PHP Класс Prado\I18N\TNumberFormat

Numbers can be formatted as currency, percentage, decimal or scientific numbers by specifying the Type attribute. The known types are "currency", "percentage", "decimal" and "scientific". If someone from US want to see sales figures from a store in Germany (say using the EURO currency), formatted using the german currency, you would need to use the attribute Culture="de_DE" to get the currency right, e.g. 100,00. The decimal and grouping separator is then also from the de_DE locale. This may lead to some confusion because people from US know the "," as thousand separator. Therefore a "Currency" attribute is available, so that the output from the following example results in 100.00. Namespace: System.I18N Properties - Value, number,
Gets or sets the number to format. The tag content is used as Value if the Value property is not specified. - Type, string,
Gets or sets the formatting type. The valid types are 'decimal', 'currency', 'percentage' and 'scientific'. - Currency, string,
Gets or sets the currency symbol for the currency format. The default is 'USD' if the Currency property is not specified. - Pattern, string,
Gets or sets the custom number formatting pattern. - DefaultText, string,
Gets or sets the default text. If Value is not set, DefaultText will be shown instead of the default currency Value/Pattern.
Наследование: extends TI18NControl, implements Prado\IDataRenderer
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$formatter Prado\I18N\core\NumberFormat Default NumberFormat, set to the application culture.

Открытые методы

Метод Описание
getCurrency ( ) : string
getData ( ) : string Get the numberic value for this control.
getDefaultText ( ) : string Get the default text value for this control.
getPattern ( ) : string Get the number formatting pattern.
getType ( ) : string Get the formatting type for this control.
getValue ( ) : string Get the numberic value for this control.
render ( $writer )
setCurrency ( $currency ) Set the 3-letter ISO 4217 code. For example, the code "USD" represents the US Dollar and "EUR" represents the Euro currency.
setData ( $value ) Set the numberic value for this control.
setDefaultText ( $value ) Set the default text value for this control.
setPattern ( $pattern ) Set the number format pattern.
setType ( $type ) Set the formatting type for this control.
setValue ( $value ) Set the numberic value for this control.

Защищенные методы

Метод Описание
getFormattedValue ( ) : string Formats the localized number, be it currency or decimal, or percentage.

Описание методов

getCurrency() публичный Метод

public getCurrency ( ) : string
Результат string 3 letter currency code. Defaults to 'USD'.

getData() публичный Метод

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link getValue()}.
См. также: getValue
С версии: 3.1.2
public getData ( ) : string
Результат string number

getDefaultText() публичный Метод

Get the default text value for this control.
public getDefaultText ( ) : string
Результат string default text value

getFormattedValue() защищенный Метод

If the culture is not specified, the default application culture will be used.
protected getFormattedValue ( ) : string
Результат string formatted number

getPattern() публичный Метод

Get the number formatting pattern.
public getPattern ( ) : string
Результат string format pattern.

getType() публичный Метод

Get the formatting type for this control.
public getType ( ) : string
Результат string formatting type.

getValue() публичный Метод

Get the numberic value for this control.
public getValue ( ) : string
Результат string number

render() публичный Метод

public render ( $writer )

setCurrency() публичный Метод

Set the 3-letter ISO 4217 code. For example, the code "USD" represents the US Dollar and "EUR" represents the Euro currency.
public setCurrency ( $currency )

setData() публичный Метод

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link setValue()}.
См. также: setValue
С версии: 3.1.2
public setData ( $value )

setDefaultText() публичный Метод

Set the default text value for this control.
public setDefaultText ( $value )

setPattern() публичный Метод

Set the number format pattern.
public setPattern ( $pattern )

setType() публичный Метод

Set the formatting type for this control.
public setType ( $type )

setValue() публичный Метод

Set the numberic value for this control.
public setValue ( $value )

Описание свойств

$formatter защищенное статическое свойство

Default NumberFormat, set to the application culture.
protected static NumberFormat,Prado\I18N\core $formatter
Результат Prado\I18N\core\NumberFormat