0 follower

類別 yii\i18n\GettextMessageSource

繼承yii\i18n\GettextMessageSource » yii\i18n\MessageSource » yii\base\Component » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/i18n/GettextMessageSource.php

GettextMessageSource 代表一個基於 GNU Gettext 的訊息來源。

每個 GettextMessageSource 實例代表單一網域的訊息翻譯。而每個訊息類別代表 Gettext 中的訊息上下文。翻譯後的訊息會儲存為 MO 或 PO 檔案,取決於 $useMoFile 屬性值。

所有翻譯都儲存在 $basePath 目錄下。

單一語言的翻譯會以 MO 或 PO 檔案的形式保存在個別子目錄下,子目錄名稱為語言 ID。檔案名稱透過 $catalog 屬性指定,預設為 'messages'。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$basePath 字串 訊息檔案的基礎目錄 yii\i18n\GettextMessageSource
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$catalog 字串 訊息檔案的子目錄 yii\i18n\GettextMessageSource
$forceTranslation 布林 當來源語言和目標語言相同時,是否強制訊息翻譯。 yii\i18n\MessageSource
$sourceLanguage 字串|null 原始訊息使用的語言。 yii\i18n\MessageSource
$useBigEndian 布林 讀取和寫入整數時是否使用大端序 yii\i18n\GettextMessageSource
$useMoFile 布林 是否使用產生的 MO 檔案 yii\i18n\GettextMessageSource

公開方法

隱藏繼承的方法

方法 描述 定義於
__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\GettextMessageSource
loadFallbackMessages() 此方法通常由 loadMessages() 呼叫,以載入語言的後備訊息。 yii\i18n\GettextMessageSource
loadMessages() 載入指定 $language 和 $category 的訊息翻譯。 yii\i18n\GettextMessageSource
loadMessagesFromFile() 載入指定語言和類別的訊息翻譯,如果檔案不存在則傳回 null。 yii\i18n\GettextMessageSource
translateMessage() 翻譯指定的訊息。 yii\i18n\MessageSource

事件

隱藏繼承的事件

事件 類型 描述 定義於
EVENT_MISSING_TRANSLATION yii\i18n\MissingTranslationEvent 當找不到訊息翻譯時觸發的事件。 yii\i18n\MessageSource

常數

隱藏繼承的常數

常數 描述 定義於
MO_FILE_EXT '.mo' yii\i18n\GettextMessageSource
PO_FILE_EXT '.po' yii\i18n\GettextMessageSource

屬性詳細資訊

隱藏繼承的屬性

$basePath 公有屬性

訊息檔案的基礎目錄

public string $basePath '@app/messages'
$catalog 公有屬性

訊息檔案的子目錄

public string $catalog 'messages'
$useBigEndian 公有屬性

讀取和寫入整數時是否使用大端序

public boolean $useBigEndian false
$useMoFile 公有屬性

是否使用產生的 MO 檔案

public boolean $useMoFile true

方法詳情

隱藏繼承的方法

__call() 公有方法

定義於: yii\base\Component::__call()

呼叫指定的非類別方法。

此方法將檢查是否有任何附加的行為具有指定名稱的方法,如果有,則會執行它。

請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當調用未知方法時會被隱式呼叫。

public mixed __call ( $name, $params )
$name 字串

方法名稱

$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 字串

屬性名稱

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.dev.org.tw/manual/en/function.isset.php

public boolean __isset ( $name )
$name 字串

屬性名稱或事件名稱

return 布林

具名屬性是否已設定

                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 字串

屬性名稱或事件名稱

$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.dev.org.tw/manual/en/function.unset.php

public void __unset ( $name )
$name 字串

屬性名稱

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 字串

行為的名稱。

$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 字串

屬性名稱

$checkVars 布林

是否將成員變數視為屬性

$checkBehaviors 布林

是否將行為的屬性視為此元件的屬性

return 布林

屬性是否可以讀取

                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 字串

屬性名稱

$checkVars 布林

是否將成員變數視為屬性

$checkBehaviors 布林

是否將行為的屬性視為此元件的屬性

return 布林

屬性是否可以寫入

                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 字串

此類別的完整限定名稱。

                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 字串

行為的名稱。

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 字串

行為名稱

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 ( $language )
$language 字串

目標語言

return 字串

