YetiForceCompany/YetiForceCRM

View on GitHub
modules/Vtiger/dashboards/UpcomingEventsModel.php

Summary

Maintainability
A
1 hr
Test Coverage
F
0%

Method getFieldInstanceByName has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getFieldInstanceByName($name)
    {
        if (!isset($this->customFields[$name])) {
            return parent::getFieldInstanceByName($name);
        }
Severity: Minor
Found in modules/Vtiger/dashboards/UpcomingEventsModel.php - About 1 hr to fix

    Function setDataFromRequest has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        public function setDataFromRequest(App\Request $request)
        {
            foreach ($this->customFields as $fieldName => $fieldInfo) {
                if ($request->has($fieldName)) {
                    $value = $request->getByType($fieldName, $fieldInfo['purifyType']);
    Severity: Minor
    Found in modules/Vtiger/dashboards/UpcomingEventsModel.php - About 25 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

    Missing class import via use statement (line '92', column '17').
    Open

            $query = (new \App\Db\Query())->select(['vtiger_field.fieldid', 'vtiger_field.fieldlabel', 'vtiger_field.tabid'])

    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\Json' in method 'setDataFromRequest'.
    Open

                            $this->set('data', \App\Json::encode($data));

    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\Language' in method 'getFieldsByTypeDate'.
    Open

                $fields[$row['fieldid']] = \App\Language::translate($sourceModuleName, $sourceModuleName) . ' - ' . \App\Language::translate($row['fieldlabel'], $sourceModuleName);

    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\Json' in method 'getFieldInstanceByName'.
    Open

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

    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\Language' in method 'getFieldsByTypeDate'.
    Open

                $fields[$row['fieldid']] = \App\Language::translate($sourceModuleName, $sourceModuleName) . ' - ' . \App\Language::translate($row['fieldlabel'], $sourceModuleName);

    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\Json' in method 'getFieldInstanceByName'.
    Open

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

    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_Field_Model' in method 'getFieldInstanceByName'.
    Open

            return \Vtiger_Field_Model::init($moduleName, $params, $name);

    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\Module' in method 'getFieldsByTypeDate'.
    Open

                $sourceModuleName = App\Module::getModuleName($row['tabid']);

    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\Json' in method 'setDataFromRequest'.
    Open

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

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

            'skip_year' => ['label' => 'LBL_SKIP_YEAR', 'purifyType' => \App\Purifier::BOOL, 'tooltip' => 'LBL_SKIP_YEAR_DESC'],

    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 "purifyType" 5 times.
    Open

            'skip_year' => ['label' => 'LBL_SKIP_YEAR', 'purifyType' => \App\Purifier::BOOL, 'tooltip' => 'LBL_SKIP_YEAR_DESC'],

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

            'date_fields' => ['label' => 'LBL_FIELD_DATE', 'purifyType' => \App\Purifier::TEXT]

    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 "label" 6 times.
    Open

            'skip_year' => ['label' => 'LBL_SKIP_YEAR', 'purifyType' => \App\Purifier::BOOL, 'tooltip' => 'LBL_SKIP_YEAR_DESC'],

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

            'skip_year' => ['label' => 'LBL_SKIP_YEAR', 'purifyType' => \App\Purifier::BOOL, 'tooltip' => 'LBL_SKIP_YEAR_DESC'],

    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.

    Reference to undeclared class \Vtiger_Widget_Model
    Open

                return parent::getFieldInstanceByName($name);

    Call to undeclared method \Vtiger_UpcomingEventsModel_Dashboard::get
    Open

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

    Class extends undeclared class \Vtiger_Widget_Model
    Open

    class Vtiger_UpcomingEventsModel_Dashboard extends Vtiger_Widget_Model

    Call to undeclared method \Vtiger_UpcomingEventsModel_Dashboard::get
    Open

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

    Reference to undeclared class \Vtiger_Widget_Model
    Open

            return $fields + parent::getEditFields() + ['limit' => ['label' => 'LBL_NUMBER_OF_RECORDS_DISPLAYED', 'purifyType' => \App\Purifier::INTEGER]];

    Reference to undeclared class \Vtiger_Widget_Model
    Open

            parent::setDataFromRequest($request);

    Call to undeclared method \Vtiger_UpcomingEventsModel_Dashboard::get
    Open

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

    Call to undeclared method \Vtiger_UpcomingEventsModel_Dashboard::set
    Open

                            $this->set('data', \App\Json::encode($data));

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

            $query = (new \App\Db\Query())->select(['vtiger_field.fieldid', 'vtiger_field.fieldlabel', 'vtiger_field.tabid'])

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

    class Vtiger_UpcomingEventsModel_Dashboard extends Vtiger_Widget_Model

    The class Vtiger_UpcomingEventsModel_Dashboard is not named in CamelCase.
    Open

    class Vtiger_UpcomingEventsModel_Dashboard extends Vtiger_Widget_Model
    {
        /** {@inheritdoc} */
        public $customFields = [
            'skip_year' => ['label' => 'LBL_SKIP_YEAR', 'purifyType' => \App\Purifier::BOOL, 'tooltip' => 'LBL_SKIP_YEAR_DESC'],

    CamelCaseClassName

    Since: 0.2

    It is considered best practice to use the CamelCase notation to name classes.

    Example

    class class_name {
    }

    Source

    Terminating statement must be on a line by itself
    Open

                default: break;

    The DEFAULT body must start on the line following the statement
    Open

                        default: break;

    The DEFAULT body must start on the line following the statement
    Open

                default: break;

    Terminating statement must be on a line by itself
    Open

                        default: break;

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

                return parent::getFieldInstanceByName($name);

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

            $params = [

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

                default: break;

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

        /** {@inheritdoc} */

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

                'label' => $this->getEditFields()[$name]['label'],

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

            ];

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

        /** {@inheritdoc} */

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

                    $fieldModel->validate($value, true);

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

                            $data[$fieldName] = $value;

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

        public $customFields = [

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

            'date_fields' => ['label' => 'LBL_FIELD_DATE', 'purifyType' => \App\Purifier::TEXT]

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

            $fields = ['title' => ['label' => 'LBL_WIDGET_NAME', 'purifyType' => \App\Purifier::TEXT, 'required' => true]];

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

            $moduleName = 'Settings:WidgetsManagement';

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

                    $params['uitype'] = 56;

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

            return \Vtiger_Field_Model::init($moduleName, $params, $name);

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

                        case 'skip_year':

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

        {

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

                    $params['fieldvalue'] = $data[$name] ?? 0;

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

                case 'date_fields':

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

                    $params['picklistValues'] = $this->getFieldsByTypeDate();

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

                    $fieldModel = $this->getFieldInstanceByName($fieldName)->getUITypeModel();

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

            'skip_year' => ['label' => 'LBL_SKIP_YEAR', 'purifyType' => \App\Purifier::BOOL, 'tooltip' => 'LBL_SKIP_YEAR_DESC'],

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

        public function getFieldInstanceByName($name)

    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 (!isset($this->customFields[$name])) {

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

                    break;

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

        {

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

                case 'skip_year':

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

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

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

                    $params['typeofdata'] = 'C~O';

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

                    $value = $request->getByType($fieldName, $fieldInfo['purifyType']);

    Line exceeds 120 characters; contains 124 characters
    Open

            'skip_year' => ['label' => 'LBL_SKIP_YEAR', 'purifyType' => \App\Purifier::BOOL, 'tooltip' => 'LBL_SKIP_YEAR_DESC'],

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

        public function getEditFields(): array

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

                'tooltip' => $this->getEditFields()[$name]['tooltip'] ?? ''

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

        /** {@inheritdoc} */

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

            }

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

                        default: break;

    Line exceeds 120 characters; contains 121 characters
    Open

            $query = (new \App\Db\Query())->select(['vtiger_field.fieldid', 'vtiger_field.fieldlabel', 'vtiger_field.tabid'])

    Line exceeds 120 characters; contains 139 characters
    Open

                ->andWhere(['<>', 'vtiger_tab.presence', 1])->orderBy(['vtiger_field.tabid' => SORT_ASC, 'vtiger_field.sequence' => SORT_ASC]);

    Line exceeds 120 characters; contains 151 characters
    Open

            return $fields + parent::getEditFields() + ['limit' => ['label' => 'LBL_NUMBER_OF_RECORDS_DISPLAYED', 'purifyType' => \App\Purifier::INTEGER]];

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

            }

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

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

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

                        case 'date_fields':

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

                            break;

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

                    }

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

                    $params['typeofdata'] = 'V~M';

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

                    $params['fieldvalue'] = $data[$name] ?? '';

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

        }

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

                $sourceModuleName = App\Module::getModuleName($row['tabid']);

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

            return $fields + parent::getEditFields() + ['limit' => ['label' => 'LBL_NUMBER_OF_RECORDS_DISPLAYED', 'purifyType' => \App\Purifier::INTEGER]];

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

                'name' => $name,

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

                    break;

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

        ];

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

                    $params['uitype'] = 16;

    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

                ->innerJoin('vtiger_tab', 'vtiger_tab.tabid = vtiger_field.tabid')

    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

            switch ($name) {

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

                    $data = $this->get('data') ? \App\Json::decode($this->get('data')) : [];

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

                if ($request->has($fieldName)) {

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

                    switch ($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 getFieldsByTypeDate(): array

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

            while ($row = $dataReader->read()) {

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

            $query = (new \App\Db\Query())->select(['vtiger_field.fieldid', 'vtiger_field.fieldlabel', 'vtiger_field.tabid'])

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

        /** {@inheritdoc} */

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

        public function setDataFromRequest(App\Request $request)

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

            foreach ($this->customFields as $fieldName => $fieldInfo) {

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

                    $value = $fieldModel->getDBValue($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

                ->where(['vtiger_field.presence' => [0, 2], 'vtiger_field.uitype' => [5, 6, 23]])

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

         *

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

                ->from('vtiger_field')

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

                ->andWhere(['<>', 'vtiger_tab.presence', 1])->orderBy(['vtiger_field.tabid' => SORT_ASC, 'vtiger_field.sequence' => SORT_ASC]);

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

            $dataReader = $query->createCommand()->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

                }

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

         * Get a date field.

    Line exceeds 120 characters; contains 176 characters
    Open

                $fields[$row['fieldid']] = \App\Language::translate($sourceModuleName, $sourceModuleName) . ' - ' . \App\Language::translate($row['fieldlabel'], $sourceModuleName);

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

                            $this->set('data', \App\Json::encode($data));

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

            return $fields;

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

            $fields = [];

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

                $fields[$row['fieldid']] = \App\Language::translate($sourceModuleName, $sourceModuleName) . ' - ' . \App\Language::translate($row['fieldlabel'], $sourceModuleName);

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

            parent::setDataFromRequest($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

            }

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

    class Vtiger_UpcomingEventsModel_Dashboard extends Vtiger_Widget_Model

    Closing brace must be on a line by itself
    Open

                default: break;

    Closing brace must be on a line by itself
    Open

                        default: break;

    There are no issues that match your filters.

    Category
    Status