DarkaOnLine/L5-Swagger

View on GitHub
src/Generator.php

Summary

Maintainability
A
1 hr
Test Coverage
A
98%

Method __construct has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

        array $paths,
        array $constants,
        bool $yamlCopyRequired,
        SecurityDefinitions $security,
        array $scanOptions,
Severity: Minor
Found in src/Generator.php - About 45 mins to fix

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

        protected function setProcessors(OpenApiGenerator $generator): void
        {
            $processorClasses = Arr::get($this->scanOptions, self::SCAN_OPTION_PROCESSORS, []);
            $processors = [];
    
    
    Severity: Minor
    Found in src/Generator.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 Generator has a coupling between objects value of 14. Consider to reduce the number of dependencies under 13.
    Open

    class Generator
    {
        public const OPEN_API_DEFAULT_SPEC_VERSION = '3.0.0';
    
        protected const SCAN_OPTION_PROCESSORS = 'processors';
    Severity: Minor
    Found in src/Generator.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

    Avoid using static access to class '\Illuminate\Support\Arr' in method 'createScanFinder'.
    Open

            $pattern = Arr::get($this->scanOptions, self::SCAN_OPTION_PATTERN);
    Severity: Minor
    Found in src/Generator.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 '\Illuminate\Support\Arr' in method 'setAnalyser'.
    Open

            $analyser = Arr::get($this->scanOptions, self::SCAN_OPTION_ANALYSER);
    Severity: Minor
    Found in src/Generator.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 '\Illuminate\Support\Arr' in method 'scanFilesForDocumentation'.
    Open

            $analysis = Arr::get($this->scanOptions, self::SCAN_OPTION_ANALYSIS);
    Severity: Minor
    Found in src/Generator.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 '\Illuminate\Support\Arr' in method 'setProcessors'.
    Open

            $processorClasses = Arr::get($this->scanOptions, self::SCAN_OPTION_PROCESSORS, []);
    Severity: Minor
    Found in src/Generator.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 '\OpenApi\Util' in method 'createScanFinder'.
    Open

            return Util::finder($this->annotationsDir, $exclude, $pattern);
    Severity: Minor
    Found in src/Generator.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 '\Illuminate\Support\Arr' in method 'createScanFinder'.
    Open

            $exclude = Arr::get($this->scanOptions, self::SCAN_OPTION_EXCLUDE);
    Severity: Minor
    Found in src/Generator.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 are no issues that match your filters.

    Category
    Status