YetiForceCompany/YetiForceCRM

View on GitHub
modules/KnowledgeBase/KnowledgeBase.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Define a constant instead of duplicating this literal "knowledgebaseid" 4 times.
Open

    public $table_index = 'knowledgebaseid';

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

        'subject' => ['knowledgebase', '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.

Define a constant instead of duplicating this literal "subject" 8 times.
Open

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

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

    public $table_name = 'u_yf_knowledgebase';

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

    public $customFieldTable = ['u_yf_knowledgebasecf', 'knowledgebaseid'];

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.

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

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

class KnowledgeBase 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 $table_name is not named in camelCase.
Open

class KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 $list_fields_name is not named in camelCase.
Open

class KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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 KnowledgeBase extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_knowledgebase';
    public $table_index = 'knowledgebaseid';

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

    // For Popup listview and UI type support

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

        'FL_CATEGORY' => ['knowledgebase', 'category'],

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

     */

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

        'subject' => ['knowledgebase', 'subject'],

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

    public $tab_name = ['vtiger_crmentity', 'u_yf_knowledgebase', 'u_yf_knowledgebasecf'];

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

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

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

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

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

    public $list_fields_name = [

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

        'FL_INTRODUCTION' => 'introduction',

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

        // tablename should not have prefix 'vtiger_'

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 $def_detailview_recname = '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

    /**

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

        'u_yf_knowledgebase' => 'knowledgebaseid',

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

    ];

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

        'u_yf_knowledgebasecf' => 'knowledgebaseid',

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

    /**

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 $table_name = 'u_yf_knowledgebase';

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

        'FL_STATUS' => 'knowledgebase_status',

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

     * Mandatory table for supporting custom fields.

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

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

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

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

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

    public $table_index = 'knowledgebaseid';

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

    public $customFieldTable = ['u_yf_knowledgebasecf', 'knowledgebaseid'];

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

        'FL_INTRODUCTION' => ['knowledgebase', 'introduction'],

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

        'FL_CATEGORY' => 'category',

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

        // Format: Field Label => Array(tablename, columnname)

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

        'FL_STATUS' => ['knowledgebase', 'knowledgebase_status'],

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

    /**

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

        'subject' => 'subject',

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

    public $search_fields = [

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

        'Assigned To' => ['crmentity', 'smownerid'],

There are no issues that match your filters.

Category
Status