Sign upLogin

skqr/hateoas

View on GitHub
Star
JsonApi/Serializer/TranslationsMetadataSerializer.php

Summary

Maintainability
A
1 hr
Test Coverage

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

    public function serialize(JsonApi\Document $document)
    {
        $json = [];

        if ($document->i18n) {
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.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

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

    private function findTranslations(JsonApi\ResourceCollection $resources)
    {
        $allTranslations = [];
        $repository = $this->em->getRepository(
            'Gedmo\\Translatable\\Entity\\Translation'
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.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 serialize uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

                } else {
                    $translations = reset($docTranslations);
                    $json = static::rearrangeTranslations($translations);
                }
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.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 variables with short names like $em. Configured minimum length is 3.
Open

    public function __construct(EntityManagerInterface $em)
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.php by phpmd

ShortVariable

Since: 0.2

Detects when a field, local, or parameter has a very short name.

Example

class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

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

Avoid variables with short names like $em. Configured minimum length is 3.
Open

    private $em;
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.php by phpmd

ShortVariable

Since: 0.2

Detects when a field, local, or parameter has a very short name.

Example

class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

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

Blank line found at start of control structure
Open

            if (!empty($docTranslations)) {
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.php by phpcodesniffer

Space found before closing bracket of FOREACH loop
Open

                    foreach (
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.php by phpcodesniffer

Space found after opening bracket of FOREACH loop
Open

                    foreach (
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.php by phpcodesniffer

Expected 0 spaces after opening bracket; newline found
Open

                    foreach (
Severity: Minor
Found in JsonApi/Serializer/TranslationsMetadataSerializer.php by phpcodesniffer

There are no issues that match your filters.

Category
Status