App\Fields\Currency

Complexity

Total Complexity

29

Size/Duplication

Total Lines	230
Duplicated Lines	0 %

Test Coverage

Coverage

57.5%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getById()	0	4	1
A	getCurrencyByModule()	0	3	1
A	getAll()	0	16	5
A	getDefault()	0	8	3
A	formatToDisplay()	0	6	2
A	getIdByCode()	0	3	1
A	getCurrencyIdByName()	0	8	2
A	getSupported()	0	9	2
A	formatToDb()	0	11	3
A	clearCache()	0	4	1
A	addCurrency()	0	18	2
A	getActiveBankForExchangeRateUpdate()	0	12	3
A	getCurrencyRatesFromArchive()	0	12	3

<?php
/**
 * Tools for currency class.
 *
 * @package App
 *
 * @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>
 */

namespace App\Fields;

/**
 * Currency class.
 */
class Currency
{
	/**
	 * Function returns the currency in user specified format.
	 *
	 * @param string     $value          Date time
	 * @param mixed|null $user
	 * @param mixed      $skipConversion
	 * @param mixed      $skipFormatting
	 *
	 * @return string
	 */
	public static function formatToDisplay($value, $user = null, $skipConversion = false, $skipFormatting = false)
	{
		if (empty($value)) {
			return 0;
		}
		return \CurrencyField::convertToUserFormat($value, $user, $skipConversion, $skipFormatting);

The function CurrencyField::convertToUserFormat() has been deprecated: Recommend using function \App\Fields\Currency::formatToDisplay

	}

	/**
	 * Function to get value for db format.
	 *
	 * @param string $value
	 *
	 * @return float
	 */
	public static function formatToDb(string $value): ?float
	{
		if (empty($value)) {
			return 0;
		}
		$currentUser = \App\User::getCurrentUserModel();
		$value = str_replace([$currentUser->getDetail('currency_grouping_separator'), $currentUser->getDetail('currency_decimal_separator'), ' '], ['', '.', ''], $value);
		if (!\is_numeric($value)) {
			return null;
		}
		return $value;

The expression return $value returns the type string which is incompatible with the type-hinted return double|null.

	}

	/**
	 * Get currency by module name.
	 *
	 * @param int    $record
	 * @param string $moduleName
	 *
	 * @return int
	 */
	public static function getCurrencyByModule(int $record, string $moduleName)
	{
		return \Vtiger_Record_Model::getInstanceById($record, $moduleName)->get('currency_id');
	}

	/**
	 * Get currency id by name.
	 *
	 * @param type $currencyName

The type App\Fields\type was not found. Maybe you did not declare it correctly or list all dependencies?

	 *
	 * @return type
	 */
	public static function getCurrencyIdByName($currencyName)
	{
		$currencyId = 1;
		$row = (new \App\Db\Query())->select(['id'])->from('vtiger_currency_info')->where(['currency_name' => $currencyName, 'deleted' => 0])->scalar();
		if ($row) {
			$currencyId = $row;
		}
		return $currencyId;

The expression return $currencyId returns the type integer|string which is incompatible with the documented return type App\Fields\type.

	}

	/**
	 * Get currency by code.
	 *
	 * @param string $code
	 * @param bool   $active
	 *
	 * @return int|null
	 */
	public static function getIdByCode(string $code, bool $active = true): ?int
	{
		return array_column(static::getAll($active), 'id', 'currency_code')[\strtoupper($code)] ?? null;
	}

	/**
	 * Get all currencies.
	 *
	 * @param bool $onlyActive
	 *
	 * @return array
	 */
	public static function getAll($onlyActive = false)
	{
		if (\App\Cache::has('CurrencyGetAll', 'All')) {
			$currencies = \App\Cache::get('CurrencyGetAll', 'All');
		} else {
			$currencies = (new \App\Db\Query())->from('vtiger_currency_info')->where(['deleted' => 0])->indexBy('id')->all();
			\App\Cache::save('CurrencyGetAll', 'All', $currencies);
		}
		if ($onlyActive) {
			foreach ($currencies as $id => $currency) {
				if ('Active' !== $currency['currency_status']) {
					unset($currencies[$id]);
				}
			}
		}
		return $currencies;
	}

