1 | <?php |
||
22 | abstract class Collection extends ArrayObject implements Common |
||
23 | { |
||
24 | /** |
||
25 | * Инстанс клиента |
||
26 | * |
||
27 | * @var Client |
||
28 | */ |
||
29 | private $client; |
||
30 | |||
31 | /** |
||
32 | * Флаг, сигнализирующий что коллекция загружена |
||
33 | * |
||
34 | * @var int |
||
35 | */ |
||
36 | private $loadStatus = 0; |
||
37 | |||
38 | /** |
||
39 | * Имена полей, подлежаших получению через API |
||
40 | * |
||
41 | * @var array |
||
42 | */ |
||
43 | private $fields = []; |
||
44 | |||
45 | /** |
||
46 | * Класс модели |
||
47 | * |
||
48 | * @var Model|string |
||
49 | */ |
||
50 | private $class = null; |
||
51 | |||
52 | /** |
||
53 | * Лимит получаемых моделей коллекции через API |
||
54 | * |
||
55 | * @var int |
||
56 | */ |
||
57 | private $limit = null; |
||
58 | |||
59 | /** |
||
60 | * Смещение выборки моделей через API |
||
61 | * |
||
62 | * @var int |
||
63 | */ |
||
64 | private $offset = null; |
||
65 | |||
66 | /** |
||
67 | * Конструктор коллекции |
||
68 | * |
||
69 | * @param Client $client Инстанс клиента |
||
70 | * @param array $fields Поля для выборки |
||
71 | * @param string $class Класс модели |
||
72 | * @param int $limit Лимит выборки |
||
73 | * @param int $offset Смещение выборки |
||
74 | * |
||
75 | * @throws Exception |
||
76 | */ |
||
77 | 3 | public function __construct(Client $client, array $fields, $class, $limit, $offset) |
|
100 | |||
101 | /** |
||
102 | * Установка лимита выборки |
||
103 | * |
||
104 | * @param int $limit Значение лимита выборки |
||
105 | * |
||
106 | * @throws Exception |
||
107 | */ |
||
108 | 3 | public function setLimit($limit) |
|
116 | |||
117 | /** |
||
118 | * Загрузка коллекции |
||
119 | * |
||
120 | * @param bool $force Заново загружать коллекцию даже если она загружена ранее |
||
121 | * |
||
122 | * @return $this |
||
123 | * |
||
124 | * @throws Exception |
||
125 | */ |
||
126 | 3 | public function load($force = false) |
|
151 | |||
152 | /** |
||
153 | * Установка смещения выборки |
||
154 | * |
||
155 | * @param int $offset Значение смещения выборки |
||
156 | * |
||
157 | * @throws Exception |
||
158 | */ |
||
159 | 3 | public function setOffset($offset) |
|
167 | |||
168 | /** |
||
169 | * Получение нового инстанса итератора коллекции |
||
170 | * |
||
171 | * @return CollectionIterator |
||
172 | */ |
||
173 | public function getIterator() |
||
177 | |||
178 | /** |
||
179 | * Количество моделей в коллекции |
||
180 | * |
||
181 | * @return int |
||
182 | * |
||
183 | * @throws Exception |
||
184 | */ |
||
185 | 2 | public function count() |
|
191 | |||
192 | /** |
||
193 | * Получение коллекции в виде массива |
||
194 | * |
||
195 | * @return array |
||
196 | * |
||
197 | * @throws Exception |
||
198 | */ |
||
199 | public function getData() |
||
205 | |||
206 | /** |
||
207 | * Получение первой модели в коллекции |
||
208 | * |
||
209 | * @return Model |
||
210 | * |
||
211 | * @throws Exception |
||
212 | */ |
||
213 | 1 | public function reset() |
|
219 | |||
220 | /** |
||
221 | * Создание модели по переданным данным |
||
222 | * |
||
223 | * @param array $data Данные для создания модели |
||
224 | * |
||
225 | * @return Model |
||
226 | * |
||
227 | * @throws Exception |
||
228 | */ |
||
229 | public function createModel(array $data = null) |
||
242 | |||
243 | /** |
||
244 | * Получение последней модели в коллекции |
||
245 | * |
||
246 | * @return Model |
||
247 | * |
||
248 | * @throws Exception |
||
249 | */ |
||
250 | public function end() |
||
256 | } |