wol-soft/php-workflow

View on GitHub
src/Stage/Validate.php

Summary

Maintainability
A
2 hrs
Test Coverage
A
100%

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

    protected function runStage(WorkflowState $workflowState): ?Stage
    {
        $workflowState->setStage(WorkflowState::STAGE_VALIDATE);

        // make sure hard validators are executed first
Severity: Minor
Found in src/Stage/Validate.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 runStage has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function runStage(WorkflowState $workflowState): ?Stage
    {
        $workflowState->setStage(WorkflowState::STAGE_VALIDATE);

        // make sure hard validators are executed first
Severity: Minor
Found in src/Stage/Validate.php - About 1 hr to fix

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

        public function validate(WorkflowStep $step, bool $hardValidator = false): self
    Severity: Minor
    Found in src/Stage/Validate.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 runStage uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                    try {
                        $this->wrapStepExecution($validator->getStep(), $workflowState);
                    } catch (SkipWorkflowException $exception) {
                        throw $exception;
    Severity: Minor
    Found in src/Stage/Validate.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

    syntax error, unexpected 'array' (T_ARRAY), expecting function (T_FUNCTION) or const (T_CONST)
    Open

        private array $validators = [];
    Severity: Critical
    Found in src/Stage/Validate.php by phan

    There are no issues that match your filters.

    Category
    Status