	/**
	 * Get supported currencies.
	 *
	 * @return array
	 */
	public static function getSupported(): array
	{
		if (\App\Cache::has('CurrencySupported', 'All')) {
			$currencies = \App\Cache::get('CurrencySupported', 'All');
		} else {
			$currencies = (new \App\Db\Query())->from('vtiger_currencies')->indexBy('currency_code')->all();
			\App\Cache::save('CurrencySupported', 'All', $currencies);
		}
		return $currencies;
	}

	/**
	 * Get currency by id.
	 *
	 * @param int $currencyId
	 *
	 * @return array
	 */
	public static function getById(int $currencyId)
	{
		$currencyInfo = static::getAll();
		return $currencyInfo[$currencyId] ?? [];
	}

	/**
	 * Get current default currency data.
	 *
	 * @return array|bool
	 */
	public static function getDefault()
	{
		foreach (self::getAll(true) as $currency) {
			if (-11 === (int) $currency['defaultid']) {
				return $currency;
			}
		}
		return false;
	}

	/**
	 * Function clears cache.
	 *
	 * @return void
	 */
	public static function clearCache(): void
	{
		\App\Cache::delete('CurrencyGetAll', 'All');
		\App\Cache::delete('CurrencySupported', 'All');
	}

	/**
	 * Add the currency by code.
	 *
	 * @param string $code
	 *
	 * @return int|null
	 */
	public static function addCurrency(string $code): ?int
	{
		$supported = self::getSupported();
		if (empty($supported[$code])) {
			\App\Log::error('No currency code to add found: ' . $code);
			return null;
		}
		$db = \App\Db::getInstance();
		$db->createCommand()
			->insert('vtiger_currency_info', [
				'currency_name' => $supported[$code]['currency_name'],
				'currency_code' => $code,
				'currency_symbol' => $supported[$code]['currency_symbol'],
				'conversion_rate' => 1,
				'currency_status' => 'Active',
			])->execute();
		self::clearCache();
		return $db->getLastInsertID('vtiger_currency_info_id_seq');

The expression return $db->getLastInsertID('vtiger_currency_info_id_seq') returns the type string which is incompatible with the type-hinted return integer|null.

	}

	/**
	 * Gets currency exchange rates from archive.
	 *
	 * @param string   $date
	 * @param int      $currencyId
	 * @param int|null $activeBankId
	 *
	 * @return array
	 */
	public static function getCurrencyRatesFromArchive(string $date, int $currencyId, ?int $activeBankId = null): array
	{
		if (null === $activeBankId) {
			$activeBankId = self::getActiveBankForExchangeRateUpdate()['id'] ?? 0;
		}

		return (new \App\Db\Query())->from('yetiforce_currencyupdate')
			->innerJoin('vtiger_currency_info', 'vtiger_currency_info.id = yetiforce_currencyupdate.currency_id AND deleted = :del', [':del' => 0])
			->where(['yetiforce_currencyupdate.exchange_date' => $date,
				'yetiforce_currencyupdate.bank_id' => $activeBankId,
				'vtiger_currency_info.id' => $currencyId])
			->one() ?: [];
	}

	/**
	 * Gets bank for exchange rate update.
	 *
	 * @return array
	 */
	public static function getActiveBankForExchangeRateUpdate(): array
	{
		$cacheName = 'ActiveBankForExchangeRate';
		$activeBank = [];
		if (\App\Cache::has($cacheName, '')) {
			$activeBank = \App\Cache::get($cacheName, '');
		} else {
			$activeBank = (new \App\Db\Query())->from('yetiforce_currencyupdate_banks')->where(['active' => 1])->one() ?: [];
			\App\Cache::save($cacheName, '', $activeBank);
		}

		return $activeBank;
	}
}