Collection.php 7.17 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

8
namespace yii\mongodb\file;
9

10
use yii\mongodb\Exception;
11
use Yii;
12 13 14 15

/**
 * Collection represents the Mongo GridFS collection information.
 *
16 17 18 19
 * 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.
 *
Qiang Xue committed
20
 * @property \yii\mongodb\Collection $chunkCollection Mongo collection instance. This property is read-only.
21 22 23 24
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
25
class Collection extends \yii\mongodb\Collection
26
{
27 28 29 30 31 32 33 34 35 36 37
    /**
     * @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.
38
     * @param boolean $refresh whether to reload the collection instance even if it is found in the cache.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
     * @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.
55 56
     * @param array $condition description of records to remove.
     * @param array $options list of options in format: optionName => optionValue.
57
     * @return integer|boolean number of updated documents or whether operation was successful.
58
     * @throws Exception on failure.
59 60 61 62 63 64 65 66 67 68 69 70
     */
    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.
71 72 73 74 75
     * @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.
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
     * @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.
98 99 100 101 102
     * @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.
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
     * @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.
125 126 127 128 129
     * @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.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
     * @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.
150
     * @param mixed $id _id of the file to find.
151
     * @return \MongoGridFSFile|null found file, or null if file does not exist
152
     * @throws Exception on failure.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
     */
    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.
172 173
     * @param mixed $id _id of the file to find.
     * @return boolean whether the operation was successful.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
     * @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);
        }
    }
AlexGx committed
192
}