Function saveInventoryField has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring. Open
public function saveInventoryField(App\Request $request)
{
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));
if ($isNew = $request->isEmpty('id')) {
$fieldModel = $inventory->getFieldCleanInstance($request->getByType('type'));- Read upRead up
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 saveInventoryField has 48 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function saveInventoryField(App\Request $request)
{
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));
if ($isNew = $request->isEmpty('id')) {
$fieldModel = $inventory->getFieldCleanInstance($request->getByType('type'));The method saveInventoryField() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10. Open
public function saveInventoryField(App\Request $request)
{
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));
if ($isNew = $request->isEmpty('id')) {
$fieldModel = $inventory->getFieldCleanInstance($request->getByType('type'));- Read upRead up
- Exclude checks
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 16 to the 15 allowed. Open
public function saveInventoryField(App\Request $request)- Read upRead up
- Exclude checks
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 undefined variables such as '$result' which will lead to PHP notices. Open
$result['message'] = \App\Language::translate('LBL_CHANGED_MODULE_TYPE_INFO', $request->getModule(false));- Read upRead up
- Exclude checks
UndefinedVariable
Since: 2.8.0
Detects when a variable is used that has not been defined before.
Example
class Foo
{
private function bar()
{
// $message is undefined
echo $message;
}
}Source https://phpmd.org/rules/cleancode.html#undefinedvariable
Avoid using undefined variables such as '$result' which will lead to PHP notices. Open
if ($result['success'] = (new \App\BatchMethod(['method' => '\App\Module::changeType', 'params' => [$moduleName, $type]]))->save()) {- Read upRead up
- Exclude checks
UndefinedVariable
Since: 2.8.0
Detects when a variable is used that has not been defined before.
Example
class Foo
{
private function bar()
{
// $message is undefined
echo $message;
}
}Source https://phpmd.org/rules/cleancode.html#undefinedvariable
Avoid using undefined variables such as '$result' which will lead to PHP notices. Open
$response->setResult($result);- Read upRead up
- Exclude checks
UndefinedVariable
Since: 2.8.0
Detects when a variable is used that has not been defined before.
Example
class Foo
{
private function bar()
{
// $message is undefined
echo $message;
}
}Source https://phpmd.org/rules/cleancode.html#undefinedvariable
Missing class import via use statement (line '83', column '18'). Open
throw new \App\Exceptions\IllegalValue("ERR_NOT_ALLOWED_VALUE||{$name}||" . $displayType, 406);- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '144', column '14'). Open
throw new \App\Exceptions\IllegalValue('ERR_NOT_ALLOWED_VALUE', 406);- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '101', column '19'). Open
$response = new Vtiger_Response();- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '110', column '19'). Open
$response = new Vtiger_Response();- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '137', column '14'). Open
throw new \App\Exceptions\NoPermittedForAdmin('LBL_PERMISSION_DENIED');- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '119', column '19'). Open
$response = new Vtiger_Response();- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '41', column '33'). Open
if ($result['success'] = (new \App\BatchMethod(['method' => '\App\Module::changeType', 'params' => [$moduleName, $type]]))->save()) {- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '150', column '19'). Open
$response = new Vtiger_Response();- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '44', column '19'). Open
$response = new Vtiger_Response();- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '140', column '14'). Open
throw new \App\Exceptions\Security('ERR_LANGUAGE_DOES_NOT_EXIST');- Read upRead up
- Exclude checks
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
Missing class import via use statement (line '76', column '18'). Open
throw new \App\Exceptions\IllegalValue("ERR_NOT_ALLOWED_VALUE||{$name}||" . $blockId, 406);- Read upRead up
- Exclude checks
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\Language' in method 'contextHelp'. Open
}- Read upRead up
- Exclude checks
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_Inventory_Model' in method 'saveInventoryField'. Open
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));- Read upRead up
- Exclude checks
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 'contextHelp'. Open
\App\Language::translationModify($request->getByType('lang'), 'Other__HelpInfo', 'php', $label, str_replace("\n", '', $request->getForHtml('context')));- Read upRead up
- Exclude checks
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 'Settings_Vtiger_Tracker_Model' in method '__construct'. Open
Settings_Vtiger_Tracker_Model::addBasic('save');- Read upRead up
- Exclude checks
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 assigning values to variables in if clauses and the like (line '57', column '7'). Open
public function saveInventoryField(App\Request $request)
{
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));
if ($isNew = $request->isEmpty('id')) {
$fieldModel = $inventory->getFieldCleanInstance($request->getByType('type'));- Read upRead up
- Exclude checks
IfStatementAssignment
Since: 2.7.0
Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.
Example
class Foo
{
public function bar($flag)
{
if ($foo = 'bar') { // possible typo
// ...
}
if ($baz = 0) { // always false
// ...
}
}
}Source http://phpmd.org/rules/cleancode.html#ifstatementassignment
Avoid using static access to class '\Vtiger_Field_Model' in method 'contextHelp'. Open
$fieldModel = \Vtiger_Field_Model::getInstanceFromFieldId($request->getInteger('field'));- Read upRead up
- Exclude checks
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\Privilege' in method 'contextHelp'. Open
if (!\App\Privilege::isPermitted($fieldModel->getModuleName())) {- Read upRead up
- Exclude checks
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 assigning values to variables in if clauses and the like (line '41', column '7'). Open
public function changeModuleType(App\Request $request)
{
$type = $request->getInteger('type');
$moduleName = $request->getByType('sourceModule', 'Alnum');
if ($result['success'] = (new \App\BatchMethod(['method' => '\App\Module::changeType', 'params' => [$moduleName, $type]]))->save()) {- Read upRead up
- Exclude checks
IfStatementAssignment
Since: 2.7.0
Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.
Example
class Foo
{
public function bar($flag)
{
if ($foo = 'bar') { // possible typo
// ...
}
if ($baz = 0) { // always false
// ...
}
}
}Source http://phpmd.org/rules/cleancode.html#ifstatementassignment
The method saveInventoryField uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$fieldModel = $inventory->getFieldById($request->getInteger('id'));
}- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}Source https://phpmd.org/rules/cleancode.html#elseexpression
Avoid using static access to class '\App\Language' in method 'saveInventoryField'. Open
$data['translate'] = \App\Language::translate($data['label'], $fieldModel->getModuleName());- Read upRead up
- Exclude checks
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_Inventory_Model' in method 'saveSequence'. Open
$inventoryField = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));- Read upRead up
- Exclude checks
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 'changeModuleType'. Open
$result['message'] = \App\Language::translate('LBL_CHANGED_MODULE_TYPE_INFO', $request->getModule(false));- Read upRead up
- Exclude checks
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_Inventory_Model' in method 'delete'. Open
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));- Read upRead up
- Exclude checks
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 "success" 3 times. Open
if ($result['success'] = (new \App\BatchMethod(['method' => '\App\Module::changeType', 'params' => [$moduleName, $type]]))->save()) {- 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 "Standard" 4 times. Open
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));- 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 "params" 3 times. Open
if ($result['success'] = (new \App\BatchMethod(['method' => '\App\Module::changeType', 'params' => [$moduleName, $type]]))->save()) {- 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 "label" 3 times. Open
$fields = ['label', 'defaultValue', 'block', 'displayType', 'params', 'colSpan'];- 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 "sourceModule" 4 times. Open
$moduleName = $request->getByType('sourceModule', 'Alnum');- 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.
Variable $result was undeclared, but array fields are being added to it. Open
if ($result['success'] = (new \App\BatchMethod(['method' => '\App\Module::changeType', 'params' => [$moduleName, $type]]))->save()) {- Exclude checks
Call to deprecated function \Vtiger_Field_Model::getFieldLabel() defined at /code/modules/Vtiger/models/Field.php:215 Open
$label = $fieldModel->getModuleName() . '|' . $fieldModel->getFieldLabel();- Exclude checks
This case's code block is the same as the block for the case on line 67. Open
case 'defaultValue':
$fieldModel->set($name, $request->getByType($name, 'Text'));
break;- Read upRead up
- Exclude checks
Having two cases in a switch statement or two branches in an if chain with the same implementation is at
best duplicate code, and at worst a coding error. If the same logic is truly needed for both instances, then in an if chain they should
be combined, or for a switch, one should fall through to the other.
Noncompliant Code Example
switch ($i) {
case 1:
doSomething();
break;
case 2:
doSomethingDifferent();
break;
case 3: // Noncompliant; duplicates case 1's implementation
doSomething();
break;
default:
doTheRest();
}
if ($a >= 0 && $a < 10) {
doTheThing();
else if ($a >= 10 && $a < 20) {
doTheOtherThing();
}
else if ($a >= 20 && $a < 50) {
doTheThing(); // Noncompliant; duplicates first condition
}
else {
doTheRest();
}
if ($b == 0) {
doOneMoreThing();
}
else {
doOneMoreThing(); // Noncompliant; duplicates then-branch
}
var b = a ? 12 > 4 : 4; // Noncompliant; always results in the same value
Compliant Solution
switch ($i) {
case 1:
case 3:
doSomething();
break;
case 2:
doSomethingDifferent();
break;
default:
doTheRest();
}
if (($a >= 0 && $a < 10) || ($a >= 20 && $a < 50)) {
doTheThing();
else if ($a >= 10 && $a < 20) {
doTheOtherThing();
}
else {
doTheRest();
}
doOneMoreThing();
b = 4;
or
switch ($i) {
case 1:
doSomething();
break;
case 2:
doSomethingDifferent();
break;
case 3:
doThirdThing();
break;
default:
doTheRest();
}
if ($a >= 0 && $a < 10) {
doTheThing();
else if ($a >= 10 && $a < 20) {
doTheOtherThing();
}
else if ($a >= 20 && $a < 50) {
doTheThirdThing();
}
else {
doTheRest();
}
if ($b == 0) {
doOneMoreThing();
}
else {
doTheRest();
}
int b = a ? 12 > 4 : 8;
Exceptions
Blocks in an if chain that contain a single line of code are ignored, as are blocks in a switch statement that contain a
single line of code with or without a following break.
This case's code block is the same as the block for the case on line 67. Open
case 'params':
$fieldModel->set($name, $request->getByType($name, 'Text'));
break;- Read upRead up
- Exclude checks
Having two cases in a switch statement or two branches in an if chain with the same implementation is at
best duplicate code, and at worst a coding error. If the same logic is truly needed for both instances, then in an if chain they should
be combined, or for a switch, one should fall through to the other.
Noncompliant Code Example
switch ($i) {
case 1:
doSomething();
break;
case 2:
doSomethingDifferent();
break;
case 3: // Noncompliant; duplicates case 1's implementation
doSomething();
break;
default:
doTheRest();
}
if ($a >= 0 && $a < 10) {
doTheThing();
else if ($a >= 10 && $a < 20) {
doTheOtherThing();
}
else if ($a >= 20 && $a < 50) {
doTheThing(); // Noncompliant; duplicates first condition
}
else {
doTheRest();
}
if ($b == 0) {
doOneMoreThing();
}
else {
doOneMoreThing(); // Noncompliant; duplicates then-branch
}
var b = a ? 12 > 4 : 4; // Noncompliant; always results in the same value
Compliant Solution
switch ($i) {
case 1:
case 3:
doSomething();
break;
case 2:
doSomethingDifferent();
break;
default:
doTheRest();
}
if (($a >= 0 && $a < 10) || ($a >= 20 && $a < 50)) {
doTheThing();
else if ($a >= 10 && $a < 20) {
doTheOtherThing();
}
else {
doTheRest();
}
doOneMoreThing();
b = 4;
or
switch ($i) {
case 1:
doSomething();
break;
case 2:
doSomethingDifferent();
break;
case 3:
doThirdThing();
break;
default:
doTheRest();
}
if ($a >= 0 && $a < 10) {
doTheThing();
else if ($a >= 10 && $a < 20) {
doTheOtherThing();
}
else if ($a >= 20 && $a < 50) {
doTheThirdThing();
}
else {
doTheRest();
}
if ($b == 0) {
doOneMoreThing();
}
else {
doTheRest();
}
int b = a ? 12 > 4 : 8;
Exceptions
Blocks in an if chain that contain a single line of code are ignored, as are blocks in a switch statement that contain a
single line of code with or without a following break.
Each class must be in a namespace of at least one level (a top-level vendor name) Open
class Settings_LayoutEditor_SaveAjax_Action extends Settings_Vtiger_Basic_Action- Exclude checks
The class Settings_LayoutEditor_SaveAjax_Action is not named in CamelCase. Open
class Settings_LayoutEditor_SaveAjax_Action extends Settings_Vtiger_Basic_Action
{
/**
* Constructor.
*/- Read upRead up
- Exclude checks
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
* Constructor.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
parent::__construct();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function __construct()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->exposeMethod('delete');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Settings_Vtiger_Tracker_Model::addBasic('save');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Function is used to create and edit fields in advanced block.- Exclude checks
Line exceeds 120 characters; contains 123 characters Open
throw new \App\Exceptions\IllegalValue("ERR_NOT_ALLOWED_VALUE||{$name}||" . $displayType, 406);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'colSpan':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$status = $inventoryField->saveSequence($request->getArray('ids', 'Integer'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->exposeMethod('saveInventoryField');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($result['success'] = (new \App\BatchMethod(['method' => '\App\Module::changeType', 'params' => [$moduleName, $type]]))->save()) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
switch ($name) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->set($name, $request->getInteger($name));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$data = $fieldModel->getData();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$inventoryField = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->set('helpinfo', implode(',', $views));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->setResult(['success' => true]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->exposeMethod('changeModuleType');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @param App\Request $request- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$inventory->saveField($fieldModel);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->exposeMethod('saveSequence');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->exposeMethod('contextHelp');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->setResult($result);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!\in_array($blockId, $fieldModel->getBlocks())) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'params':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function saveSequence(App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$moduleName = $request->getByType('sourceModule', 'Alnum');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$result['message'] = \App\Language::translate('LBL_CHANGED_MODULE_TYPE_INFO', $request->getModule(false));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Set context help.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @throws \App\Exceptions\Security- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response = new Vtiger_Response();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fields = ['label', 'defaultValue', 'block', 'displayType', 'params', 'colSpan'];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($request->has($name)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response = new Vtiger_Response();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->setResult(['data' => $data, 'edit' => !$isNew]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($isNew = $request->isEmpty('id')) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel = $inventory->getFieldCleanInstance($request->getByType('type'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->set($name, $blockId);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @param \App\Request $request- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @throws \App\Exceptions\IllegalValue- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$views = $request->getArray('views', 'Standard');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$type = $request->getInteger('type');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$inventory = Vtiger_Inventory_Model::getInstance($request->getByType('sourceModule', 'Standard'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Line exceeds 120 characters; contains 141 characters Open
if ($result['success'] = (new \App\BatchMethod(['method' => '\App\Module::changeType', 'params' => [$moduleName, $type]]))->save()) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function saveInventoryField(App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($fields as $name) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Change module type.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel = $inventory->getFieldById($request->getInteger('id'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'block':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'displayType':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\IllegalValue("ERR_NOT_ALLOWED_VALUE||{$name}||" . $displayType, 406);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$status = $inventory->deleteField($request->getByType('fieldName', 'Alnum'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @throws \App\Exceptions\NoPermittedForAdmin- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function contextHelp(App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\IllegalValue('ERR_NOT_ALLOWED_VALUE', 406);- Exclude checks
Line exceeds 120 characters; contains 160 characters Open
\App\Language::translationModify($request->getByType('lang'), 'Other__HelpInfo', 'php', $label, str_replace("\n", '', $request->getForHtml('context')));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function changeModuleType(App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @param \App\Request $request- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
default:- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response = new Vtiger_Response();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'defaultValue':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'label':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->set($name, $request->getByType($name, 'Text'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$blockId = $request->getInteger($name);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!\in_array($displayType, $fieldModel->displayTypeBase())) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->emit();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->set($name, $request->getByType($name, 'Text'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$data['translate'] = \App\Language::translate($data['label'], $fieldModel->getModuleName());- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$displayType = $request->getInteger($name);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->setResult($status);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->emit();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->emit();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response = new Vtiger_Response();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->emit();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!\App\Privilege::isPermitted($fieldModel->getModuleName())) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!isset(App\Language::getAll()[$request->getByType('lang')])) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel = \Vtiger_Field_Model::getInstanceFromFieldId($request->getInteger('field'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\Security('ERR_LANGUAGE_DOES_NOT_EXIST');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($views && array_diff($views, \App\Field::HELP_INFO_VIEWS)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
\App\Language::translationModify($request->getByType('lang'), 'Other__HelpInfo', 'php', $label, str_replace("\n", '', $request->getForHtml('context')));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->emit();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
} else {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->set($name, $request->getByType($name, 'Text'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->setResult(['success' => (bool) $status]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function delete(App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->setDefaultDataConfig();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\IllegalValue("ERR_NOT_ALLOWED_VALUE||{$name}||" . $blockId, 406);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->set($name, $displayType);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response = new Vtiger_Response();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\NoPermittedForAdmin('LBL_PERMISSION_DENIED');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldModel->save();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$label = $fieldModel->getModuleName() . '|' . $fieldModel->getFieldLabel();- Exclude checks
Class name "Settings_LayoutEditor_SaveAjax_Action" is not in camel caps format Open
class Settings_LayoutEditor_SaveAjax_Action extends Settings_Vtiger_Basic_Action- Exclude checks