Sign upLogin

eidng8/sttbot

View on GitHub
Star
src/Wiki/Templates/Mission.php

Summary

Maintainability
D
1 day
Test Coverage

The class Mission has 11 public methods. Consider refactoring Mission to keep number of public methods under 10.
Open

class Mission extends Template
{
    private $advanced = false;

    /**
Severity: Minor
Found in src/Wiki/Templates/Mission.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

Function parseStep has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
Open

    public function parseStep(string $text): array
    {
        $columns = [
            'steptitle'  => 'name',
            'choice'     => 'alt',
Severity: Minor
Found in src/Wiki/Templates/Mission.php - About 2 hrs 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 parseStepProp has 64 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function parseStepProp(
        string $key,
        string $values,
        string $advValues
    ) {
Severity: Major
Found in src/Wiki/Templates/Mission.php - About 2 hrs to fix

File Mission.php has 266 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * Created by PhpStorm.
 * User: JC
 * Date: 2016-11-20
Severity: Minor
Found in src/Wiki/Templates/Mission.php - About 2 hrs to fix

Function parseStepProp has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

    public function parseStepProp(
        string $key,
        string $values,
        string $advValues
    ) {
Severity: Minor
Found in src/Wiki/Templates/Mission.php - About 2 hrs 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 parseStep has 52 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function parseStep(string $text): array
    {
        $columns = [
            'steptitle'  => 'name',
            'choice'     => 'alt',
Severity: Major
Found in src/Wiki/Templates/Mission.php - About 2 hrs to fix

Method createModel has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function createModel(): MissionModel
    {
        $model = new MissionModel();
        /* @var InfoBox $info */
        $info = $this->found['info'];
Severity: Minor
Found in src/Wiki/Templates/Mission.php - About 1 hr to fix

Function createModel has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    public function createModel(): MissionModel
    {
        $model = new MissionModel();
        /* @var InfoBox $info */
        $info = $this->found['info'];
Severity: Minor
Found in src/Wiki/Templates/Mission.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

Function parseMWHead has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    public function parseMWHead(string $head): array
    {
        $lines = explode("\n", $head);

        $intro = [];
Severity: Minor
Found in src/Wiki/Templates/Mission.php - About 35 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 parseStep() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
Open

    public function parseStep(string $text): array
    {
        $columns = [
            'steptitle'  => 'name',
            'choice'     => 'alt',
Severity: Minor
Found in src/Wiki/Templates/Mission.php by phpmd

CyclomaticComplexity

Since: 0.1

Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

Example

// Cyclomatic Complexity = 11
class Foo {
1   public function example() {
2       if ($a == $b) {
3           if ($a1 == $b1) {
                fiddle();
4           } elseif ($a2 == $b2) {
                fiddle();
            } else {
                fiddle();
            }
5       } elseif ($c == $d) {
6           while ($c == $d) {
                fiddle();
            }
7        } elseif ($e == $f) {
8           for ($n = 0; $n < $h; $n++) {
                fiddle();
            }
        } else {
            switch ($z) {
9               case 1:
                    fiddle();
                    break;
10              case 2:
                    fiddle();
                    break;
11              case 3:
                    fiddle();
                    break;
                default:
                    fiddle();
                    break;
            }
        }
    }
}

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

The method parseStepProp() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
Open

    public function parseStepProp(
        string $key,
        string $values,
        string $advValues
    ) {
Severity: Minor
Found in src/Wiki/Templates/Mission.php by phpmd

CyclomaticComplexity

Since: 0.1

Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

Example

// Cyclomatic Complexity = 11
class Foo {
1   public function example() {
2       if ($a == $b) {
3           if ($a1 == $b1) {
                fiddle();
4           } elseif ($a2 == $b2) {
                fiddle();
            } else {
                fiddle();
            }
5       } elseif ($c == $d) {
6           while ($c == $d) {
                fiddle();
            }
7        } elseif ($e == $f) {
8           for ($n = 0; $n < $h; $n++) {
                fiddle();
            }
        } else {
            switch ($z) {
9               case 1:
                    fiddle();
                    break;
10              case 2:
                    fiddle();
                    break;
11              case 3:
                    fiddle();
                    break;
                default:
                    fiddle();
                    break;
            }
        }
    }
}

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

Avoid using static access to class '\eidng8\Wiki\Template' in method 'parseMWHead'.
Open

                $traits = Template::explode($found[1][0]);
Severity: Minor
Found in src/Wiki/Templates/Mission.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 parseStep uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

            } else {
                $alt = null;
            }
Severity: Minor
Found in src/Wiki/Templates/Mission.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\Templates\Triple' in method 'parseStepProp'.
Open

                        $adv = Triple::empty($triple->name);
Severity: Minor
Found in src/Wiki/Templates/Mission.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\Templates\Triple' in method 'parseStepProp'.
Open

            $triple = Triple::load($value);
Severity: Minor
Found in src/Wiki/Templates/Mission.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\Templates\Triple' in method 'parseStepProp'.
Open

                        $adv = Triple::empty($triple->name);
Severity: Minor
Found in src/Wiki/Templates/Mission.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\Log\Log' in method 'parseStep'.
Open

                    Log::warn($e->getMessage());
Severity: Minor
Found in src/Wiki/Templates/Mission.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 parseStep uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

            } else {
                $props[$key] = trim($value);
            }
Severity: Minor
Found in src/Wiki/Templates/Mission.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 createModel uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            $model->type = MissionModel::AWAY_TEAM;
            $model->traits = $this->found['intro']['traits'];

            $model->steps = [];
Severity: Minor
Found in src/Wiki/Templates/Mission.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\Log\Log' in method 'parseStep'.
Open

                    Log::notice($e->getMessage());
Severity: Minor
Found in src/Wiki/Templates/Mission.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