clean/phpdoc-md

View on GitHub
src/ClassParser.php

Summary

Maintainability
A
1 hr
Test Coverage

Method getMethodDetails has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function getMethodDetails($method)
    {
        $docblock = $this->docBlockFactory->create($method->getDocComment() ?: '/** */');

        $data = [
Severity: Minor
Found in src/ClassParser.php - About 1 hr to fix

    Missing class import via use statement (line '87', column '29').
    Open

                $atlasdoc = new \Clean\PhpAtlas\ClassMethod($className);
    Severity: Minor
    Found in src/ClassParser.php by phpmd

    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 '\phpDocumentor\Reflection\DocBlockFactory' in method '__construct'.
    Open

            $this->docBlockFactory = DocBlockFactory::createInstance();
    Severity: Minor
    Found in src/ClassParser.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

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

            } else {
                $className = sprintf("%s::%s", $method->class, $method->name);
                $atlasdoc = new \Clean\PhpAtlas\ClassMethod($className);
                $data['shortDescription'] = $atlasdoc->getMethodShortDescription();
                $data['doclink'] = $atlasdoc->getMethodPHPDocLink();
    Severity: Minor
    Found in src/ClassParser.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 private methods such as 'getPHPDocLink'.
    Open

        private function getPHPDocLink($method) {
            return strtolower(sprintf('https://secure.php.net/manual/en/%s.%s.php', $method->class, $method->name));
        }
    Severity: Minor
    Found in src/ClassParser.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

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

            return ($p = $this->reflection->getParentClass()) ? $p->getName() : null;
    Severity: Minor
    Found in src/ClassParser.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

    There are no issues that match your filters.

    Category
    Status