Class yii\i18n\GettextPoFile

All Classes | Properties | Methods

Inheritance	yii\i18n\GettextPoFile » yii\i18n\GettextFile » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/i18n/GettextPoFile.php

GettextPoFile represents a PO Gettext message file.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\base\BaseObject
load()	Loads messages from a PO file.	yii\i18n\GettextPoFile
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
save()	Saves messages to a PO file.	yii\i18n\GettextPoFile
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
decode()	Decodes special characters in a message.	yii\i18n\GettextPoFile
encode()	Encodes special characters in a message.	yii\i18n\GettextPoFile

Method Details

decode() protected method

Decodes special characters in a message.

protected string decode ( $string )
$string	string	Message to be decoded
return	string	The decoded message

encode() protected method

Encodes special characters in a message.

protected string encode ( $string )
$string	string	Message to be encoded
return	string	The encoded message

load() public method

Loads messages from a PO file.

public array load ( $filePath, $context )
$filePath	string	File path
$context	string	Message context
return	array	Message translations. Array keys are source messages and array values are translated messages: source message => translated message.

save() public method

Saves messages to a PO file.

public void save ( $filePath, $messages )
$filePath	string	File path
$messages	array	Message translations. Array keys are source messages and array values are translated messages: source message => translated message. Note if the message has a context, the message ID must be prefixed with the context with chr(4) as the separator.