<?php /** * @link http://www.yiiframework.com/ * @copyright Copyright (c) 2008 Yii Software LLC * @license http://www.yiiframework.com/license/ */ namespace yii\data; use yii\helpers\ArrayHelper; /** * ArrayDataProvider implements a data provider based on a data array. * * The [[allModels]] property contains all data models that may be sorted and/or paginated. * ArrayDataProvider will provide the data after sorting and/or pagination. * You may configure the [[sort]] and [[pagination]] properties to * customize the sorting and pagination behaviors. * * Elements in the [[allModels]] array may be either objects (e.g. model objects) * or associative arrays (e.g. query results of DAO). * Make sure to set the [[key]] property to the name of the field that uniquely * identifies a data record or false if you do not have such a field. * * Compared to [[ActiveDataProvider]], ArrayDataProvider could be less efficient * because it needs to have [[allModels]] ready. * * ArrayDataProvider may be used in the following way: * * ~~~ * $query = new Query; * $provider = new ArrayDataProvider(array( * 'allModels' => $query->from('tbl_post')->all(), * 'sort' => array( * 'attributes' => array( * 'id', 'username', 'email', * ), * ), * 'pagination' => array( * 'pageSize' => 10, * ), * )); * // get the posts in the current page * $posts = $provider->getModels(); * ~~~ * * Note: if you want to use the sorting feature, you must configure the [[sort]] property * so that the provider knows which columns can be sorted. * * @property array $keys The list of key values corresponding to [[models]]. Each data model in [[models]] is * uniquely identified by the corresponding key value in this array. * @property array $models The list of data models in the current page. * @property integer $totalCount Total number of possible data models. * * @author Qiang Xue <qiang.xue@gmail.com> * @since 2.0 */ class ArrayDataProvider extends DataProvider { /** * @var string|callable 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 index of the [[models]] array will be used. * @see getKeys() */ public $key; /** * @var array the data that is not paginated or sorted. When pagination is enabled, * this property usually contains more elements than [[models]]. * The array elements must use zero-based integer keys. */ public $allModels; private $_totalCount; /** * Returns the total number of data models. * @return integer total number of possible data models. */ public function getTotalCount() { if ($this->getPagination() === false) { return $this->getCount(); } elseif ($this->_totalCount === null) { $this->_totalCount = count($this->allModels); } return $this->_totalCount; } /** * Sets the total number of data models. * @param integer $value the total number of data models. */ public function setTotalCount($value) { $this->_totalCount = $value; } private $_models; /** * Returns the data models in the current page. * @return array the list of data models in the current page. */ public function getModels() { if ($this->_models === null) { if (($models = $this->allModels) === null) { return array(); } if (($sort = $this->getSort()) !== false) { $models = $this->sortModels($models, $sort); } if (($pagination = $this->getPagination()) !== false) { $models = array_slice($models, $pagination->getOffset(), $pagination->getLimit()); } $this->_models = $models; } return $this->_models; } /** * Sets the data models in the current page. * @param array $models the models in the current page */ public function setModels($models) { $this->_models = $models; } private $_keys; /** * Returns the key values associated with the data models. * @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. */ public function getKeys() { if ($this->_keys === null) { $this->_keys = array(); $models = $this->getModels(); if ($this->key !== null) { foreach ($models as $model) { if (is_string($this->key)) { $this->_keys[] = $model[$this->key]; } else { $this->_keys[] = call_user_func($this->key, $model); } } } else { $this->_keys = array_keys($models); } } return $this->_keys; } /** * Sets the key values associated with the data models. * @param array $keys the list of key values corresponding to [[models]]. */ public function setKeys($keys) { $this->_keys = $keys; } /** * Sorts the data models according to the given sort definition * @param array $models the models to be sorted * @param Sort $sort the sort definition * @return array the sorted data models */ protected function sortModels($models, $sort) { $orders = $sort->getOrders(); if (!empty($orders)) { ArrayHelper::multisort($models, array_keys($orders), array_values($orders)); } return $models; } }