modules/Contacts/ConfigTemplate.php
Define a constant instead of duplicating this literal "description" 3 times. Open
Open
'description' => 'Columns visible in Contacts hierarchy [$label => $columnName]'
- Read upRead up
- Exclude checks
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 "default" 3 times. Open
Open
'default' => [],
- Read upRead up
- Exclude checks
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.
Spaces must be used to indent lines; tabs are not allowed Open
Open
'description' => 'Count Contacts in hierarchy',
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'COLUMNS_IN_HIERARCHY' => [
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'default' => [],
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'description' => 'Columns visible in Contacts hierarchy [$label => $columnName]'
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'default' => true,
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'validation' => '\App\Validator::bool',
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
]
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
],
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'description' => 'Max depth of hierarchy',
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'COUNT_IN_HIERARCHY' => [
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'validation' => '\App\Validator::naturalNumber'
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'sanitization' => '\App\Purifier::bool'
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'MAX_HIERARCHY_DEPTH' => [
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'default' => 50,
- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
],
- Exclude checks