File TrackAction.php
has 737 lines of code (exceeds 250 allowed). Consider refactoring. Open
<?php
/**
*
* @package Gems
Gems_Default_TrackAction
has 51 functions (exceeds 20 allowed). Consider refactoring. Open
class Gems_Default_TrackAction extends \Gems_Default_RespondentChildActionAbstract
{
/**
*
* @var \Gems_AccessLog
Function getRespondentTrack
has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring. Open
public function getRespondentTrack()
{
static $respTrack;
if ($respTrack instanceof \Gems_Tracker_RespondentTrack) {
- 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 class Gems_Default_TrackAction has 29 non-getter- and setter-methods. Consider refactoring Gems_Default_TrackAction to keep number of methods under 25. Open
class Gems_Default_TrackAction extends \Gems_Default_RespondentChildActionAbstract
{
/**
*
* @var \Gems_AccessLog
- Read upRead up
- Exclude checks
TooManyMethods
Since: 0.1
A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
By default it ignores methods starting with 'get' or 'set'.
The default was changed from 10 to 25 in PHPMD 2.3.
Example
Source https://phpmd.org/rules/codesize.html#toomanymethods
The class Gems_Default_TrackAction has an overall complexity of 103 which is very high. The configured complexity threshold is 50. Open
class Gems_Default_TrackAction extends \Gems_Default_RespondentChildActionAbstract
{
/**
*
* @var \Gems_AccessLog
- Exclude checks
The class Gems_Default_TrackAction has 28 public methods. Consider refactoring Gems_Default_TrackAction to keep number of public methods under 10. Open
class Gems_Default_TrackAction extends \Gems_Default_RespondentChildActionAbstract
{
/**
*
* @var \Gems_AccessLog
- Read upRead up
- Exclude checks
TooManyPublicMethods
Since: 0.1
A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
By default it ignores methods starting with 'get' or 'set'.
Example
Source https://phpmd.org/rules/codesize.html#toomanypublicmethods
Method getRespondentTrack
has 41 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getRespondentTrack()
{
static $respTrack;
if ($respTrack instanceof \Gems_Tracker_RespondentTrack) {
The class Gems_Default_TrackAction has 35 fields. Consider redesigning Gems_Default_TrackAction to keep the number of fields under 15. Open
class Gems_Default_TrackAction extends \Gems_Default_RespondentChildActionAbstract
{
/**
*
* @var \Gems_AccessLog
- Read upRead up
- Exclude checks
TooManyFields
Since: 0.1
Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.
Example
class Person {
protected $one;
private $two;
private $three;
[... many more fields ...]
}
Source https://phpmd.org/rules/codesize.html#toomanyfields
Function getTrackEngine
has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring. Open
public function getTrackEngine()
{
static $engine;
if ($engine instanceof \Gems_Tracker_Engine_TrackEngineInterface) {
- 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 getTrackEngine
has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getTrackEngine()
{
static $engine;
if ($engine instanceof \Gems_Tracker_Engine_TrackEngineInterface) {
Function createModel
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
protected function createModel($detailed, $action)
{
$apply = true;
$model = $this->loader->getTracker()->getRespondentTrackModel();
if ($detailed) {
- 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 getToken
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
public function getToken()
{
static $token;
if ($token instanceof \Gems_Tracker_Token) {
- 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 class Gems_Default_TrackAction has 1338 lines of code. Current threshold is 1000. Avoid really long classes. Open
class Gems_Default_TrackAction extends \Gems_Default_RespondentChildActionAbstract
{
/**
*
* @var \Gems_AccessLog
- Exclude checks
The method getRespondentTrack() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. Open
public function getRespondentTrack()
{
static $respTrack;
if ($respTrack instanceof \Gems_Tracker_RespondentTrack) {
- 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 local variables such as '$respondent'. Open
$respondent = $this->getRespondent();
- 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 getTrackEngine. Open
} catch (\Exception $ex) {
}
- 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
}
}
Source https://phpmd.org/rules/design.html#emptycatchblock
Avoid excessively long variable names like $answerExportParameters. Keep variable name length under 20. Open
protected $answerExportParameters = array(
'formTitle' => 'getTokenTitle',
'hideGroup' => 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 $defaultTokenParameters. Keep variable name length under 20. Open
protected $defaultTokenParameters = array(
'model' => null,
'respondent' => null,
'token' => 'getToken',
'tokenId' => 'getTokenId',
- 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 $exportTrackParameters. Keep variable name length under 20. Open
protected $exportTrackParameters = array(
'formTitle' => 'getTrackTitle',
'respondentTrack' => 'getRespondentTrack',
);
- 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 $deleteTrackParameters. Keep variable name length under 20. Open
protected $deleteTrackParameters = array(
'formTitle' => null,
'multiTracks' => 'isMultiTracks',
'respondentTrack' => 'getRespondentTrack',
'respondentTrackId' => 'getRespondentTrackId',
- 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 variables with short names like $db. Configured minimum length is 3. Open
public $db;
- 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;
}
}
}