EclipseGc/PluginsAnnotation

View on GitHub
src/Discovery/AnnotatedPluginDiscovery.php

Summary

Maintainability
B
5 hrs
Test Coverage

Function findPluginImplementations has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

  public function findPluginImplementations(PluginDefinitionInterface ...$definitions) : PluginDefinitionSet {
    // Clear the annotation loaders of any previous annotation classes.
    AnnotationRegistry::reset();
    // Register the namespaces of classes that can be used for annotations.
    AnnotationRegistry::registerLoader('class_exists');
Severity: Minor
Found in src/Discovery/AnnotatedPluginDiscovery.php - About 3 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

Method findPluginImplementations has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  public function findPluginImplementations(PluginDefinitionInterface ...$definitions) : PluginDefinitionSet {
    // Clear the annotation loaders of any previous annotation classes.
    AnnotationRegistry::reset();
    // Register the namespaces of classes that can be used for annotations.
    AnnotationRegistry::registerLoader('class_exists');
Severity: Minor
Found in src/Discovery/AnnotatedPluginDiscovery.php - About 1 hr to fix

    Function extractNamespace has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

      protected function extractNamespace(array $tokens) : string {
        $namespace = '';
        $found = FALSE;
        foreach ($tokens as $token) {
          if (is_array($token) && $token[0] == T_NAMESPACE) {
    Severity: Minor
    Found in src/Discovery/AnnotatedPluginDiscovery.php - About 55 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

    Missing class import via use statement (line '93', column '34').
    Open

                    $reflector = new \ReflectionClass($definition);

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Avoid using static access to class '\Doctrine\Common\Annotations\AnnotationRegistry' in method 'findPluginImplementations'.
    Open

        AnnotationRegistry::registerLoader('class_exists');

    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 '\Doctrine\Common\Annotations\AnnotationRegistry' in method 'findPluginImplementations'.
    Open

        AnnotationRegistry::reset();

    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 unused local variables such as '$namespace'.
    Open

        foreach ($this->namespaces as $namespace => $directory) {

    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 '$class'.
    Open

          public function findFile($class) {

    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

    The variable $file_contents is not named in camelCase.
    Open

      public function findPluginImplementations(PluginDefinitionInterface ...$definitions) : PluginDefinitionSet {
        // Clear the annotation loaders of any previous annotation classes.
        AnnotationRegistry::reset();
        // Register the namespaces of classes that can be used for annotations.
        AnnotationRegistry::registerLoader('class_exists');

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
        public function doSomething() {
            $data_module = new DataModule();
        }
    }

    Source

    The variable $file_contents is not named in camelCase.
    Open

      public function findPluginImplementations(PluginDefinitionInterface ...$definitions) : PluginDefinitionSet {
        // Clear the annotation loaders of any previous annotation classes.
        AnnotationRegistry::reset();
        // Register the namespaces of classes that can be used for annotations.
        AnnotationRegistry::registerLoader('class_exists');

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
        public function doSomething() {
            $data_module = new DataModule();
        }
    }

    Source

    The variable $plugin_directory is not named in camelCase.
    Open

      public function findPluginImplementations(PluginDefinitionInterface ...$definitions) : PluginDefinitionSet {
        // Clear the annotation loaders of any previous annotation classes.
        AnnotationRegistry::reset();
        // Register the namespaces of classes that can be used for annotations.
        AnnotationRegistry::registerLoader('class_exists');

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
        public function doSomething() {
            $data_module = new DataModule();
        }
    }

    Source

    The variable $plugin_directory is not named in camelCase.
    Open

      public function findPluginImplementations(PluginDefinitionInterface ...$definitions) : PluginDefinitionSet {
        // Clear the annotation loaders of any previous annotation classes.
        AnnotationRegistry::reset();
        // Register the namespaces of classes that can be used for annotations.
        AnnotationRegistry::registerLoader('class_exists');

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
        public function doSomething() {
            $data_module = new DataModule();
        }
    }

    Source

    The variable $plugin_directory is not named in camelCase.
    Open

      public function findPluginImplementations(PluginDefinitionInterface ...$definitions) : PluginDefinitionSet {
        // Clear the annotation loaders of any previous annotation classes.
        AnnotationRegistry::reset();
        // Register the namespaces of classes that can be used for annotations.
        AnnotationRegistry::registerLoader('class_exists');

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
        public function doSomething() {
            $data_module = new DataModule();
        }
    }

    Source

    There are no issues that match your filters.

    Category
    Status