Sign upLogin

jannisfink/yarf

View on GitHub
Star

Showing 27 of 27 total issues

Avoid excessively long variable names like $requestMethodParameters. Keep variable name length under 20.
Open

    $requestMethodParameters = $this->getParametersForMethod($reflectionObject->getMethod($requestMethod));
Severity: Minor
Found in src/response/PageRenderer.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

Method evaluatePage has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  public function evaluatePage() {
    if ($this->webPage == null) {
      throw new HttpNotFound();
    }
Severity: Minor
Found in src/response/PageRenderer.php - About 1 hr to fix

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

      private function traverse(array $pageMap, array $uriParts) {
    if (count($uriParts) === 0) {
      if (array_key_exists('', $pageMap)) {
        return $pageMap[''];
      }
    Severity: Minor
    Found in src/request/PageMapper.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

    Function getParametersForMethod has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

      private function getParametersForMethod(\ReflectionMethod $method) {
    $result = [];

    foreach ($method->getParameters() as $parameter) {
      if ($parameter->getClass() !== null && $parameter->getClass()->getName() === Request::class) {
    Severity: Minor
    Found in src/response/PageRenderer.php - About 45 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 null;
    Severity: Major
    Found in src/request/PageMapper.php - About 30 mins to fix

      Missing class import via use statement (line '138', column '20').
      Open

            $class = new \ReflectionClass($className);
      Severity: Minor
      Found in src/request/PageMapper.php by phpmd

      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

      The method __construct has a boolean flag argument $fallThrough, which is a certain sign of a Single Responsibility Principle violation.
      Open

        public function __construct($fallThrough = false) {
      Severity: Minor
      Found in src/Router.php by phpmd

      BooleanArgumentFlag

      Since: 1.4.0

      A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

      Example

      class Foo {
    public function bar($flag = true) {
    }
}

      Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

      Missing class import via use statement (line '67', column '29').
      Open

          $reflectionObject = new \ReflectionObject($this->webPage);
      Severity: Minor
      Found in src/response/PageRenderer.php by phpmd

      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

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

        private function createWebPageFromClassName($className) {
    try {
      $class = new \ReflectionClass($className);
      if ($class->isSubclassOf(WebPage::class)) {
        $constructor = $class->getConstructor();
      Severity: Minor
      Found in src/request/PageMapper.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 evaluatePermissions uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

            } else {
        throw new HttpNotFound();
      }
      Severity: Minor
      Found in src/response/PageRenderer.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

      Source https://phpmd.org/rules/cleancode.html#elseexpression

      The method createHeader uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

          } else {
      foreach ($this->response->getHeaders() as $header => $value) {
        header($header . ":" . $value);
      }
    }
      Severity: Minor
      Found in src/response/PageResolver.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

      Source https://phpmd.org/rules/cleancode.html#elseexpression

      The method getStatusCode uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

          } else {
      return $this->thrownWebException->getStatusCode();
    }
      Severity: Minor
      Found in src/response/PageResolver.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

      Source https://phpmd.org/rules/cleancode.html#elseexpression

      The method getContentType uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

          } else {
      return $this->webPage->getContentType();
    }
      Severity: Minor
      Found in src/response/PageResolver.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

      Source https://phpmd.org/rules/cleancode.html#elseexpression

      The method getParametersForMethod uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

            } else {
        $result[] = null;
      }
      Severity: Minor
      Found in src/response/PageRenderer.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

      Source https://phpmd.org/rules/cleancode.html#elseexpression

      Avoid using static access to class 'Yarf\response\Response' in method 'getParametersForMethod'.
      Open

              $result[] = Response::createResponseForPage($this->webPage);
      Severity: Minor
      Found in src/response/PageRenderer.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

      Source https://phpmd.org/rules/cleancode.html#staticaccess

      Avoid using static access to class '\Yarf\wrapper\Server' in method 'evaluatePage'.
      Open

          $requestMethod = Server::getRequestMethod();
      Severity: Minor
      Found in src/response/PageRenderer.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

      Source https://phpmd.org/rules/cleancode.html#staticaccess

      The method getRequestBody uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

          } else {
      return $this->rawRequestBody;
    }
      Severity: Minor
      Found in src/response/PageResolver.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

      Source https://phpmd.org/rules/cleancode.html#elseexpression

      Avoid using static access to class '\Yarf\wrapper\Server' in method 'getPage'.
      Open

          $page = $this->traverse($this->pageMap, Server::getRequestUriParts());
      Severity: Minor
      Found in src/request/PageMapper.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

      Source https://phpmd.org/rules/cleancode.html#staticaccess

      __construct accesses the super-global variable $_GET.
      Open

        public function __construct($get = null, $post = null, $body = null, $files = null) {
    if ($get === null) {
      $get = $_GET;
    }
    if ($post === null) {
      Severity: Minor
      Found in src/request/Request.php by phpmd

      Superglobals

      Since: 0.2

      Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

      Example

      class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

      Source

      __construct accesses the super-global variable $_FILES.
      Open

        public function __construct($get = null, $post = null, $body = null, $files = null) {
    if ($get === null) {
      $get = $_GET;
    }
    if ($post === null) {
      Severity: Minor
      Found in src/request/Request.php by phpmd

      Superglobals

      Since: 0.2

      Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

      Example

      class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

      Source

      Severity
      Category
      Status
      Source
      Language