Function global has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring. Open
public function global(App\Request $request)
{
$moduleName = $request->getModule(false);
$data = [];
$type = 'global';- 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 global has 46 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function global(App\Request $request)
{
$moduleName = $request->getModule(false);
$data = [];
$type = 'global';The method global() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10. Open
public function global(App\Request $request)
{
$moduleName = $request->getModule(false);
$data = [];
$type = 'global';- 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 29 to the 15 allowed. Open
public function global(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
Missing class import via use statement (line '81', column '19'). Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . implode(',', $values), 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 '93', 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 '58', column '18'). Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $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 '35', 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 '72', column '18'). Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $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 '65', column '18'). Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $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
Avoid using static access to class '\App\Language' in method 'global'. Open
$response->setResult(['success' => true, 'message' => \App\Language::translate('LBL_SAVE_NOTIFY_OK', $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\Map\Address' in method 'global'. Open
$providers = \App\Map\Address::getAllProviders();- 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\Map\Address' in method 'global'. 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 '\App\Language' in method 'provider'. Open
$response->setResult(['success' => true, 'message' => \App\Language::translate('LBL_SAVE_NOTIFY_OK', $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\Map\Address' in method 'provider'. Open
$provider = \App\Map\Address::getInstance($request->getByType('provider', \App\Purifier::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 "ERR_ILLEGAL_FIELD_VALUE||" 4 times. Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 406);- 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.
Call to method getDataFromRequest from undeclared class \App\Map\Address\Base (Did you mean class \App\Base or class \App\Cache\Base or class \App\Cli\Base or class \App\Controller\Base or class \App\Controller\View\Base or class \App\Db\Importers\Base or class \Tests\Base) Open
$data = $provider->getDataFromRequest($request);- Exclude checks
Similar blocks of code found in 2 locations. Consider refactoring. Open
case 'result_num':
$value = $request->getByType($fieldName, \App\Purifier::INTEGER);
if ($value < 1 || $value > 100) {
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 406);
}- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 101.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 2 locations. Consider refactoring. Open
case 'min_length':
$value = $request->getByType($fieldName, \App\Purifier::INTEGER);
if ($value < 0 || $value > 100) {
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 406);
}- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 101.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Each class must be in a namespace of at least one level (a top-level vendor name) Open
class Settings_ApiAddress_SaveConfig_Action extends Settings_Vtiger_Basic_Action- Exclude checks
The class Settings_ApiAddress_SaveConfig_Action is not named in CamelCase. Open
class Settings_ApiAddress_SaveConfig_Action extends Settings_Vtiger_Basic_Action
{
/** {@inheritdoc} */
public function __construct()
{- 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
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$data[] = ['name' => $fieldName, 'type' => $type, 'val' => $value];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'active':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
default:- Exclude checks
Line exceeds 120 characters; contains 124 characters Open
$response->setResult(['success' => true, 'message' => \App\Language::translate('LBL_SAVE_NOTIFY_OK', $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
$providers = \App\Map\Address::getAllProviders();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @return void- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @return void- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function provider(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
case 'min_length':- 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
$data[] = ['name' => $fieldName, 'type' => $type, 'val' => (int) $value];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = $request->getByType($fieldName, \App\Purifier::STANDARD);- Exclude checks
Line exceeds 120 characters; contains 147 characters Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 406);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($values as $provider => $active) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . implode(',', $values), 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
$moduleName = $request->getModule(false);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($value < 1 || $value > 100) {- 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
$response = new Vtiger_Response();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = $request->getByType($fieldName, \App\Purifier::INTEGER);- 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
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->exposeMethod('provider');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$provider = \App\Map\Address::getInstance($request->getByType('provider', \App\Purifier::STANDARD));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->exposeMethod('global');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$moduleName = $request->getModule(false);- 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
Line exceeds 120 characters; contains 124 characters Open
$response->setResult(['success' => true, 'message' => \App\Language::translate('LBL_SAVE_NOTIFY_OK', $moduleName)]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->setResult(['success' => true, 'message' => \App\Language::translate('LBL_SAVE_NOTIFY_OK', $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
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'result_num':- 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 'default_provider':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Settings_ApiAddress_Module_Model::getInstance($moduleName)->setConfig($data);- 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
{- 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
{- 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
$data[] = ['name' => $fieldName, 'type' => $provider, 'val' => (int) $active];- 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 ($request->has($fieldName)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ($value < 0 || $value > 100) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 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
$data = $provider->getDataFromRequest($request);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @param App\Request $request- Exclude checks
Line exceeds 120 characters; contains 147 characters Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 406);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$values = $request->getArray($fieldName, \App\Purifier::BOOL, [], \App\Purifier::STANDARD);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Save provider configuration.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Save global configuration.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$data[] = ['name' => $fieldName, 'type' => $type, 'val' => (int) $value];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 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
$value = $request->getByType($fieldName, \App\Purifier::INTEGER);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 406);- Exclude checks
Line exceeds 120 characters; contains 147 characters Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . $value, 406);- Exclude checks
Line exceeds 120 characters; contains 166 characters Open
throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . $fieldName . '||' . $moduleName . '||' . implode(',', $values), 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
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$response->setResult(['success' => true, 'message' => \App\Language::translate('LBL_SAVE_NOTIFY_OK', $moduleName)]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$data = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$type = 'global';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!isset($providers[$provider])) {- 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
/** {@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
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Settings_ApiAddress_Module_Model::getInstance($moduleName)->setConfig($data);- 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
if (!isset(\App\Map\Address::getAllProviders()[$value])) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function global(App\Request $request)- 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
foreach (['min_length', 'result_num', 'default_provider', 'active'] as $fieldName) {- 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 ($fieldName) {- 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
Class name "Settings_ApiAddress_SaveConfig_Action" is not in camel caps format Open
class Settings_ApiAddress_SaveConfig_Action extends Settings_Vtiger_Basic_Action- Exclude checks