File StepEngineAbstract.php
has 573 lines of code (exceeds 250 allowed). Consider refactoring. Open
<?php
/**
*
* @package Gems
Method getRoundModel
has 145 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getRoundModel($detailed, $action)
{
$model = parent::getRoundModel($detailed, $action);
// Add information about surveys and groups
Gems_Tracker_Engine_StepEngineAbstract
has 34 functions (exceeds 20 allowed). Consider refactoring. Open
abstract class Gems_Tracker_Engine_StepEngineAbstract extends \Gems_Tracker_Engine_TrackEngineAbstract
{
/**
* Database stored constant value for using an answer in a survey as date source
*/
The class Gems_Tracker_Engine_StepEngineAbstract has an overall complexity of 118 which is very high. The configured complexity threshold is 50. Open
abstract class Gems_Tracker_Engine_StepEngineAbstract extends \Gems_Tracker_Engine_TrackEngineAbstract
{
/**
* Database stored constant value for using an answer in a survey as date source
*/
- Exclude checks
Function getSourceList
has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring. Open
protected function getSourceList($validAfter, $firstRound, $detailed = true)
{
if (! ($validAfter || $this->project->isValidUntilRequired())) {
$results[self::NO_TABLE] = array($this->_('Does not expire'));
}
- 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 applyRespondentRelation
has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring. Open
protected function applyRespondentRelation(\MUtil_Model_ModelAbstract $model, array &$itemData)
{
$model->set('gro_id_survey', 'onchange', 'this.form.submit();');
if (!empty($itemData['gro_id_survey']) && $model->has('gro_id_relationfield')) {
$forStaff = $this->tracker->getSurvey($itemData['gro_id_survey'])->isTakenByStaff();
- 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 getDateOptionsFor
has 34 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected function getDateOptionsFor($sourceType, $roundId, $language, $validAfter)
{
switch ($sourceType) {
case self::NO_TABLE:
return array();
Method getSourceList
has 31 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected function getSourceList($validAfter, $firstRound, $detailed = true)
{
if (! ($validAfter || $this->project->isValidUntilRequired())) {
$results[self::NO_TABLE] = array($this->_('Does not expire'));
}
Method checkTokenDates
has 28 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected function checkTokenDates($token, $round, $userId, \Gems_Tracker_RespondentTrack $respTrack)
{
$skipCode = $this->util->getReceptionCodeLibrary()->getSkipString();
// Change only not-completed tokens with a positive successcode where at least one date
Method displayDateCalculation
has 28 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function displayDateCalculation($value, $new, $name, array $context = array())
{
$fieldBase = substr($name, 0, -5); // Strip field
$validAfter = (bool) strpos($fieldBase, 'after');
Function checkTokenDates
has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
protected function checkTokenDates($token, $round, $userId, \Gems_Tracker_RespondentTrack $respTrack)
{
$skipCode = $this->util->getReceptionCodeLibrary()->getSkipString();
// Change only not-completed tokens with a positive successcode where at least one date
- 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 applyRespondentRelation
has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected function applyRespondentRelation(\MUtil_Model_ModelAbstract $model, array &$itemData)
{
$model->set('gro_id_survey', 'onchange', 'this.form.submit();');
if (!empty($itemData['gro_id_survey']) && $model->has('gro_id_relationfield')) {
$forStaff = $this->tracker->getSurvey($itemData['gro_id_survey'])->isTakenByStaff();
Method setDateListFor
has 6 arguments (exceeds 4 allowed). Consider refactoring. Open
protected function setDateListFor(\MUtil_Model_ModelAbstract $model, $fieldName, $source, $roundId, $language, $validAfter)
Method getValidUntilDate
has 6 arguments (exceeds 4 allowed). Consider refactoring. Open
abstract protected function getValidUntilDate($fieldSource, $fieldName, $prevRoundId, \Gems_Tracker_Token $token, \Gems_Tracker_RespondentTrack $respTrack, $validFrom);
Function displayDateCalculation
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
public function displayDateCalculation($value, $new, $name, array $context = array())
{
$fieldBase = substr($name, 0, -5); // Strip field
$validAfter = (bool) strpos($fieldBase, 'after');
- 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 getRoundModel
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
public function getRoundModel($detailed, $action)
{
$model = parent::getRoundModel($detailed, $action);
// Add information about surveys and groups
- 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 getValidFromDate
has 5 arguments (exceeds 4 allowed). Consider refactoring. Open
abstract protected function getValidFromDate($fieldSource, $fieldName, $prevRoundId, \Gems_Tracker_Token $token, \Gems_Tracker_RespondentTrack $respTrack);
Function updateRoundModelToItem
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
public function updateRoundModelToItem(\MUtil_Model_ModelAbstract $model, array &$itemData, $language)
{
$this->_ensureRounds();
// Is this the first 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
Avoid too many return
statements within this method. Open
return $results + $this->_fieldsDefinition->getFieldLabelsOfType(array(
FieldsDefinition::TYPE_DATE,
FieldsDefinition::TYPE_DATETIME,
));
Avoid too many return
statements within this method. Open
return array(
'gto_valid_from' => $this->_('Valid from'),
'gto_valid_until' => $this->_('Valid until'),
'gto_start_time' => $this->_('Start time'),
'gto_completion_time' => $this->_('Completion date'),
Avoid too many return
statements within this method. Open
return [
'grs_birthday' => $this->_('Birthday'),
'gr2o_created' => $this->_('Respondent created'),
/*'gr2o_changed' => $this->_('Respondent changed'),*/
];
Function checkTokenCondition
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
protected function checkTokenCondition(\Gems_Tracker_Token $token, $round, $userId, \Gems_Tracker_RespondentTrack $respTrack)
{
$skipCode = $this->util->getReceptionCodeLibrary()->getSkipString();
// Only if we have a condition, the token is not yet completed and
- 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 checkTokensFrom
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
public function checkTokensFrom(\Gems_Tracker_RespondentTrack $respTrack, \Gems_Tracker_Token $startToken, $userId, \Gems_Tracker_Token $skipToken = null)
{
// Make sure the rounds are loaded
$this->_ensureRounds();
- 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 getSourceList() has an NPath complexity of 324. The configured NPath complexity threshold is 200. Open
protected function getSourceList($validAfter, $firstRound, $detailed = true)
{
if (! ($validAfter || $this->project->isValidUntilRequired())) {
$results[self::NO_TABLE] = array($this->_('Does not expire'));
}
- 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 class Gems_Tracker_Engine_StepEngineAbstract has 1025 lines of code. Current threshold is 1000. Avoid really long classes. Open
abstract class Gems_Tracker_Engine_StepEngineAbstract extends \Gems_Tracker_Engine_TrackEngineAbstract
{
/**
* Database stored constant value for using an answer in a survey as date source
*/
- Exclude checks
The method getRoundModel() has 166 lines of code. Current threshold is set to 100. Avoid really long methods. Open
public function getRoundModel($detailed, $action)
{
$model = parent::getRoundModel($detailed, $action);
// Add information about surveys and groups
- Exclude checks
The method getSourceList() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10. Open
protected function getSourceList($validAfter, $firstRound, $detailed = true)
{
if (! ($validAfter || $this->project->isValidUntilRequired())) {
$results[self::NO_TABLE] = array($this->_('Does not expire'));
}
- 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 updateRoundModelToItem() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10. Open
public function updateRoundModelToItem(\MUtil_Model_ModelAbstract $model, array &$itemData, $language)
{
$this->_ensureRounds();
// Is this the first token?
- 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 Gems_Tracker_Engine_StepEngineAbstract has a coupling between objects value of 15. Consider to reduce the number of dependencies under 13. Open
abstract class Gems_Tracker_Engine_StepEngineAbstract extends \Gems_Tracker_Engine_TrackEngineAbstract
{
/**
* Database stored constant value for using an answer in a survey as date source
*/
- 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 unused parameters such as '$value'. Open
public function displayDateCalculation($value, $new, $name, array $context = array())
- 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
Avoid unused parameters such as '$validAfter'. Open
protected function getDateOptionsFor($sourceType, $roundId, $language, $validAfter)
- 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
Avoid unused parameters such as '$respTrack'. Open
public function getTrackDeleteSnippetNames(\Gems_Tracker_RespondentTrack $respTrack)
- 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
Avoid unused parameters such as '$new'. Open
public function displayRoundId($value, $new, $name, array $context = array())
- 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
Avoid unused local variables such as '$field'. Open
foreach ($this->getFieldsOfType('relation') as $key => $field)
- 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 parameters such as '$token'. Open
public function getTokenDeleteSnippetNames(\Gems_Tracker_Token $token)
- 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
Avoid unused parameters such as '$respTrack'. Open
protected function checkTokenCondition(\Gems_Tracker_Token $token, $round, $userId, \Gems_Tracker_RespondentTrack $respTrack)
- 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
Avoid unused parameters such as '$token'. Open
public function getTokenEditSnippetNames(\Gems_Tracker_Token $token)
- 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
Avoid unused parameters such as '$respTrack'. Open
public function getTrackEditSnippetNames(\Gems_Tracker_RespondentTrack $respTrack)
- 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
Avoid unused parameters such as '$new'. Open
public function displayDateCalculation($value, $new, $name, array $context = array())
- 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 2 locations. Consider refactoring. Open
if ($detailed) {
$model->set('gro_valid_for_field',
'label', $this->_('Date used'),
'default', 'gto_valid_from',
'onchange', 'this.form.submit();'
- 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 149.
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
Similar blocks of code found in 2 locations. Consider refactoring. Open
if ($detailed) {
$periodUnits = $this->util->getTranslated()->getPeriodUnits();
$model->set('gro_valid_after_field',
'label', $this->_('Date used'),
- 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 149.
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 variables with short names like $id. Configured minimum length is 3. Open
$id = str_replace($fieldPrefix, '', $key);
- 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;
}
}
}