Sign upLogin

XoopsModules25x/xoopspoll

View on GitHub
Star
class/PollHandler.php

Summary

Maintainability
A
3 hrs
Test Coverage

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

mailResults accesses the super-global variable $GLOBALS.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.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

Method mailResults has 46 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
Severity: Minor
Found in class/PollHandler.php - About 1 hr to fix

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

        public function mailResults(mixed $pollObj = null): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
        $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
    Severity: Minor
    Found in class/PollHandler.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 '76', column '28').
    Open

            $criteria->add(new \Criteria('mail_status', Constants::POLL_NOT_MAILED, '=')); // email not previously sent
    Severity: Minor
    Found in class/PollHandler.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 '78', column '32').
    Open

                $criteria->add(new \Criteria('poll_id', $pollObj->getVar('poll_id'), '='));
    Severity: Minor
    Found in class/PollHandler.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 '75', column '28').
    Open

            $criteria->add(new \Criteria('end_time', \time(), '<'));  // expired polls
    Severity: Minor
    Found in class/PollHandler.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 '106', column '27').
    Open

                $author = new \XoopsUser($pollValues['user_id']);
    Severity: Minor
    Found in class/PollHandler.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 '74', column '25').
    Open

            $criteria = new \CriteriaCompo();
    Severity: Minor
    Found in class/PollHandler.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 mailResults uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                    } else {
                    $ret[] = $xoopsMailer->getErrors(false); // return error array from mailer
                }
    Severity: Minor
    Found in class/PollHandler.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\Xoopspoll\Helper' in method '__construct'.
    Open

            $this->helper = $helper ?? Helper::getInstance();
    Severity: Minor
    Found in class/PollHandler.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 variables with short names like $db. Configured minimum length is 3.
    Open

        public function __construct(\XoopsDatabase $db = null, Helper $helper = null)
    Severity: Minor
    Found in class/PollHandler.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 122 characters
    Open

                    $xoopsMailer->assign('POLL_START', \formatTimestamp($pollValues['start_time'], 'l', $author->timezone()));
    Severity: Minor
    Found in class/PollHandler.php by phpcodesniffer

    Line exceeds 120 characters; contains 133 characters
    Open

                    $xoopsMailer->setSubject(\sprintf(\_MD_XOOPSPOLL_YOURPOLLAT, $author->uname(), $GLOBALS['xoopsConfig']['sitename']));
    Severity: Minor
    Found in class/PollHandler.php by phpcodesniffer

    Line exceeds 120 characters; contains 152 characters
    Open

            if (\file_exists($GLOBALS['xoops']->path('modules/xoopspoll/language/' . $GLOBALS['xoopsConfig']['language'] . '/mail_template/' . $tplFile))) {
    Severity: Minor
    Found in class/PollHandler.php by phpcodesniffer

    Line exceeds 120 characters; contains 121 characters
    Open

            $xoopsMailer->setTemplateDir($GLOBALS['xoops']->path('modules/xoopspoll/language/' . $lang . '/mail_template/'));
    Severity: Minor
    Found in class/PollHandler.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status