YetiForceCompany/YetiForceCRM

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

Summary

Maintainability
A
2 hrs
Test Coverage
F
10%

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

    public static function getConfig($type = false)
    {
        \App\Log::trace('Start ' . __METHOD__ . " | Type: $type");
        $cache = Vtiger_Cache::get('SalesProcesses', false === $type ? 'all' : $type);
        if ($cache) {
Severity: Minor
Found in modules/Settings/SalesProcesses/models/Module.php - About 1 hr to fix

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

        public static function getConfig($type = false)
        {
            \App\Log::trace('Start ' . __METHOD__ . " | Type: $type");
            $cache = Vtiger_Cache::get('SalesProcesses', false === $type ? 'all' : $type);
            if ($cache) {
    Severity: Minor
    Found in modules/Settings/SalesProcesses/models/Module.php - About 55 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 an NPath complexity of 224. The configured NPath complexity threshold is 200.
    Open

        public static function getConfig($type = false)
        {
            \App\Log::trace('Start ' . __METHOD__ . " | Type: $type");
            $cache = Vtiger_Cache::get('SalesProcesses', false === $type ? 'all' : $type);
            if ($cache) {

    NPathComplexity

    Since: 0.1

    The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

    Example

    class Foo {
        function bar() {
            // lots of complicated code
        }
    }

    Source https://phpmd.org/rules/codesize.html#npathcomplexity

    The method getConfig() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
    Open

        public static function getConfig($type = false)
        {
            \App\Log::trace('Start ' . __METHOD__ . " | Type: $type");
            $cache = Vtiger_Cache::get('SalesProcesses', false === $type ? 'all' : $type);
            if ($cache) {

    CyclomaticComplexity

    Since: 0.1

    Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

    Example

    // Cyclomatic Complexity = 11
    class Foo {
    1   public function example() {
    2       if ($a == $b) {
    3           if ($a1 == $b1) {
                    fiddle();
    4           } elseif ($a2 == $b2) {
                    fiddle();
                } else {
                    fiddle();
                }
    5       } elseif ($c == $d) {
    6           while ($c == $d) {
                    fiddle();
                }
    7        } elseif ($e == $f) {
    8           for ($n = 0; $n < $h; $n++) {
                    fiddle();
                }
            } else {
                switch ($z) {
    9               case 1:
                        fiddle();
                        break;
    10              case 2:
                        fiddle();
                        break;
    11              case 3:
                        fiddle();
                        break;
                    default:
                        fiddle();
                        break;
                }
            }
        }
    }

    Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

    Missing class import via use statement (line '39', column '17').
    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

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

        public static function getConfig($type = false)

    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

    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[$row['type']][$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 '\App\Log' in method 'getConfig'.
    Open

            \App\Log::trace('Start ' . __METHOD__ . " | Type: $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

    Avoid using static access to class '\App\Log' in method 'setConfig'.
    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

    Avoid using static access to class 'Vtiger_Cache' in method 'getConfig'.
    Open

            Vtiger_Cache::set('SalesProcesses', false === $type ? 'all' : $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 '\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

    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

    Avoid using static access to class '\App\Log' in method 'setConfig'.
    Open

            \App\Log::trace('Start ' . __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

    Avoid using static access to class 'Vtiger_Cache' in method 'getConfig'.
    Open

            $cache = Vtiger_Cache::get('SalesProcesses', false === $type ? 'all' : $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

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

                $param = $row['param'];

    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('Start ' . __METHOD__);

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

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

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

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

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

            App\Db::getInstance()->createCommand()

    Return type of getCleanInstance() is undeclared type \self
    Open

        public static function getCleanInstance()

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

        public static function getConfig($type = false)

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

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

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

            \App\Log::trace('Start ' . __METHOD__ . " | Type: $type");

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

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

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

    class Settings_SalesProcesses_Module_Model extends \App\Base

    The class Settings_SalesProcesses_Module_Model is not named in CamelCase.
    Open

    class Settings_SalesProcesses_Module_Model extends \App\Base
    {
        /**
         * Return clean instance of 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

                $query->where(['type' => $type]);

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

        public static function setConfig($param)

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

            return true;

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

         * @return bool

    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 static function getCleanInstance()

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

            \App\Log::trace('Start ' . __METHOD__ . " | Type: $type");

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

            if (!$rows) {

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

            foreach ($rows as $row) {

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

                }

    Line exceeds 120 characters; contains 121 characters
    Open

                ->update('yetiforce_proc_sales', ['value' => $value], ['type' => $param['type'], 'param' => $param['param']])

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

                    $value = '' === $value ? [] : explode(',', $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

        public static function getConfig($type = false)

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

         * @return bool

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

                ->execute();

    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

        {

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

            if ('true' == $popup['limit_product_service']) {

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

                ->from('yetiforce_proc_sales');

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

        }

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

            $rows = $query->all();

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

            $returnArrayForFields = ['groups', 'status', 'calculationsstatus', 'salesstage', 'salesstage', 'assetstatus', 'statuses_close'];

    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

            App\Db::getInstance()->createCommand()

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

         * @param mixed $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

                return [];

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

                    $config[$row['type']][$param] = $value;

    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

         */

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

            $value = $param['val'];

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

                ->update('yetiforce_proc_sales', ['value' => $value], ['type' => $param['type'], 'param' => $param['param']])

    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

                return $cache;

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

            $returnArrayForFields = ['groups', 'status', 'calculationsstatus', 'salesstage', 'salesstage', 'assetstatus', 'statuses_close'];

    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_Cache::set('SalesProcesses', false === $type ? 'all' : $type, $config);

    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

            $cache = Vtiger_Cache::get('SalesProcesses', false === $type ? 'all' : $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

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

    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 (\in_array($param, $returnArrayForFields)) {

    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

                return false;

    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

            if ($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

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

    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

         * @param array $param

    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

                $value = $row['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

        }

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

            if (!self::isLimitForModule($moduleName)) {

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

         * Return clean instance of self.

    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

                if ($type) {

    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

            if (\is_array($value)) {

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

        public static function checkRelatedToPotentialsLimit($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

                return true;

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

        /**

    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

            return new self();

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

         * Set sales processess config variable.

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

        /**

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

         * Checks if products are set to be narrowed to only those related to Opportunity.

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

         */

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

            $popup = self::getConfig('popup');

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

         * @return \self

    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 sales processess configuration array.

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

         * @param string $type

    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

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

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

         * @param mixed $moduleName

    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

            $validModules = ['SQuotes', 'SCalculations', 'SQuoteEnquiries', 'SRequirementsCards', 'SSingleOrders', 'SRecurringOrders'];

    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 bool

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

            return \in_array($moduleName, $validModules);

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

         * Checks if limit can be applied to this module.

    Line exceeds 120 characters; contains 131 characters
    Open

            $validModules = ['SQuotes', 'SCalculations', 'SQuoteEnquiries', 'SRequirementsCards', 'SSingleOrders', 'SRecurringOrders'];

    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 static function isLimitForModule($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 "Settings_SalesProcesses_Module_Model" is not in camel caps format
    Open

    class Settings_SalesProcesses_Module_Model extends \App\Base

    There are no issues that match your filters.

    Category
    Status