Function get_external_metadata
has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring. Open
public function get_external_metadata($object, string $object_type): bool
{
$valid_types = array('label', 'artist');
// Artist metadata only for now
if (!in_array($object_type, $valid_types)) {
- 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 get_metadata
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
public function get_metadata($gather_types, $media_info): array
{
// Music metadata only
if (!in_array('music', $gather_types)) {
return array();
- 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 too many return
statements within this method. Open
return false;
The method get_external_metadata() has an NPath complexity of 962. The configured NPath complexity threshold is 200. Open
public function get_external_metadata($object, string $object_type): bool
{
$valid_types = array('label', 'artist');
// Artist metadata only for now
if (!in_array($object_type, $valid_types)) {
- 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 get_external_metadata() has 159 lines of code. Current threshold is set to 100. Avoid really long methods. Open
public function get_external_metadata($object, string $object_type): bool
{
$valid_types = array('label', 'artist');
// Artist metadata only for now
if (!in_array($object_type, $valid_types)) {
- Exclude checks
The method get_external_metadata() has a Cyclomatic Complexity of 25. The configured cyclomatic complexity threshold is 10. Open
public function get_external_metadata($object, string $object_type): bool
{
$valid_types = array('label', 'artist');
// Artist metadata only for now
if (!in_array($object_type, $valid_types)) {
- 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
Avoid assigning values to variables in if clauses and the like (line '141', column '14'). Open
public function get_metadata($gather_types, $media_info): array
{
// Music metadata only
if (!in_array('music', $gather_types)) {
return array();
- Read upRead up
- Exclude checks
IfStatementAssignment
Since: 2.7.0
Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.
Example
class Foo
{
public function bar($flag)
{
if ($foo = 'bar') { // possible typo
// ...
}
if ($baz = 0) { // always false
// ...
}
}
}
Source http://phpmd.org/rules/cleancode.html#ifstatementassignment
The method get_external_metadata uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
try {
$args = array($object_type => $object->get_fullname());
switch ($object_type) {
case 'label':
- 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 'string' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST)
Open
public string $name = 'MusicBrainz';
- Exclude checks
The parameter $object_type is not named in camelCase. Open
public function get_external_metadata($object, string $object_type): bool
{
$valid_types = array('label', 'artist');
// Artist metadata only for now
if (!in_array($object_type, $valid_types)) {
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $gather_types is not named in camelCase. Open
public function get_metadata($gather_types, $media_info): array
{
// Music metadata only
if (!in_array('music', $gather_types)) {
return array();
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $media_info is not named in camelCase. Open
public function get_metadata($gather_types, $media_info): array
{
// Music metadata only
if (!in_array('music', $gather_types)) {
return array();
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The 'get_external_metadata()' method which returns a boolean should be named 'is...()' or 'has...()' Open
public function get_external_metadata($object, string $object_type): bool
{
$valid_types = array('label', 'artist');
// Artist metadata only for now
if (!in_array($object_type, $valid_types)) {
- Read upRead up
- Exclude checks
BooleanGetMethodName
Since: 0.2
Looks for methods named 'getX()' with 'boolean' as the return type. The convention is to name these methods 'isX()' or 'hasX()'.
Example
class Foo {
/**
* @return boolean
*/
public function getFoo() {} // bad
/**
* @return bool
*/
public function isFoo(); // ok
/**
* @return boolean
*/
public function getFoo($bar); // ok, unless checkParameterizedMethods=true
}