0 关注者

类 yii\i18n\PhpMessageSource

继承yii\i18n\PhpMessageSource » yii\i18n\MessageSource » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/i18n/PhpMessageSource.php

PhpMessageSource 代表一个消息源,它将翻译后的消息存储在 PHP 脚本中。

PhpMessageSource 使用 PHP 数组来保存消息翻译。

  • 每个 PHP 脚本包含一个数组,该数组存储了一种特定语言和一个单一消息类别中的消息翻译;
  • 每个 PHP 脚本都以一个名为 "$basePath/LanguageID/CategoryName.php" 的文件保存;
  • 在每个 PHP 脚本中,消息翻译都以如下数组形式返回
return [
    'original message 1' => 'translated message 1',
    'original message 2' => 'translated message 2',
];

您可以使用 $fileMap 来自定义类别名称和文件名之间的关联。

公共属性

隐藏继承属性

属性 类型 描述 定义
$basePath string 所有翻译消息的基路径。 yii\i18n\PhpMessageSource
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$fileMap array 消息类别与其对应消息文件路径之间的映射。 yii\i18n\PhpMessageSource
$forceTranslation boolean 当源语言和目标语言相同时,是否强制消息翻译。 yii\i18n\MessageSource
$sourceLanguage string|null 原始消息所在的语言。 yii\i18n\MessageSource

公共方法

隐藏继承方法

方法 描述 定义
__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\i18n\MessageSource
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
translate() 将消息翻译成指定的语言。 yii\i18n\MessageSource
trigger() 触发事件。 yii\base\Component

受保护的方法

隐藏继承方法

方法 描述 定义
getMessageFilePath() 返回指定语言和类别的消息文件路径。 yii\i18n\PhpMessageSource
loadFallbackMessages() 此方法通常由 loadMessages() 调用来加载语言的回退消息。 yii\i18n\PhpMessageSource
loadMessages() 加载指定 $language 和 $category 的消息翻译。 yii\i18n\PhpMessageSource
loadMessagesFromFile() 加载指定语言和类别的消息翻译,如果文件不存在则返回 null。 yii\i18n\PhpMessageSource
translateMessage() 翻译指定的消息。 yii\i18n\MessageSource

事件

隐藏继承事件

事件 类型 描述 定义
EVENT_MISSING_TRANSLATION yii\i18n\MissingTranslationEvent 当找不到消息翻译时触发的事件。 yii\i18n\MessageSource

属性详情

隐藏继承属性

$basePath 公共属性

所有翻译消息的基路径。默认为 '@app/messages'。

public string $basePath '@app/messages'
$fileMap 公共属性

消息类别与其对应消息文件路径之间的映射。文件路径相对于 $basePath。例如,

[
    'core' => 'core.php',
    'ext' => 'extensions.php',
]
public array $fileMap null

方法详情

隐藏继承方法

__call() 公共方法

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

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

此方法将检查是否有任何附加行为具有命名方法,并在可用时执行它。

不要直接调用此方法,因为它是当调用未知方法时隐式调用的 PHP 魔术方法。

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

方法名

$params array

方法参数

return mixed

方法返回值

throws 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

属性名称

return mixed

属性值或行为属性的值

throws yii\base\UnknownPropertyException

如果未定义属性

throws 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

属性名称或事件名称

return 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

属性值

throws yii\base\UnknownPropertyException

如果未定义属性

throws 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

属性名称

throws 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 string|array|yii\base\Behavior

行为配置。这可以是以下之一

return 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 ( )
return 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

是否将行为的属性视为此组件的属性

return 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

是否将行为的属性视为此组件的属性

return 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 ( )
return 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

行为的名称。

return 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

行为名称

return 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 ( )
return yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getMessageFilePath() 受保护方法

返回指定语言和类别的消息文件路径。

protected string getMessageFilePath ( $category, $language )
$category string

消息类别

$language string

目标语言

return string

消息文件的路径

                protected function getMessageFilePath($category, $language)
{
    $language = (string) $language;
    if ($language !== '' && !preg_match('/^[a-z0-9_-]+$/i', $language)) {
        throw new InvalidArgumentException(sprintf('Invalid language code: "%s".', $language));
    }
    $messageFile = Yii::getAlias($this->basePath) . "/$language/";
    if (isset($this->fileMap[$category])) {
        $messageFile .= $this->fileMap[$category];
    } else {
        $messageFile .= str_replace('\\', '/', $category) . '.php';
    }
    return $messageFile;
}

            
hasEventHandlers() 公共方法

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

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

public boolean hasEventHandlers ( $name )
$name string

事件名称

return 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

是否将行为的方法视为此组件的方法

return 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 为真时)。

另请参阅

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

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

return boolean

属性是否已定义

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

            
init() 公共方法

定义于: yii\i18n\MessageSource::init()

初始化此组件。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->sourceLanguage === null) {
        $this->sourceLanguage = Yii::$app->sourceLanguage;
    }
}

            
loadFallbackMessages() 受保护方法(从版本 2.0.7 开始可用)

此方法通常由 loadMessages() 调用来加载语言的回退消息。

此方法尝试加载 $fallbackLanguage 的 $category 消息,并将它们添加到 $messages 数组中。

protected array loadFallbackMessages ( $category, $fallbackLanguage, $messages, $originalMessageFile )
$category string

消息类别

$fallbackLanguage string

目标回退语言

$messages array

先前加载的翻译消息数组。键是原始消息,值是翻译后的消息。

$originalMessageFile string

包含消息的文件的路径。用于在未找到翻译时记录错误消息。

return array

