Sign upLogin

YetiForceCompany/YetiForceCRM

View on GitHub
Star
modules/Vtiger/models/Processes.php

Summary

Maintainability
A
1 hr
Test Coverage
F
0%

Method getConfig has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function getConfig($process, $type, $procesParam = false)
    {
        \App\Log::trace('Start ' . __METHOD__ . " | Process: $process, Type: $type");
        $processList = [
            'marketing' => 'yetiforce_proc_marketing',
Severity: Minor
Found in modules/Vtiger/models/Processes.php - About 1 hr to fix

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

        public static function getConfig($process, $type, $procesParam = false)
    {
        \App\Log::trace('Start ' . __METHOD__ . " | Process: $process, Type: $type");
        $processList = [
            'marketing' => 'yetiforce_proc_marketing',
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php - About 45 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

    The method getConfig has a boolean flag argument $procesParam, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public static function getConfig($process, $type, $procesParam = false)
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

    Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

    Missing class import via use statement (line '35', column '22').
    Open

            $dataReader = (new \App\Db\Query())->from($processList[$process])->where(['type' => $type])
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

    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__);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

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

                \App\Log::trace('End ' . __METHOD__);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

    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;
            }
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

    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('ProcessesModel', $process . $type, $config);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

    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('ProcessesModel', $process . $type);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

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

            \App\Log::trace('Start ' . __METHOD__ . " | Process: $process, Type: $type");
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

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

            \App\Log::trace('End ' . __METHOD__);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

    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

                    Vtiger_Cache::set('ProcessesModel', $process . $type . $procesParam, $value);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

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

            $cache = Vtiger_Cache::get('ProcessesModel', $process . $type);
    Severity: Critical
    Found in modules/Vtiger/models/Processes.php by sonar-php

    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 trace from undeclared class \App\Log
    Open

            \App\Log::trace('End ' . __METHOD__);
    Severity: Critical
    Found in modules/Vtiger/models/Processes.php by phan

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

            \App\Log::trace('Start ' . __METHOD__ . " | Process: $process, Type: $type");
    Severity: Critical
    Found in modules/Vtiger/models/Processes.php by phan

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

            $dataReader = (new \App\Db\Query())->from($processList[$process])->where(['type' => $type])
    Severity: Critical
    Found in modules/Vtiger/models/Processes.php by phan

    Returning type '' but getConfig() is declared to return array
    Open

                    return $value;
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phan

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

                    \App\Log::trace('End ' . __METHOD__);
    Severity: Critical
    Found in modules/Vtiger/models/Processes.php by phan

    Default value for string $procesParam can't be false
    Open

        public static function getConfig($process, $type, $procesParam = false)
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phan

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

                \App\Log::trace('End ' . __METHOD__);
    Severity: Critical
    Found in modules/Vtiger/models/Processes.php by phan

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

    class Vtiger_Processes_Model
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

    The class Vtiger_Processes_Model is not named in CamelCase.
    Open

    class Vtiger_Processes_Model
{
    /**
     * Returns configuration for processes.
     *
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpmd

    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

         *
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

         *
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                    return $value;
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

         * @param string $type
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            $dataReader = (new \App\Db\Query())->from($processList[$process])->where(['type' => $type])
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

        public static function getConfig($process, $type, $procesParam = false)
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                }
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

         * @param string $process
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

         * @param string $procesParam
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                $param = $row['param'];
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                    Vtiger_Cache::set('ProcessesModel', $process . $type . $procesParam, $value);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

         */
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            ];
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            }
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                    $config[$param] = $value;
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                'marketing' => 'yetiforce_proc_marketing',
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                'sales' => 'yetiforce_proc_sales',
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                    $config[$param] = '' == $value ? [] : explode(',', $value);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                } else {
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                if (false !== $procesParam && $param == $procesParam) {
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            if ($cache) {
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                ->createCommand()->query();
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            $config = [];
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                if ('users' == $param) {
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                \App\Log::trace('End ' . __METHOD__);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                return $cache;
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                $value = $row['value'];
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

         * Returns configuration for processes.
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

        {
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            $processList = [
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

         * @return array
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            \App\Log::trace('Start ' . __METHOD__ . " | Process: $process, Type: $type");
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            $cache = Vtiger_Cache::get('ProcessesModel', $process . $type);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

        /**
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            while ($row = $dataReader->read()) {
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                }
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

                    \App\Log::trace('End ' . __METHOD__);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            }
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            \App\Log::trace('End ' . __METHOD__);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            Vtiger_Cache::set('ProcessesModel', $process . $type, $config);
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

        }
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

            return $config;
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

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

    class Vtiger_Processes_Model
    Severity: Minor
    Found in modules/Vtiger/models/Processes.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status