0 追蹤者

抽象類別 yii\data\BaseDataProvider

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

BaseDataProvider 提供了一個基礎類別，實作了 yii\data\DataProviderInterface。

關於 BaseDataProvider 的更多詳細資訊和使用方式，請參閱關於資料提供者的指南文章。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$count integer 目前頁面中的資料模型數量。 yii\data\BaseDataProvider
$id string|null 在所有資料提供者中唯一識別此資料提供者的 ID。 yii\data\BaseDataProvider
$keys array 對應於 $models 的鍵值列表。 yii\data\BaseDataProvider
$models array 目前頁面中的資料模型列表。 yii\data\BaseDataProvider
$pagination yii\data\Pagination|false 分頁物件。 yii\data\BaseDataProvider
$sort yii\data\Sort|boolean 排序物件。 yii\data\BaseDataProvider
$totalCount integer 可能的資料模型總數。 yii\data\BaseDataProvider

公開方法

隱藏繼承的方法

方法 描述 定義於
__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
getCount() 傳回目前頁面中的資料模型數量。 yii\data\BaseDataProvider
getKeys() 傳回與資料模型相關聯的鍵值。 yii\data\BaseDataProvider
getModels() 傳回目前頁面中的資料模型。 yii\data\BaseDataProvider
getPagination() 傳回此資料提供者使用的分頁物件。 yii\data\BaseDataProvider
getSort() 傳回此資料提供者使用的排序物件。 yii\data\BaseDataProvider
getTotalCount() 傳回資料模型的總數。 yii\data\BaseDataProvider
hasEventHandlers() 傳回一個值，指示是否有名稱事件附加任何處理常式。 yii\base\Component
hasMethod() 傳回一個值，指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值，指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\data\BaseDataProvider
off() 從此組件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
prepare() 準備資料模型和鍵。 yii\data\BaseDataProvider
refresh() 重新整理資料提供者。 yii\data\BaseDataProvider
setKeys() 設定與資料模型相關聯的鍵值。 yii\data\BaseDataProvider
setModels() 設定目前頁面中的資料模型。 yii\data\BaseDataProvider
setPagination() 為此資料提供者設定分頁。 yii\data\BaseDataProvider
setSort() 為此資料提供者設定排序定義。 yii\data\BaseDataProvider
setTotalCount() 設定資料模型的總數。 yii\data\BaseDataProvider
trigger() 觸發事件。 yii\base\Component

保護方法

隱藏繼承的方法

方法 描述 定義於
prepareKeys() 準備與目前可用的資料模型相關聯的鍵。 yii\data\BaseDataProvider
prepareModels() 準備將在目前頁面中提供的資料模型。 yii\data\BaseDataProvider
prepareTotalCount() 傳回一個值，指示此資料提供者中資料模型的總數。 yii\data\BaseDataProvider

屬性詳細資訊

隱藏繼承的屬性

$count 公開屬性

目前頁面中的資料模型數量。

public integer $count = null
$id 公開屬性

在所有資料提供者中唯一識別此資料提供者的 ID。如果未設定，則會自動以下列方式產生

  • 第一個資料提供者 ID 為空。
  • 第二個及所有後續資料提供者 ID 為："dp-1"、"dp-2" 等。
public string|null $id = null
$keys 公開屬性

對應於 $models 的鍵值列表。 $models 中的每個資料模型都由此陣列中的對應鍵值唯一識別。

public array $keys = null
$models 公開屬性

目前頁面中的資料模型列表。

public array $models = null
$pagination 公開屬性

分頁物件。如果此值為 false，則表示已停用分頁。請注意，此屬性的類型在 getter 和 setter 中有所不同。有關詳細資訊，請參閱 getPagination() 和 setPagination()。

public yii\data\Pagination|false $pagination = null
$sort 公開屬性

排序物件。如果此值為 false，則表示已停用排序。請注意，此屬性的類型在 getter 和 setter 中有所不同。有關詳細資訊，請參閱 getSort() 和 setSort()。

public yii\data\Sort|boolean $sort = null
$totalCount 公開屬性

可能的資料模型總數。

public integer $totalCount = null

方法詳細資訊

隱藏繼承的方法

__call() 公開方法

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

呼叫非類別方法的具名方法。

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

