YetiForceCompany/YetiForceCRM

View on GitHub
modules/Vtiger/models/QuickCreateRecordStructure.php

Summary

Maintainability
B
4 hrs
Test Coverage
D
60%

Function getStructure has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

    public function getStructure()
    {
        if (!empty($this->structuredValues)) {
            return $this->structuredValues;
        }
Severity: Minor
Found in modules/Vtiger/models/QuickCreateRecordStructure.php - About 2 hrs 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

Method getStructure has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getStructure()
    {
        if (!empty($this->structuredValues)) {
            return $this->structuredValues;
        }
Severity: Minor
Found in modules/Vtiger/models/QuickCreateRecordStructure.php - About 1 hr to fix

    The method getStructure() has an NPath complexity of 542. The configured NPath complexity threshold is 200.
    Open

        public function getStructure()
        {
            if (!empty($this->structuredValues)) {
                return $this->structuredValues;
            }

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

        public function getStructure()
        {
            if (!empty($this->structuredValues)) {
                return $this->structuredValues;
            }

    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

    Refactor this function to reduce its Cognitive Complexity from 21 to the 15 allowed.
    Open

        public function getStructure()

    Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

    See

    Avoid using static access to class 'Users_Record_Model' in method 'getStructure'.
    Open

                    $currentUserModel = Users_Record_Model::getCurrentUserModel();

    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 'Users_Record_Model' in method 'getStructure'.
    Open

                    $currentUserModel = Users_Record_Model::getCurrentUserModel();

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

                } else {
                    $defaultValue = $fieldModel->getDefaultFieldValue();
                    if ($defaultValue) {
                        $fieldModel->set('fieldvalue', $defaultValue);
                    }

    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\FieldsDependency' in method 'getStructure'.
    Open

            $fieldsDependency = \App\FieldsDependency::getByRecordModel('QuickCreate', $this->record);

    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 "fieldvalue" 4 times.
    Open

                    $fieldModel->set('fieldvalue', $recordModelFieldValue);

    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.

    Argument 2 (recordModel) is false but \App\FieldsDependency::getByRecordModel() takes \Vtiger_Record_Model defined at /code/app/FieldsDependency.php:99
    Open

            $fieldsDependency = \App\FieldsDependency::getByRecordModel('QuickCreate', $this->record);

    Call to method get on non-class type false
    Open

                $recordModelFieldValue = $this->record->get($fieldName);

    Avoid excessively long variable names like $recordModelFieldValue. Keep variable name length under 20.
    Open

                $recordModelFieldValue = $this->record->get($fieldName);

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

    Source https://phpmd.org/rules/naming.html#longvariable

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

    class Vtiger_QuickCreateRecordStructure_Model extends Vtiger_RecordStructure_Model

    The class Vtiger_QuickCreateRecordStructure_Model is not named in CamelCase.
    Open

    class Vtiger_QuickCreateRecordStructure_Model extends Vtiger_RecordStructure_Model
    {
        /**
         * Function to get the values in structured format.
         *

    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_Model::$tabIndexDefaultSeq = 1000;

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

                    $fieldModel->set('hideField', true);

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

            foreach ($fieldModelList as $fieldName => $fieldModel) {

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

                if ($fieldsDependency['hide']['backend'] && \in_array($fieldName, $fieldsDependency['hide']['backend'])) {

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

                } elseif ('activitystatus' === $fieldName) {

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

                    $fieldValue = $defaulteventstatus;

    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 (!empty($this->structuredValues)) {

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

                }

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

                $recordModelFieldValue = $this->record->get($fieldName);

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

                        $fieldModel->set('fieldvalue', $defaultValue);

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

         *

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

                    $fieldModel->set('fieldvalue', $fieldValue);

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

                $this->structuredValues[$fieldName] = $fieldModel;

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

                if (!empty($recordModelFieldValue)) {

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

                    continue;

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

            ++Vtiger_Field_Model::$tabIndexLastSeq;

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

            return $this->structuredValues;

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

        /**

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

                    $currentUserModel = Users_Record_Model::getCurrentUserModel();

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

                }

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

                    $fieldModel->set('fieldvalue', $recordModelFieldValue);

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

                    $defaultValue = $fieldModel->getDefaultFieldValue();

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

                    }

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

         * Function to get the values in structured format.

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

                return $this->structuredValues;

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

            }

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

            $fieldModelList = $this->getModule()->getQuickCreateFields();

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

                    $fieldModel->set('fieldvalue', $fieldValue);

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

                    if ($defaultValue) {

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

                    Vtiger_Field_Model::$tabIndexLastSeq = $fieldModel->get('tabindex');

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

                    $fieldModel->set('isMandatory', 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

                if ($fieldModel->get('tabindex') > Vtiger_Field_Model::$tabIndexLastSeq) {

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

                if ($fieldsDependency['mandatory'] && \in_array($fieldName, $fieldsDependency['mandatory'])) {

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

                    $defaulteventstatus = $currentUserModel->get('defaulteventstatus');

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

                    $defaultactivitytype = $currentUserModel->get('defaultactivitytype');

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

         * @return Vtiger_Field_Model[] Field instances.

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

        public function getStructure()

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

        {

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

                    $fieldValue = $defaultactivitytype;

    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

                } elseif ('activitytype' === $fieldName) {

    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

                if ($fieldsDependency['hide']['frontend'] && \in_array($fieldName, $fieldsDependency['hide']['frontend'])) {

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

            $fieldsDependency = \App\FieldsDependency::getByRecordModel('QuickCreate', $this->record);

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

                    $currentUserModel = Users_Record_Model::getCurrentUserModel();

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

    class Vtiger_QuickCreateRecordStructure_Model extends Vtiger_RecordStructure_Model

    There are no issues that match your filters.

    Category
    Status