Function setBreadcrumbHeader
has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring. Open
public function setBreadcrumbHeader($nodes, &$view)
{
if (is_string($nodes)) {
return $nodes;
}
- Read upRead up
- Create a ticketCreate a ticket
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 setBreadcrumbHeader
has 35 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function setBreadcrumbHeader($nodes, &$view)
{
if (is_string($nodes)) {
return $nodes;
}
- Create a ticketCreate a ticket
The method setBreadcrumbHeader() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10. Open
public function setBreadcrumbHeader($nodes, &$view)
{
if (is_string($nodes)) {
return $nodes;
}
- Read upRead up
- Create a ticketCreate a ticket
- 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
Missing class import via use statement (line '145', column '23'). Open
throw new Zend_Exception('Object must be a user to create user breadcrumb type');
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '219', column '23'). Open
throw new Zend_Exception('Custom breadcrumbs must have a text and an icon parameter');
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '87', column '23'). Open
throw new Zend_Exception('Object must be a community to create community breadcrumb type');
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '44', column '27'). Open
throw new Zend_Exception('Each breadcrumb node must have a type');
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '116', column '23'). Open
throw new Zend_Exception('Object must be a folder to create folder breadcrumb type');
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '39', column '23'). Open
throw new Zend_Exception('Must pass a string or an array to createBreadcrumbs');
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '172', column '23'). Open
throw new Zend_Exception('Object must be an item to create item breadcrumb type');
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
The method _createCustomBreadcrumb uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$str .= $text;
}
- Read upRead up
- Create a ticketCreate a ticket
- 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
The method _createFolderBreadcrumb uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$str .= '<a href="'.$view->webroot.'/folder/'.$node['object']->getKey().'">'.$name.'</a>';
}
- Read upRead up
- Create a ticketCreate a ticket
- 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
The method _createItemBreadcrumb uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$str .= '<a href="'.$view->webroot.'/item/'.$node['object']->getKey().'">'.$name.'</a>';
}
- Read upRead up
- Create a ticketCreate a ticket
- 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 using static access to class 'UtilityComponent' in method '_createFolderBreadcrumb'. Open
$name = UtilityComponent::sliceName($node['object']->getName(), 25);
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}
Source https://phpmd.org/rules/cleancode.html#staticaccess
Avoid using static access to class 'UtilityComponent' in method '_createItemBreadcrumb'. Open
$name = UtilityComponent::sliceName($node['object']->getName(), 25);
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}
Source https://phpmd.org/rules/cleancode.html#staticaccess
Avoid using static access to class 'UtilityComponent' in method '_createCommunityBreadcrumb'. Open
$name = UtilityComponent::sliceName($node['object']->getName(), 25);
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}
Source https://phpmd.org/rules/cleancode.html#staticaccess
The method _createCommunityBreadcrumb uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$str .= '<a href="'.$view->webroot.'/community/'.$node['object']->getKey().$anchor.'">'.$name.'</a>';
}
- Read upRead up
- Create a ticketCreate a ticket
- 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 using static access to class 'UtilityComponent' in method '_createUserBreadcrumb'. Open
$name = UtilityComponent::sliceName($node['object']->getFullName(), 25);
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}
Source https://phpmd.org/rules/cleancode.html#staticaccess
The method _createUserBreadcrumb uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$str .= '<a href="'.$view->webroot.'/user/'.$node['object']->getKey().'">'.$name.'</a>';
}
- Read upRead up
- Create a ticketCreate a ticket
- 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 using static access to class 'UtilityComponent' in method '_createCustomBreadcrumb'. Open
$text = isset($node['maxLength']) ? UtilityComponent::sliceName(
$node['text'],
(int) $node['maxLength']
) : $node['text'];
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}
Source https://phpmd.org/rules/cleancode.html#staticaccess
Avoid unused parameters such as '$view'. Open
protected function _createCustomBreadcrumb($node, &$view)
- Read upRead up
- Create a ticketCreate a ticket
- 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 '$node'. Open
protected function _createModuleListBreadcrumb($node, &$view)
- Read upRead up
- Create a ticketCreate a ticket
- 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
protected function _createItemBreadcrumb($node, &$view)
{
if (!isset($node['object']) || !($node['object'] instanceof ItemDao)) {
throw new Zend_Exception('Object must be an item to create item breadcrumb type');
}
- Read upRead up
- Create a ticketCreate a ticket
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 177.
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
protected function _createUserBreadcrumb($node, &$view)
{
if (!isset($node['object']) || !($node['object'] instanceof UserDao)) {
throw new Zend_Exception('Object must be a user to create user breadcrumb type');
}
- Read upRead up
- Create a ticketCreate a ticket
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 177.
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
Each class must be in a namespace of at least one level (a top-level vendor name) Open
class BreadcrumbComponent extends AppComponent
- Create a ticketCreate a ticket
- Exclude checks
Method name "_createUserBreadcrumb" should not be prefixed with an underscore to indicate visibility Open
protected function _createUserBreadcrumb($node, &$view)
- Create a ticketCreate a ticket
- Exclude checks
Method name "_createFolderBreadcrumb" should not be prefixed with an underscore to indicate visibility Open
protected function _createFolderBreadcrumb($node, &$view)
- Create a ticketCreate a ticket
- Exclude checks
Method name "_createItemBreadcrumb" should not be prefixed with an underscore to indicate visibility Open
protected function _createItemBreadcrumb($node, &$view)
- Create a ticketCreate a ticket
- Exclude checks
Method name "_createCommunityBreadcrumb" should not be prefixed with an underscore to indicate visibility Open
protected function _createCommunityBreadcrumb($node, &$view)
- Create a ticketCreate a ticket
- Exclude checks
Method name "_createCustomBreadcrumb" should not be prefixed with an underscore to indicate visibility Open
protected function _createCustomBreadcrumb($node, &$view)
- Create a ticketCreate a ticket
- Exclude checks
Method name "_createModuleListBreadcrumb" should not be prefixed with an underscore to indicate visibility Open
protected function _createModuleListBreadcrumb($node, &$view)
- Create a ticketCreate a ticket
- Exclude checks
Line exceeds 120 characters; contains 127 characters Open
$str = '<li class="pathCommunity"><img alt="" src="'.$view->coreWebroot.'/public/images/icons/community.png" /><span>';
- Create a ticketCreate a ticket
- Exclude checks
Line exceeds 120 characters; contains 130 characters Open
$str = '<li class="pathUser"><img alt="" src="'.$view->coreWebroot.'/public/images/icons/unknownUser-small.png" /><span>';
- Create a ticketCreate a ticket
- Exclude checks
Line exceeds 120 characters; contains 127 characters Open
$str = '<li class="pathFolder"><img alt="" src="'.$view->coreWebroot.'/public/images/FileTree/'.$icon.'.png" /><span>';
- Create a ticketCreate a ticket
- Exclude checks
The method _createFolderBreadcrumb is not named in camelCase. Open
protected function _createFolderBreadcrumb($node, &$view)
{
if (!isset($node['object']) || !($node['object'] instanceof FolderDao)) {
throw new Zend_Exception('Object must be a folder to create folder breadcrumb type');
}
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method _createCustomBreadcrumb is not named in camelCase. Open
protected function _createCustomBreadcrumb($node, &$view)
{
if (!isset($node['text']) || !isset($node['icon'])) {
throw new Zend_Exception('Custom breadcrumbs must have a text and an icon parameter');
}
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method _createItemBreadcrumb is not named in camelCase. Open
protected function _createItemBreadcrumb($node, &$view)
{
if (!isset($node['object']) || !($node['object'] instanceof ItemDao)) {
throw new Zend_Exception('Object must be an item to create item breadcrumb type');
}
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method _createCommunityBreadcrumb is not named in camelCase. Open
protected function _createCommunityBreadcrumb($node, &$view)
{
if (!isset($node['object']) || !($node['object'] instanceof CommunityDao)) {
throw new Zend_Exception('Object must be a community to create community breadcrumb type');
}
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method _createUserBreadcrumb is not named in camelCase. Open
protected function _createUserBreadcrumb($node, &$view)
{
if (!isset($node['object']) || !($node['object'] instanceof UserDao)) {
throw new Zend_Exception('Object must be a user to create user breadcrumb type');
}
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method _createModuleListBreadcrumb is not named in camelCase. Open
protected function _createModuleListBreadcrumb($node, &$view)
{
$str = '<li class="pathItem"><img alt="" src="'.$view->coreWebroot.'/public/images/icons/plugin.png" /><span>';
$str .= '<a href="'.$view->webroot.'/admin#tabs-modules">Modules</a></span></li>';
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}