0 關注者

類別 yii\data\ArrayDataProvider

繼承關係yii\data\ArrayDataProvider » yii\data\BaseDataProvider » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable, yii\data\DataProviderInterface
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/data/ArrayDataProvider.php

ArrayDataProvider 實作了基於資料陣列的資料提供器。

$allModels 屬性包含所有可能被排序和/或分頁的資料模型。 ArrayDataProvider 將在排序和/或分頁後提供資料。您可以配置 $sort$pagination 屬性來自訂排序和分頁行為。

$allModels 陣列中的元素可以是物件(例如模型物件)或關聯陣列(例如 DAO 的查詢結果)。請確保將 $key 屬性設定為唯一識別資料記錄的欄位名稱,如果您沒有此欄位,則設定為 false。

yii\data\ActiveDataProvider 相比,ArrayDataProvider 的效率可能較低,因為它需要準備好 $allModels

ArrayDataProvider 可以以下列方式使用

$query = new Query;
$provider = new ArrayDataProvider([
    'allModels' => $query->from('post')->all(),
    'sort' => [
        'attributes' => ['id', 'username', 'email'],
    ],
    'pagination' => [
        'pageSize' => 10,
    ],
]);
// get the posts in the current page
$posts = $provider->getModels();

注意:如果您想使用排序功能,您必須配置 $sort 屬性,以便提供器知道哪些欄位可以排序。

有關 ArrayDataProvider 的更多詳細資訊和使用資訊,請參閱關於資料提供器的指南文章

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$allModels 陣列 未分頁或排序的資料。 yii\data\ArrayDataProvider
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$count 整數 目前頁面中的資料模型數量。 yii\data\BaseDataProvider
$id 字串|null 在所有資料提供器中唯一識別此資料提供器的 ID。 yii\data\BaseDataProvider
$key 字串|callable|null 用作資料模型鍵值的欄位。 yii\data\ArrayDataProvider
$keys 陣列 對應於 $models 的鍵值列表。 yii\data\BaseDataProvider
$modelClass 字串 將被表示的 Model 類別的名稱。 yii\data\ArrayDataProvider
$models 陣列 目前頁面中的資料模型列表。 yii\data\BaseDataProvider
$pagination yii\data\Pagination|false 分頁物件。 yii\data\BaseDataProvider
$sort yii\data\Sort|boolean 排序物件。 yii\data\BaseDataProvider
$totalCount 整數 可能的資料模型總數。 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\ArrayDataProvider
prepareModels() 準備將在目前頁面中提供的資料模型。 yii\data\ArrayDataProvider
prepareTotalCount() 傳回一個值,指示此資料提供者中的資料模型總數量。 yii\data\ArrayDataProvider
sortModels() 根據給定的排序定義排序資料模型。 yii\data\ArrayDataProvider

屬性詳細資訊

隱藏繼承的屬性

$allModels public property

未分頁或排序的資料。當啟用分頁時,此屬性通常包含比 $models 更多的元素。陣列元素必須使用從零開始的整數鍵。

public array $allModels null
$key public property

作為資料模型鍵使用的欄位。這可以是欄位名稱,或是一個可呼叫的回呼函式,傳回給定資料模型的鍵值。如果未設定,將會使用 $models 陣列的索引。

另請參閱 getKeys()

public string|callable|null $key null
$modelClass public property (available since version 2.0.9)

將被表示的 Model 類別名稱。此屬性用於取得欄位名稱。

public string $modelClass null

方法詳細資訊

隱藏繼承的方法

__call() public method

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

呼叫未定義為類別方法的具名方法。

此方法將檢查是否有任何附加的行為具有具名方法,並在可用時執行它。

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

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

方法名稱

$params 陣列

方法參數

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 陣列

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

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

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

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

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

將元件屬性設定為 null。

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

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

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

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

public void __unset ( $name )
$name 字串

屬性名稱

throws yii\base\InvalidCallException

如果屬性為唯讀。

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

            
attachBehavior() 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 陣列

要附加到元件的行為列表

                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 陣列

行為組態。

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

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

            
getCount() public method

定義於: yii\data\BaseDataProvider::getCount()

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

