eidng8/sttbot

View on GitHub
src/Wiki/Models/CrewMember.php

Summary

Maintainability
A
3 hrs
Test Coverage

The class CrewMember has 20 public methods. Consider refactoring CrewMember to keep number of public methods under 10.
Open

class CrewMember extends Model implements Hyperlink
{
    /**
     * Member name, also used in generating URI & page
     *
Severity: Minor
Found in src/Wiki/Models/CrewMember.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

The class CrewMember has an overall complexity of 57 which is very high. The configured complexity threshold is 50.
Open

class CrewMember extends Model implements Hyperlink
{
    /**
     * Member name, also used in generating URI & page
     *
Severity: Minor
Found in src/Wiki/Models/CrewMember.php by phpmd

CrewMember has 25 functions (exceeds 20 allowed). Consider refactoring.
Open

class CrewMember extends Model implements Hyperlink
{
    /**
     * Member name, also used in generating URI & page
     *
Severity: Minor
Found in src/Wiki/Models/CrewMember.php - About 2 hrs to fix

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

    public function offsetSet($offset, $value)
    {
        switch (strtolower($offset)) {
            case 'crewname':
                list($this->name, $this->page) = $this->parseName($value);
Severity: Minor
Found in src/Wiki/Models/CrewMember.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

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

    public function canUnlock(MissionStep $step): bool
    {
        foreach ($step->locks as $lock) {
            if (empty($lock)) {
                continue;
Severity: Minor
Found in src/Wiki/Models/CrewMember.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

The method canPassCadet has a boolean flag argument $critical, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function canPassCadet(MissionStep $step, bool $critical = false)
Severity: Minor
Found in src/Wiki/Models/CrewMember.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

The method canPass has a boolean flag argument $critical, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function canPass(MissionStep $step, bool $critical = false): bool
Severity: Minor
Found in src/Wiki/Models/CrewMember.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

Avoid using static access to class 'eidng8\Wiki\Models\Skills' in method 'offsetGet'.
Open

        if (Skills::isSkill($offset)) {
Severity: Minor
Found in src/Wiki/Models/CrewMember.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 'eidng8\Wiki\Models\Skills' in method 'offsetSet'.
Open

                if (Skills::isSkill($offset)) {
Severity: Minor
Found in src/Wiki/Models/CrewMember.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 __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

            } else {
                $this[$key] = $value;
            }
Severity: Minor
Found in src/Wiki/Models/CrewMember.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 'eidng8\Wiki\Models\Skills' in method 'offsetUnset'.
Open

                if (Skills::isSkill($offset)) {
Severity: Minor
Found in src/Wiki/Models/CrewMember.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 offsetSet uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

                } else {
                    parent::offsetSet($offset, $value);
                }
Severity: Minor
Found in src/Wiki/Models/CrewMember.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 'eidng8\Wiki\Models\Skills' in method 'offsetExists'.
Open

        if (Skills::isSkill($offset)) {
Severity: Minor
Found in src/Wiki/Models/CrewMember.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

There are no issues that match your filters.

Category
Status