Method buildMetadata
has 115 lines of code (exceeds 25 allowed). Consider refactoring. Open
private function buildMetadata(string $xmlPath) : Entity
{
$xml = $this->loadValidatedXml($xmlPath);
$fields = [];
$embeddables = [];
Function buildMetadata
has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring. Open
private function buildMetadata(string $xmlPath) : Entity
{
$xml = $this->loadValidatedXml($xmlPath);
$fields = [];
$embeddables = [];
- 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
The method buildMetadata() has an NPath complexity of 3888. The configured NPath complexity threshold is 200. Open
private function buildMetadata(string $xmlPath) : Entity
{
$xml = $this->loadValidatedXml($xmlPath);
$fields = [];
$embeddables = [];
- Read upRead up
- Exclude checks
NPathComplexity
Since: 0.1
The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.
Example
class Foo {
function bar() {
// lots of complicated code
}
}
Source https://phpmd.org/rules/codesize.html#npathcomplexity
The method buildMetadata() has 128 lines of code. Current threshold is set to 100. Avoid really long methods. Open
private function buildMetadata(string $xmlPath) : Entity
{
$xml = $this->loadValidatedXml($xmlPath);
$fields = [];
$embeddables = [];
- Exclude checks
The method buildMetadata() has a Cyclomatic Complexity of 27. The configured cyclomatic complexity threshold is 10. Open
private function buildMetadata(string $xmlPath) : Entity
{
$xml = $this->loadValidatedXml($xmlPath);
$fields = [];
$embeddables = [];
- 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 MetadataBuilder has a coupling between objects value of 28. Consider to reduce the number of dependencies under 13. Open
final class MetadataBuilder implements MetadataBuilderInterface
{
const SCHEMA_PATH = __DIR__ . '/../../../../xsd/entity-metadata-5-1.xsd';
/**
- 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
Avoid using static access to class '\Soliant\SimpleFM\Repository\Builder\Metadata\Exception\InvalidTypeException' in method 'buildMetadata'. Open
throw InvalidTypeException::fromNonExistentType($type);
- 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 '\Soliant\SimpleFM\Repository\Builder\Metadata\Exception\MissingInterfaceException' in method 'getInterfaceNameForRelation'. Open
throw MissingInterfaceException::fromMissingInterface($mainEntityClassName, $relationEntityClassName);
- 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 '\Soliant\SimpleFM\Repository\Builder\Metadata\Exception\InvalidFileException' in method 'getMetadata'. Open
throw InvalidFileException::fromNonExistentFile($xmlPath, $entityClassName);
- 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 '\Soliant\SimpleFM\Repository\Builder\Metadata\Exception\InvalidFileException' in method 'loadValidatedXml'. Open
throw InvalidFileException::fromInvalidFile($xmlPath);
- 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 '\Assert\Assertion' in method '__construct'. Open
Assertion::count(array_filter($additionalTypes, function ($type) : bool {
return !$type instanceof TypeInterface;
}), 0, sprintf('At least one element in array is not an instance of %s', TypeInterface::class));
- 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 excessively long variable names like $previousUseInternalErrors. Keep variable name length under 20. Open
$previousUseInternalErrors = libxml_use_internal_errors(true);
- Read upRead up
- Exclude checks
LongVariable
Since: 0.2
Detects when a field, formal or local variable is declared with a long name.
Example
class Something {
protected $reallyLongIntName = -3; // VIOLATION - Field
public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
$otherReallyLongName = -5; // VIOLATION - Local
for ($interestingIntIndex = 0; // VIOLATION - For
$interestingIntIndex < 10;
$interestingIntIndex++ ) {
}
}
}
Source https://phpmd.org/rules/naming.html#longvariable
Avoid excessively long variable names like $relationEntityClassName. Keep variable name length under 20. Open
string $relationEntityClassName,
- Read upRead up
- Exclude checks
LongVariable
Since: 0.2
Detects when a field, formal or local variable is declared with a long name.
Example
class Something {
protected $reallyLongIntName = -3; // VIOLATION - Field
public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
$otherReallyLongName = -5; // VIOLATION - Local
for ($interestingIntIndex = 0; // VIOLATION - For
$interestingIntIndex < 10;
$interestingIntIndex++ ) {
}
}
}