Класс yii\mongodb\file\Collection

Все классы | Свойства | Методы

Наследование	yii\mongodb\file\Collection » yii\mongodb\Collection » yii\base\Object
Реализует	yii\base\Configurable
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2-mongodb/blob/master/file/Collection.php

Collection представляет информацию о коллекции Mongo GridFS.

Объект коллекции файлов обычно создается путем вызова \yii\mongodb\file\Database::getFileCollection() или \yii\mongodb\file\Connection::getFileCollection().

Коллекция файлов наследует все интерфейсы от обычной \yii\mongo\Collection, добавляя методы для хранения файлов.

Публичные свойства

Свойство	Тип	Описание	Определено в
$chunkCollection	yii\mongodb\Collection	Экземпляр коллекции Mongo.	yii\mongodb\file\Collection
$database	yii\mongodb\Database	Экземпляр базы данных MongoDB.	yii\mongodb\file\Collection
$fileCollection	yii\mongodb\Collection	Экземпляр коллекции Mongo.	yii\mongodb\file\Collection
$fullName	string	Полное имя этой коллекции, включая имя базы данных.	yii\mongodb\Collection
$name	string	Имя этой коллекции.	yii\mongodb\Collection
$prefix	string	Префикс этой коллекции файлов.	yii\mongodb\file\Collection

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в null.	yii\base\Object
aggregate()	Выполняет агрегацию с помощью фреймворка Mongo Aggregation.	yii\mongodb\Collection
batchInsert()	Вставляет несколько новых строк в коллекцию.	yii\mongodb\Collection
canGetProperty()	Возвращает значение, указывающее, можно ли считать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное квалифицированное имя этого класса.	yii\base\Object
count()	Подсчитывает записи в этой коллекции.	yii\mongodb\Collection
createDownload()	Создаёт команду загрузки.	yii\mongodb\file\Collection
createIndex()	Создаёт индекс в коллекции по указанным полям.	yii\mongodb\Collection
createIndexes()	Создаёт несколько индексов одновременно.	yii\mongodb\Collection
createUpload()	Создаёт команду загрузки.	yii\mongodb\file\Collection
delete()	Удаляет файл с заданным _id.	yii\mongodb\file\Collection
distinct()	Возвращает список уникальных значений для заданного столбца во всей коллекции.	yii\mongodb\Collection
drop()	Удаляет эту коллекцию.	yii\mongodb\file\Collection
dropAllIndexes()	Удаляет все индексы для этой коллекции.	yii\mongodb\Collection
dropIndex()	Удаляет индексы по указанному(ым) столбцу(ам).	yii\mongodb\Collection
dropIndexes()	Удаляет индексы коллекции по имени.	yii\mongodb\Collection
ensureIndexes()	Убеждается, что индексы, которые важны для обработки файлов, существуют в этой коллекции и $chunkCollection.	yii\mongodb\file\Collection
find()	Возвращает курсор для результатов поиска.	yii\mongodb\file\Collection
findAndModify()	Обновляет документ и возвращает его.	yii\mongodb\Collection
findOne()	Возвращает один документ.	yii\mongodb\Collection
get()	Извлекает файл с заданным _id.	yii\mongodb\file\Collection
getChunkCollection()	Возвращает коллекцию MongoDB для фрагментов файла.	yii\mongodb\file\Collection
getFileCollection()	Возвращает коллекцию MongoDB для файлов.	yii\mongodb\file\Collection
getFullName()		yii\mongodb\Collection
getPrefix()		yii\mongodb\file\Collection
group()	Выполняет агрегацию с помощью команды Mongo "group".	yii\mongodb\Collection
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object
insert()	Вставляет новые данные в коллекцию.	yii\mongodb\Collection
insertFile()	Создаёт новый файл в коллекции GridFS из файла локальной файловой системы.	yii\mongodb\file\Collection
insertFileContent()	Создаёт новый файл в коллекции GridFS со заданным содержимым.	yii\mongodb\file\Collection
insertUploads()	Создаёт новый файл в коллекции GridFS из загруженного файла.	yii\mongodb\file\Collection
listIndexes()	Возвращает список определённых индексов.	yii\mongodb\Collection
mapReduce()	Выполняет агрегацию с помощью механизма MongoDB "map-reduce".	yii\mongodb\Collection
remove()	Удаляет данные из коллекции.	yii\mongodb\file\Collection
save()	Обновляет существующие данные в базе данных, иначе вставляет эти данные.	yii\mongodb\Collection
setPrefix()		yii\mongodb\file\Collection
update()	Обновляет строки, которые соответствуют заданным критериям, заданными данными.	yii\mongodb\Collection

Подробное описание свойств

$chunkCollection общедоступное только для чтения свойство

Экземпляр коллекции Mongo.

public yii\mongodb\Collection getChunkCollection ( $refresh = false )

$database общедоступное свойство

Экземпляр базы данных MongoDB.

public yii\mongodb\Database $database = null

$fileCollection общедоступное только для чтения свойство

Экземпляр коллекции Mongo.

public yii\mongodb\Collection getFileCollection ( $refresh = false )

$prefix общедоступное свойство

Префикс этой коллекции файлов.

public string getPrefix ( )
public void setPrefix ( $prefix )

Подробное описание методов

createDownload() общедоступный метод (доступен с версии 2.1)

Создаёт команду загрузки.

