YetiForceCompany/YetiForceCRM

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

Summary

Maintainability
C
7 hrs
Test Coverage
F
0%

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

    public function getStructure()
    {
        if (!empty($this->structuredValues)) {
            return $this->structuredValues;
        }
Severity: Minor
Found in modules/Vtiger/models/DetailRecordStructure.php - About 3 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 29 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/DetailRecordStructure.php - About 1 hr to fix

    The method getStructure() has a Cyclomatic Complexity of 12. 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 25 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 '\App\FieldsDependency' in method 'getStructure'.
    Open

                $fieldsDependency = \App\FieldsDependency::getByRecordModel('Detail', $recordModel);

    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

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

                        if ($fieldModel->isViewableInDetailView() && (empty($fieldsDependency['hide']['backend']) || !\in_array($fieldName, $fieldsDependency['hide']['backend']))) {
                            if ($recordExists) {
                                $fieldModel->set('fieldvalue', $recordModel->get($fieldName));
                            }
                            if (!empty($fieldsDependency['hide']['frontend']) && \in_array($fieldName, $fieldsDependency['hide']['frontend'])) {
    Severity: Major
    Found in modules/Vtiger/models/DetailRecordStructure.php and 1 other location - About 2 hrs to fix
    modules/Users/models/DetailRecordStructure.php on lines 40..48

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

    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

    class Vtiger_DetailRecordStructure_Model extends Vtiger_RecordStructure_Model

    The class Vtiger_DetailRecordStructure_Model is not named in CamelCase.
    Open

    class Vtiger_DetailRecordStructure_Model extends Vtiger_RecordStructure_Model
    {
        /**
         * Function to get the fields in the header.
         *

    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

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

    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 = $blockModel->getFields();

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

                if ($fieldModelList) {

    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

                $fieldsDependency = \App\FieldsDependency::getByRecordModel('Detail', $recordModel);

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

                                $fieldModel->set('fieldvalue', $recordModel->get($fieldName));

    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 function getFieldInHeader()

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

         */

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

            $recordExists = !empty($recordModel);

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

            $blockModelList = $moduleModel->getBlocks();

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

         * @throws \App\Exceptions\AppException

    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

            $fieldsInHeader = [];

    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

            $moduleModel = $this->getModule();

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

                        if ($fieldModel->isViewableInDetailView() && (empty($fieldsDependency['hide']['backend']) || !\in_array($fieldName, $fieldsDependency['hide']['backend']))) {

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

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

                            if ($recordExists) {

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

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

    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 array values in structure array('block'=>array(fieldinfo));

    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

            return $this->structuredValues = $values;

    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 function getStructure()

    Line exceeds 120 characters; contains 177 characters
    Open

                        if ($fieldModel->isViewableInDetailView() && (empty($fieldsDependency['hide']['backend']) || !\in_array($fieldName, $fieldsDependency['hide']['backend']))) {

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

                    $fieldModel->set('fieldvalue', $recordModel->get($fieldName));

    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

            $values = [];

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

            if ($recordExists) {

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

        /**

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

            $recordModel = $this->getRecord();

    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

         *

    Line exceeds 120 characters; contains 140 characters
    Open

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

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

                            $values[$blockLabel][$fieldName] = $fieldModel;

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

            $recordModel = $this->getRecord();

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

        {

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

            $moduleModel = $this->getModule();

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

                    $fieldsInHeader[$fieldModel->getHeaderValue('type')][$fieldModel->getName()] = $fieldModel;

    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

            foreach ($moduleModel->getFields() as $fieldName => $fieldModel) {

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

                if ($fieldModel->isHeaderField() && $fieldModel->isViewableInDetailView() && $recordModel) {

    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 fields in the header.

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

            }

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

            foreach ($blockModelList as $blockLabel => &$blockModel) {

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

                    $values[$blockLabel] = [];

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

    class Vtiger_DetailRecordStructure_Model extends Vtiger_RecordStructure_Model

    There are no issues that match your filters.

    Category
    Status