# Class yii\i18n\Locale

Inheritance | yii\i18n\Locale » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0.14
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/i18n/Locale.php

Locale provides various locale information via convenient methods.

The class requires PHP intl extension to be installed.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$currencySymbol | string | This property is read-only. | yii\i18n\Locale
$locale | string | The locale ID. | yii\i18n\Locale

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__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
__construct() | Constructor. | yii\base\BaseObject
__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() | 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 | yii\i18n\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. | yii\i18n\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

$currencySymbol public property

This property is read-only.

public string $currencySymbol = null
$locale public property

The locale ID. If not set, yii\base\Application::$language will be used.

public string $locale = null

## Method Details

getCurrencySymbol() public method

Returns a currency symbol

public string getCurrencySymbol ( $currencyCode = null )
$currencyCode | string | The 3-letter ISO 4217 currency code to get symbol for. If null, method will attempt using currency code from $locale.

init() public method

Initializes the object.

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

public void init ( )