請勿直接呼叫此方法，因為它是 PHP magic method，當呼叫未知方法時會隱式呼叫。

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

方法名稱
$params array

方法參數
return mixed

方法傳回值
throws yii\base\UnknownMethodException

當呼叫未知方法時

 

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__clone() 公開方法

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

在透過複製現有物件建立物件後呼叫此方法。

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

public void __clone ( )

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

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

建構子。

預設實作執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()。

如果在子類別中覆寫此方法，建議

  • 建構子的最後一個參數是組態陣列，例如此處的 $config。
  • 在建構子的結尾呼叫父級實作。
public void __construct ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值對

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() 公開方法

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

傳回組件屬性的值。

此方法將依以下順序檢查並相應地執行

  • getter 定義的屬性：傳回 getter 結果
  • 行為的屬性：傳回行為屬性值

請勿直接呼叫此方法，因為它是 PHP magic method，當執行 $value = $component->property; 時會隱式呼叫。

另請參閱 __set()。

public mixed __get ( $name )
$name string

屬性名稱
return mixed

屬性值或行為屬性的值
throws yii\base\UnknownPropertyException

如果未定義屬性
throws yii\base\InvalidCallException

如果屬性為唯寫。

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公開方法

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

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

此方法將依以下順序檢查並相應地執行

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

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

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

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱
return boolean

具名屬性是否已設定

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}
__set() 公開方法

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

設定組件屬性的值。

此方法將依以下順序檢查並相應地執行

  • setter 定義的屬性：設定屬性值
  • 格式為 "on xyz" 的事件：將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為：附加名為 "xyz" 的行為
  • 行為的屬性：設定行為屬性值

請勿直接呼叫此方法，因為它是 PHP magic method，當執行 $component->property = $value; 時會隱式呼叫。

另請參閱 __get()。

public void __set ( $name, $value )
$name string

屬性名稱或事件名稱
$value mixed

屬性值
throws yii\base\UnknownPropertyException

如果未定義屬性
throws yii\base\InvalidCallException

如果屬性為唯讀。

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
__unset() 公開方法

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

將組件屬性設定為 null。

此方法將依以下順序檢查並相應地執行

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

請勿直接呼叫此方法，因為它是 PHP magic method，當執行 unset($component->property) 時會隱式呼叫。

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

public void __unset ( $name )
$name string

屬性名稱
throws yii\base\InvalidCallException

如果屬性為唯讀。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
attachBehavior() 公開方法

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

將行為附加到此組件。

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

另請參閱 detachBehavior()。

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

行為的名稱。
$behavior string|array|yii\base\Behavior

行為組態。可以是下列其中一項
return yii\base\Behavior

行為物件

 

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}
attachBehaviors() 公開方法

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

將行為列表附加到組件。

每個行為都依其名稱編製索引，並且應該是 yii\base\Behavior 物件、指定行為類別的字串，或是用於建立行為的組態陣列。

另請參閱 attachBehavior()。

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到組件的行為列表

 

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}
behaviors() 公開方法

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

傳回此組件應表現為的行為列表。

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

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

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

請注意，行為類別必須從 yii\base\Behavior 擴展。行為可以使用名稱或匿名方式附加。當名稱用作陣列鍵時，使用此名稱，稍後可以使用 getBehavior() 檢索行為，或使用 detachBehavior() 分離行為。匿名行為無法檢索或分離。

在此方法中宣告的行為將自動（按需）附加到組件。

public array behaviors ( )
return array

行為組態。

 

                public function behaviors()
{
    return [];
}
canGetProperty() 公開方法

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

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

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

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

另請參閱 canSetProperty()。

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性
return boolean

是否可以讀取屬性

 

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}
canSetProperty() 公開方法

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

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

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

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

另請參閱 canGetProperty()。

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性
return boolean

是否可以寫入屬性

 

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}
className() 公開靜態方法
自 2.0.14 版本起已過時。在 PHP >=5.5 上，請改用 ::class。

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

傳回此類別的完整限定名稱。

public static string className ( )
return string

此類別的完整限定名稱。

 

                public static function className()
{
    return get_called_class();
}
detachBehavior() 公開方法

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

從組件分離行為。

將呼叫行為的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行為的名稱。
return yii\base\Behavior|null

已分離的行為。如果行為不存在，則為 Null。

 

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}
detachBehaviors() 公開方法

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