public integer getCount ( )
return 整數

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

                public function getCount()
{
    return count($this->getModels());
}

            
getKeys() public method

定義於: yii\data\BaseDataProvider::getKeys()

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

public array getKeys ( )
return 陣列

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

                public function getKeys()
{
    $this->prepare();
    return $this->_keys;
}

            
getModels() public method

定義於: yii\data\BaseDataProvider::getModels()

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

public array getModels ( )
return 陣列

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

                public function getModels()
{
    $this->prepare();
    return $this->_models;
}

            
getPagination() public method

定義於: yii\data\BaseDataProvider::getPagination()

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

請注意,您應該先呼叫 prepare()getModels() 以取得 yii\data\Pagination::$totalCountyii\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 method

定義於: yii\data\BaseDataProvider::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() 公開方法

定義於: yii\data\BaseDataProvider::getTotalCount()

傳回資料模型的總數量。

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

public integer getTotalCount ( )
return 整數

可能的資料模型總數。

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

事件名稱

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

屬性名稱

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

屬性名稱

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

定義於: yii\data\BaseDataProvider::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 字串

事件名稱

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

事件名稱

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

定義於: yii\data\BaseDataProvider::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 array prepareKeys ( $models )
$models 陣列

可用的資料模型

return 陣列

                protected function prepareKeys($models)
{
    if ($this->key !== null) {
        $keys = [];
        foreach ($models as $model) {
            if (is_string($this->key)) {
                $keys[] = $model[$this->key];
            } else {
                $keys[] = call_user_func($this->key, $model);
            }
        }
        return $keys;
    }
    return array_keys($models);
}

            
prepareModels() 受保護方法

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

protected array prepareModels ( )
return 陣列

可用的資料模型

                protected function prepareModels()
{
    if (($models = $this->allModels) === null) {
        return [];
    }
    if (($sort = $this->getSort()) !== false) {
        $models = $this->sortModels($models, $sort);
    }
    if (($pagination = $this->getPagination()) !== false) {
        $pagination->totalCount = $this->getTotalCount();
        if ($pagination->getPageSize() > 0) {
            $models = array_slice($models, $pagination->getOffset(), $pagination->getLimit(), true);
        }
    }
    return $models;
}

            
prepareTotalCount() 受保護方法

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

protected integer prepareTotalCount ( )
return 整數

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

                protected function prepareTotalCount()
{
    return is_array($this->allModels) ? count($this->allModels) : 0;
}

            
refresh() 公開方法

定義於: yii\data\BaseDataProvider::refresh()

重新整理資料提供者。

在調用此方法之後,如果再次調用 getModels()getKeys()getTotalCount(),它們將重新執行查詢並回傳最新的可用資料。

public void refresh ( )

                public function refresh()
{
    $this->_totalCount = null;
    $this->_models = null;
    $this->_keys = null;
}

            
setKeys() 公開方法

定義於: yii\data\BaseDataProvider::setKeys()

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

public void setKeys ( $keys )
$keys 陣列

對應於 $models 的鍵值列表。

                public function setKeys($keys)
{
    $this->_keys = $keys;
}

            
setModels() 公開方法

定義於: yii\data\BaseDataProvider::setModels()

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

public void setModels ( $models )
$models 陣列

當前頁面中的模型

                public function setModels($models)
{
    $this->_models = $models;
}

            
setPagination() 公開方法

定義於: yii\data\BaseDataProvider::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() 公開方法

定義於: yii\data\BaseDataProvider::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() 公開方法

定義於: yii\data\BaseDataProvider::setTotalCount()

設定資料模型的總數量。

public void setTotalCount ( $value )
$value 整數

資料模型的總數。

                public function setTotalCount($value)
{
    $this->_totalCount = $value;
}

            
sortModels() 受保護方法

根據給定的排序定義排序資料模型。

protected array sortModels ( $models, $sort )
$models 陣列

要排序的模型

$sort yii\data\Sort

排序定義

return 陣列

已排序的資料模型

                protected function sortModels($models, $sort)
{
    $orders = $sort->getOrders();
    if (!empty($orders)) {
        ArrayHelper::multisort($models, array_keys($orders), array_values($orders), $sort->sortFlags);
    }
    return $models;
}

            
trigger() 公開方法

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