NumberFormatter

Type
Class
Namespace
Craft
Inherits
Craft\NumberFormatter » CNumberFormatter » CComponent
Since
1.3

Number formatter class.

See also http://craftcms.com

View source

Protected Properties

PropertyDescription
$_locale

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
format()Formats a number based on the specified pattern.
formatCurrency()Formats a number using the currency format defined in the locale.
formatDecimal()Formats a number using the decimal format defined in the locale.
formatPercentage()Formats a number using the percentage format defined in the locale.
getEventHandlers()Returns the list of attached event handlers for an event.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
raiseEvent()Raises an event.

formatCurrency()

Formats a number using the currency format defined in the locale.

View source

Arguments

Returns

string – The formatted result.

Signature

public string formatCurrency ( $value, $currency, $stripZeroCents = false )

formatDecimal()

Formats a number using the decimal format defined in the locale.

View source

Arguments

  • $value (mixed)
  • $withGroupSymbol (boolean)

Returns

string

Signature

public string formatDecimal ( $value, $withGroupSymbol = true )

Protected Methods

MethodDescription
formatNumber()Formats a number based on a format.
parseFormat()Parses a given string pattern.