YetiForceCompany/YetiForceCRM

View on GitHub
modules/Calendar/crons/SetCrmActivity.php

Summary

Maintainability
A
25 mins
Test Coverage
B
86%

Function process has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    public function process()
    {
        $pauser = \App\Pauser::getInstance('CrmActivity');
        $lastId = (int) $pauser->getValue();

Severity: Minor
Found in modules/Calendar/crons/SetCrmActivity.php - About 25 mins 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 '47', column '17').
Open

        $query = (new App\Db\Query())->select(['vtiger_crmentity.crmid', 'vtiger_crmentity.setype'])

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

        $pauser = \App\Pauser::getInstance('CrmActivity');

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

            Calendar_Record_Model::setCrmActivity(array_flip([$row['crmid']]), $row['setype']);

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

        $query = (new App\Db\Query())->select(['vtiger_crmentity.crmid', 'vtiger_crmentity.setype'])

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 close from undeclared class \yii\db\DataReader
Open

        $dataReader->close();
Severity: Critical
Found in modules/Calendar/crons/SetCrmActivity.php by phan

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

        $query = (new App\Db\Query())->select(['vtiger_crmentity.crmid', 'vtiger_crmentity.setype'])
Severity: Critical
Found in modules/Calendar/crons/SetCrmActivity.php by phan

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

        while ($row = $dataReader->read()) {
Severity: Critical
Found in modules/Calendar/crons/SetCrmActivity.php by phan

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

        if ($lastId && !$dataReader->count()) {
Severity: Critical
Found in modules/Calendar/crons/SetCrmActivity.php by phan

Doc-block of $lastId in getQuery is phpdoc param type int which is not a permitted replacement of the nullable param type ?int declared in the signature ('?T' should be documented as 'T|null' or '?T')
Open

     * @param int $lastId

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

class Calendar_SetCrmActivity_Cron extends \App\CronHandler

The class Calendar_SetCrmActivity_Cron is not named in CamelCase.
Open

class Calendar_SetCrmActivity_Cron extends \App\CronHandler
{
    /** {@inheritdoc} */
    public function process()
    {

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

                ['vtiger_field.tablename' => 'vtiger_entity_stats', 'vtiger_field.fieldname' => 'crmactivity'],

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

        $lastId = (int) $pauser->getValue();

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

            $pauser->setValue((string) $row['crmid']);

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

            ->innerJoin('vtiger_tab', 'vtiger_tab.name=vtiger_crmentity.setype')

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

            ->innerJoin('vtiger_field', 'vtiger_tab.tabid = vtiger_field.tabid')

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

            ])->orderBy(['vtiger_crmentity.crmid' => SORT_ASC]);

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

    /** {@inheritdoc} */

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

            $pauser->destroy();

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

     * @param int $lastId

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

                ['not', ['vtiger_field.presence' => 1]]

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

        if ($lastId && !$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 App\Db\Query

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

        $query = (new App\Db\Query())->select(['vtiger_crmentity.crmid', 'vtiger_crmentity.setype'])

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

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

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

     */

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

                ['vtiger_crmentity.deleted' => 0],

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

        $dataReader = $this->getQuery($lastId)->createCommand()->query();

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

            if ($this->checkTimeout()) {

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->close();

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

        return $query;

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

        }

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

            Calendar_Record_Model::setCrmActivity(array_flip([$row['crmid']]), $row['setype']);

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

            $query->andWhere(['>', 'vtiger_crmentity.crmid', $lastId]);

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

    }

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

     * Gets query.

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

    private function getQuery(int $lastId = null): App\Db\Query

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

            ->innerJoin('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

    }

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

        if ($lastId) {

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

    public function process()

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

    {

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

        $pauser = \App\Pauser::getInstance('CrmActivity');

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

                ['not', ['vtiger_entity_stats.crmactivity' => null]],

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

     *

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

                break;

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

            ->where(['and',

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

class Calendar_SetCrmActivity_Cron extends \App\CronHandler

There are no issues that match your filters.

Category
Status