Class yii\i18n\GettextMoFile

All Classes | Properties | Methods

Inheritance	yii\i18n\GettextMoFile » 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/GettextMoFile.php

GettextMoFile represents an MO Gettext message file.

This class is written by adapting Michael's Gettext_MO class in PEAR. Please refer to the following license terms.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component
$useBigEndian	boolean	Whether to use big-endian when reading and writing an integer.	yii\i18n\GettextMoFile

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 an MO file.	yii\i18n\GettextMoFile
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 an MO file.	yii\i18n\GettextMoFile
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
readBytes()	Reads one or several bytes.	yii\i18n\GettextMoFile
readInteger()	Reads a 4-byte integer.	yii\i18n\GettextMoFile
readString()	Reads a string.	yii\i18n\GettextMoFile
writeBytes()	Write bytes.	yii\i18n\GettextMoFile
writeInteger()	Writes a 4-byte integer.	yii\i18n\GettextMoFile
writeString()	Writes a string.	yii\i18n\GettextMoFile

Property Details

Hide inherited properties

$useBigEndian public property

Whether to use big-endian when reading and writing an integer.

public boolean $useBigEndian = false

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name	string	The method name
$params	array	Method parameters
return	mixed	The method return value
throws	yii\base\UnknownMethodException	when calling unknown method

Source code

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

__clone() public method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

Source code

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

Initializes the object with the given configuration $config.
Call init().

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

public void __construct ( $config = [] )
$config	array	Name-value pairs that will be used to initialize the object properties

Source code

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

public mixed __get ( $name )
$name	string	The property name
return	mixed	The property value or the value of a behavior's property
throws	yii\base\UnknownPropertyException	if the property is not defined
throws	yii\base\InvalidCallException	if the property is write-only.

public boolean __isset ( $name )
$name	string	The property name or the event name
return	boolean	Whether the named property is set

public void __set ( $name, $value )
$name	string	The property name or the event name
$value	mixed	The property value
throws	yii\base\UnknownPropertyException	if the property is not defined
throws	yii\base\InvalidCallException	if the property is read-only.

public void __unset ( $name )
$name	string	The property name
throws	yii\base\InvalidCallException	if the property is read only.

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name	string	The name of the behavior.
$behavior	string\|array\|yii\base\Behavior	The behavior configuration. This can be one of the following: a yii\base\Behavior object a string specifying the behavior class an object configuration array that will be passed to Yii::createObject() to create the behavior object.
return	yii\base\Behavior	The behavior object

public array behaviors ( )
return	array	The behavior configurations.

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	The property name
$checkVars	boolean	Whether to treat member variables as properties
$checkBehaviors	boolean	Whether to treat behaviors' properties as properties of this component
return	boolean	Whether the property can be read

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	The property name
$checkVars	boolean	Whether to treat member variables as properties
$checkBehaviors	boolean	Whether to treat behaviors' properties as properties of this component
return	boolean	Whether the property can be written

public static string className ( )
return	string	The fully qualified name of this class.

public yii\base\Behavior\|null detachBehavior ( $name )
$name	string	The behavior's name.
return	yii\base\Behavior\|null	The detached behavior. Null if the behavior does not exist.

public yii\base\Behavior\|null getBehavior ( $name )
$name	string	The behavior name
return	yii\base\Behavior\|null	The behavior object, or null if the behavior does not exist

public yii\base\Behavior[] getBehaviors ( )
return	yii\base\Behavior[]	List of behaviors attached to this component

public boolean hasEventHandlers ( $name )
$name	string	The event name
return	boolean	Whether there is any handler attached to the event.

public boolean hasMethod ( $name, $checkBehaviors = true )
$name	string	The property name
$checkBehaviors	boolean	Whether to treat behaviors' methods as methods of this component
return	boolean	Whether the method is defined

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	The property name
$checkVars	boolean	Whether to treat member variables as properties
$checkBehaviors	boolean	Whether to treat behaviors' properties as properties of this component
return	boolean	Whether the property is defined

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.
throws	yii\base\Exception	if unable to read the MO file

public boolean off ( $name, $handler = null )
$name	string	Event name
$handler	callable\|null	The event handler to be removed. If it is null, all handlers attached to the named event will be removed.
return	boolean	If a handler is found and detached

See also off().

public void on ( $name, $handler, $data = null, $append = true )
$name	string	The event name
$handler	callable	The event handler
$data	mixed	The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.
$append	boolean	Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Source code

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

readBytes() protected method

Reads one or several bytes.

