Sign upLogin

iranianpep/code-jetter

View on GitHub
Star
core/Mailer.php

Summary

Maintainability
A
3 hrs
Test Coverage

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

    public function send($to, $subject, $message)
    {
        if (empty($to)) {
            throw new \Exception('Recipient for sending email cannot be empty');
        }
Severity: Minor
Found in core/Mailer.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

Method send has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function send($to, $subject, $message)
    {
        if (empty($to)) {
            throw new \Exception('Recipient for sending email cannot be empty');
        }
Severity: Minor
Found in core/Mailer.php - About 1 hr to fix

    Function __construct has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        public function __construct()
    {
        // True means throwing error if there is any
        $mailer = new PHPMailer(true);
    Severity: Minor
    Found in core/Mailer.php - About 45 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

    Missing class import via use statement (line '100', column '18').
    Open

                (new \CodeJetter\core\ErrorHandler())->logError($e);
    Severity: Minor
    Found in core/Mailer.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 '68', column '23').
    Open

                throw new \Exception('Recipient for sending email cannot be empty');
    Severity: Minor
    Found in core/Mailer.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 '35').
    Open

                            throw new \Exception("Email: '{$recipient}' is not valid");
    Severity: Minor
    Found in core/Mailer.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 '31', column '23').
    Open

                throw new \Exception('Specified default mailer does not exist in mailers list');
    Severity: Minor
    Found in core/Mailer.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 '102', column '18').
    Open

                (new \CodeJetter\core\ErrorHandler())->logError($e);
    Severity: Minor
    Found in core/Mailer.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 '85', column '31').
    Open

                        throw new \Exception("Email: '{$to}' is not valid");
    Severity: Minor
    Found in core/Mailer.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 send uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                if ($this->validateEmail($to) !== true) {
                    throw new \Exception("Email: '{$to}' is not valid");
                }
    Severity: Minor
    Found in core/Mailer.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 'CodeJetter\core\Registry' in method '__construct'.
    Open

            $config = Registry::getConfigClass();
    Severity: Minor
    Found in core/Mailer.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 $to. Configured minimum length is 3.
    Open

        public function send($to, $subject, $message)
    Severity: Minor
    Found in core/Mailer.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

    There are no issues that match your filters.

    Category
    Status