CPhpMessageSource
| Package | system.i18n |
|---|---|
| Inheritance | class CPhpMessageSource » CMessageSource » CApplicationComponent » CComponent |
| Implements | IApplicationComponent |
| Since | 1.0 |
| Version | $Id: CPhpMessageSource.php 433 2008-12-30 22:59:17Z qiang.xue $ |
CPhpMessageSource represents a message source that stores translated messages in PHP scripts.
CPhpMessageSource uses PHP files and arrays to keep message translations.
CPhpMessageSource uses PHP files and arrays to keep message translations.
- All translations are saved under the basePath directory.
- Translations in one language are kept as PHP files under an individual subdirectory whose name is the same as the language ID. Each PHP file contains messages belonging to the same category, and the file name is the same as the category name.
- Within a PHP file, an array of (source, translation) pairs is returned.
For example:
return array( 'original message 1' => 'translated message 1', 'original message 2' => 'translated message 2', );
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| basePath | string | the base path for all translated messages. | CPhpMessageSource |
| behaviors | array | the behaviors that should be attached to this component. | CApplicationComponent |
| cachingDuration | integer | the time in seconds that the messages can remain valid in cache. | CPhpMessageSource |
| isInitialized | boolean | whether this application component has been initialized (i. | CApplicationComponent |
| language | string | the language that the source messages are written in. | CMessageSource |
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 |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getIsInitialized() | CApplicationComponent | |
| getLanguage() | CMessageSource | |
| 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 |
| init() | Initializes the application component. | CPhpMessageSource |
| onMissingTranslation() | Raised when a message cannot be translated. | CMessageSource |
| raiseEvent() | Raises an event. | CComponent |
| setLanguage() | CMessageSource | |
| translate() | Translates a message to the specified language. | CMessageSource |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| loadMessages() | Loads the message translation for the specified language and category. | CPhpMessageSource |
| translateMessage() | Translates the specified message. | CMessageSource |
Events
| Event | Description | Defined By |
|---|---|---|
| onMissingTranslation | Raised when a message cannot be translated. | CMessageSource |
Property Details
basePath
property
public string $basePath;
the base path for all translated messages. Defaults to null, meaning the "messages" subdirectory of the application directory (e.g. "protected/messages").
cachingDuration
property
public integer $cachingDuration;
the time in seconds that the messages can remain valid in cache. Defaults to 0, meaning the caching is disabled.
Method Details
init()
method
|
public void init()
|
Initializes the application component. This method overrides the parent implementation by preprocessing the user request data.
loadMessages()
method
|
protected array loadMessages(string $category, string $language)
| ||
| $category | string | the message category |
| $language | string | the target language |
| {return} | array | the loaded messages |
Loads the message translation for the specified language and category.