Completed
Pull Request — master (#20)
by
unknown
02:57
created

MongoCollection::getDBRef()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %
Metric Value
dl 0
loc 4
rs 10
cc 1
eloc 2
nc 1
nop 1
1
<?php
2
/*
3
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
 */
15
16
use Alcaeus\MongoDbAdapter\Helper;
17
use Alcaeus\MongoDbAdapter\TypeConverter;
18
use Alcaeus\MongoDbAdapter\ExceptionConverter;
19
20
/**
21
 * Represents a database collection.
22
 * @link http://www.php.net/manual/en/class.mongocollection.php
23
 */
24
class MongoCollection
1 ignored issue
show
Coding Style Compatibility introduced by
PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

You can fix this by adding a namespace to your class:

namespace YourVendor;

class YourClass { }

When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.

Loading history...
25
{
26
    use Helper\ReadPreference;
27
    use Helper\SlaveOkay;
28
    use Helper\WriteConcern;
29
30
    const ASCENDING = 1;
31
    const DESCENDING = -1;
32
33
    /**
34
     * @var MongoDB
35
     */
36
    public $db = NULL;
37
38
    /**
39
     * @var string
40
     */
41
    protected $name;
42
43
    /**
44
     * @var \MongoDB\Collection
45
     */
46
    protected $collection;
47
48
    /**
49
     * Creates a new collection
50
     *
51
     * @link http://www.php.net/manual/en/mongocollection.construct.php
52
     * @param MongoDB $db Parent database.
53
     * @param string $name Name for this collection.
54
     * @throws Exception
55
     * @return MongoCollection
0 ignored issues
show
Comprehensibility Best Practice introduced by
Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

Adding a @return annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.

Please refer to the PHP core documentation on constructors.

Loading history...
56
     */
57
    public function __construct(MongoDB $db, $name)
58
    {
59
        $this->checkCollectionName($name);
60
        $this->db = $db;
61
        $this->name = $name;
62
63
        $this->setReadPreferenceFromArray($db->getReadPreference());
64
        $this->setWriteConcernFromArray($db->getWriteConcern());
65
66
        $this->createCollectionObject();
67
    }
68
69
    /**
70
     * Gets the underlying collection for this object
71
     *
72
     * @internal This part is not of the ext-mongo API and should not be used
73
     * @return \MongoDB\Collection
74
     */
75
    public function getCollection()
76
    {
77
        return $this->collection;
78
    }
79
80
    /**
81
     * String representation of this collection
82
     *
83
     * @link http://www.php.net/manual/en/mongocollection.--tostring.php
84
     * @return string Returns the full name of this collection.
85
     */
86
    public function __toString()
87
    {
88
        return (string) $this->db . '.' . $this->name;
89
    }
90
91
    /**
92
     * Gets a collection
93
     *
94
     * @link http://www.php.net/manual/en/mongocollection.get.php
95
     * @param string $name The next string in the collection name.
96
     * @return MongoCollection
97
     */
98
    public function __get($name)
99
    {
100
        // Handle w and wtimeout properties that replicate data stored in $readPreference
101
        if ($name === 'w' || $name === 'wtimeout') {
102
            return $this->getWriteConcern()[$name];
103
        }
104
105
        return $this->db->selectCollection($this->name . '.' . $name);
106
    }
107
108
    /**
109
     * @param string $name
110
     * @param mixed $value
111
     */
112 View Code Duplication
    public function __set($name, $value)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
113
    {
114
        if ($name === 'w' || $name === 'wtimeout') {
115
            $this->setWriteConcernFromArray([$name => $value] + $this->getWriteConcern());
116
            $this->createCollectionObject();
117
        }
118
    }
119
120
    /**
121
     * Perform an aggregation using the aggregation framework
122
     *
123
     * @link http://www.php.net/manual/en/mongocollection.aggregate.php
124
     * @param array $pipeline
125
     * @param array $op
126
     * @return array
127
     */
128
    public function aggregate(array $pipeline, array $op = [])
129
    {
130
        if (! TypeConverter::isNumericArray($pipeline)) {
131
            $pipeline = [];
132
            $options = [];
133
134
            $i = 0;
135
            foreach (func_get_args() as $operator) {
136
                $i++;
137
                if (! is_array($operator)) {
138
                    trigger_error("Argument $i is not an array", E_WARNING);
139
                    return;
140
                }
141
142
                $pipeline[] = $operator;
143
            }
144
        } else {
145
            $options = $op;
146
        }
147
148
        $command = [
149
            'aggregate' => $this->name,
150
            'pipeline' => $pipeline
151
        ];
152
153
        $command += $options;
154
155
        try {
156
            return $this->db->command($command);
157
        } catch (MongoCursorTimeoutException $e) {
158
            throw new MongoExecutionTimeoutException($e->getMessage(), $e->getCode(), $e->getPrevious());
159
        }
160
    }
161
162
    /**
163
     * Execute an aggregation pipeline command and retrieve results through a cursor
164
     *
165
     * @link http://php.net/manual/en/mongocollection.aggregatecursor.php
166
     * @param array $pipeline
167
     * @param array $options
168
     * @return MongoCommandCursor
169
     */
170
    public function aggregateCursor(array $pipeline, array $options = [])
171
    {
172
        // Build command manually, can't use mongo-php-library here
173
        $command = [
174
            'aggregate' => $this->name,
175
            'pipeline' => $pipeline
176
        ];
177
178
        // Convert cursor option
179
        if (! isset($options['cursor'])) {
180
            $options['cursor'] = true;
181
        }
182
183
        $command += $options;
184
185
        $cursor = new MongoCommandCursor($this->db->getConnection(), (string) $this, $command);
186
        $cursor->setReadPreference($this->getReadPreference());
0 ignored issues
show
Documentation introduced by
$this->getReadPreference() is of type array, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
187
188
        return $cursor;
189
    }
190
191
    /**
192
     * Returns this collection's name
193
     *
194
     * @link http://www.php.net/manual/en/mongocollection.getname.php
195
     * @return string
196
     */
197
    public function getName()
198
    {
199
        return $this->name;
200
    }
201
202
    /**
203
     * {@inheritdoc}
204
     */
205
    public function setReadPreference($readPreference, $tags = null)
206
    {
207
        $result = $this->setReadPreferenceFromParameters($readPreference, $tags);
208
        $this->createCollectionObject();
209
210
        return $result;
211
    }
212
213
    /**
214
     * {@inheritdoc}
215
     */
216
    public function setWriteConcern($wstring, $wtimeout = 0)
217
    {
218
        $result = $this->setWriteConcernFromParameters($wstring, $wtimeout);
219
        $this->createCollectionObject();
220
221
        return $result;
222
    }
223
224
    /**
225
     * Drops this collection
226
     *
227
     * @link http://www.php.net/manual/en/mongocollection.drop.php
228
     * @return array Returns the database response.
229
     */
230
    public function drop()
231
    {
232
        return TypeConverter::toLegacy($this->collection->drop());
233
    }
234
235
    /**
236
     * Validates this collection
237
     *
238
     * @link http://www.php.net/manual/en/mongocollection.validate.php
239
     * @param bool $scan_data Only validate indices, not the base collection.
240
     * @return array Returns the database's evaluation of this object.
241
     */
242
    public function validate($scan_data = FALSE)
243
    {
244
        $command = [
245
            'validate' => $this->name,
246
            'full'     => $scan_data,
247
        ];
248
249
        return $this->db->command($command);
250
    }
251
252
    /**
253
     * Inserts an array into the collection
254
     *
255
     * @link http://www.php.net/manual/en/mongocollection.insert.php
256
     * @param array|object $a
257
     * @param array $options
258
     * @throws MongoException if the inserted document is empty or if it contains zero-length keys. Attempting to insert an object with protected and private properties will cause a zero-length key error.
259
     * @throws MongoCursorException if the "w" option is set and the write fails.
260
     * @throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds.
261
     * @return bool|array Returns an array containing the status of the insertion if the "w" option is set.
262
     */
263
    public function insert($a, array $options = [])
264
    {
265
        if (! count((array)$a)) {
266
            throw new \MongoException('document must be an array or object');
267
        }
268
269
        try {
270
            $result = $this->collection->insertOne(
271
                TypeConverter::fromLegacy($a),
272
                $this->convertWriteConcernOptions($options)
273
            );
274
        } catch (\MongoDB\Driver\Exception\Exception $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
275
            ExceptionConverter::toLegacy($e);
276
        }
277
278
279
        if (! $result->isAcknowledged()) {
280
            return true;
281
        }
282
283
        return [
284
            'ok' => 1.0,
285
            'n' => 0,
286
            'err' => null,
287
            'errmsg' => null,
288
        ];
289
    }
290
291
    /**
292
     * Inserts multiple documents into this collection
293
     *
294
     * @link http://www.php.net/manual/en/mongocollection.batchinsert.php
295
     * @param array $a An array of arrays.
296
     * @param array $options Options for the inserts.
297
     * @throws MongoCursorException
298
     * @return mixed If "safe" is set, returns an associative array with the status of the inserts ("ok") and any error that may have occured ("err"). Otherwise, returns TRUE if the batch insert was successfully sent, FALSE otherwise.
299
     */
300
    public function batchInsert(array $a, array $options = [])
301
    {
302
        try {
303
            $result = $this->collection->insertMany(
304
                TypeConverter::fromLegacy($a),
305
                $this->convertWriteConcernOptions($options)
306
            );
307
        } catch (\MongoDB\Driver\Exception\Exception $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
308
            ExceptionConverter::toLegacy($e);
309
        }
310
311
        if (! $result->isAcknowledged()) {
312
            return true;
313
        }
314
315
        return [
316
            'connectionId' => 0,
317
            'n' => 0,
318
            'syncMillis' => 0,
319
            'writtenTo' => null,
320
            'err' => null,
321
            'errmsg' => null,
322
        ];
323
    }
324
325
    /**
326
     * Update records based on a given criteria
327
     *
328
     * @link http://www.php.net/manual/en/mongocollection.update.php
329
     * @param array $criteria Description of the objects to update.
330
     * @param array $newobj The object with which to update the matching records.
331
     * @param array $options
332
     * @throws MongoCursorException
333
     * @return boolean
334
     */
335
    public function update(array $criteria , array $newobj, array $options = [])
336
    {
337
        $multiple = isset($options['multiple']) ? $options['multiple'] : false;
338
        $method = $multiple ? 'updateMany' : 'updateOne';
339
        unset($options['multiple']);
340
341
        try {
342
            /** @var \MongoDB\UpdateResult $result */
343
            $result = $this->collection->$method(
344
                TypeConverter::fromLegacy($criteria),
345
                TypeConverter::fromLegacy($newobj),
346
                $this->convertWriteConcernOptions($options)
347
            );
348
        } catch (\MongoDB\Driver\Exception\Exception $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
349
            ExceptionConverter::toLegacy($e);
350
        }
351
352
        if (! $result->isAcknowledged()) {
353
            return true;
354
        }
355
356
        return [
357
            'ok' => 1.0,
358
            'nModified' => $result->getModifiedCount(),
359
            'n' => $result->getMatchedCount(),
360
            'err' => null,
361
            'errmsg' => null,
362
            'updatedExisting' => $result->getUpsertedCount() == 0,
363
        ];
364
    }
365
366
    /**
367
     * Remove records from this collection
368
     *
369
     * @link http://www.php.net/manual/en/mongocollection.remove.php
370
     * @param array $criteria Query criteria for the documents to delete.
371
     * @param array $options An array of options for the remove operation.
372
     * @throws MongoCursorException
373
     * @throws MongoCursorTimeoutException
374
     * @return bool|array Returns an array containing the status of the removal
375
     * if the "w" option is set. Otherwise, returns TRUE.
376
     */
377
    public function remove(array $criteria = [], array $options = [])
378
    {
379
        $multiple = isset($options['justOne']) ? !$options['justOne'] : true;
380
        $method = $multiple ? 'deleteMany' : 'deleteOne';
381
382
        try {
383
            /** @var \MongoDB\DeleteResult $result */
384
            $result = $this->collection->$method(
385
                TypeConverter::fromLegacy($criteria),
386
                $this->convertWriteConcernOptions($options)
387
            );
388
        } catch (\MongoDB\Driver\Exception\Exception $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
389
            ExceptionConverter::toLegacy($e);
390
        }
391
392
        if (! $result->isAcknowledged()) {
393
            return true;
394
        }
395
396
        return [
397
            'ok' => 1.0,
398
            'n' => $result->getDeletedCount(),
399
            'err' => null,
400
            'errmsg' => null
401
        ];
402
    }
403
404
    /**
405
     * Querys this collection
406
     *
407
     * @link http://www.php.net/manual/en/mongocollection.find.php
408
     * @param array $query The fields for which to search.
409
     * @param array $fields Fields of the results to return.
410
     * @return MongoCursor
411
     */
412
    public function find(array $query = [], array $fields = [])
413
    {
414
        $cursor = new MongoCursor($this->db->getConnection(), (string) $this, $query, $fields);
415
        $cursor->setReadPreference($this->getReadPreference());
0 ignored issues
show
Documentation introduced by
$this->getReadPreference() is of type array, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
416
417
        return $cursor;
418
    }
419
420
    /**
421
     * Retrieve a list of distinct values for the given key across a collection
422
     *
423
     * @link http://www.php.net/manual/ru/mongocollection.distinct.php
424
     * @param string $key The key to use.
425
     * @param array $query An optional query parameters
426
     * @return array|bool Returns an array of distinct values, or FALSE on failure
427
     */
428
    public function distinct($key, array $query = [])
429
    {
430
        try {
431
            return array_map([TypeConverter::class, 'toLegacy'], $this->collection->distinct($key, $query));
432
        } catch (\MongoDB\Driver\Exception\Exception $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
433
            return false;
434
        }
435
    }
436
437
    /**
438
     * Update a document and return it
439
     *
440
     * @link http://www.php.net/manual/ru/mongocollection.findandmodify.php
441
     * @param array $query The query criteria to search for.
442
     * @param array $update The update criteria.
443
     * @param array $fields Optionally only return these fields.
444
     * @param array $options An array of options to apply, such as remove the match document from the DB and return it.
445
     * @return array Returns the original document, or the modified document when new is set.
446
     */
447
    public function findAndModify(array $query, array $update = null, array $fields = null, array $options = [])
448
    {
449
        $query = TypeConverter::fromLegacy($query);
450
        try {
451
            if (isset($options['remove'])) {
452
                unset($options['remove']);
453
                $document = $this->collection->findOneAndDelete($query, $options);
454
            } else {
455
                $update = is_array($update) ? TypeConverter::fromLegacy($update) : [];
456
457
                if (isset($options['new'])) {
458
                    $options['returnDocument'] = \MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER;
459
                    unset($options['new']);
460
                }
461
462
                $options['projection'] = is_array($fields) ? TypeConverter::fromLegacy($fields) : [];
463
464
                $document = $this->collection->findOneAndUpdate($query, $update, $options);
465
            }
466
        } catch (\MongoDB\Driver\Exception\ConnectionException $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\ConnectionException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
467
            throw new MongoResultException($e->getMessage(), $e->getCode(), $e);
468
        } catch (\MongoDB\Driver\Exception\ExecutionTimeoutException $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\ExecutionTimeoutException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
469
            ExceptionConverter::toLegacy($e);
470
        }
471
472
        if ($document) {
473
            $document = TypeConverter::toLegacy($document);
0 ignored issues
show
Bug introduced by
The variable $document does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
474
        }
475
476
        return $document;
477
    }
478
479
    /**
480
     * Querys this collection, returning a single element
481
     *
482
     * @link http://www.php.net/manual/en/mongocollection.findone.php
483
     * @param array $query The fields for which to search.
484
     * @param array $fields Fields of the results to return.
485
     * @param array $options
486
     * @return array|null
487
     */
488
    public function findOne(array $query = [], array $fields = [], array $options = [])
489
    {
490
        $options = ['projection' => $fields] + $options;
491
        try {
492
            $document = $this->collection->findOne(TypeConverter::fromLegacy($query), $options);
493
        } catch (\MongoDB\Driver\Exception\ExecutionTimeoutException $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\ExecutionTimeoutException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
494
            throw new MongoExecutionTimeoutException($e->getMessage(), $e->getCode(), $e);
495
        } catch (\MongoDB\Driver\Exception\Exception $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
496
            ExceptionConverter::toLegacy($e);
497
        }
498
499
        if ($document !== null) {
500
            $document = TypeConverter::toLegacy($document);
501
        }
502
503
        return $document;
504
    }
505
506
    /**
507
     * Creates an index on the given field(s), or does nothing if the index already exists
508
     *
509
     * @link http://www.php.net/manual/en/mongocollection.createindex.php
510
     * @param array $keys Field or fields to use as index.
511
     * @param array $options [optional] This parameter is an associative array of the form array("optionname" => <boolean>, ...).
512
     * @return array Returns the database response.
513
     *
514
     * @todo This method does not yet return the correct result
515
     */
516
    public function createIndex(array $keys, array $options = [])
517
    {
518
        if (! is_array($keys) || ! count($keys)) {
519
            throw new MongoException('keys cannot be empty');
520
        }
521
522
        // duplicate
523
        $indexes = $this->collection->listIndexes();
524
        foreach ($indexes as $index) {
525
            if ($index->getKey() === $keys) {
526
                throw new \MongoDuplicateKeyException();
527
            }
528
        }
529
530
        try {
531
            $this->collection->createIndex($keys, $this->convertWriteConcernOptions($options));
532
        } catch (\MongoDB\Driver\Exception\Exception $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
533
            ExceptionConverter::toLegacy($e);
534
        }
535
536
        return [
537
            'createdCollectionAutomatically' => true,
538
            'numIndexesBefore' => count($indexes),
539
            'numIndexesAfter' => count($indexes) + 1,
540
            'ok' => 1.0
541
        ];
542
    }
543
544
    /**
545
     * Creates an index on the given field(s), or does nothing if the index already exists
546
     *
547
     * @link http://www.php.net/manual/en/mongocollection.ensureindex.php
548
     * @param array $keys Field or fields to use as index.
549
     * @param array $options [optional] This parameter is an associative array of the form array("optionname" => <boolean>, ...).
550
     * @return boolean always true
551
     * @deprecated Use MongoCollection::createIndex() instead.
552
     */
553
    public function ensureIndex(array $keys, array $options = [])
554
    {
555
        $this->createIndex($keys, $options);
556
557
        return true;
558
    }
559
560
    /**
561
     * Deletes an index from this collection
562
     *
563
     * @link http://www.php.net/manual/en/mongocollection.deleteindex.php
564
     * @param string|array $keys Field or fields from which to delete the index.
565
     * @return array Returns the database response.
566
     */
567
    public function deleteIndex($keys)
568
    {
569
        if (is_string($keys)) {
570
            $indexName = $keys;
571
        } elseif (is_array($keys)) {
572
            $indexName = \MongoDB\generate_index_name($keys);
573
        } else {
574
            throw new \InvalidArgumentException();
575
        }
576
577
        return TypeConverter::toLegacy($this->collection->dropIndex($indexName));
578
    }
579
580
    /**
581
     * Delete all indexes for this collection
582
     *
583
     * @link http://www.php.net/manual/en/mongocollection.deleteindexes.php
584
     * @return array Returns the database response.
585
     */
586
    public function deleteIndexes()
587
    {
588
        return TypeConverter::toLegacy($this->collection->dropIndexes());
589
    }
590
591
    /**
592
     * Returns an array of index names for this collection
593
     *
594
     * @link http://www.php.net/manual/en/mongocollection.getindexinfo.php
595
     * @return array Returns a list of index names.
596
     */
597
    public function getIndexInfo()
598
    {
599
        $convertIndex = function(\MongoDB\Model\IndexInfo $indexInfo) {
600
            return [
601
                'v' => $indexInfo->getVersion(),
602
                'key' => $indexInfo->getKey(),
603
                'name' => $indexInfo->getName(),
604
                'ns' => $indexInfo->getNamespace(),
605
            ];
606
        };
607
608
        return array_map($convertIndex, iterator_to_array($this->collection->listIndexes()));
609
    }
610
611
    /**
612
     * Counts the number of documents in this collection
613
     *
614
     * @link http://www.php.net/manual/en/mongocollection.count.php
615
     * @param array|stdClass $query
616
     * @param array $options
617
     * @return int Returns the number of documents matching the query.
618
     */
619
    public function count($query = [], array $options = [])
620
    {
621
        try {
622
            return $this->collection->count(TypeConverter::fromLegacy($query), $options);
623
        } catch (\MongoDB\Driver\Exception\ExecutionTimeoutException $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\ExecutionTimeoutException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
624
            throw new MongoExecutionTimeoutException($e->getMessage(), $e->getCode(), $e);
625
        } catch (\MongoDB\Driver\Exception\Exception $e) {
1 ignored issue
show
Bug introduced by
The class MongoDB\Driver\Exception\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
626
            ExceptionConverter::toLegacy($e);
627
        }
628
    }
629
630
    /**
631
     * Saves an object to this collection
632
     *
633
     * @link http://www.php.net/manual/en/mongocollection.save.php
634
     * @param array|object $a Array to save. If an object is used, it may not have protected or private properties.
635
     * @param array $options Options for the save.
636
     * @throws MongoException if the inserted document is empty or if it contains zero-length keys. Attempting to insert an object with protected and private properties will cause a zero-length key error.
637
     * @throws MongoCursorException if the "w" option is set and the write fails.
638
     * @throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds.
639
     * @return array|boolean If w was set, returns an array containing the status of the save.
640
     * Otherwise, returns a boolean representing if the array was not empty (an empty array will not be inserted).
641
     */
642
    public function save($a, array $options = [])
643
    {
644
        if (is_object($a)) {
645
            $a = (array) $a;
646
        }
647
648
        if ( ! array_key_exists('_id', $a)) {
649
            $id = new \MongoId();
650
        } else {
651
            $id = $a['_id'];
652
            unset($a['_id']);
653
        }
654
        $options['upsert'] = true;
655
656
        if (! count($a)) {
657
            throw new MongoException('document can not be empty');
658
        }
659
660
        return $this->update(['_id' => $id], ['$set' => $a], $options);
661
    }
662
663
    /**
664
     * Creates a database reference
665
     *
666
     * @link http://www.php.net/manual/en/mongocollection.createdbref.php
667
     * @param array|object $document_or_id Object to which to create a reference.
668
     * @return array Returns a database reference array.
669
     */
670 View Code Duplication
    public function createDBRef($document_or_id)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
671
    {
672
        if ($document_or_id instanceof \MongoId) {
673
            $id = $document_or_id;
674
        } elseif (is_object($document_or_id)) {
675
            if (! isset($document_or_id->_id)) {
676
                return null;
677
            }
678
679
            $id = $document_or_id->_id;
680
        } elseif (is_array($document_or_id)) {
681
            if (! isset($document_or_id['_id'])) {
682
                return null;
683
            }
684
685
            $id = $document_or_id['_id'];
686
        } else {
687
            $id = $document_or_id;
688
        }
689
690
        return MongoDBRef::create($this->name, $id);
691
    }
692
693
    /**
694
     * Fetches the document pointed to by a database reference
695
     *
696
     * @link http://www.php.net/manual/en/mongocollection.getdbref.php
697
     * @param array $ref A database reference.
698
     * @return array Returns the database document pointed to by the reference.
699
     */
700
    public function getDBRef(array $ref)
701
    {
702
        return $this->db->getDBRef($ref);
703
    }
704
705
    /**
706
     * Performs an operation similar to SQL's GROUP BY command
707
     *
708
     * @link http://www.php.net/manual/en/mongocollection.group.php
709
     * @param mixed $keys Fields to group by. If an array or non-code object is passed, it will be the key used to group results.
710
     * @param array $initial Initial value of the aggregation counter object.
711
     * @param MongoCode|string $reduce A function that aggregates (reduces) the objects iterated.
712
     * @param array $condition An condition that must be true for a row to be considered.
713
     * @return array
714
     */
715
    public function group($keys, array $initial, $reduce, array $condition = [])
716
    {
717
        if (is_string($reduce)) {
718
            $reduce = new MongoCode($reduce);
719
        }
720
721
        $command = [
722
            'group' => [
723
                'ns' => $this->name,
724
                '$reduce' => (string)$reduce,
725
                'initial' => $initial,
726
                'cond' => $condition,
727
            ],
728
        ];
729
730
        if ($keys instanceof MongoCode) {
731
            $command['group']['$keyf'] = (string)$keys;
732
        } else {
733
            $command['group']['key'] = $keys;
734
        }
735
        if (array_key_exists('condition', $condition)) {
736
            $command['group']['cond'] = $condition['condition'];
737
        }
738
        if (array_key_exists('finalize', $condition)) {
739
            if ($condition['finalize'] instanceof MongoCode) {
740
                $condition['finalize'] = (string)$condition['finalize'];
741
            }
742
            $command['group']['finalize'] = $condition['finalize'];
743
        }
744
745
        return $this->db->command($command);
746
    }
747
748
    /**
749
     * Returns an array of cursors to iterator over a full collection in parallel
750
     *
751
     * @link http://www.php.net/manual/en/mongocollection.parallelcollectionscan.php
752
     * @param int $num_cursors The number of cursors to request from the server. Please note, that the server can return less cursors than you requested.
753
     * @return MongoCommandCursor[]
754
     */
755
    public function parallelCollectionScan($num_cursors)
0 ignored issues
show
Unused Code introduced by
The parameter $num_cursors is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
756
    {
757
        $this->notImplemented();
758
    }
759
760
    protected function notImplemented()
761
    {
762
        throw new \Exception('Not implemented');
763
    }
764
765
    /**
766
     * @return \MongoDB\Collection
767
     */
768 View Code Duplication
    private function createCollectionObject()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
769
    {
770
        $options = [
771
            'readPreference' => $this->readPreference,
772
            'writeConcern' => $this->writeConcern,
773
        ];
774
775
        if ($this->collection === null) {
776
            $this->collection = $this->db->getDb()->selectCollection($this->name, $options);
777
        } else {
778
            $this->collection = $this->collection->withOptions($options);
779
        }
780
    }
781
782
    /**
783
     * Converts legacy write concern options to a WriteConcern object
784
     *
785
     * @param array $options
786
     * @return array
787
     */
788
    private function convertWriteConcernOptions(array $options)
789
    {
790
        if (isset($options['safe'])) {
791
            $options['w'] = ($options['safe']) ? 1 : 0;
792
        }
793
794
        if (isset($options['wtimeout']) && !isset($options['wTimeoutMS'])) {
795
            $options['wTimeoutMS'] = $options['wtimeout'];
796
        }
797
798
        if (isset($options['w']) || !isset($options['wTimeoutMS'])) {
799
            $collectionWriteConcern = $this->getWriteConcern();
800
            $writeConcern = $this->createWriteConcernFromParameters(
801
                isset($options['w']) ? $options['w'] : $collectionWriteConcern['w'],
802
                isset($options['wTimeoutMS']) ? $options['wTimeoutMS'] : $collectionWriteConcern['wtimeout']
803
            );
804
805
            $options['writeConcern'] = $writeConcern;
806
        }
807
808
        unset($options['safe']);
809
        unset($options['w']);
810
        unset($options['wTimeout']);
811
        unset($options['wTimeoutMS']);
812
813
        return $options;
814
    }
815
816
    private function checkCollectionName($name)
817
    {
818
        if (empty($name)) {
819
            throw new Exception('Collection name cannot be empty');
820
        } elseif (strpos($name, chr(0)) !== false) {
821
            throw new Exception('Collection name cannot contain null bytes');
822
        }
823
    }
824
}
825
826