加载的消息。键是原始消息,值是翻译后的消息。

                protected function loadFallbackMessages($category, $fallbackLanguage, $messages, $originalMessageFile)
{
    $fallbackMessageFile = $this->getMessageFilePath($category, $fallbackLanguage);
    $fallbackMessages = $this->loadMessagesFromFile($fallbackMessageFile);
    if (
        $messages === null && $fallbackMessages === null
        && $fallbackLanguage !== $this->sourceLanguage
        && strpos($this->sourceLanguage, $fallbackLanguage) !== 0
    ) {
        Yii::error("The message file for category '$category' does not exist: $originalMessageFile "
            . "Fallback file does not exist as well: $fallbackMessageFile", __METHOD__);
    } elseif (empty($messages)) {
        return $fallbackMessages;
    } elseif (!empty($fallbackMessages)) {
        foreach ($fallbackMessages as $key => $value) {
            if (!empty($value) && empty($messages[$key])) {
                $messages[$key] = $value;
            }
        }
    }
    return (array) $messages;
}

            
loadMessages() 受保护方法

加载指定 $language 和 $category 的消息翻译。

如果找不到特定区域设置代码(如 en-US)的翻译,它会尝试更通用的 en。如果两者都存在,en-US 消息将合并到 en 上。有关详细信息,请参见 loadFallbackMessages()。如果 $language 比 $sourceLanguage менее конкретно, этот метод попытается загрузить сообщения для $sourceLanguage. 例如:$sourceLanguageen-GB,$language 是 en。此方法将加载 en 的消息并将其合并到 en-GB 上。

另请参阅

protected array loadMessages ( $category, $language )
$category string

消息类别

$language string

目标语言

return array

加载的消息。键是原始消息,值是翻译后的消息。

                protected function loadMessages($category, $language)
{
    $messageFile = $this->getMessageFilePath($category, $language);
    $messages = $this->loadMessagesFromFile($messageFile);
    $fallbackLanguage = substr((string)$language, 0, 2);
    $fallbackSourceLanguage = substr($this->sourceLanguage, 0, 2);
    if ($fallbackLanguage !== '' && $language !== $fallbackLanguage) {
        $messages = $this->loadFallbackMessages($category, $fallbackLanguage, $messages, $messageFile);
    } elseif ($fallbackSourceLanguage !== '' && $language === $fallbackSourceLanguage) {
        $messages = $this->loadFallbackMessages($category, $this->sourceLanguage, $messages, $messageFile);
    } elseif ($messages === null) {
        Yii::warning("The message file for category '$category' does not exist: $messageFile", __METHOD__);
    }
    return (array) $messages;
}

            
loadMessagesFromFile() 受保护方法

加载指定语言和类别的消息翻译,如果文件不存在则返回 null。

protected array|null loadMessagesFromFile ( $messageFile )
$messageFile string

消息文件的路径

return array|null

消息数组,如果文件未找到,则为 null

                protected function loadMessagesFromFile($messageFile)
{
    if (is_file($messageFile)) {
        $messages = include $messageFile;
        if (!is_array($messages)) {
            $messages = [];
        }
        return $messages;
    }
    return null;
}

            
off() 公共方法

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

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

此方法与 on() 相反。

注意:如果事件名称使用通配符模式传递,则只會移除使用此通配符註冊的處理常式,而使用與此通配符匹配的純名稱註冊的處理常式將保留。

另请参阅 on().

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

事件名称

$handler callable|null

要移除的事件处理程序。如果它为空,则将移除附加到指定事件的所有处理程序。

return 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]);
    }
}

            
translate() 公共方法

定义于: yii\i18n\MessageSource::translate()

将消息翻译成指定的语言。

请注意,除非 $forceTranslation 为真,如果目标语言与 源语言 相同,则不会翻译消息。

如果找不到翻译,则会触发 missingTranslation 事件。

public string|boolean translate ( $category, $message, $language )
$category string

消息类别

$message string

要翻译的消息

$language string

目标语言

return string|boolean

翻译后的消息或 false(如果未找到翻译或不需要翻译)

                public function translate($category, $message, $language)
{
    if ($this->forceTranslation || $language !== $this->sourceLanguage) {
        return $this->translateMessage($category, $message, $language);
    }
    return false;
}

            
translateMessage() 受保护方法

定义于: yii\i18n\MessageSource::translateMessage()

翻译指定的消息。

如果找不到消息,则会触发 missingTranslation 事件。如果有事件处理程序,它可能会提供 回退翻译。如果没有提供回退翻译,则此方法将返回 false

protected string|boolean translateMessage ( $category, $message, $language )
$category string

消息所属的类别。

$message string

要翻译的消息。

$language string

目标语言。

return string|boolean

翻译后的消息或 false(如果未找到翻译)。

                protected function translateMessage($category, $message, $language)
{
    $key = $language . '/' . $category;
    if (!isset($this->_messages[$key])) {
        $this->_messages[$key] = $this->loadMessages($category, $language);
    }
    if (isset($this->_messages[$key][$message]) && $this->_messages[$key][$message] !== '') {
        return $this->_messages[$key][$message];
    } elseif ($this->hasEventHandlers(self::EVENT_MISSING_TRANSLATION)) {
        $event = new MissingTranslationEvent([
            'category' => $category,
            'message' => $message,
            'language' => $language,
        ]);
        $this->trigger(self::EVENT_MISSING_TRANSLATION, $event);
        if ($event->translatedMessage !== null) {
            return $this->_messages[$key][$message] = $event->translatedMessage;
        }
    }
    return $this->_messages[$key][$message] = false;
}

            
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);
}