api/webservice/WebservicePremium/BaseModule/SaveInventory.php
Function post has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring. Open
Open
public function post(): array
{
if ($result = $this->checkBeforeSave()) {
return $result;
}- 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 post has 61 lines of code (exceeds 25 allowed). Consider refactoring. Open
Open
public function post(): array
{
if ($result = $this->checkBeforeSave()) {
return $result;
}The method post() has an NPath complexity of 7560. The configured NPath complexity threshold is 200. Open
Open
public function post(): array
{
if ($result = $this->checkBeforeSave()) {
return $result;
}- Read upRead up
- Exclude checks
NPathComplexity
Since: 0.1
The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.
Example
class Foo {
function bar() {
// lots of complicated code
}
}Source https://phpmd.org/rules/codesize.html#npathcomplexity
The method post() has a Cyclomatic Complexity of 18. The configured cyclomatic complexity threshold is 10. Open
Open
public function post(): array
{
if ($result = $this->checkBeforeSave()) {
return $result;
}- 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 26 to the 15 allowed. Open
Open
public function post(): array- 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
Reduce the number of returns of this function 4, down to the maximum allowed 3. Open
Open
private function checkBeforeSave(): array- Read upRead up
- Exclude checks
Having too many return statements in a function increases the function's essential complexity because the flow of execution is broken each time a return statement is encountered. This makes it harder to read and understand the logic of the function.
Noncompliant Code Example
With the default threshold of 3:
function myFunction(){ // Noncompliant as there are 4 return statements
if (condition1) {
return true;
} else {
if (condition2) {
return false;
} else {
return true;
}
}
return false;
}
Missing class import via use statement (line '45', column '14'). Open
Open
throw new \Api\Core\Exception('No permissions to create record', 403);- 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 '191', column '26'). Open
Open
$this->inventory = new \Api\WebservicePremium\Inventory($this->moduleName, $this);- 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 assigning values to variables in if clauses and the like (line '105', column '7'). Open
Open
public function post(): array
{
if ($result = $this->checkBeforeSave()) {
return $result;
}- 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_Record_Model' in method 'checkPermission'. Open
Open
$this->recordModel = \Vtiger_Record_Model::getCleanInstance($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 '\Vtiger_InventoryLimit_UIType' in method 'post'. Open
Open
$limits = \Vtiger_InventoryLimit_UIType::getLimits();- 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 '207', column '93'). Open
Open
public function getCheckStockLevels(): bool
{
if (\Api\WebservicePremium\Privilege::USER_PERMISSIONS !== $this->getPermissionType() && ($parentId = $this->getParentCrmId())) {
return (bool) \Vtiger_Record_Model::getInstanceById($parentId)->get('check_stock_levels');
}- 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_Record_Model' in method 'post'. Open
Open
$parentRecordModel = \Vtiger_Record_Model::getInstanceById($parentRecordId, 'Accounts');- 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 '\Api\Core\Module' in method 'post'. Open
Open
$fieldPermission = \Api\Core\Module::getApiFieldPermission($this->moduleName, (int) $this->controller->app['id']);- 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
The method post uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
$inventoryData = $this->inventory->getInventoryData();
}- 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
Define a constant instead of duplicating this literal "errors" 4 times. Open
Open
'errors' => [- 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.
Rename "$moduleName" which has the same name as the field declared at line 27. Open
Open
$moduleName = $this->controller->request->getModule();- Read upRead up
- Exclude checks
Shadowing fields with a local variable is a bad practice that reduces code readability: it makes it confusing to know whether the field or the variable is being used.
Noncompliant Code Example
class Foo {
public $myField;
public function doSomething() {
$myField = 0;
...
}
}
See
- CERT, DCL51-J. - Do not shadow or obscure identifiers in subscopes
Possibly zero references to use statement for classlike/namespace OA (\OpenApi\Annotations) Open
Open
use OpenApi\Annotations as OA;- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No permissions to create record",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseAction_SaveInventory_ResponseBodyError",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Post(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* summary="A store functionality - creates a record in an advanced module (orders)",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(ref="#/components/schemas/BaseAction_SaveInventory_ResponseBodyError"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="id", description="Record Id", type="integer", example=38),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
continue;- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* tags={"BaseModule"},- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Contents of the response contains only id nd module name",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=403,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/BaseAction_SaveInventory_ResponseBody"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=403,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseAction_SaveInventory_ResponseBodySuccess",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base module - Create inventory record response success schema",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="errors", description="Error details", type="object"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Creating inventory records for the functionality of the store",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
foreach ($this->moduleModel->getFields() as $fieldName => $fieldModel) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/BaseAction_SaveInventory_ResponseBody"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return $result;- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="result",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Create result",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* path="/webservice/WebservicePremium/{moduleName}/SaveInventory",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseAction_SaveInventory_ResponseBody",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(ref="#/components/schemas/BaseAction_SaveInventory_ResponseBodySuccess"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="moduleName", type="string", example="SSingleOrders"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=200,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* }- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Creating inventory records for the functionality of the store",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base module - Create inventory record response error schema",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* path="/webservice/WebservicePremium/{moduleName}/SaveInventory",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Accounts"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No permissions to create record",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(ref="#/components/schemas/BaseAction_SaveInventory_ResponseBodyError"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="result",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($this->controller->request->has($fieldName)) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* }- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($result = $this->checkBeforeSave()) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=200,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/BaseAction_SaveInventory_ResponseBody"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Contents of the response contains only id nd module name",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* oneOf={- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseAction_SaveInventory_ResponseBody",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="moduleName", type="string", example="SSingleOrders"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (!$fieldModel->isWritable()) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* tags={"BaseModule"},- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/BaseAction_SaveInventory_ResponseBody"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* summary="A store functionality - creates a record in an advanced module (orders)",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Accounts"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base module - Create inventory record response schema",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Create result",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base module - Create inventory record response schema",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(ref="#/components/schemas/BaseAction_SaveInventory_ResponseBodySuccess"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base module - Create inventory record response error schema",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
public function post(): array- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* oneOf={- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseAction_SaveInventory_ResponseBodySuccess",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base module - Create inventory record response success schema",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="id", description="Record Id", type="integer", example=38),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseAction_SaveInventory_ResponseBodyError",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="errors", description="Error details", type="object"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->recordModel->set($fieldModel->getFieldName(), $this->getUserStorageId());- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($fieldPermission) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return [- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->inventory = new \Api\WebservicePremium\Inventory($this->moduleName, $this);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (\Api\WebservicePremium\Privilege::USER_PERMISSIONS !== $this->getPermissionType()) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (!empty($creditLimitId)) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($grossFieldModel && $grossFieldModel->getSummaryValuesFromData($inventoryData) > (($limits[$creditLimitId]['value'] ?? 0) - $parentRecordModel->get('sum_open_orders'))) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$grossFieldModel = \Vtiger_Inventory_Model::getInstance($this->moduleName)->getField('gross');- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return [- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return [- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'record' => 'There are no inventory records',- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return [- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->moduleModel = $this->recordModel->getModule();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (!$this->moduleModel->isInventory()) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$parentRecordId = $this->getParentCrmId();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->recordModel->set($fieldModel->getFieldName(), $this->getUserCrmId());- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$fieldPermission = \Api\Core\Module::getApiFieldPermission($this->moduleName, (int) $this->controller->app['id']);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$inventoryData = [];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($this->getCheckStockLevels() && !$this->inventory->validate()) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($fieldModel && !$this->controller->request->has($fieldModel->getFieldName())) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (!empty($parentRecordId)) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->recordModel->set($fieldName, $parentRecordModel->get($fieldName));- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'errors' => [- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
private function checkBeforeSave(): array- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
],- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$fieldModel = current($this->moduleModel->getReferenceFieldsForModule('Contacts'));- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'limit' => 'Merchant limit was exceeded',- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* Get information, whether to check inventory levels.- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
} else {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$creditLimitId = $parentRecordModel->get('creditlimit');- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (!$this->controller->request->has('inventory')) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'record' => 'This is not an inventory module',- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @return bool- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$fieldModel = current($this->moduleModel->getReferenceFieldsForModule('IStorages'));- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return [];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$fieldModel->getUITypeModel()->setValueFromRequest($this->controller->request, $this->recordModel);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->recordModel->initInventoryData($inventoryData, false);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$limits = \Vtiger_InventoryLimit_UIType::getLimits();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'id' => $this->recordModel->getId(),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($fieldModel) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($fieldModel) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$parentRecordModel = \Vtiger_Record_Model::getInstanceById($parentRecordId, 'Accounts');- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->recordModel->save();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @return array- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'moduleName' => $this->moduleName,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (\Api\WebservicePremium\Privilege::USER_PERMISSIONS !== $this->getPermissionType() && ($parentId = $this->getParentCrmId())) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$fieldModel = current($this->moduleModel->getReferenceFieldsForModule('Accounts'));- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$inventoryData = $this->inventory->getInventoryFromRecord($this->controller->request->getInteger('reference_id'), $this->controller->request->getByType('reference_module', 'Alnum'));- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (!$this->controller->request->has($fieldName)) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* Check the request before the save.- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'errors' => [- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return (bool) \Vtiger_Record_Model::getInstanceById($parentId)->get('check_stock_levels');- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return false;- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->recordModel->setDataForSave([$fieldPermission['tablename'] => [$fieldPermission['columnname'] => 1]]);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$inventoryData = $this->inventory->getInventoryData();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
],- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->moduleName = $this->controller->request->getModule();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'errors' => [- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if ($this->controller->request->has('reference_id') && $this->controller->request->has('reference_module')) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$fieldName = 'assigned_user_id';- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$this->recordModel->set($fieldModel->getFieldName(), $parentRecordId);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
],- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
public function getCheckStockLevels(): bool- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return [- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
'errors' => $this->inventory->getErrors(),- Exclude checks
The 'getCheckStockLevels()' method which returns a boolean should be named 'is...()' or 'has...()' Open
Open
public function getCheckStockLevels(): bool
{
if (\Api\WebservicePremium\Privilege::USER_PERMISSIONS !== $this->getPermissionType() && ($parentId = $this->getParentCrmId())) {
return (bool) \Vtiger_Record_Model::getInstanceById($parentId)->get('check_stock_levels');
}- Read upRead up
- Exclude checks
BooleanGetMethodName
Since: 0.2
Looks for methods named 'getX()' with 'boolean' as the return type. The convention is to name these methods 'isX()' or 'hasX()'.
Example
class Foo {
/**
* @return boolean
*/
public function getFoo() {} // bad
/**
* @return bool
*/
public function isFoo(); // ok
/**
* @return boolean
*/
public function getFoo($bar); // ok, unless checkParameterizedMethods=true
}Source https://phpmd.org/rules/naming.html#booleangetmethodname
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected function checkPermission(): void- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
parent::checkPermission();- Exclude checks
Line exceeds 120 characters; contains 145 characters Open
Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Accounts"),- 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
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
private $recordModel;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$moduleName = $this->controller->request->getModule();- 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 $allowedMethod = ['POST'];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->recordModel = \Vtiger_Record_Model::getCleanInstance($moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if (!$this->recordModel->isCreateable()) {- Exclude checks
Line exceeds 120 characters; contains 189 characters Open
Open
* @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"),- 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
/** @var \Api\WebservicePremium\Inventory Inventory object. */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
private $inventory;- 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
* @return array- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** @var \Vtiger_Module_Model Module model. */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
private $moduleModel;- 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
* Put method - A store functionality - creates a record in an advanced module (orders).- 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
* @OA\Post(- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** @var string Module name. */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
private $moduleName;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** @var \Vtiger_Record_Model Record model. */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
throw new \Api\Core\Exception('No permissions to create record', 403);- Exclude checks
Line exceeds 120 characters; contains 131 characters Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),- Exclude checks
Line exceeds 120 characters; contains 194 characters Open
Open
$inventoryData = $this->inventory->getInventoryFromRecord($this->controller->request->getInteger('reference_id'), $this->controller->request->getByType('reference_module', 'Alnum'));- Exclude checks
Line exceeds 120 characters; contains 121 characters Open
Open
$this->recordModel->setDataForSave([$fieldPermission['tablename'] => [$fieldPermission['columnname'] => 1]]);- Exclude checks
Line exceeds 120 characters; contains 137 characters Open
Open
if (\Api\WebservicePremium\Privilege::USER_PERMISSIONS !== $this->getPermissionType() && ($parentId = $this->getParentCrmId())) {- Exclude checks
Line exceeds 120 characters; contains 190 characters Open
Open
if ($grossFieldModel && $grossFieldModel->getSummaryValuesFromData($inventoryData) > (($limits[$creditLimitId]['value'] ?? 0) - $parentRecordModel->get('sum_open_orders'))) {- Exclude checks
Line exceeds 120 characters; contains 122 characters Open
Open
$fieldPermission = \Api\Core\Module::getApiFieldPermission($this->moduleName, (int) $this->controller->app['id']);- Exclude checks