LocalizationService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\LocalizationService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class LocalizationService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# 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. |
| addSiteLocale() | Adds a new site locale. |
| 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. |
| deleteSiteLocale() | Deletes a site locale. |
| 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. |
| getAllLocales() | Returns an array of all known locales. The list of known locales is based on whatever files exist in framework/i18n/data/. |
| getAppLocaleIds() | Returns an array of the locale IDs which Craft has been translated into. The list of locales is based on whatever files exist in craft/app/translations/. |
| getAppLocales() | Returns an array of locales that Craft is translated into. The list of locales is based on whatever files exist in craft/app/translations/. |
| getEditableLocaleIds() | Returns an array of the editable locale IDs. |
| getEditableLocales() | Returns a list of locales that are editable by the current user. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getLocaleById() | Returns a locale by its ID. |
| getLocaleData() | Returns the localization data for a given locale. |
| getPrimarySiteLocale() | Returns the site's primary locale. The primary locale is whatever is listed first in Settings > Locales in the control panel. |
| getPrimarySiteLocaleId() | Returns the site's primary locale ID. The primary locale is whatever is listed first in Settings > Locales in the control panel. |
| getSiteLocaleIds() | Returns an array of the site locale IDs. The list of locales is based on whatever was defined in Settings > Locales in the control panel. |
| getSiteLocales() | Returns an array of the site locales. The list of locales is based on whatever was defined in Settings > Locales in the control panel. |
| 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. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| onAddLocale() | Fires an 'onAddLocale' event. |
| onBeforeDeleteLocale() | Fires an 'onBeforeDeleteLocale' event. |
| onDeleteLocale() | Fires an 'onDeleteLocale' event. |
| raiseEvent() (opens new window) | Raises an event. |
| reorderSiteLocales() | Reorders the site's locales. |
# addSiteLocale()
Adds a new site locale.
View source (opens new window)
Arguments
$localeId(string (opens new window))
Returns
Signature
public boolean addSiteLocale ( $localeId )
# deleteSiteLocale()
Deletes a site locale.
View source (opens new window)
Arguments
$localeId(string (opens new window)) – The locale to be deleted.$transferContentTo(string (opens new window), null (opens new window)) – The locale that should take over the deleted locale’s content.
Returns
boolean (opens new window) – Whether the locale was successfully deleted.
Throws
Signature
public boolean deleteSiteLocale ( $localeId, $transferContentTo )
# getAllLocales()
Returns an array of all known locales. The list of known locales is based on whatever files exist in framework/i18n/data/.
View source (opens new window)
Returns
array (opens new window) – An array of LocaleModel objects.
Signature
public array getAllLocales ( )
# getAppLocaleIds()
Returns an array of the locale IDs which Craft has been translated into. The list of locales is based on whatever files exist in craft/app/translations/.
View source (opens new window)
Returns
array (opens new window) – An array of locale IDs.
Signature
public array getAppLocaleIds ( )
# getAppLocales()
Returns an array of locales that Craft is translated into. The list of locales is based on whatever files exist in craft/app/translations/.
View source (opens new window)
Returns
array (opens new window) – An array of {@link LocaleModel} objects.
Signature
public array getAppLocales ( )
# getEditableLocaleIds()
Signature
public array getEditableLocaleIds ( )
# getEditableLocales()
Returns a list of locales that are editable by the current user.
View source (opens new window)
Returns
Signature
public array getEditableLocales ( )
# getLocaleById()
Returns a locale by its ID.
View source (opens new window)
Arguments
$localeId(string (opens new window))
Returns
Signature
public Craft\LocaleModel getLocaleById ( $localeId )
# getLocaleData()
Returns the localization data for a given locale.
View source (opens new window)
Arguments
$localeId(string (opens new window))
Returns
Signature
public Craft\LocaleData, null getLocaleData ( $localeId = null )
# getPrimarySiteLocale()
Returns the site's primary locale. The primary locale is whatever is listed first in Settings > Locales in the control panel.
View source (opens new window)
Returns
Craft\LocaleModel – A {@link LocaleModel} object representing the primary locale.
Signature
public Craft\LocaleModel getPrimarySiteLocale ( )
# getPrimarySiteLocaleId()
Returns the site's primary locale ID. The primary locale is whatever is listed first in Settings > Locales in the control panel.
View source (opens new window)
Returns
string (opens new window) – The primary locale ID.
Signature
public string getPrimarySiteLocaleId ( )
# getSiteLocaleIds()
Returns an array of the site locale IDs. The list of locales is based on whatever was defined in Settings > Locales in the control panel.
View source (opens new window)
Returns
array (opens new window) – An array of locale IDs.
Signature
public array getSiteLocaleIds ( )
# getSiteLocales()
Returns an array of the site locales. The list of locales is based on whatever was defined in Settings > Locales in the control panel.
View source (opens new window)
Returns
array (opens new window) – An array of {@link LocaleModel} objects.
Signature
public array getSiteLocales ( )
# onAddLocale()
Signature
public null onAddLocale ( Craft\Event $event )
# onBeforeDeleteLocale()
Fires an 'onBeforeDeleteLocale' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeDeleteLocale ( Craft\Event $event )
# onDeleteLocale()
Fires an 'onDeleteLocale' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onDeleteLocale ( Craft\Event $event )
# reorderSiteLocales()
Reorders the site's locales.
View source (opens new window)
Arguments
$localeIds(array (opens new window))
Returns
Signature
public boolean reorderSiteLocales ( $localeIds )