YetiForceCompany/YetiForceCRM

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

Summary

Maintainability
A
25 mins
Test Coverage
F
0%

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

    public static function getConfig($type)
    {
        $cache = Vtiger_Cache::get('MarketingProcesses', $type);
        if ($cache) {
            \App\Log::trace('End ' . __METHOD__);
Severity: Minor
Found in modules/Settings/MarketingProcesses/models/Module.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 '24', column '17').
Open

        $query = (new \App\Db\Query())->from('yetiforce_proc_marketing')->where(['type' => $type]);

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\Log' in method 'getConfig'.
Open

            \App\Log::trace('End ' . __METHOD__);

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

            } else {
                $config[$param] = $value;
            }

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_Cache' in method 'getConfig'.
Open

        Vtiger_Cache::set('MarketingProcesses', $type, $config);

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_Cache' in method 'getConfig'.
Open

        $cache = Vtiger_Cache::get('MarketingProcesses', $type);

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

Call to method trace from undeclared class \App\Log
Open

            \App\Log::trace('End ' . __METHOD__);

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

        $query = (new \App\Db\Query())->from('yetiforce_proc_marketing')->where(['type' => $type]);

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

        \App\Db::getInstance()->createCommand()->update('yetiforce_proc_marketing', ['value' => $value], ['type' => $type, 'param' => $param])->execute();

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

class Settings_MarketingProcesses_Module_Model extends \App\Base

The class Settings_MarketingProcesses_Module_Model is not named in CamelCase.
Open

class Settings_MarketingProcesses_Module_Model extends \App\Base
{
    public static function getCleanInstance()
    {
        return new self();

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 $cache;

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

    {

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

            $value = implode(',', $value);

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 $config;

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

        if ($cache) {

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 new self();

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

            if (\in_array($param, ['groups', 'status', 'convert_status'])) {

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

            \App\Log::trace('End ' . __METHOD__);

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

            return [];

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

    public static function setConfig($param, $type, $value)

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

        $cache = Vtiger_Cache::get('MarketingProcesses', $type);

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

        $noRows = $dataReader->count();

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

        $config = [];

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

        if (\is_array($value)) {

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

                $config[$param] = $value;

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

Line exceeds 120 characters; contains 154 characters
Open

        \App\Db::getInstance()->createCommand()->update('yetiforce_proc_marketing', ['value' => $value], ['type' => $type, 'param' => $param])->execute();

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

    public static function getCleanInstance()

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\Db::getInstance()->createCommand()->update('yetiforce_proc_marketing', ['value' => $value], ['type' => $type, 'param' => $param])->execute();

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

    public static function getConfig($type)

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 (0 === $noRows) {

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

    }

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

        $query = (new \App\Db\Query())->from('yetiforce_proc_marketing')->where(['type' => $type]);

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

            $value = $row['value'];

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

            $param = $row['param'];

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

                $config[$param] = '' == $value ? [] : explode(',', $value);

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

        Vtiger_Cache::set('MarketingProcesses', $type, $config);

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

        return true;

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

class Settings_MarketingProcesses_Module_Model extends \App\Base

There are no issues that match your filters.

Category
Status