Sign upLogin

YetiForceCompany/YetiForceCRM

View on GitHub
Star
modules/Settings/Mail/models/ListView.php

Summary

Maintainability
A
3 hrs
Test Coverage
F
0%

Function getListViewEntries has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

    public function getListViewEntries($pagingModel)
    {
        $module = $this->getModule();
        $parentModuleName = $module->getParentName();
        if (!empty($parentModuleName)) {
Severity: Minor
Found in modules/Settings/Mail/models/ListView.php - About 2 hrs 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

Method getListViewEntries has 46 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getListViewEntries($pagingModel)
    {
        $module = $this->getModule();
        $parentModuleName = $module->getParentName();
        if (!empty($parentModuleName)) {
Severity: Minor
Found in modules/Settings/Mail/models/ListView.php - About 1 hr to fix

    The method getListViewEntries() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
    Open

        public function getListViewEntries($pagingModel)
    {
        $module = $this->getModule();
        $parentModuleName = $module->getParentName();
        if (!empty($parentModuleName)) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpmd

    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

    Refactor this function to reduce its Cognitive Complexity from 16 to the 15 allowed.
    Open

        public function getListViewEntries($pagingModel)
    Severity: Critical
    Found in modules/Settings/Mail/models/ListView.php by sonar-php

    Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

    See

    Missing class import via use statement (line '29', column '17').
    Open

            $query = (new \App\Db\Query())->select($listFields)
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpmd

    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

    Avoid using static access to class 'Vtiger_Loader' in method 'getListViewEntries'.
    Open

            $recordModelClass = Vtiger_Loader::getComponentClassName('Model', 'Record', $qualifiedModuleName);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpmd

    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 {
            $pagingModel->set('nextPageExists', false);
        }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpmd

    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 getListViewEntries uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                $query->orderBy([$orderBy => SORT_ASC]);
            }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpmd

    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

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

            $query = (new \App\Db\Query())->select($listFields)
    Severity: Critical
    Found in modules/Settings/Mail/models/ListView.php by phan

    Call to undeclared method \Settings_Vtiger_Module_Model::getFilterFields
    Open

            $fieldsToFilter = $module->getFilterFields();
    Severity: Critical
    Found in modules/Settings/Mail/models/ListView.php by phan

    Each class must be in a namespace of at least one level (a top-level vendor name)
    Open

    class Settings_Mail_ListView_Model extends Settings_Vtiger_ListView_Model
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

    The class Settings_Mail_ListView_Model is not named in CamelCase.
    Open

    class Settings_Mail_ListView_Model extends Settings_Vtiger_ListView_Model
{
    /**
     * Function to get the list view entries.
     *
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpmd

    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

            if (!empty($parentModuleName)) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                $recordModel->setData($row);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

        {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

        }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $query = (new \App\Db\Query())->select($listFields)
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            return $listViewRecordModels;
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

         */
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $startIndex = $pagingModel->getStartIndex();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $pageLimit = $pagingModel->getPageLimit();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            if (!empty($orderBy) && \in_array($orderBy, $listFields)) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

         * Function to get the list view entries.
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

         * @return array - Associative array of record id mapped to Vtiger_Record_Model instance
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

        {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $listFields[] = $module->baseIndex;
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            while ($row = $dataReader->read()) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                array_pop($listViewRecordModels);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $recordModelClass = Vtiger_Loader::getComponentClassName('Model', 'Record', $qualifiedModuleName);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $dataReader = $query->createCommand()->query();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            if ($dataReader->count() > $pageLimit) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

        /**
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $fieldsToFilter = $module->getFilterFields();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                $pagingModel->set('nextPageExists', false);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $listFields = array_keys($module->listFields);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                } else {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $query->limit($pageLimit + 1)->offset($startIndex);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

         *
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                foreach ($searchParams as $key => $value) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

        public function getBasicLinks()
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                    }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $listViewRecordModels = [];
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                $listViewRecordModels[$recordModel->getId()] = $recordModel;
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                    $query->orderBy([$orderBy => SORT_DESC]);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            } else {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            return [];
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

         * @param Vtiger_Paging_Model $pagingModel
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

         *
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $module = $this->getModule();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                $qualifiedModuleName = $parentModuleName . ':' . $module->getName();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                    $query->orderBy([$orderBy => SORT_ASC]);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                $recordModel = new $recordModelClass();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                    if ('' !== $value['value'] && \in_array($key, $fieldsToFilter)) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                        $query->andWhere([$key => $value['value']]);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

        }
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $parentModuleName = $module->getParentName();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $searchParams = $this->get('searchParams');
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

        public function getListViewEntries($pagingModel)
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                ->from($module->baseTable);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $orderBy = $this->getForSql('orderby');
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                if ('DESC' === $this->getForSql('sortorder')) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

                $pagingModel->set('nextPageExists', true);
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $dataReader->close();
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            if (!empty($searchParams)) {
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

            $pagingModel->calculatePageRange($dataReader->count());
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

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

    class Settings_Mail_ListView_Model extends Settings_Vtiger_ListView_Model
    Severity: Minor
    Found in modules/Settings/Mail/models/ListView.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status