訊息檔案路徑

                protected function getMessageFilePath($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 . '/' . $this->catalog;
    if ($this->useMoFile) {
        $messageFile .= self::MO_FILE_EXT;
    } else {
        $messageFile .= self::PO_FILE_EXT;
    }
    return $messageFile;
}

            
hasEventHandlers() 公有方法

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指示是否有任何處理常式附加到指定的事件。

public boolean hasEventHandlers ( $name )
$name 字串

事件名稱

return 布林

是否有任何處理器附加到事件。

                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 字串

屬性名稱

$checkBehaviors 布林

是否將行為的方法視為此元件的方法

return 布林

方法是否已定義

                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 字串

屬性名稱

$checkVars 布林

是否將成員變數視為屬性

$checkBehaviors 布林

是否將行為的屬性視為此元件的屬性

return 布林

屬性是否已定義

                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() 呼叫,以載入語言的後備訊息。

方法嘗試載入 $category 訊息的 $fallbackLanguage,並將它們添加到 $messages 陣列。

protected array loadFallbackMessages ( $category, $fallbackLanguage, $messages, $originalMessageFile )
$category 字串

訊息類別

$fallbackLanguage 字串

目標備用語言

$messages array

先前載入的翻譯訊息陣列。鍵是原始訊息,值是翻譯後的訊息。

$originalMessageFile 字串

包含訊息的檔案路徑。用於記錄找不到翻譯時的錯誤訊息。

return array

載入的訊息。鍵是原始訊息,值是翻譯後的訊息。

                protected function loadFallbackMessages($category, $fallbackLanguage, $messages, $originalMessageFile)
{
    $fallbackMessageFile = $this->getMessageFilePath($fallbackLanguage);
    $fallbackMessages = $this->loadMessagesFromFile($fallbackMessageFile, $category);
    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 字串

訊息類別

$language 字串

目標語言

return array

已載入的訊息。索引鍵是原始訊息,值是翻譯後的訊息。

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

            
loadMessagesFromFile() protected method

載入指定語言和類別的訊息翻譯,如果檔案不存在則傳回 null。

protected array|null loadMessagesFromFile ( $messageFile, $category )
$messageFile 字串

訊息檔案路徑

$category 字串

訊息類別

return array|null

訊息陣列;若找不到檔案則為 null

                protected function loadMessagesFromFile($messageFile, $category)
{
    if (is_file($messageFile)) {
        if ($this->useMoFile) {
            $gettextFile = new GettextMoFile(['useBigEndian' => $this->useBigEndian]);
        } else {
            $gettextFile = new GettextPoFile();
        }
        $messages = $gettextFile->load($messageFile, $category);
        if (!is_array($messages)) {
            $messages = [];
        }
        return $messages;
    }
    return null;
}

            
off() public method

定義於: yii\base\Component::off()

從此組件中分離現有的事件處理常式。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則僅會移除使用此萬用字元註冊的處理常式,而使用與此萬用字元匹配的純名稱註冊的處理常式將保留。

另請參閱 on()

public boolean off ( $name, $handler null )
$name 字串

事件名稱

$handler callable|null

要移除的事件處理常式。如果為 null,則將移除附加到指定名稱事件的所有處理常式。

return 布林

如果找到並分離處理常式

                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() public method

定義於: 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 字串

事件名稱

$handler callable

事件處理常式

$data mixed

事件觸發時要傳遞給事件處理常式的資料。當調用事件處理常式時,可以透過 yii\base\Event::$data 存取此資料。

$append 布林

是否將新的事件處理常式附加到現有處理常式列表的末尾。如果為 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() public method

定義於: yii\i18n\MessageSource::translate()

將訊息翻譯成指定的語言。

請注意,除非 $forceTranslation 為 true,否則如果目標語言與 來源語言 相同,則不會翻譯訊息。

如果找不到翻譯,將觸發 missingTranslation 事件。

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

訊息類別

$message 字串

要翻譯的訊息

$language 字串

目標語言

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() protected method

定義於: yii\i18n\MessageSource::translateMessage()

翻譯指定的訊息。

如果找不到訊息,將觸發 missingTranslation 事件。如果存在事件處理常式,則可能會提供 fallback translation (後備翻譯)。如果未提供後備翻譯,則此方法將返回 false

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

訊息所屬的類別。

$message 字串

要翻譯的訊息。

$language 字串

目標語言。

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() public method

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。它會調用事件的所有附加處理常式,包括類別層級處理常式。

public void trigger ( $name, yii\base\Event $event null )
$name 字串

事件名稱

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