CTypedMap
| Package | system.collections |
|---|---|
| Inheritance | class CTypedMap » CMap » CComponent |
| Implements | Countable, ArrayAccess, Traversable, IteratorAggregate |
| Since | 1.0 |
| Source Code | framework/collections/CTypedMap.php |
CTypedMap представляет собой map, элементы которого имеют определённый тип.
CTypedMap расширяет CMap, гарантируя, что добавляемые в список элементы имеют определённый класс типа.
CTypedMap расширяет CMap, гарантируя, что добавляемые в список элементы имеют определённый класс типа.
Открытые свойства
| Property | Type | Description | Defined By |
|---|---|---|---|
| count | integer | Возвращает количество элементов в map. | CMap |
| iterator | CMapIterator | Возвращает итератор для обхода элементов в списке. | CMap |
| keys | array | Список ключей | CMap |
| readOnly | boolean | Определяет, является ли данный map доступным только для чтения. | CMap |
Открытые методы
| Method | Description | Defined By |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CTypedMap |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| add() | Добавляет элемент в map. | CTypedMap |
| asa() | Возвращает именованный объект поведения. | CComponent |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, можно ли прочитать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| clear() | Удаляет все элементы из map. | CMap |
| contains() | CMap | |
| copyFrom() | Копирует итерируемые данные в map. | CMap |
| count() | Возвращает количество элементов в map. | CMap |
| detachBehavior() | Открепляет поведение от компонента. | CComponent |
| detachBehaviors() | Открепляет все поведения от компонента. | CComponent |
| detachEventHandler() | Открепляет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает прикреплённое поведение. | CComponent |
| disableBehaviors() | Отключает все поведения, прикреплённые к этому компоненту. | CComponent |
| enableBehavior() | Включает прикреплённое поведение. | CComponent |
| enableBehaviors() | Включает все поведения, прикреплённые к этому компоненту. | CComponent |
| evaluateExpression() | Вычисляет PHP-выражение или обратный вызов в контексте этого компонента. | CComponent |
| getCount() | Возвращает количество элементов в map. | CMap |
| getEventHandlers() | Возвращает список прикреплённых обработчиков событий для события. | CComponent |
| getIterator() | Возвращает итератор для обхода элементов в списке. | CMap |
| getKeys() | Возвращает список ключей | CMap |
| getReadOnly() | Возвращает, является ли данный map доступным только для чтения. По умолчанию false. | CMap |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли у именованного события прикреплённые обработчики. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| itemAt() | Возвращает элемент с указанным ключом. | CMap |
| mergeArray() | Рекурсивно объединяет два или более массивов в один. | CMap |
| mergeWith() | Объединяет итерируемые данные в map. | CMap |
| offsetExists() | Возвращает, существует ли элемент по указанному смещению. | CMap |
| offsetGet() | Возвращает элемент по указанному смещению. | CMap |
| offsetSet() | Устанавливает элемент по указанному смещению. | CMap |
| offsetUnset() | Сбрасывает элемент по указанному смещению. | CMap |
| raiseEvent() | Вызывает событие. | CComponent |
| remove() | Удаляет элемент из map по его ключу. | CMap |
| toArray() | CMap |
Защищённые методы
| Method | Description | Defined By |
|---|---|---|
| setReadOnly() | Устанавливает, является ли данный список доступным только для чтения | CMap |
Подробное описание методов
__construct() метод
public void __construct(string $type) | ||
| $type | string | тип класса |
Исходный код: framework/collections/CTypedMap.php#29 (show)
public function __construct($type)
{
$this->_type=$type;
}
Конструктор.
add() метод
public void add(integer $index, mixed $item) | ||
| $index | целое число | указанная позиция. |
| $item | смешанный тип | новый элемент |
Исходный код: framework/collections/CTypedMap.php#43 (показать)
public function add($index,$item)
{
if($item instanceof $this->_type)
parent::add($index,$item);
else
throw new CException(Yii::t('yii','CTypedMap<{type}> can only hold objects of {type} class.',
array('{type}'=>$this->_type)));
}
Добавляет элемент в карту. Этот метод переопределяет реализацию родительского класса, проверяя, что вставляемый элемент имеет определённый тип.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CTypedMap