LocaleData
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\LocaleData » CLocale (opens new window) » CComponent (opens new window)
- Since
- 1.0
Class LocaleData
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $dataPath (opens new window) | string (opens new window) – The directory that contains the locale data. |
# Protected Properties
| Property | Description |
|---|---|
| $_data (opens new window) | |
| $_dateFormatter (opens new window) | |
| $_id (opens new window) | |
| $_numberFormatter (opens new window) |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| exists() | |
| getAMName() (opens new window) | |
| getAllTerritories() | Returns an array of territories for the locale instance or null, if none exist. |
| getCanonicalID() (opens new window) | Converts a locale ID to its canonical form. |
| getCurrencyFormat() (opens new window) | |
| getCurrencySymbol() (opens new window) | |
| getDateFormat() (opens new window) | |
| getDateFormatter() | |
| getDateTimeFormat() (opens new window) | |
| getDecimalFormat() (opens new window) | |
| getEraName() (opens new window) | |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getId() (opens new window) | |
| getInstance() | 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. |
| getLanguage() | Converts a locale ID to a language ID. Language ID consists of only the first group of letters before an underscore or dash. |
| getLanguageID() (opens new window) | Converts a locale ID to a language ID. |
| getLocaleDisplayName() (opens new window) | Gets a localized name from i18n data file (one of framework/i18n/data/ files). |
| getLocaleIDs() (opens new window) | |
| getMonthName() (opens new window) | |
| getMonthNames() (opens new window) | Returns the month names in the specified width. |
| getNumberFormatter() | |
| getNumberSymbol() (opens new window) | |
| getOrientation() (opens new window) | |
| getPMName() (opens new window) | |
| getPercentFormat() (opens new window) | |
| getPluralRules() (opens new window) | |
| getScientificFormat() (opens new window) | |
| getScript() (opens new window) | |
| getScriptID() (opens new window) | Converts a locale ID to a script ID. |
| getTerritory() (opens new window) | |
| getTerritoryID() (opens new window) | Converts a locale ID to a territory ID. |
| getTimeFormat() (opens new window) | |
| getWeekDayName() (opens new window) | |
| getWeekDayNames() (opens new window) | Returns the week day names in the specified width. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| raiseEvent() (opens new window) | Raises an event. |
# exists()
Signature
public static boolean exists ( $id )
# getAllTerritories()
Returns an array of territories for the locale instance or null, if none exist.
View source (opens new window)
Returns
string (opens new window)[], null (opens new window) – An array of all territories for the given locale, or null, if none exist.
Signature
public string[], null getAllTerritories ( )
# getDateFormatter()
Signature
public Craft\DateFormatter getDateFormatter ( )
# getInstance()
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.
View source (opens new window)
Arguments
$id(string (opens new window)) – The locale ID (e.g. en_US)
Returns
Craft\LocaleData – The locale instance
Signature
public static Craft\LocaleData getInstance ( $id )
# getLanguage()
Converts a locale ID to a language ID. Language ID consists of only the first group of letters before an underscore or dash. Craft overrides the parent method from {@link \CLocale} because this is where we want to chop off the territory half of a locale ID.
View source (opens new window)
Arguments
$id(string (opens new window)) – The locale ID to be converted
Returns
string (opens new window) – The language ID
Signature
public string getLanguage ( $id )
# getNumberFormatter()
Signature
public Craft\NumberFormatter getNumberFormatter ( )
# Protected Methods
| Method | Description |
|---|---|
| __construct() (opens new window) | Constructor. |