k911/swoole-bundle

View on GitHub
src/Server/HttpServerConfiguration.php

Summary

Maintainability
C
1 day
Test Coverage
C
78%

HttpServerConfiguration has 32 functions (exceeds 20 allowed). Consider refactoring.
Open

class HttpServerConfiguration
{
    private const SWOOLE_HTTP_SERVER_CONFIG_DAEMONIZE = 'daemonize';
    private const SWOOLE_HTTP_SERVER_CONFIG_SERVE_STATIC = 'serve_static';
    private const SWOOLE_HTTP_SERVER_CONFIG_REACTOR_COUNT = 'reactor_count';
Severity: Minor
Found in src/Server/HttpServerConfiguration.php - About 4 hrs to fix

    The class HttpServerConfiguration has an overall complexity of 59 which is very high. The configured complexity threshold is 50.
    Open

    class HttpServerConfiguration
    {
        private const SWOOLE_HTTP_SERVER_CONFIG_DAEMONIZE = 'daemonize';
        private const SWOOLE_HTTP_SERVER_CONFIG_SERVE_STATIC = 'serve_static';
        private const SWOOLE_HTTP_SERVER_CONFIG_REACTOR_COUNT = 'reactor_count';

    File HttpServerConfiguration.php has 266 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    
    declare(strict_types=1);
    
    namespace K911\Swoole\Server;
    Severity: Minor
    Found in src/Server/HttpServerConfiguration.php - About 2 hrs to fix

      Method validateSetting has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function validateSetting(string $key, $value): void
          {
              Assertion::keyExists(self::SWOOLE_HTTP_SERVER_CONFIGURATION, $key, 'There is no configuration mapping for setting "%s".');
      
              switch ($key) {
      Severity: Minor
      Found in src/Server/HttpServerConfiguration.php - About 1 hr to fix

        Function validateSetting has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

            private function validateSetting(string $key, $value): void
            {
                Assertion::keyExists(self::SWOOLE_HTTP_SERVER_CONFIGURATION, $key, 'There is no configuration mapping for setting "%s".');
        
                switch ($key) {
        Severity: Minor
        Found in src/Server/HttpServerConfiguration.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

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

            private function validateSetting(string $key, $value): void
            {
                Assertion::keyExists(self::SWOOLE_HTTP_SERVER_CONFIGURATION, $key, 'There is no configuration mapping for setting "%s".');
        
                switch ($key) {

        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

        Class "HttpServerConfiguration" has 32 methods, which is greater than 20 authorized. Split it into smaller classes.
        Open

        class HttpServerConfiguration

        A class that grows too much tends to aggregate too many responsibilities and inevitably becomes harder to understand and therefore to maintain. Above a specific threshold, it is strongly advised to refactor the class into smaller ones which focus on well defined topics.

        Remove this unused "SWOOLE_HTTP_SERVER_CONFIG_LOG_FILE" private field.
        Invalid

            private const SWOOLE_HTTP_SERVER_CONFIG_LOG_FILE = 'log_file';

        If a private field is declared but not used in the program, it can be considered dead code and should therefore be removed. This will improve maintainability because developers will not wonder what the variable is used for.

        Noncompliant Code Example

        class MyClass {
          private $foo = 4;                       //foo is unused
        
          public function compute($a) {
            return $a * 4;
          }
        }
        

        Compliant Solution

        class MyClass {
        
          public function compute($a) {
            return $a * 4;
          }
        }
        

        See

        Rename "$settings" which has the same name as the field declared at line 78.
        Wontfix

                $settings = [self::SWOOLE_HTTP_SERVER_CONFIG_DAEMONIZE => true];

        Shadowing fields with a local variable is a bad practice that reduces code readability: it makes it confusing to know whether the field or the variable is being used.

        Noncompliant Code Example

        class Foo {
          public $myField;
        
          public function doSomething() {
            $myField = 0;
            ...
          }
        }
        

        See

        Rename "$settings" which has the same name as the field declared at line 78.
        Open

                $settings = [

        Shadowing fields with a local variable is a bad practice that reduces code readability: it makes it confusing to know whether the field or the variable is being used.

        Noncompliant Code Example

        class Foo {
          public $myField;
        
          public function doSomething() {
            $myField = 0;
            ...
          }
        }
        

        See

        Define a constant instead of duplicating this literal "default" 3 times.
        Open

                'default' => true,

        Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

        On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

        Noncompliant Code Example

        With the default threshold of 3:

        function run() {
          prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
          execute('action1');
          release('action1');
        }
        

        Compliant Solution

        ACTION_1 = 'action1';
        
        function run() {
          prepare(ACTION_1);
          execute(ACTION_1);
          release(ACTION_1);
        }
        

        Exceptions

        To prevent generating some false-positives, literals having less than 5 characters are excluded.

        Define a constant instead of duplicating this literal "Setting "%s" must be an integer." 4 times.
        Open

                        Assertion::integer($value, \sprintf('Setting "%s" must be an integer.', $key));

        Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

        On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

        Noncompliant Code Example

        With the default threshold of 3:

        function run() {
          prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
          execute('action1');
          release('action1');
        }
        

        Compliant Solution

        ACTION_1 = 'action1';
        
        function run() {
          prepare(ACTION_1);
          execute(ACTION_1);
          release(ACTION_1);
        }
        

        Exceptions

        To prevent generating some false-positives, literals having less than 5 characters are excluded.

        There are no issues that match your filters.

        Category
        Status