You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
120 lines
3.9 KiB
120 lines
3.9 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\mongo\file; |
|
|
|
use yii\mongo\Exception; |
|
use Yii; |
|
|
|
/** |
|
* Collection represents the Mongo GridFS collection information. |
|
* |
|
* @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\mongo\Collection |
|
{ |
|
/** |
|
* @var \MongoGridFS Mongo GridFS collection instance. |
|
*/ |
|
public $mongoCollection; |
|
/** |
|
* @var \yii\mongo\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\mongo\Collection mongo collection instance. |
|
*/ |
|
public function getChunkCollection($refresh = false) |
|
{ |
|
if ($refresh || !is_object($this->_chunkCollection)) { |
|
$this->_chunkCollection = Yii::createObject([ |
|
'class' => 'yii\mongo\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; |
|
} |
|
|
|
/** |
|
* @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. |
|
*/ |
|
public function insertFile($filename, $metadata = [], $options = []) |
|
{ |
|
$options = array_merge(['w' => 1], $options); |
|
return $this->mongoCollection->storeFile($filename, $metadata, $options); |
|
} |
|
|
|
/** |
|
* @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. |
|
*/ |
|
public function insertFileContent($bytes, $metadata = [], $options = []) |
|
{ |
|
$options = array_merge(['w' => 1], $options); |
|
return $this->mongoCollection->storeBytes($bytes, $metadata, $options); |
|
} |
|
|
|
/** |
|
* @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. |
|
*/ |
|
public function insertUploads($name, $metadata = []) |
|
{ |
|
return $this->mongoCollection->storeUpload($name, $metadata); |
|
} |
|
|
|
/** |
|
* @param mixed $id _id of the file to find. |
|
* @return \MongoGridFSFile|null found file, or null if file does not exist |
|
*/ |
|
public function get($id) |
|
{ |
|
return $this->mongoCollection->get($id); |
|
} |
|
|
|
/** |
|
* @param mixed $id _id of the file to find. |
|
* @return boolean whether the operation was successful. |
|
*/ |
|
public function delete($id) |
|
{ |
|
$result = $this->mongoCollection->delete($id); |
|
$this->tryResultError($result); |
|
return true; |
|
} |
|
} |