Method getListViewEntries
has 30 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getListViewEntries($pagingModel)
{
$moduleModel = $this->getModule();
$moduleName = $moduleModel->getName();
$parentModuleName = $moduleModel->getParentName();
Function getListViewEntries
has a Cognitive Complexity of 9 (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
Avoid using static access to class 'Vtiger_Loader' in method 'getListViewEntries'. Open
$recordModelClass = Vtiger_Loader::getComponentClassName('Model', 'Record', $qualifiedModuleName);
- 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 'getInstance'. Open
$modelClassName = Vtiger_Loader::getComponentClassName('Model', 'ListView', $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
Call to undeclared method \App\Db\Query::orderBy
Open
$listQuery->orderBy([$orderBy => SORT_DESC]);
- Exclude checks
Declaration of function getInstance(mixed|string $name = 'Settings:BusinessHours') : \Settings_Vtiger_Module_Model
should be compatible with function getInstance(string $name = 'Settings:Vtiger') : \Settings_Vtiger_ListView_Model
defined in /code/modules/Settings/Vtiger/models/ListView.php:183
Open
public static function getInstance($name = 'Settings:BusinessHours')
- Exclude checks
Call to method read
from undeclared class \yii\db\DataReader
Open
while ($row = $dataReader->read()) {
- Exclude checks
Call to method close
from undeclared class \yii\db\DataReader
Open
$dataReader->close();
- Exclude checks
Call to undeclared method \App\Db\Query::orderBy
Open
$listQuery->orderBy([$orderBy => SORT_ASC]);
- Exclude checks
Each class must be in a namespace of at least one level (a top-level vendor name) Open
class Settings_BusinessHours_ListView_Model extends Settings_Vtiger_ListView_Model
- Exclude checks
The class Settings_BusinessHours_ListView_Model is not named in CamelCase. Open
class Settings_BusinessHours_ListView_Model extends Settings_Vtiger_ListView_Model
{
/**
* Function to get the list view entries.
*
- 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
$listViewRecordModels = [];
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$record = new $recordModelClass();
- 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
$recordModelClass = Vtiger_Loader::getComponentClassName('Model', 'Record', $qualifiedModuleName);
- 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
/**
- 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
} else {
- 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
{
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Function to get the list view entries.
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$orderBy = $this->getForSql('orderby');
- 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
$parentModuleName = $moduleModel->getParentName();
- 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
*
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$pagingModel->set('page', 1);
- 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
$record->setData($row);
- 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
$moduleName = $moduleModel->getName();
- 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
$listQuery->orderBy([$orderBy => SORT_DESC]);
- 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
* @param Vtiger_Paging_Model $pagingModel
- 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
if (!empty($orderBy)) {
- 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
* @return Settings_Vtiger_Record_Model[] - Associative array of record id mapped to Vtiger_Record_Model instance
- 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 ('DESC' === $this->getForSql('sortorder')) {
- 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
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
$modelClassName = Vtiger_Loader::getComponentClassName('Model', 'ListView', $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
$instance = 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
/**
- 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
* Function to get the instance of Settings module model.
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public static function getInstance($name = 'Settings:BusinessHours')
- 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
* @param mixed $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
* @return Settings_Vtiger_Module_Model instance
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $instance->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
}
- 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
Class name "Settings_BusinessHours_ListView_Model" is not in camel caps format Open
class Settings_BusinessHours_ListView_Model extends Settings_Vtiger_ListView_Model
- Exclude checks