1 | <?php |
||
16 | abstract class Collection extends ArrayObject implements Common |
||
17 | { |
||
18 | /** |
||
19 | * Инстанс клиента |
||
20 | * |
||
21 | * @var Client |
||
22 | */ |
||
23 | private $client; |
||
24 | |||
25 | /** |
||
26 | * Флаг, сигнализирующий что коллекция загружена |
||
27 | * |
||
28 | * @var int |
||
29 | */ |
||
30 | private $loadStatus = 0; |
||
31 | |||
32 | /** |
||
33 | * Имена полей, подлежаших получению через API |
||
34 | * |
||
35 | * @var array |
||
36 | */ |
||
37 | private $fields = []; |
||
38 | |||
39 | /** |
||
40 | * Класс модели |
||
41 | * |
||
42 | * @var Model|string |
||
43 | */ |
||
44 | private $class = null; |
||
45 | |||
46 | /** |
||
47 | * Лимит получаемых моделей коллекции через API |
||
48 | * |
||
49 | * @var int |
||
50 | */ |
||
51 | private $limit = null; |
||
52 | |||
53 | /** |
||
54 | * Смещение выборки моделей через API |
||
55 | * |
||
56 | * @var int |
||
57 | */ |
||
58 | private $offset = null; |
||
59 | |||
60 | /** |
||
61 | * Всего элементов без учета лимита |
||
62 | * |
||
63 | * @var int |
||
64 | */ |
||
65 | private $fullCount = null; |
||
66 | |||
67 | /** |
||
68 | * Конструктор коллекции |
||
69 | * |
||
70 | * @param Client $client Инстанс клиента |
||
71 | * @param array $fields Поля для выборки |
||
72 | * @param string $class Класс модели |
||
73 | * @param int $limit Лимит выборки |
||
74 | * @param int $offset Смещение выборки |
||
75 | * |
||
76 | * @throws Exception |
||
77 | */ |
||
78 | 3 | public function __construct(Client $client, array $fields, $class, $limit, $offset) |
|
101 | |||
102 | /** |
||
103 | * Установка лимита выборки |
||
104 | * |
||
105 | * @param int $limit Значение лимита выборки |
||
106 | * |
||
107 | * @throws Exception |
||
108 | */ |
||
109 | 3 | public function setLimit($limit) |
|
117 | |||
118 | /** |
||
119 | * Загрузка коллекции |
||
120 | * |
||
121 | * @param bool $force Заново загружать коллекцию даже если она загружена ранее |
||
122 | * |
||
123 | * @return $this |
||
124 | * |
||
125 | * @throws Exception |
||
126 | */ |
||
127 | 3 | public function load($force = false) |
|
154 | |||
155 | /** |
||
156 | * Получение количества всех элементов без учета лимита |
||
157 | * |
||
158 | * @return int |
||
159 | * |
||
160 | * @throws Exception |
||
161 | */ |
||
162 | public function getFullCount() |
||
168 | |||
169 | /** |
||
170 | * Установка смещения выборки |
||
171 | * |
||
172 | * @param int $offset Значение смещения выборки |
||
173 | * |
||
174 | * @throws Exception |
||
175 | */ |
||
176 | 3 | public function setOffset($offset) |
|
184 | |||
185 | /** |
||
186 | * Получение нового инстанса итератора коллекции |
||
187 | * |
||
188 | * @return CollectionIterator |
||
189 | */ |
||
190 | public function getIterator() |
||
194 | |||
195 | /** |
||
196 | * Количество моделей в коллекции |
||
197 | * |
||
198 | * @return int |
||
199 | * |
||
200 | * @throws Exception |
||
201 | */ |
||
202 | 2 | public function count() |
|
208 | |||
209 | /** |
||
210 | * Получение коллекции в виде массива |
||
211 | * |
||
212 | * @return array |
||
213 | * |
||
214 | * @throws Exception |
||
215 | */ |
||
216 | public function getData() |
||
222 | |||
223 | /** |
||
224 | * Получение первой модели в коллекции |
||
225 | * |
||
226 | * @return Model |
||
227 | * |
||
228 | * @throws Exception |
||
229 | */ |
||
230 | 1 | public function reset() |
|
236 | |||
237 | /** |
||
238 | * Создание модели по переданным данным |
||
239 | * |
||
240 | * @param array $data Данные для создания модели |
||
241 | * |
||
242 | * @return Model |
||
243 | * |
||
244 | * @throws Exception |
||
245 | */ |
||
246 | public function createModel(array $data = null) |
||
259 | |||
260 | /** |
||
261 | * Получение последней модели в коллекции |
||
262 | * |
||
263 | * @return Model |
||
264 | * |
||
265 | * @throws Exception |
||
266 | */ |
||
267 | public function end() |
||
273 | } |