AppStateESS/InternshipInventory

View on GitHub
class/Email/BackgroundCheckEmail.php

Summary

Maintainability
A
3 hrs
Test Coverage

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

    protected function buildMessage()
    {
        $this->to = explode(',', $this->emailSettings->getBackgroundCheckEmail());
        $host = $this->internship->getHost();

Severity: Minor
Found in class/Email/BackgroundCheckEmail.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 buildMessage has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function buildMessage()
    {
        $this->to = explode(',', $this->emailSettings->getBackgroundCheckEmail());
        $host = $this->internship->getHost();

Severity: Minor
Found in class/Email/BackgroundCheckEmail.php - About 1 hr to fix

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

    public function __construct(InternSettings $emailSettings, Internship $internship, Term $term, $backgroundCheck, $drugCheck) {
Severity: Minor
Found in class/Email/BackgroundCheckEmail.php - About 35 mins to fix

Missing class import via use statement (line '98', column '23').
Open

            throw new \InvalidArgumentException( 'Both background check and drug test varaibles were false. One or both must be set to true.');
Severity: Minor
Found in class/Email/BackgroundCheckEmail.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

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

        $this->tpl['USER'] = \Current_User::getUsername();
Severity: Minor
Found in class/Email/BackgroundCheckEmail.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 '\Current_User' in method 'buildMessage'.
Open

        $this->tpl['USER_FULL_NAME'] = \Current_User::getDisplayName();
Severity: Minor
Found in class/Email/BackgroundCheckEmail.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 buildMessage uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            // Both variables were false, what are we doing here?
            throw new \InvalidArgumentException( 'Both background check and drug test varaibles were false. One or both must be set to true.');
        }
Severity: Minor
Found in class/Email/BackgroundCheckEmail.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 buildMessage uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            $this->tpl['FACULTY'] = 'Faculty supervisor not set.';
        }
Severity: Minor
Found in class/Email/BackgroundCheckEmail.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

Call to method getDisplayName from undeclared class \Current_User
Open

        $this->tpl['USER_FULL_NAME'] = \Current_User::getDisplayName();
Severity: Critical
Found in class/Email/BackgroundCheckEmail.php by phan

Possibly zero references to use statement for classlike/namespace TermFactory (\Intern\TermFactory)
Open

use \Intern\TermFactory;
Severity: Minor
Found in class/Email/BackgroundCheckEmail.php by phan

Call to method getUsername from undeclared class \Current_User
Open

        $this->tpl['USER'] = \Current_User::getUsername();
Severity: Critical
Found in class/Email/BackgroundCheckEmail.php by phan

There are no issues that match your filters.

Category
Status