Method getFieldInstanceByName has 72 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getFieldInstanceByName($name)
{
$moduleName = $this->getModule()->getName(true);
$fieldsLabel = $this->getEditFields();
$params = ['uitype' => 1, 'column' => $name, 'name' => $name, 'label' => $fieldsLabel[$name], 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];Function getFieldInstanceByName has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring. Open
public function getFieldInstanceByName($name)
{
$moduleName = $this->getModule()->getName(true);
$fieldsLabel = $this->getEditFields();
$params = ['uitype' => 1, 'column' => $name, 'name' => $name, 'label' => $fieldsLabel[$name], 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];- 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
Function setDataFromRequest has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring. Open
public function setDataFromRequest(App\Request $request)
{
foreach (array_keys($this->getEditFields()) as $field) {
if ($request->has($field)) {
switch ($field) {- 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 setDataFromRequest has 33 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function setDataFromRequest(App\Request $request)
{
foreach (array_keys($this->getEditFields()) as $field) {
if ($request->has($field)) {
switch ($field) {The method getFieldInstanceByName() has a Cyclomatic Complexity of 15. The configured cyclomatic complexity threshold is 10. Open
public function getFieldInstanceByName($name)
{
$moduleName = $this->getModule()->getName(true);
$fieldsLabel = $this->getEditFields();
$params = ['uitype' => 1, 'column' => $name, 'name' => $name, 'label' => $fieldsLabel[$name], 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];- 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
The method setDataFromRequest() has a Cyclomatic Complexity of 16. The configured cyclomatic complexity threshold is 10. Open
public function setDataFromRequest(App\Request $request)
{
foreach (array_keys($this->getEditFields()) as $field) {
if ($request->has($field)) {
switch ($field) {- 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
Missing class import via use statement (line '166', column '16'). Open
throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||{$field}", 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 '160', column '18'). Open
throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||{$field}", 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 'getFieldInstanceByName'. Open
'PLL_PASSWORD_2FA' => \App\Language::translate('PLL_PASSWORD_2FA', 'Users'),- 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 'getFieldInstanceByName'. Open
'-' => \App\Language::translate('LBL_NONE'),- 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 'getFieldInstanceByName'. Open
$params['picklistValues'] = \App\Language::getAll();- 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 'getFieldInstanceByName'. Open
'PLL_AUTHY_TOTP' => \App\Language::translate('PLL_AUTHY_TOTP', 'Users'),- 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 'getFieldInstanceByName'. Open
'PLL_PASSWORD' => \App\Language::translate('PLL_PASSWORD', 'Users'),- 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 'getFieldInstanceByName'. Open
$params['picklistValues'] = [1 => \App\Language::translate('FL_ACTIVE'), 0 => \App\Language::translate('FL_INACTIVE')];- 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 'getFieldInstanceByName'. Open
$params['picklistValues'][$key] = \App\Language::translate($value, $moduleName);- 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\Encryption' in method 'getValueToSave'. Open
$value = App\Encryption::createPasswordHash($value, 'WebservicePremium');- 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 'getFieldInstanceByName'. Open
$params['picklistValues'] = [1 => \App\Language::translate('FL_ACTIVE'), 0 => \App\Language::translate('FL_INACTIVE')];- 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_WebserviceApps_Module_Model' in method 'getFieldInstanceByName'. Open
$servers = Settings_WebserviceApps_Module_Model::getActiveServers($this->getModule()->typeApi);- 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_Field_Model' in method 'getFieldInstanceByName'. Open
return $params ? Settings_Vtiger_Field_Model::init($moduleName, $params) : null;- 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 "typeofdata" 5 times. Open
$params = ['uitype' => 1, 'column' => $name, 'name' => $name, 'label' => $fieldsLabel[$name], 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];- 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 "istorage" 5 times. Open
'istorage' => 'FL_STORAGE',- 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 "language" 3 times. Open
'language' => 'FL_LANGUAGE',- 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 "picklistValues" 9 times. Open
$params['picklistValues'] = [1 => \App\Language::translate('FL_ACTIVE'), 0 => \App\Language::translate('FL_INACTIVE')];- 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 "authy_methods" 3 times. Open
'authy_methods' => 'FL_AUTHY_METHODS',- 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 "uitype" 11 times. Open
$params = ['uitype' => 1, 'column' => $name, 'name' => $name, 'label' => $fieldsLabel[$name], 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];- 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 "status" 6 times. Open
'status' => 'FL_STATUS',- 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 "FL_STATUS" 3 times. Open
'status' => 'FL_STATUS',- 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 "crmid" 7 times. Open
'crmid' => 'FL_RECORD_NAME',- 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 "login_method" 4 times. Open
'login_method' => 'FL_LOGIN_METHOD',- 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 "Users" 3 times. Open
'PLL_PASSWORD' => \App\Language::translate('PLL_PASSWORD', 'Users'),- 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 "server_id" 5 times. Open
'server_id' => 'FL_SERVER',- 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 "password" 4 times. Open
'password' => 'FL_PASSWORD',- 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 "user_id" 5 times. Open
'user_id' => 'FL_USER',- 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.
Returning type \Vtiger_Field_Model but getFieldInstanceByName() is declared to return string[] Open
return $params ? Settings_Vtiger_Field_Model::init($moduleName, $params) : null;- Exclude checks
Call to method createPasswordHash from undeclared class \App\Encryption (Did you mean class \Tests\App\Encryption) Open
$value = App\Encryption::createPasswordHash($value, 'WebservicePremium');- Exclude checks
Call to method getInstance from undeclared class \App\Fields\Owner Open
$params['picklistValues'] = \App\Fields\Owner::getInstance($moduleName)->getAccessibleUsers('', 'owner');- Exclude checks
Returning type null but getFieldInstanceByName() is declared to return string[] Open
return $params ? Settings_Vtiger_Field_Model::init($moduleName, $params) : null;- Exclude checks
Remove the code after this "throw". Open
throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||{$field}", 406);- Read upRead up
- Exclude checks
Jump statements (return, break, continue, and goto) and throw expressions move
control flow out of the current code block. Typically, any statements in a block that come after a jump or throw are simply wasted
keystrokes lying in wait to confuse the unwary.
Rarely, as illustrated below, code after a jump or throw is reachable. However, such code is difficult to understand, and should be
refactored.
Noncompliant Code Example
function fun($a) {
$i = 10;
return $i + $a;
$i++; // this is never executed
}
function foo($a) {
if ($a == 5) {
goto error;
} else {
// do the job
}
return;
error:
printf("don't use 5"); // this is reachable but unreadable
}
Compliant Solution
function fun($a) {
$i = 10;
return $i + $a;
}
function foo($a) {
if ($a == 5) {
handleError();
} else {
// do the job
}
return;
}
See
- MISRA C:2004, 14.1 - There shall be no unreachable code
- MISRA C++:2008, 0-1-1 - A project shall not contain unreachable code
- MISRA C++:2008, 0-1-9 - There shall be no dead code
- MISRA C:2012, 2.1 - A project shall not contain unreachable code
- MISRA C:2012, 2.2 - There shall be no dead code
- MITRE, CWE-561 - Dead Code
- CERT, MSC56-J. - Detect and remove superfluous code and values
- CERT, MSC12-C. - Detect and remove code that has no effect or is never executed
- CERT, MSC07-CPP. - Detect and remove dead code
Avoid excessively long class names like Settings_WebserviceUsers_WebservicePremium_Service. Keep class name length under 40. Open
class Settings_WebserviceUsers_WebservicePremium_Service extends Settings_WebserviceUsers_WebserviceStandard_Service
{
/** {@inheritdoc} */
public $baseTable = 'w_#__portal_user';
- Read upRead up
- Exclude checks
LongClassName
Since: 2.9
Detects when classes or interfaces are declared with excessively long names.
Example
class ATooLongClassNameThatHintsAtADesignProblem {
}
interface ATooLongInterfaceNameThatHintsAtADesignProblem {
}Source https://phpmd.org/rules/naming.html#longclassname
Each class must be in a namespace of at least one level (a top-level vendor name) Open
class Settings_WebserviceUsers_WebservicePremium_Service extends Settings_WebserviceUsers_WebserviceStandard_Service- Exclude checks
The class Settings_WebserviceUsers_WebservicePremium_Service is not named in CamelCase. Open
class Settings_WebserviceUsers_WebservicePremium_Service extends Settings_WebserviceUsers_WebserviceStandard_Service
{
/** {@inheritdoc} */
public $baseTable = 'w_#__portal_user';
- 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
Terminating statement must be on a line by itself Open
default: break;- Exclude checks
Terminating statement must be indented to the same level as the CASE body Open
throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||{$field}", 406);- Exclude checks
The DEFAULT body must start on the line following the statement Open
default: break;- Exclude checks
Terminating statement must be on a line by itself Open
default: break;- Exclude checks
The DEFAULT body must start on the line following the statement Open
default: break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'crmid' => 'FL_RECORD_NAME',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fieldsLabel = $this->getEditFields();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'searchParams' => '[[["email","ny",""]]]',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 10;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['referenceList'] = ['IStorages'];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public $listFields = [- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'ip' => 'LBL_IP_ADDRESS',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['picklistValues'] = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public $columnsToShow = [- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params = ['uitype' => 1, 'column' => $name, 'name' => $name, 'label' => $fieldsLabel[$name], 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];- 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
$servers = Settings_WebserviceApps_Module_Model::getActiveServers($this->getModule()->typeApi);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'password' => 'FL_PASSWORD',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'user_id' => 'FL_USER',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'istorage' => 'FL_STORAGE',- 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
'user_name' => 'FL_LOGIN',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'login_method' => 'FL_LOGIN_METHOD',- 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
$params['picklistValues'] = [1 => \App\Language::translate('FL_ACTIVE'), 0 => \App\Language::translate('FL_INACTIVE')];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public $baseTable = 'w_#__portal_user';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'language' => 'FL_LANGUAGE',- Exclude checks
Line exceeds 120 characters; contains 193 characters Open
$params = ['uitype' => 1, 'column' => $name, 'name' => $name, 'label' => $fieldsLabel[$name], 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'istorage':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 16;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($servers as $key => $value) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public $editFields = [- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'status' => 'FL_STATUS',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['typeofdata'] = 'V~O';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 16;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 32;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getFieldInstanceByName($name)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'login_method' => 'FL_LOGIN_METHOD',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'server_id' => 'FL_SERVER',- 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
switch ($name) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'crmid':- Exclude checks
Line exceeds 120 characters; contains 135 characters Open
$params['picklistValues'] = [1 => \App\Language::translate('FL_ACTIVE'), 0 => \App\Language::translate('FL_INACTIVE')];- 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 'language':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'istorage' => 'FL_STORAGE',- 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
$params['picklistValues'][$key] = $value['name'];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['picklistValues'] = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'server_id' => 'FL_SERVER',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'type' => 'FL_TYPE',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'login_time' => 'FL_LOGIN_TIME',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/** @var array Columns to show on the list session. */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'server_id':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['picklistValues'] = [- 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 setDataFromRequest(App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
switch ($field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['fieldparams'] = [- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['typeofdata'] = 'V~O';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'user_id':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['picklistValues'] = [- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['typeofdata'] = 'V~O';- 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
case 'language':- 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
throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||{$field}", 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
/** {@inheritdoc} */- 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
'user_id' => 'FL_USER',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'custom_params' => 'FL_CUSTOM_PARAMS',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['referenceList'] = ['Contacts'];- 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 'type':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($this->getTypeValues() as $key => $value) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['fieldparams'] = '{"validate":["pwned","config"],"auto-generate":true,"strengthMeter":true}';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'server_id':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'type':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'status' => 'FL_STATUS',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'time' => 'FL_LOGIN_TIME',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'agent' => 'LBL_USER_AGENT',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$moduleName = $this->getModule()->getName(true);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'status':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 16;- 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
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 16;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'authy_methods' => 'FL_AUTHY_METHODS',- 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
$params['picklistValues'][$key] = \App\Language::translate($value, $moduleName);- 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
$params['picklistValues'] = \App\Language::getAll();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
default: break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($request->has($field)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'status':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'user_name':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||{$field}", 406);- 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
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'crmid' => 'FL_RECORD_NAME',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'type' => 'FL_TYPE',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'status' => 'FL_STATUS',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'device_id' => 'LBL_DEVICE_ID',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 10;- 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
'PLL_PASSWORD' => \App\Language::translate('PLL_PASSWORD', 'Users'),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'authy_methods':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'server_id':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'authy_methods':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'crmid':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'PLL_PASSWORD_2FA' => \App\Language::translate('PLL_PASSWORD_2FA', 'Users'),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'-' => \App\Language::translate('LBL_NONE'),- 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
$value = $request->isEmpty('crmid') ? '' : $request->getInteger('crmid');- 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
$value = $request->getByType($field, 'Text');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
switch ($key) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = (int) $value;- 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
$params['picklistValues'] = \App\Fields\Owner::getInstance($moduleName)->getAccessibleUsers('', 'owner');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($this->has('id')) {- 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
Spaces must be used to indent lines; tabs are not allowed Open
case 'istorage':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'status':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'password':- 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
$params['typeofdata'] = 'V~O';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 99;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params = null;- 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 'crmid':- 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 'login_method':- 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 'password':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'user_id':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'password':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
parent::set($field, $value);- 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
];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'PLL_AUTHY_TOTP' => \App\Language::translate('PLL_AUTHY_TOTP', 'Users'),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'istorage':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
default: break;- Exclude checks
Line exceeds 120 characters; contains 121 characters Open
$params['picklistValues'] = \App\Fields\Owner::getInstance($moduleName)->getAccessibleUsers('', 'owner');- 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
$params['uitype'] = 16;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $params ? Settings_Vtiger_Field_Model::init($moduleName, $params) : null;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'type':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!$this->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
$value = $request->getRaw($field, null);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getValueToSave($key, $value)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['uitype'] = 16;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['typeApi'] = $this->getModule()->typeApi;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params['maximumlength'] = '100';- 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 (array_keys($this->getEditFields()) as $field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = $request->getInteger($field);- 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 'login_method':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->set($field, $this->getValueToSave($field, $value));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'user_id':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = App\Encryption::createPasswordHash($value, 'WebservicePremium');- 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
return $value;- Exclude checks
Class name "Settings_WebserviceUsers_WebservicePremium_Service" is not in camel caps format Open
class Settings_WebserviceUsers_WebservicePremium_Service extends Settings_WebserviceUsers_WebserviceStandard_Service- Exclude checks
Closing brace must be on a line by itself Open
default: break;- Exclude checks
Closing brace must be on a line by itself Open
default: break;- Exclude checks