modules/Settings/LayoutEditor/actions/WebserviceApps.php
Function update has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring. Open
Open
public function update(App\Request $request): void
{
$response = new Vtiger_Response();
try {
$fieldInstance = Settings_LayoutEditor_Field_Model::getInstance($request->getInteger('fieldId'));- 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 update has 31 lines of code (exceeds 25 allowed). Consider refactoring. Open
Open
public function update(App\Request $request): void
{
$response = new Vtiger_Response();
try {
$fieldInstance = Settings_LayoutEditor_Field_Model::getInstance($request->getInteger('fieldId'));Missing class import via use statement (line '34', column '19'). Open
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
Avoid using static access to class 'Settings_Vtiger_Tracker_Model' in method '__construct'. Open
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 using static access to class '\App\Language' in method 'update'. Open
Open
$response->setResult(['success' => true, 'notify' => ['text' => \App\Language::translate('LBL_CHANGES_SAVED')], 'closeModal' => true]);- 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_LayoutEditor_Field_Model' in method 'update'. Open
Open
$fieldInstance = Settings_LayoutEditor_Field_Model::getInstance($request->getInteger('fieldId'));- 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\Field' in method 'update'. Open
Open
$list = \App\Field::getCustomListForDefaultValue($fieldInstance);- 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 "is_default" 3 times. Open
Open
if ($request->getBoolean('is_default')) {- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Argument 1 (value) is int but \Settings_LayoutEditor_Field_Model::getInstance() takes string defined at /code/modules/Settings/LayoutEditor/models/Field.php:359 Open
Open
$fieldInstance = Settings_LayoutEditor_Field_Model::getInstance($request->getInteger('fieldId'));- Exclude checks
Avoid excessively long class names like Settings_LayoutEditor_WebserviceApps_Action. Keep class name length under 40. Open
Open
class Settings_LayoutEditor_WebserviceApps_Action extends Settings_Vtiger_Index_Action
{
/** {@inheritdoc} */
public function __construct()
{- 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
Open
class Settings_LayoutEditor_WebserviceApps_Action extends Settings_Vtiger_Index_Action- Exclude checks
The class Settings_LayoutEditor_WebserviceApps_Action is not named in CamelCase. Open
Open
class Settings_LayoutEditor_WebserviceApps_Action extends Settings_Vtiger_Index_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
Open
$uitypeModel->setDefaultValueFromRequest($request);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function __construct()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$defaultValue = $customDefaultValue;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
Settings_Vtiger_Tracker_Model::addBasic('save');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$customDefaultValue = $request->getByType('customDefaultValue', \App\Purifier::ALNUM);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Update active status.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @param \App\Request $request- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function update(App\Request $request): void- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$uitypeModel = $fieldInstance->getUITypeModel();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
parent::__construct();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ('' === $defaultValue) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->exposeMethod('update');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @return void- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$fieldInstance = Settings_LayoutEditor_Field_Model::getInstance($request->getInteger('fieldId'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$defaultValue = '';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ($list && $request->has('customDefaultValue')) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ($request->getBoolean('is_default')) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$defaultValue = $fieldInstance->get('defaultvalue');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
try {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$response = new Vtiger_Response();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$list = \App\Field::getCustomListForDefaultValue($fieldInstance);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ('-' !== $customDefaultValue && isset($list[$customDefaultValue])) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
[- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$response->setResult(['success' => true, 'notify' => ['text' => \App\Language::translate('LBL_CHANGES_SAVED')], 'closeModal' => true]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
} catch (Exception $e) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'visibility' => $request->getInteger('visibility'),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$response->emit();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'default_value' => $defaultValue,- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
],- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
'is_default' => $request->getInteger('is_default'),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$fieldInstance->updateWebserviceData(- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$request->getInteger('wa')- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$response->setError($e->getCode(), $e->getMessage());- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
);- Exclude checks
Line exceeds 120 characters; contains 147 characters Open
Open
$response->setResult(['success' => true, 'notify' => ['text' => \App\Language::translate('LBL_CHANGES_SAVED')], 'closeModal' => true]);- Exclude checks
Class name "Settings_LayoutEditor_WebserviceApps_Action" is not in camel caps format Open
Open
class Settings_LayoutEditor_WebserviceApps_Action extends Settings_Vtiger_Index_Action- Exclude checks