Function getListViewEntries
has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring. Open
public function getListViewEntries($pagingModel)
{
$moduleModel = $this->getModule();
$moduleName = $moduleModel->getName();
$parentModuleName = $moduleModel->getParentName();
- 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 getListViewEntries
has 42 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getListViewEntries($pagingModel)
{
$moduleModel = $this->getModule();
$moduleName = $moduleModel->getName();
$parentModuleName = $moduleModel->getParentName();
The method getListViewEntries() has an NPath complexity of 384. The configured NPath complexity threshold is 200. Open
public function getListViewEntries($pagingModel)
{
$moduleModel = $this->getModule();
$moduleName = $moduleModel->getName();
$parentModuleName = $moduleModel->getParentName();
- 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 getListViewEntries() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10. Open
public function getListViewEntries($pagingModel)
{
$moduleModel = $this->getModule();
$moduleName = $moduleModel->getName();
$parentModuleName = $moduleModel->getParentName();
- 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 static access to class 'App\Module' in method 'getListViewEntries'. Open
$orderBy = 'COALESCE(' . App\Module::getSqlForNameInDisplayFormat('Users') . ',vtiger_groups.groupname)';
- Read upRead up
- 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 getListViewEntries uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$listQuery->orderBy([$orderBy => SORT_ASC]);
}
- 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 using static access to class 'Vtiger_Loader' in method 'setModule'. Open
$modelClassName = Vtiger_Loader::getComponentClassName('Model', 'Module', $name);
- Read upRead up
- 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 '\App\Request' in method 'setModule'. Open
$this->module->typeApi = \App\Request::_get('typeApi');
- Read upRead up
- 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 'Vtiger_Field_Model' in method 'getListViewEntries'. Open
$fieldModel = Vtiger_Field_Model::getInstance('assigned_user_id', $moduleModel);
- Read upRead up
- 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
Argument 2 (module)
is \App\Base|\Settings_Vtiger_Module_Model
but \Vtiger_Field_Model::getInstance()
takes \Vtiger_Module_Model|false
defined at /code/modules/Vtiger/models/Field.php:1158
Open
$fieldModel = Vtiger_Field_Model::getInstance('assigned_user_id', $moduleModel);
- Exclude checks
Call to undeclared method \App\Db\Query::limit
Open
$listQuery->limit($pageLimit)->offset($startIndex);
- Exclude checks
Call to undeclared method \Settings_Vtiger_Module_Model::getService
Open
$record = $moduleModel->getService();
- Exclude checks
Call to undeclared method \App\Db\Query::orderBy
Open
$listQuery->orderBy([$orderBy => SORT_ASC]);
- Exclude checks
Call to method count
from undeclared class \yii\db\DataReader
Open
$pagingModel->calculatePageRange($dataReader->count());
- Exclude checks
Call to method close
from undeclared class \yii\db\DataReader
Open
$dataReader->close();
- Exclude checks
Call to method read
from undeclared class \yii\db\DataReader
Open
while ($row = $dataReader->read()) {
- Exclude checks
Reference to undeclared property \Settings_WebserviceUsers_ListView_Model->module
Open
$this->module = new $modelClassName();
- Exclude checks
Call to undeclared method \App\Db\Query::orderBy
Open
$listQuery->orderBy([$orderBy => SORT_DESC]);
- Exclude checks
Reference to undeclared property \Settings_WebserviceUsers_ListView_Model->module
Open
$this->module->typeApi = \App\Request::_get('typeApi');
- Exclude checks
Call to undeclared method \Settings_Vtiger_Module_Model::getEditViewUrl
Open
'linkdata' => ['url' => $moduleModel->getEditViewUrl()],
- Exclude checks
Similar blocks of code found in 2 locations. Consider refactoring. Open
public function getBasicLinks()
{
$basicLinks = [];
$moduleModel = $this->getModule();
if ($moduleModel->hasCreatePermissions()) {
- 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 90.
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 Settings_WebserviceUsers_ListView_Model extends Settings_Vtiger_ListView_Model
- Exclude checks
The class Settings_WebserviceUsers_ListView_Model is not named in CamelCase. Open
class Settings_WebserviceUsers_ListView_Model extends Settings_Vtiger_ListView_Model
{
/**
* Function sets module instance.
*
- Read upRead up
- Exclude checks
CamelCaseClassName
Since: 0.2
It is considered best practice to use the CamelCase notation to name classes.
Example
class class_name {
}
Source
Spaces must be used to indent lines; tabs are not allowed Open
*
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @return $this
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @return array of Basic links
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'showLabel' => 1,
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $basicLinks;
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Function sets module instance.
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $this;
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Function to get Basic links.
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkicon' => 'fas fa-plus',
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$moduleName = $moduleModel->getName();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$modelClassName = Vtiger_Loader::getComponentClassName('Model', 'Module', $name);
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linklabel' => 'LBL_ADD_RECORD',
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getListViewEntries($pagingModel)
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$orderBy = $this->getForSql('orderby');
- Exclude checks
Line exceeds 120 characters; contains 121 characters Open
$orderBy = 'COALESCE(' . App\Module::getSqlForNameInDisplayFormat('Users') . ',vtiger_groups.groupname)';
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
} else {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
while ($row = $dataReader->read()) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (method_exists($record, 'getModule') && method_exists($record, 'setModule')) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $listViewRecordModels;
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$listViewRecordModels = [];
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$parentModuleName = $moduleModel->getParentName();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$pageLimit = $pagingModel->getPageLimit();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$listQuery->orderBy([$orderBy => SORT_DESC]);
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->module->typeApi = \App\Request::_get('typeApi');
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ('owner' == $fieldModel->getFieldDataType()) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($moduleModel->hasCreatePermissions()) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$basicLinks[] = [
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkdata' => ['url' => $moduleModel->getEditViewUrl()],
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$listQuery = $this->getBasicListQuery();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!empty($parentModuleName)) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function setModule($name)
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'modalView' => true,
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$qualifiedModuleName = $moduleName;
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!empty($orderBy) && 'smownerid' === $orderBy) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!empty($orderBy)) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @param string $name
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
];
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($moduleModel->isPagingSupported()) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$startIndex = $pagingModel->getStartIndex();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel = Vtiger_Field_Model::getInstance('assigned_user_id', $moduleModel);
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ('DESC' === $this->getForSql('sortorder')) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$record->setModule($moduleModel);
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->module = new $modelClassName();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linktype' => 'LISTVIEWBASIC',
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/** {@inheritdoc} */
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$qualifiedModuleName = $parentModuleName . ':' . $qualifiedModuleName;
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$orderBy = 'COALESCE(' . App\Module::getSqlForNameInDisplayFormat('Users') . ',vtiger_groups.groupname)';
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$listQuery->orderBy([$orderBy => SORT_ASC]);
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$pagingModel->calculatePageRange($dataReader->count());
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$basicLinks = [];
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$moduleModel = $this->getModule();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkclass' => 'btn-light addRecord',
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$moduleModel = $this->getModule();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$listQuery->limit($pageLimit)->offset($startIndex);
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getBasicLinks()
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$listViewRecordModels[$record->getId()] = $record;
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($moduleModel->isPagingSupported()) {
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$dataReader = $listQuery->createCommand()->query();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$record->setData($row);
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$dataReader->close();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$record = $moduleModel->getService();
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}
- Exclude checks
Class name "Settings_WebserviceUsers_ListView_Model" is not in camel caps format Open
class Settings_WebserviceUsers_ListView_Model extends Settings_Vtiger_ListView_Model
- Exclude checks