YetiForceCompany/YetiForceCRM

View on GitHub
modules/Accounts/dashboards/NeglectedAccounts.php

Summary

Maintainability
A
1 hr
Test Coverage
F
0%

Method process has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function process(App\Request $request)
    {
        $currentUser = \App\User::getCurrentUserModel();
        $moduleName = $request->getModule();
        $linkId = $request->getInteger('linkid');
Severity: Minor
Found in modules/Accounts/dashboards/NeglectedAccounts.php - About 1 hr to fix

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

            $queryGenerator = new App\QueryGenerator($moduleName);

    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 '71', column '22').
    Open

            $pagingModel = new Vtiger_Paging_Model();

    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 '32', column '61').
    Open

            $dataReader = $queryGenerator->createQuery()->orderBy(new yii\db\Expression('vtiger_entity_stats.crmactivity IS NULL'))

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

            } else {
                $viewer->view('dashboards/NeglectedAccounts.tpl', $moduleName);
            }

    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 'Settings_WidgetsManagement_Module_Model' in method 'process'.
    Open

                $user = Settings_WidgetsManagement_Module_Model::getDefaultUserId($widget);

    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\User' in method 'process'.
    Open

            $currentUser = \App\User::getCurrentUserModel();

    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_Widget_Model' in method 'process'.
    Open

            $widget = Vtiger_Widget_Model::getInstance($linkId, $currentUser->getId());

    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

    Define a constant instead of duplicating this literal "vtiger_entity_stats.crmactivity" 5 times.
    Open

            $queryGenerator->addNativeCondition(['or', ['<=', 'vtiger_entity_stats.crmactivity', 0], ['vtiger_entity_stats.crmactivity' => null]]);

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
      prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
      execute('action1');
      release('action1');
    }
    

    Compliant Solution

    ACTION_1 = 'action1';
    
    function run() {
      prepare(ACTION_1);
      execute(ACTION_1);
      release(ACTION_1);
    }
    

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('USER_CONDITIONS', $this->conditions);

    Call to method __construct from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            $queryGenerator = new App\QueryGenerator($moduleName);

    Call to method setFields from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            $queryGenerator->setFields(['id', 'accountname', 'assigned_user_id', 'crmactivity']);

    Call to method __construct from undeclared class \yii\db\Expression
    Open

            $dataReader = $queryGenerator->createQuery()->orderBy(new yii\db\Expression('vtiger_entity_stats.crmactivity IS NULL'))

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('ACCOUNTS', $accounts);

    Call to method addNativeCondition from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            $queryGenerator->addNativeCondition(['or', ['<=', 'vtiger_entity_stats.crmactivity', 0], ['vtiger_entity_stats.crmactivity' => null]]);

    Call to method addCondition from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            $queryGenerator->addCondition('assigned_user_id', $user, 'e');

    Call to method setOffset from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            $queryGenerator->setOffset($pagingModel->getStartIndex());

    Call to method getInstance from undeclared class \App\Fields\Owner
    Open

            $accessibleGroups = \App\Fields\Owner::getInstance($moduleName, $currentUser)->getAccessibleGroupForModule();

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('WIDGET', $widget);

    Call to method addJoin from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            $queryGenerator->addJoin(['INNER JOIN', 'vtiger_entity_stats', 'vtiger_entity_stats.crmid = vtiger_account.accountid']);

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('OWNER', $user);

    Call to method getInstance from undeclared class \App\Fields\Owner
    Open

            $accessibleUsers = \App\Fields\Owner::getInstance($moduleName, $currentUser)->getAccessibleUsersForModule();

    Call to method createQuery from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            $dataReader = $queryGenerator->createQuery()->orderBy(new yii\db\Expression('vtiger_entity_stats.crmactivity IS NULL'))

    Call to method getCurrentUserModel from undeclared class \App\User (Did you mean class \Tests\App\User)
    Open

            $currentUser = \App\User::getCurrentUserModel();

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('ACCESSIBLE_USERS', $accessibleUsers);

    Call to method getInstance from undeclared class \Vtiger_Widget_Model
    Open

            $widget = Vtiger_Widget_Model::getInstance($linkId, $currentUser->getId());

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('ACCESSIBLE_GROUPS', $accessibleGroups);

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('MODULE_NAME', $moduleName);

    Call to method setLimit from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            $queryGenerator->setLimit($pagingModel->getPageLimit());

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('PAGING_MODEL', $pagingModel);

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

    class Accounts_NeglectedAccounts_Dashboard extends Vtiger_IndexAjax_View

    The class Accounts_NeglectedAccounts_Dashboard is not named in CamelCase.
    Open

    class Accounts_NeglectedAccounts_Dashboard extends Vtiger_IndexAjax_View
    {
        private $conditions = [];
    
        /**

    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

         * @return array

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

        {

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

            $this->conditions = [

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

            $accessibleUsers = \App\Fields\Owner::getInstance($moduleName, $currentUser)->getAccessibleUsersForModule();

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

            }

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

            }

    Line exceeds 120 characters; contains 143 characters
    Open

            $queryGenerator->addNativeCondition(['or', ['<=', 'vtiger_entity_stats.crmactivity', 0], ['vtiger_entity_stats.crmactivity' => null]]);

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

            $dataReader = $queryGenerator->createQuery()->orderBy(new yii\db\Expression('vtiger_entity_stats.crmactivity IS NULL'))

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

                $accounts[$row['id']] = \Vtiger_Module_Model::getInstance($moduleName)->getRecordFromArray($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

        {

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

            }

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

            $page = $request->getInteger('page');

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

            if ($request->has('content')) {

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

                $viewer->view('dashboards/NeglectedAccounts.tpl', $moduleName);

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

            $queryGenerator->addJoin(['INNER JOIN', 'vtiger_entity_stats', 'vtiger_entity_stats.crmid = vtiger_account.accountid']);

    Line exceeds 120 characters; contains 128 characters
    Open

            $queryGenerator->addJoin(['INNER JOIN', 'vtiger_entity_stats', 'vtiger_entity_stats.crmid = vtiger_account.accountid']);

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

            }

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

        public function process(App\Request $request)

    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

        /**

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

            $queryGenerator->setOffset($pagingModel->getStartIndex());

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

            return $accounts;

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

            $moduleName = $request->getModule();

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

            $viewer->assign('OWNER', $user);

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

         *

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

        private function getAccounts($moduleName, $user, Vtiger_Paging_Model $pagingModel)

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

            $queryGenerator->addNativeCondition(['or', ['<=', 'vtiger_entity_stats.crmactivity', 0], ['vtiger_entity_stats.crmactivity' => null]]);

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

            $pagingModel = new Vtiger_Paging_Model();

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

         * @param int|array           $user

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

            $accounts = [];

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

        private $conditions = [];

    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

         * Process.

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

         *

    Line exceeds 120 characters; contains 127 characters
    Open

            $dataReader = $queryGenerator->createQuery()->orderBy(new yii\db\Expression('vtiger_entity_stats.crmactivity IS NULL'))

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

                $user = Settings_WidgetsManagement_Module_Model::getDefaultUserId($widget);

    Line exceeds 120 characters; contains 124 characters
    Open

                'condition' => ['or', ['vtiger_entity_stats.crmactivity' => null], ['<', 'vtiger_entity_stats.crmactivity', 0]],

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

            $currentUser = \App\User::getCurrentUserModel();

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

            $linkId = $request->getInteger('linkid');

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

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

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

            $viewer->assign('PAGING_MODEL', $pagingModel);

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

         */

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

                'join' => [['LEFT JOIN', 'vtiger_entity_stats', 'vtiger_entity_stats.crmid = vtiger_crmentity.crmid']],

    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 (empty($user)) {

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

                $page = 1;

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

            $viewer->assign('ACCESSIBLE_USERS', $accessibleUsers);

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

        }

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

            $user = $request->getByType('owner', 2);

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

         * @param string              $moduleName

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

                'condition' => ['or', ['vtiger_entity_stats.crmactivity' => null], ['<', 'vtiger_entity_stats.crmactivity', 0]],

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

            $queryGenerator->setFields(['id', 'accountname', 'assigned_user_id', 'crmactivity']);

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

        }

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

            $queryGenerator->setLimit($pagingModel->getPageLimit());

    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

                $user = array_keys($accessibleUsers);

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

            $accessibleGroups = \App\Fields\Owner::getInstance($moduleName, $currentUser)->getAccessibleGroupForModule();

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

            $viewer->assign('USER_CONDITIONS', $this->conditions);

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

            $viewer->assign('ACCOUNTS', $accounts);

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

         * Function to get neglected accounts.

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

                ->addOrderBy(['vtiger_entity_stats.crmactivity' => SORT_ASC])->createCommand()->query();

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

            if ('all' == $user) {

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

            if (empty($page)) {

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

                $viewer->view('dashboards/NeglectedAccountsContents.tpl', $moduleName);

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

            $widget = Vtiger_Widget_Model::getInstance($linkId, $currentUser->getId());

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

            }

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

            $viewer->assign('WIDGET', $widget);

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

            $queryGenerator = new App\QueryGenerator($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

         * @param \App\Request $request

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

            $pagingModel->set('limit', (int) $widget->get('limit'));

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

            $viewer = $this->getViewer($request);

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

            $viewer->assign('ACCESSIBLE_GROUPS', $accessibleGroups);

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

            $queryGenerator->addCondition('assigned_user_id', $user, 'e');

    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

            $accounts = $this->getAccounts($moduleName, $user, $pagingModel);

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

            $viewer->assign('MODULE_NAME', $moduleName);

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

    class Accounts_NeglectedAccounts_Dashboard extends Vtiger_IndexAjax_View

    There are no issues that match your filters.

    Category
    Status