Class: TNumberFormat

Source Location: /I18N/TNumberFormat.php

Class Overview

TComponent
   |
   --TControl
      |
      --TI18NControl
         |
         --TNumberFormat

To format numbers in locale sensitive manner use

Class Details

[line 66]
To format numbers in locale sensitive manner use

 <com:TNumberFormat Pattern="0.##" value="2.0" />

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

 <com:TNumberFormat Type="currency" Culture="en_US" Currency="EUR" Value="100" />

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.

version:	v1.0, last update on Sat Dec 11 17:49:56 EST 2004
author:	Xiang Wei Zhuo <weizhuo[at]gmail[dot]com>

[ Top ]

Variables

$formatter

Methods

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TI18NControl

TI18NControl::charset(): Gets the charset, with fall back to the application charset,
TI18NControl::getCharset()
TI18NControl::getCulture(): Get the specific culture for this control.
TI18NControl::setCharset(): Sets the charset for message output
TI18NControl::setCulture(): Get the custom culture identifier.

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Variables

$formatter =

[line 72]

Default NumberFormat, set to the application culture.

static:
access:	protected

Type:

NumberFormat

[ Top ]

Class Methods

method getCurrency [line 153]

string getCurrency(
parameter
0)

Get the currency for this control.

return:

3 letter currency code.

Parameters:

parameter

[ Top ]

method getPattern [line 78]

string getPattern(
)

Get the number formatting pattern.

return:

format pattern.

[ Top ]

method getType [line 114]

string getType(
)

Get the formatting type for this control.

return:

formatting type.

[ Top ]

method getValue [line 96]

string getValue(
)

Get the numberic value for this control.

return:

number

[ Top ]

method renderBody [line 177]

void renderBody(
)

Renders the localized number, be it currency or decimal, or percentage.

If the culture is not specified, the default application culture will be used. This method overrides parent's implementation.

access:

protected

Overrides TControl::renderBody() (Renders the body content.)

[ Top ]

method setCurrency [line 166]

void setCurrency(
string
$currency)

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

Parameters:

string

$currency

currency code.

[ Top ]

method setPattern [line 87]

void setPattern(
string
$pattern)

Set the number format pattern.

Parameters:

string

$pattern

format pattern.

[ Top ]

method setType [line 128]

void setType(
string
$type)

Set the formatting type for this control.

throws:

TPropertyTypeInvalidException

Parameters:

string

$type

formatting type, either "decimal", "currency","percentage" or "scientific"

[ Top ]

method setValue [line 105]

void setValue(
string
$value)

Set the numberic value for this control.

Parameters:

string

$value

the number value

[ Top ]