yii2-bootstrap/extensions/yii/mongodb/file/Collection.php

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\mongodb\file;

use yii\mongodb\Exception;
use Yii;

/**
 * Collection represents the Mongo GridFS collection information.
 *
 * A file collection object is usually created by calling [[Database::getFileCollection()]] or [[Connection::getFileCollection()]].
 *
 * File collection inherits all interface from regular [[\yii\mongo\Collection]], adding methods to store files.
 *
 * @property \yii\mongo\Collection $chunkCollection file chunks Mongo collection. This property is read-only.
 * @method \MongoGridFSCursor find() returns a cursor for the search results.
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class Collection extends \yii\mongodb\Collection
{
	/**
	 * @var \MongoGridFS Mongo GridFS collection instance.
	 */
	public $mongoCollection;
	/**
	 * @var \yii\mongodb\Collection file chunks Mongo collection.
	 */
	private $_chunkCollection;

	/**
	 * Returns the Mongo collection for the file chunks.
	 * @param boolean $refresh whether to reload the collection instance even if it is found in the cache.
	 * @return \yii\mongodb\Collection mongo collection instance.
	 */
	public function getChunkCollection($refresh = false)
	{
		if ($refresh || !is_object($this->_chunkCollection)) {
			$this->_chunkCollection = Yii::createObject([
				'class' => 'yii\mongodb\Collection',
				'mongoCollection' => $this->mongoCollection->chunks
			]);
		}
		return $this->_chunkCollection;
	}

	/**
	 * Removes data from the collection.
	 * @param array $condition description of records to remove.
	 * @param array $options list of options in format: optionName => optionValue.
	 * @return integer|boolean number of updated documents or whether operation was successful.
	 * @throws Exception on failure.
	 */
	public function remove($condition = [], $options = [])
	{
		$result = parent::remove($condition, $options);
		$this->tryLastError(); // MongoGridFS::remove will return even if the remove failed
		return $result;
	}

	/**
	 * Creates new file in GridFS collection from given local filesystem file.
	 * Additional attributes can be added file document using $metadata.
	 * @param string $filename name of the file to store.
	 * @param array $metadata other metadata fields to include in the file document.
	 * @param array $options list of options in format: optionName => optionValue
	 * @return mixed the "_id" of the saved file document. This will be a generated [[\MongoId]]
	 * unless an "_id" was explicitly specified in the metadata.
	 * @throws Exception on failure.
	 */
	public function insertFile($filename, $metadata = [], $options = [])
	{
		$token = 'Inserting file into ' . $this->getFullName();
		Yii::info($token, __METHOD__);
		try {
			Yii::beginProfile($token, __METHOD__);
			$options = array_merge(['w' => 1], $options);
			$result = $this->mongoCollection->storeFile($filename, $metadata, $options);
			Yii::endProfile($token, __METHOD__);
			return $result;
		} catch (\Exception $e) {
			Yii::endProfile($token, __METHOD__);
			throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
		}
	}

	/**
	 * Creates new file in GridFS collection with specified content.
	 * Additional attributes can be added file document using $metadata.
	 * @param string $bytes string of bytes to store.
	 * @param array $metadata other metadata fields to include in the file document.
	 * @param array $options list of options in format: optionName => optionValue
	 * @return mixed the "_id" of the saved file document. This will be a generated [[\MongoId]]
	 * unless an "_id" was explicitly specified in the metadata.
	 * @throws Exception on failure.
	 */
	public function insertFileContent($bytes, $metadata = [], $options = [])
	{
		$token = 'Inserting file content into ' . $this->getFullName();
		Yii::info($token, __METHOD__);
		try {
			Yii::beginProfile($token, __METHOD__);
			$options = array_merge(['w' => 1], $options);
			$result = $this->mongoCollection->storeBytes($bytes, $metadata, $options);
			Yii::endProfile($token, __METHOD__);
			return $result;
		} catch (\Exception $e) {
			Yii::endProfile($token, __METHOD__);
			throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
		}
	}

	/**
	 * Creates new file in GridFS collection from uploaded file.
	 * Additional attributes can be added file document using $metadata.
	 * @param string $name name of the uploaded file to store. This should correspond to
	 * the file field's name attribute in the HTML form.
	 * @param array $metadata other metadata fields to include in the file document.
	 * @return mixed the "_id" of the saved file document. This will be a generated [[\MongoId]]
	 * unless an "_id" was explicitly specified in the metadata.
	 * @throws Exception on failure.
	 */
	public function insertUploads($name, $metadata = [])
	{
		$token = 'Inserting file uploads into ' . $this->getFullName();
		Yii::info($token, __METHOD__);
		try {
			Yii::beginProfile($token, __METHOD__);
			$result = $this->mongoCollection->storeUpload($name, $metadata);
			Yii::endProfile($token, __METHOD__);
			return $result;
		} catch (\Exception $e) {
			Yii::endProfile($token, __METHOD__);
			throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
		}
	}

	/**
	 * Retrieves the file with given _id.
	 * @param mixed $id _id of the file to find.
	 * @return \MongoGridFSFile|null found file, or null if file does not exist
	 * @throws Exception on failure.
	 */
	public function get($id)
	{
		$token = 'Inserting file uploads into ' . $this->getFullName();
		Yii::info($token, __METHOD__);
		try {
			Yii::beginProfile($token, __METHOD__);
			$result = $this->mongoCollection->get($id);
			Yii::endProfile($token, __METHOD__);
			return $result;
		} catch (\Exception $e) {
			Yii::endProfile($token, __METHOD__);
			throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
		}
	}

	/**
	 * Deletes the file with given _id.
	 * @param mixed $id _id of the file to find.
	 * @return boolean whether the operation was successful.
	 * @throws Exception on failure.
	 */
	public function delete($id)
	{
		$token = 'Inserting file uploads into ' . $this->getFullName();
		Yii::info($token, __METHOD__);
		try {
			Yii::beginProfile($token, __METHOD__);
			$result = $this->mongoCollection->delete($id);
			$this->tryResultError($result);
			Yii::endProfile($token, __METHOD__);
			return true;
		} catch (\Exception $e) {
			Yii::endProfile($token, __METHOD__);
			throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
		}
	}
}