public yii\mongodb\file\Download createDownload ( $document )
$document	массив\|\MongoDB\BSON\ObjectID	Документ файла для загрузки.
return	yii\mongodb\file\Download	Экземпляр загрузки файла.

createUpload() общедоступный метод (доступен с версии 2.1)

Создаёт команду загрузки.

public yii\mongodb\file\Upload createUpload ( $options = [] )
$options	массив	Опции загрузки.
return	yii\mongodb\file\Upload	Экземпляр загрузки файла.

delete() общедоступный метод

Удаляет файл с заданным _id.

public boolean delete ( $id )
$id	mixed	_id файла для поиска.
return	boolean	Указывает, была ли операция успешной.
throws	yii\mongodb\Exception	при ошибке.

drop() общедоступный метод

Удаляет эту коллекцию.

public boolean drop ( )
return	boolean	Указывает, была ли операция успешной.
throws	yii\mongodb\Exception	при ошибке.

ensureIndexes() общедоступный метод

Убеждается, что индексы, критически важные для обработки файлов, существуют в этой коллекции и в $chunkCollection.

Результат проверки кэшируется по экземпляру коллекции.

public $this ensureIndexes ( $force = false )
$force	boolean	Указывает, следует ли игнорировать кэш внутреннего экземпляра коллекции.
return	$this	Ссылка на себя.

find() общедоступный метод

Возвращает курсор для результатов поиска.

Для выполнения запросов "find" используйте класс yii\mongodb\file\Query.

public yii\mongodb\file\Cursor find ( $condition = [], $fields = [], $options = [] )
$condition	массив	Условие запроса
$fields	массив	Поля для выбора
$options	массив	Опции запроса (доступны с версии 2.1).
return	yii\mongodb\file\Cursor	Курсор для результатов поиска

get() общедоступный метод

Возвращает файл с заданным _id.

public yii\mongodb\file\Download\|null get ( $id )
$id	mixed	_id файла для поиска.
return	yii\mongodb\file\Download\|null	Найденный файл или null, если файл не существует
throws	yii\mongodb\Exception	при ошибке.

getChunkCollection() общедоступный метод

Возвращает MongoDB коллекцию для фрагментов файлов.

public yii\mongodb\Collection getChunkCollection ( $refresh = false )
$refresh	boolean	Указывает, следует ли перезагрузить экземпляр коллекции, даже если он найден в кэше.
return	yii\mongodb\Collection	Экземпляр Mongo коллекции.

getFileCollection() общедоступный метод (доступен с версии 2.1)

Возвращает MongoDB коллекцию для файлов.

public yii\mongodb\Collection getFileCollection ( $refresh = false )
$refresh	boolean	Указывает, следует ли перезагрузить экземпляр коллекции, даже если он найден в кэше.
return	yii\mongodb\Collection	Экземпляр Mongo коллекции.

getPrefix() общедоступный метод

public строка getPrefix ( )
return	строка	Префикс этой коллекции файлов.

insertFile() общедоступный метод

Создаёт новый файл в коллекции GridFS из файла на локальном файловой системе.

Дополнительные атрибуты могут быть добавлены в документ файла с помощью $metadata.

public mixed insertFile ( $filename, $metadata = [], $options = [] )
$filename	строка	Имя файла для сохранения.
$metadata	массив	Другие метаданные для включения в документ файла.
$options	массив	Список опций в формате: имяОпции => значениеОпции
return	mixed	"_id" сохранённого документа файла. Будет сгенерирован \MongoId, если в метаданных явно не указан "_id".
throws	yii\mongodb\Exception	при ошибке.

insertFileContent() общедоступный метод

Создаёт новый файл в коллекции GridFS с указанным содержимым.

Дополнительные атрибуты могут быть добавлены в документ файла с помощью $metadata.

public mixed insertFileContent ( $bytes, $metadata = [], $options = [] )
$bytes	строка	Строка байтов для сохранения.
$metadata	массив	Другие метаданные для включения в документ файла.
$options	массив	Список опций в формате: имяОпции => значениеОпции
return	mixed	"_id" сохранённого документа файла. Будет сгенерирован \MongoId, если в метаданных явно не указан "_id".
throws	yii\mongodb\Exception	при ошибке.

insertUploads() общедоступный метод

Создаёт новый файл в коллекции GridFS из загруженного файла.

Дополнительные атрибуты могут быть добавлены в документ файла с помощью $metadata.

public mixed insertUploads ( $name, $metadata = [], $options = [] )
$name	строка	Имя загруженного файла для сохранения. Должно соответствовать атрибуту name поля файла в HTML-форме.
$metadata	массив	Другие метаданные для включения в документ файла.
$options	массив	Список опций в формате: имяОпции => значениеОпции
return	mixed	"_id" сохранённого документа файла. Будет сгенерирован \MongoId, если в метаданных явно не указан "_id".
throws	yii\mongodb\Exception	при ошибке.

remove() общедоступный метод

Удаляет данные из коллекции.

public integer\|boolean remove ( $condition = [], $options = [] )
$condition	array	Описание записей для удаления.
$options	array	Список опций в формате: имяОпции => значениеОпции.
return	integer\|boolean	Количество обновлённых документов или успешность операции.
throws	yii\mongodb\Exception	при ошибке.

setPrefix() public method

public void setPrefix ( $prefix )
$prefix	string	Префикс этой коллекции файлов.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-file-collection.html