Format Class Reference

Inheritance diagram for Format:

Public Member Functions
	__construct (\Magento\Framework\App\ScopeResolverInterface $scopeResolver, \Magento\Framework\Locale\ResolverInterface $localeResolver, \Magento\Directory\Model\CurrencyFactory $currencyFactory)
	getNumber ($value)
	getPriceFormat ($localeCode=null, $currencyCode=null)
Public Member Functions inherited from FormatInterface
	getPriceFormat ()

Protected Attributes
	$_scopeResolver
	$_localeResolver
	$currencyFactory

Detailed Description

Definition at line 8 of file Format.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\ScopeResolverInterface	$scopeResolver,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
		\Magento\Directory\Model\CurrencyFactory	$currencyFactory
	)

Parameters

\Magento\Framework\App\ScopeResolverInterface	$scopeResolver
ResolverInterface	$localeResolver
\Magento\Directory\Model\CurrencyFactory	$currencyFactory

Definition at line 30 of file Format.php.

      {
        $this->_scopeResolver = $scopeResolver;
        $this->_localeResolver = $localeResolver;
        $this->currencyFactory = $currencyFactory;
    }

Member Function Documentation

getNumber()

getNumber

(

$value

)

Returns the first found number from a string Parsing depends on given locale (grouping and decimal)

Examples for input: ' 2345.4356,1234' = 23455456.1234 '+23,3452.123' = 233452.123 ' 12343 ' = 12343 '-9456km' = -9456 '0' = 0 '2 054,10' = 2054.1 '2'054.52' = 2054.52 '2,46 GB' = 2.46

Parameters

string | float | int

$value

Returns

float|null

Implements FormatInterface.

Definition at line 57 of file Format.php.

    {
        if ($value === null) {
            return null;
        }

        if (!is_string($value)) {
            return (float)$value;
        }

        //trim spaces and apostrophes
        $value = preg_replace('/[^0-9^\^.,-]/m', '', $value);

        $separatorComa = strpos($value, ',');
        $separatorDot = strpos($value, '.');

        if ($separatorComa !== false && $separatorDot !== false) {
            if ($separatorComa > $separatorDot) {
                $value = str_replace(['.', ','], ['', '.'], $value);
            } else {
                $value = str_replace(',', '', $value);
            }
        } elseif ($separatorComa !== false) {
            $value = str_replace(',', '.', $value);
        }

        return (float)$value;
    }

getPriceFormat()

getPriceFormat	(		$localeCode = null,
			$currencyCode = null
	)

Returns an array with price formatting info

Parameters

string	$localeCode	Locale code.
string	$currencyCode	Currency code.

Returns

array

Definition at line 93 of file Format.php.

    {
        $localeCode = $localeCode ?: $this->_localeResolver->getLocale();
        if ($currencyCode) {
            $currency = $this->currencyFactory->create()->load($currencyCode);
        } else {
            $currency = $this->_scopeResolver->getScope()->getCurrentCurrency();
        }

        $formatter = new \NumberFormatter(
            $localeCode . '@currency=' . $currency->getCode(),
            \NumberFormatter::CURRENCY
        );
        $format = $formatter->getPattern();
        $decimalSymbol = $formatter->getSymbol(\NumberFormatter::DECIMAL_SEPARATOR_SYMBOL);
        $groupSymbol = $formatter->getSymbol(\NumberFormatter::GROUPING_SEPARATOR_SYMBOL);

        $pos = strpos($format, ';');
        if ($pos !== false) {
            $format = substr($format, 0, $pos);
        }
        $format = preg_replace("/[^0\#\.,]/", '', $format);
        $totalPrecision = 0;
        $decimalPoint = strpos($format, '.');
        if ($decimalPoint !== false) {
            $totalPrecision = strlen($format) - (strrpos($format, '.') + 1);
        } else {
            $decimalPoint = strlen($format);
        }
        $requiredPrecision = $totalPrecision;
        $t = substr($format, $decimalPoint);
        $pos = strpos($t, '#');
        if ($pos !== false) {
            $requiredPrecision = strlen($t) - $pos - $totalPrecision;
        }

        if (strrpos($format, ',') !== false) {
            $group = $decimalPoint - strrpos($format, ',') - 1;
        } else {
            $group = strrpos($format, '.');
        }

        $result = [
            //TODO: change interface
            'pattern' => $currency->getOutputFormat(),
            'precision' => $totalPrecision,
            'requiredPrecision' => $requiredPrecision,
            'decimalSymbol' => $decimalSymbol,
            'groupSymbol' => $groupSymbol,
            'groupLength' => $group,
            'integerRequired' => $totalPrecision == 0,
        ];

        return $result;
    }

Field Documentation

$_localeResolver

$_localeResolver

protected

Definition at line 18 of file Format.php.

$_scopeResolver

$_scopeResolver

protected

Definition at line 13 of file Format.php.

$currencyFactory

$currencyFactory

protected

Definition at line 23 of file Format.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Locale/Format.php