Класс yii\mongodb\file\Cursor
| Наследование | yii\mongodb\file\Cursor » IteratorIterator |
|---|---|
| Реализует | Countable |
| Доступна с версии | 2.1 |
| Исходный код | https://github.com/yiisoft/yii2-mongodb/blob/master/file/Cursor.php |
Cursor — это оболочка вокруг \MongoDB\Driver\Cursor, которая позволяет возвращать запись с экземпляром yii\mongodb\file\Download.
Общественные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $collection | yii\mongodb\file\Collection | Связанный экземпляр коллекции GridFS. | yii\mongodb\file\Cursor |
Общественные методы
| Метод | Описание | Определено |
|---|---|---|
| __call() | Магический метод PHP, который вызывается при попытке вызова несуществующего метода. | yii\mongodb\file\Cursor |
| __construct() | Конструктор. | yii\mongodb\file\Cursor |
| __get() | Магический метод PHP, который вызывается при попытке получить несуществующее свойство. | yii\mongodb\file\Cursor |
| __isset() | Магический метод PHP, который вызывается при попытке проверить, установлено ли свойство. | yii\mongodb\file\Cursor |
| __set() | Магический метод PHP, который вызывается при попытке установить несуществующее свойство. | yii\mongodb\file\Cursor |
| __unset() | Магический метод PHP, который вызывается при попытке удалить свойство. | yii\mongodb\file\Cursor |
| count() | Подсчитать элементы этого курсора. | yii\mongodb\file\Cursor |
| current() | Возвращает текущий элемент. Этот метод требуется интерфейсом Iterator. | yii\mongodb\file\Cursor |
| getId() | Возвращает идентификатор для этого курсора. | yii\mongodb\file\Cursor |
| setTypeMap() | Устанавливает таблицу типов для использования при десериализации BSON. | yii\mongodb\file\Cursor |
| toArray() | Возвращает массив, содержащий все результаты для этого курсора. | yii\mongodb\file\Cursor |
Подробное описание свойств
$collection общественное свойство
Связанный экземпляр коллекции GridFS.
public yii\mongodb\file\Collection $collection = null
Подробное описание методов
__call() public method
Магический метод PHP, вызываемый при попытке вызвать несуществующий метод.
Перенаправляет вызов метода к внутреннему итератору.
| public mixed __call ( $name, $arguments ) | ||
|---|---|---|
| $name | string |
Имя метода. |
| $arguments | array |
Аргументы метода |
| return | mixed |
Результат метода. |
__construct() public method
Конструктор.
| public void __construct ( $collection, $cursor ) | ||
|---|---|---|
| $collection | yii\mongodb\file\Collection | |
| $cursor | \MongoDB\Driver\Cursor | |
__get() public method
Магический метод PHP, вызываемый при попытке получить несуществующее свойство.
Возвращает значение из внутреннего итератора.
| public mixed __get ( $name ) | ||
|---|---|---|
| $name | string |
Имя поля. |
| return | mixed |
Значение поля. |
__isset() public method
Магический метод PHP, вызываемый при попытке проверить, установлено ли свойство.
| public boolean __isset ( $name ) | ||
|---|---|---|
| $name | string |
Имя поля. |
| return | boolean |
Существует ли поле или нет. |
__set() public method
Магический метод PHP, вызываемый при попытке установить несуществующее свойство.
Передает значение внутреннему итератору.
| public void __set ( $name, $value ) | ||
|---|---|---|
| $name | string |
Имя поля. |
| $value | mixed |
Значение поля. |
__unset() public method
Магический метод PHP, вызываемый при попытке удалить свойство.
| public void __unset ( $name ) | ||
|---|---|---|
| $name | string |
Имя поля. |
count() public method
Подсчёт элементов этого курсора.
Этот метод необходим для интерфейса Countable.
| public integer count ( ) | ||
|---|---|---|
| return | integer |
Количество элементов. |
current() public method
Возвращает текущий элемент. Этот метод необходим для интерфейса Iterator.
| public mixed current ( ) | ||
|---|---|---|
| return | mixed |
Текущая строка |
getId() public method
Возвращает идентификатор для этого курсора.
| public \MongoDB\Driver\CursorId getId ( ) | ||
|---|---|---|
| return | \MongoDB\Driver\CursorId |
Идентификатор курсора. |
setTypeMap() public method
Устанавливает карту типов для использования при десериализации BSON.
| public void setTypeMap ( $typemap ) | ||
|---|---|---|
| $typemap | array |
Карта типов. |
toArray() public method
Возвращает массив, содержащий все результаты для этого курсора.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-file-cursor.html