0 關注者

類別 yii\base\Theme

所有類別 | 屬性 | 方法
繼承yii\base\Theme » yii\base\Component » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/base/Theme.php

Theme 代表應用程式主題。

當 yii\base\View 渲染視圖檔案時，它會檢查活動主題，查看是否存在該視圖檔案的主題版本。 如果是，將會渲染主題版本。

主題是一個目錄，其中包含視圖檔案，旨在取代其非主題對應檔案。

Theme 使用 $pathMap 來實現視圖檔案的替換

  1. 它首先在 $pathMap 中尋找一個鍵，該鍵是給定視圖檔案路徑的子字串；
  2. 如果存在這樣的鍵，則對應的值將用於替換視圖檔案路徑中的對應部分；
  3. 然後它將檢查更新後的視圖檔案是否存在。 如果存在，則該檔案將用於替換原始視圖檔案。
  4. 如果步驟 2 或 3 失敗，將使用原始視圖檔案。

例如，如果 $pathMap 是 ['@app/views' => '@app/themes/basic']，則視圖檔案 @app/views/site/index.php 的主題版本將是 @app/themes/basic/site/index.php。

可以將單一路徑映射到多個路徑。 例如，

'pathMap' => [
    '@app/views' => [
        '@app/themes/christmas',
        '@app/themes/basic',
    ],
]

在這種情況下，主題版本可以是 @app/themes/christmas/site/index.php 或 @app/themes/basic/site/index.php。 如果兩個檔案都存在，前者優先於後者。

要使用主題，您應該像下面這樣配置 "view" 應用程式組件的 theme 屬性

'view' => [
    'theme' => [
        'basePath' => '@app/themes/basic',
        'baseUrl' => '@web/themes/basic',
    ],
],

上述配置指定了一個主題，該主題位於包含應用程式入口腳本的 Web 資料夾的 "themes/basic" 目錄下。 如果您的主題旨在處理模組，您可以像上面描述的那樣配置 $pathMap 屬性。

有關 Theme 的更多詳細資訊和使用資訊，請參閱關於主題化的指南文章。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$basePath 字串 此主題的根路徑。 yii\base\Theme
$baseUrl 字串 此主題的基本 URL (不含結尾斜線)。 yii\base\Theme
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$pathMap 陣列|空值 視圖目錄及其對應主題版本之間的映射。 yii\base\Theme

公共方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫指定的非類別方法。 yii\base\Component
__clone() 在通過克隆現有對象創建對象後調用此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回組件屬性的值。 yii\base\Component
__isset() 檢查是否已設定屬性，即已定義且非空值。 yii\base\Component
__set() 設定組件屬性的值。 yii\base\Component
__unset() 將組件屬性設定為空值。 yii\base\Component
applyTo() 如果可能，將檔案轉換為主題檔案。 yii\base\Theme
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
getBasePath() yii\base\Theme
getBaseUrl() yii\base\Theme
getBehavior() 傳回指定的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有行為。 yii\base\Component
getPath() 使用 $basePath 將相對檔案路徑轉換為絕對路徑。 yii\base\Theme
getUrl() 使用 $baseUrl 將相對 URL 轉換為絕對 URL。 yii\base\Theme
hasEventHandlers() 傳回一個值，指示是否有名稱事件附加任何處理常式。 yii\base\Component
hasMethod() 傳回一個值，指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值，指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\base\BaseObject
off() 從此元件移除現有的事件處理器。 yii\base\Component
on() 將事件處理器附加到事件。 yii\base\Component
setBasePath() yii\base\Theme
setBaseUrl() yii\base\Theme
trigger() 觸發一個事件。 yii\base\Component

屬性詳細資訊

隱藏繼承的屬性

$basePath public property

此主題的根路徑。此主題的所有資源都位於此目錄下。

public string $basePath = null
$baseUrl public property

此主題的基礎 URL (不包含結尾斜線)。此主題的所有資源都被視為位於此基礎 URL 之下。

public string $baseUrl = null
$pathMap public property

檢視目錄及其對應主題化版本之間的映射。當檢視嘗試套用主題時，applyTo() 會使用此屬性。在指定目錄時可以使用 路徑別名。如果此屬性為空或未設定，則會使用從 yii\base\Application::$basePath 到 $basePath 的映射。

public array|null $pathMap = null

方法詳細資訊

隱藏繼承的方法

__call() public method

定義於： 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() public method

定義於： yii\base\Component::__clone()

在通過克隆現有對象創建對象後調用此方法。

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

public void __clone ( )

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

定義於： 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() public method

定義於： 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() public method

定義於： yii\base\Component::__isset()

檢查是否已設定屬性，即已定義且非空值。

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

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

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

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name 字串

屬性名稱或事件名稱
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() public method

定義於： 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() public method

定義於： yii\base\Component::__unset()

將組件屬性設定為空值。

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

  • 由 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);
}
applyTo() public method

如果可能，將檔案轉換為主題檔案。

如果沒有對應的主題檔案，將會傳回原始檔案。

public string applyTo ( $path )
$path 字串

要主題化的檔案
return 字串

主題化的檔案，如果主題版本不可用，則為原始檔案。
throws yii\base\InvalidConfigException

