CGettextFile
| Package | system.i18n.gettext |
|---|---|
| Inheritance | abstract class CGettextFile » CComponent |
| Subclasses | CGettextMoFile, CGettextPoFile |
| Since | 1.0 |
| Source Code | framework/i18n/gettext/CGettextFile.php |
CGettextFile is the base class for representing a Gettext message file.
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 |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| 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 |
| load() | Loads messages from a file. | CGettextFile |
| raiseEvent() | Raises an event. | CComponent |
| save() | Saves messages to a file. | CGettextFile |
Method Details
load() method
abstract public array load(string $file, string $context) | ||
| $file | string | file path |
| $context | string | message context |
| {return} | array | message translations (source message => translated message) |
Source Code: framework/i18n/gettext/CGettextFile.php#26 (show)
abstract public function load($file,$context);
Loads messages from a file.
save() method
abstract public void save(string $file, array $messages) | ||
| $file | string | file path |
| $messages | array | message translations (message id => translated message). Note if the message has a context, the message id must be prefixed with the context with chr(4) as the separator. |
Source Code: framework/i18n/gettext/CGettextFile.php#34 (show)
abstract public function save($file,$messages);
Saves messages to a file.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CGettextFile