0 follower

Class yii\i18n\Formatter

All Classes | Properties | Methods | Constants
Inheritanceyii\i18n\Formatter » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/i18n/Formatter.php

Formatter provides a set of commonly used data formatting methods.

The formatting methods provided by Formatter are all named in the form of asXyz(). The behavior of some of them may be configured via the properties of Formatter. For example, by configuring $dateFormat, one may control how asDate() formats the value into a date string.

Formatter is configured as an application component in yii\base\Application by default. You can access that instance via Yii::$app->formatter.

The Formatter class is designed to format values according to a $locale. For this feature to work the PHP intl extension has to be installed. Most of the methods however work also if the PHP intl extension is not installed by providing a fallback implementation. Without intl month and day names are in English only. Note that even if the intl extension is installed, formatting date and time values for years >=2038 or <=1901 on 32bit systems will fall back to the PHP implementation because intl uses a 32bit UNIX timestamp internally. On a 64bit system the intl formatter is used in all cases if installed.

Note: The Formatter class is meant to be used for formatting values for display to users in different languages and time zones. If you need to format a date or time in machine readable format, use the PHP date() function instead.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$baseUnits array The base units that are used as multipliers for smallest possible unit from $measureUnits. yii\i18n\Formatter
$behaviors yii\base\Behavior[] List of behaviors attached to this component. This property is read-only. yii\base\Component
$booleanFormat array The text to be displayed when formatting a boolean value. yii\i18n\Formatter
$calendar IntlCalendar|integer|null The calendar to be used for date formatting. yii\i18n\Formatter
$currencyCode string The 3-letter ISO 4217 currency code indicating the default currency to use for asCurrency(). yii\i18n\Formatter
$currencyDecimalSeparator string The character displayed as the decimal point when formatting a currency. yii\i18n\Formatter
$dateFormat string The default format string to be used to format a date. yii\i18n\Formatter
$datetimeFormat string The default format string to be used to format a date and time. yii\i18n\Formatter
$decimalSeparator string The character displayed as the decimal point when formatting a number. yii\i18n\Formatter
$defaultTimeZone string The time zone that is assumed for input values if they do not include a time zone explicitly. yii\i18n\Formatter
$language string The language code (e.g. en-US, en) that is used to translate internal messages. yii\i18n\Formatter
$locale string The locale ID that is used to localize the date and number formatting. yii\i18n\Formatter
$measureUnits array Configuration of weight and length measurement units. yii\i18n\Formatter
$nullDisplay string The text to be displayed when formatting a null value. yii\i18n\Formatter
$numberFormatterOptions array A list of name value pairs that are passed to the intl [NumberFormatter::setAttribute()](https://secure. yii\i18n\Formatter
$numberFormatterSymbols array A list of name value pairs that are passed to the intl [NumberFormatter::setSymbol()](https://secure. yii\i18n\Formatter
$numberFormatterTextOptions array A list of name value pairs that are passed to the intl [NumberFormatter::setTextAttribute()](https://secure. yii\i18n\Formatter
$sizeFormatBase integer The base at which a kilobyte is calculated (1000 or 1024 bytes per kilobyte), used by asSize() and asShortSize(). yii\i18n\Formatter
$systemOfUnits string Default system of measure units. yii\i18n\Formatter
$thousandSeparator string The character displayed as the thousands separator (also called grouping separator) character when formatting a number. yii\i18n\Formatter
$timeFormat string The default format string to be used to format a time. yii\i18n\Formatter
$timeZone string The time zone to use for formatting time and date values. yii\i18n\Formatter

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
asBoolean() Formats the value as a boolean. yii\i18n\Formatter
asCurrency() Formats the value as a currency number. yii\i18n\Formatter
asDate() Formats the value as a date. yii\i18n\Formatter
asDatetime() Formats the value as a datetime. yii\i18n\Formatter
asDecimal() Formats the value as a decimal number. yii\i18n\Formatter
asDuration() Represents the value as duration in human readable format. yii\i18n\Formatter
asEmail() Formats the value as a mailto link. yii\i18n\Formatter
asHtml() Formats the value as HTML text. yii\i18n\Formatter
asImage() Formats the value as an image tag. yii\i18n\Formatter
asInteger() Formats the value as an integer number by removing any decimal digits without rounding. yii\i18n\Formatter
asLength() Formats the value as a length in human readable form for example 12 meters. yii\i18n\Formatter
asNtext() Formats the value as an HTML-encoded plain text with newlines converted into breaks. yii\i18n\Formatter
asOrdinal() Formats the value as a ordinal value of a number. yii\i18n\Formatter
asParagraphs() Formats the value as HTML-encoded text paragraphs. yii\i18n\Formatter
asPercent() Formats the value as a percent number with "%" sign. yii\i18n\Formatter
asRaw() Formats the value as is without any formatting. yii\i18n\Formatter
asRelativeTime() Formats the value as the time interval between a date and now in human readable form. yii\i18n\Formatter
asScientific() Formats the value as a scientific number. yii\i18n\Formatter
asShortLength() Formats the value as a length in human readable form for example 12 m. yii\i18n\Formatter
asShortSize() Formats the value in bytes as a size in human readable form for example 12 kB. yii\i18n\Formatter
asShortWeight() Formats the value as a weight in human readable form for example 12 kg. yii\i18n\Formatter
asSize() Formats the value in bytes as a size in human readable form, for example 12 kilobytes. yii\i18n\Formatter
asSpellout() Formats the value as a number spellout. yii\i18n\Formatter
asText() Formats the value as an HTML-encoded plain text. yii\i18n\Formatter
asTime() Formats the value as a time. yii\i18n\Formatter
asTimestamp() Formats a date, time or datetime in a float number as UNIX timestamp (seconds since 01-01-1970). yii\i18n\Formatter
asUrl() Formats the value as a hyperlink. yii\i18n\Formatter
asWeight() Formats the value as a weight in human readable form for example 12 kilograms. yii\i18n\Formatter
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
format() Formats the value based on the given format type. yii\i18n\Formatter
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\i18n\Formatter
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
asCurrencyStringFallback() Fallback for formatting value as a currency number. yii\i18n\Formatter
asDecimalStringFallback() Fallback for formatting value as a decimal number. yii\i18n\Formatter
asIntegerStringFallback() Fallback for formatting value as an integer number by removing any decimal digits without rounding. yii\i18n\Formatter
asPercentStringFallback() Fallback for formatting value as a percent number with "%" sign. yii\i18n\Formatter
createNumberFormatter() Creates a number formatter based on the given type and format. yii\i18n\Formatter
formatNumber() Given the value in bytes formats number part of the human readable form. yii\i18n\Formatter
isNormalizedValueMispresented() Checks if string representations of given value and its normalized version are different. yii\i18n\Formatter
normalizeDatetimeValue() Normalizes the given datetime value as a DateTime object that can be taken by various date/time formatting methods. yii\i18n\Formatter
normalizeNumericStringValue() Normalizes a numeric string value. yii\i18n\Formatter
normalizeNumericValue() Normalizes a numeric input value. yii\i18n\Formatter

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
FORMAT_WIDTH_LONG 'long' yii\i18n\Formatter
FORMAT_WIDTH_SHORT 'short' yii\i18n\Formatter
UNIT_LENGTH 'length' yii\i18n\Formatter
UNIT_SYSTEM_IMPERIAL 'imperial' yii\i18n\Formatter
UNIT_SYSTEM_METRIC 'metric' yii\i18n\Formatter
UNIT_WEIGHT 'mass' yii\i18n\Formatter

Property Details

$baseUnits public property (available since version 2.0.13)

The base units that are used as multipliers for smallest possible unit from $measureUnits.

public array $baseUnits = [self::UNIT_LENGTH => [self::UNIT_SYSTEM_IMPERIAL => 12, self::UNIT_SYSTEM_METRIC => 1000], self::UNIT_WEIGHT => [self::UNIT_SYSTEM_IMPERIAL => 7000, self::UNIT_SYSTEM_METRIC => 1000]]
$booleanFormat public property

The text to be displayed when formatting a boolean value. The first element corresponds to the text displayed for false, the second element for true. Defaults to ['No', 'Yes'], where Yes and No will be translated according to $locale.

public array $booleanFormat = null
$calendar public property (available since version 2.0.7)

The calendar to be used for date formatting. The value of this property will be directly passed to the constructor of the IntlDateFormatter class.

Defaults to null, which means the Gregorian calendar will be used. You may also explicitly pass the constant \IntlDateFormatter::GREGORIAN for Gregorian calendar.

To use an alternative calendar like for example the Jalali calendar, set this property to \IntlDateFormatter::TRADITIONAL. The calendar must then be specified in the $locale, for example for the persian calendar the configuration for the formatter would be:

'formatter' => [
    'locale' => 'fa_IR@calendar=persian',
    'calendar' => \IntlDateFormatter::TRADITIONAL,
],

Available calendar names can be found in the ICU manual.

Since PHP 5.5 you may also use an instance of the IntlCalendar class. Check the PHP manual for more details.

If the PHP intl extension is not available, setting this property will have no effect.

See also:

public IntlCalendar|integer|null $calendar = null
$currencyCode public property

The 3-letter ISO 4217 currency code indicating the default currency to use for asCurrency(). If not set, the currency code corresponding to $locale will be used. Note that in this case the $locale has to be specified with a country code, e.g. en-US otherwise it is not possible to determine the default currency.

public string $currencyCode = null
$currencyDecimalSeparator public property (available since version 2.0.35)

The character displayed as the decimal point when formatting a currency. If not set, the currency decimal separator corresponding to $locale will be used. If PHP intl extension is not available, setting this property will have no effect.

public string $currencyDecimalSeparator = null
$dateFormat public property

The default format string to be used to format a date. This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.

It can also be a custom format as specified in the ICU manual. Alternatively this can be a string prefixed with php: representing a format that can be recognized by the PHP date()-function.

For example:

'MM/dd/yyyy' // date in ICU format
'php:m/d/Y' // the same date in PHP format
public string $dateFormat = 'medium'
$datetimeFormat public property

The default format string to be used to format a date and time. This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.

It can also be a custom format as specified in the ICU manual.

Alternatively this can be a string prefixed with php: representing a format that can be recognized by the PHP date()-function.

For example:

'MM/dd/yyyy HH:mm:ss' // date and time in ICU format
'php:m/d/Y H:i:s' // the same date and time in PHP format
public string $datetimeFormat = 'medium'
$decimalSeparator public property

The character displayed as the decimal point when formatting a number. If not set, the decimal separator corresponding to $locale will be used. If PHP intl extension is not available, the default value is '.'.

public string $decimalSeparator = null
$defaultTimeZone public property (available since version 2.0.1)

The time zone that is assumed for input values if they do not include a time zone explicitly.

The value must be a valid time zone identifier, e.g. UTC, Europe/Berlin or America/Chicago. Please refer to the php manual for available time zones.

It defaults to UTC so you only have to adjust this value if you store datetime values in another time zone in your database.

Note that a UNIX timestamp is always in UTC by its definition. That means that specifying a default time zone different from UTC has no effect on date values given as UNIX timestamp.

public string $defaultTimeZone = 'UTC'
$language public property (available since version 2.0.28)

The language code (e.g. en-US, en) that is used to translate internal messages. If not set, $locale will be used (without the @calendar param, if included).

public string $language = null
$locale public property

The locale ID that is used to localize the date and number formatting. For number and date formatting this is only effective when the PHP intl extension is installed. If not set, yii\base\Application::$language will be used.

public string $locale = null
$measureUnits public property (available since version 2.0.13)

Configuration of weight and length measurement units. This array contains the most usable measurement units, but you can change it in case you have some special requirements.

For example, you can add smaller measure unit:

$this->measureUnits[self::UNIT_LENGTH][self::UNIT_SYSTEM_METRIC] = [
    'nanometer' => 0.000001
]

See also:

public array $measureUnits = [self::UNIT_LENGTH => [self::UNIT_SYSTEM_IMPERIAL => ['inch' => 1, 'foot' => 12, 'yard' => 36, 'chain' => 792, 'furlong' => 7920, 'mile' => 63360], self::UNIT_SYSTEM_METRIC => ['millimeter' => 1, 'centimeter' => 10, 'meter' => 1000, 'kilometer' => 1000000]], self::UNIT_WEIGHT => [self::UNIT_SYSTEM_IMPERIAL => ['grain' => 1, 'drachm' => 27.34375, 'ounce' => 437.5, 'pound' => 7000, 'stone' => 98000, 'quarter' => 196000, 'hundredweight' => 784000, 'ton' => 15680000], self::UNIT_SYSTEM_METRIC => ['gram' => 1, 'kilogram' => 1000, 'ton' => 1000000]]]
$nullDisplay public property

The text to be displayed when formatting a null value. Defaults to '<span class="not-set">(not set)</span>', where (not set) will be translated according to $locale.

public string $nullDisplay = null
$numberFormatterOptions public property

A list of name value pairs that are passed to the intl NumberFormatter::setAttribute() method of all the number formatter objects created by createNumberFormatter(). This property takes only effect if the PHP intl extension is installed.

Please refer to the PHP manual for the possible options.

For example to adjust the maximum and minimum value of fraction digits you can configure this property like the following:

[
    NumberFormatter::MIN_FRACTION_DIGITS => 0,
    NumberFormatter::MAX_FRACTION_DIGITS => 2,
]
public array $numberFormatterOptions = []
$numberFormatterSymbols public property (available since version 2.0.4)

A list of name value pairs that are passed to the intl NumberFormatter::setSymbol() method of all the number formatter objects created by createNumberFormatter(). This property takes only effect if the PHP intl extension is installed.

Please refer to the PHP manual for the possible options.

For example to choose a custom currency symbol, e.g. U+20BD instead of руб. for Russian Ruble:

[
    NumberFormatter::CURRENCY_SYMBOL => '₽',
]
public array $numberFormatterSymbols = []
$numberFormatterTextOptions public property

A list of name value pairs that are passed to the intl NumberFormatter::setTextAttribute() method of all the number formatter objects created by createNumberFormatter(). This property takes only effect if the PHP intl extension is installed.

Please refer to the PHP manual for the possible options.

For example to change the minus sign for negative numbers you can configure this property like the following:

[
    NumberFormatter::NEGATIVE_PREFIX => 'MINUS',
]
public array $numberFormatterTextOptions = []
$sizeFormatBase public property

The base at which a kilobyte is calculated (1000 or 1024 bytes per kilobyte), used by asSize() and asShortSize(). Defaults to 1024.

public integer $sizeFormatBase = 1024
$systemOfUnits public property (available since version 2.0.13)

Default system of measure units. Defaults to UNIT_SYSTEM_METRIC. Possible values:

See also:

public string $systemOfUnits = self::UNIT_SYSTEM_METRIC
$thousandSeparator public property

The character displayed as the thousands separator (also called grouping separator) character when formatting a number. If not set, the thousand separator corresponding to $locale will be used. If PHP intl extension is not available, the default value is ','.

public string $thousandSeparator = null
$timeFormat public property

The default format string to be used to format a time. This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.

It can also be a custom format as specified in the ICU manual. Alternatively this can be a string prefixed with php: representing a format that can be recognized by the PHP date()-function.

For example:

'HH:mm:ss' // time in ICU format
'php:H:i:s' // the same time in PHP format
public string $timeFormat = 'medium'
$timeZone public property

The time zone to use for formatting time and date values.

This can be any value that may be passed to date_default_timezone_set() e.g. UTC, Europe/Berlin or America/Chicago. Refer to the php manual for available time zones. If this property is not set, yii\base\Application::$timeZone will be used.

Note that the default time zone for input data is assumed to be UTC by default if no time zone is included in the input date value. If you store your data in a different time zone in the database, you have to adjust $defaultTimeZone accordingly.

public string $timeZone = null

Method Details

asBoolean() public method

Formats the value as a boolean.

See also $booleanFormat.

public string asBoolean ( $value )
$value mixed

The value to be formatted.
return string

The formatted result.
asCurrency() public method

Formats the value as a currency number.

This function does not require the PHP intl extension to be installed to work, but it is highly recommended to install it to get good formatting results.

Since 2.0.16 numbers that are mispresented after normalization are formatted as strings using fallback function without PHP intl extension support. For very big numbers it's recommended to pass them as strings and not use scientific notation otherwise the output might be wrong.

public string asCurrency ( $value, $currency = null, $options = [], $textOptions = [] )
$value mixed

The value to be formatted.
$currency string|null

The 3-letter ISO 4217 currency code indicating the currency to use. If null, $currencyCode will be used.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
throws yii\base\InvalidConfigException

if no currency is given and $currencyCode is not defined.
asCurrencyStringFallback() protected method (available since version 2.0.16)

Fallback for formatting value as a currency number.

protected string asCurrencyStringFallback ( $value, $currency = null )
$value string|integer|float

The value to be formatted.
$currency string|null

The 3-letter ISO 4217 currency code indicating the currency to use. If null, $currencyCode will be used.
return string

The formatted result.
throws yii\base\InvalidConfigException

if no currency is given and $currencyCode is not defined.
asDate() public method

Formats the value as a date.

See also $dateFormat.

public string asDate ( $value, $format = null )
$value integer|string|DateTime|DateTimeInterface

The value to be formatted. The following types of value are supported:

  • an integer representing a UNIX timestamp. A UNIX timestamp is always in UTC by its definition.
  • a string that can be parsed to create a DateTime object. The timestamp is assumed to be in $defaultTimeZone unless a time zone is explicitly given.
  • a PHP DateTime object. You may set the time zone for the DateTime object to specify the source time zone.

The formatter will convert date values according to $timeZone before formatting it. If no timezone conversion should be performed, you need to set $defaultTimeZone and $timeZone to the same value. Also no conversion will be performed on values that have no time information, e.g. "2017-06-05".
$format string|null

The format used to convert the value into a date string. If null, $dateFormat will be used.

This can be "short", "medium", "long", or "full", which represents a preset format of different lengths. It can also be a custom format as specified in the ICU manual.

Alternatively this can be a string prefixed with php: representing a format that can be recognized by the PHP date()-function.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value can not be evaluated as a date value.
throws yii\base\InvalidConfigException

if the date format is invalid.
asDatetime() public method

Formats the value as a datetime.

See also $datetimeFormat.

public string asDatetime ( $value, $format = null )
$value integer|string|DateTime|DateTimeInterface

The value to be formatted. The following types of value are supported:

  • an integer representing a UNIX timestamp. A UNIX timestamp is always in UTC by its definition.
  • a string that can be parsed to create a DateTime object. The timestamp is assumed to be in $defaultTimeZone unless a time zone is explicitly given.
  • a PHP DateTime object. You may set the time zone for the DateTime object to specify the source time zone.

The formatter will convert date values according to $timeZone before formatting it. If no timezone conversion should be performed, you need to set $defaultTimeZone and $timeZone to the same value.
$format string|null

The format used to convert the value into a date string. If null, $datetimeFormat will be used.

This can be "short", "medium", "long", or "full", which represents a preset format of different lengths. It can also be a custom format as specified in the ICU manual.

Alternatively this can be a string prefixed with php: representing a format that can be recognized by the PHP date()-function.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value can not be evaluated as a date value.
throws yii\base\InvalidConfigException

if the date format is invalid.
asDecimal() public method

Formats the value as a decimal number.

Property $decimalSeparator will be used to represent the decimal point. The value is rounded automatically to the defined decimal digits.

Since 2.0.16 numbers that are mispresented after normalization are formatted as strings using fallback function without PHP intl extension support. For very big numbers it's recommended to pass them as strings and not use scientific notation otherwise the output might be wrong.

See also:

public string asDecimal ( $value, $decimals = null, $options = [], $textOptions = [] )
$value mixed

The value to be formatted.
$decimals integer|null

The number of digits after the decimal point. If not given, the number of digits depends in the input value and is determined based on NumberFormatter::MIN_FRACTION_DIGITS and NumberFormatter::MAX_FRACTION_DIGITS, which can be configured using $numberFormatterOptions. If the PHP intl extension is not available, the default value is 2. If you want consistent behavior between environments where intl is available and not, you should explicitly specify a value here.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
asDecimalStringFallback() protected method (available since version 2.0.16)

Fallback for formatting value as a decimal number.

Property $decimalSeparator will be used to represent the decimal point. The value is rounded automatically to the defined decimal digits.

See also:

protected string asDecimalStringFallback ( $value, $decimals = 2 )
$value string|integer|float

The value to be formatted.
$decimals integer

The number of digits after the decimal point. The default value is 2.
return string

The formatted result.
asDuration() public method (available since version 2.0.7)

Represents the value as duration in human readable format.

public string asDuration ( $value, $implodeString = ', ', $negativeSign = '-' )
$value DateInterval|string|integer

The value to be formatted. Acceptable formats:

  • DateInterval object
  • integer - number of seconds. For example: value 131 represents 2 minutes, 11 seconds
  • ISO8601 duration format. For example, all of these values represent 1 day, 2 hours, 30 minutes duration: 2015-01-01T13:00:00Z/2015-01-02T13:30:00Z - between two datetime values 2015-01-01T13:00:00Z/P1D2H30M - time interval after datetime value P1D2H30M/2015-01-02T13:30:00Z - time interval before datetime value P1D2H30M - simply a date interval P-1D2H30M - a negative date interval (-1 day, 2 hours, 30 minutes)
$implodeString string

Will be used to concatenate duration parts. Defaults to , .
$negativeSign string

Will be prefixed to the formatted duration, when it is negative. Defaults to -.
return string

The formatted duration.
asEmail() public method

Formats the value as a mailto link.

public string asEmail ( $value, $options = [] )
$value string

The value to be formatted.
$options array

The tag options in terms of name-value pairs. See yii\helpers\Html::mailto().
return string

The formatted result.
asHtml() public method

Formats the value as HTML text.

The value will be purified using yii\helpers\HtmlPurifier to avoid XSS attacks. Use asRaw() if you do not want any purification of the value.

public string asHtml ( $value, $config = null )
$value string

The value to be formatted.
$config array|null

The configuration for the HTMLPurifier class.
return string

The formatted result.
asImage() public method

Formats the value as an image tag.

public string asImage ( $value, $options = [] )
$value mixed

The value to be formatted.
$options array

The tag options in terms of name-value pairs. See yii\helpers\Html::img().
return string

The formatted result.
asInteger() public method

Formats the value as an integer number by removing any decimal digits without rounding.

Since 2.0.16 numbers that are mispresented after normalization are formatted as strings using fallback function without PHP intl extension support. For very big numbers it's recommended to pass them as strings and not use scientific notation otherwise the output might be wrong.

public string asInteger ( $value, $options = [], $textOptions = [] )
$value mixed

The value to be formatted.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
asIntegerStringFallback() protected method (available since version 2.0.16)

Fallback for formatting value as an integer number by removing any decimal digits without rounding.

protected string asIntegerStringFallback ( $value )
$value string|integer|float

The value to be formatted.
return string

The formatted result.
asLength() public method (available since version 2.0.13)

Formats the value as a length in human readable form for example 12 meters.

Check properties $baseUnits if you need to change unit of value as the multiplier of the smallest unit and $systemOfUnits to switch between UNIT_SYSTEM_METRIC or UNIT_SYSTEM_IMPERIAL.

See also asLength().

public string asLength ( $value, $decimals = null, $numberOptions = [], $textOptions = [] )
$value float|integer

Value to be formatted.
$decimals integer|null

The number of digits after the decimal point.
$numberOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
throws yii\base\InvalidConfigException

when INTL is not installed or does not contain required information.
asNtext() public method

Formats the value as an HTML-encoded plain text with newlines converted into breaks.

public string asNtext ( $value )
$value string

The value to be formatted.
return string

The formatted result.
asOrdinal() public method

Formats the value as a ordinal value of a number.

This function requires the PHP intl extension to be installed.

This formatter does not work well with very big numbers.

public string asOrdinal ( $value )
$value mixed

The value to be formatted
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
throws yii\base\InvalidConfigException

when the PHP intl extension is not available.
asParagraphs() public method

Formats the value as HTML-encoded text paragraphs.

Each text paragraph is enclosed within a <p> tag. One or multiple consecutive empty lines divide two paragraphs.

public string asParagraphs ( $value )
$value string

The value to be formatted.
return string

The formatted result.
asPercent() public method

Formats the value as a percent number with "%" sign.

Since 2.0.16 numbers that are mispresented after normalization are formatted as strings using fallback function without PHP intl extension support. For very big numbers it's recommended to pass them as strings and not use scientific notation otherwise the output might be wrong.

public string asPercent ( $value, $decimals = null, $options = [], $textOptions = [] )
$value mixed

The value to be formatted. It must be a factor e.g. 0.75 will result in 75%.
$decimals integer|null

The number of digits after the decimal point. If not given, the number of digits depends in the input value and is determined based on NumberFormatter::MIN_FRACTION_DIGITS and NumberFormatter::MAX_FRACTION_DIGITS, which can be configured using $numberFormatterOptions. If the PHP intl extension is not available, the default value is 0. If you want consistent behavior between environments where intl is available and not, you should explicitly specify a value here.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
asPercentStringFallback() protected method (available since version 2.0.16)

Fallback for formatting value as a percent number with "%" sign.

Property $decimalSeparator will be used to represent the decimal point. The value is rounded automatically to the defined decimal digits.

protected string asPercentStringFallback ( $value, $decimals = null )
$value string|integer|float

The value to be formatted.
$decimals integer|null

The number of digits after the decimal point. The default value is 0.
return string

The formatted result.
asRaw() public method

Formats the value as is without any formatting.

This method simply returns back the parameter without any format. The only exception is a null value which will be formatted using $nullDisplay.

public string asRaw ( $value )
$value mixed

The value to be formatted.
return string

The formatted result.
asRelativeTime() public method

Formats the value as the time interval between a date and now in human readable form.

This method can be used in three different ways:

  1. Using a timestamp that is relative to now.
  2. Using a timestamp that is relative to the $referenceTime.
  3. Using a DateInterval object.
public string asRelativeTime ( $value, $referenceTime = null )
$value integer|string|DateTime|DateTimeInterface|DateInterval

The value to be formatted. The following types of value are supported:

  • an integer representing a UNIX timestamp
  • a string that can be parsed to create a DateTime object. The timestamp is assumed to be in $defaultTimeZone unless a time zone is explicitly given.
  • a PHP DateTime object
  • a PHP DateInterval object (a positive time interval will refer to the past, a negative one to the future)
$referenceTime integer|string|DateTime|DateTimeInterface|null

If specified the value is used as a reference time instead of now when $value is not a DateInterval object.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value can not be evaluated as a date value.
asScientific() public method

Formats the value as a scientific number.

public string asScientific ( $value, $decimals = null, $options = [], $textOptions = [] )
$value mixed

The value to be formatted.
$decimals integer|null

The number of digits after the decimal point. If not given, the number of digits depends in the input value and is determined based on NumberFormatter::MIN_FRACTION_DIGITS and NumberFormatter::MAX_FRACTION_DIGITS, which can be configured using $numberFormatterOptions. If the PHP intl extension is not available, the default value depends on your PHP configuration. If you want consistent behavior between environments where intl is available and not, you should explicitly specify a value here.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
asShortLength() public method (available since version 2.0.13)

Formats the value as a length in human readable form for example 12 m.

This is the short form of asLength().

Check properties $baseUnits if you need to change unit of value as the multiplier of the smallest unit and $systemOfUnits to switch between UNIT_SYSTEM_METRIC or UNIT_SYSTEM_IMPERIAL.

See also asLength().

public string asShortLength ( $value, $decimals = null, $options = [], $textOptions = [] )
$value float|integer

Value to be formatted.
$decimals integer|null

The number of digits after the decimal point.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
throws yii\base\InvalidConfigException

when INTL is not installed or does not contain required information.
asShortSize() public method

Formats the value in bytes as a size in human readable form for example 12 kB.

This is the short form of asSize().

If $sizeFormatBase is 1024, binary prefixes (e.g. kibibyte/KiB, mebibyte/MiB, ...) are used in the formatting result.

See also:

public string asShortSize ( $value, $decimals = null, $options = [], $textOptions = [] )
$value string|integer|float

Value in bytes to be formatted.
$decimals integer|null

The number of digits after the decimal point.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
asShortWeight() public method (available since version 2.0.13)

Formats the value as a weight in human readable form for example 12 kg.

This is the short form of asWeight().

Check properties $baseUnits if you need to change unit of value as the multiplier of the smallest unit and $systemOfUnits to switch between UNIT_SYSTEM_METRIC or UNIT_SYSTEM_IMPERIAL.

public string asShortWeight ( $value, $decimals = null, $options = [], $textOptions = [] )
$value float|integer

Value to be formatted.
$decimals integer|null

The number of digits after the decimal point.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
throws yii\base\InvalidConfigException

when INTL is not installed or does not contain required information.
asSize() public method

Formats the value in bytes as a size in human readable form, for example 12 kilobytes.

If $sizeFormatBase is 1024, binary prefixes (e.g. kibibyte/KiB, mebibyte/MiB, ...) are used in the formatting result.

See also:

public string asSize ( $value, $decimals = null, $options = [], $textOptions = [] )
$value string|integer|float

Value in bytes to be formatted.
$decimals integer|null

The number of digits after the decimal point.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
asSpellout() public method

Formats the value as a number spellout.

This function requires the PHP intl extension to be installed.

This formatter does not work well with very big numbers.

public string asSpellout ( $value )
$value mixed

The value to be formatted
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
throws yii\base\InvalidConfigException

when the PHP intl extension is not available.
asText() public method

Formats the value as an HTML-encoded plain text.

public string asText ( $value )
$value string

The value to be formatted.
return string

The formatted result.
asTime() public method

Formats the value as a time.

See also $timeFormat.

public string asTime ( $value, $format = null )
$value integer|string|DateTime|DateTimeInterface

The value to be formatted. The following types of value are supported:

  • an integer representing a UNIX timestamp. A UNIX timestamp is always in UTC by its definition.
  • a string that can be parsed to create a DateTime object. The timestamp is assumed to be in $defaultTimeZone unless a time zone is explicitly given.
  • a PHP DateTime object. You may set the time zone for the DateTime object to specify the source time zone.

The formatter will convert date values according to $timeZone before formatting it. If no timezone conversion should be performed, you need to set $defaultTimeZone and $timeZone to the same value.
$format string|null

The format used to convert the value into a date string. If null, $timeFormat will be used.

This can be "short", "medium", "long", or "full", which represents a preset format of different lengths. It can also be a custom format as specified in the ICU manual.

Alternatively this can be a string prefixed with php: representing a format that can be recognized by the PHP date()-function.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value can not be evaluated as a date value.
throws yii\base\InvalidConfigException

if the date format is invalid.
asTimestamp() public method

Formats a date, time or datetime in a float number as UNIX timestamp (seconds since 01-01-1970).

public string asTimestamp ( $value )
$value integer|string|DateTime|DateTimeInterface

The value to be formatted. The following types of value are supported:
return string

The formatted result.
asUrl() public method

Formats the value as a hyperlink.

public string asUrl ( $value, $options = [] )
$value mixed

The value to be formatted.
$options array

The tag options in terms of name-value pairs. See yii\helpers\Html::a().
return string

The formatted result.
asWeight() public method (available since version 2.0.13)

Formats the value as a weight in human readable form for example 12 kilograms.

Check properties $baseUnits if you need to change unit of value as the multiplier of the smallest unit and $systemOfUnits to switch between UNIT_SYSTEM_METRIC or UNIT_SYSTEM_IMPERIAL.

public string asWeight ( $value, $decimals = null, $options = [], $textOptions = [] )
$value float|integer

Value to be formatted.
$decimals integer|null

The number of digits after the decimal point.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return string

The formatted result.
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
throws yii\base\InvalidConfigException

when INTL is not installed or does not contain required information.
createNumberFormatter() protected method

Creates a number formatter based on the given type and format.

You may override this method to create a number formatter based on patterns.

protected NumberFormatter createNumberFormatter ( $style, $decimals = null, $options = [], $textOptions = [] )
$style integer

The type of the number formatter. Values: NumberFormatter::DECIMAL, ::CURRENCY, ::PERCENT, ::SCIENTIFIC, ::SPELLOUT, ::ORDINAL ::DURATION, ::PATTERN_RULEBASED, ::DEFAULT_STYLE, ::IGNORE
$decimals integer|null

The number of digits after the decimal point.
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return NumberFormatter

The created formatter instance
format() public method

Formats the value based on the given format type.

This method will call one of the "as" methods available in this class to do the formatting. For type "xyz", the method "asXyz" will be used. For example, if the format is "html", then asHtml() will be used. Format names are case insensitive.

public string format ( $value, $format )
$value mixed

The value to be formatted.
$format string|array|Closure

The format of the value, e.g., "html", "text" or an anonymous function returning the formatted value.

To specify additional parameters of the formatting method, you may use an array. The first element of the array specifies the format name, while the rest of the elements will be used as the parameters to the formatting method. For example, a format of ['date', 'Y-m-d'] will cause the invocation of asDate($value, 'Y-m-d').

The anonymous function signature should be: function($value, $formatter), where $value is the value that should be formatted and $formatter is an instance of the Formatter class, which can be used to call other formatting functions. The possibility to use an anonymous function is available since version 2.0.13.
return string

The formatting result.
throws yii\base\InvalidArgumentException

if the format type is not supported by this class.
formatNumber() protected method (available since version 2.0.32)

Given the value in bytes formats number part of the human readable form.

protected array formatNumber ( $value, $decimals, $maxPosition, $formatBase, $options, $textOptions )
$value string|integer|float

Value in bytes to be formatted.
$decimals integer

The number of digits after the decimal point
$maxPosition integer

Maximum internal position of size unit, ignored if $formatBase is an array
$formatBase array|integer

The base at which each next unit is calculated, either 1000 or 1024, or an array
$options array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterOptions.
$textOptions array

Optional configuration for the number formatter. This parameter will be merged with $numberFormatterTextOptions.
return array

[parameters for Yii::t containing formatted number, internal position of size unit]
throws yii\base\InvalidArgumentException

if the input value is not numeric or the formatting failed.
init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )
isNormalizedValueMispresented() protected method (available since version 2.0.16)

Checks if string representations of given value and its normalized version are different.

protected boolean isNormalizedValueMispresented ( $value, $normalizedValue )
$value string|float|integer
$normalizedValue float|integer
normalizeDatetimeValue() protected method

Normalizes the given datetime value as a DateTime object that can be taken by various date/time formatting methods.

protected DateTime|array normalizeDatetimeValue ( $value, $checkDateTimeInfo = false )
$value integer|string|DateTime|DateTimeInterface

The datetime value to be normalized. The following types of value are supported:
$checkDateTimeInfo boolean

Whether to also check if the date/time value has some time and date information attached. Defaults to false. If true, the method will then return an array with the first element being the normalized timestamp, the second a boolean indicating whether the timestamp has time information and third a boolean indicating whether the timestamp has date information. This parameter is available since version 2.0.1.
return DateTime|array

The normalized datetime value. Since version 2.0.1 this may also return an array if $checkDateTimeInfo is true. The first element of the array is the normalized timestamp and the second is a boolean indicating whether the timestamp has time information or it is just a date value. Since version 2.0.12 the array has third boolean element indicating whether the timestamp has date information or it is just a time value.
throws yii\base\InvalidArgumentException

if the input value can not be evaluated as a date value.
normalizeNumericStringValue() protected method (available since version 2.0.16)

Normalizes a numeric string value.

protected string normalizeNumericStringValue ( $value )
$value string
return string

The normalized number value as a string
normalizeNumericValue() protected method

Normalizes a numeric input value.

  • everything empty will result in 0
  • a numeric string will be casted to float
  • everything else will be returned if it is numeric, otherwise an exception is thrown.
protected float|integer normalizeNumericValue ( $value )
$value mixed

The input value
return float|integer

The normalized number value
throws yii\base\InvalidArgumentException

if the input value is not numeric.