YetiForceCompany/YetiForceCRM

View on GitHub
modules/Settings/BusinessHours/models/ListView.php

Summary

Maintainability
A
2 hrs
Test Coverage
F
0%

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();
Severity: Minor
Found in modules/Settings/BusinessHours/models/ListView.php - About 1 hr to fix

    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();
    Severity: Minor
    Found in modules/Settings/BusinessHours/models/ListView.php - About 55 mins to fix

    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);

    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]);
                }

    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);

    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]);

    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')

    Call to method read from undeclared class \yii\db\DataReader
    Open

            while ($row = $dataReader->read()) {

    Call to method close from undeclared class \yii\db\DataReader
    Open

            $dataReader->close();

    Call to undeclared method \App\Db\Query::orderBy
    Open

                    $listQuery->orderBy([$orderBy => SORT_ASC]);

    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

    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.
         *

    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 = [];

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $record = new $recordModelClass();

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public function getListViewEntries($pagingModel)

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $recordModelClass = Vtiger_Loader::getComponentClassName('Model', 'Record', $qualifiedModuleName);

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $dataReader = $listQuery->createCommand()->query();

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /**

    Spaces must be used to indent lines; tabs are not allowed
    Open

         */

    Spaces must be used to indent lines; tabs are not allowed
    Open

                } else {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if (method_exists($record, 'getModule') && method_exists($record, 'setModule')) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

        {

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * Function to get the list view entries.

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $orderBy = $this->getForSql('orderby');

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $moduleModel = $this->getModule();

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $parentModuleName = $moduleModel->getParentName();

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $qualifiedModuleName = $moduleName;

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $pagingModel->set('page', 1);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $listQuery->orderBy([$orderBy => SORT_ASC]);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $record->setData($row);

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $moduleName = $moduleModel->getName();

    Spaces must be used to indent lines; tabs are not allowed
    Open

            if (!empty($parentModuleName)) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $listQuery->orderBy([$orderBy => SORT_DESC]);

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $listQuery = $this->getBasicListQuery();

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @param Vtiger_Paging_Model $pagingModel

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $qualifiedModuleName = $parentModuleName . ':' . $qualifiedModuleName;

    Spaces must be used to indent lines; tabs are not allowed
    Open

            if (!empty($orderBy)) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }

    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

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if ('DESC' === $this->getForSql('sortorder')) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

            while ($row = $dataReader->read()) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

            return $listViewRecordModels;

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $modelClassName = Vtiger_Loader::getComponentClassName('Model', 'ListView', $name);

    Spaces must be used to indent lines; tabs are not allowed
    Open

        {

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $instance = new $modelClassName();

    Spaces must be used to indent lines; tabs are not allowed
    Open

        }

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /**

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $record->setModule($moduleModel);

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * Function to get the instance of Settings module model.

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public static function getInstance($name = 'Settings:BusinessHours')

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $dataReader->close();

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @param mixed $name

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *

    Spaces must be used to indent lines; tabs are not allowed
    Open

         */

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @return Settings_Vtiger_Module_Model instance

    Spaces must be used to indent lines; tabs are not allowed
    Open

            return $instance->setModule($name);

    Spaces must be used to indent lines; tabs are not allowed
    Open

        }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $listViewRecordModels[$record->getId()] = $record;

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *

    Class name "Settings_BusinessHours_ListView_Model" is not in camel caps format
    Open

    class Settings_BusinessHours_ListView_Model extends Settings_Vtiger_ListView_Model

    There are no issues that match your filters.

    Category
    Status