0 关注者

类 yii\i18n\GettextMoFile

所有类 | 属性 | 方法
继承关系yii\i18n\GettextMoFile » yii\i18n\GettextFile » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/i18n/GettextMoFile.php

GettextMoFile 代表一个 MO Gettext 消息文件。

本类代码改编自 PEAR 中 Michael 的 Gettext_MO 类。请参考以下许可条款。

版权所有 (c) 2004-2005，Michael Wallner [email protected]。保留所有权利。

在满足以下条件的情况下，允许以源代码和二进制形式重新分发和使用，无论是否修改

* 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.

本软件由版权持有人和贡献者“按原样”提供，并且不提供任何明示或暗示的担保，包括但不限于适销性和特定用途适用性的暗示担保。在任何情况下，版权持有人或贡献者均不对任何直接、间接、附带、特殊、惩罚性或后果性损害（包括但不限于替代商品或服务的采购；使用、数据或利润损失；或业务中断）负责，无论其原因如何以及在任何责任理论下，无论是基于合同、严格责任或侵权行为（包括疏忽或其他原因），即使已告知可能会发生此类损害。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$useBigEndian boolean 读取和写入整数时是否使用大端序。 yii\i18n\GettextMoFile

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置，即已定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值，指示属性是否可读。 yii\base\Component
canSetProperty() 返回一个值，指示属性是否可设置。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
hasEventHandlers() 返回一个值，指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值，指示此组件是否定义了属性。 yii\base\Component
init() 初始化对象。 yii\base\BaseObject
load() 从 MO 文件加载消息。 yii\i18n\GettextMoFile
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
save() 将消息保存到 MO 文件。 yii\i18n\GettextMoFile
trigger() 触发事件。 yii\base\Component

受保护的方法

隐藏继承的方法

方法 描述 定义于
readBytes() 读取一个或多个字节。 yii\i18n\GettextMoFile
readInteger() 读取一个 4 字节整数。 yii\i18n\GettextMoFile
readString() 读取字符串。 yii\i18n\GettextMoFile
writeBytes() 写入字节。 yii\i18n\GettextMoFile
writeInteger() 写入一个 4 字节整数。 yii\i18n\GettextMoFile
writeString() 写入字符串。 yii\i18n\GettextMoFile

属性详情

隐藏继承的属性

$useBigEndian 公共属性

读取和写入整数时是否使用大端序。

public boolean $useBigEndian = false

方法详情

隐藏继承的方法

__call() 公共方法

定义于： yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有命名方法，如果可用，将执行它。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用它。

public mixed __call ( $name, $params )
$name string

方法名称
$params array

方法参数
返回值 mixed

方法返回值
抛出 yii\base\UnknownMethodException

调用未知方法时

 

                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() 公共方法

定义于： yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后被调用。

它会移除所有的行为，因为它们附加到了旧的对象上。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}
__construct() 公共方法

定义于： yii\base\BaseObject::__construct()

构造函数。

默认实现做了两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()。

如果此方法在子类中被重写，建议

  • 构造函数的最后一个参数是一个配置数组，如这里的 $config。
  • 在构造函数的末尾调用父类的实现。
public void __construct ( $config = [] )
$config array

用于初始化对象属性的键值对

 

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

定义于： yii\base\Component::__get()

返回组件属性的值。

此方法将按照以下顺序检查并相应地执行

  • 由 getter 定义的属性：返回 getter 的结果
  • 行为的属性：返回行为属性的值

不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 $value = $component->property; 时会被隐式调用。

另见 __set()。

public mixed __get ( $name )
$name string

属性名称
返回值 mixed

属性值或行为属性的值
抛出 yii\base\UnknownPropertyException

如果属性未定义
抛出 yii\base\InvalidCallException

如果属性是只写属性。

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公共方法

定义于： yii\base\Component::__isset()

检查属性是否已设置，即已定义且不为 null。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性：返回属性是否已设置
  • 行为的属性：返回属性是否已设置
  • 对于不存在的属性返回 false

不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 isset($component->property) 时会被隐式调用。

另见 https://php.ac.cn/manual/en/function.isset.php。

public boolean __isset ( $name )
$name string

属性名称或事件名称
返回值 boolean

命名的属性是否已设置

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}
__set() 公共方法

定义于： yii\base\Component::__set()

设置组件属性的值。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性：设置属性值
  • “on xyz” 格式的事件：将处理程序附加到事件“xyz”
  • “as xyz” 格式的行为：附加名为“xyz”的行为
  • 行为的属性：设置行为属性的值

不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 $component->property = $value; 时会被隐式调用。

另见 __get()。

public void __set ( $name, $value )
$name string

属性名称或事件名称
$value mixed

属性值
抛出 yii\base\UnknownPropertyException

如果属性未定义
抛出 yii\base\InvalidCallException

如果属性是只读属性。

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
__unset() 公共方法

定义于： yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性：将属性值设置为 null
  • 行为的属性：将属性值设置为 null

