File RevisionableTrait.php has 297 lines of code (exceeds 250 allowed). Consider refactoring. Open
<?php
namespace Convenia\Revisionable;
/*Function postSave has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring. Open
public function postSave()
{
$limitReached = false;
if (isset($this->historyLimit) && $this->revisionHistory()->count() >= $this->historyLimit) {- 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 postSave has 40 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function postSave()
{
$limitReached = false;
if (isset($this->historyLimit) && $this->revisionHistory()->count() >= $this->historyLimit) {Function preSave has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring. Open
public function preSave()
{
if (self::$suspended === true) {
return;
}- 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 preSave has 30 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function preSave()
{
if (self::$suspended === true) {
return;
}Method postCreate has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function postCreate()
{
// Check if we should store creations in our revision history
// Set this value to true in your model if you want to
if (empty($this->revisionCreationsEnabled)) {Function changedRevisionableFields has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
protected function changedRevisionableFields()
{
$changesToRecord = [];
foreach ($this->dirtyData as $key => $value) {
// check that the field is revisionable, and double check- 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 postCreate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
public function postCreate()
{
// Check if we should store creations in our revision history
// Set this value to true in your model if you want to
if (empty($this->revisionCreationsEnabled)) {- 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 preSave() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10. Open
public function preSave()
{
if (self::$suspended === true) {
return;
}- 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 method postSave() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10. Open
public function postSave()
{
$limitReached = false;
if (isset($this->historyLimit) && $this->revisionHistory()->count() >= $this->historyLimit) {- 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 using undefined variables such as '$revisions' which will lead to PHP notices. Open
\DB::table($revision->getTable())->insert($revisions);- Read upRead up
- Exclude checks
UndefinedVariable
Since: 2.8.0
Detects when a variable is used that has not been defined before.
Example
class Foo
{
private function bar()
{
// $message is undefined
echo $message;
}
}Source https://phpmd.org/rules/cleancode.html#undefinedvariable
Avoid using undefined variables such as '$revisions' which will lead to PHP notices. Open
\Event::fire('revisionable.deleted', ['model' => $this, 'revisions' => $revisions]);- Read upRead up
- Exclude checks
UndefinedVariable
Since: 2.8.0
Detects when a variable is used that has not been defined before.
Example
class Foo
{
private function bar()
{
// $message is undefined
echo $message;
}
}Source https://phpmd.org/rules/cleancode.html#undefinedvariable
Avoid using undefined variables such as '$revisions' which will lead to PHP notices. Open
$revisions[] = [- Read upRead up
- Exclude checks
UndefinedVariable
Since: 2.8.0
Detects when a variable is used that has not been defined before.
Example
class Foo
{
private function bar()
{
// $message is undefined
echo $message;
}
}Source https://phpmd.org/rules/cleancode.html#undefinedvariable
The method changedRevisionableFields uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
// we don't need these any more, and they could
// contain a lot of data, so lets trash them.
unset($this->updatedData[$key]);
unset($this->originalData[$key]);- 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 unused local variables such as '$change'. Open
foreach ($changesToRecord as $key => $change) {- Read upRead up
- Exclude checks
UnusedLocalVariable
Since: 0.2
Detects when a local variable is declared and/or assigned, but not used.
Example
class Foo {
public function doSomething()
{
$i = 5; // Unused
}
}Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable
Avoid unused local variables such as '$change'. Open
foreach ($changesToRecord as $key => $change) {- Read upRead up
- Exclude checks
UnusedLocalVariable
Since: 0.2
Detects when a local variable is declared and/or assigned, but not used.
Example
class Foo {
public function doSomething()
{
$i = 5; // Unused
}
}Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable
Avoid using empty try-catch blocks in preSave. Open
} catch (Exception $e) {
}- Read upRead up
- Exclude checks
EmptyCatchBlock
Since: 2.7.0
Usually empty try-catch is a bad idea because you are silently swallowing an error condition and then continuing execution. Occasionally this may be the right thing to do, but often it's a sign that a developer saw an exception, didn't know what to do about it, and so used an empty catch to silence the problem.
Example
class Foo {
public function bar()
{
try {
// ...
} catch (Exception $e) {} // empty catch block
}
}