# Class yii\data\ActiveDataProvider

Inheritance | yii\data\ActiveDataProvider » yii\data\BaseDataProvider » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\data\DataProviderInterface
Subclasses | yii\elasticsearch\ActiveDataProvider, yii\sphinx\ActiveDataProvider
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/data/ActiveDataProvider.php

ActiveDataProvider implements a data provider based on yii\db\Query and yii\db\ActiveQuery.

ActiveDataProvider provides data by performing DB queries using $query.

The following is an example of using ActiveDataProvider to provide ActiveRecord instances:

    $provider = new ActiveDataProvider([
        'query' => Post::find(),
        'pagination' => [
            'pageSize' => 20,
        ],
    ]);

    // get the posts in the current page
    $posts = $provider->getModels();

And the following example shows how to use ActiveDataProvider without ActiveRecord:

    $query = new Query();
    $provider = new ActiveDataProvider([
        'query' => $query->from('post'),
        'pagination' => [
            'pageSize' => 20,
        ],
    ]);

    // get the posts in the current page
    $posts = $provider->getModels();

For more details and usage information on ActiveDataProvider, see the guide article on data providers.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$count | integer | The number of data models in the current page. This property is read-only. | yii\data\BaseDataProvider
$db | yii\db\Connection|array|string|null | The DB connection object or the application component ID of the DB connection. | yii\data\ActiveDataProvider
$id | string | An ID that uniquely identifies the data provider among all data providers. | yii\data\BaseDataProvider
$key | string|callable|null | The column that is used as the key of the data models. | yii\data\ActiveDataProvider
$keys | array | The list of key values corresponding to $models. Each data model in $models is uniquely identified by the corresponding key value in this array. | yii\data\BaseDataProvider
$models | array | The list of data models in the current page. | yii\data\BaseDataProvider
$pagination | yii\data\Pagination|false | The pagination object. If this is false, it means the pagination is disabled. Note that the type of this property differs in getter and setter. See getPagination() and setPagination() for details. | yii\data\BaseDataProvider
$query | yii\db\QueryInterface|null | The query that is used to fetch data models and $totalCount if it is not explicitly set. | yii\data\ActiveDataProvider
$sort | yii\data\Sort|boolean | The sorting object. If this is false, it means the sorting is disabled. Note that the type of this property differs in getter and setter. See getSort() and setSort() for details. | yii\data\BaseDataProvider
$totalCount | integer | Total number of possible data models. | yii\data\BaseDataProvider

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() |  | yii\data\ActiveDataProvider
__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() | Returns the number of data models in the current page. | yii\data\BaseDataProvider
getKeys() | Returns the key values associated with the data models. | yii\data\BaseDataProvider
getModels() | Returns the data models in the current page. | yii\data\BaseDataProvider
getPagination() | Returns the pagination object used by this data provider. | yii\data\BaseDataProvider
getSort() | Returns the sorting object used by this data provider. | yii\data\BaseDataProvider
getTotalCount() | Returns the total number of data models. | 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 DB connection component. | yii\data\ActiveDataProvider
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
prepare() | Prepares the data models and keys. | yii\data\BaseDataProvider
refresh() | Refreshes the data provider. | yii\data\BaseDataProvider
setKeys() | Sets the key values associated with the data models. | yii\data\BaseDataProvider
setModels() | Sets the data models in the current page. | yii\data\BaseDataProvider
setPagination() | Sets the pagination for this data provider. | yii\data\BaseDataProvider
setSort() | Sets the sort definition for this data provider. | yii\data\ActiveDataProvider
setTotalCount() | Sets the total number of data models. | yii\data\BaseDataProvider
trigger() | Triggers an event. | yii\base\Component

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
prepareKeys() | Prepares the keys associated with the currently available data models. | yii\data\ActiveDataProvider
prepareModels() | Prepares the data models that will be made available in the current page. | yii\data\ActiveDataProvider
prepareTotalCount() | Returns a value indicating the total number of data models in this data provider. | yii\data\ActiveDataProvider

## Property Details

$db public property

The DB connection object or the application component ID of the DB connection. If set it overrides $query default DB connection. Starting from version 2.0.2, this can also be a configuration array for creating the object.

public yii\db\Connection|array|string|null $db = null
$key public property

The column that is used as the key of the data models. This can be either a column name, or a callable that returns the key value of a given data model.

If this is not set, the following rules will be used to determine the keys of the data models:

- If $query is an yii\db\ActiveQuery instance, the primary keys of yii\db\ActiveQuery::$modelClass will be used.
- Otherwise, the keys of the $models array will be used.

See also getKeys().

public string|callable|null $key = null
$query public property

The query that is used to fetch data models and $totalCount if it is not explicitly set.

public yii\db\QueryInterface|null $query = null

## Method Details

__clone() public method

public void __clone ( )

init() public method

Initializes the DB connection component.

This method will initialize the $db property (when set) to make sure it refers to a valid DB connection.

public void init ( )
throws | yii\base\InvalidConfigException | if $db is invalid.

prepareKeys() protected method

Prepares the keys associated with the currently available data models.

protected array prepareKeys ( $models )
$models | array | The available data models
return | array | The keys

prepareModels() protected method

Prepares the data models that will be made available in the current page.

protected array prepareModels ( )
return | array | The available data models

prepareTotalCount() protected method

Returns a value indicating the total number of data models in this data provider.

protected integer prepareTotalCount ( )
return | integer | Total number of data models in this data provider.

setSort() public method

Sets the sort definition for this data provider.

public void setSort ( $value )

$value

array|yii\data\Sort|boolean

The sort definition to be used by this data provider. This can be one of the following:

- a configuration array for creating the sort definition object. The "class" element defaults to 'yii\data\Sort'
- an instance of yii\data\Sort or its subclass
- false, if sorting needs to be disabled.

throws | yii\base\InvalidArgumentException |