skqr/hateoas

View on GitHub
JsonApi/ResourceCollectionFactory.php

Summary

Maintainability
A
35 mins
Test Coverage

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

    private function mineMetadata(array $entities)
    {
        $metadata = NULL;

        if (0 < count($entities)) {
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.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

The class ResourceCollectionFactory has a coupling between objects value of 17. Consider to reduce the number of dependencies under 13.
Open

class ResourceCollectionFactory implements Factory
{
    /**
     * @var ResourceManager
     */
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.php by phpmd

CouplingBetweenObjects

Since: 1.1.0

A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

Example

class Foo {
    /**
     * @var \foo\bar\X
     */
    private $x = null;

    /**
     * @var \foo\bar\Y
     */
    private $y = null;

    /**
     * @var \foo\bar\Z
     */
    private $z = null;

    public function setFoo(\Foo $foo) {}
    public function setBar(\Bar $bar) {}
    public function setBaz(\Baz $baz) {}

    /**
     * @return \SplObjectStorage
     * @throws \OutOfRangeException
     * @throws \InvalidArgumentException
     * @throws \ErrorException
     */
    public function process(\Iterator $it) {}

    // ...
}

Source https://phpmd.org/rules/design.html#couplingbetweenobjects

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

        } else {
            $collection = $this->createPlain();
        }
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.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 mineMetadata uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

            } else {
                $type = $this->params->primaryType;
            }
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.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 getRelationType uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            throw new FactoryErrorException(
                self::ERROR_PARAMS_INCOHERENT
            );
        }
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.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 mineMetadata uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            $type = NULL;

            if (empty($this->params)) {
                throw new FactoryRequisiteException(
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.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 unused local variables such as '$entity'.
Open

            $entity = reset($entities);
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.php by phpmd

UnusedLocalVariable

Since: 0.2

Detects when a local variable is declared and/or assigned, but not used.

Example

class Foo {
    public function doSomething()
    {
        $i = 5; // Unused
    }
}

Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

Avoid unused parameters such as '$params'.
Open

    private function getRelationType(Params $params)
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.php by phpmd

UnusedFormalParameter

Since: 0.2

Avoid passing parameters to methods or constructors and then not using those parameters.

Example

class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

Avoid unused private methods such as 'createResource'.
Open

    private function createResource(ResourceEntityInterface $entity)
    {
        return $this->resourceManager
            ->createResourceFactory()
            ->setEntity($entity)
Severity: Minor
Found in JsonApi/ResourceCollectionFactory.php by phpmd

UnusedPrivateMethod

Since: 0.2

Unused Private Method detects when a private method is declared but is unused.

Example

class Something
{
    private function foo() {} // unused
}

Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

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

        $collection = NULL;

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

        $metadata = NULL;

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

        $relation = NULL;

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

            $type = NULL;

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

    {

Expected 1 space after FUNCTION keyword; 0 found
Open

        array_walk($entities, function(ResourceEntityInterface $entity) {

There are no issues that match your filters.

Category
Status