YetiForceCompany/YetiForceCRM

View on GitHub
modules/Vtiger/inventoryfields/MarginP.php

Summary

Maintainability
A
1 hr
Test Coverage
D
60%

Function getSummaryValuesFromData has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    public function getSummaryValuesFromData($data)
    {
        $sum = $purchase = $totalOrNet = 0;
        if (\is_array($data)) {
            foreach ($data as $row) {
Severity: Minor
Found in modules/Vtiger/inventoryfields/MarginP.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

Function validate has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    public function validate($value, string $columnName, bool $isUserFormat, $originalValue = null)
    {
        if ($isUserFormat) {
            $value = $this->getDBValue($value, $columnName);
            if (null !== $originalValue) {
Severity: Minor
Found in modules/Vtiger/inventoryfields/MarginP.php - About 45 mins 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 '76', column '14').
Open

            throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||$columnName||$value", 406);

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 '79', column '14').
Open

            throw new \App\Exceptions\Security("ERR_VALUE_IS_TOO_LONG||$columnName||$value", 406);

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 getDisplayValue has a boolean flag argument $rawText, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function getDisplayValue($value, array $rowData = [], bool $rawText = false)

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

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

The method getValueForSave has a boolean flag argument $userFormat, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function getValueForSave(array $item, bool $userFormat = false, string $column = null)

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

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

Missing class import via use statement (line '82', column '14').
Open

            throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . ($columnName ?? $this->getColumnName()) . "||{$this->getModuleName()}||$value($originalValue)", 406);

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\Fields\Double' in method 'getEditValue'.
Open

        return \App\Fields\Double::formatToDisplay($value, false);

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\Fields\Double' in method 'getDBValue'.
Open

            $this->dbValue["{$value}"] = App\Fields\Double::formatToDb($value);

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\Fields\Double' in method 'getDisplayValue'.
Open

        return \App\Fields\Double::formatToDisplay($value);

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 getSummaryValuesFromData uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

                } else {
                    $totalOrNet += $row['total'];
                }

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 '\App\Validator' in method 'validate'.
Open

        if (!\App\Validator::float($value)) {

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\Validator' in method 'validate'.
Open

        if (null !== $originalValue && !\App\Validator::floatIsEqualUserCurrencyDecimals($value, $originalValue)) {

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

Call to method floatIsEqualUserCurrencyDecimals from undeclared class \App\Validator (Did you mean class \Tests\App\Validator)
Open

        if (null !== $originalValue && !\App\Validator::floatIsEqualUserCurrencyDecimals($value, $originalValue)) {
Severity: Critical
Found in modules/Vtiger/inventoryfields/MarginP.php by phan

Reference to undeclared property \Vtiger_MarginP_InventoryField->dbValue (Did you mean expr->value or $value)
Open

        if (!isset($this->dbValue["{$value}"])) {

Reference to undeclared property \Vtiger_MarginP_InventoryField->dbValue (Did you mean expr->value or $value)
Open

            $this->dbValue["{$value}"] = App\Fields\Double::formatToDb($value);

Reference to undeclared property \Vtiger_MarginP_InventoryField->dbValue (Did you mean expr->value or $value)
Open

        return $this->dbValue["{$value}"];

Call to method float from undeclared class \App\Validator (Did you mean class \Tests\App\Validator)
Open

        if (!\App\Validator::float($value)) {
Severity: Critical
Found in modules/Vtiger/inventoryfields/MarginP.php by phan

Each class must be in a namespace of at least one level (a top-level vendor name)
Open

class Vtiger_MarginP_InventoryField extends Vtiger_Basic_InventoryField

The class Vtiger_MarginP_InventoryField is not named in CamelCase.
Open

class Vtiger_MarginP_InventoryField extends Vtiger_Basic_InventoryField
{
    protected $type = 'MarginP';
    protected $defaultLabel = 'LBL_MARGIN_PERCENT';
    protected $defaultValue = 0;

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

            if (!empty($purchase) && !empty($totalOrNet)) {

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

            throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||$columnName||$value", 406);

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 (null !== $originalValue && !\App\Validator::floatIsEqualUserCurrencyDecimals($value, $originalValue)) {

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

        $value = 0.0;

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

            $value = 100.0 * static::getInstance($this->getModuleName(), 'Margin')->getValueForSave($item, $userFormat) / $totalPurchase;

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 \App\Fields\Double::formatToDisplay($value);

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

    protected $defaultValue = 0;

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

    public function getSummaryValuesFromData($data)

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

        $sum = $purchase = $totalOrNet = 0;

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

        if ($isUserFormat) {

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

            $value = $this->getDBValue($value, $columnName);

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

            if (null !== $originalValue) {

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

        if (!empty($totalPurchase)) {

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

    protected $summationValue = true;

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

    /** {@inheritdoc} */

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

    }

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

                $sum = ($subtraction * 100) / $purchase;

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

    public function getDBValue($value, ?string $name = '')

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

            $this->dbValue["{$value}"] = App\Fields\Double::formatToDb($value);

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

    protected $type = 'MarginP';

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

    public function getEditValue($value)

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

        return \App\Fields\Double::formatToDisplay($value, false);

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 getValueForSave(array $item, bool $userFormat = false, string $column = null)

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

        if (\is_array($data)) {

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

                $originalValue = $this->getDBValue($originalValue, $columnName);

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

        }

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

    /** {@inheritdoc} */

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

    }

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

    protected $purifyType = \App\Purifier::NUMBER;

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 ($this->maximumLength < $value || -$this->maximumLength > $value) {

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

        $purchase = static::getInstance($this->getModuleName(), 'Purchase')->getValueForSave($item, $userFormat);

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

        $totalPurchase = $purchase * $quantity;

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

        return $value;

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

    public function getDisplayValue($value, array $rowData = [], bool $rawText = false)

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

                $purchase += $row['qty'] * ($row['purchase'] ?? 0);

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($this->dbValue["{$value}"])) {

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

        return $this->dbValue["{$value}"];

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

        }

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

                    $totalOrNet += $row['total'];

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 validate($value, string $columnName, bool $isUserFormat, $originalValue = null)

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

    {

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

    protected $columnName = 'marginp';

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

    protected $maximumLength = '99999999999999999999';

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

            }

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

                $subtraction = ($totalOrNet - $purchase);

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

            throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . ($columnName ?? $this->getColumnName()) . "||{$this->getModuleName()}||$value($originalValue)", 406);

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

    /** {@inheritdoc} */

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

        $quantity = static::getInstance($this->getModuleName(), 'Quantity')->getValueForSave($item, $userFormat);

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

    protected $colSpan = 15;

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

    /** {@inheritdoc} */

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

                    $totalOrNet += $row['net'];

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

    protected $defaultLabel = 'LBL_MARGIN_PERCENT';

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

        if (!\App\Validator::float($value)) {

Line exceeds 120 characters; contains 178 characters
Open

            throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . ($columnName ?? $this->getColumnName()) . "||{$this->getModuleName()}||$value($originalValue)", 406);

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

    protected $dbType = 'decimal(28,8) DEFAULT 0';

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

            foreach ($data as $row) {

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

                if (isset($row['net'])) {

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

            throw new \App\Exceptions\Security("ERR_VALUE_IS_TOO_LONG||$columnName||$value", 406);

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 $sum;

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

    /** {@inheritdoc} */

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

    }

Line exceeds 120 characters; contains 137 characters
Open

            $value = 100.0 * static::getInstance($this->getModuleName(), 'Margin')->getValueForSave($item, $userFormat) / $totalPurchase;

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

class Vtiger_MarginP_InventoryField extends Vtiger_Basic_InventoryField

There are no issues that match your filters.

Category
Status