Класс yii\mongodb\file\Query
| Наследование | yii\mongodb\file\Query » yii\mongodb\Query » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\db\QueryInterface |
| Использует Трейты | yii\db\QueryTrait |
| Подклассы | yii\mongodb\file\ActiveQuery |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-mongodb/blob/master/file/Query.php |
Query представляет операцию Mongo "find" для коллекции GridFS.
Query ведет себя точно так же, как обычный yii\mongodb\Query. Найденные файлы будут представлены как массивы атрибутов документа файла с дополнительным ключом 'file', который хранит экземпляр \MongoGridFSFile.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $collection | yii\mongodb\file\Collection | Экземпляр коллекции. | yii\mongodb\file\Query |
| $emulateExecution | boolean | Имитировать выполнение запроса, возвращая пустые или ложные результаты. | yii\db\QueryTrait |
| $from | string|array | Коллекция, из которой будет выполняться выборка. | yii\mongodb\Query |
| $indexBy | string|callable | Имя столбца, по которому должны быть индексированы результаты запроса. | yii\db\QueryTrait |
| $limit | integer|yii\db\Expression | Максимальное количество записей, которое должно быть возвращено. | yii\db\QueryTrait |
| $offset | integer|yii\db\Expression | Смещение от нуля, с которого должны быть возвращены записи. | yii\db\QueryTrait |
| $options | array | Параметры курсора в формате: optionKey => optionValue | yii\mongodb\Query |
| $orderBy | array | Как отсортировать результаты запроса. | yii\db\QueryTrait |
| $select | array | Поля результатов, которые нужно вернуть. | yii\mongodb\Query |
| $where | string|array | Условие запроса. | yii\db\QueryTrait |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в значение null. | yii\base\Component |
| addOptions() | Добавляет дополнительные параметры курсора. | yii\mongodb\Query |
| addOrderBy() | Добавляет дополнительные столбцы ORDER BY в запрос. | yii\db\QueryTrait |
| all() | Выполняет запрос и возвращает все результаты в виде массива. | yii\mongodb\Query |
| andFilterCompare() | Вспомогательный метод для удобного запроса по значениям, содержащим некоторые распространенные операторы. | yii\mongodb\Query |
| andFilterWhere() | Добавляет дополнительное условие WHERE к существующему, но игнорирует пустые операнды. | yii\db\QueryTrait |
| andWhere() | Добавляет дополнительное условие WHERE к существующему. | yii\db\QueryTrait |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| average() | Возвращает среднее значение указанных значений столбцов. | yii\mongodb\Query |
| batch() | Начинает пакетный запрос. | yii\mongodb\Query |
| behaviors() | Возвращает список поведений, по которым этот компонент должен вести себя. | yii\base\Component |
| buildCursor() | Создаёт MongoDB курсор для этого запроса. | yii\mongodb\Query |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| column() | Выполняет запрос и возвращает первый столбец результата. | yii\mongodb\Query |
| count() | Возвращает количество записей. | yii\mongodb\Query |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| distinct() | Возвращает список различных значений для заданного столбца по всей коллекции. | yii\mongodb\Query |
| each() | Начинает пакетный запрос и извлекает данные строка за строкой. | yii\mongodb\Query |
| emulateExecution() | Устанавливает, следует ли эмулировать выполнение запроса, предотвращая взаимодействие с хранилищем данных. | yii\db\QueryTrait |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| exists() | Возвращает значение, указывающее, содержит ли результат запроса какую-либо строку данных. | yii\mongodb\Query |
| filterWhere() | Устанавливает часть WHERE запроса, но игнорирует пустые операнды. | yii\db\QueryTrait |
| from() | Устанавливает коллекцию, из которой необходимо выбрать данные. | yii\mongodb\Query |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все прикрепленные к этому компоненту поведения. | yii\base\Component |
| getCollection() | Возвращает коллекцию Mongo для этого запроса. | yii\mongodb\file\Query |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| indexBy() | Устанавливает свойство indexBy(). | yii\db\QueryTrait |
| init() | Инициализирует объект. | yii\base\Object |
| limit() | Устанавливает часть LIMIT запроса. | yii\db\QueryTrait |
| max() | Возвращает максимальное значение указанных значений столбцов. | yii\mongodb\Query |
| min() | Возвращает минимальное значение указанных значений столбцов. | yii\mongodb\Query |
| modify() | Выполняет запрос 'findAndModify' и возвращает одну строку результата. | yii\mongodb\Query |
| off() | Отсоединяет существующего обработчика событий от этого компонента. | yii\base\Component |
| offset() | Устанавливает часть OFFSET запроса. | yii\db\QueryTrait |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| one() | Выполняет запрос и возвращает одну строку результата. | yii\mongodb\Query |
| options() | Устанавливает параметры курсора. | yii\mongodb\Query |
| orFilterWhere() | Добавляет дополнительное условие WHERE к существующему, но игнорирует пустые операнды. | yii\db\QueryTrait |
| orWhere() | Добавляет дополнительное условие WHERE к существующему. | yii\db\QueryTrait |
| orderBy() | Устанавливает часть ORDER BY запроса. | yii\db\QueryTrait |
| populate() | Преобразует сырые результаты запроса в формат, указанный в этом запросе. | yii\mongodb\Query |
| prepare() | Подготавливает к построению запроса. | yii\mongodb\Query |
| scalar() | Возвращает результат запроса как скалярное значение. | yii\mongodb\Query |
| select() | Устанавливает список полей результатов для возврата. | yii\mongodb\Query |
| sum() | Возвращает сумму значений указанного столбца. | yii\mongodb\Query |
| trigger() | Вызывает событие. | yii\base\Component |
| where() | Устанавливает часть WHERE запроса. | yii\db\QueryTrait |
Защищенные методы
| Метод | Описание | Определено |
|---|---|---|
| aggregate() | Выполняет агрегацию для заданного столбца. | yii\mongodb\Query |
| fetchRows() | Извлекает строки из заданного курсора Mongo. | yii\mongodb\Query |
| fetchRowsInternal() | yii\mongodb\Query | |
| filterCondition() | Удаляет пустые операнды из заданного условия запроса. | yii\db\QueryTrait |
| isEmpty() | Возвращает значение, указывающее, является ли данное значение "пустым". | yii\db\QueryTrait |
| normalizeOrderBy() | Нормализует формат данных ORDER BY | yii\db\QueryTrait |
Подробное описание свойств
$collection общедоступное только для чтения свойство
Экземпляр коллекции.
public yii\mongodb\file\Collection getCollection ( $db = null )
Подробное описание методов
getCollection() общедоступный метод
Возвращает коллекцию Mongo для этого запроса.
| public yii\mongodb\file\Collection getCollection ( $db = null ) | ||
|---|---|---|
| $db | yii\mongodb\Connection |
Подключение Mongo. |
| return | yii\mongodb\file\Collection |
Экземпляр коллекции. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-file-query.html
