1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
/**
* Файл содержит класс, реализующий функции списка.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright &copy; 2008-2011 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
/**
* Класс CList реализует коллекцию с целочисленными индексами.
*
* Вы можете получать, добавлять, вставлять и удалять элементы, используя методы
* {@link itemAt}, {@link add}, {@link insertAt}, {@link remove}, и {@link removeAt}.
* Для получения количества элементов в списке, используйте {@link getCount}.
* Объект класса CList может также использоваться в качестве обычного массива:
* <pre>
* $list[]=$item; // добавить в конец
* $list[$index]=$item; // $index должен лежать в диапазоне между 0 и $list->Count
* unset($list[$index]); // удалить элемент с индексом $index
* if(isset($list[$index])) // есть ли элемент в данной позиции списка
* foreach($list as $index=>$item) // обход элементов списка
* $n=count($list); // количество элементов списка
* </pre>
*
* Для расширения CList до выполнения дополнительных операций добавления и удаления
* (например, проверка типа), переопределяйте методы {@link insertAt()} и {@link removeAt()}.
*
* @property boolean $readOnly только для чтения ли данный список или нет. По
* умолчанию false
* @property Iterator $iterator итератор для обхода элементов списка
* @property integer $count количество элементов списка
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id: CList.php 3430 2011-11-02 23:10:03Z alexander.makarow@gmail.com $
* @package system.collections
* @since 1.0
*/
class CList extends CComponent implements IteratorAggregate,ArrayAccess,Countable
{
/**
* @var array внутреннее хранилище данных
*/
private $_d=array();
/**
* @var integer количество элементов
*/
private $_c=0;
/**
* @var boolean только для чтения ли данный список
*/
private $_r=false;
/**
* Конструктор.
* Инициализирует список массивом или итерируемым объектом.
* @param array $data начальные данные. По умолчанию null - без инициализации.
* @param boolean $readOnly только для чтения ли данный список
* @throws CException вызывается, если данные не нулевые и не являются ни массивом ни итератором.
*/
public function __construct($data=null,$readOnly=false)
{
if($data!==null)
$this->copyFrom($data);
$this->setReadOnly($readOnly);
}
/**
* @return boolean только для чтения ли данный список или нет. По умолчанию false
*/
public function getReadOnly()
{
return $this->_r;
}
/**
* @param boolean $value только для чтения ли данный список или нет
*/
protected function setReadOnly($value)
{
$this->_r=$value;
}
/**
* Возвращает итератор для обхода элементов списка.
* Метод требуется интерфейсом IteratorAggregate
* @return CIterator итератор для обхода элементов списка
*/
public function getIterator()
{
return new CListIterator($this->_d);
}
/**
* Возвращает количество элементов списка.
* Метод требуется интерфейсом Countable
* @return integer количество элементов списка
*/
public function count()
{
return $this->getCount();
}
/**
* Возвращает количество элементов списка
* @return integer количество элементов списка
*/
public function getCount()
{
return $this->_c;
}
/**
* Возвращает элемент по определенному смещению.
* Метод в точности такой же как метод {@link offsetGet}.
* @param integer $index индекс элемента
* @return mixed элемент при индексе
* @throws CException вызывается, если индекс выходит за границы диапазона
*/
public function itemAt($index)
{
if(isset($this->_d[$index]))
return $this->_d[$index];
else if($index>=0 && $index<$this->_c) // in case the value is null
return $this->_d[$index];
else
throw new CException(Yii::t('yii','List index "{index}" is out of bound.',
array('{index}'=>$index)));
}
/**
* Добавляет элемент в конец списка.
* @param mixed $item новый элемент
* @return integer индекс, в который был добавлен элемент
*/
public function add($item)
{
$this->insertAt($this->_c,$item);
return $this->_c-1;
}
/**
* Вставляет элемент в определенную позицию.
* Текущий элемент в данной позиции и последующие будут сдвинуты на один шаг к концу
* @param integer $index определенная позиция.
* @param mixed $item новый элемент
* @throws CException вызывается, если переданный индекс превышает границы списка или список только для чтения
*/
public function insertAt($index,$item)
{
if(!$this->_r)
{
if($index===$this->_c)
$this->_d[$this->_c++]=$item;
else if($index>=0 && $index<$this->_c)
{
array_splice($this->_d,$index,0,array($item));
$this->_c++;
}
else
throw new CException(Yii::t('yii','List index "{index}" is out of bound.',
array('{index}'=>$index)));
}
else
throw new CException(Yii::t('yii','The list is read only.'));
}
/**
* Удаляет элемент из списка.
* Сначала выполняется поиск элемента в списке.
* Первый найденный элемент удаляется из списка.
* @param mixed $item удаляемый элемент.
* @return integer индекс, из которого был удален элемент
* @throws CException вызывается, если элемент не существует
*/
public function remove($item)
{
if(($index=$this->indexOf($item))>=0)
{
$this->removeAt($index);
return $index;
}
else
return false;
}
/**
* Удаляет элемент из определенной позиции.
* @param integer $index индекс удаляемого элемента.
* @return mixed удаленный элемент.
* @throws CException вызывается, если переданный индекс превышает границы списка или список только для чтения
*/
public function removeAt($index)
{
if(!$this->_r)
{
if($index>=0 && $index<$this->_c)
{
$this->_c--;
if($index===$this->_c)
return array_pop($this->_d);
else
{
$item=$this->_d[$index];
array_splice($this->_d,$index,1);
return $item;
}
}
else
throw new CException(Yii::t('yii','List index "{index}" is out of bound.',
array('{index}'=>$index)));
}
else
throw new CException(Yii::t('yii','The list is read only.'));
}
/**
* Очищает список
*/
public function clear()
{
for($i=$this->_c-1;$i>=0;--$i)
$this->removeAt($i);
}
/**
* @param mixed $item элемент
* @return boolean содержит ли список элемент
*/
public function contains($item)
{
return $this->indexOf($item)>=0;
}
/**
* @param mixed $item элемент
* @return integer индекс элемнта в списке (начало счета с 0); -1, если не найден.
*/
public function indexOf($item)
{
if(($index=array_search($item,$this->_d,true))!==false)
return $index;
else
return -1;
}
/**
* @return array список элементов массива
*/
public function toArray()
{
return $this->_d;
}
/**
* Копирует итерируемые данные в список.
* Примечание: существующие данные сначала будут очищены.
* @param mixed $data копируемые данные; должны быть массивом или Traversable-объектом
* @throws CException вызывается, если данные не являются ни массивом ни итератором.
*/
public function copyFrom($data)
{
if(is_array($data) || ($data instanceof Traversable))
{
if($this->_c>0)
$this->clear();
if($data instanceof CList)
$data=$data->_d;
foreach($data as $item)
$this->add($item);
}
else if($data!==null)
throw new CException(Yii::t('yii','List data must be an array or an object implementing Traversable.'));
}
/**
* Сливает итерируемые данные в список.
* Новые данные будут добавлены в конец существующих данных.
* @param mixed $data данные для слияния; должны быть массивом или Traversable-объектом
* @throws CException вызывается, если данные не являются ни массивом ни итератором.
*/
public function mergeWith($data)
{
if(is_array($data) || ($data instanceof Traversable))
{
if($data instanceof CList)
$data=$data->_d;
foreach($data as $item)
$this->add($item);
}
else if($data!==null)
throw new CException(Yii::t('yii','List data must be an array or an object implementing Traversable.'));
}
/**
* Находится ли элемент на данном смещении (ключе).
* Метод требуется интерфейсом ArrayAccess.
* @param mixed $offset смещение для проверки
* @return boolean
*/
public function offsetExists($offset)
{
return ($offset>=0 && $offset<$this->_c);
}
/**
* Возвращает элемент на данном смещении (ключе).
* Метод требуется интерфейсом ArrayAccess.
* @param integer $offset смещение для получения элемента.
* @return mixed элемент на данном смещении (ключе)
* @throws CException вызывается, если смещения неверно
*/
public function offsetGet($offset)
{
return $this->itemAt($offset);
}
/**
* Устанавливает элемент в определенное смещение.
* Метод требуется интерфейсом ArrayAccess.
* @param integer $offset смещение для установки элемента
* @param mixed $item элемент
*/
public function offsetSet($offset,$item)
{
if($offset===null || $offset===$this->_c)
$this->insertAt($this->_c,$item);
else
{
$this->removeAt($offset);
$this->insertAt($offset,$item);
}
}
/**
* Удаляет элемент на определенном смещении.
* Метод требуется интерфейсом ArrayAccess.
* @param mixed $offset смещение для удаления элемента
*/
public function offsetUnset($offset)
{
$this->removeAt($offset);
}
}