Особенность yii\base\ArrayAccessTrait
| Реализовано в | yii\elasticsearch\ActiveFixture, yii\mongodb\ActiveFixture, yii\sphinx\ActiveFixture, yii\test\ActiveFixture, yii\test\ArrayFixture, yii\test\BaseActiveFixture |
|---|---|
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/base/ArrayAccessTrait.php |
Особенность ArrayAccessTrait предоставляет реализацию для IteratorAggregate, ArrayAccess и Countable.
Обратите внимание, что ArrayAccessTrait требует, чтобы класс, использующий его, содержал свойство с именем data, которое должно быть массивом. Данные будут доступны через ArrayAccessTrait для поддержки доступа к объекту класса как к массиву.
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| count() | Возвращает количество элементов данных. | yii\base\ArrayAccessTrait |
| getIterator() | Возвращает итератор для обхода данных. | yii\base\ArrayAccessTrait |
| offsetExists() | Этот метод требуется интерфейсом ArrayAccess. | yii\base\ArrayAccessTrait |
| offsetGet() | Этот метод требуется интерфейсом ArrayAccess. | yii\base\ArrayAccessTrait |
| offsetSet() | Этот метод требуется интерфейсом ArrayAccess. | yii\base\ArrayAccessTrait |
| offsetUnset() | Этот метод требуется интерфейсом ArrayAccess. | yii\base\ArrayAccessTrait |
Подробное описание методов
count() публичный метод
Возвращает количество элементов данных.
Этот метод требуется интерфейсом Countable.
| public целое число count ( ) | ||
|---|---|---|
| return | целое число |
Количество элементов данных. |
getIterator() публичный метод
Возвращает итератор для обхода данных.
Этот метод требуется интерфейсом SPL IteratorAggregate. Он будет неявно вызван при использовании foreach для обхода коллекции.
| public ArrayIterator getIterator ( ) | ||
|---|---|---|
| return | ArrayIterator |
Итератор для обхода элементов в коллекции. |
offsetExists() публичный метод
Этот метод требуется интерфейсом ArrayAccess.
| public булево offsetExists ( $offset ) | ||
|---|---|---|
| $offset | смешанный тип |
Смещение для проверки |
offsetGet() публичный метод
Этот метод требуется интерфейсом ArrayAccess.
| public mixed offsetGet ( $offset ) | ||
|---|---|---|
| $offset | целое число |
Смещение для получения элемента. |
| return | смешанный тип |
Элемент по смещению, null, если элемент по данному смещению не найден. |
offsetSet() публичный метод
Этот метод требуется интерфейсом ArrayAccess.
| public void offsetSet ( $offset, $item ) | ||
|---|---|---|
| $offset | целое число |
Смещение для установки элемента |
| $item | смешанный тип |
Значение элемента |
offsetUnset() публичный метод
Этот метод требуется интерфейсом ArrayAccess.
| public void offsetUnset ( $offset ) | ||
|---|---|---|
| $offset | смешанный тип |
Смещение для удаления элемента |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-arrayaccesstrait.html
