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
/**
* Файл содержит класс, реализующий функции маппирования (Map).
*
* @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/
*/
/**
* Класс CMap реализует коллекцию, имеющую пары ключ-значение.
*
* Вы можете иметь доступ, добавлять и удалять элементы по ключу, используя методы
* {@link itemAt}, {@link add} и {@link remove}.
* Для получения количества элементов в карте, используйте метод {@link getCount}.
* Объект класса CMap также может использоваться как обычный массив:
* <pre>
* $map[$key]=$value; // добавление пары ключ-значение
* unset($map[$key]); // удаление значения с определенным ключом
* if(isset($map[$key])) // проверка наличия ключа в карте
* foreach($map as $key=>$value) // обход элементов карты
* $n=count($map); // получение числа элементов карты
* </pre>
*
* @property boolean $readOnly только для чтения ли данная карта или нет. По
* умолчанию false
* @property CMapIterator $iterator итератор для обхода элементов карты
* @property integer $count количество элементов карты
* @property array $keys список ключей
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id: CMap.php 3518 2011-12-28 23:31:29Z alexander.makarow $
* @package system.collections
* @since 1.0
*/
class CMap extends CComponent implements IteratorAggregate,ArrayAccess,Countable
{
/**
* @var array внутреннее хранилище данных
*/
private $_d=array();
/**
* @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 CMapIterator итератор для обхода элементов карты
*/
public function getIterator()
{
return new CMapIterator($this->_d);
}
/**
* Возвращает количество элементов карты.
* Метод требуется интерфейсом Countable
* @return integer количество элементов карты
*/
public function count()
{
return $this->getCount();
}
/**
* Возвращает количество элементов карты
* @return integer количество элементов карты
*/
public function getCount()
{
return count($this->_d);
}
/**
* @return array список ключей
*/
public function getKeys()
{
return array_keys($this->_d);
}
/**
* Возвращает элемент по определенному ключу.
* Метод в точности такой же как метод {@link offsetGet}
* @param mixed $key ключ
* @return mixed элемент; null, если элемент не найден
*/
public function itemAt($key)
{
if(isset($this->_d[$key]))
return $this->_d[$key];
else
return null;
}
/**
* Добавляет элемент в карту.
* Примечание: если определенный ключ уже существует, старое значение будет перезаписано
* @param mixed $key ключ
* @param mixed $value значение
* @throws CException вызывается, если карта только для чтения
*/
public function add($key,$value)
{
if(!$this->_r)
{
if($key===null)
$this->_d[]=$value;
else
$this->_d[$key]=$value;
}
else
throw new CException(Yii::t('yii','The map is read only.'));
}
/**
* Удаляет элемент из карты по его ключу
* @param mixed $key ключ удаляемого элемента
* @return mixed удаленное значение; null, если такого ключа не существует
* @throws CException вызывается, если карта только для чтения
*/
public function remove($key)
{
if(!$this->_r)
{
if(isset($this->_d[$key]))
{
$value=$this->_d[$key];
unset($this->_d[$key]);
return $value;
}
else
{
// it is possible the value is null, which is not detected by isset
unset($this->_d[$key]);
return null;
}
}
else
throw new CException(Yii::t('yii','The map is read only.'));
}
/**
* Очищает карту
*/
public function clear()
{
foreach(array_keys($this->_d) as $key)
$this->remove($key);
}
/**
* @param mixed $key ключ
* @return boolean содержит ли карта элемент с определенным ключом
*/
public function contains($key)
{
return isset($this->_d[$key]) || array_key_exists($key,$this->_d);
}
/**
* @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->getCount()>0)
$this->clear();
if($data instanceof CMap)
$data=$data->_d;
foreach($data as $key=>$value)
$this->add($key,$value);
}
else if($data!==null)
throw new CException(Yii::t('yii','Map data must be an array or an object implementing Traversable.'));
}
/**
* Сливает итерируемые данные в карту.
*
* Существующие данные в карте будут перезаписаны, если их ключи совпадают с ключами добавляемых данных.
* Если происходит рекурсивное слияние, выполняется следующий алгоритм:
* <ul>
* <li>данные карты сохраняются в переменную $a, а добавляемые данные - в переменную $b;</li>
* <li>если и $a и $b имеют индексированный массив при одинаковых строковых ключах, массивы сливаются по этому алгоритму;</li>
* <li>все целочисленно-индексированные элементы в $b добавляются в $a и переиндексируются соответственно;</li>
* <li>все строково-индексированные элементы в $b переписывают элементы в $a с теми же индексами;</li>
* </ul>
*
* @param mixed $data данные для слияния; должны быть массивом или Traversable-объектом
* @param boolean $recursive должно ли слияние быть рекурсивным
* @throws CException вызывается, если данные не являются ни массивом ни итератором
*/
public function mergeWith($data,$recursive=true)
{
if(is_array($data) || $data instanceof Traversable)
{
if($data instanceof CMap)
$data=$data->_d;
if($recursive)
{
if($data instanceof Traversable)
{
$d=array();
foreach($data as $key=>$value)
$d[$key]=$value;
$this->_d=self::mergeArray($this->_d,$d);
}
else
$this->_d=self::mergeArray($this->_d,$data);
}
else
{
foreach($data as $key=>$value)
$this->add($key,$value);
}
}
else if($data!==null)
throw new CException(Yii::t('yii','Map data must be an array or an object implementing Traversable.'));
}
/**
* Сливает рекурсивно два или более массива в один
* Если массивы имеют элемент с одинаковым строковым ключом, то элемент второго
* массива перезапишет элемент первого (в отличие от array_merge_recursive).
* Рекурсивное слияние будет выполняться, если оба массива имеют элементы с одинаковым ключом
* и значением в виде массива. Для элементов с целочисленными ключами элементы второго
* массива будут добавлены к первому массиву
* @param array $a массив, в который происходит слияние
* @param array $b массив, который сливается с предыдущим. Можно определить
* дополнительные массивы третим и т.д. аргументами
* @return array слитый массив (исходные массивы остаются без изменений)
* @see mergeWith
*/
public static function mergeArray($a,$b)
{
$args=func_get_args();
$res=array_shift($args);
while(!empty($args))
{
$next=array_shift($args);
foreach($next as $k => $v)
{
if(is_integer($k))
isset($res[$k]) ? $res[]=$v : $res[$k]=$v;
else if(is_array($v) && isset($res[$k]) && is_array($res[$k]))
$res[$k]=self::mergeArray($res[$k],$v);
else
$res[$k]=$v;
}
}
return $res;
}
/**
* Находится ли элемент на данном смещении (ключе).
* Метод требуется интерфейсом ArrayAccess
* @param mixed $offset смещение для проверки
* @return boolean
*/
public function offsetExists($offset)
{
return $this->contains($offset);
}
/**
* Возвращает элемент на данном смещении (ключе).
* Метод требуется интерфейсом ArrayAccess
* @param integer $offset смещение для получения элемента
* @return mixed элемент на данном смещении (ключе); null, если элемента нет
*/
public function offsetGet($offset)
{
return $this->itemAt($offset);
}
/**
* Устанавливает элемент в определенное смещение.
* Метод требуется интерфейсом ArrayAccess
* @param integer $offset смещение для установки элемента
* @param mixed $item элемент
*/
public function offsetSet($offset,$item)
{
$this->add($offset,$item);
}
/**
* Удаляет элемент на определенном смещении.
* Метод требуется интерфейсом ArrayAccess
* @param mixed $offset смещение для удаления элемента
*/
public function offsetUnset($offset)
{
$this->remove($offset);
}
}