0 追蹤者 (follower)

類別 (Class) yii\i18n\PhpMessageSource

繼承 (Inheritance)yii\i18n\PhpMessageSource » yii\i18n\MessageSource » 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/PhpMessageSource.php

PhpMessageSource 代表一個訊息來源,將翻譯訊息儲存在 PHP 腳本中。(PhpMessageSource represents a message source that stores translated messages in PHP scripts.)

PhpMessageSource 使用 PHP 陣列來保存訊息翻譯。(PhpMessageSource uses PHP arrays to keep message translations.)

  • 每個 PHP 腳本包含一個陣列,該陣列儲存特定語言和單一訊息類別的訊息翻譯;(Each PHP script contains one array which stores the message translations in one particular language and for a single message category;)
  • 每個 PHP 腳本都以 "$basePath/LanguageID/CategoryName.php" 命名並儲存為檔案;(Each PHP script is saved as a file named as "$basePath/LanguageID/CategoryName.php";)
  • 在每個 PHP 腳本中,訊息翻譯都以如下陣列形式返回 (Within each PHP script, the message translations are returned as an array like the following)
return [
    'original message 1' => 'translated message 1',
    'original message 2' => 'translated message 2',
];

您可以使用 $fileMap 自訂類別名稱和檔案名稱之間的關聯。(You may use $fileMap to customize the association between category names and the file names.)

公開屬性 (Public Properties)

隱藏繼承的屬性 (Hide inherited properties)

屬性 (Property) 類型 (Type) 描述 (Description) 定義於 (Defined By)
$basePath string 所有翻譯訊息的基礎路徑。(The base path for all translated messages.) yii\i18n\PhpMessageSource
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。(List of behaviors attached to this component.) yii\base\Component
$fileMap array 訊息類別與對應訊息檔案路徑之間的映射。(Mapping between message categories and the corresponding message file paths.) yii\i18n\PhpMessageSource
$forceTranslation boolean 當來源和目標語言相同時,是否強制訊息翻譯。(Whether to force message translation when the source and target languages are the same.) yii\i18n\MessageSource
$sourceLanguage string|null 原始訊息所使用的語言。(The language that the original messages are in.) yii\i18n\MessageSource

