類別 yii\widgets\Breadcrumbs
麵包屑顯示連結列表,指示目前頁面在整個網站層次結構中的位置。
例如,像「首頁 / 範例文章 / 編輯」這樣的麵包屑表示使用者正在檢視「範例文章」的編輯頁面。 他可以點擊「範例文章」來檢視該頁面,或者他可以點擊「首頁」返回首頁。
若要使用麵包屑,您需要設定其 $links 屬性,該屬性指定要顯示的連結。 例如,
// $this is the view object currently being used
echo Breadcrumbs::widget([
'itemTemplate' => "<li><i>{link}</i></li>\n", // template for all links
'links' => [
[
'label' => 'Post Category',
'url' => ['post-category/view', 'id' => 10],
'template' => "<li><b>{link}</b></li>\n", // template for this link only
],
['label' => 'Sample Post', 'url' => ['post/edit', 'id' => 1]],
'Edit',
],
]);
由於麵包屑通常會出現在網站的幾乎每個頁面中,您可以考慮將其放置在佈局視圖中。 您可以使用視圖參數 (例如 $this->params['breadcrumbs']
) 來設定不同視圖中的連結。 在佈局視圖中,您可以將此視圖參數指派給 $links 屬性,如下所示
// $this is the view object currently being used
echo Breadcrumbs::widget([
'links' => isset($this->params['breadcrumbs']) ? $this->params['breadcrumbs'] : [],
]);
公開屬性
屬性 | 類型 | 描述 | 定義於 |
---|---|---|---|
$activeItemTemplate | string | 用於呈現麵包屑中每個活動項目的範本。 | yii\widgets\Breadcrumbs |
$autoIdPrefix | string | 自動產生的 widget ID 的前綴。 | yii\base\Widget |
$behaviors | yii\base\Behavior[] | 附加到此元件的行為列表。 | yii\base\Component |
$encodeLabels | boolean | 是否要將連結標籤進行 HTML 編碼。 | yii\widgets\Breadcrumbs |
$homeLink | array|null | 麵包屑中的第一個超連結 (稱為首頁連結)。 | yii\widgets\Breadcrumbs |
$id | string|null | Widget 的 ID。 | yii\base\Widget |
$itemTemplate | string | 用於呈現麵包屑中每個非活動項目的範本。 | yii\widgets\Breadcrumbs |
$links | array | 要顯示在麵包屑中的連結列表。 | yii\widgets\Breadcrumbs |
$options | array | 麵包屑容器標籤的 HTML 屬性。 | yii\widgets\Breadcrumbs |
$tag | string | 麵包屑容器標籤的名稱。 | yii\widgets\Breadcrumbs |
$view | yii\web\View | 可用於呈現視圖或視圖檔案的視圖物件。 | yii\base\Widget |
$viewPath | string | 包含此 widget 的視圖檔案的目錄。 | yii\base\Widget |
公開方法
事件
事件 | 類型 | 描述 | 定義於 |
---|---|---|---|
EVENT_AFTER_RUN | yii\base\WidgetEvent | 在執行小工具後立即觸發的事件。(自版本 2.0.11 起可用) | yii\base\Widget |
EVENT_BEFORE_RUN | yii\base\WidgetEvent | 在執行小工具前立即觸發的事件。(自版本 2.0.11 起可用) | yii\base\Widget |
EVENT_INIT | yii\base\Event | 當小工具透過 init() 初始化時觸發的事件。(自版本 2.0.11 起可用) | yii\base\Widget |
屬性詳情
用於呈現麵包屑導航中每個活動項目的範本。符記 {link}
將被替換為每個活動項目的實際 HTML 連結。
麵包屑導航中的第一個超連結(稱為首頁連結)。關於連結的格式,請參閱 $links。如果未設定此屬性,則預設為指向 yii\web\Application::$homeUrl 且標籤為 'Home' 的連結。如果此屬性為 false,則不會呈現首頁連結。
用於呈現麵包屑導航中每個非活動項目的範本。符記 {link}
將被替換為每個非活動項目的實際 HTML 連結。
將顯示在麵包屑導航中的連結列表。如果此屬性為空,小工具將不會呈現任何內容。每個陣列元素代表麵包屑導航中的單個連結,具有以下結構
[
'label' => 'label of the link', // required
'url' => 'url of the link', // optional, will be processed by Url::to()
'template' => 'own template of the item', // optional, if not set $this->itemTemplate will be used
]
如果連結處於活動狀態,您只需要指定其「標籤」,並且您可以直接使用 $label
,而不是寫成 ['label' => $label]
。
自版本 2.0.1 起,每個連結的任何額外陣列元素都將被視為超連結標籤的 HTML 屬性。例如,以下連結規範將產生一個具有 CSS 類別 external
的超連結
[
'label' => 'demo',
'url' => 'https://example.com',
'class' => 'external',
]
自版本 2.0.3 起,每個單獨的連結都可以覆蓋全域 $encodeLabels 參數,如下所示
[
'label' => '<strong>Hello!</strong>',
'encode' => false,
]
麵包屑容器標籤的 HTML 屬性。
另請參閱 yii\helpers\Html::renderTagAttributes(),以瞭解屬性如何呈現的詳細資訊。
方法詳情
定義於:yii\base\Component::__call()
呼叫指定的非類別方法。
此方法將檢查是否有任何附加的行為具有指定名稱的方法,如果有,則會執行它。
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當調用未知方法時會被隱式呼叫。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名稱 |
$params | array |
方法參數 |
返回 | mixed |
方法返回值 |
---|---|---|
拋出 | yii\base\UnknownMethodException |
當調用未知方法時 |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定義於: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();
}
定義於:yii\base\Component::__get()
傳回元件屬性的值。
此方法將按以下順序檢查並相應地執行操作
- 由 getter 定義的屬性:返回 getter 結果
- 行為的屬性:返回行為屬性值
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當執行 $value = $component->property;
時會被隱式呼叫。
另請參閱 __set()。
public mixed __get ( $name ) | ||
$name | string |
屬性名稱 |
返回 | mixed |
屬性值或行為屬性的值 |
---|---|---|
拋出 | yii\base\UnknownPropertyException |
如果未定義屬性 |
拋出 | yii\base\InvalidCallException |
如果屬性是唯寫的。 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定義於:yii\base\Component::__isset()
檢查屬性是否已設定,即已定義且非 null。
此方法將按以下順序檢查並相應地執行操作
- 由 setter 定義的屬性:返回屬性是否已設定
- 行為的屬性:返回屬性是否已設定
- 對於不存在的屬性,返回
false
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當執行 isset($component->property)
時會被隱式呼叫。
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;
}
定義於:yii\base\Component::__set()
設定元件屬性的值。
此方法將按以下順序檢查並相應地執行操作
- 由 setter 定義的屬性:設定屬性值
- 格式為「on xyz」的事件:將處理程序附加到事件「xyz」
- 格式為「as xyz」的行為:附加名為「xyz」的行為
- 行為的屬性:設定行為屬性值
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當執行 $component->property = $value;
時會被隱式呼叫。
另請參閱 __get()。
public void __set ( $name, $value ) | ||
$name | string |
屬性名稱或事件名稱 |
$value | mixed |
屬性值 |
拋出 | yii\base\UnknownPropertyException |
如果未定義屬性 |
---|---|---|
拋出 | yii\base\InvalidCallException |
如果屬性是唯讀的。 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
定義於:yii\base\Component::__unset()
將元件屬性設定為 null。
此方法將按以下順序檢查並相應地執行操作
- 由 setter 定義的屬性:將屬性值設定為 null
- 行為的屬性:將屬性值設定為 null
請勿直接呼叫此方法,因為它是 PHP 的魔術方法,當執行 unset($component->property)
時會被隱式呼叫。
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);
}
定義於:yii\base\Widget::afterRun()
此方法在 widget 執行後立即調用。
此方法將觸發 EVENT_AFTER_RUN 事件。該方法的返回值將用作小工具的返回值。
如果您覆寫此方法,您的程式碼應如下所示
public function afterRun($result)
{
$result = parent::afterRun($result);
// your custom code here
return $result;
}
public mixed afterRun ( $result ) | ||
$result | mixed |
小工具的返回結果。 |
返回 | mixed |
已處理的小工具結果。 |
---|
public function afterRun($result)
{
$event = new WidgetEvent();
$event->result = $result;
$this->trigger(self::EVENT_AFTER_RUN, $event);
return $event->result;
}
定義於:yii\base\Component::attachBehavior()
將行為附加到此元件。
此方法將基於給定的配置建立行為物件。之後,將通過呼叫 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);
}
定義於: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);
}
}
定義於:yii\base\Widget::beforeRun()
此方法在 widget 執行前立即調用。
此方法將觸發 EVENT_BEFORE_RUN 事件。該方法的返回值將決定小工具是否應繼續運行。
當覆寫此方法時,請確保您像下面這樣呼叫父級實作
public function beforeRun()
{
if (!parent::beforeRun()) {
return false;
}
// your custom code here
return true; // or false to not run the widget
}
public boolean beforeRun ( ) | ||
返回 | boolean |
小工具是否應繼續執行。 |
---|
public function beforeRun()
{
$event = new WidgetEvent();
$this->trigger(self::EVENT_BEFORE_RUN, $event);
return $event->isValid;
}
開始一個 widget。
此方法建立呼叫類別的實例。它將把配置應用於建立的實例。稍後應呼叫匹配的 end() 呼叫。由於某些小工具可能會使用輸出緩衝,因此應在同一個視圖中進行 end() 呼叫,以避免破壞輸出緩衝的巢狀結構。
另請參閱 end()。
public static static begin ( $config = [] ) | ||
$config | array |
將用於初始化物件屬性的名稱-值對 |
返回 | yii\base\Widget |
新建立的小工具實例 |
---|
public static function begin($config = [])
{
$config['class'] = get_called_class();
/* @var $widget Widget */
$widget = Yii::createObject($config);
self::$stack[] = $widget;
return $widget;
}
定義於:yii\base\Component::behaviors()
傳回此元件應表現為的行為列表。
子類別可以覆寫此方法以指定它們想要表現的行為。
此方法的返回值應為行為物件或配置的陣列,並按行為名稱索引。行為配置可以是指定行為類別的字串,也可以是以下結構的陣列
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
請注意,行為類別必須從 yii\base\Behavior 擴展。可以使用名稱或匿名方式附加行為。當名稱用作陣列鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為,或使用 detachBehavior() 分離行為。匿名行為無法檢索或分離。
在此方法中宣告的行為將自動(按需)附加到組件。
public array behaviors ( ) | ||
返回 | array |
行為配置。 |
---|
public function behaviors()
{
return [];
}
定義於:yii\base\Component::canGetProperty()
傳回一個值,指示是否可以讀取屬性。
如果滿足以下條件,則可以讀取屬性
- 類別具有與指定名稱關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的可讀屬性(當
$checkBehaviors
為 true 時)。
另請參閱 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
$checkBehaviors | boolean |
是否將行為的屬性視為此組件的屬性 |
返回 | boolean |
屬性是否可以讀取 |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
定義於:yii\base\Component::canSetProperty()
傳回一個值,指示是否可以設定屬性。
如果滿足以下條件,則可以寫入屬性
- 類別具有與指定名稱關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的可寫屬性(當
$checkBehaviors
為 true 時)。
另請參閱 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
$checkBehaviors | boolean |
是否將行為的屬性視為此組件的屬性 |
返回 | boolean |
屬性是否可以寫入 |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
。
定義於: yii\base\BaseObject::className()
傳回此類別的完整限定名稱。
public static string className ( ) | ||
返回 | string |
此類別的完整限定名稱。 |
---|
public static function className()
{
return get_called_class();
}
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;
}
定義於: yii\base\Component::detachBehaviors()
從元件分離所有行為。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
public static static end ( ) | ||
返回 | yii\base\Widget |
已結束的小部件實例。 |
---|---|---|
拋出 | yii\base\InvalidCallException |
public static function end()
{
if (!empty(self::$stack)) {
$widget = array_pop(self::$stack);
$calledClass = get_called_class();
if (Yii::$container->has($calledClass) && isset(Yii::$container->getDefinitions()[$calledClass]['class'])) {
$calledClass = Yii::$container->getDefinitions()[$calledClass]['class'];
}
if (get_class($widget) === $calledClass) {
/* @var $widget Widget */
if ($widget->beforeRun()) {
$result = $widget->run();
$result = $widget->afterRun($result);
echo $result;
}
return $widget;
}
throw new InvalidCallException('Expecting end() of ' . get_class($widget) . ', found ' . get_called_class());
}
throw new InvalidCallException('Unexpected ' . get_called_class() . '::end() call. A matching begin() is not found.');
}
定義於: 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);
}
}
}
定義於: yii\base\Component::getBehavior()
傳回指定名稱的行為物件。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
行為名稱 |
返回 | yii\base\Behavior|null |
行為物件,如果行為不存在,則為 null |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定義於: yii\base\Component::getBehaviors()
傳回附加到此元件的所有行為。
public yii\base\Behavior[] getBehaviors ( ) | ||
返回 | yii\base\Behavior[] |
附加到此組件的行為列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
傳回 widget 的 ID。
public string|null getId ( $autoGenerate = true ) | ||
$autoGenerate | boolean |
如果先前未設定 ID,是否自動產生 ID |
返回 | string|null |
Widget 的 ID。 |
---|
public function getId($autoGenerate = true)
{
if ($autoGenerate && $this->_id === null) {
$this->_id = static::$autoIdPrefix . static::$counter++;
}
return $this->_id;
}
定義於: yii\base\Widget::getView()
傳回可用於呈現視圖或視圖檔案的視圖物件。
The render() 和 renderFile() 方法將使用此視圖物件來實現實際的視圖渲染。如果未設定,它將預設為 "view" 應用程式組件。
public yii\web\View getView ( ) | ||
返回 | yii\web\View |
可用於呈現視圖或視圖檔案的視圖物件。 |
---|
public function getView()
{
if ($this->_view === null) {
$this->_view = Yii::$app->getView();
}
return $this->_view;
}
public string getViewPath ( ) | ||
返回 | string |
包含此 widget 的視圖檔案的目錄。 |
---|
public function getViewPath()
{
$class = new ReflectionClass($this);
return dirname($class->getFileName()) . DIRECTORY_SEPARATOR . 'views';
}
定義於: yii\base\Component::hasEventHandlers()
傳回一個值,指示是否有名稱事件附加任何處理常式。
public boolean hasEventHandlers ( $name ) | ||
$name | string |
事件名稱 |
返回 | boolean |
是否有任何處理器附加到事件。 |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
定義於: yii\base\Component::hasMethod()
傳回一個值,指示是否已定義方法。
如果滿足以下條件,則定義方法
- 類別具有指定名稱的方法
- 附加的行為具有 ... 的方法 (當
$checkBehaviors
為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkBehaviors | boolean |
是否將行為的方法視為此組件的方法 |
返回 | boolean |
方法是否已定義 |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
定義於: yii\base\Component::hasProperty()
傳回一個值,指示是否為此元件定義屬性。
如果滿足以下條件,則定義屬性
- 類別具有與指定名稱相關聯的 getter 或 setter 方法 (在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的屬性 (當
$checkBehaviors
為 true 時)。
另請參閱
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
$checkBehaviors | boolean |
是否將行為的屬性視為此組件的屬性 |
返回 | boolean |
屬性是否已定義 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
public void init ( ) |
public function init()
{
parent::init();
$this->trigger(self::EVENT_INIT);
}
定義於: yii\base\Component::off()
從此元件分離現有的事件處理常式。
此方法與 on() 相反。
注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理器,而使用與此萬用字元匹配的純名稱註冊的處理器將保持不變。
另請參閱 on()。
public boolean off ( $name, $handler = null ) | ||
$name | string |
事件名稱 |
$handler | callable|null |
要移除的事件處理器。如果為 null,則會移除附加到具名事件的所有處理器。 |
返回 | boolean |
如果找到並分離處理器 |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
將事件處理常式附加到事件。
事件處理器必須是有效的 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]);
}
}
定義於: yii\base\Widget::render()
呈現視圖。
要渲染的視圖可以使用以下格式之一指定
- 路徑別名 (例如 "@app/views/site/index");
- 應用程式內的絕對路徑 (例如 "//site/index"):視圖名稱以雙斜線開頭。實際的視圖檔案將在應用程式的 視圖路徑 下查找。
- 模組內的絕對路徑 (例如 "/site/index"):視圖名稱以單斜線開頭。實際的視圖檔案將在當前活動模組的 視圖路徑 下查找。
- 相對路徑 (例如 "index"):實際的視圖檔案將在 $viewPath 下查找。
如果視圖名稱不包含檔案副檔名,它將使用預設的 .php
。
public string render ( $view, $params = [] ) | ||
$view | string |
視圖名稱。 |
$params | array |
應在視圖中提供的參數(名稱-值對)。 |
返回 | string |
渲染結果。 |
---|---|---|
拋出 | yii\base\InvalidArgumentException |
如果視圖檔案不存在。 |
public function render($view, $params = [])
{
return $this->getView()->render($view, $params, $this);
}
定義於: yii\base\Widget::renderFile()
呈現視圖檔案。
public string renderFile ( $file, $params = [] ) | ||
$file | string |
要渲染的視圖檔案。這可以是檔案路徑或 路徑別名。 |
$params | array |
應在視圖中提供的參數(名稱-值對)。 |
返回 | string |
渲染結果。 |
---|---|---|
拋出 | yii\base\InvalidArgumentException |
如果視圖檔案不存在。 |
public function renderFile($file, $params = [])
{
return $this->getView()->renderFile($file, $params, $this);
}
呈現單個麵包屑項目。
protected string renderItem ( $link, $template ) | ||
$link | array |
要渲染的連結。它必須包含 "label" 元素。"url" 元素是可選的。 |
$template | string |
用於渲染連結的模板。token "{link}" 將被連結替換。 |
返回 | string |
渲染結果 |
---|---|---|
拋出 | yii\base\InvalidConfigException |
如果 `$link` 沒有 "label" 元素。 |
protected function renderItem($link, $template)
{
$encodeLabel = ArrayHelper::remove($link, 'encode', $this->encodeLabels);
if (array_key_exists('label', $link)) {
$label = $encodeLabel ? Html::encode($link['label']) : $link['label'];
} else {
throw new InvalidConfigException('The "label" element is required for each link.');
}
if (isset($link['template'])) {
$template = $link['template'];
}
if (isset($link['url'])) {
$options = $link;
unset($options['template'], $options['label'], $options['url']);
$link = Html::a($label, $link['url'], $options);
} else {
$link = $label;
}
return strtr($template, ['{link}' => $link]);
}
呈現 widget。
public void run ( ) |
public function run()
{
if (empty($this->links)) {
return;
}
$links = [];
if ($this->homeLink === null) {
$links[] = $this->renderItem([
'label' => Yii::t('yii', 'Home'),
'url' => Yii::$app->homeUrl,
], $this->itemTemplate);
} elseif ($this->homeLink !== false) {
$links[] = $this->renderItem($this->homeLink, $this->itemTemplate);
}
foreach ($this->links as $link) {
if (!is_array($link)) {
$link = ['label' => $link];
}
$links[] = $this->renderItem($link, isset($link['url']) ? $this->itemTemplate : $this->activeItemTemplate);
}
echo Html::tag($this->tag, implode('', $links), $this->options);
}
設定 widget 的 ID。
public void setId ( $value ) | ||
$value | string |
小部件的 ID。 |
public function setId($value)
{
$this->_id = $value;
}
定義於: yii\base\Widget::setView()
設定由此 widget 使用的視圖物件。
public void setView ( $view ) | ||
$view | yii\base\View |
可用於呈現視圖或視圖檔案的視圖物件。 |
public function setView($view)
{
$this->_view = $view;
}
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);
}
public static string widget ( $config = [] ) | ||
$config | array |
將用於初始化物件屬性的名稱-值對 |
返回 | string |
小部件的渲染結果。 |
---|---|---|
拋出 | Throwable |
public static function widget($config = [])
{
ob_start();
ob_implicit_flush(false);
try {
/* @var $widget Widget */
$config['class'] = get_called_class();
$widget = Yii::createObject($config);
$out = '';
if ($widget->beforeRun()) {
$result = $widget->run();
$out = $widget->afterRun($result);
}
} catch (\Exception $e) {
// close the output buffer opened above if it has not been closed already
if (ob_get_level() > 0) {
ob_end_clean();
}
throw $e;
} catch (\Throwable $e) {
// close the output buffer opened above if it has not been closed already
if (ob_get_level() > 0) {
ob_end_clean();
}
throw $e;
}
return ob_get_clean() . $out;
}
註冊 或 登入 以發表評論。