BaseDataProvider::prepareTotalCount()

Completed

Push — master ( b4b2b0...f965e3 )

by Dmitry

created 2016-12-20 08:02 UTC

↳ Parent: BaseDataProvider

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0
ccs	0
cts	0
cp	0
nc	1

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\data;

use Yii;
use yii\base\Component;
use yii\base\InvalidParamException;

/**
 * BaseDataProvider provides a base class that implements the [[DataProviderInterface]].
 *
 * For more details and usage information on BaseDataProvider, see the [guide article on data providers](guide:output-data-providers).
 *
 * @property int $count The number of data models in the current page. This property is read-only.
 * @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 Pagination|false $pagination 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.
 * @property Sort|bool $sort 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.
 * @property int $totalCount Total number of possible data models.
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
abstract class BaseDataProvider extends Component implements DataProviderInterface
{
    /**
     * @var string an ID that uniquely identifies the data provider among all data providers.
     * You should set this property if the same page contains two or more different data providers.
     * Otherwise, the [[pagination]] and [[sort]] may not work properly.
     */
    public $id;

    private $_sort;
    private $_pagination;
    private $_keys;
    private $_models;
    private $_totalCount;


    /**
     * Prepares the data models that will be made available in the current page.
     * @return array the available data models
     */
    abstract protected function prepareModels();

    /**
     * Prepares the keys associated with the currently available data models.
     * @param array $models the available data models
     * @return array the keys
     */
    abstract protected function prepareKeys($models);

    /**
     * Returns a value indicating the total number of data models in this data provider.
     * @return int total number of data models in this data provider.
     */
    abstract protected function prepareTotalCount();

    /**
     * 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.
     *
     * @param bool $forcePrepare whether to force data preparation even if it has been done before.
     */
    public function prepare($forcePrepare = false)
    {
        if ($forcePrepare || $this->_models === null) {
            $this->_models = $this->prepareModels();
        }
        if ($forcePrepare || $this->_keys === null) {
            $this->_keys = $this->prepareKeys($this->_models);
        }
    }

    /**
     * Returns the data models in the current page.
     * @return array the list of data models in the current page.
     */
    public function getModels()
    {
        $this->prepare();

        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;
    }

    /**
     * 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()
    {
        $this->prepare();

        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;
    }

    /**
     * Returns the number of data models in the current page.
     * @return int the number of data models in the current page.
     */
    public function getCount()
    {
        return count($this->getModels());
    }

    /**
     * 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.
     * @return int total number of possible data models.
     */
    public function getTotalCount()
    {
        if ($this->getPagination() === false) {
            return $this->getCount();
        } elseif ($this->_totalCount === null) {
            $this->_totalCount = $this->prepareTotalCount();
        }

        return $this->_totalCount;
    }

    /**
     * Sets the total number of data models.
     * @param int $value the total number of data models.
     */
    public function setTotalCount($value)
    {
        $this->_totalCount = $value;
    }

    /**
     * Returns the pagination object used by this data provider.
     * Note that you should call [[prepare()]] or [[getModels()]] first to get correct values
     * of [[Pagination::totalCount]] and [[Pagination::pageCount]].
     * @return Pagination|false the pagination object. If this is false, it means the pagination is disabled.
     */
    public function getPagination()
    {
        if ($this->_pagination === null) {
            $this->setPagination([]);
        }

        return $this->_pagination;
    }

    /**
     * Sets the pagination for this data provider.
     * @param array|Pagination|bool $value 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 [[Pagination]] or its subclass
     * - false, if pagination needs to be disabled.
     *
     * @throws InvalidParamException
     */
    public function setPagination($value)
    {
        if (is_array($value)) {
            $config = ['class' => Pagination::className()];
            if ($this->id !== null) {
                $config['pageParam'] = $this->id . '-page';
                $config['pageSizeParam'] = $this->id . '-per-page';
            }
            $this->_pagination = Yii::createObject(array_merge($config, $value));
        } elseif ($value instanceof Pagination || $value === false) {
            $this->_pagination = $value;
        } else {
            throw new InvalidParamException('Only Pagination instance, configuration array or false is allowed.');
        }
    }

    /**
     * Returns the sorting object used by this data provider.
     * @return Sort|bool the sorting object. If this is false, it means the sorting is disabled.
     */
    public function getSort()
    {
        if ($this->_sort === null) {
            $this->setSort([]);
        }

        return $this->_sort;
    }

    /**
     * Sets the sort definition for this data provider.
     * @param array|Sort|bool $value 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 [[Sort]] or its subclass
     * - false, if sorting needs to be disabled.
     *
     * @throws InvalidParamException
     */
    public function setSort($value)
    {
        if (is_array($value)) {
            $config = ['class' => Sort::className()];
            if ($this->id !== null) {
                $config['sortParam'] = $this->id . '-sort';
            }
            $this->_sort = Yii::createObject(array_merge($config, $value));
        } elseif ($value instanceof Sort || $value === false) {
            $this->_sort = $value;
        } else {
            throw new InvalidParamException('Only Sort instance, configuration array or false is allowed.');
        }
    }

    /**
     * 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 function refresh()
    {
        $this->_totalCount = null;
        $this->_models = null;
        $this->_keys = null;
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\data;
9
10		use Yii;
11		use yii\base\Component;
12		use yii\base\InvalidParamException;
13
14		/**
15		* BaseDataProvider provides a base class that implements the [[DataProviderInterface]].
16		*
17		* For more details and usage information on BaseDataProvider, see the [guide article on data providers](guide:output-data-providers).
18		*
19		* @property int $count The number of data models in the current page. This property is read-only.
20		* @property array $keys The list of key values corresponding to [[models]]. Each data model in [[models]] is
21		* uniquely identified by the corresponding key value in this array.
22		* @property array $models The list of data models in the current page.
23		* @property Pagination\|false $pagination The pagination object. If this is false, it means the pagination is
24		* disabled. Note that the type of this property differs in getter and setter. See [[getPagination()]] and
25		* [[setPagination()]] for details.
26		* @property Sort\|bool $sort The sorting object. If this is false, it means the sorting is disabled. Note
27		* that the type of this property differs in getter and setter. See [[getSort()]] and [[setSort()]] for details.
28		* @property int $totalCount Total number of possible data models.
29		*
30		* @author Qiang Xue <[email protected]>
31		* @since 2.0
32		*/
33		abstract class BaseDataProvider extends Component implements DataProviderInterface
34		{
35		/**
36		* @var string an ID that uniquely identifies the data provider among all data providers.
37		* You should set this property if the same page contains two or more different data providers.
38		* Otherwise, the [[pagination]] and [[sort]] may not work properly.
39		*/
40		public $id;
41
42		private $_sort;
43		private $_pagination;
44		private $_keys;
45		private $_models;
46		private $_totalCount;
47
48
49		/**
50		* Prepares the data models that will be made available in the current page.
51		* @return array the available data models
52		*/
53		abstract protected function prepareModels();
54
55		/**
56		* Prepares the keys associated with the currently available data models.
57		* @param array $models the available data models
58		* @return array the keys
59		*/
60		abstract protected function prepareKeys($models);
61
62		/**
63		* Returns a value indicating the total number of data models in this data provider.
64		* @return int total number of data models in this data provider.
65		*/
66		abstract protected function prepareTotalCount();
67
68		/**
69		* Prepares the data models and keys.
70		*
71		* This method will prepare the data models and keys that can be retrieved via
72		* [[getModels()]] and [[getKeys()]].
73		*
74		* This method will be implicitly called by [[getModels()]] and [[getKeys()]] if it has not been called before.
75		*
76		* @param bool $forcePrepare whether to force data preparation even if it has been done before.
77		*/
78	48	public function prepare($forcePrepare = false)
79		{
80	48	if ($forcePrepare \|\| $this->_models === null) {
81	46	$this->_models = $this->prepareModels();
82	46	}
83	48	if ($forcePrepare \|\| $this->_keys === null) {
84	48	$this->_keys = $this->prepareKeys($this->_models);
85	48	}
86	48	}
87
88		/**
89		* Returns the data models in the current page.
90		* @return array the list of data models in the current page.
91		*/
92	47	public function getModels()
93		{
94	47	$this->prepare();
95
96	47	return $this->_models;
97		}
98
99		/**
100		* Sets the data models in the current page.
101		* @param array $models the models in the current page
102		*/
103	21	public function setModels($models)
104	21	{
105	2	$this->_models = $models;
106	2	}
107
108		/**
109		* Returns the key values associated with the data models.
110		* @return array the list of key values corresponding to [[models]]. Each data model in [[models]]
111		* is uniquely identified by the corresponding key value in this array.
112		*/
113	23	public function getKeys()
114		{
115	23	$this->prepare();
116
117	23	return $this->_keys;
118		}
119
120		/**
121		* Sets the key values associated with the data models.
122		* @param array $keys the list of key values corresponding to [[models]].
123		*/
124		public function setKeys($keys)
125		{
126		$this->_keys = $keys;
127		}
128
129		/**
130		* Returns the number of data models in the current page.
131		* @return int the number of data models in the current page.
132		*/
133	13	public function getCount()
134		{
135	13	return count($this->getModels());
136		}
137
138		/**
139		* Returns the total number of data models.
140		* When [[pagination]] is false, this returns the same value as [[count]].
141		* Otherwise, it will call [[prepareTotalCount()]] to get the count.
142		* @return int total number of possible data models.
143		*/
144	46	public function getTotalCount()
145		{
146	46	if ($this->getPagination() === false) {
147		return $this->getCount();
148	46	} elseif ($this->_totalCount === null) {
149	44	$this->_totalCount = $this->prepareTotalCount();
150	44	}
151
152	46	return $this->_totalCount;
153		}
154
155		/**
156		* Sets the total number of data models.
157		* @param int $value the total number of data models.
158		*/
159	8	public function setTotalCount($value)
160		{
161	8	$this->_totalCount = $value;
162	8	}
163
164		/**
165		* Returns the pagination object used by this data provider.
166		* Note that you should call [[prepare()]] or [[getModels()]] first to get correct values
167		* of [[Pagination::totalCount]] and [[Pagination::pageCount]].
168		* @return Pagination\|false the pagination object. If this is false, it means the pagination is disabled.
169		*/
170	46	public function getPagination()
171		{
172	46	if ($this->_pagination === null) {
173	38	$this->setPagination([]);
174	38	}
175
176	46	return $this->_pagination;
177		}
178
179		/**
180		* Sets the pagination for this data provider.
181		* @param array\|Pagination\|bool $value the pagination to be used by this data provider.
182		* This can be one of the following:
183		*
184		* - a configuration array for creating the pagination object. The "class" element defaults
185		* to 'yii\data\Pagination'
186		* - an instance of [[Pagination]] or its subclass
187		* - false, if pagination needs to be disabled.
188		*
189		* @throws InvalidParamException
190		*/
191	40	public function setPagination($value)
192		{
193	40	if (is_array($value)) {
194	40	$config = ['class' => Pagination::className()];
195	40	if ($this->id !== null) {
196		$config['pageParam'] = $this->id . '-page';
197		$config['pageSizeParam'] = $this->id . '-per-page';
198		}
199	40	$this->_pagination = Yii::createObject(array_merge($config, $value));
200	40	} elseif ($value instanceof Pagination \|\| $value === false) {
201		$this->_pagination = $value;
202		} else {
203		throw new InvalidParamException('Only Pagination instance, configuration array or false is allowed.');
204		}
205	40	}
206
207		/**
208		* Returns the sorting object used by this data provider.
209		* @return Sort\|bool the sorting object. If this is false, it means the sorting is disabled.
210		*/
211	48	public function getSort()
212		{
213	48	if ($this->_sort === null) {
214	43	$this->setSort([]);
215	43	}
216
217	48	return $this->_sort;
218		}
219
220		/**
221		* Sets the sort definition for this data provider.
222		* @param array\|Sort\|bool $value the sort definition to be used by this data provider.
223		* This can be one of the following:
224		*
225		* - a configuration array for creating the sort definition object. The "class" element defaults
226		* to 'yii\data\Sort'
227		* - an instance of [[Sort]] or its subclass
228		* - false, if sorting needs to be disabled.
229		*
230		* @throws InvalidParamException
231		*/
232	48	public function setSort($value)
233		{
234	48	if (is_array($value)) {
235	48	$config = ['class' => Sort::className()];
236	48	if ($this->id !== null) {
237		$config['sortParam'] = $this->id . '-sort';
238		}
239	48	$this->_sort = Yii::createObject(array_merge($config, $value));
240	48	} elseif ($value instanceof Sort \|\| $value === false) {
241		$this->_sort = $value;
242		} else {
243		throw new InvalidParamException('Only Sort instance, configuration array or false is allowed.');
244		}
245	48	}
246
247		/**
248		* Refreshes the data provider.
249		* After calling this method, if [[getModels()]], [[getKeys()]] or [[getTotalCount()]] is called again,
250		* they will re-execute the query and return the latest data available.
251		*/
252	6	public function refresh()
253		{
254	6	$this->_totalCount = null;
255	6	$this->_models = null;
256	6	$this->_keys = null;
257	6	}
258		}
259

yiisoft / yii2

Push — master ( b4b2b0...f965e3 )

BaseDataProvider::prepareTotalCount()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like