felixarntz/wp-site-identity

View on GitHub
src/settings/class-wp-site-identity-standard-setting-registry.php

Summary

Maintainability
A
3 hrs
Test Coverage

The class WP_Site_Identity_Standard_Setting_Registry has 11 public methods. Consider refactoring WP_Site_Identity_Standard_Setting_Registry to keep number of public methods under 10.
Open

class WP_Site_Identity_Standard_Setting_Registry implements WP_Site_Identity_Setting_Registry {

    /**
     * Prefix to use for all setting names within WordPress.
     *

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

Method build_rest_schema_for_wp has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function build_rest_schema_for_wp( WP_Site_Identity_Setting $setting ) {
        $default_schema = array(
            'type'        => $setting->get_type(),
            'description' => $setting->get_description(),
            'default'     => $setting->get_default(),
Severity: Minor
Found in src/settings/class-wp-site-identity-standard-setting-registry.php - About 1 hr to fix

    Function build_rest_schema_for_wp has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function build_rest_schema_for_wp( WP_Site_Identity_Setting $setting ) {
            $default_schema = array(
                'type'        => $setting->get_type(),
                'description' => $setting->get_description(),
                'default'     => $setting->get_default(),
    Severity: Minor
    Found in src/settings/class-wp-site-identity-standard-setting-registry.php - About 55 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

    Method __construct has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        public function __construct( $prefix, $group, WP_Site_Identity_Setting_Feedback_Handler $feedback_handler = null, WP_Site_Identity_Setting_Validator $validator = null, WP_Site_Identity_Setting_Sanitizer $sanitizer = null ) {
    Severity: Minor
    Found in src/settings/class-wp-site-identity-standard-setting-registry.php - About 35 mins to fix

      Function __construct has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          public function __construct( $prefix, $group, WP_Site_Identity_Setting_Feedback_Handler $feedback_handler = null, WP_Site_Identity_Setting_Validator $validator = null, WP_Site_Identity_Setting_Sanitizer $sanitizer = null ) {
              $this->prefix = $prefix;
              $this->group  = $group;
      
              $this->factory = new WP_Site_Identity_Setting_Factory( $this );
      Severity: Minor
      Found in src/settings/class-wp-site-identity-standard-setting-registry.php - About 25 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

      The method build_rest_schema_for_wp() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
      Open

          protected function build_rest_schema_for_wp( WP_Site_Identity_Setting $setting ) {
              $default_schema = array(
                  'type'        => $setting->get_type(),
                  'description' => $setting->get_description(),
                  'default'     => $setting->get_default(),

      CyclomaticComplexity

      Since: 0.1

      Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

      Example

      // Cyclomatic Complexity = 11
      class Foo {
      1   public function example() {
      2       if ($a == $b) {
      3           if ($a1 == $b1) {
                      fiddle();
      4           } elseif ($a2 == $b2) {
                      fiddle();
                  } else {
                      fiddle();
                  }
      5       } elseif ($c == $d) {
      6           while ($c == $d) {
                      fiddle();
                  }
      7        } elseif ($e == $f) {
      8           for ($n = 0; $n < $h; $n++) {
                      fiddle();
                  }
              } else {
                  switch ($z) {
      9               case 1:
                          fiddle();
                          break;
      10              case 2:
                          fiddle();
                          break;
      11              case 3:
                          fiddle();
                          break;
                      default:
                          fiddle();
                          break;
                  }
              }
          }
      }

      Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

      Missing class import via use statement (line '106', column '27').
      Open

                  $this->sanitizer = new WP_Site_Identity_Setting_Sanitizer();

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Missing class import via use statement (line '155', column '14').
      Open

                  throw new WP_Site_Identity_Setting_Not_Found_Exception( sprintf( __( 'The setting with the name %s could not be found.', 'wp-site-identity' ), $name ) );

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Missing class import via use statement (line '100', column '27').
      Open

                  $this->validator = new WP_Site_Identity_Setting_Validator();

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Missing class import via use statement (line '125', column '14').
      Open

                  throw new WP_Site_Identity_Setting_Not_Found_Exception( sprintf( __( 'The setting with the name %s could not be found.', 'wp-site-identity' ), $name ) );

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Missing class import via use statement (line '89', column '24').
      Open

              $this->factory = new WP_Site_Identity_Setting_Factory( $this );

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Missing class import via use statement (line '94', column '34').
      Open

                  $this->feedback_handler = new WP_Site_Identity_Setting_Feedback_Handler();

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Avoid excessively long class names like WP_Site_Identity_Standard_Setting_Registry. Keep class name length under 40.
      Open

      class WP_Site_Identity_Standard_Setting_Registry implements WP_Site_Identity_Setting_Registry {
      
          /**
           * Prefix to use for all setting names within WordPress.
           *

      LongClassName

      Since: 2.9

      Detects when classes or interfaces are declared with excessively long names.

      Example

      class ATooLongClassNameThatHintsAtADesignProblem {
      
      }
      
      interface ATooLongInterfaceNameThatHintsAtADesignProblem {
      
      }

      Source https://phpmd.org/rules/naming.html#longclassname

      There are no issues that match your filters.

      Category
      Status