API Documentation for Yii 2.0

0 follower

Abstract Class yii\data\BaseDataProvider

All Classes | Properties | Methods

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

BaseDataProvider provides a base class that implements the yii\data\DataProviderInterface.

For more details and usage information on BaseDataProvider, 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	yii\base\Component
$count	integer	The number of data models in the current page.	yii\data\BaseDataProvider
$id	string	An ID that uniquely identifies the data provider among all data providers.	yii\data\BaseDataProvider
$keys	array	The list of key values corresponding to $models.	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.	yii\data\BaseDataProvider
$sort	yii\data\Sort\|boolean	The sorting object.	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()	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()	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 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()	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\BaseDataProvider
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\BaseDataProvider
prepareModels()	Prepares the data models that will be made available in the current page.	yii\data\BaseDataProvider
prepareTotalCount()	Returns a value indicating the total number of data models in this data provider.	yii\data\BaseDataProvider

Property Details

$count public read-only property

The number of data models in the current page.

public integer getCount ( )

$id public property

An ID that uniquely identifies the data provider among all data providers. Generated automatically the following way in case it is not set:

First data provider ID is empty.
Second and all subsequent data provider IDs are: "dp-1", "dp-2", etc.

public string $id = null

$keys public property

The list of key values corresponding to $models. Each data model in $models is uniquely identified by the corresponding key value in this array.

public array getKeys ( )
public void setKeys ( $keys )

$models public property

The list of data models in the current page.

public array getModels ( )
public void setModels ( $models )

$pagination public property

The pagination object. If this is false, it means the pagination is disabled.

public yii\data\Pagination|false getPagination ( )
public void setPagination ( $value )

$sort public property

The sorting object. If this is false, it means the sorting is disabled.

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

$totalCount public property

Total number of possible data models.

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

Method Details

getCount() public method

Returns the number of data models in the current page.

public integer getCount ( )
return	integer	The number of data models in the current page.

getKeys() public method

Returns the key values associated with the data models.

public array getKeys ( )
return	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.

getModels() public method

Returns the data models in the current page.

public array getModels ( )
return	array	The list of data models in the current page.

getPagination() public method

Returns the pagination object used by this data provider.

Note that you should call prepare() or getModels() first to get correct values of yii\data\Pagination::$totalCount and yii\data\Pagination::$pageCount.

public yii\data\Pagination\|false getPagination ( )
return	yii\data\Pagination\|false	The pagination object. If this is false, it means the pagination is disabled.

getSort() public method

Returns the sorting object used by this data provider.

public yii\data\Sort\|boolean getSort ( )
return	yii\data\Sort\|boolean	The sorting object. If this is false, it means the sorting is disabled.

getTotalCount() public method

Returns the total number of data models.

When $pagination is false, this returns the same value as $count. Otherwise, it will call prepareTotalCount() to get the count.

public integer getTotalCount ( )
return	integer	Total number of possible data models.

init() public method

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

Prepares the data models and keys.

This method will prepare the data models and keys that can be retrieved via getModels() and getKeys().

This method will be implicitly called by getModels() and getKeys() if it has not been called before.

public void prepare ( $forcePrepare = false )
$forcePrepare	boolean	Whether to force data preparation even if it has been done before.

prepareKeys() protected abstract method

Prepares the keys associated with the currently available data models.

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

prepareModels() protected abstract method

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

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

prepareTotalCount() protected abstract method

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

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

refresh() public method

Refreshes the data provider.

After calling this method, if getModels(), getKeys() or getTotalCount() is called again, they will re-execute the query and return the latest data available.

public void refresh ( )

setKeys() public method

Sets the key values associated with the data models.

public void setKeys ( $keys )
$keys	array	The list of key values corresponding to $models.

setModels() public method

Sets the data models in the current page.

public void setModels ( $models )
$models	array	The models in the current page

setPagination() public method

Sets the pagination for this data provider.

public void setPagination ( $value )
$value	array\|yii\data\Pagination\|boolean	The pagination to be used by this data provider. This can be one of the following: a configuration array for creating the pagination object. The "class" element defaults to 'yii\data\Pagination' an instance of yii\data\Pagination or its subclass false, if pagination needs to be disabled.
throws	yii\base\InvalidArgumentException

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

setTotalCount() public method

Sets the total number of data models.

public void setTotalCount ( $value )
$value	integer	The total number of data models.

User Contributed Notes