Craft 2 Class Reference

Class NumberFormatter

Package
craft.app.etc.i18n
Namespace
Craft
Inheritance
class NumberFormatter » \CNumberFormatter » \CComponent
Since
1.3
Source Code
craft/app/etc/i18n/NumberFormatter.php

Number formatter class.

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

Method Details

formatCurrency() public method #

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

public string formatCurrency(mixed $value, string $currency, bool $stripZeroCents = false)
$value mixed
$currency string
$stripZeroCents bool
Returns string The formatted result.

formatDecimal() public method #

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

public string formatDecimal(mixed $value, bool $withGroupSymbol = true)
$value mixed
$withGroupSymbol bool
Returns string