LocaleModel

Type
Class
Namespace
Craft
Inherits
Craft\LocaleModel » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements
IApplicationComponent
Since
1.0

Stores locale info.

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.
__construct() Constructor
__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.
__toString() Use the ID as the string representation of locales.
__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.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
getId()
getIsInitialized() (opens new window) Checks if this application component has been initialized.
getName() Returns the locale name in a given language.
getNativeName() Returns the locale name in its own language.
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.
raiseEvent() (opens new window) Raises an event.

# __construct()

Constructor

View source (opens new window)

Arguments

  • $id

Returns

Craft\LocaleModel

Signature

public Craft\LocaleModel __construct ( $id )

# __toString()

Use the ID as the string representation of locales.

View source (opens new window)

Returns

string (opens new window)

Signature

public string __toString ( )

# getId()

Signature

public void getId ( )

# getName()

Returns the locale name in a given language.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

Signature

public string, null getName ( $targetLocaleId = null )

# getNativeName()

Returns the locale name in its own language.

View source (opens new window)

Returns

string (opens new window), false (opens new window)

Signature

public string, false getNativeName ( )