ArrayDataProvider.php 5.18 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<?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.
 *
15
 * The [[allModels]] property contains all data models that may be sorted and/or paginated.
Qiang Xue committed
16 17 18 19
 * 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.
 *
20
 * Elements in the [[allModels]] array may be either objects (e.g. model objects)
Qiang Xue committed
21 22 23 24 25
 * 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
26
 * because it needs to have [[allModels]] ready.
Qiang Xue committed
27 28 29 30 31 32
 *
 * ArrayDataProvider may be used in the following way:
 *
 * ~~~
 * $query = new Query;
 * $provider = new ArrayDataProvider(array(
33
 *     'allModels' => $query->from('tbl_post')->all(),
Qiang Xue committed
34 35 36 37 38 39 40 41 42 43
 *     'sort' => array(
 *         'attributes' => array(
 *              'id', 'username', 'email',
 *         ),
 *     ),
 *     'pagination' => array(
 *         'pageSize' => 10,
 *     ),
 * ));
 * // get the posts in the current page
44
 * $posts = $provider->getModels();
Qiang Xue committed
45 46 47 48 49
 * ~~~
 *
 * 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.
 *
50 51
 * @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.
52 53 54
 * @property array $models The list of data models in the current page.
 * @property integer $totalCount Total number of possible data models.
 *
Qiang Xue committed
55 56 57 58 59 60
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ArrayDataProvider extends DataProvider
{
	/**
61 62 63
	 * @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.
Qiang Xue committed
64 65 66 67 68
	 * @see getKeys()
	 */
	public $key;
	/**
	 * @var array the data that is not paginated or sorted. When pagination is enabled,
69
	 * this property usually contains more elements than [[models]].
Qiang Xue committed
70 71
	 * The array elements must use zero-based integer keys.
	 */
72
	public $allModels;
Qiang Xue committed
73

Qiang Xue committed
74
	private $_totalCount;
Qiang Xue committed
75 76

	/**
77 78
	 * Returns the total number of data models.
	 * @return integer total number of possible data models.
Qiang Xue committed
79
	 */
Qiang Xue committed
80
	public function getTotalCount()
Qiang Xue committed
81 82
	{
		if ($this->getPagination() === false) {
Qiang Xue committed
83 84
			return $this->getCount();
		} elseif ($this->_totalCount === null) {
85
			$this->_totalCount = count($this->allModels);
Qiang Xue committed
86
		}
Qiang Xue committed
87
		return $this->_totalCount;
Qiang Xue committed
88 89 90
	}

	/**
91 92
	 * Sets the total number of data models.
	 * @param integer $value the total number of data models.
Qiang Xue committed
93
	 */
Qiang Xue committed
94
	public function setTotalCount($value)
Qiang Xue committed
95
	{
Qiang Xue committed
96
		$this->_totalCount = $value;
Qiang Xue committed
97 98
	}

99
	private $_models;
Qiang Xue committed
100 101

	/**
102 103
	 * Returns the data models in the current page.
	 * @return array the list of data models in the current page.
Qiang Xue committed
104
	 */
105
	public function getModels()
Qiang Xue committed
106
	{
107 108 109
		if ($this->_models === null) {
			if (($models = $this->allModels) === null) {
				return array();
Qiang Xue committed
110 111 112
			}

			if (($sort = $this->getSort()) !== false) {
113
				$models = $this->sortModels($models, $sort);
Qiang Xue committed
114 115 116
			}

			if (($pagination = $this->getPagination()) !== false) {
Qiang Xue committed
117
				$pagination->totalCount = $this->getTotalCount();
118
				$models = array_slice($models, $pagination->getOffset(), $pagination->getLimit());
Qiang Xue committed
119 120
			}

121
			$this->_models = $models;
Qiang Xue committed
122
		}
123
		return $this->_models;
Qiang Xue committed
124 125 126
	}

	/**
127 128
	 * Sets the data models in the current page.
	 * @param array $models the models in the current page
Qiang Xue committed
129
	 */
130
	public function setModels($models)
Qiang Xue committed
131
	{
132
		$this->_models = $models;
Qiang Xue committed
133 134 135 136 137
	}

	private $_keys;

	/**
138 139
	 * Returns the key values associated with the data models.
	 * @return array the list of key values corresponding to [[models]]. Each data model in [[models]]
Qiang Xue committed
140 141 142 143 144 145
	 * is uniquely identified by the corresponding key value in this array.
	 */
	public function getKeys()
	{
		if ($this->_keys === null) {
			$this->_keys = array();
146
			$models = $this->getModels();
Qiang Xue committed
147
			if ($this->key !== null) {
148
				foreach ($models as $model) {
Qiang Xue committed
149
					if (is_string($this->key)) {
150
						$this->_keys[] = $model[$this->key];
Qiang Xue committed
151
					} else {
152
						$this->_keys[] = call_user_func($this->key, $model);
Qiang Xue committed
153 154 155
					}
				}
			} else {
156
				$this->_keys = array_keys($models);
Qiang Xue committed
157 158 159 160 161 162
			}
		}
		return $this->_keys;
	}

	/**
163 164
	 * Sets the key values associated with the data models.
	 * @param array $keys the list of key values corresponding to [[models]].
Qiang Xue committed
165 166 167 168 169 170 171
	 */
	public function setKeys($keys)
	{
		$this->_keys = $keys;
	}

	/**
172 173
	 * Sorts the data models according to the given sort definition
	 * @param array $models the models to be sorted
Qiang Xue committed
174
	 * @param Sort $sort the sort definition
175
	 * @return array the sorted data models
Qiang Xue committed
176
	 */
177
	protected function sortModels($models, $sort)
Qiang Xue committed
178 179 180
	{
		$orders = $sort->getOrders();
		if (!empty($orders)) {
181
			ArrayHelper::multisort($models, array_keys($orders), array_values($orders));
Qiang Xue committed
182
		}
183
		return $models;
Qiang Xue committed
184 185
	}
}