Sign upLogin

wikimedia/mediawiki-core

View on GitHub
Star
includes/libs/ParamValidator/ParamValidator.php

Summary

Maintainability
F
4 days
Test Coverage

File ParamValidator.php has 488 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Wikimedia\ParamValidator;

use DomainException;
Severity: Minor
Found in includes/libs/ParamValidator/ParamValidator.php - About 7 hrs to fix

    Function checkSettings has a Cognitive Complexity of 37 (exceeds 5 allowed). Consider refactoring.
    Open

        public function checkSettings( string $name, $settings, array $options ): array {
        $settings = $this->normalizeSettingsInternal( $settings );
        $issues = [];
        $allowedKeys = [
            self::PARAM_TYPE, self::PARAM_DEFAULT, self::PARAM_REQUIRED, self::PARAM_ISMULTI,
    Severity: Minor
    Found in includes/libs/ParamValidator/ParamValidator.php - About 5 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Method validateValue has 98 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function validateValue( $name, $value, $settings, array $options = [] ) {
        $settings = $this->normalizeSettings( $settings );

        $typeDef = $this->getTypeDef( $settings[self::PARAM_TYPE] );
        if ( !$typeDef ) {
    Severity: Major
    Found in includes/libs/ParamValidator/ParamValidator.php - About 3 hrs to fix

      Method checkSettings has 96 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function checkSettings( string $name, $settings, array $options ): array {
        $settings = $this->normalizeSettingsInternal( $settings );
        $issues = [];
        $allowedKeys = [
            self::PARAM_TYPE, self::PARAM_DEFAULT, self::PARAM_REQUIRED, self::PARAM_ISMULTI,
      Severity: Major
      Found in includes/libs/ParamValidator/ParamValidator.php - About 3 hrs to fix

        Function validateValue has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
        Open

            public function validateValue( $name, $value, $settings, array $options = [] ) {
        $settings = $this->normalizeSettings( $settings );

        $typeDef = $this->getTypeDef( $settings[self::PARAM_TYPE] );
        if ( !$typeDef ) {
        Severity: Minor
        Found in includes/libs/ParamValidator/ParamValidator.php - About 3 hrs to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function getHelpInfo has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
        Open

            public function getHelpInfo( $name, $settings, array $options ) {
        $settings = $this->normalizeSettings( $settings );
        $typeDef = $this->getTypeDef( $settings[self::PARAM_TYPE] );

        // Define ordering. Some are overwritten below, some expected from the TypeDef
        Severity: Minor
        Found in includes/libs/ParamValidator/ParamValidator.php - About 2 hrs to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Method getHelpInfo has 60 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function getHelpInfo( $name, $settings, array $options ) {
        $settings = $this->normalizeSettings( $settings );
        $typeDef = $this->getTypeDef( $settings[self::PARAM_TYPE] );

        // Define ordering. Some are overwritten below, some expected from the TypeDef
        Severity: Major
        Found in includes/libs/ParamValidator/ParamValidator.php - About 2 hrs to fix

          Method getParamInfo has 41 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function getParamInfo( $name, $settings, array $options ) {
        $settings = $this->normalizeSettings( $settings );
        $typeDef = $this->getTypeDef( $settings[self::PARAM_TYPE] );
        $info = [];
          Severity: Minor
          Found in includes/libs/ParamValidator/ParamValidator.php - About 1 hr to fix

            Function getParamInfo has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
            Open

                public function getParamInfo( $name, $settings, array $options ) {
        $settings = $this->normalizeSettings( $settings );
        $typeDef = $this->getTypeDef( $settings[self::PARAM_TYPE] );
        $info = [];
            Severity: Minor
            Found in includes/libs/ParamValidator/ParamValidator.php - About 1 hr to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Method getValue has 30 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function getValue( $name, $settings, array $options = [] ) {
        $settings = $this->normalizeSettings( $settings );

        $typeDef = $this->getTypeDef( $settings[self::PARAM_TYPE] );
        if ( !$typeDef ) {
            Severity: Minor
            Found in includes/libs/ParamValidator/ParamValidator.php - About 1 hr to fix

              Function getValue has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
              Open

                  public function getValue( $name, $settings, array $options = [] ) {
        $settings = $this->normalizeSettings( $settings );

        $typeDef = $this->getTypeDef( $settings[self::PARAM_TYPE] );
        if ( !$typeDef ) {
              Severity: Minor
              Found in includes/libs/ParamValidator/ParamValidator.php - About 35 mins to fix

              Cognitive Complexity

              Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

              A method's cognitive complexity is based on a few simple rules:

              • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
              • Code is considered more complex for each "break in the linear flow of the code"
              • Code is considered more complex when "flow breaking structures are nested"

              Further reading

              Avoid too many return statements within this method.
              Open

                      return $validValues;
              Severity: Major
              Found in includes/libs/ParamValidator/ParamValidator.php - About 30 mins to fix

                Similar blocks of code found in 2 locations. Consider refactoring.
                Open

                        $info = [
            self::PARAM_DEPRECATED => null,
            self::PARAM_REQUIRED => null,
            self::PARAM_SENSITIVE => null,
            self::PARAM_TYPE => null,
                Severity: Minor
                Found in includes/libs/ParamValidator/ParamValidator.php and 1 other location - About 45 mins to fix
                includes/libs/objectcache/wancache/WANObjectCache.php on lines 2825..2836

                Duplicated Code

                Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                Tuning

                This issue has a mass of 96.

                We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                Refactorings

                Further Reading

                There are no issues that match your filters.

                Category
                Status