YetiForceCompany/YetiForceCRM

View on GitHub
modules/IStorages/handlers/RecalculateStockHandler.php

Summary

Maintainability
A
1 hr
Test Coverage
D
66%

Function entityAfterSave has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    public function entityAfterSave(App\EventHandler $eventHandler)
    {
        $moduleName = $eventHandler->getModuleName();
        $correctionModules = ['IGRNC' => 'igrnid', 'IGDNC' => 'igdnid'];
        $recordModel = $eventHandler->getRecordModel();
Severity: Minor
Found in modules/IStorages/handlers/RecalculateStockHandler.php - About 1 hr to fix

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

Missing class import via use statement (line '71', column '9').
Open

            (new \App\BatchMethod(['method' => 'App\Integrations\Magento\Controller::updateStock', 'params' => [

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

The method entityAfterSave uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            $delta = $recordModel->getPreviousValue($status);
            if ($delta && 'PLL_ACCEPTED' === $delta) {
                if (isset($correctionModules[$moduleName])) {
                    $this->updateStock($relatedModuleRecordModel, 'add');

ElseExpression

Since: 1.4.0

An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

Example

class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

Source https://phpmd.org/rules/cleancode.html#elseexpression

Avoid using static access to class 'Vtiger_Record_Model' in method 'entityAfterSave'.
Open

            $relatedModuleRecordModel = Vtiger_Record_Model::getInstanceById($relatedModuleRecordId);

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 'IStorages_Module_Model' in method 'updateStock'.
Open

            IStorages_Module_Model::setQtyInStock($recordModel->getModuleName(), $inventoryData, $recordModel->get('storageid'), $action);

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 excessively long variable names like $relatedModuleRecordId. Keep variable name length under 20.
Open

            $relatedModuleRecordId = $recordModel->get($relatedModuleField);

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

Source https://phpmd.org/rules/naming.html#longvariable

Avoid excessively long variable names like $relatedModuleRecordModel. Keep variable name length under 20.
Open

            $relatedModuleRecordModel = Vtiger_Record_Model::getInstanceById($relatedModuleRecordId);

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

Source https://phpmd.org/rules/naming.html#longvariable

Avoid excessively long class names like IStorages_RecalculateStockHandler_Handler. Keep class name length under 40.
Open

class IStorages_RecalculateStockHandler_Handler
{
    /**
     * EntityAfterSave handler function.
     *

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 IStorages_RecalculateStockHandler_Handler

The class IStorages_RecalculateStockHandler_Handler is not named in CamelCase.
Open

class IStorages_RecalculateStockHandler_Handler
{
    /**
     * EntityAfterSave handler function.
     *

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

            $relatedModuleField = $correctionModules[$moduleName];

Spaces must be used to indent lines; tabs are not allowed
Open

        }

Spaces must be used to indent lines; tabs are not allowed
Open

     */

Spaces must be used to indent lines; tabs are not allowed
Open

                'product' => $productId,

Spaces must be used to indent lines; tabs are not allowed
Open

     * EntityAfterSave handler function.

Spaces must be used to indent lines; tabs are not allowed
Open

        $moduleName = $eventHandler->getModuleName();

Spaces must be used to indent lines; tabs are not allowed
Open

        }

Spaces must be used to indent lines; tabs are not allowed
Open

     * @param string              $action

Spaces must be used to indent lines; tabs are not allowed
Open

     *

Spaces must be used to indent lines; tabs are not allowed
Open

        $storageId = $eventHandler->getParams()['storageId'];

Spaces must be used to indent lines; tabs are not allowed
Open

            $this->updateStock($recordModel, 'add');

Spaces must be used to indent lines; tabs are not allowed
Open

    /**

Spaces must be used to indent lines; tabs are not allowed
Open

        }

Spaces must be used to indent lines; tabs are not allowed
Open

            $relatedModuleRecordModel = Vtiger_Record_Model::getInstanceById($relatedModuleRecordId);

Spaces must be used to indent lines; tabs are not allowed
Open

        if (!empty($inventoryData) && $recordModel->get('storageid')) {

Spaces must be used to indent lines; tabs are not allowed
Open

    /**

Spaces must be used to indent lines; tabs are not allowed
Open

     * IStoragesAfterUpdateStock handler function.

Spaces must be used to indent lines; tabs are not allowed
Open

    }

Spaces must be used to indent lines; tabs are not allowed
Open

        if (isset($correctionModules[$moduleName])) {

Spaces must be used to indent lines; tabs are not allowed
Open

                    $this->updateStock($relatedModuleRecordModel, 'add');

Spaces must be used to indent lines; tabs are not allowed
Open

    /**

Spaces must be used to indent lines; tabs are not allowed
Open

            }

Spaces must be used to indent lines; tabs are not allowed
Open

        if ('PLL_ACCEPTED' === $recordModel->get($status)) {

Spaces must be used to indent lines; tabs are not allowed
Open

     */

Spaces must be used to indent lines; tabs are not allowed
Open

        }

Spaces must be used to indent lines; tabs are not allowed
Open

        $status = strtolower($moduleName) . '_status';

Spaces must be used to indent lines; tabs are not allowed
Open

            }

Spaces must be used to indent lines; tabs are not allowed
Open

     * Update stock.

Spaces must be used to indent lines; tabs are not allowed
Open

                'storageId' => $storageId,

Spaces must be used to indent lines; tabs are not allowed
Open

     * @param App\EventHandler $eventHandler

Spaces must be used to indent lines; tabs are not allowed
Open

     */

Spaces must be used to indent lines; tabs are not allowed
Open

            $delta = $recordModel->getPreviousValue($status);

Spaces must be used to indent lines; tabs are not allowed
Open

     * @param Vtiger_Record_Model $recordModel

Spaces must be used to indent lines; tabs are not allowed
Open

     *

Spaces must be used to indent lines; tabs are not allowed
Open

    public function iStoragesAfterUpdateStock(App\EventHandler $eventHandler)

Spaces must be used to indent lines; tabs are not allowed
Open

        $correctionModules = ['IGRNC' => 'igrnid', 'IGDNC' => 'igdnid'];

Spaces must be used to indent lines; tabs are not allowed
Open

                }

Spaces must be used to indent lines; tabs are not allowed
Open

     *

Spaces must be used to indent lines; tabs are not allowed
Open

     * @return void

Line exceeds 120 characters; contains 138 characters
Open

            IStorages_Module_Model::setQtyInStock($recordModel->getModuleName(), $inventoryData, $recordModel->get('storageid'), $action);

Spaces must be used to indent lines; tabs are not allowed
Open

        $recordModel = $eventHandler->getRecordModel();

Spaces must be used to indent lines; tabs are not allowed
Open

        // Checks if the module is a correction module

Spaces must be used to indent lines; tabs are not allowed
Open

            if (isset($correctionModules[$moduleName])) {

Spaces must be used to indent lines; tabs are not allowed
Open

    {

Spaces must be used to indent lines; tabs are not allowed
Open

            ]]))->save();

Spaces must be used to indent lines; tabs are not allowed
Open

            if ($delta && 'PLL_ACCEPTED' === $delta) {

Spaces must be used to indent lines; tabs are not allowed
Open

                if (isset($correctionModules[$moduleName])) {

Spaces must be used to indent lines; tabs are not allowed
Open

                $this->updateStock($recordModel, 'remove');

Spaces must be used to indent lines; tabs are not allowed
Open

    public function updateStock(Vtiger_Record_Model $recordModel, string $action): void

Spaces must be used to indent lines; tabs are not allowed
Open

            (new \App\BatchMethod(['method' => 'App\Integrations\Magento\Controller::updateStock', 'params' => [

Spaces must be used to indent lines; tabs are not allowed
Open

     *

Spaces must be used to indent lines; tabs are not allowed
Open

            IStorages_Module_Model::setQtyInStock($recordModel->getModuleName(), $inventoryData, $recordModel->get('storageid'), $action);

Spaces must be used to indent lines; tabs are not allowed
Open

    {

Spaces must be used to indent lines; tabs are not allowed
Open

    public function entityAfterSave(App\EventHandler $eventHandler)

Spaces must be used to indent lines; tabs are not allowed
Open

            $relatedModuleRecordId = $recordModel->get($relatedModuleField);

Spaces must be used to indent lines; tabs are not allowed
Open

    }

Spaces must be used to indent lines; tabs are not allowed
Open

        $inventoryData = $recordModel->getInventoryData();

Spaces must be used to indent lines; tabs are not allowed
Open

        foreach ((array_keys($eventHandler->getParams()['products']) ?? []) as $productId) {

Spaces must be used to indent lines; tabs are not allowed
Open

    {

Spaces must be used to indent lines; tabs are not allowed
Open

                $this->updateStock($relatedModuleRecordModel, 'remove');

Spaces must be used to indent lines; tabs are not allowed
Open

        } else {

Spaces must be used to indent lines; tabs are not allowed
Open

    }

Spaces must be used to indent lines; tabs are not allowed
Open

     * @param App\EventHandler $eventHandler

Spaces must be used to indent lines; tabs are not allowed
Open

        $eventHandler->getParams();

Class name "IStorages_RecalculateStockHandler_Handler" is not in camel caps format
Open

class IStorages_RecalculateStockHandler_Handler

There are no issues that match your filters.

Category
Status