Function getRecurringAdvancedConfigurationBasedEvents
has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring. Open
public static function getRecurringAdvancedConfigurationBasedEvents(\Carbon\Carbon $date) {
$events = [];
if ($date->day == 13 && $date->isFriday()) {
$events[] = "Friday the 13th";
- 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 getRecurringAdvancedConfigurationBasedEvents
has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open
public static function getRecurringAdvancedConfigurationBasedEvents(\Carbon\Carbon $date) {
$events = [];
if ($date->day == 13 && $date->isFriday()) {
$events[] = "Friday the 13th";
Consider simplifying this complex logical expression. Open
if (($date->day==1 && $date->isFriday())
|| $date->day==2 && in_array($date->englishDayOfWeek, ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"])
|| ($date->day==3 && $date->isMonday())
) {
$events[] = "National Leave the Office Early Day";
The method getRecurringAdvancedConfigurationBasedEvents() has an NPath complexity of 3024. The configured NPath complexity threshold is 200. Open
public static function getRecurringAdvancedConfigurationBasedEvents(\Carbon\Carbon $date) {
$events = [];
if ($date->day == 13 && $date->isFriday()) {
$events[] = "Friday the 13th";
- 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 getRecurringAdvancedConfigurationBasedEvents() has a Cyclomatic Complexity of 18. The configured cyclomatic complexity threshold is 10. Open
public static function getRecurringAdvancedConfigurationBasedEvents(\Carbon\Carbon $date) {
$events = [];
if ($date->day == 13 && $date->isFriday()) {
$events[] = "Friday the 13th";
- 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 unused parameters such as '$date'. Open
public static function getRecurringAdvancedConfigurationBasedHolidays(\Carbon\Carbon $date) {
- 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
Similar blocks of code found in 3 locations. Consider refactoring. Open
if ($date->day == date("d", strtotime("first Friday of June ".$date->year)) || $date->day == date("d", strtotime("first Friday of June ".$date->year))+1 || $date->day == date("d", strtotime("first Friday of June ".$date->year))+2 ) {
$events[] = "Horseradish Days";
}
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 117.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Avoid excessively long variable names like $configurationHolidays. Keep variable name length under 20. Open
public static $configurationHolidays = [
"third Sunday of June %Y" => ["Father's Day"],
];
- 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++ ) {
}
}
}