PhpMessageSource
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\PhpMessageSource » CPhpMessageSource (opens new window) » CMessageSource (opens new window) » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class PhpMessageSource
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $basePath (opens new window) | string (opens new window) – The base path for all translated messages. |
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
| $cacheID (opens new window) | string (opens new window) – The ID of the cache application component that is used to cache the messages. |
| $cachingDuration (opens new window) | integer (opens new window) – The time in seconds that the messages can remain valid in cache. |
| $extensionPaths (opens new window) | array (opens new window) – The message paths for extensions that do not have a base class to use as category prefix. |
| $forceTranslation | boolean (opens new window) |
# $forceTranslation
Signature
public boolean $forceTranslation = true
# 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. |
| 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. |
| getLanguage() (opens new window) | |
| 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() | |
| onMissingTranslation() (opens new window) | Raised when a message cannot be translated. |
| raiseEvent() (opens new window) | Raises an event. |
| setLanguage() (opens new window) | |
| translate() (opens new window) | Translates a message to the specified language. |
# init()
Signature
public void init ( )
# Protected Methods
| Method | Description |
|---|---|
| getMessageFile() (opens new window) | Determines the message file name based on the given category and language. |
| loadMessages() | Loads the message translation for the specified language and category. |
| translateMessage() (opens new window) | Translates the specified message. |
# loadMessages()
Loads the message translation for the specified language and category.
View source (opens new window)
Arguments
$category(string (opens new window)) – The message category$language(string (opens new window)) – The target locale
Returns
array (opens new window) – The loaded messages
Signature
protected array loadMessages ( $category, $language )
# Constants
| Constant | Description |
|---|---|
CACHE_KEY_PREFIX |