CLocale
| Package | system.i18n |
|---|---|
| Inheritance | class CLocale » CComponent |
| Since | 1.0 |
| Version | $Id: CLocale.php 2093 2010-05-05 00:45:46Z qiang.xue $ |
CLocale represents the data relevant to a locale.
The data includes the number formatting information and date formatting information.
The data includes the number formatting information and date formatting information.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| aMName | string | the AM name | CLocale |
| currencyFormat | string | the currency format | CLocale |
| dataPath | string | the directory that contains the locale data. | CLocale |
| dateFormat | string | date format | CLocale |
| dateFormatter | CDateFormatter | the date formatter for this locale | CLocale |
| dateTimeFormat | string | datetime format, i. | CLocale |
| decimalFormat | string | the decimal format | CLocale |
| id | string | the locale ID (in canonical form) | CLocale |
| monthNames | array | Returns the month names in the specified width. | CLocale |
| numberFormatter | CNumberFormatter | the number formatter for this locale | CLocale |
| orientation | string | the character orientation, which is either 'ltr' (left-to-right) or 'rtl' (right-to-left) | CLocale |
| pMName | string | the PM name | CLocale |
| percentFormat | string | the percent format | CLocale |
| scientificFormat | string | the scientific format | CLocale |
| timeFormat | string | date format | CLocale |
| weekDayNames | array | Returns the week day names in the specified width. | CLocale |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __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 |
| getAMName() | CLocale | |
| getCanonicalID() | Converts a locale ID to its canonical form. | CLocale |
| getCurrencyFormat() | CLocale | |
| getCurrencySymbol() | CLocale | |
| getDateFormat() | CLocale | |
| getDateFormatter() | CLocale | |
| getDateTimeFormat() | CLocale | |
| getDecimalFormat() | CLocale | |
| getEraName() | CLocale | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | CLocale | |
| getInstance() | Returns the instance of the specified locale. | CLocale |
| getLocaleIDs() | CLocale | |
| getMonthName() | CLocale | |
| getMonthNames() | Returns the month names in the specified width. | CLocale |
| getNumberFormatter() | CLocale | |
| getNumberSymbol() | CLocale | |
| getOrientation() | CLocale | |
| getPMName() | CLocale | |
| getPercentFormat() | CLocale | |
| getScientificFormat() | CLocale | |
| getTimeFormat() | CLocale | |
| getWeekDayName() | CLocale | |
| getWeekDayNames() | Returns the week day names in the specified width. | CLocale |
| 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 |
|---|---|---|
| __construct() | Constructor. | CLocale |
Property Details
aMName
property
read-only
public string getAMName()
the AM name
currencyFormat
property
read-only
public string getCurrencyFormat()
the currency format
dataPath
property
(available since v1.1.0)
public static string $dataPath;
the directory that contains the locale data. If this property is not set, the locale data will be loaded from 'framework/i18n/data'.
dateFormat
property
read-only
public string getDateFormat(string $width='medium')
date format
dateFormatter
property
read-only
public CDateFormatter getDateFormatter()
the date formatter for this locale
dateTimeFormat
property
read-only
public string getDateTimeFormat()
datetime format, i.e., the order of date and time.
decimalFormat
property
read-only
public string getDecimalFormat()
the decimal format
id
property
read-only
public string getId()
the locale ID (in canonical form)
monthNames
property
read-only (available since v1.0.9)
public array getMonthNames(string $width='wide', boolean $standAlone=false)
Returns the month names in the specified width.
numberFormatter
property
read-only
public CNumberFormatter getNumberFormatter()
the number formatter for this locale
orientation
property
read-only (available since v1.1.2)
public string getOrientation()
the character orientation, which is either 'ltr' (left-to-right) or 'rtl' (right-to-left)
pMName
property
read-only
public string getPMName()
the PM name
percentFormat
property
read-only
public string getPercentFormat()
the percent format
scientificFormat
property
read-only
public string getScientificFormat()
the scientific format
timeFormat
property
read-only
public string getTimeFormat(string $width='medium')
date format
weekDayNames
property
read-only (available since v1.0.9)
public array getWeekDayNames(string $width='wide', boolean $standAlone=false)
Returns the week day names in the specified width.
Method Details
__construct()
method
|
protected void __construct(string $id)
| ||
| $id | string | the locale ID (e.g. en_US) |
Constructor. Since the constructor is protected, please use getInstance to obtain an instance of the specified locale.
getAMName()
method
|
public string getAMName()
| ||
| {return} | string | the AM name |
getCanonicalID()
method
|
public static string getCanonicalID(string $id)
| ||
| $id | string | the locale ID to be converted |
| {return} | string | the locale ID in canonical form |
Converts a locale ID to its canonical form. In canonical form, a locale ID consists of only underscores and lower-case letters.
getCurrencyFormat()
method
|
public string getCurrencyFormat()
| ||
| {return} | string | the currency format |
getCurrencySymbol()
method
|
public string getCurrencySymbol(string $currency)
| ||
| $currency | string | 3-letter ISO 4217 code. For example, the code "USD" represents the US Dollar and "EUR" represents the Euro currency. |
| {return} | string | the localized currency symbol. Null if the symbol does not exist. |
getDateFormat()
method
|
public string getDateFormat(string $width='medium')
| ||
| $width | string | date format width. It can be 'full', 'long', 'medium' or 'short'. |
| {return} | string | date format |
getDateFormatter()
method
|
public CDateFormatter getDateFormatter()
| ||
| {return} | CDateFormatter | the date formatter for this locale |
getDateTimeFormat()
method
|
public string getDateTimeFormat()
| ||
| {return} | string | datetime format, i.e., the order of date and time. |
getDecimalFormat()
method
|
public string getDecimalFormat()
| ||
| {return} | string | the decimal format |
getEraName()
method
|
public string getEraName(integer $era, string $width='wide')
| ||
| $era | integer | era (0,1) |
| $width | string | era name width. It can be 'wide', 'abbreviated' or 'narrow'. |
| {return} | string | the era name |
getId()
method
|
public string getId()
| ||
| {return} | string | the locale ID (in canonical form) |
getInstance()
method
|
public static CLocale getInstance(string $id)
| ||
| $id | string | the locale ID (e.g. en_US) |
| {return} | CLocale | the locale instance |
Returns the instance of the specified locale. Since the constructor of CLocale is protected, you can only use this method to obtain an instance of the specified locale.
getLocaleIDs()
method
|
public static array getLocaleIDs()
| ||
| {return} | array | IDs of the locales which the framework can recognize |
getMonthName()
method
|
public string getMonthName(integer $month, string $width='wide', boolean $standAlone=false)
| ||
| $month | integer | month (1-12) |
| $width | string | month name width. It can be 'wide', 'abbreviated' or 'narrow'. |
| $standAlone | boolean | whether the month name should be returned in stand-alone format |
| {return} | string | the month name |
getMonthNames()
method
(available since v1.0.9)
|
public array getMonthNames(string $width='wide', boolean $standAlone=false)
| ||
| $width | string | month name width. It can be 'wide', 'abbreviated' or 'narrow'. |
| $standAlone | boolean | whether the month names should be returned in stand-alone format |
| {return} | array | month names indexed by month values (1-12) |
Returns the month names in the specified width.
getNumberFormatter()
method
|
public CNumberFormatter getNumberFormatter()
| ||
| {return} | CNumberFormatter | the number formatter for this locale |
getNumberSymbol()
method
|
public string getNumberSymbol(string $name)
| ||
| $name | string | symbol name |
| {return} | string | symbol |
getOrientation()
method
(available since v1.1.2)
|
public string getOrientation()
| ||
| {return} | string | the character orientation, which is either 'ltr' (left-to-right) or 'rtl' (right-to-left) |
getPMName()
method
|
public string getPMName()
| ||
| {return} | string | the PM name |
getPercentFormat()
method
|
public string getPercentFormat()
| ||
| {return} | string | the percent format |
getScientificFormat()
method
|
public string getScientificFormat()
| ||
| {return} | string | the scientific format |
getTimeFormat()
method
|
public string getTimeFormat(string $width='medium')
| ||
| $width | string | time format width. It can be 'full', 'long', 'medium' or 'short'. |
| {return} | string | date format |
getWeekDayName()
method
|
public string getWeekDayName(integer $day, string $width='wide', boolean $standAlone=false)
| ||
| $day | integer | weekday (0-6, 0 means Sunday) |
| $width | string | weekday name width. It can be 'wide', 'abbreviated' or 'narrow'. |
| $standAlone | boolean | whether the week day name should be returned in stand-alone format |
| {return} | string | the weekday name |
getWeekDayNames()
method
(available since v1.0.9)
|
public array getWeekDayNames(string $width='wide', boolean $standAlone=false)
| ||
| $width | string | weekday name width. It can be 'wide', 'abbreviated' or 'narrow'. |
| $standAlone | boolean | whether the week day name should be returned in stand-alone format |
| {return} | array | the weekday names indexed by weekday values (0-6, 0 means Sunday, 1 Monday, etc.) |
Returns the week day names in the specified width.