不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 unset($component->property) 时会被隐式调用。

另见 https://php.ac.cn/manual/en/function.unset.php。

public void __unset ( $name )
$name string

属性名称
抛出 yii\base\InvalidCallException

如果属性是只读属性。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
attachBehavior() 公共方法

定义于： yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后，行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另见 detachBehavior()。

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。
$behavior 字符串|数组|yii\base\Behavior

行为配置。可以是以下之一
返回值 yii\base\Behavior

行为对象

 

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}
attachBehaviors() 公共方法

定义于： yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都按其名称索引，并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或一个用于创建行为的配置数组。

另见 attachBehavior()。

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

 

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}
behaviors() 公共方法

定义于： yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以重写此方法来指定它们想要表现出的行为。

此方法的返回值应该是一个行为对象或配置数组，按行为名称索引。行为配置可以是指定行为类的字符串，也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意，行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当数组键使用名称时，使用此名称，行为以后可以使用 getBehavior() 检索，或使用 detachBehavior() 分离。匿名行为无法检索或分离。

在此方法中声明的行为将自动（按需）附加到组件。

public array behaviors ( )
返回值 array

行为配置。

 

                public function behaviors()
{
    return [];
}
canGetProperty() 公共方法

定义于： yii\base\Component::canGetProperty()

返回一个值，指示属性是否可读。

如果满足以下条件，则可以读取属性：

  • 类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；
  • 附加的行为具有给定名称的可读属性（当 $checkBehaviors 为 true 时）。

另请参阅 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
$checkBehaviors boolean

是否将行为的属性视为此组件的属性
返回值 boolean

属性是否可读

 

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}
canSetProperty() 公共方法

定义于： yii\base\Component::canSetProperty()

返回一个值，指示属性是否可设置。

如果满足以下条件，则可以写入属性：

  • 类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；
  • 附加的行为具有给定名称的可写属性（当 $checkBehaviors 为 true 时）。

另请参阅 canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
$checkBehaviors boolean

是否将行为的属性视为此组件的属性
返回值 boolean

属性是否可写

 

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}
className() 公共静态方法
自 2.0.14 版起已弃用。在 PHP >=5.5 上，请改用 ::class。

定义于： yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detachBehavior() 公共方法

定义于： yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。
返回值 yii\base\Behavior|null

分离的行为。如果行为不存在，则为 null。

 

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}
detachBehaviors() 公共方法

定义于： yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}
ensureBehaviors() 公共方法

定义于： yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}
getBehavior() 公共方法

定义于： yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称
返回值 yii\base\Behavior|null

行为对象，如果行为不存在则为 null

 

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
getBehaviors() 公共方法

定义于： yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
hasEventHandlers() 公共方法

定义于： yii\base\Component::hasEventHandlers()

返回一个值，指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称
返回值 boolean

事件是否已附加任何处理程序。

 

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}
hasMethod() 公共方法

定义于： yii\base\Component::hasMethod()

返回一个值，指示方法是否已定义。

如果满足以下条件，则定义了方法：

  • 类具有与指定名称相同的方法
  • 附加的行为具有给定名称的方法（当 $checkBehaviors 为 true 时）。
public boolean hasMethod ( $name, $checkBehaviors = true )
$name string

属性名称
$checkBehaviors boolean

是否将行为的方法视为此组件的方法
返回值 boolean

方法是否已定义

 

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}
hasProperty() 公共方法

定义于： yii\base\Component::hasProperty()

返回一个值，指示此组件是否定义了属性。

如果满足以下条件，则定义了属性：

  • 类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；
  • 附加的行为具有给定名称的属性（当 $checkBehaviors 为 true 时）。

另请参阅

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
$checkBehaviors boolean

是否将行为的属性视为此组件的属性
返回值 boolean

属性是否已定义

 

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
init() 公共方法

定义于： yii\base\BaseObject::init()

初始化对象。

此方法在对象使用给定配置初始化后，在构造函数结束时被调用。

public void init ( )

                public function init()
{
}
load() 公共方法

从 MO 文件加载消息。

public array load ( $filePath, $context )
$filePath string

文件路径
$context string

消息上下文
返回值 array

消息翻译。数组键是源消息，数组值是翻译后的消息：源消息 => 翻译后的消息。
抛出 yii\base\Exception

