Locale

API reference › yii › i18n › Locale

class	`yii\i18n\Locale`
Extends	`yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0.14
Source	`framework/i18n/Locale.php`

Locale provides various locale information via convenient methods.

The class requires PHP intl extension to be installed.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$currencySymbol` read-only	`string`		`Locale`
`$locale`	`string\|null`	The locale ID. Default: `null`.	`Locale`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getCurrencySymbol()`	Returns a currency symbol	`Locale`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`Locale`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`trigger()`	Triggers an event.	`yii\base\Component`

Property details

$locale

public string|null $locale = null

The locale ID.

If not set, Application::$language will be used.

Method details

getCurrencySymbol()

public function getCurrencySymbol(string|null $currencyCode = null): string

Returns a currency symbol

Parameters

Parameter	Type	Description
`$currencyCode`	`string\|null`	The 3-letter ISO 4217 currency code to get symbol for. If null, method will attempt using currency code from `$locale`.

Returns

string

init()

public function init(): mixed

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

Returns

mixed