YetiForceCompany/YetiForceCRM

View on GitHub
modules/SQuoteEnquiries/SQuoteEnquiries.php

Summary

Maintainability
A
35 mins
Test Coverage
F
30%

Function moduleHandler has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    public function moduleHandler($moduleName, $eventType)
    {
        if ('module.postinstall' === $eventType) {
            \App\Db::getInstance()->createCommand()->update('vtiger_tab', ['customized' => 0], ['name' => $moduleName])->execute();
            $modcommentsModuleInstance = vtlib\Module::getInstance('ModComments');
Severity: Minor
Found in modules/SQuoteEnquiries/SQuoteEnquiries.php - About 35 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

Avoid using static access to class '\App\Module' in method 'moduleHandler'.
Open

            CRMEntity::getInstance('ModTracker')->enableTrackingForModule(\App\Module::getModuleId($moduleName));

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

            $modcommentsModuleInstance = vtlib\Module::getInstance('ModComments');

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 'ModComments' in method 'moduleHandler'.
Open

                    ModComments::addWidgetTo(['SQuoteEnquiries']);

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

    public $table_index = 'squoteenquiriesid';

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

    public $customFieldTable = ['u_yf_squoteenquiriescf', 'squoteenquiriesid'];

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

    public $table_name = 'u_yf_squoteenquiries';

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

        'LBL_SUBJECT' => 'subject',

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 undeclared method \App\Db::createCommand
Open

            \App\Db::getInstance()->createCommand()->update('vtiger_tab', ['customized' => 0], ['name' => $moduleName])->execute();

Saw possibly unextractable annotation for a fragment of comment '* @param string Event Type': after string, did not see an element name (will guess based on comment order)
Open

     * @param string Event Type

Call to undeclared method \CRMEntity::enableTrackingForModule
Open

            CRMEntity::getInstance('ModTracker')->enableTrackingForModule(\App\Module::getModuleId($moduleName));

Argument 1 (moduleNames) is array{0:'SQuoteEnquiries'} but \ModComments::addWidgetTo() takes string defined at /code/modules/ModComments/ModComments.php:72
Open

                    ModComments::addWidgetTo(['SQuoteEnquiries']);

Saw possibly unextractable annotation for a fragment of comment '* @param string Module name': after string, did not see an element name (will guess based on comment order)
Open

     * @param string Module name

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

    public $def_detailview_recname = 'subject';

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

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

            $modcommentsModuleInstance = vtlib\Module::getInstance('ModComments');

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 SQuoteEnquiries extends Vtiger_CRMEntity

A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 9 and the first side effect is on line 7.
Open

<?php

The property $list_fields_name is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $def_basicsearch_col is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $def_detailview_recname is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $search_fields_name is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $default_sort_order is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $default_order_by is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $table_index is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $tab_name is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $popup_fields is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $tab_name_index is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $search_fields is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $mandatory_fields is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

The property $table_name is not named in camelCase.
Open

class SQuoteEnquiries extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_squoteenquiries';
    public $table_index = 'squoteenquiriesid';

CamelCasePropertyName

Since: 0.2

It is considered best practice to use the camelCase notation to name attributes.

Example

class ClassName {
    protected $property_name;
}

Source

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

     * Mandatory table for supporting custom fields.

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

    // For Popup window record selection

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

    public $popup_fields = ['subject'];

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

                include_once 'modules/ModComments/ModComments.php';

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

    public $customFieldTable = ['u_yf_squoteenquiriescf', 'squoteenquiriesid'];

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

        'u_yf_squoteenquiries' => 'squoteenquiriesid',

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

    // For Popup listview and UI type support

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

    public $def_detailview_recname = 'subject';

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

    public $mandatory_fields = ['subject', 'assigned_user_id'];

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

            $modcommentsModuleInstance = vtlib\Module::getInstance('ModComments');

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

                    ModComments::addWidgetTo(['SQuoteEnquiries']);

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_crmentity' => 'crmid',

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

        'vtiger_entity_stats' => 'crmid', ];

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

    public $relationFields = [];

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

    public $search_fields = [];

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 ('module.postinstall' === $eventType) {

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

    public $tab_name_index = [

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

        // Format: Field Label => fieldname

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

     * @param string Module name

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

     * @param string Event Type

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

     * @param mixed $eventType

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

    /**

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

        'Assigned To' => 'assigned_user_id',

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

    public $default_order_by = '';

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

     *

Line exceeds 120 characters; contains 131 characters
Open

            \App\Db::getInstance()->createCommand()->update('vtiger_tab', ['customized' => 0], ['name' => $moduleName])->execute();

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

            if ($modcommentsModuleInstance && file_exists('modules/ModComments/ModComments.php')) {

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

                }

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

     * Mandatory for Saving, Include tablename and tablekey columnname here.

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

    /**

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

     * @var string[] List of fields in the RelationListView

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

    public $table_name = 'u_yf_squoteenquiries';

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

     * Mandatory for Saving, Include tables related to this module.

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

    // Used when enabling/disabling the mandatory fields for the module.

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

    public $table_index = 'squoteenquiriesid';

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

     */

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

        'LBL_SUBJECT' => 'subject',

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\Db::getInstance()->createCommand()->update('vtiger_tab', ['customized' => 0], ['name' => $moduleName])->execute();

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

    public $tab_name = ['vtiger_crmentity', 'u_yf_squoteenquiries', 'u_yf_squoteenquiriescf', 'vtiger_entity_stats'];

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

        'u_yf_squoteenquiriescf' => 'squoteenquiriesid',

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

    /**

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

    // Refers to vtiger_field.fieldname values.

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

     * Invoked when special actions are performed on the module.

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

                if (class_exists('ModComments')) {

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

        }

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

    // Column value to use on detail view record text display

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

    public $list_fields_name = [

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

    public $def_basicsearch_col = 'subject';

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 moduleHandler($moduleName, $eventType)

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

    // For Alphabetical search

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

    public $default_sort_order = 'ASC';

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 $search_fields_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

            CRMEntity::getInstance('ModTracker')->enableTrackingForModule(\App\Module::getModuleId($moduleName));

There are no issues that match your filters.

Category
Status