PHP Class 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.

Inheritance: extends TI18NControl, implements Prado\IDataRenderer

Datei anzeigen Open project: pradosoft/prado

Protected Properties

Property	Type	Description
$formatter	Prado\I18N\core\NumberFormat	Default NumberFormat, set to the application culture.

Public Methods

Method	Description
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.

Protected Methods

Method	Description
getFormattedValue ( ) : string	Formats the localized number, be it currency or decimal, or percentage.

Method Details

getCurrency() public method

public getCurrency ( ) : string
return	string	3 letter currency code. Defaults to 'USD'.

getData() public method

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link getValue()}.

getDefaultText() public method

Get the default text value for this control.

public getDefaultText ( ) : string
return	string	default text value

getFormattedValue() protected method

If the culture is not specified, the default application culture will be used.

protected getFormattedValue ( ) : string
return	string	formatted number

getPattern() public method

Get the number formatting pattern.

public getPattern ( ) : string
return	string	format pattern.

getType() public method

Get the formatting type for this control.

public getType ( ) : string
return	string	formatting type.

getValue() public method

Get the numberic value for this control.

public getValue ( ) : string
return	string	number

render() public method

public render ( $writer )

setCurrency() public method

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() public method

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link setValue()}.

setDefaultText() public method

Set the default text value for this control.

public setDefaultText ( $value )

setPattern() public method

Set the number format pattern.

public setPattern ( $pattern )

setType() public method

Set the formatting type for this control.

public setType ( $type )

setValue() public method

Set the numberic value for this control.

public setValue ( $value )

Property Details

$formatter protected_oe static_oe property

Default NumberFormat, set to the application culture.

protected static NumberFormat,Prado\I18N\core $formatter
return	Prado\I18N\core\NumberFormat