從組件分離所有行為。

public void detachBehaviors ( )

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

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

確保在 behaviors() 中宣告的行為已附加到此組件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}
getBehavior() 公開方法

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

傳回具名行為物件。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行為名稱
return yii\base\Behavior|null

行為物件，如果行為不存在則為 null

 

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
getBehaviors() 公開方法

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

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

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

附加到此組件的行為列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
getCount() 公開方法

傳回目前頁面中的資料模型數量。

public integer getCount ( )
return integer

目前頁面中的資料模型數量。

 

                public function getCount()
{
    return count($this->getModels());
}
getKeys() 公開方法

傳回與資料模型相關聯的鍵值。

public array getKeys ( )
return array

對應於 $models 的鍵值列表。 $models 中的每個資料模型都由此陣列中的對應鍵值唯一識別。

 

                public function getKeys()
{
    $this->prepare();
    return $this->_keys;
}
getModels() 公開方法

傳回目前頁面中的資料模型。

public array getModels ( )
return array

目前頁面中的資料模型列表。

 

                public function getModels()
{
    $this->prepare();
    return $this->_models;
}
getPagination() 公開方法

傳回此資料提供者使用的分頁物件。

請注意，您應該先呼叫 prepare() 或 getModels()，以取得 yii\data\Pagination::$totalCount 和 yii\data\Pagination::$pageCount 的正確值。

public yii\data\Pagination|false getPagination ( )
return yii\data\Pagination|false

分頁物件。如果這是 false，表示分頁已停用。

 

                public function getPagination()
{
    if ($this->_pagination === null) {
        $this->setPagination([]);
    }
    return $this->_pagination;
}
getSort() 公開方法

傳回此資料提供者使用的排序物件。

public yii\data\Sort|boolean getSort ( )
return yii\data\Sort|boolean

排序物件。如果這是 false，表示排序已停用。

 

                public function getSort()
{
    if ($this->_sort === null) {
        $this->setSort([]);
    }
    return $this->_sort;
}
getTotalCount() 公開方法

傳回資料模型的總數。

當 $pagination 為 false 時，此方法會傳回與 $count 相同的值。否則，它將呼叫 prepareTotalCount() 以取得計數。

public integer getTotalCount ( )
return integer

可能的資料模型總數。

 

                public function getTotalCount()
{
    if ($this->getPagination() === false) {
        return $this->getCount();
    } elseif ($this->_totalCount === null) {
        $this->_totalCount = $this->prepareTotalCount();
    }
    return $this->_totalCount;
}
hasEventHandlers() 公開方法

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

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

public boolean hasEventHandlers ( $name )
$name string

事件名稱
return boolean

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

 

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}
hasMethod() 公開方法

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

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

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

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

屬性名稱
$checkBehaviors boolean

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

方法是否已定義

 

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}
hasProperty() 公開方法

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

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

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

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

另請參閱

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性
return boolean

屬性是否已定義

 

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

初始化物件。

在物件使用給定組態初始化後，此方法會在建構函式的結尾被呼叫。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->id === null) {
        if (self::$counter > 0) {
            $this->id = 'dp-' . self::$counter;
        }
        self::$counter++;
    }
}
off() 公開方法

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

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

此方法與 on() 相反。

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

另請參閱 on()。

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

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

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

將事件處理常式附加到事件。

事件處理器必須是有效的 PHP 回呼。以下是一些範例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件處理器必須使用以下簽名定義，

function ($event)

其中 $event 是一個 yii\base\Event 物件，其中包含與事件相關聯的參數。

自 2.0.14 版本起，您可以將事件名稱指定為萬用字元模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另請參閱 off()。

public void on ( $name, $handler, $data = null, $append = true )
$name string

事件名稱
$handler callable

事件處理器
$data mixed

事件觸發時要傳遞給事件處理器的資料。當事件處理器被呼叫時，可以透過 yii\base\Event::$data 存取此資料。
$append boolean

是否將新的事件處理器附加到現有處理器列表的末尾。如果為 false，則新的處理器將插入到現有處理器列表的開頭。

 

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}
prepare() 公開方法

準備資料模型和鍵。

此方法將準備可以透過 getModels() 和 getKeys() 檢索的資料模型和鍵。

