YetiForceCompany/YetiForceCRM

View on GitHub
modules/Vtiger/actions/Mass.php

Summary

Maintainability
A
3 hrs
Test Coverage
F
0%

Method getQuery has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function getQuery(App\Request $request)
    {
        $cvId = $request->isEmpty('viewname') ? '' : $request->getByType('viewname', 2);
        $moduleName = $request->getByType('module', 'Alnum');
        if (!empty($cvId) && 'undefined' === $cvId && 'Users' !== $request->getByType('source_module', 2)) {
Severity: Minor
Found in modules/Vtiger/actions/Mass.php - About 1 hr to fix

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

        public static function getQuery(App\Request $request)
        {
            $cvId = $request->isEmpty('viewname') ? '' : $request->getByType('viewname', 2);
            $moduleName = $request->getByType('module', 'Alnum');
            if (!empty($cvId) && 'undefined' === $cvId && 'Users' !== $request->getByType('source_module', 2)) {
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.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 getQuery() has an NPath complexity of 1152. The configured NPath complexity threshold is 200.
    Open

        public static function getQuery(App\Request $request)
        {
            $cvId = $request->isEmpty('viewname') ? '' : $request->getByType('viewname', 2);
            $moduleName = $request->getByType('module', 'Alnum');
            if (!empty($cvId) && 'undefined' === $cvId && 'Users' !== $request->getByType('source_module', 2)) {
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.php by phpmd

    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 getQuery() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10.
    Open

        public static function getQuery(App\Request $request)
        {
            $cvId = $request->isEmpty('viewname') ? '' : $request->getByType('viewname', 2);
            $moduleName = $request->getByType('module', 'Alnum');
            if (!empty($cvId) && 'undefined' === $cvId && 'Users' !== $request->getByType('source_module', 2)) {
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.php by phpmd

    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 '35', column '26').
    Open

                $queryGenerator = new App\QueryGenerator($moduleName);
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.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\Condition' in method 'getQuery'.
    Open

                $customViewModel->set('search_value', App\Condition::validSearchValue($request->getByType('search_value', 'Text'), $moduleName, $searchKey, $operator));
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.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\Condition' in method 'getQuery'.
    Open

            $customViewModel->set('search_params', App\Condition::validSearchParams($moduleName, $request->getArray('search_params')));
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.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 'CustomView_Record_Model' in method 'getQuery'.
    Open

            $customViewModel = CustomView_Record_Model::getInstanceById((int) $cvId);
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.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\Condition' in method 'getQuery'.
    Open

                $customViewModel->set('advancedConditions', \App\Condition::validAdvancedConditions($advancedConditions));
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.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 assigning values to variables in if clauses and the like (line '53', column '7').
    Open

        public static function getQuery(App\Request $request)
        {
            $cvId = $request->isEmpty('viewname') ? '' : $request->getByType('viewname', 2);
            $moduleName = $request->getByType('module', 'Alnum');
            if (!empty($cvId) && 'undefined' === $cvId && 'Users' !== $request->getByType('source_module', 2)) {
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.php by phpmd

    IfStatementAssignment

    Since: 2.7.0

    Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($foo = 'bar') { // possible typo
                // ...
            }
            if ($baz = 0) { // always false
                // ...
            }
        }
    }

    Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

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

            if (!$request->isEmpty('operator')) {
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.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.

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

                $queryGenerator->setStateCondition($request->getByType('entityState'));
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.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.

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

            if ($request->getBoolean('isSortActive') && !$request->isEmpty('orderby')) {
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.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.

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

            if ($advancedConditions = $request->has('advancedConditions') ? $request->getArray('advancedConditions') : []) {
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.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 __construct from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

                $queryGenerator = new App\QueryGenerator($moduleName);
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.php by phan

    Call to method addCondition from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

                $queryGenerator->addCondition('id', $selectedIds, 'e');
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.php by phan

    Call to method clearFields from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

            return $queryGenerator ? $queryGenerator->clearFields()->createQuery()->column() : [];
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.php by phan

    Call to method initForCustomViewById from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

                $queryGenerator->initForCustomViewById($cvId);
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.php by phan

    Call to method setStateCondition from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

                $queryGenerator->setStateCondition($request->getByType('entityState'));
    Severity: Critical
    Found in modules/Vtiger/actions/Mass.php by phan

    Return type of getQuery() is undeclared type \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

        public static function getQuery(App\Request $request)
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.php by phan

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

            if (!$request->isEmpty('operator')) {
                $operator = $request->getByType('operator');
                $searchKey = $request->getByType('search_key', 'Alnum');
                $customViewModel->set('operator', $operator);
                $customViewModel->set('search_key', $searchKey);
    Severity: Major
    Found in modules/Vtiger/actions/Mass.php and 2 other locations - About 1 hr to fix
    modules/SMSNotifier/actions/MassSMS.php on lines 90..96
    modules/SMSNotifier/views/MassSMS.php on lines 119..125

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

    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

    abstract class Vtiger_Mass_Action extends \App\Controller\Action

    The class Vtiger_Mass_Action is not named in CamelCase.
    Open

    abstract class Vtiger_Mass_Action extends \App\Controller\Action
    {
        /**
         * Get query for records list from request.
         *
    Severity: Minor
    Found in modules/Vtiger/actions/Mass.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

         *

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

                $sourceModule = $request->getByType('sourceModule', 2);

    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

                $queryGenerator = new App\QueryGenerator($moduleName);

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

            if (!$request->isEmpty('operator')) {

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

         * @param \App\Request $request

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

            }

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

                $queryGenerator->initForCustomViewById($cvId);

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

                return $queryGenerator;

    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

                $queryGenerator->setStateCondition($request->getByType('entityState'));

    Line exceeds 120 characters; contains 164 characters
    Open

                $customViewModel->set('search_value', App\Condition::validSearchValue($request->getByType('search_value', 'Text'), $moduleName, $searchKey, $operator));

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

         * Get records list from request.

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

        public static function getRecordsListFromRequest(App\Request $request): array

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

        public static function getQuery(App\Request $request)

    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

                $customViewModel->set('search_value', App\Condition::validSearchValue($request->getByType('search_value', 'Text'), $moduleName, $searchKey, $operator));

    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 \App\Request $request

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

                $customViewModel->set('operator', $operator);

    Line exceeds 120 characters; contains 131 characters
    Open

            $customViewModel->set('search_params', App\Condition::validSearchParams($moduleName, $request->getArray('search_params')));

    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 ($advancedConditions = $request->has('advancedConditions') ? $request->getArray('advancedConditions') : []) {

    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 $customViewModel->getRecordsListQuery($request->getArray('excluded_ids', 2), $moduleName);

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

         * @return \App\QueryGenerator|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

            if (!$customViewModel) {

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

            }

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

                $customViewModel->set('advancedConditions', \App\Condition::validAdvancedConditions($advancedConditions));

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

                return $selectedIds;

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

                $cvId = CustomView_Record_Model::getAllFilterByModule($sourceModule)->getId();

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

                $queryGenerator->addCondition('id', $selectedIds, 'e');

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

            if ($request->getBoolean('isSortActive') && !$request->isEmpty('orderby')) {

    Line exceeds 120 characters; contains 125 characters
    Open

                $customViewModel->set('orderby', $request->getArray('orderby', \App\Purifier::STANDARD, [], \App\Purifier::SQL));

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

            $customViewModel->set('search_params', App\Condition::validSearchParams($moduleName, $request->getArray('search_params')));

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

            $queryGenerator = static::getQuery($request);

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

        }

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

            $customViewModel = CustomView_Record_Model::getInstanceById((int) $cvId);

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

                $customViewModel->set('search_key', $searchKey);

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

            }

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

            $customViewModel->set('entityState', $request->getByType('entityState'));

    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

            $selectedIds = $request->getArray('selected_ids', 2);

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

            $cvId = $request->isEmpty('viewname') ? '' : $request->getByType('viewname', 2);

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

                $customViewModel->set('orderby', $request->getArray('orderby', \App\Purifier::STANDARD, [], \App\Purifier::SQL));

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

        /**

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

         * Get query for records list from request.

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

            $moduleName = $request->getByType('module', 'Alnum');

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

            if ($selectedIds && 'all' !== $selectedIds[0]) {

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

                $operator = $request->getByType('operator');

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

                $searchKey = $request->getByType('search_key', 'Alnum');

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

         * @return 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

            if ($selectedIds && 'all' !== $selectedIds[0]) {

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

            return $queryGenerator ? $queryGenerator->clearFields()->createQuery()->column() : [];

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

            if (!empty($cvId) && 'undefined' === $cvId && 'Users' !== $request->getByType('source_module', 2)) {

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

            $selectedIds = $request->getArray('selected_ids', 2);

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

         *

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

    abstract class Vtiger_Mass_Action extends \App\Controller\Action

    There are no issues that match your filters.

    Category
    Status