netglue/prismic-php-kit

View on GitHub
src/Prismic/Document/Fragment/RichText.php

Summary

Maintainability
B
4 hrs
Test Coverage
A
100%

Method factory has 59 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function factory($value, LinkResolver $linkResolver) : FragmentInterface
    {
        $richText = new static;
        // In API V2, Rich text is an array of 'Block Level' objects,
        // in V1, the array is in the property 'value'
Severity: Major
Found in src/Prismic/Document/Fragment/RichText.php - About 2 hrs to fix

    Function factory has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

        public static function factory($value, LinkResolver $linkResolver) : FragmentInterface
        {
            $richText = new static;
            // In API V2, Rich text is an array of 'Block Level' objects,
            // in V1, the array is in the property 'value'
    Severity: Minor
    Found in src/Prismic/Document/Fragment/RichText.php - About 2 hrs 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 factory() has a Cyclomatic Complexity of 21. The configured cyclomatic complexity threshold is 10.
    Open

        public static function factory($value, LinkResolver $linkResolver) : FragmentInterface
        {
            $richText = new static;
            // In API V2, Rich text is an array of 'Block Level' objects,
            // in V1, the array is in the property 'value'

    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

    Avoid using static access to class 'Prismic\Document\Fragment\ListElement' in method 'factory'.
    Open

                            $openList = ListElement::fromTag('ul');

    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 'Prismic\Document\Fragment\TextElement' in method 'factory'.
    Open

                        $item = TextElement::factory($blockData, $linkResolver);

    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 'Prismic\Document\Fragment\ListElement' in method 'factory'.
    Open

                            $openList = ListElement::fromTag('ol');

    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 'Prismic\Document\Fragment\Embed' in method 'factory'.
    Open

                        $richText->blocks[] = Embed::factory($blockData);

    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 'Prismic\Document\Fragment\TextElement' in method 'factory'.
    Open

                        $richText->blocks[] = TextElement::factory($blockData, $linkResolver);

    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 'Prismic\Document\Fragment\Image' in method 'factory'.
    Open

                        $richText->blocks[] = Image::factory($blockData, $linkResolver);

    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 'Prismic\Document\Fragment\TextElement' in method 'factory'.
    Open

                        $item = TextElement::factory($blockData, $linkResolver);

    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

    Expected an object instance when accessing an instance property, but saw an expression with type array
    Open

            if (isset($value->value)) {
    Severity: Critical
    Found in src/Prismic/Document/Fragment/RichText.php by phan

    Expected an object instance when accessing an instance property, but saw an expression with type array
    Open

                $value = $value->value;
    Severity: Critical
    Found in src/Prismic/Document/Fragment/RichText.php by phan

    There are no issues that match your filters.

    Category
    Status