XoopsModules25x/xfguestbook

View on GitHub
blocks/xfguestbook_new.php

Summary

Maintainability
A
3 hrs
Test Coverage

Function b_xfguestbook_show has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

function b_xfguestbook_show($options)
{
    global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
    /** @var Helper $helper */
    $helper = Helper::getInstance();
Severity: Minor
Found in blocks/xfguestbook_new.php - About 2 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 b_xfguestbook_show has 46 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function b_xfguestbook_show($options)
{
    global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
    /** @var Helper $helper */
    $helper = Helper::getInstance();
Severity: Minor
Found in blocks/xfguestbook_new.php - About 1 hr to fix

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

        $criteria       = new \Criteria('moderate', '0', '=');
    Severity: Minor
    Found in blocks/xfguestbook_new.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

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

        } else {
            $block['full_view'] = false;
        }
    Severity: Minor
    Found in blocks/xfguestbook_new.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 b_xfguestbook_show uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

        } else {
            $module = $xoopsModule;
            $config = $xoopsModuleConfig;
        }
    Severity: Minor
    Found in blocks/xfguestbook_new.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 '\XoopsModules\Xfguestbook\Helper' in method 'b_xfguestbook_show'.
    Open

        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 '\MyTextSanitizer' in method 'b_xfguestbook_show'.
    Open

            $ts  = \MyTextSanitizer::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 b_xfguestbook_show uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

        } else {
            $block['nbmsg'] = 0;
        }
    Severity: Minor
    Found in blocks/xfguestbook_new.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 local variables such as '$config'.
    Open

            $config        = $configHandler->getConfigsByCat(0, $module->getVar('mid'));
    Severity: Minor
    Found in blocks/xfguestbook_new.php by phpmd

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

        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
    Severity: Minor
    Found in blocks/xfguestbook_new.php by phpmd

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

            $ts  = \MyTextSanitizer::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.php by phpmd

    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 variables with short names like $ts. Configured minimum length is 3.
    Open

            $ts  = \MyTextSanitizer::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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

    Line exceeds 120 characters; contains 160 characters
    Open

        $form .= '&nbsp;<br>' . MB_XFGUESTBOOK_CHARS . "&nbsp;<input type='text' name='options[]' value='" . $options[1] . '\'>&nbsp;' . MB_XFGUESTBOOK_LENGTH . '';
    Severity: Minor
    Found in blocks/xfguestbook_new.php by phpcodesniffer

    The variable $msg_id is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $msg_id is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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 $a_item is not named in camelCase.
    Open

    function b_xfguestbook_show($options)
    {
        global $xoopsModule, $xoopsModuleConfig, $xoopsDB;
        /** @var Helper $helper */
        $helper = Helper::getInstance();
    Severity: Minor
    Found in blocks/xfguestbook_new.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