Sign upLogin

skqr/hateoas

View on GitHub
Star
JsonApi/Serializer/TopLevelPaginationLinksSerializer.php

Summary

Maintainability
A
35 mins
Test Coverage

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

    public function serialize(Document $document)
    {
        $json = [];
        $pagination = $document->pagination;
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.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 using static access to class '\GoIntegro\Hateoas\Util\Inflector' in method 'serialize'.
Open

                $method = 'get' . Inflector::camelize($relationship);
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.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

There must be one USE keyword per declaration
Open

use GoIntegro\Hateoas\JsonApi\ResourceEntityInterface,
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.php by phpcodesniffer

TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL"
Open

        return $page <= $this->getLast($document) ? $page : NULL;
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.php by phpcodesniffer

TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL"
Open

        return 0 < $page ? $page : NULL;
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.php by phpcodesniffer

Multi-line function declarations must define one parameter per line
Open

        DocumentResource $resource, $relationship
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.php by phpcodesniffer

There must be one USE keyword per declaration
Open

use GoIntegro\Hateoas\JsonApi\Document,
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.php by phpcodesniffer

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line
Open

    {
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.php by phpcodesniffer

Inline control structures are not allowed
Open

                if (is_null($page)) continue;
Severity: Minor
Found in JsonApi/Serializer/TopLevelPaginationLinksSerializer.php by phpcodesniffer

There are no issues that match your filters.

Category
Status