YetiForceCompany/YetiForceCRM

View on GitHub
modules/Notification/dashboards/NotificationsBySender.php

Summary

Maintainability
F
4 days
Test Coverage
F
0%

Method getNotificationBySender has 40 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function getNotificationBySender($time)
    {
        $accessibleUsers = \App\Fields\Owner::getInstance()->getAccessibleUsers();
        $moduleName = 'Notification';
        $listViewUrl = Vtiger_Module_Model::getInstance($moduleName)->getListViewUrl();
Severity: Minor
Found in modules/Notification/dashboards/NotificationsBySender.php - About 1 hr to fix

    Missing class import via use statement (line '49', 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 '50', column '34').
    Open

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

    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\Fields\Date' in method 'getNotificationBySender'.
    Open

            $time = \App\Fields\Date::formatRangeToDisplay($time);

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

                $time = Settings_WidgetsManagement_Module_Model::getDefaultDateRange($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\Fields\Date' in method 'process'.
    Open

            $viewer->assign('DTIME', \App\Fields\Date::formatRangeToDisplay($time));

    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 'getNotificationBySender'.
    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

    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/NotificationsBySenderRecipient.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 'App\Fields\Owner' in method 'getNotificationBySender'.
    Open

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

    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($request->getInteger('linkid'), Users_Record_Model::getCurrentUserModel()->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 "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.

    Define a constant instead of duplicating this literal "smcreatorid" 7 times.
    Open

                $conditions[] = ['smcreatorid', 'e', $owner];

    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.

    Define a constant instead of duplicating this literal "createdtime" 3 times.
    Open

                $conditions[] = ['createdtime', 'bw', implode(',', $time)];

    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('DATA', $this->getNotificationBySender($time));

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

            $dataReader->close();

    Call to undeclared method \Vtiger_Viewer::assign
    Open

            $viewer->assign('DTIME', \App\Fields\Date::formatRangeToDisplay($time));

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

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

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

            $query->groupBy(['smcreatorid']);

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

            $accessibleUsers = \App\Fields\Owner::getInstance()->getAccessibleUsers();

    Call to undeclared method \Vtiger_Viewer::assign
    Open

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

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

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

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

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

    Call to method getInstance from undeclared class \Vtiger_Widget_Model
    Open

            $widget = Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), Users_Record_Model::getCurrentUserModel()->getId());

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

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

    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(*)'), 'smcreatorid'])

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

    <?php
    
    /**
     * Notifications Dashboard Class.
     *
    Severity: Major
    Found in modules/Notification/dashboards/NotificationsBySender.php and 1 other location - About 4 days to fix
    modules/Notification/dashboards/NotificationsByRecipient.php on lines 1..107

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 786.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Avoid excessively long class names like Notification_NotificationsBySender_Dashboard. Keep class name length under 40.
    Open

    class Notification_NotificationsBySender_Dashboard extends Vtiger_IndexAjax_View
    {
        /**
         * Return search params (use to in building address URL to listview).
         *

    LongClassName

    Since: 2.9

    Detects when classes or interfaces are declared with excessively long names.

    Example

    class ATooLongClassNameThatHintsAtADesignProblem {
    
    }
    
    interface ATooLongInterfaceNameThatHintsAtADesignProblem {
    
    }

    Source https://phpmd.org/rules/naming.html#longclassname

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

    class Notification_NotificationsBySender_Dashboard extends Vtiger_IndexAjax_View

    The class Notification_NotificationsBySender_Dashboard is not named in CamelCase.
    Open

    class Notification_NotificationsBySender_Dashboard extends Vtiger_IndexAjax_View
    {
        /**
         * Return search params (use to in building address URL to listview).
         *

    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

            $time = \App\Fields\Date::formatRangeToDisplay($time);

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

            $viewer->assign('DATA', $this->getNotificationBySender($time));

    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

        /**

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

            $accessibleUsers = \App\Fields\Owner::getInstance()->getAccessibleUsers();

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

                ->from('vtiger_crmentity')

    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

         */

    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

                        'backgroundColor' => [],

    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

                $label = $accessibleUsers[$row['smcreatorid']];

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

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

    Line exceeds 120 characters; contains 135 characters
    Open

            $widget = Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), Users_Record_Model::getCurrentUserModel()->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

         * @param string|int $owner

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

                    'and',

    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

            return $chartData;

    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('WIDGET', $widget);

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

            if (!empty($time)) {

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

                $conditions[] = ['createdtime', 'bw', implode(',', $time)];

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

            return '&entityState=Active&viewname=All&search_params=' . json_encode($listSearchParams);

    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

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

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

                $time = Settings_WidgetsManagement_Module_Model::getDefaultDateRange($widget);

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

                    ['setype' => $moduleName],

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

            $widget = Vtiger_Widget_Model::getInstance($request->getInteger('linkid'), Users_Record_Model::getCurrentUserModel()->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

                $conditions[] = ['smcreatorid', 'e', $owner];

    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

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

    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

        public function process(App\Request $request)

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

         * Return search params (use to in building address URL to listview).

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

         * @param array      $time

    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($owner, $time)

    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

                    ['deleted' => 0],

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

                    ['>=', 'createdtime', $time[0] . ' 00:00:00'],

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

                ]);

    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

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

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

            }

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

            $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

        {

    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

         *

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

         * @param array $time Contains start and end created time of natification

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

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

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

                ->where([

    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

            $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

            $moduleName = 'Notification';

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

                    ['smcreatorid' => array_keys($accessibleUsers)],

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

            $query->groupBy(['smcreatorid']);

    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

         * Function to get data for chart Return number notification by sender.

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

                    ],

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

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

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

            if (!empty($owner)) {

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

        private function getNotificationBySender($time)

    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

                    ['<=', 'createdtime', $time[1] . ' 23:59:59'],

    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

            $time = $request->getDateRange('time');

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

        {

    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

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

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

            if (empty($time)) {

    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/NotificationsBySenderRecipient.tpl', $moduleName);

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

            $viewer->assign('DTIME', \App\Fields\Date::formatRangeToDisplay($time));

    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

            } else {

    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

        }

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

            }

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

    class Notification_NotificationsBySender_Dashboard extends Vtiger_IndexAjax_View

    There are no issues that match your filters.

    Category
    Status