Function __construct has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
public function __construct(
DocumentResource $documentResource,
ResourceCache $resourceCache,
array $include = [],
array $sparseFields = [],- 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
Method __construct has 6 arguments (exceeds 4 allowed). Consider refactoring. Open
DocumentResource $documentResource,
ResourceCache $resourceCache,
array $include = [],
array $sparseFields = [],
DocumentPagination $pagination = NULL,The method __construct has a boolean flag argument $i18n, which is a certain sign of a Single Responsibility Principle violation. Open
$i18n = FALSE- 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 __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$documentResource
= ResourceCollection::buildFromResource($documentResource);
}- 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 'GoIntegro\Hateoas\JsonApi\ResourceCollection' in method '__construct'. Open
= ResourceCollection::buildFromResource($documentResource);- 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 closing parenthesis and the opening brace of a multi-line function declaration must be on the same line Open
{- Exclude checks
There must be one USE keyword per declaration Open
use IteratorAggregate, AppendIterator, Countable;- Exclude checks
The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line Open
{- Exclude checks
TRUE, FALSE and NULL must be lowercase; expected "true" but found "TRUE" Open
$this->wasCollection = TRUE;- Exclude checks
TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL" Open
$meta = NULL;- Exclude checks
TRUE, FALSE and NULL must be lowercase; expected "false" but found "FALSE" Open
public $wasCollection = FALSE;- Exclude checks
TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL" Open
DocumentResource $resource = NULL, $key = NULL- Exclude checks
TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL" Open
DocumentResource $resource = NULL, $key = NULL- Exclude checks
TRUE, FALSE and NULL must be lowercase; expected "false" but found "FALSE" Open
$i18n = FALSE- Exclude checks
Multi-line function declarations must define one parameter per line Open
DocumentResource $resource = NULL, $key = NULL- Exclude checks
TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL" Open
DocumentPagination $pagination = NULL,- Exclude checks