Vtiger_Discount_InventoryField

Complexity

Total Complexity

31

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Test Coverage

Coverage

75.93%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getDiscountValueByType()	0	16	3
A	getDBValue()	0	6	3
A	compare()	0	3	2
A	getValueForSave()	0	16	6
B	validate()	0	17	9
A	getEditValue()	0	4	1
A	getDiscountValue()	0	15	4
A	getDisplayValue()	0	8	3

<?php

/**
 * Inventory Discount Field Class.
 *
 * @package   InventoryField
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>
 * @author    Radosław Skrzypczak <r.skrzypczak@yetiforce.com>
 */
class Vtiger_Discount_InventoryField extends Vtiger_Basic_InventoryField
{
	/** {@inheritdoc} */
	protected $type = 'Discount';
	/** {@inheritdoc} */
	protected $defaultLabel = 'LBL_DISCOUNT';
	/** {@inheritdoc} */
	protected $defaultValue = 0;
	/** {@inheritdoc} */
	protected $columnName = 'discount';
	/** {@inheritdoc} */
	protected $dbType = 'decimal(28,8) DEFAULT 0';
	/** {@inheritdoc} */
	protected $customColumn = [
		'discountparam' => 'string',
	];
	/** {@inheritdoc} */
	protected $summationValue = true;
	/** {@inheritdoc} */
	protected $maximumLength = '99999999999999999999';
	/** {@inheritdoc} */
	protected $customMaximumLength = [
		'discountparam' => 255,
	];
	/** {@inheritdoc} */
	protected $purifyType = \App\Purifier::NUMBER;
	/** {@inheritdoc} */
	protected $customPurifyType = [
		'discountparam' => App\Purifier::TEXT,
	];

	/** {@inheritdoc} */
	public function getDisplayValue($value, array $rowData = [], bool $rawText = false)
	{
		$value = \App\Fields\Double::formatToDisplay($value);
		if (isset($rowData['currency']) && $currencySymbol = \App\Fields\Currency::getById($rowData['currency'])['currency_symbol'] ?? '') {
			$value = \CurrencyField::appendCurrencySymbol($value, $currencySymbol);

$value of type string is incompatible with the type double|integer expected by parameter $currencyValue of CurrencyField::appendCurrencySymbol().

		}

		return $value;
	}

	/** {@inheritdoc} */
	public function getEditValue(array $itemData, string $column = '')
	{
		$value = parent::getEditValue($itemData, $column);
		return \App\Fields\Double::formatToDisplay($value, false);
	}

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

The property dbValue does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

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

	/** {@inheritdoc} */
	public function validate($value, string $columnName, bool $isUserFormat, $originalValue = null)
	{
		if ($columnName === $this->getColumnName()) {
			if ($isUserFormat) {
				$value = $this->getDBValue($value, $columnName);
				if (null !== $originalValue) {
					$originalValue = $this->getDBValue($originalValue, $columnName);
				}
			}
			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);
			}
		} elseif (App\TextUtils::getTextLength($value) > $this->customMaximumLength[$columnName]) {
			throw new \App\Exceptions\Security("ERR_VALUE_IS_TOO_LONG||$columnName||$value", 406);
		}
	}

	/** {@inheritdoc} */
	public function getValueForSave(array $item, bool $userFormat = false, string $column = null)
	{
		if ($column === $this->getColumnName() || null === $column) {
			$value = 0.0;
			if (!\App\Json::isEmpty($item['discountparam'] ?? '')) {
				$aggregation = $item['discount_aggreg'] ?? \Vtiger_Inventory_Model::getDiscountsConfig('aggregation');
				if (\is_numeric($aggregation)) {
					$discountParam = \App\Json::decode($item['discountparam']) ?? [];
					$totalPrice = static::getInstance($this->getModuleName(), 'TotalPrice')->getValueForSave($item, $userFormat);
					$value = $this->getDiscountValue($discountParam, $totalPrice, (int) $aggregation);
				}
			}
		} else {
			$value = $userFormat ? $this->getDBValue($item[$column]) : $item[$column];
		}
		return $value;
	}

	/**
	 * Calculate the discount value.
	 *
	 * @param array  $discountParam
	 * @param float  $totalPrice
	 * @param string $mode          0-can not be combined, 1-summary, 2-cascade
	 *
	 * @return float
	 */
	private function getDiscountValue(array $discountParam, float $totalPrice, int $mode): float
	{
		$value = $discountValue = 0.0;

The assignment to $discountValue is dead and can be removed.

		$types = $discountParam['aggregationType'] ?? [];
		if (!\is_array($types)) {
			$types = [$types];
		}
		foreach ($types as $type) {
			$discountValue = $this->getDiscountValueByType($type, $discountParam, $totalPrice);
			$value += $discountValue;
			if (2 === $mode) {
				$totalPrice -= $discountValue;
			}
		}
		return $value;
	}

	/**
	 * Gets the discount by type.
	 *
	 * @param string $aggregationType
	 * @param array  $discountParam
	 * @param float  $totalPrice
	 *
	 * @return float
	 */
	private function getDiscountValueByType(string $aggregationType, array $discountParam, float $totalPrice): float
	{
		$discountType = $discountParam["{$aggregationType}DiscountType"] ?? 'percentage';
		$discount = $discountParam["{$aggregationType}Discount"];
		$value = 0.0;
		switch ($discountType) {
			case 'amount':
				$value = $discount;
				break;
			case 'percentage':
				$value = $totalPrice * $discount / 100.00;
				break;
			default:
				throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||discountType||{$discountType}", 406);
		}
		return $value;
	}

	/** {@inheritdoc} */
	public function compare($value, $prevValue, string $column): bool
	{
		return $column === $this->getColumnName() ? \App\Validator::floatIsEqual((float) $value, (float) $prevValue, 8) : parent::compare($value, $prevValue, $column);
	}
}