kai-jacobsen/kontentblocks

View on GitHub
includes/wp-api.php

Summary

Maintainability
A
35 mins
Test Coverage

Method kb_render_area has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

function kb_render_area( $area = null, $post_id = null, $additionalArgs = null, $moduleSettings = array(), $echo = true )
Severity: Minor
Found in includes/wp-api.php - About 35 mins to fix

    The method kb_render_area has a boolean flag argument $echo, which is a certain sign of a Single Responsibility Principle violation.
    Open

    function kb_render_area( $area = null, $post_id = null, $additionalArgs = null, $moduleSettings = array(), $echo = true )
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
        public function bar($flag = true) {
        }
    }

    Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

    Avoid using static access to class '\Kontentblocks\Kontentblocks' in method 'Kontentblocks'.
    Open

        return Kontentblocks::getInstance();
    Severity: Minor
    Found in includes/wp-api.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 parameter $post_id is not named in camelCase.
    Open

    function kb_render_area( $area = null, $post_id = null, $additionalArgs = null, $moduleSettings = array(), $echo = true )
    {
        \Kontentblocks\renderSingleArea( $area, $post_id, $additionalArgs, $moduleSettings, $echo );
    }
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    CamelCaseParameterName

    Since: 0.2

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

    Example

    class ClassName {
        public function doSomething($user_name) {
        }
    }

    Source

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

    function kb_render_area_sidebar( $id = null, $additionalArgs = array() )
    Severity: Minor
    Found in includes/wp-api.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

    The parameter $post_id is not named in camelCase.
    Open

    function kb_render_context( $context = null, $post_id = null, $additionalArgs = array() )
    {
        \Kontentblocks\renderContext( $context, $post_id, $additionalArgs );
    }
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    CamelCaseParameterName

    Since: 0.2

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

    Example

    class ClassName {
        public function doSomething($user_name) {
        }
    }

    Source

    The parameter $area_id is not named in camelCase.
    Open

    function has_modules( $area_id, $post_id = null )
    {
        return \Kontentblocks\hasModules( $area_id, $post_id );
    }
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    CamelCaseParameterName

    Since: 0.2

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

    Example

    class ClassName {
        public function doSomething($user_name) {
        }
    }

    Source

    The parameter $post_id is not named in camelCase.
    Open

    function has_modules( $area_id, $post_id = null )
    {
        return \Kontentblocks\hasModules( $area_id, $post_id );
    }
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    CamelCaseParameterName

    Since: 0.2

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

    Example

    class ClassName {
        public function doSomething($user_name) {
        }
    }

    Source

    The variable $post_id is not named in camelCase.
    Open

    function kb_render_area( $area = null, $post_id = null, $additionalArgs = null, $moduleSettings = array(), $echo = true )
    {
        \Kontentblocks\renderSingleArea( $area, $post_id, $additionalArgs, $moduleSettings, $echo );
    }
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    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 $post_id is not named in camelCase.
    Open

    function kb_render_context( $context = null, $post_id = null, $additionalArgs = array() )
    {
        \Kontentblocks\renderContext( $context, $post_id, $additionalArgs );
    }
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    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 $post_id is not named in camelCase.
    Open

    function has_modules( $area_id, $post_id = null )
    {
        return \Kontentblocks\hasModules( $area_id, $post_id );
    }
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    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 $area_id is not named in camelCase.
    Open

    function has_modules( $area_id, $post_id = null )
    {
        return \Kontentblocks\hasModules( $area_id, $post_id );
    }
    Severity: Minor
    Found in includes/wp-api.php by phpmd

    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