majkel89/tcpdf-warper

View on GitHub
src/org/majkel/tcpdfwarper/generator/ClassDefinition.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method parse has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function parse($additionalDoc, $class = '\TCPDF') {
        $method = new ReflectionMethod($class, $this->method);
        $docComment = $method->getDocComment();
        $offset = 3;

Severity: Minor
Found in src/org/majkel/tcpdfwarper/generator/ClassDefinition.php - About 1 hr to fix

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

        protected function parse($additionalDoc, $class = '\TCPDF') {
            $method = new ReflectionMethod($class, $this->method);
            $docComment = $method->getDocComment();
            $offset = 3;
    
    
    Severity: Minor
    Found in src/org/majkel/tcpdfwarper/generator/ClassDefinition.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 generateMetaMethods has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function generateMetaMethods($metaMethodsConfig) {
            $this->metaMethods = array();
            foreach ($metaMethodsConfig as $methodConfig) {
                $item = new ClassMetaMethod();
                $item->doc = $methodConfig->doc;
    Severity: Minor
    Found in src/org/majkel/tcpdfwarper/generator/ClassDefinition.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 parse uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                    else {
                        $realValue = $parameter->getDefaultValue();
                        $item->value = is_null($realValue) ? 'null'
                                : (is_array($realValue) && empty($realValue) ? 'array()'
                                        : var_export($realValue, true));

    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

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

                else {
                    $this->requiredArguments[$name] = $item;
                    $item->value = 'null';
                }

    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

    There are no issues that match your filters.

    Category
    Status