如果未設定 $basePath

 

                public function applyTo($path)
{
    $pathMap = $this->pathMap;
    if (empty($pathMap)) {
        if (($basePath = $this->getBasePath()) === null) {
            throw new InvalidConfigException('The "basePath" property must be set.');
        }
        $pathMap = [Yii::$app->getBasePath() => [$basePath]];
    }
    $path = FileHelper::normalizePath($path);
    foreach ($pathMap as $from => $tos) {
        $from = FileHelper::normalizePath(Yii::getAlias($from)) . DIRECTORY_SEPARATOR;
        if (strpos($path, $from) === 0) {
            $n = strlen($from);
            foreach ((array) $tos as $to) {
                $to = FileHelper::normalizePath(Yii::getAlias($to)) . DIRECTORY_SEPARATOR;
                $file = $to . substr($path, $n);
                if (is_file($file)) {
                    return $file;
                }
            }
        }
    }
    return $path;
}
attachBehavior() public method

定義於： 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() public method

定義於： 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() public method

定義於： 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() public method

定義於： yii\base\Component::canGetProperty()

傳回一個值，指示是否可以讀取屬性。

如果符合以下條件，則可以讀取屬性

  • 類別具有與指定名稱關聯的 getter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；
  • 附加的行為具有給定名稱的可讀屬性（當 $checkBehaviors 為 true 時）。

另請參閱 canSetProperty()。

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

屬性名稱
$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() public method

定義於： yii\base\Component::canSetProperty()

傳回一個值，指示是否可以設定屬性。

如果符合以下條件，則可以寫入屬性

  • 類別具有與指定名稱關聯的 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；
  • 附加的行為具有給定名稱的可寫入屬性（當 $checkBehaviors 為 true 時）。

另請參閱 canGetProperty()。

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

屬性名稱
$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() public static method
自 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() public method

定義於： 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() public method

定義於： yii\base\Component::detachBehaviors()

從組件中分離所有行為。

public void detachBehaviors ( )

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

定義於： 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);
        }
    }
}
getBasePath() public method

另請參閱 $pathMap。

public string getBasePath ( )
return 字串

此主題的根路徑。此主題的所有資源都位於此目錄下。

 

                public function getBasePath()
{
    return $this->_basePath;
}
getBaseUrl() public method

public string getBaseUrl ( )
return 字串

此主題的基礎 URL (不包含結尾斜線)。此主題的所有資源都被視為位於此基礎 URL 之下。

 

                public function getBaseUrl()
{
    return $this->_baseUrl;
}
getBehavior() public method

定義於： 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() public method

定義於： yii\base\Component::getBehaviors()

傳回附加到此組件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此元件的行為列表

 

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

使用 $basePath 將相對檔案路徑轉換為絕對路徑。

public string getPath ( $path )
$path 字串

要轉換的相對檔案路徑。
return 字串

絕對檔案路徑
throws yii\base\InvalidConfigException

如果未設定 $basePath

 

                public function getPath($path)
{
    if (($basePath = $this->getBasePath()) !== null) {
        return $basePath . DIRECTORY_SEPARATOR . ltrim($path, '/\\');
    }
    throw new InvalidConfigException('The "basePath" property must be set.');
}
getUrl() public method

使用 $baseUrl 將相對 URL 轉換為絕對 URL。

public string getUrl ( $url )
$url 字串

要轉換的相對 URL。
return 字串

絕對 URL
throws yii\base\InvalidConfigException

如果未設定 $baseUrl

 

                public function getUrl($url)
{
    if (($baseUrl = $this->getBaseUrl()) !== null) {
        return $baseUrl . '/' . ltrim($url, '/');
    }
    throw new InvalidConfigException('The "baseUrl" property must be set.');
}
hasEventHandlers() public 方法

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

傳回一個值，指示是否有名稱事件附加任何處理常式。

public boolean hasEventHandlers ( $name )
$name 字串

事件名稱
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() public 方法

定義於： yii\base\Component::hasMethod()

傳回一個值，指示是否已定義方法。

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

  • 類別具有指定名稱的方法
  • 附加的行為具有給定名稱的方法（當 $checkBehaviors 為 true 時）。
public boolean hasMethod ( $name, $checkBehaviors = true )
$name 字串

屬性名稱
$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() public 方法

定義於： yii\base\Component::hasProperty()

傳回一個值，指示是否為此組件定義了屬性。

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

  • 類別具有與指定名稱關聯的 getter 或 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；
  • 附加的行為具有給定名稱的屬性（當 $checkBehaviors 為 true 時）。

另請參閱

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

屬性名稱
$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() public 方法

定義於： yii\base\BaseObject::init()

初始化物件。

在物件使用給定配置初始化之後，此方法會在建構子的結尾被調用。

public void init ( )

                public function init()
{
}
off() public 方法

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

從此元件移除現有的事件處理器。

此方法與 on() 相反。

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

另請參閱 on()。

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

事件名稱
$handler callable|null

要移除的事件處理器。如果為 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() public 方法

定義於： 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 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]);
    }
}
setBasePath() public 方法

另請參閱 $pathMap。

public void setBasePath ( $path )
$path 字串

此主題的根路徑或 路徑別名。此主題的所有資源都位於此目錄下。

 

                public function setBasePath($path)
{
    $this->_basePath = Yii::getAlias($path);
}
setBaseUrl() public 方法

public void setBaseUrl ( $url )
$url 字串

此主題的基本 URL 或 路徑別名。此主題的所有資源都被視為在此基本 URL 下。

 

                public function setBaseUrl($url)
{
    $this->_baseUrl = $url === null ? null : rtrim(Yii::getAlias($url), '/');
}
trigger() public 方法

定義於： 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);
}