CTypedList
| Пакет | system.collections |
|---|---|
| Наследование | класс CTypedList » CList » CComponent |
| Реализует | Countable, ArrayAccess, Traversable, IteratorAggregate |
| С момента | 1.0 |
| Исходный код | framework/collections/CTypedList.php |
CTypedList представляет список, элементы которого имеют определённый тип.
CTypedList расширяет CList, гарантируя, что все добавляемые в список элементы относятся к определённому классу.
CTypedList расширяет CList, гарантируя, что все добавляемые в список элементы относятся к определённому классу.
Свойства общедоступные
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| count | целое число | Возвращает количество элементов в списке. | CList |
| iterator | Итератор | Возвращает итератор для обхода элементов в списке. | CList |
| readOnly | булево | Указывает, является ли список только для чтения. | CList |
Методы общедоступные
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CTypedList |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства нулевым. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в значение null. | CComponent |
| add() | Добавляет элемент в конец списка. | CList |
| asa() | Возвращает объект поведения с заданным именем. | CComponent |
| attachBehavior() | Прикрепляет поведение к компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, можно ли прочитать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| clear() | Удаляет все элементы из списка. | CList |
| contains() | CList | |
| copyFrom() | Копирует данные из итерируемого объекта в список. | CList |
| count() | Возвращает количество элементов в списке. | CList |
| detachBehavior() | Открепляет поведение от компонента. | CComponent |
| detachBehaviors() | Открепляет все поведения от компонента. | CComponent |
| detachEventHandler() | Открепляет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает прикрепленное поведение. | CComponent |
| disableBehaviors() | Отключает все прикрепленные поведения к компоненту. | CComponent |
| enableBehavior() | Включает прикрепленное поведение. | CComponent |
| enableBehaviors() | Включает все прикрепленные поведения к компоненту. | CComponent |
| evaluateExpression() | Вычисляет PHP выражение или обратный вызов в контексте данного компонента. | CComponent |
| getCount() | Возвращает количество элементов в списке. | CList |
| getEventHandlers() | Возвращает список прикреплённых обработчиков событий для события. | CComponent |
| getIterator() | Возвращает итератор для обхода элементов в списке. | CList |
| getReadOnly() | Возвращает, является ли список только для чтения. По умолчанию false. | CList |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли прикреплённые обработчики к событию с заданным именем. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| indexOf() | CList | |
| insertAt() | Вставляет элемент в указанную позицию. | CTypedList |
| itemAt() | Возвращает элемент по указанному смещению. | CList |
| mergeWith() | Объединяет данные из итерируемого объекта в список. | CList |
| offsetExists() | Возвращает, существует ли элемент по указанному смещению. | CList |
| offsetGet() | Возвращает элемент по указанному смещению. | CList |
| offsetSet() | Устанавливает элемент по указанному смещению. | CList |
| offsetUnset() | Удаляет элемент по указанному смещению. | CList |
| raiseEvent() | Возбуждает событие. | CComponent |
| remove() | Удаляет элемент из списка. | CList |
| removeAt() | Удаляет элемент по указанной позиции. | CList |
| toArray() | CList |
Методы защищённые
| Метод | Описание | Определено в |
|---|---|---|
| setReadOnly() | Устанавливает, является ли список только для чтения. | CList |
Подробное описание методов
__construct() метод
public void __construct(string $type) | ||
| $type | строка | тип класса |
Исходный код: framework/collections/CTypedList.php#29 (показать)
public function __construct($type)
{
$this->_type=$type;
}
Конструктор.
insertAt() метод
public void insertAt(integer $index, mixed $item) | ||
| $index | integer | указанная позиция. |
| $item | mixed | новый элемент |
Исходный код: framework/collections/CTypedList.php#43 (показать)
public function insertAt($index,$item)
{
if($item instanceof $this->_type)
parent::insertAt($index,$item);
else
throw new CException(Yii::t('yii','CTypedList<{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/CTypedList