YetiForceCompany/YetiForceCRM

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

Summary

Maintainability
C
7 hrs
Test Coverage
F
33%
<?php

/**
 * Inventory Margin Field Class.
 *
 * @package   InventoryField
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>
 * @author    Radosław Skrzypczak <r.skrzypczak@yetiforce.com>
 */
class Vtiger_Margin_InventoryField extends Vtiger_Basic_InventoryField
{
    protected $type = 'Margin';
    protected $defaultLabel = 'LBL_MARGIN';
    protected $defaultValue = 0;
    protected $columnName = 'margin';
    protected $dbType = 'decimal(28,8) DEFAULT 0';
    protected $summationValue = true;
    protected $maximumLength = '99999999999999999999';
    protected $purifyType = \App\Purifier::NUMBER;

    /** {@inheritdoc} */
    public function getDisplayValue($value, array $rowData = [], bool $rawText = false)
    {
        return \App\Fields\Double::formatToDisplay($value);
    }

    /** {@inheritdoc} */
    public function getEditValue($value)
    {
        return \App\Fields\Double::formatToDisplay($value, false);
    }

    /** {@inheritdoc} */
    public function getDBValue($value, ?string $name = '')
    {
        if (!isset($this->dbValue["{$value}"])) {
            $this->dbValue["{$value}"] = App\Fields\Double::formatToDb($value);
        }
        return $this->dbValue["{$value}"];
    }

    /** {@inheritdoc} */
    public function validate($value, string $columnName, bool $isUserFormat, $originalValue = null)
    {
        if ($isUserFormat) {
            $value = $this->getDBValue($value, $columnName);
            if (null !== $originalValue) {
                $originalValue = $this->getDBValue($originalValue, $columnName);
            }
        }
        if (!is_numeric($value)) {
            throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||$columnName||$value", 406);
        }
        if ($this->maximumLength < $value || -$this->maximumLength > $value) {
            throw new \App\Exceptions\Security("ERR_VALUE_IS_TOO_LONG||$columnName||$value", 406);
        }
        if (null !== $originalValue && !\App\Validator::floatIsEqualUserCurrencyDecimals($value, $originalValue)) {
            throw new \App\Exceptions\Security('ERR_ILLEGAL_FIELD_VALUE||' . ($columnName ?? $this->getColumnName()) . "||{$this->getModuleName()}||$value($originalValue)", 406);
        }
    }

    /** {@inheritdoc} */
    public function getValueForSave(array $item, bool $userFormat = false, string $column = null)
    {
        $quantity = static::getInstance($this->getModuleName(), 'Quantity')->getValueForSave($item, $userFormat);
        $purchase = static::getInstance($this->getModuleName(), 'Purchase')->getValueForSave($item, $userFormat);
        $netPrice = static::getInstance($this->getModuleName(), 'NetPrice')->getValueForSave($item, $userFormat);
        return $netPrice - ($purchase * $quantity);
    }
}