没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Abstract Class 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/yiichina/yii2/blob/api/framework/data/BaseDataProvider.php

BaseDataProvider 是一个实现了 yii\data\DataProviderInterface 的基类。

有关 BaseDataProvider 的详细信息和使用信息，请参阅 guide article on data providers。

公共属性

隐藏继承的属性

属性类型描述被定义在
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$count integer 当前页中的数据模型数。 yii\data\BaseDataProvider
$id string 在所有数据提供器中唯一标识该数据提供器的 ID，如果未设置该 ID， 则按以下方式自动生成： - 第一个数据提供器 ID 为空。 - 第二个和所有后续的数据提供者 IDs 是："dp-1"，"dp-2" 等。 yii\data\BaseDataProvider
$keys array 与 models 对应的键值列表。models 中的每个数据模型 都由该数组中相应的键值唯一标识。 yii\data\BaseDataProvider
$models array 当前页中的数据模型列表。 yii\data\BaseDataProvider
$pagination yii\data\Pagination|false 分页对象。如果为 false，则表示禁用分页。 yii\data\BaseDataProvider
$sort yii\data\Sort|boolean 排序对象。如果为 false，则表示排序被禁用。 yii\data\BaseDataProvider
$totalCount integer 数据模型总数。 yii\data\BaseDataProvider

公共方法

隐藏继承的方法

方法描述被定义在
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getCount() 返回当前页中的数据模型数。 yii\data\BaseDataProvider
getKeys() 返回与数据模型关联的键值。 yii\data\BaseDataProvider
getModels() 返回当前页中的数据模型。 yii\data\BaseDataProvider
getPagination() 返回此数据提供器使用的分页对象。 注意，我们应该先调用 prepare() 或者 getModels() 以获取 yii\data\Pagination::$totalCount 和 yii\data\Pagination::$pageCount 的正确的值。 yii\data\BaseDataProvider
getSort() 返回此数据提供器使用的排序对象。 yii\data\BaseDataProvider
getTotalCount() 返回数据模型总数。 当 $pagination 为 false，值与 $count 相同。 否则，将调用 prepareTotalCount() 获取数量。 yii\data\BaseDataProvider
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\data\BaseDataProvider
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
prepare() 准备数据模型和键。 yii\data\BaseDataProvider
refresh() 刷新数据提供器 调用此方法后，如果再次调用 getModels()，getKeys() 或者 getTotalCount()， 它们将重新执行查询并返回可用的最新数据。 yii\data\BaseDataProvider
setKeys() 设置与数据模型关联的键值。 yii\data\BaseDataProvider
setModels() 设置当前页中的数据模型。 yii\data\BaseDataProvider
setPagination() 为数据提供器设置分页组件。 yii\data\BaseDataProvider
setSort() 设置此数据提供器的排序定义。 yii\data\BaseDataProvider
setTotalCount() 设置数据模型总数。 yii\data\BaseDataProvider
trigger() Triggers an event. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述被定义在
prepareKeys() 准备与当前可用数据模型关联的键。 yii\data\BaseDataProvider
prepareModels() 准备将在当前页中可用的数据模型。 yii\data\BaseDataProvider
prepareTotalCount() 返回一个值，该值指示此数据提供器中的数据模型总数。 yii\data\BaseDataProvider

属性详情

$count 公共 只读 属性

当前页中的数据模型数。

public integer getCount ( )
$id 公共 属性

在所有数据提供器中唯一标识该数据提供器的 ID，如果未设置该 ID， 则按以下方式自动生成：

  • 第一个数据提供器 ID 为空。
  • 第二个和所有后续的数据提供者 IDs 是："dp-1"，"dp-2" 等。
public string $id = null
$keys 公共 属性

与 models 对应的键值列表。models 中的每个数据模型 都由该数组中相应的键值唯一标识。

public array getKeys ( )
public void setKeys ( $keys )
$models 公共 属性

当前页中的数据模型列表。

public array getModels ( )
public void setModels ( $models )
$pagination 公共 属性

分页对象。如果为 false，则表示禁用分页。

public yii\data\Pagination|false getPagination ( )
public void setPagination ( $value )
$sort 公共 属性

排序对象。如果为 false，则表示排序被禁用。

public yii\data\Sort|boolean getSort ( )
public void setSort ( $value )
$totalCount 公共 属性

数据模型总数。

public integer getTotalCount ( )
public void setTotalCount ( $value )

方法详情

getCount() 公共 方法

返回当前页中的数据模型数。

public integer getCount()
return integer

当前页中的数据模型数。
getKeys() 公共 方法

返回与数据模型关联的键值。

public array getKeys()
return array

与 models 对应的键值列表。models 中的每个数据模型 都由该数组中相应的键值唯一标识。
getModels() 公共 方法

返回当前页中的数据模型。

public array getModels()
return array

当前页中的数据模型列表。
getPagination() 公共 方法

返回此数据提供器使用的分页对象。 注意，我们应该先调用 prepare() 或者 getModels() 以获取 yii\data\Pagination::$totalCount 和 yii\data\Pagination::$pageCount 的正确的值。

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

分页对象。如果为 false，则表示禁用分页。
getSort() 公共 方法

返回此数据提供器使用的排序对象。

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

排序对象。如果为 false，则表示排序被禁用。
getTotalCount() 公共 方法

返回数据模型总数。 当 $pagination 为 false，值与 $count 相同。 否则，将调用 prepareTotalCount() 获取数量。

public integer getTotalCount()
return integer

数据模型总数。
init() 公共 方法

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init()
prepare() 公共 方法

准备数据模型和键。

此方法将准备可通过 getModels() 和 getKeys() 检索的 数据模型和键。

如果没有调用此方法，则它将由 getModels() 和 getKeys() 隐式调用。

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

是否强制进行数据准备，即使之前已经进行过。
prepareKeys() 受保护 抽象 方法

准备与当前可用数据模型关联的键。

protected abstract array prepareKeys($models)
$models array

可用的数据模型
return array

键列表
prepareModels() 受保护 抽象 方法

准备将在当前页中可用的数据模型。

protected abstract array prepareModels()
return array

可用的数据模型
prepareTotalCount() 受保护 抽象 方法

返回一个值，该值指示此数据提供器中的数据模型总数。

protected abstract integer prepareTotalCount()
return integer

此数据提供器中的数据模型总数。
refresh() 公共 方法

刷新数据提供器 调用此方法后，如果再次调用 getModels()，getKeys() 或者 getTotalCount()， 它们将重新执行查询并返回可用的最新数据。

public void refresh()
setKeys() 公共 方法

设置与数据模型关联的键值。

public void setKeys($keys)
$keys array

与 $models 对应的键值列表
setModels() 公共 方法

设置当前页中的数据模型。

public void setModels($models)
$models array

当前页面中的模型
setPagination() 公共 方法

为数据提供器设置分页组件。

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

被此数据提供器使用的分页件。 可以是下列之一：

  • 一个用于创建分页对象的配置数组。“class” 元素默认 为 'yii\data\Pagination'
  • yii\data\Pagination 或其子类的实例
  • false，禁用分页
throws yii\base\InvalidArgumentException
setSort() 公共 方法

设置此数据提供器的排序定义。

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

被此数据提供器使用的排序定义。 可以是下列之一：

  • 一个用于创建排序定义的配置数组。"class" 元素默认 为 'yii\data\Sort'
  • yii\data\Sort 或其子类的实例。
  • false，禁用排序
throws yii\base\InvalidArgumentException
setTotalCount() 公共 方法

设置数据模型总数。

public void setTotalCount($value)
$value integer

数据模型总数