YetiForceCompany/YetiForceCRM

View on GitHub
modules/Settings/CronTasks/models/Module.php

Summary

Maintainability
B
5 hrs
Test Coverage
B
80%

Method getLastCronIteration has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getLastCronIteration()
    {
        $result = [];
        $totalDiff = $finalLastStart = $finalLastEnd = $finishedTasks = 0;
        $timedout = false;
Severity: Minor
Found in modules/Settings/CronTasks/models/Module.php - About 1 hr to fix

    Function getLastCronIteration has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

        public function getLastCronIteration()
        {
            $result = [];
            $totalDiff = $finalLastStart = $finalLastEnd = $finishedTasks = 0;
            $timedout = false;
    Severity: Minor
    Found in modules/Settings/CronTasks/models/Module.php - About 1 hr 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

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

                $record = new Settings_CronTasks_Record_Model($task);

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

            $db->createCommand()->update('vtiger_cron_task', ['sequence' => new yii\db\Expression($caseSequence)])->execute();

    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 '101', column '17').
    Open

            $tasks = (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

    Avoid using static access to class '\App\Fields\DateTime' in method 'getLastCronIteration'.
    Open

            $result['laststart'] = empty($lastStart) ? ' - ' : \App\Fields\DateTime::formatToViewDate(date('Y-m-d H:i:s', $lastStart));

    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\Db' in method 'updateSequence'.
    Open

            $db = App\Db::getInstance();

    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\RangeTime' in method 'getLastCronIteration'.
    Open

                $result['duration'] = \App\Fields\RangeTime::displayElapseTime($totalDiff, 's');

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

            } else {
                $result['duration'] = \App\Fields\RangeTime::displayElapseTime($totalDiff, 's');
            }

    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

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

        public $baseTable = 'vtiger_cron_task';

    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 "status" 3 times.
    Open

            'status' => 'Status',

    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 "duration" 3 times.
    Open

            'duration' => 'LBL_DURATION',

    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 "laststart" 4 times.
    Open

            'laststart' => 'Last Start',

    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 \App\Db::quoteColumnName
    Open

                $caseSequence .= ' WHEN ' . $db->quoteColumnName('id') . ' = ' . $db->quoteValue($recordId) . ' THEN ' . $db->quoteValue($sequence);

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

            $tasks = (new \App\Db\Query())

    Call to undeclared method \App\Db::createCommand
    Open

            $db->createCommand()->update('vtiger_cron_task', ['sequence' => new yii\db\Expression($caseSequence)])->execute();

    Call to undeclared method \App\Db::quoteValue
    Open

                $caseSequence .= ' WHEN ' . $db->quoteColumnName('id') . ' = ' . $db->quoteValue($recordId) . ' THEN ' . $db->quoteValue($sequence);

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

            $db->createCommand()->update('vtiger_cron_task', ['sequence' => new yii\db\Expression($caseSequence)])->execute();

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

        public function updateSequence($sequencesList)
        {
            $db = App\Db::getInstance();
            $caseSequence = 'CASE';
            foreach ($sequencesList as $sequence => $recordId) {
    Severity: Major
    Found in modules/Settings/CronTasks/models/Module.php and 1 other location - About 1 hr to fix
    modules/Settings/Countries/models/Module.php on lines 15..24

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

    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

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

    class Settings_CronTasks_Module_Model extends Settings_Vtiger_Module_Model

    The class Settings_CronTasks_Module_Model is not named in CamelCase.
    Open

    class Settings_CronTasks_Module_Model extends Settings_Vtiger_Module_Model
    {
        public $baseTable = 'vtiger_cron_task';
        public $baseIndex = 'id';
        public $listFields = [

    CamelCaseClassName

    Since: 0.2

    It is considered best practice to use the CamelCase notation to name classes.

    Example

    class class_name {
    }

    Source

    Avoid variables with short names like $db. Configured minimum length is 3.
    Open

            $db = App\Db::getInstance();

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
        private $q = 15; // VIOLATION - Field
        public static function main( array $as ) { // VIOLATION - Formal
            $r = 20 + $this->q; // VIOLATION - Local
            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                $r += $this->q;
            }
        }
    }

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

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

            'last_update' => 'Last update',

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

        private $lastCronStart = 0;

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

        public function getLastCronStart()

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

                ],

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

                        $finalLastStart = $lastStart;

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

         * @return array List of fieldNames

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

            foreach ($sequencesList as $sequence => $recordId) {

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

                    return $this->lastCronStart = (int) $cronConfig['last_start'];

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

            $timedout = false;

    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

                $cronConfig = include $cronConfigFileName;

    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

            $result = [];

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

                ])

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

                        $finalLastEnd = $lastEnd;

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

    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 hasCreatePermissions()

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

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

                ->from('vtiger_cron_task')

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

            foreach ($tasks as $task) {

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

        public $name = 'CronTasks';

    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 144 characters
    Open

                $caseSequence .= ' WHEN ' . $db->quoteColumnName('id') . ' = ' . $db->quoteValue($recordId) . ' THEN ' . $db->quoteValue($sequence);

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

         * @return int timestamp

    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 ($cronConfig && isset($cronConfig['last_start'])) {

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

                ->query()

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

         * @var int

    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

                ->where(['>=', 'laststart', $lastStart])

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

                $lastStart = (int) $record->get('laststart');

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

                    if ($lastEnd > $finalLastEnd) {

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

         * Get last executed Cron info formated by user settings.

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

                if (!$record->isRunning() && !$record->hadTimedout()) {

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

            'sequence' => 'Sequence',

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

         * Function to get editable fields from this module.

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

         */

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

            $db = App\Db::getInstance();

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

        }

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

            $totalDiff = $finalLastStart = $finalLastEnd = $finishedTasks = 0;

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

                    Settings_CronTasks_Record_Model::$STATUS_COMPLETED,

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

                $record = new Settings_CronTasks_Record_Model($task);

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

                $lastEnd = (int) $record->get('lastend');

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

                    if ($lastStart > $finalLastStart) {

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

            'laststart' => 'Last Start',

    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

            $lastStart = $this->getLastCronStart();

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

                    ++$finishedTasks;

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

            $result['laststart'] = empty($lastStart) ? ' - ' : \App\Fields\DateTime::formatToViewDate(date('Y-m-d H:i:s', $lastStart));

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

            $result['tasks'] = \count($tasks);

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

            $result['finished_tasks'] = $finishedTasks;

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

            'frequency' => 'Frequency(H:M)',

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

            'status' => 'Status',

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

         * Save last cron time start between views (timestamp).

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

        public function getEditableFieldsList()

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

            $caseSequence = 'CASE';

    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

        public function getLastCronIteration()

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

            return $result;

    Line exceeds 120 characters; contains 131 characters
    Open

            $result['laststart'] = empty($lastStart) ? ' - ' : \App\Fields\DateTime::formatToViewDate(date('Y-m-d H:i:s', $lastStart));

    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

            'name' => 'Cron Job',

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

            if ($timedout) {

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

            return ['frequency', 'status'];

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

         * Function to update sequence of several records.

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

                $caseSequence .= ' WHEN ' . $db->quoteColumnName('id') . ' = ' . $db->quoteValue($recordId) . ' THEN ' . $db->quoteValue($sequence);

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

            $caseSequence .= ' END';

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

            return false;

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

         * Returns last iteration start 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

                ->readAll();

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

            $db->createCommand()->update('vtiger_cron_task', ['sequence' => new yii\db\Expression($caseSequence)])->execute();

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

                return $this->lastCronStart;

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

            $cronConfigFileName = ROOT_DIRECTORY . '/app_data/cron.php';

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

            if (file_exists($cronConfigFileName)) {

    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

                    $totalDiff += (int) $record->getTimeDiff();

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

                } elseif ($record->hadTimedout()) {

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

                }

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

                    $timedout = $record;

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

                $result['duration'] = $timedout->getDuration();

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

            }

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

                $result['duration'] = \App\Fields\RangeTime::displayElapseTime($totalDiff, 's');

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

            'lastend' => 'Last 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

         */

    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 updateSequence($sequencesList)

    Line exceeds 120 characters; contains 122 characters
    Open

            $db->createCommand()->update('vtiger_cron_task', ['sequence' => new yii\db\Expression($caseSequence)])->execute();

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

        public function isPagingSupported()

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

            return 0;

    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

            $tasks = (new \App\Db\Query())

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

        public $listFields = [

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

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

         */

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

                    Settings_CronTasks_Record_Model::$STATUS_ENABLED,

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

                    Settings_CronTasks_Record_Model::$STATUS_RUNNING,

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

        public $baseTable = 'vtiger_cron_task';

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

        public $baseIndex = 'id';

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

            'duration' => 'LBL_DURATION',

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

    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 ['duration'=>'0g 0m 0s','laststart'=>'3 hours ago','tasks'=>2, 'finished_tasks'=>1]

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

                ->where(['status', [

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

                ->createCommand()

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

            }

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

    class Settings_CronTasks_Module_Model extends Settings_Vtiger_Module_Model

    There are no issues that match your filters.

    Category
    Status