Sign upLogin

nabble/ajde

View on GitHub
Star
lib/Ajde/Document.php

Summary

Maintainability
B
4 hrs
Test Coverage

Ajde_Document has 25 functions (exceeds 20 allowed). Consider refactoring.
Open

abstract class Ajde_Document extends Ajde_Object_Standard
{
    const CACHE_CONTROL_PUBLIC = 'public';
    const CACHE_CONTROL_PRIVATE = 'private';
    const CACHE_CONTROL_NOCACHE = 'no-cache';
Severity: Minor
Found in lib/Ajde/Document.php - About 2 hrs to fix

    Function registerDocumentProcessor has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

        public static function registerDocumentProcessor($format, $registerOn = 'layout')
    {
        $documentProcessors = config('layout.filters.documentProcessors');
        if (is_array($documentProcessors) && isset($documentProcessors[$format])) {
            foreach ($documentProcessors[$format] as $processor) {
    Severity: Minor
    Found in lib/Ajde/Document.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

    Missing class import via use statement (line '28', column '30').
    Open

                $exception = new Ajde_Core_Exception_Routing("Document format $format not found",
    Severity: Minor
    Found in lib/Ajde/Document.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

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

                $this->setLayout(new Ajde_Layout(config('layout.frontend')));
    Severity: Minor
    Found in lib/Ajde/Document.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

    Missing class import via use statement (line '198', column '19').
    Open

            throw new Ajde_Core_Exception_Deprecated();
    Severity: Minor
    Found in lib/Ajde/Document.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

    Missing class import via use statement (line '221', column '31').
    Open

                        throw new Ajde_Exception('Document processor must be registered on either \'layout\' or \'compressor\'');
    Severity: Minor
    Found in lib/Ajde/Document.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

    Missing class import via use statement (line '188', column '19').
    Open

            throw new Ajde_Core_Exception_Deprecated();
    Severity: Minor
    Found in lib/Ajde/Document.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

    Missing class import via use statement (line '42', column '27').
    Open

                $layout = new Ajde_Layout($layout);
    Severity: Minor
    Found in lib/Ajde/Document.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

    Missing class import via use statement (line '209', column '31').
    Open

                        throw new Ajde_Exception('Processor '.$processorClass.' not found', 90022);
    Severity: Minor
    Found in lib/Ajde/Document.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 'Ajde_Event' in method 'registerDocumentProcessor'.
    Open

                        Ajde_Event::register('Ajde_Layout', 'beforeGetContents', $processorClass.'::preProcess');
    Severity: Minor
    Found in lib/Ajde/Document.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 getFullTitle uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
            return $projectTitle;
        }
    Severity: Minor
    Found in lib/Ajde/Document.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

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

            } else {
            return config('app.author');
        }
    Severity: Minor
    Found in lib/Ajde/Document.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

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

            } else {
            return '';
        }
    Severity: Minor
    Found in lib/Ajde/Document.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 using static access to class 'Ajde_Event' in method 'registerDocumentProcessor'.
    Open

                        Ajde_Event::register('Ajde_Layout', 'afterGetContents', $processorClass.'::postProcess');
    Severity: Minor
    Found in lib/Ajde/Document.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 'Ajde_Event' in method 'registerDocumentProcessor'.
    Open

                        Ajde_Event::register('Ajde_Resource_Local_Compressor', 'beforeCompress',
                        $processorClass.'::preCompress');
    Severity: Minor
    Found in lib/Ajde/Document.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 'Ajde_Event' in method 'registerDocumentProcessor'.
    Open

                        Ajde_Event::register('Ajde_Resource_Local_Compressor', 'afterCompress',
                        $processorClass.'::postCompress');
    Severity: Minor
    Found in lib/Ajde/Document.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 getDescription uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
            return config('app.description');
        }
    Severity: Minor
    Found in lib/Ajde/Document.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

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

                    } else {
                    // TODO:
                    throw new Ajde_Exception('Document processor must be registered on either \'layout\' or \'compressor\'');
                }
    Severity: Minor
    Found in lib/Ajde/Document.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 using static access to class 'Ajde' in method 'fromRoute'.
    Open

                Ajde::routingError($exception);
    Severity: Minor
    Found in lib/Ajde/Document.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 unused parameters such as '$resource'.
    Open

        public function addResource(Ajde_Resource $resource)
    Severity: Minor
    Found in lib/Ajde/Document.php by phpmd

    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

    Avoid unused parameters such as '$cacheControl'.
    Open

        protected function setCacheControlHeader($cacheControl = null)
    Severity: Minor
    Found in lib/Ajde/Document.php by phpmd

    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

    Avoid unused parameters such as '$contentType'.
    Open

        protected function setContentTypeHeader($contentType = null)
    Severity: Minor
    Found in lib/Ajde/Document.php by phpmd

    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

    TODO found
    Open

                        // TODO:
    Severity: Minor
    Found in lib/Ajde/Document.php by fixme

    TODO found
    Open

                        // TODO:
    Severity: Minor
    Found in lib/Ajde/Document.php by fixme

    The property $_contentType is not named in camelCase.
    Open

    abstract class Ajde_Document extends Ajde_Object_Standard
{
    const CACHE_CONTROL_PUBLIC = 'public';
    const CACHE_CONTROL_PRIVATE = 'private';
    const CACHE_CONTROL_NOCACHE = 'no-cache';
    Severity: Minor
    Found in lib/Ajde/Document.php by phpmd

    CamelCasePropertyName

    Since: 0.2

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

    Example

    class ClassName {
    protected $property_name;
}

    Source

    The class Ajde_Document is not named in CamelCase.
    Open

    abstract class Ajde_Document extends Ajde_Object_Standard
{
    const CACHE_CONTROL_PUBLIC = 'public';
    const CACHE_CONTROL_PRIVATE = 'private';
    const CACHE_CONTROL_NOCACHE = 'no-cache';
    Severity: Minor
    Found in lib/Ajde/Document.php by phpmd

    CamelCaseClassName

    Since: 0.2

    It is considered best practice to use the CamelCase notation to name classes.

    Example

    class class_name {
}

    Source

    The property $_maxAge is not named in camelCase.
    Open

    abstract class Ajde_Document extends Ajde_Object_Standard
{
    const CACHE_CONTROL_PUBLIC = 'public';
    const CACHE_CONTROL_PRIVATE = 'private';
    const CACHE_CONTROL_NOCACHE = 'no-cache';
    Severity: Minor
    Found in lib/Ajde/Document.php by phpmd

    CamelCasePropertyName

    Since: 0.2

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

    Example

    class ClassName {
    protected $property_name;
}

    Source

    The property $_cacheControl is not named in camelCase.
    Open

    abstract class Ajde_Document extends Ajde_Object_Standard
{
    const CACHE_CONTROL_PUBLIC = 'public';
    const CACHE_CONTROL_PRIVATE = 'private';
    const CACHE_CONTROL_NOCACHE = 'no-cache';
    Severity: Minor
    Found in lib/Ajde/Document.php by phpmd

    CamelCasePropertyName

    Since: 0.2

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

    Example

    class ClassName {
    protected $property_name;
}

    Source

    There are no issues that match your filters.

    Category
    Status