Showing 116 of 116 total issues
Avoid too many return statements within this method. Open
case WorkflowState::STAGE_SUMMARY: return 'Summary';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): Validate- Read upRead up
- Exclude checks
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 executeWorkflow has a boolean flag argument $throwOnFailure, which is a certain sign of a Single Responsibility Principle violation. Open
bool $throwOnFailure = true- Read upRead up
- Exclude checks
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 executeWorkflow has a boolean flag argument $throwOnFailure, which is a certain sign of a Single Responsibility Principle violation. Open
bool $throwOnFailure = true- Read upRead up
- Exclude checks
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
Function executeWorkflow has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
public function executeWorkflow(
WorkflowContainer $workflowContainer = null,
bool $throwOnFailure = true
): WorkflowResult {
if (!$workflowContainer) {- Read upRead up
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
Avoid unused parameters such as '$control'. Open
WorkflowControl $control,- Read upRead up
- Exclude checks
UnusedFormalParameter
Since: 0.2
Avoid passing parameters to methods or constructors and then not using those parameters.
Example
class Foo
{
private function bar($howdy)
{
// $howdy is not used
}
}Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter
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;- Read upRead up
- Exclude checks
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 run uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
if ($exception instanceof BreakException) {
WorkflowState::getRunningWorkflow()->addExecutionLog(
new Summary("Loop iteration #$iteration"),
ExecutionLog::STATE_SKIPPED,- Read upRead up
- Exclude checks
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 '\PHPWorkflow\State\ExecutionLog\ExecutionLog' in method 'format'. Open
ExecutionLog::mapStage($stage)- Read upRead up
- Exclude checks
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 '\PHPWorkflow\State\WorkflowState' in method 'run'. Open
$this->wrapStepExecution($step, WorkflowState::getRunningWorkflow());- Read upRead up
- Exclude checks
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 '\PHPWorkflow\State\ExecutionLog\ExecutionLog' in method 'renderWorkflowGraph'. Open
ExecutionLog::mapStage($stage)- Read upRead up
- Exclude checks
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 wrapStepExecution() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. Open
protected function wrapStepExecution(WorkflowStep $step, WorkflowState $workflowState): void {
try {
($this->resolveMiddleware($step, $workflowState))();
} catch (SkipStepException | FailStepException $exception) {
$workflowState->addExecutionLog(- Read upRead up
- Exclude checks
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 run() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. Open
public function run(WorkflowControl $control, WorkflowContainer $container): void
{
$iteration = 0;
WorkflowState::getRunningWorkflow()->setInLoop(true);- Read upRead up
- Exclude checks
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 check() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. Open
public function check(WorkflowContainer $container): void
{
if (!$container->has($this->key)) {
throw new WorkflowStepDependencyNotFulfilledException("Missing '$this->key' in container");
}- Read upRead up
- Exclude checks
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
Space before opening parenthesis of function call prohibited Open
$profile = fn () => $control->attachStepInfo(- Exclude checks
Closing brace must be on a line by itself Open
case WorkflowState::STAGE_ON_SUCCESS: return 'On Success';- Exclude checks
Multi-line function call not indented correctly; expected 28 spaces but found 32 Open
$info->getInfo(),- Exclude checks
Closing brace must be on a line by itself Open
default: return "{$this->indentation} - " . $info->getInfo();- Exclude checks
Space before opening parenthesis of function call prohibited Open
$tip = fn () => $step->run($workflowState->getWorkflowControl(), $workflowState->getWorkflowContainer());- Exclude checks
Opening brace should be on a new line Open
public function __construct(private string $key, private ?string $type = null) {}- Exclude checks