File TrafficLightTokenSnippet.php
has 544 lines of code (exceeds 250 allowed). Consider refactoring. Open
<?php
/**
*
* @package Gems
Function getHtmlOutput
has a Cognitive Complexity of 47 (exceeds 5 allowed). Consider refactoring. Open
public function getHtmlOutput(\Zend_View_Abstract $view)
{
$this->_initView($view);
$main = $this->creator->div(array('class' => 'panel panel-default', 'id' => 'trackwrapper', 'renderClosingTag' => true));
- 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 getHtmlOutput
has 139 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getHtmlOutput(\Zend_View_Abstract $view)
{
$this->_initView($view);
$main = $this->creator->div(array('class' => 'panel panel-default', 'id' => 'trackwrapper', 'renderClosingTag' => true));
The class Gems_Snippets_Respondent_TrafficLightTokenSnippet has an overall complexity of 89 which is very high. The configured complexity threshold is 50. Open
class Gems_Snippets_Respondent_TrafficLightTokenSnippet extends \Gems\Snippets\Token\RespondentTokenSnippet
{
/**
* Set a fixed model filter.
*
- Exclude checks
Method addToken
has 56 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function addToken($tokenData)
{
// We add all data we need so no database calls needed to load the token
$tokenDiv = $this->creator->div(array('class' => 'zpitem', 'renderClosingTag' => true));
$innerDiv = $tokenDiv->div(array('class' => 'tokenwrapper', 'renderClosingTag' => true));
Method getToolIcons
has 46 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getToolIcons($toolsDiv, $token)
{
static $correctIcon;
static $showIcon;
static $clipboardIcon;
The class Gems_Snippets_Respondent_TrafficLightTokenSnippet has 30 fields. Consider redesigning Gems_Snippets_Respondent_TrafficLightTokenSnippet to keep the number of fields under 15. Open
class Gems_Snippets_Respondent_TrafficLightTokenSnippet extends \Gems\Snippets\Token\RespondentTokenSnippet
{
/**
* Set a fixed model filter.
*
- 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 addToken
has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring. Open
public function addToken($tokenData)
{
// We add all data we need so no database calls needed to load the token
$tokenDiv = $this->creator->div(array('class' => 'zpitem', 'renderClosingTag' => true));
$innerDiv = $tokenDiv->div(array('class' => 'tokenwrapper', 'renderClosingTag' => true));
- 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 _loadData
has 29 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected function _loadData()
{
$model = $this->getModel();
$model->trackUsage();
Method finishTrack
has 28 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected function finishTrack($progressDiv)
{
if (!is_null($progressDiv)) {
$total = max($this->_completedTrack + $this->_openTrack + $this->_missedTrack + $this->_futureTrack, 1);
Function getToolIcons
has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
public function getToolIcons($toolsDiv, $token)
{
static $correctIcon;
static $showIcon;
static $clipboardIcon;
- 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 createMenuLink
has 5 arguments (exceeds 4 allowed). Consider refactoring. Open
public function createMenuLink($parameterSource, $controller, $action = 'index', $label = null, $menuItem = null)
Function _getDeleteIcon
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
protected function _getDeleteIcon($row, $trackParameterSource, $isSuccess = true)
{
$deleteTrackContainer = \MUtil_Html::create('div', array('class' => 'otherOrg pull-right', 'renderClosingTag' => true));
if ($row['gr2o_id_organization'] != $this->currentOrgId) {
$deleteTrackContainer[] = $this->loader->getOrganization($row['gr2o_id_organization'])->getName() . ' ';
- 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 getHtmlOutput() has 168 lines of code. Current threshold is set to 100. Avoid really long methods. Open
public function getHtmlOutput(\Zend_View_Abstract $view)
{
$this->_initView($view);
$main = $this->creator->div(array('class' => 'panel panel-default', 'id' => 'trackwrapper', 'renderClosingTag' => true));
- Exclude checks
The method getHtmlOutput() has an NPath complexity of 35526. The configured NPath complexity threshold is 200. Open
public function getHtmlOutput(\Zend_View_Abstract $view)
{
$this->_initView($view);
$main = $this->creator->div(array('class' => 'panel panel-default', 'id' => 'trackwrapper', 'renderClosingTag' => true));
- 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 getHtmlOutput() has a Cyclomatic Complexity of 24. The configured cyclomatic complexity threshold is 10. Open
public function getHtmlOutput(\Zend_View_Abstract $view)
{
$this->_initView($view);
$main = $this->creator->div(array('class' => 'panel panel-default', 'id' => 'trackwrapper', 'renderClosingTag' => true));
- 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 addToken() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10. Open
public function addToken($tokenData)
{
// We add all data we need so no database calls needed to load the token
$tokenDiv = $this->creator->div(array('class' => 'zpitem', 'renderClosingTag' => true));
$innerDiv = $tokenDiv->div(array('class' => 'tokenwrapper', 'renderClosingTag' => true));
- 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_Snippets_Respondent_TrafficLightTokenSnippet has a coupling between objects value of 14. Consider to reduce the number of dependencies under 13. Open
class Gems_Snippets_Respondent_TrafficLightTokenSnippet extends \Gems\Snippets\Token\RespondentTokenSnippet
{
/**
* Set a fixed model filter.
*
- 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 local variables such as '$clibboardIcon'. Open
if (!isset($clibboardIcon)) {
- 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
Similar blocks of code found in 2 locations. Consider refactoring. Open
protected function processFilterAndSort(\MUtil_Model_ModelAbstract $model)
{
$filter['gto_id_respondent'] = $this->respondent->getId();
if (is_array($this->forOtherOrgs)) {
$filter['gto_id_organization'] = $this->forOtherOrgs;
- 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 170.
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 class names like Gems_Snippets_Respondent_TrafficLightTokenSnippet. Keep class name length under 40. Open
class Gems_Snippets_Respondent_TrafficLightTokenSnippet extends \Gems\Snippets\Token\RespondentTokenSnippet
{
/**
* Set a fixed model filter.
*
- Read upRead up
- Exclude checks
LongClassName
Since: 2.9
Detects when classes or interfaces are declared with excessively long names.
Example
class ATooLongClassNameThatHintsAtADesignProblem {
}
interface ATooLongInterfaceNameThatHintsAtADesignProblem {
}