protected string readBytes ( $fileHandle, $byteCount = 1 )
$fileHandle	resource	To read from
$byteCount	integer	To be read
return	string	Bytes

Source code

                protected function readBytes($fileHandle, $byteCount = 1)
{
    if ($byteCount > 0) {
        return fread($fileHandle, $byteCount);
    }
    return null;
}

readInteger() protected method

Reads a 4-byte integer.

protected integer readInteger ( $fileHandle )
$fileHandle	resource	To read from
return	integer	The result

Source code

                protected function readInteger($fileHandle)
{
    $array = unpack($this->useBigEndian ? 'N' : 'V', $this->readBytes($fileHandle, 4));
    return current($array);
}

readString() protected method

Reads a string.

protected string readString ( $fileHandle, $length, $offset = null )
$fileHandle	resource	File handle
$length	integer	Of the string
$offset	integer\|null	Of the string in the file. If null, it reads from the current position.
return	string	The result

Source code

                protected function readString($fileHandle, $length, $offset = null)
{
    if ($offset !== null) {
        fseek($fileHandle, $offset);
    }
    return $this->readBytes($fileHandle, $length);
}

save() public method

Saves messages to an MO 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.
throws	yii\base\Exception	if unable to save the MO file

Source code

                public function save($filePath, $messages)
{
    if (false === ($fileHandle = @fopen($filePath, 'wb'))) {
        throw new Exception('Unable to write file "' . $filePath . '".');
    }
    if (false === @flock($fileHandle, LOCK_EX)) {
        throw new Exception('Unable to lock file "' . $filePath . '" for reading.');
    }
    // magic
    if ($this->useBigEndian) {
        $this->writeBytes($fileHandle, pack('c*', 0x95, 0x04, 0x12, 0xde)); // -107
    } else {
        $this->writeBytes($fileHandle, pack('c*', 0xde, 0x12, 0x04, 0x95)); // -34
    }
    // revision
    $this->writeInteger($fileHandle, 0);
    // message count
    $messageCount = count($messages);
    $this->writeInteger($fileHandle, $messageCount);
    // offset of source message table
    $offset = 28;
    $this->writeInteger($fileHandle, $offset);
    $offset += $messageCount * 8;
    $this->writeInteger($fileHandle, $offset);
    // hashtable size, omitted
    $this->writeInteger($fileHandle, 0);
    $offset += $messageCount * 8;
    $this->writeInteger($fileHandle, $offset);
    // length and offsets for source messages
    foreach (array_keys($messages) as $id) {
        $length = strlen($id);
        $this->writeInteger($fileHandle, $length);
        $this->writeInteger($fileHandle, $offset);
        $offset += $length + 1;
    }
    // length and offsets for target messages
    foreach ($messages as $message) {
        $length = strlen($message);
        $this->writeInteger($fileHandle, $length);
        $this->writeInteger($fileHandle, $offset);
        $offset += $length + 1;
    }
    // source messages
    foreach (array_keys($messages) as $id) {
        $this->writeString($fileHandle, $id);
    }
    // target messages
    foreach ($messages as $message) {
        $this->writeString($fileHandle, $message);
    }
    @flock($fileHandle, LOCK_UN);
    @fclose($fileHandle);
}

trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event = null )
$name	string	The event name
$event	yii\base\Event\|null	The event instance. If not set, a default yii\base\Event object will be created.

Source code

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

writeBytes() protected method

Write bytes.

protected integer writeBytes ( $fileHandle, $bytes )
$fileHandle	resource	To write to
$bytes	string	To be written
return	integer	How many bytes are written

Source code

                protected function writeBytes($fileHandle, $bytes)
{
    return fwrite($fileHandle, $bytes);
}

writeInteger() protected method

Writes a 4-byte integer.

protected integer writeInteger ( $fileHandle, $integer )
$fileHandle	resource	To write to
$integer	integer	To be written
return	integer	How many bytes are written

Source code

                protected function writeInteger($fileHandle, $integer)
{
    return $this->writeBytes($fileHandle, pack($this->useBigEndian ? 'N' : 'V', (int) $integer));
}

writeString() protected method

Writes a string.

protected integer writeString ( $fileHandle, $string )
$fileHandle	resource	To write to
$string	string	To be written
return	integer	How many bytes are written

Source code

                protected function writeString($fileHandle, $string)
{
    return $this->writeBytes($fileHandle, $string . "\0");
}

public void attachBehaviors ( $behaviors )
$behaviors	array	List of behaviors to be attached to the component