src/SchemaProcessor/PostProcessor/EnumPostProcessor.php
Method process has 59 lines of code (exceeds 25 allowed). Consider refactoring. Open
Open
public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
{
$generatorConfiguration->addFilter(new EnumFilter());
foreach ($schema->getProperties() as $property) {Function process has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring. Open
Open
public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
{
$generatorConfiguration->addFilter(new EnumFilter());
foreach ($schema->getProperties() as $property) {- 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 validateEnum has 34 lines of code (exceeds 25 allowed). Consider refactoring. Open
Open
private function validateEnum(PropertyInterface $property): bool
{
$throw = function (string $message) use ($property): void {
throw new SchemaException(
sprintf(Method renderEnum has 33 lines of code (exceeds 25 allowed). Consider refactoring. Open
Open
private function renderEnum(
GeneratorConfiguration $generatorConfiguration,
JsonSchema $jsonSchema,
string $name,
array $values,Function validateEnum has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
Open
private function validateEnum(PropertyInterface $property): bool
{
$throw = function (string $message) use ($property): void {
throw new SchemaException(
sprintf(- 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
Function renderEnum has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
Open
private function renderEnum(
GeneratorConfiguration $generatorConfiguration,
JsonSchema $jsonSchema,
string $name,
array $values,- 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 renderEnum has 5 arguments (exceeds 4 allowed). Consider refactoring. Open
Open
GeneratorConfiguration $generatorConfiguration,
JsonSchema $jsonSchema,
string $name,
array $values,
?array $map,The method validateEnum() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. Open
Open
private function validateEnum(PropertyInterface $property): bool
{
$throw = function (string $message) use ($property): void {
throw new SchemaException(
sprintf(- 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 class EnumPostProcessor has a coupling between objects value of 19. Consider to reduce the number of dependencies under 13. Open
Open
class EnumPostProcessor extends PostProcessor
{
private array $generatedEnums = [];
private string $namespace;- Read upRead up
- Exclude checks
CouplingBetweenObjects
Since: 1.1.0
A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability
Example
class Foo {
/**
* @var \foo\bar\X
*/
private $x = null;
/**
* @var \foo\bar\Y
*/
private $y = null;
/**
* @var \foo\bar\Z
*/
private $z = null;
public function setFoo(\Foo $foo) {}
public function setBar(\Bar $bar) {}
public function setBaz(\Baz $baz) {}
/**
* @return \SplObjectStorage
* @throws \OutOfRangeException
* @throws \InvalidArgumentException
* @throws \ErrorException
*/
public function process(\Iterator $it) {}
// ...
}Source https://phpmd.org/rules/design.html#couplingbetweenobjects
The method __construct has a boolean flag argument $skipNonMappedEnums, which is a certain sign of a Single Responsibility Principle violation. Open
Open
private bool $skipNonMappedEnums = 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
Avoid using static access to class '\PHPModelGenerator\Utils\ArrayHash' in method 'process'. Open
Open
$enumSignature = ArrayHash::hash($json, ['enum', 'enum-map', '$id']);- 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 '\PHPModelGenerator\Utils\NormalizedName' in method 'renderEnum'. Open
Open
$caseName = ucfirst(NormalizedName::from($map ? array_search($value, $map, true) : $value, $jsonSchema));- 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 process uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
if ($generatorConfiguration->isOutputEnabled()) {
// @codeCoverageIgnoreStart
echo "Duplicated signature $enumSignature for enum $enumName." .
" Redirecting to {$this->generatedEnums[$enumSignature]['name']}\n";- 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
syntax error, unexpected 'array' (T_ARRAY), expecting function (T_FUNCTION) or const (T_CONST) Open
Open
private array $generatedEnums = [];- Exclude checks
Avoid variables with short names like $a. Configured minimum length is 3. Open
Open
fn($a, $b): int => $a === $b ? 0 : 1,- Read upRead up
- Exclude checks
ShortVariable
Since: 0.2
Detects when a field, local, or parameter has a very short name.
Example
class Something {
private $q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal
$r = 20 + $this->q; // VIOLATION - Local
for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
$r += $this->q;
}
}
}Source https://phpmd.org/rules/naming.html#shortvariable
Avoid variables with short names like $b. Configured minimum length is 3. Open
Open
fn($a, $b): int => $a === $b ? 0 : 1,- Read upRead up
- Exclude checks
ShortVariable
Since: 0.2
Detects when a field, local, or parameter has a very short name.
Example
class Something {
private $q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal
$r = 20 + $this->q; // VIOLATION - Local
for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
$r += $this->q;
}
}
}Source https://phpmd.org/rules/naming.html#shortvariable
A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 45 and the first side effect is on line 29. Open
Open
<?php- Exclude checks
Each PHP statement must be on a line by itself Open
Open
case ['string']: $backedType = 'string'; break;- Exclude checks
Each PHP statement must be on a line by itself Open
Open
case ['integer']: $backedType = 'int'; break;- Exclude checks
The CASE body must start on the line following the statement Open
Open
case ['string']: $backedType = 'string'; break;- Exclude checks
Terminating statement must be on a line by itself Open
Open
case ['string']: $backedType = 'string'; break;- Exclude checks
Terminating statement must be on a line by itself Open
Open
case ['integer']: $backedType = 'int'; break;- Exclude checks
Possible parse error: class missing opening or closing brace Open
Open
class EnumPostProcessor extends PostProcessor- Exclude checks
Possible parse error: class missing opening or closing brace Open
Open
class EnumPostProcessor extends PostProcessor- Exclude checks
The CASE body must start on the line following the statement Open
Open
case ['integer']: $backedType = 'int'; break;- Exclude checks
Only one argument is allowed per line in a multi-line function call Open
Open
static fn(Validator $validator): bool => !is_a($validator->getValidator(), EnumValidator::class),- Exclude checks
Arguments with default values must be at the end of the argument list Open
Open
private bool $skipNonMappedEnums = false,- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
Open
if (!isset($this->generatedEnums[$enumSignature])) {- Exclude checks
Line indented incorrectly; expected 16 spaces, found 20 Open
Open
}- Exclude checks
Line indented incorrectly; expected 12 spaces, found 16 Open
Open
},- Exclude checks
Line indented incorrectly; expected at least 12 spaces, found 8 Open
Open
return array_unique(array_map(- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
public function __construct(- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
}- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
Open
}- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
private string $targetDirectory;- Exclude checks
Newline required after opening brace Open
Open
fn($a, $b): int => $a === $b ? 0 : 1,- Exclude checks
Line indented incorrectly; expected 12 spaces, found 8 Open
Open
}- Exclude checks
Line indented incorrectly; expected 8 spaces, found 4 Open
Open
}- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
private function checkForExistingTransformingFilter(PropertyInterface $property): void- Exclude checks
Closing brace indented incorrectly; expected 12 spaces, found 8 Open
Open
}- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
}- Exclude checks
Closing brace indented incorrectly; expected 8 spaces, found 4 Open
Open
}- Exclude checks
Line indented incorrectly; expected 0 spaces, found 8 Open
Open
private bool $skipNonMappedEnums = false,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
if (PHP_VERSION_ID < 80100) {- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void- Exclude checks
Line indented incorrectly; expected 4 spaces, found 12 Open
Open
}- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
Open
} else {- Exclude checks
Line indented incorrectly; expected 16 spaces, found 20 Open
Open
public function __construct(PropertyInterface $property, string $enumName)- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
}- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
Open
if ($validator instanceof FilterValidator- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
foreach ($property->getValidators() as $validator) {- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
Open
}- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
}- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
private string $namespace;- Exclude checks
Line indented incorrectly; expected at least 8 spaces, found 4 Open
Open
{- Exclude checks
Closing brace indented incorrectly; expected 4 spaces, found 0 Open
Open
}- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
}- Exclude checks
Line indented incorrectly; expected at least 16 spaces, found 12 Open
Open
) {- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
Open
if (!isset($json['enum']) || !$this->validateEnum($property)) {- Exclude checks
Line indented incorrectly; expected at least 12 spaces, found 8 Open
Open
return true;- Exclude checks
Closing brace must be on a line by itself Open
Open
case ['integer']: $backedType = 'int'; break;- Exclude checks
Line indented incorrectly; expected 8 spaces, found 4 Open
Open
}- Exclude checks
Line indented incorrectly; expected 8 spaces, found 4 Open
Open
private function renderEnum(- Exclude checks
Line indented incorrectly; expected 12 spaces, found 16 Open
Open
}- Exclude checks
Expected 1 space after closing parenthesis; found 0 Open
Open
) {- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
private array $generatedEnums = [];- Exclude checks
Line indented incorrectly; expected 12 spaces, found 16 Open
Open
if ($generatorConfiguration->isOutputEnabled()) {- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
Open
}- Exclude checks
Line indented incorrectly; expected 4 spaces, found 16 Open
Open
static fn(Validator $validator): bool => !is_a($validator->getValidator(), EnumValidator::class),- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
private function validateEnum(PropertyInterface $property): bool- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
};- Exclude checks
Line indented incorrectly; expected at least 16 spaces, found 12 Open
Open
}- Exclude checks
Line indented incorrectly; expected 4 spaces, found 12 Open
Open
if ($property->getDefaultValue() && in_array($property->getJsonSchema()->getJson()['default'], $values)) {- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
public function postProcess(): void- Exclude checks
Line indented incorrectly; expected 8 spaces, found 4 Open
Open
private function getArrayTypes(array $array): array- Exclude checks
Line indented incorrectly; expected at least 12 spaces, found 8 Open
Open
));- Exclude checks
Closing brace must be on a line by itself Open
Open
case ['string']: $backedType = 'string'; break;- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
}- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
}- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
Open
private Render $renderer;- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
foreach ($schema->getProperties() as $property) {- Exclude checks
Line indented incorrectly; expected 8 spaces, found 4 Open
Open
}- Exclude checks