如果无法读取 MO 文件

 

                public function load($filePath, $context)
{
    if (false === ($fileHandle = @fopen($filePath, 'rb'))) {
        throw new Exception('Unable to read file "' . $filePath . '".');
    }
    if (false === @flock($fileHandle, LOCK_SH)) {
        throw new Exception('Unable to lock file "' . $filePath . '" for reading.');
    }
    // magic
    $array = unpack('c', $this->readBytes($fileHandle, 4));
    $magic = current($array);
    if ($magic == -34) {
        $this->useBigEndian = false;
    } elseif ($magic == -107) {
        $this->useBigEndian = true;
    } else {
        throw new Exception('Invalid MO file: ' . $filePath . ' (magic: ' . $magic . ').');
    }
    // revision
    $revision = $this->readInteger($fileHandle);
    if ($revision !== 0) {
        throw new Exception('Invalid MO file revision: ' . $revision . '.');
    }
    $count = $this->readInteger($fileHandle);
    $sourceOffset = $this->readInteger($fileHandle);
    $targetOffset = $this->readInteger($fileHandle);
    $sourceLengths = [];
    $sourceOffsets = [];
    fseek($fileHandle, $sourceOffset);
    for ($i = 0; $i < $count; ++$i) {
        $sourceLengths[] = $this->readInteger($fileHandle);
        $sourceOffsets[] = $this->readInteger($fileHandle);
    }
    $targetLengths = [];
    $targetOffsets = [];
    fseek($fileHandle, $targetOffset);
    for ($i = 0; $i < $count; ++$i) {
        $targetLengths[] = $this->readInteger($fileHandle);
        $targetOffsets[] = $this->readInteger($fileHandle);
    }
    $messages = [];
    for ($i = 0; $i < $count; ++$i) {
        $id = $this->readString($fileHandle, $sourceLengths[$i], $sourceOffsets[$i]);
        $separatorPosition = strpos((string)$id, chr(4));
        if ((!$context && $separatorPosition === false) || ($context && $separatorPosition !== false && strncmp($id, $context, $separatorPosition) === 0)) {
            if ($separatorPosition !== false) {
                $id = substr($id, $separatorPosition + 1);
            }
            $message = $this->readString($fileHandle, $targetLengths[$i], $targetOffsets[$i]);
            $messages[$id] = $message;
        }
    }
    @flock($fileHandle, LOCK_UN);
    @fclose($fileHandle);
    return $messages;
}
off() 公共方法

定义于： yii\base\Component::off()

从此组件分离现有的事件处理程序。

此方法与 on() 相反。

注意：如果为事件名称传递了通配符模式，则只会删除使用此通配符注册的处理程序，而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()。

public boolean off ( $name, $handler = null )
$name string

事件名称
$handler callable|null

要删除的事件处理程序。如果为 null，则将删除附加到指定事件的所有处理程序。
返回值 boolean

如果找到并分离了处理程序

 

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}
on() 公共方法

定义于： yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义，

function ($event)

其中$event是一个yii\base\Event对象，其中包含与事件关联的参数。

从 2.0.14 开始，您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()。

public void on ( $name, $handler, $data = null, $append = true )
$name string

事件名称
$handler callable

事件处理程序
$data mixed

触发事件时要传递给事件处理程序的数据。当调用事件处理程序时，可以通过 yii\base\Event::$data 访问此数据。
$append boolean

是否将新的事件处理程序附加到现有处理程序列表的末尾。如果为 false，则新的处理程序将插入到现有处理程序列表的开头。

 

                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 string readBytes ( $fileHandle, $byteCount = 1 )
$fileHandle resource

从中读取
$byteCount integer

要读取的
返回值 string

字节

 

                protected function readBytes($fileHandle, $byteCount = 1)
{
    if ($byteCount > 0) {
        return fread($fileHandle, $byteCount);
    }
    return null;
}
readInteger() 受保护方法

读取一个 4 字节整数。

protected integer readInteger ( $fileHandle )
$fileHandle resource

从中读取
返回值 integer

结果

 

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

读取字符串。

protected string readString ( $fileHandle, $length, $offset = null )
$fileHandle resource

文件句柄
$length integer

字符串的
$offset integer|null

文件中字符串的偏移量。如果为 null，则从当前位置读取。
返回值 string

结果

 

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

将消息保存到 MO 文件。

public void save ( $filePath, $messages )
$filePath string

文件路径
$messages array

消息翻译。数组键是源消息，数组值是翻译后的消息：源消息 => 翻译后的消息。请注意，如果消息具有上下文，则消息 ID 必须以上下文为前缀，并以 chr(4) 作为分隔符。
抛出 yii\base\Exception

如果无法保存 MO 文件

 

                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() 公共方法

定义于： yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序，包括类级处理程序。

public void trigger ( $name, yii\base\Event $event = null )
$name string

事件名称
$event yii\base\Event|null

事件实例。如果未设置，则将创建一个默认的 yii\base\Event 对象。

 

                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 integer writeBytes ( $fileHandle, $bytes )
$fileHandle resource

写入到
$bytes string

要写入的
返回值 integer

写入的字节数

 

                protected function writeBytes($fileHandle, $bytes)
{
    return fwrite($fileHandle, $bytes);
}
writeInteger() 受保护方法

写入一个 4 字节整数。

protected integer writeInteger ( $fileHandle, $integer )
$fileHandle resource

写入到
$integer

 integer

要写入的
返回值 integer

写入的字节数

 

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

写入字符串。

受保护 整数 writeString ( $fileHandle, $string )
$fileHandle resource

写入到
$string string

要写入的
返回值 integer

写入的字节数

 

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