如果之前未呼叫過此方法，則 getModels() 和 getKeys() 將隱式呼叫此方法。

public void prepare ( $forcePrepare = false )
$forcePrepare boolean

即使之前已完成資料準備，是否強制進行資料準備。

 

                public function prepare($forcePrepare = false)
{
    if ($forcePrepare || $this->_models === null) {
        $this->_models = $this->prepareModels();
    }
    if ($forcePrepare || $this->_keys === null) {
        $this->_keys = $this->prepareKeys($this->_models);
    }
}
prepareKeys() protected abstract method

準備與目前可用的資料模型相關聯的鍵。

protected abstract array prepareKeys ( $models )
$models array

可用的資料模型
return array

鍵

 

                abstract protected function prepareKeys($models);
prepareModels() protected abstract method

準備將在目前頁面中提供的資料模型。

protected abstract array prepareModels ( )
return array

可用的資料模型

 

                abstract protected function prepareModels();
prepareTotalCount() protected abstract method

傳回一個值，指示此資料提供者中資料模型的總數。

protected abstract integer prepareTotalCount ( )
return integer

此資料提供器中的資料模型總數。

 

                abstract protected function prepareTotalCount();
refresh() 公開方法

重新整理資料提供者。

呼叫此方法後，如果再次呼叫 getModels()、getKeys() 或 getTotalCount()，它們將重新執行查詢並傳回最新的可用資料。

public void refresh ( )

                public function refresh()
{
    $this->_totalCount = null;
    $this->_models = null;
    $this->_keys = null;
}
setKeys() 公開方法

設定與資料模型相關聯的鍵值。

public void setKeys ( $keys )
$keys array

對應於 $models 的鍵值列表。

 

                public function setKeys($keys)
{
    $this->_keys = $keys;
}
setModels() 公開方法

設定目前頁面中的資料模型。

public void setModels ( $models )
$models array

當前頁面中的模型

 

                public function setModels($models)
{
    $this->_models = $models;
}
setPagination() 公開方法

為此資料提供者設定分頁。

public void setPagination ( $value )
$value array|yii\data\Pagination|boolean

此資料提供器要使用的分頁。這可以是以下其中之一

  • 用於建立分頁物件的組態陣列。「class」元素預設為 'yii\data\Pagination'
  • yii\data\Pagination 或其子類別的實例
  • false，如果需要停用分頁。
throws yii\base\InvalidArgumentException 

                public function setPagination($value)
{
    if (is_array($value)) {
        $config = ['class' => Pagination::className()];
        if ($this->id !== null) {
            $config['pageParam'] = $this->id . '-page';
            $config['pageSizeParam'] = $this->id . '-per-page';
        }
        $this->_pagination = Yii::createObject(array_merge($config, $value));
    } elseif ($value instanceof Pagination || $value === false) {
        $this->_pagination = $value;
    } else {
        throw new InvalidArgumentException('Only Pagination instance, configuration array or false is allowed.');
    }
}
setSort() 公開方法

為此資料提供者設定排序定義。

public void setSort ( $value )
$value array|yii\data\Sort|boolean

此資料提供器要使用的排序定義。這可以是以下其中之一

  • 用於建立排序定義物件的組態陣列。「class」元素預設為 'yii\data\Sort'
  • yii\data\Sort 或其子類別的實例
  • false，如果需要停用排序。
throws yii\base\InvalidArgumentException 

                public function setSort($value)
{
    if (is_array($value)) {
        $config = ['class' => Sort::className()];
        if ($this->id !== null) {
            $config['sortParam'] = $this->id . '-sort';
        }
        $this->_sort = Yii::createObject(array_merge($config, $value));
    } elseif ($value instanceof Sort || $value === false) {
        $this->_sort = $value;
    } else {
        throw new InvalidArgumentException('Only Sort instance, configuration array or false is allowed.');
    }
}
setTotalCount() 公開方法

設定資料模型的總數。

public void setTotalCount ( $value )
$value integer

資料模型的總數。

 

                public function setTotalCount($value)
{
    $this->_totalCount = $value;
}
trigger() 公開方法

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

觸發事件。

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

public void trigger ( $name, yii\base\Event $event = null )
$name string

事件名稱
$event yii\base\Event|null

事件實例。如果未設定，將建立預設的 yii\base\Event 物件。

 

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}