YetiForceCompany/YetiForceCRM

View on GitHub
modules/HelpDesk/dashboards/OpenTickets.php

Summary

Maintainability
A
1 hr
Test Coverage
F
0%

Method getOpenTickets has 44 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getOpenTickets()
    {
        $ticketStatus = Settings_SupportProcesses_Module_Model::getTicketStatusNotModify();
        $moduleName = 'HelpDesk';
        $query = new \App\Db\Query();
Severity: Minor
Found in modules/HelpDesk/dashboards/OpenTickets.php - About 1 hr to fix

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

            $query = new \App\Db\Query();

    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 '27', column '19').
    Open

                'color' => new \yii\db\Expression("CASE WHEN ($userNameSql NOT LIKE '') THEN

    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 '25', column '34').
    Open

            $query->select(['count' => new \yii\db\Expression('COUNT(*)'),

    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 '26', column '18').
    Open

                'name' => new \yii\db\Expression("CASE WHEN ($userNameSql NOT LIKE '') THEN $userNameSql ELSE vtiger_groups.groupname END"),

    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 'App\Module' in method 'getOpenTickets'.
    Open

            $userNameSql = App\Module::getSqlForNameInDisplayFormat('Users');

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

            } else {
                $allTicketStatus = Settings_SupportProcesses_Module_Model::getAllTicketStatus();
                $openTicketsStatus = implode('##', $allTicketStatus);
            }

    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_SupportProcesses_Module_Model' in method 'getSearchParams'.
    Open

            $openTicketsStatus = Settings_SupportProcesses_Module_Model::getOpenTicketStatus();

    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\Json' in method 'getSearchParams'.
    Open

            return '&entityState=Active&viewname=All&search_params=' . urlencode(App\Json::encode($listSearchParams));

    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

            $viewer->assign('WIDGET', Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), \App\User::getCurrentUserId()));

    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 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/OpenTickets.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 'Vtiger_Widget_Model' in method 'process'.
    Open

            $viewer->assign('WIDGET', Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), \App\User::getCurrentUserId()));

    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 'Settings_SupportProcesses_Module_Model' in method 'getOpenTickets'.
    Open

            $ticketStatus = Settings_SupportProcesses_Module_Model::getTicketStatusNotModify();

    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\PrivilegeQuery' in method 'getOpenTickets'.
    Open

            \App\PrivilegeQuery::getConditions($query, $moduleName);

    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 'Settings_SupportProcesses_Module_Model' in method 'getSearchParams'.
    Open

                $allTicketStatus = Settings_SupportProcesses_Module_Model::getAllTicketStatus();

    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\Fields\Owner' in method 'getOpenTickets'.
    Open

                $chartData['datasets'][0]['backgroundColor'][] = \App\Fields\Owner::getColor($row['id']);

    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\Utils' in method 'getOpenTickets'.
    Open

                $chartData['labels'][] = \App\Utils::getInitials($label);

    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 "datasets" 5 times.
    Open

                'datasets' => [

    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 method __construct from undeclared class \yii\db\Expression
    Open

                'name' => new \yii\db\Expression("CASE WHEN ($userNameSql NOT LIKE '') THEN $userNameSql ELSE vtiger_groups.groupname END"),

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

                'color' => new \yii\db\Expression("CASE WHEN ($userNameSql NOT LIKE '') THEN

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

            $query->groupBy(['smownerid', 'vtiger_users.last_name', 'vtiger_users.first_name', 'vtiger_groups.groupname', 'vtiger_users.cal_color', 'vtiger_groups.color']);

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

            $dataReader->close();

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

                $query->andWhere(['not in', 'vtiger_troubletickets.status', $ticketStatus]);

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

                $chartData['datasets'][0]['backgroundColor'][] = \App\Fields\Owner::getColor($row['id']);

    Call to method getInstance from undeclared class \Vtiger_Widget_Model
    Open

            $viewer->assign('WIDGET', Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), \App\User::getCurrentUserId()));

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('WIDGET', Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), \App\User::getCurrentUserId()));

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

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

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

            $query->select(['count' => new \yii\db\Expression('COUNT(*)'),

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('DATA', $data);

    Call to undeclared method \Vtiger_Viewer::assign
    Open

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

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

            $query->select(['count' => new \yii\db\Expression('COUNT(*)'),

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

            $chartData['show_chart'] = (bool) $dataReader->count();

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

            $viewer->assign('WIDGET', Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), \App\User::getCurrentUserId()));

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

    class HelpDesk_OpenTickets_Dashboard extends Vtiger_IndexAjax_View

    The class HelpDesk_OpenTickets_Dashboard is not named in CamelCase.
    Open

    class HelpDesk_OpenTickets_Dashboard extends Vtiger_IndexAjax_View
    {
        /**
         * Function returns Tickets grouped by Status.
         *

    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

                ],

    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 getSearchParams($value)

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

            $listSearchParams = [];

    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

        /**

    Line exceeds 120 characters; contains 136 characters
    Open

                'name' => new \yii\db\Expression("CASE WHEN ($userNameSql NOT LIKE '') THEN $userNameSql ELSE vtiger_groups.groupname END"),

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

                'color' => new \yii\db\Expression("CASE WHEN ($userNameSql NOT LIKE '') THEN

    Line exceeds 120 characters; contains 168 characters
    Open

            $query->groupBy(['smownerid', 'vtiger_users.last_name', 'vtiger_users.first_name', 'vtiger_groups.groupname', 'vtiger_users.cal_color', 'vtiger_groups.color']);

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

            $listViewUrl = Vtiger_Module_Model::getInstance($moduleName)->getListViewUrl();

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

                $chartData['labels'][] = \App\Utils::getInitials($label);

    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

        public function process(App\Request $request)

    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

                        'data' => [],

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

                        'backgroundColor' => [],

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

         * @param int $value

    Line exceeds 120 characters; contains 137 characters
    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

                ->leftJoin('vtiger_users', 'vtiger_crmentity.smownerid = vtiger_users.id')

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

                ->where(['vtiger_crmentity.deleted' => 0]);

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

                'labels' => [],

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

                'show_chart' => false,

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

                        'titlesFormatted' => [],

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

            $chartData['show_chart'] = (bool) $dataReader->count();

    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 params to search.

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

                $query->andWhere(['not in', 'vtiger_troubletickets.status', $ticketStatus]);

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

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

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

         * Main process.

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

            $data = $this->getOpenTickets();

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

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

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

                $viewer->view('dashboards/OpenTickets.tpl', $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

            if (!empty($ticketStatus)) {

    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

                $label = trim($row['name']);

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

                $allTicketStatus = Settings_SupportProcesses_Module_Model::getAllTicketStatus();

    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 = 'HelpDesk';

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

                ->leftJoin('vtiger_groups', 'vtiger_crmentity.smownerid = vtiger_groups.groupid')

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

            ];

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

                $chartData['datasets'][0]['data'][] = (int) $row['count'];

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

         * @return string

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

                'name' => new \yii\db\Expression("CASE WHEN ($userNameSql NOT LIKE '') THEN $userNameSql ELSE vtiger_groups.groupname END"),

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

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

            return '&entityState=Active&viewname=All&search_params=' . urlencode(App\Json::encode($listSearchParams));

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

         *

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

            //Include special script and css needed for this widget

    Line exceeds 120 characters; contains 131 characters
    Open

            $viewer->assign('WIDGET', Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), \App\User::getCurrentUserId()));

    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

            $query = new \App\Db\Query();

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

                'id' => 'smownerid', ])

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

                ->innerJoin('vtiger_crmentity', 'vtiger_troubletickets.ticketid = vtiger_crmentity.crmid')

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

            \App\PrivilegeQuery::getConditions($query, $moduleName);

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

            $chartData = [

    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

            $dataReader->close();

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

         *

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

            $openTicketsStatus = Settings_SupportProcesses_Module_Model::getOpenTicketStatus();

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

                $openTicketsStatus = implode('##', $allTicketStatus);

    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

            $viewer->assign('WIDGET', Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), \App\User::getCurrentUserId()));

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

                $viewer->view('dashboards/DashBoardWidgetContents.tpl', $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

            $moduleName = $request->getModule();

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

            $viewer->assign('DATA', $data);

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

        public function getOpenTickets()

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

                        'links' => [],

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

                $chartData['datasets'][0]['titlesFormatted'][] = $label;

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

                $openTicketsStatus = implode('##', $openTicketsStatus);

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

            $conditions = [['assigned_user_id', 'e', $value]];

    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

        {

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

            $userNameSql = App\Module::getSqlForNameInDisplayFormat('Users');

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

                $chartData['datasets'][0]['links'][] = $listViewUrl . $this->getSearchParams($row['id']);

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

            return $chartData;

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

         * Function returns Tickets grouped by Status.

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

            $ticketStatus = Settings_SupportProcesses_Module_Model::getTicketStatusNotModify();

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

                ->from('vtiger_troubletickets')

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

                $chartData['datasets'][0]['backgroundColor'][] = \App\Fields\Owner::getColor($row['id']);

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

            array_push($conditions, ['ticketstatus', 'e', $openTicketsStatus]);

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

            $listSearchParams[] = $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

            $query->select(['count' => new \yii\db\Expression('COUNT(*)'),

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

                'datasets' => [

    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

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

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

            }

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

            $query->groupBy(['smownerid', 'vtiger_users.last_name', 'vtiger_users.first_name', 'vtiger_groups.groupname', 'vtiger_users.cal_color', 'vtiger_groups.color']);

    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

            }

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

    class HelpDesk_OpenTickets_Dashboard extends Vtiger_IndexAjax_View

    There are no issues that match your filters.

    Category
    Status