公開方法 (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() 檢查屬性是否已設定,即已定義且非 null。(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() 將元件屬性設定為 null。(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() 確保在 behaviors() 中宣告的行為已附加到此元件。(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 this component.) yii\i18n\MessageSource
off() 從此元件中分離現有的事件處理常式。(Detaches an existing event handler from this component.) yii\base\Component
on() 將事件處理常式附加到事件。(Attaches an event handler to an event.) yii\base\Component
translate() 將訊息翻譯成指定的語言。(Translates a message to the specified language.) yii\i18n\MessageSource
trigger() 觸發事件。(Triggers an event.) yii\base\Component

受保護方法 (Protected Methods)

隱藏繼承的方法 (Hide inherited methods)

方法 (Method) 描述 (Description) 定義於 (Defined By)
getMessageFilePath() 傳回指定語言和類別的訊息檔案路徑。(Returns message file path for the specified language and category.) yii\i18n\PhpMessageSource
loadFallbackMessages() 此方法通常由 loadMessages() 呼叫,以載入語言的後備訊息。(The method is normally called by loadMessages() to load the fallback messages for the language.) yii\i18n\PhpMessageSource
loadMessages() 載入指定的 $language 和 $category 的訊息翻譯。(Loads the message translation for the specified $language and $category.) yii\i18n\PhpMessageSource
loadMessagesFromFile() 載入指定語言和類別的訊息翻譯,如果檔案不存在則傳回 null。(Loads the message translation for the specified language and category or returns null if file doesn't exist.) yii\i18n\PhpMessageSource
translateMessage() 翻譯指定的訊息。(Translates the specified message.) yii\i18n\MessageSource

事件 (Events)

隱藏繼承的事件 (Hide inherited events)

事件 (Event) 類型 (Type) 描述 (Description) 定義於 (Defined By)
EVENT_MISSING_TRANSLATION yii\i18n\MissingTranslationEvent 當找不到訊息翻譯時觸發的事件。(An event that is triggered when a message translation is not found.) yii\i18n\MessageSource

屬性詳情 (Property Details)

隱藏繼承的屬性 (Hide inherited properties)

$basePath public property

所有翻譯訊息的基礎路徑。預設為 '@app/messages'。(The base path for all translated messages. Defaults to '@app/messages'. )

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

訊息類別與對應訊息檔案路徑之間的映射。檔案路徑相對於 $basePath。例如,

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

方法詳情

隱藏繼承的方法 (Hide inherited methods)

__call() 公有方法

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

呼叫指定的非類別方法。(Calls the named method which is not a class method.)

此方法將檢查是否有任何附加的行為具有指定的名稱方法,並在可用的情況下執行它。

請勿直接呼叫此方法,因為它是一個 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()

在透過複製現有物件建立物件後,會呼叫此方法。(This method is called after the object is created by cloning an existing one.)

它會移除所有行為,因為它們附加到舊物件。

public void __clone ( )

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

            
__construct() 公有方法

定義於: yii\base\BaseObject::__construct()

建構子。(Constructor.)

預設實作會執行兩件事

  • 使用給定的組態 $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()

傳回元件屬性的值。(Returns the value of a component property.)

此方法將依以下順序檢查並採取相應行動

  • 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。(Checks if a property is set, i.e. defined and not null.)

此方法將依以下順序檢查並採取相應行動

  • setter 定義的屬性:傳回屬性是否已設定
  • 行為的屬性:傳回屬性是否已設定
  • 對於不存在的屬性,傳回 false

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 isset($component->property) 時將會被隱式呼叫。

另請參閱 https://php.dev.org.tw/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()

設定元件屬性的值。(Sets the value of a component property.)

此方法將依以下順序檢查並採取相應行動

  • 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。(Sets a component property to be null.)

此方法將依以下順序檢查並採取相應行動

  • setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 unset($component->property) 時將會被隱式呼叫。

另請參閱 https://php.dev.org.tw/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()

將行為附加到此元件。(Attaches a behavior to this component.)

此方法將根據給定的組態建立行為物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。

另請參閱 detachBehavior()

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

行為的名稱。

$behavior string|array|yii\base\Behavior

行為組態。這可以是下列其中之一

傳回 yii\base\Behavior

行為物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公有方法

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

將行為列表附加到元件。(Attaches a list of behaviors to the component.)

每個行為都以其名稱索引,並且應該是一個 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()

傳回此元件應表現為的行為列表。(Returns a list of behaviors that this component should behave as.)

子類別可以覆寫此方法,以指定它們想要表現為的行為。

此方法的傳回值應該是一個行為物件或組態的陣列,以行為名稱索引。行為組態可以是指定行為類別的字串,或是具有以下結構的陣列

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

傳回一個值,指示屬性是否可讀取。(Returns a value indicating whether a property can be read.)

如果滿足以下條件,則可以讀取屬性

  • 類別具有與指定名稱相關聯的 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()

傳回一個值,指示屬性是否可設定。(Returns a value indicating whether a property can be set.)

如果滿足以下條件,則可以寫入屬性

  • 類別具有與指定名稱相關聯的 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()

傳回此類別的完整限定名稱。(Returns the fully qualified name of this class.)

public static string className ( )
傳回 string

此類別的完整限定名稱。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() 公有方法

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

從元件中分離行為。(Detaches a behavior from the component.)

將會呼叫行為的 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()

從元件中分離所有行為。(Detaches all behaviors from the component.)

public void detachBehaviors ( )

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

            
ensureBehaviors() 公有方法

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

確保在 behaviors() 中宣告的行為已附加到此元件。(Makes sure that the behaviors declared in behaviors() are attached to this component.)

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

傳回指定的行為物件。(Returns the named behavior object.)

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

傳回附加到此元件的所有行為。(Returns all behaviors attached to this component.)

public yii\base\Behavior[] getBehaviors ( )
傳回 yii\base\Behavior[]

附加到此元件的行為列表

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

            
getMessageFilePath() 受保護方法

傳回指定語言和類別的訊息檔案路徑。(Returns message file path for the specified language and category.)

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

訊息類別

$language string

目標語言

傳回 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()

傳回一個值,指示是否有名稱事件的任何處理常式。(Returns a value indicating whether there is any handler attached to the named event.)

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

傳回一個值,指示是否已定義方法。(Returns a value indicating whether a method is defined.)

如果滿足以下條件,則定義方法

  • 類別具有指定名稱的方法
  • 附加的行為具有給定名稱的方法(當 $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()

傳回一個值,指示是否為此元件定義了屬性。(Returns a value indicating whether a property is defined for this component.)

如果滿足以下條件,則定義屬性

  • 類別具有與指定名稱相關聯的 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\i18n\MessageSource::init()

初始化此元件。(Initializes this component.)

public void init ( )

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

            
loadFallbackMessages() 受保護方法 (自 2.0.7 版本起可用)

此方法通常由 loadMessages() 呼叫,以載入語言的後備訊息。(The method is normally called by loadMessages() to load the fallback messages for the language.)

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

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

訊息類別

$fallbackLanguage string

目標後備語言

$messages array

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

$originalMessageFile string

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

傳回 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 的訊息翻譯。(Loads the message translation for the specified $language and $category.)

如果找不到特定地區代碼(例如 en-US)的翻譯,它會嘗試更通用的 en。當兩者都存在時,en-US 訊息將合併到 en 之上。詳情請參閱 loadFallbackMessages()。如果 $language$sourceLanguage 不具體,則此方法將嘗試載入 $sourceLanguage 的訊息。例如:$sourceLanguageen-GB$languageen。此方法將載入 en 的訊息並將它們合併到 en-GB 之上。

另請參閱

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

訊息類別

$language string

目標語言

傳回 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。(Loads the message translation for the specified language and category or returns null if file doesn't exist.)

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

訊息檔案路徑

傳回 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()

從此元件中分離現有的事件處理常式。(Detaches an existing event handler from this component.)

此方法與 on() 相反。

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

另請參閱 on()

public 布林值 off ( $name, $handler null )
$name string

事件名稱

$handler 可呼叫|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() public 方法

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

將事件處理常式附加到事件。(Attaches an event handler to an event.)

事件處理器必須是有效的 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 可呼叫

事件處理器

$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() public 方法

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

將訊息翻譯成指定的語言。(Translates a message to the specified language.)

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

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

public 字串|布林值 translate ( $category, $message, $language )
$category string

訊息類別

$message string

要翻譯的訊息

$language string

目標語言

傳回 字串|布林值

已翻譯的訊息,如果找不到翻譯或不需要翻譯,則為 false

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

            
translateMessage() protected 方法

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

翻譯指定的訊息。(Translates the specified message.)

如果找不到訊息,將會觸發 missingTranslation 事件。如果存在事件處理器,它可能會提供回退翻譯。如果沒有提供回退翻譯,此方法將返回 false

protected 字串|布林值 translateMessage ( $category, $message, $language )
$category string

訊息所屬的類別。

$message string

要翻譯的訊息。

$language string

目標語言。

傳回 字串|布林值

已翻譯的訊息,如果找不到翻譯,則為 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 方法

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

觸發事件。(Triggers an event.)

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

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