XoopsModules25x/apcal

View on GitHub
include/comment_functions.php

Summary

Maintainability
A
25 mins
Test Coverage

apcal_comments_update accesses the super-global variable $GLOBALS.
Open

    function apcal_comments_update($event_id, $total_num)
    {
        // record total_num
        global $xoopsDB, $cal;

Severity: Minor
Found in include/comment_functions.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

apcal_comments_update accesses the super-global variable $GLOBALS.
Open

    function apcal_comments_update($event_id, $total_num)
    {
        // record total_num
        global $xoopsDB, $cal;

Severity: Minor
Found in include/comment_functions.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

Function apcal_comments_update has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    function apcal_comments_update($event_id, $total_num)
    {
        // record total_num
        global $xoopsDB, $cal;

Severity: Minor
Found in include/comment_functions.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

Avoid unused local variables such as '$xoopsDB'.
Open

        global $xoopsDB, $cal;
Severity: Minor
Found in include/comment_functions.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 parameters such as '$comment'.
Open

    function apcal_comments_approve(&$comment)
Severity: Minor
Found in include/comment_functions.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

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

        } else {
            $moduleDirName = basename(dirname(__DIR__));
            if (!preg_match('/^(\D+)(\d*)$/', $moduleDirName, $regs)) {
                echo('invalid dirname: ' . htmlspecialchars($moduleDirName));
            }
Severity: Minor
Found in include/comment_functions.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 parameter $event_id is not named in camelCase.
Open

    function apcal_comments_update($event_id, $total_num)
    {
        // record total_num
        global $xoopsDB, $cal;

Severity: Minor
Found in include/comment_functions.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 $total_num is not named in camelCase.
Open

    function apcal_comments_update($event_id, $total_num)
    {
        // record total_num
        global $xoopsDB, $cal;

Severity: Minor
Found in include/comment_functions.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 $total_num is not named in camelCase.
Open

    function apcal_comments_update($event_id, $total_num)
    {
        // record total_num
        global $xoopsDB, $cal;

Severity: Minor
Found in include/comment_functions.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 $event_id is not named in camelCase.
Open

    function apcal_comments_update($event_id, $total_num)
    {
        // record total_num
        global $xoopsDB, $cal;

Severity: Minor
Found in include/comment_functions.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