Completed
Pull Request — master (#1577)
by Andreas
11:05
created

DocumentPersister::getQueryForDocument()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 10
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 6
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 10
ccs 6
cts 6
cp 1
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 6
nc 1
nop 1
crap 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
 * This software consists of voluntary contributions made by many individuals
16
 * and is licensed under the MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
18
 */
19
20
namespace Doctrine\ODM\MongoDB\Persisters;
21
22
use Doctrine\Common\EventManager;
23
use Doctrine\Common\Persistence\Mapping\MappingException;
24
use Doctrine\MongoDB\CursorInterface;
25
use Doctrine\MongoDB\EagerCursor;
26
use Doctrine\ODM\MongoDB\Cursor;
27
use Doctrine\ODM\MongoDB\DocumentManager;
28
use Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo;
29
use Doctrine\ODM\MongoDB\Query\ReferencePrimer;
30
use Doctrine\ODM\MongoDB\Utility\CollectionHelper;
31
use Doctrine\ODM\MongoDB\Hydrator\HydratorFactory;
32
use Doctrine\ODM\MongoDB\LockException;
33
use Doctrine\ODM\MongoDB\LockMode;
34
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
35
use Doctrine\ODM\MongoDB\MongoDBException;
36
use Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionInterface;
37
use Doctrine\ODM\MongoDB\Proxy\Proxy;
38
use Doctrine\ODM\MongoDB\Query\CriteriaMerger;
39
use Doctrine\ODM\MongoDB\Query\Query;
40
use Doctrine\ODM\MongoDB\Types\Type;
41
use Doctrine\ODM\MongoDB\UnitOfWork;
42
43
/**
44
 * The DocumentPersister is responsible for persisting documents.
45
 *
46
 * @since       1.0
47
 */
48
class DocumentPersister
49
{
50
    /**
51
     * The PersistenceBuilder instance.
52
     *
53
     * @var PersistenceBuilder
54
     */
55
    private $pb;
56
57
    /**
58
     * The DocumentManager instance.
59
     *
60
     * @var DocumentManager
61
     */
62
    private $dm;
63
64
    /**
65
     * The EventManager instance
66
     *
67
     * @var EventManager
68
     */
69
    private $evm;
70
71
    /**
72
     * The UnitOfWork instance.
73
     *
74
     * @var UnitOfWork
75
     */
76
    private $uow;
77
78
    /**
79
     * The ClassMetadata instance for the document type being persisted.
80
     *
81
     * @var ClassMetadata
82
     */
83
    private $class;
84
85
    /**
86
     * The MongoCollection instance for this document.
87
     *
88
     * @var \MongoCollection
89
     */
90
    private $collection;
91
92
    /**
93
     * Array of queued inserts for the persister to insert.
94
     *
95
     * @var array
96
     */
97
    private $queuedInserts = array();
98
99
    /**
100
     * Array of queued inserts for the persister to insert.
101
     *
102
     * @var array
103
     */
104
    private $queuedUpserts = array();
105
106
    /**
107
     * The CriteriaMerger instance.
108
     *
109
     * @var CriteriaMerger
110
     */
111
    private $cm;
112
113
    /**
114
     * The CollectionPersister instance.
115
     *
116
     * @var CollectionPersister
117
     */
118
    private $cp;
119
120
    /**
121
     * Initializes this instance.
122
     *
123
     * @param PersistenceBuilder $pb
124
     * @param DocumentManager $dm
125
     * @param EventManager $evm
126
     * @param UnitOfWork $uow
127
     * @param HydratorFactory $hydratorFactory
128
     * @param ClassMetadata $class
129
     * @param CriteriaMerger $cm
130
     */
131 764
    public function __construct(
132
        PersistenceBuilder $pb,
133
        DocumentManager $dm,
134
        EventManager $evm,
135
        UnitOfWork $uow,
136
        HydratorFactory $hydratorFactory,
137
        ClassMetadata $class,
138
        CriteriaMerger $cm = null
139
    ) {
140 764
        $this->pb = $pb;
141 764
        $this->dm = $dm;
142 764
        $this->evm = $evm;
143 764
        $this->cm = $cm ?: new CriteriaMerger();
144 764
        $this->uow = $uow;
145 764
        $this->hydratorFactory = $hydratorFactory;
0 ignored issues
show
Bug introduced by
The property hydratorFactory does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
146 764
        $this->class = $class;
147 764
        $this->collection = $dm->getDocumentCollection($class->name);
0 ignored issues
show
Documentation Bug introduced by
It seems like $dm->getDocumentCollection($class->name) of type object<Doctrine\MongoDB\Collection> is incompatible with the declared type object<MongoCollection> of property $collection.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
148 764
        $this->cp = $this->uow->getCollectionPersister();
149 764
    }
150
151
    /**
152
     * @return array
153
     */
154
    public function getInserts()
155
    {
156
        return $this->queuedInserts;
157
    }
158
159
    /**
160
     * @param object $document
161
     * @return bool
162
     */
163
    public function isQueuedForInsert($document)
164
    {
165
        return isset($this->queuedInserts[spl_object_hash($document)]);
166
    }
167
168
    /**
169
     * Adds a document to the queued insertions.
170
     * The document remains queued until {@link executeInserts} is invoked.
171
     *
172
     * @param object $document The document to queue for insertion.
173
     */
174 536
    public function addInsert($document)
175
    {
176 536
        $this->queuedInserts[spl_object_hash($document)] = $document;
177 536
    }
178
179
    /**
180
     * @return array
181
     */
182
    public function getUpserts()
183
    {
184
        return $this->queuedUpserts;
185
    }
186
187
    /**
188
     * @param object $document
189
     * @return boolean
190
     */
191
    public function isQueuedForUpsert($document)
192
    {
193
        return isset($this->queuedUpserts[spl_object_hash($document)]);
194
    }
195
196
    /**
197
     * Adds a document to the queued upserts.
198
     * The document remains queued until {@link executeUpserts} is invoked.
199
     *
200
     * @param object $document The document to queue for insertion.
201
     */
202 87
    public function addUpsert($document)
203
    {
204 87
        $this->queuedUpserts[spl_object_hash($document)] = $document;
205 87
    }
206
207
    /**
208
     * Gets the ClassMetadata instance of the document class this persister is used for.
209
     *
210
     * @return ClassMetadata
211
     */
212
    public function getClassMetadata()
213
    {
214
        return $this->class;
215
    }
216
217
    /**
218
     * Executes all queued document insertions.
219
     *
220
     * Queued documents without an ID will inserted in a batch and queued
221
     * documents with an ID will be upserted individually.
222
     *
223
     * If no inserts are queued, invoking this method is a NOOP.
224
     *
225
     * @param array $options Options for batchInsert() and update() driver methods
226
     */
227 536
    public function executeInserts(array $options = array())
228
    {
229 536
        if ( ! $this->queuedInserts) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->queuedInserts of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
230
            return;
231
        }
232
233 536
        $inserts = array();
234 536
        $options = $this->getWriteOptions($options);
235 536
        foreach ($this->queuedInserts as $oid => $document) {
236 536
            $data = $this->pb->prepareInsertData($document);
237
238
            // Set the initial version for each insert
239 535 View Code Duplication
            if ($this->class->isVersioned) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
240 39
                $versionMapping = $this->class->fieldMappings[$this->class->versionField];
241 39
                if ($versionMapping['type'] === 'int') {
242 37
                    $nextVersion = max(1, (int) $this->class->reflFields[$this->class->versionField]->getValue($document));
243 37
                    $this->class->reflFields[$this->class->versionField]->setValue($document, $nextVersion);
244 2
                } elseif ($versionMapping['type'] === 'date') {
245 2
                    $nextVersionDateTime = new \DateTime();
246 2
                    $nextVersion = new \MongoDate($nextVersionDateTime->getTimestamp());
247 2
                    $this->class->reflFields[$this->class->versionField]->setValue($document, $nextVersionDateTime);
248
                }
249 39
                $data[$versionMapping['name']] = $nextVersion;
0 ignored issues
show
Bug introduced by
The variable $nextVersion 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...
250
            }
251
252 535
            $inserts[$oid] = $data;
253
        }
254
255 535
        if ($inserts) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $inserts of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
256
            try {
257 535
                $this->collection->batchInsert($inserts, $options);
258 7
            } catch (\MongoException $e) {
259 7
                $this->queuedInserts = array();
260 7
                throw $e;
261
            }
262
        }
263
264
        /* All collections except for ones using addToSet have already been
265
         * saved. We have left these to be handled separately to avoid checking
266
         * collection for uniqueness on PHP side.
267
         */
268 535
        foreach ($this->queuedInserts as $document) {
269 535
            $this->handleCollections($document, $options);
270
        }
271
272 535
        $this->queuedInserts = array();
273 535
    }
274
275
    /**
276
     * Executes all queued document upserts.
277
     *
278
     * Queued documents with an ID are upserted individually.
279
     *
280
     * If no upserts are queued, invoking this method is a NOOP.
281
     *
282
     * @param array $options Options for batchInsert() and update() driver methods
283
     */
284 87
    public function executeUpserts(array $options = array())
285
    {
286 87
        if ( ! $this->queuedUpserts) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->queuedUpserts of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
287
            return;
288
        }
289
290 87
        $options = $this->getWriteOptions($options);
291 87
        foreach ($this->queuedUpserts as $oid => $document) {
292
            try {
293 87
                $this->executeUpsert($document, $options);
294 87
                $this->handleCollections($document, $options);
295 87
                unset($this->queuedUpserts[$oid]);
296
            } catch (\MongoException $e) {
297
                unset($this->queuedUpserts[$oid]);
298 87
                throw $e;
299
            }
300
        }
301 87
    }
302
303
    /**
304
     * Executes a single upsert in {@link executeUpserts}
305
     *
306
     * @param object $document
307
     * @param array  $options
308
     */
309 87
    private function executeUpsert($document, array $options)
310
    {
311 87
        $options['upsert'] = true;
312 87
        $criteria = $this->getQueryForDocument($document);
313
314 87
        $data = $this->pb->prepareUpsertData($document);
315
316
        // Set the initial version for each upsert
317 87 View Code Duplication
        if ($this->class->isVersioned) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
318 3
            $versionMapping = $this->class->fieldMappings[$this->class->versionField];
319 3
            if ($versionMapping['type'] === 'int') {
320 2
                $nextVersion = max(1, (int) $this->class->reflFields[$this->class->versionField]->getValue($document));
321 2
                $this->class->reflFields[$this->class->versionField]->setValue($document, $nextVersion);
322 1
            } elseif ($versionMapping['type'] === 'date') {
323 1
                $nextVersionDateTime = new \DateTime();
324 1
                $nextVersion = new \MongoDate($nextVersionDateTime->getTimestamp());
325 1
                $this->class->reflFields[$this->class->versionField]->setValue($document, $nextVersionDateTime);
326
            }
327 3
            $data['$set'][$versionMapping['name']] = $nextVersion;
0 ignored issues
show
Bug introduced by
The variable $nextVersion 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...
328
        }
329
330 87
        foreach (array_keys($criteria) as $field) {
331 87
            unset($data['$set'][$field]);
332
        }
333
334
        // Do not send an empty $set modifier
335 87
        if (empty($data['$set'])) {
336 17
            unset($data['$set']);
337
        }
338
339
        /* If there are no modifiers remaining, we're upserting a document with
340
         * an identifier as its only field. Since a document with the identifier
341
         * may already exist, the desired behavior is "insert if not exists" and
342
         * NOOP otherwise. MongoDB 2.6+ does not allow empty modifiers, so $set
343
         * the identifier to the same value in our criteria.
344
         *
345
         * This will fail for versions before MongoDB 2.6, which require an
346
         * empty $set modifier. The best we can do (without attempting to check
347
         * server versions in advance) is attempt the 2.6+ behavior and retry
348
         * after the relevant exception.
349
         *
350
         * See: https://jira.mongodb.org/browse/SERVER-12266
351
         */
352 87
        if (empty($data)) {
353 17
            $retry = true;
354 17
            $data = array('$set' => array('_id' => $criteria['_id']));
355
        }
356
357
        try {
358 87
            $this->collection->update($criteria, $data, $options);
359 87
            return;
360
        } catch (\MongoCursorException $e) {
361
            if (empty($retry) || strpos($e->getMessage(), 'Mod on _id not allowed') === false) {
362
                throw $e;
363
            }
364
        }
365
366
        $this->collection->update($criteria, array('$set' => new \stdClass), $options);
367
    }
368
369
    /**
370
     * Updates the already persisted document if it has any new changesets.
371
     *
372
     * @param object $document
373
     * @param array $options Array of options to be used with update()
374
     * @throws \Doctrine\ODM\MongoDB\LockException
375
     */
376 225
    public function update($document, array $options = array())
377
    {
378 225
        $update = $this->pb->prepareUpdateData($document);
379
380 225
        $query = $this->getQueryForDocument($document);
381
382 223
        foreach (array_keys($query) as $field) {
383 223
            unset($update['$set'][$field]);
384
        }
385
386 223
        if (empty($update['$set'])) {
387 94
            unset($update['$set']);
388
        }
389
390
391
        // Include versioning logic to set the new version value in the database
392
        // and to ensure the version has not changed since this document object instance
393
        // was fetched from the database
394 223
        if ($this->class->isVersioned) {
395 31
            $versionMapping = $this->class->fieldMappings[$this->class->versionField];
396 31
            $currentVersion = $this->class->reflFields[$this->class->versionField]->getValue($document);
397 31
            if ($versionMapping['type'] === 'int') {
398 28
                $nextVersion = $currentVersion + 1;
399 28
                $update['$inc'][$versionMapping['name']] = 1;
400 28
                $query[$versionMapping['name']] = $currentVersion;
401 28
                $this->class->reflFields[$this->class->versionField]->setValue($document, $nextVersion);
402 3
            } elseif ($versionMapping['type'] === 'date') {
403 3
                $nextVersion = new \DateTime();
404 3
                $update['$set'][$versionMapping['name']] = new \MongoDate($nextVersion->getTimestamp());
405 3
                $query[$versionMapping['name']] = new \MongoDate($currentVersion->getTimestamp());
406 3
                $this->class->reflFields[$this->class->versionField]->setValue($document, $nextVersion);
407
            }
408
        }
409
410 223
        if ( ! empty($update)) {
411
            // Include locking logic so that if the document object in memory is currently
412
            // locked then it will remove it, otherwise it ensures the document is not locked.
413 155
            if ($this->class->isLockable) {
414 11
                $isLocked = $this->class->reflFields[$this->class->lockField]->getValue($document);
415 11
                $lockMapping = $this->class->fieldMappings[$this->class->lockField];
416 11
                if ($isLocked) {
417 2
                    $update['$unset'] = array($lockMapping['name'] => true);
418
                } else {
419 9
                    $query[$lockMapping['name']] = array('$exists' => false);
420
                }
421
            }
422
423 155
            $options = $this->getWriteOptions($options);
424
425 155
            $result = $this->collection->update($query, $update, $options);
426
427 155 View Code Duplication
            if (($this->class->isVersioned || $this->class->isLockable) && ! $result['n']) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
428 5
                throw LockException::lockFailed($document);
429
            }
430
        }
431
432 219
        $this->handleCollections($document, $options);
433 219
    }
434
435
    /**
436
     * Removes document from mongo
437
     *
438
     * @param mixed $document
439
     * @param array $options Array of options to be used with remove()
440
     * @throws \Doctrine\ODM\MongoDB\LockException
441
     */
442 34
    public function delete($document, array $options = array())
443
    {
444 34
        $query = $this->getQueryForDocument($document);
445
446 34
        if ($this->class->isLockable) {
447 2
            $query[$this->class->lockField] = array('$exists' => false);
448
        }
449
450 34
        $options = $this->getWriteOptions($options);
451
452 34
        $result = $this->collection->remove($query, $options);
453
454 34 View Code Duplication
        if (($this->class->isVersioned || $this->class->isLockable) && ! $result['n']) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
455 2
            throw LockException::lockFailed($document);
456
        }
457 32
    }
458
459
    /**
460
     * Refreshes a managed document.
461
     *
462
     * @param string $id
463
     * @param object $document The document to refresh.
464
     *
465
     * @deprecated The first argument is deprecated.
466
     */
467 22
    public function refresh($id, $document)
0 ignored issues
show
Unused Code introduced by
The parameter $id 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...
468
    {
469 22
        $query = $this->getQueryForDocument($document);
470 22
        $data = $this->collection->findOne($query);
471 22
        $data = $this->hydratorFactory->hydrate($document, $data);
472 22
        $this->uow->setOriginalDocumentData($document, $data);
473 22
    }
474
475
    /**
476
     * Finds a document by a set of criteria.
477
     *
478
     * If a scalar or MongoId is provided for $criteria, it will be used to
479
     * match an _id value.
480
     *
481
     * @param mixed   $criteria Query criteria
482
     * @param object  $document Document to load the data into. If not specified, a new document is created.
483
     * @param array   $hints    Hints for document creation
484
     * @param integer $lockMode
485
     * @param array   $sort     Sort array for Cursor::sort()
486
     * @throws \Doctrine\ODM\MongoDB\LockException
487
     * @return object|null The loaded and managed document instance or null if no document was found
488
     * @todo Check identity map? loadById method? Try to guess whether $criteria is the id?
489
     */
490 379
    public function load($criteria, $document = null, array $hints = array(), $lockMode = 0, array $sort = null)
0 ignored issues
show
Unused Code introduced by
The parameter $lockMode 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...
491
    {
492
        // TODO: remove this
493 379
        if ($criteria === null || is_scalar($criteria) || $criteria instanceof \MongoId) {
494
            $criteria = array('_id' => $criteria);
495
        }
496
497 379
        $criteria = $this->prepareQueryOrNewObj($criteria);
0 ignored issues
show
Bug introduced by
It seems like $criteria can also be of type object; however, Doctrine\ODM\MongoDB\Per...:prepareQueryOrNewObj() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
498 379
        $criteria = $this->addDiscriminatorToPreparedQuery($criteria);
499 379
        $criteria = $this->addFilterToPreparedQuery($criteria);
500
501 379
        $cursor = $this->collection->find($criteria);
502
503 379
        if (null !== $sort) {
504 105
            $cursor->sort($this->prepareSortOrProjection($sort));
505
        }
506
507 379
        $result = $cursor->getSingleResult();
508
509 379
        if ($this->class->isLockable) {
510 1
            $lockMapping = $this->class->fieldMappings[$this->class->lockField];
511 1
            if (isset($result[$lockMapping['name']]) && $result[$lockMapping['name']] === LockMode::PESSIMISTIC_WRITE) {
512 1
                throw LockException::lockFailed($result);
513
            }
514
        }
515
516 378
        return $this->createDocument($result, $document, $hints);
517
    }
518
519
    /**
520
     * Finds documents by a set of criteria.
521
     *
522
     * @param array        $criteria Query criteria
523
     * @param array        $sort     Sort array for Cursor::sort()
524
     * @param integer|null $limit    Limit for Cursor::limit()
525
     * @param integer|null $skip     Skip for Cursor::skip()
526
     * @return Cursor
527
     */
528 26
    public function loadAll(array $criteria = array(), array $sort = null, $limit = null, $skip = null)
529
    {
530 26
        $criteria = $this->prepareQueryOrNewObj($criteria);
531 26
        $criteria = $this->addDiscriminatorToPreparedQuery($criteria);
532 26
        $criteria = $this->addFilterToPreparedQuery($criteria);
533
534 26
        $baseCursor = $this->collection->find($criteria);
535 26
        $cursor = $this->wrapCursor($baseCursor);
0 ignored issues
show
Documentation introduced by
$baseCursor is of type object<MongoCursor>, but the function expects a object<Doctrine\MongoDB\CursorInterface>.

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...
536
537 26
        if (null !== $sort) {
538 3
            $cursor->sort($sort);
539
        }
540
541 26
        if (null !== $limit) {
542 2
            $cursor->limit($limit);
543
        }
544
545 26
        if (null !== $skip) {
546 2
            $cursor->skip($skip);
547
        }
548
549 26
        return $cursor;
550
    }
551
552
    /**
553
     * @param object $document
554
     *
555
     * @return array
556
     * @throws MongoDBException
557
     */
558 303
    private function getShardKeyQuery($document)
559
    {
560 303
        if ( ! $this->class->isSharded()) {
561 294
            return array();
562
        }
563
564 9
        $shardKey = $this->class->getShardKey();
565 9
        $keys = array_keys($shardKey['keys']);
566 9
        $data = $this->uow->getDocumentActualData($document);
567
568 9
        $shardKeyQueryPart = array();
569 9
        foreach ($keys as $key) {
570 9
            $mapping = $this->class->getFieldMappingByDbFieldName($key);
571 9
            $this->guardMissingShardKey($document, $key, $data);
572 7
            $value = Type::getType($mapping['type'])->convertToDatabaseValue($data[$mapping['fieldName']]);
573 7
            $shardKeyQueryPart[$key] = $value;
574
        }
575
576 7
        return $shardKeyQueryPart;
577
    }
578
579
    /**
580
     * Wraps the supplied base cursor in the corresponding ODM class.
581
     *
582
     * @param CursorInterface $baseCursor
583
     * @return Cursor
584
     */
585 26
    private function wrapCursor(CursorInterface $baseCursor)
586
    {
587 26
        return new Cursor($baseCursor, $this->dm->getUnitOfWork(), $this->class);
588
    }
589
590
    /**
591
     * Checks whether the given managed document exists in the database.
592
     *
593
     * @param object $document
594
     * @return boolean TRUE if the document exists in the database, FALSE otherwise.
595
     */
596 3
    public function exists($document)
597
    {
598 3
        $id = $this->class->getIdentifierObject($document);
599 3
        return (boolean) $this->collection->findOne(array('_id' => $id), array('_id'));
600
    }
601
602
    /**
603
     * Locks document by storing the lock mode on the mapped lock field.
604
     *
605
     * @param object $document
606
     * @param int $lockMode
607
     */
608 5
    public function lock($document, $lockMode)
609
    {
610 5
        $id = $this->uow->getDocumentIdentifier($document);
611 5
        $criteria = array('_id' => $this->class->getDatabaseIdentifierValue($id));
612 5
        $lockMapping = $this->class->fieldMappings[$this->class->lockField];
613 5
        $this->collection->update($criteria, array('$set' => array($lockMapping['name'] => $lockMode)));
614 5
        $this->class->reflFields[$this->class->lockField]->setValue($document, $lockMode);
615 5
    }
616
617
    /**
618
     * Releases any lock that exists on this document.
619
     *
620
     * @param object $document
621
     */
622 1
    public function unlock($document)
623
    {
624 1
        $id = $this->uow->getDocumentIdentifier($document);
625 1
        $criteria = array('_id' => $this->class->getDatabaseIdentifierValue($id));
626 1
        $lockMapping = $this->class->fieldMappings[$this->class->lockField];
627 1
        $this->collection->update($criteria, array('$unset' => array($lockMapping['name'] => true)));
628 1
        $this->class->reflFields[$this->class->lockField]->setValue($document, null);
629 1
    }
630
631
    /**
632
     * Creates or fills a single document object from an query result.
633
     *
634
     * @param object $result The query result.
635
     * @param object $document The document object to fill, if any.
636
     * @param array $hints Hints for document creation.
637
     * @return object The filled and managed document object or NULL, if the query result is empty.
638
     */
639 378
    private function createDocument($result, $document = null, array $hints = array())
640
    {
641 378
        if ($result === null) {
642 120
            return null;
643
        }
644
645 325
        if ($document !== null) {
646 38
            $hints[Query::HINT_REFRESH] = true;
647 38
            $id = $this->class->getPHPIdentifierValue($result['_id']);
648 38
            $this->uow->registerManaged($document, $id, $result);
0 ignored issues
show
Documentation introduced by
$result is of type object, but the function expects a array.

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...
649
        }
650
651 325
        return $this->uow->getOrCreateDocument($this->class->name, $result, $hints, $document);
0 ignored issues
show
Documentation introduced by
$result is of type object, but the function expects a array.

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...
652
    }
653
654
    /**
655
     * Loads a PersistentCollection data. Used in the initialize() method.
656
     *
657
     * @param PersistentCollectionInterface $collection
658
     */
659 173
    public function loadCollection(PersistentCollectionInterface $collection)
660
    {
661 173
        $mapping = $collection->getMapping();
662 173
        switch ($mapping['association']) {
663 173
            case ClassMetadata::EMBED_MANY:
664 119
                $this->loadEmbedManyCollection($collection);
665 119
                break;
666
667 71
            case ClassMetadata::REFERENCE_MANY:
668 71
                if (isset($mapping['repositoryMethod']) && $mapping['repositoryMethod']) {
669 5
                    $this->loadReferenceManyWithRepositoryMethod($collection);
670
                } else {
671 66
                    if ($mapping['isOwningSide']) {
672 55
                        $this->loadReferenceManyCollectionOwningSide($collection);
673
                    } else {
674 15
                        $this->loadReferenceManyCollectionInverseSide($collection);
675
                    }
676
                }
677 70
                break;
678
        }
679 172
    }
680
681 119
    private function loadEmbedManyCollection(PersistentCollectionInterface $collection)
682
    {
683 119
        $embeddedDocuments = $collection->getMongoData();
684 119
        $mapping = $collection->getMapping();
685 119
        $owner = $collection->getOwner();
686 119
        if ($embeddedDocuments) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $embeddedDocuments of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
687 90
            foreach ($embeddedDocuments as $key => $embeddedDocument) {
688 90
                $className = $this->uow->getClassNameForAssociation($mapping, $embeddedDocument);
689 90
                $embeddedMetadata = $this->dm->getClassMetadata($className);
690 90
                $embeddedDocumentObject = $embeddedMetadata->newInstance();
691
692 90
                $this->uow->setParentAssociation($embeddedDocumentObject, $mapping, $owner, $mapping['name'] . '.' . $key);
693
694 90
                $data = $this->hydratorFactory->hydrate($embeddedDocumentObject, $embeddedDocument, $collection->getHints());
695 90
                $id = $embeddedMetadata->identifier && isset($data[$embeddedMetadata->identifier])
696 23
                    ? $data[$embeddedMetadata->identifier]
697 90
                    : null;
698
                
699 90
                if (empty($collection->getHints()[Query::HINT_READ_ONLY])) {
700 89
                    $this->uow->registerManaged($embeddedDocumentObject, $id, $data);
701
                }
702 90
                if (CollectionHelper::isHash($mapping['strategy'])) {
703 25
                    $collection->set($key, $embeddedDocumentObject);
704
                } else {
705 90
                    $collection->add($embeddedDocumentObject);
706
                }
707
            }
708
        }
709 119
    }
710
711 55
    private function loadReferenceManyCollectionOwningSide(PersistentCollectionInterface $collection)
712
    {
713 55
        $hints = $collection->getHints();
714 55
        $mapping = $collection->getMapping();
715 55
        $groupedIds = array();
716
717 55
        $sorted = isset($mapping['sort']) && $mapping['sort'];
718
719 55
        foreach ($collection->getMongoData() as $key => $reference) {
720 50
            if (isset($mapping['storeAs']) && $mapping['storeAs'] === ClassMetadataInfo::REFERENCE_STORE_AS_ID) {
721 5
                $className = $mapping['targetDocument'];
722 5
                $mongoId = $reference;
723
            } else {
724 46
                $className = $this->uow->getClassNameForAssociation($mapping, $reference);
725 46
                $mongoId = $reference['$id'];
726
            }
727 50
            $id = $this->dm->getClassMetadata($className)->getPHPIdentifierValue($mongoId);
728
729
            // create a reference to the class and id
730 50
            $reference = $this->dm->getReference($className, $id);
731
732
            // no custom sort so add the references right now in the order they are embedded
733 50
            if ( ! $sorted) {
734 49
                if (CollectionHelper::isHash($mapping['strategy'])) {
735 2
                    $collection->set($key, $reference);
736
                } else {
737 47
                    $collection->add($reference);
738
                }
739
            }
740
741
            // only query for the referenced object if it is not already initialized or the collection is sorted
742 50
            if (($reference instanceof Proxy && ! $reference->__isInitialized__) || $sorted) {
0 ignored issues
show
Bug introduced by
Accessing __isInitialized__ on the interface Doctrine\ODM\MongoDB\Proxy\Proxy suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
743 50
                $groupedIds[$className][] = $mongoId;
744
            }
745
        }
746 55
        foreach ($groupedIds as $className => $ids) {
747 35
            $class = $this->dm->getClassMetadata($className);
748 35
            $mongoCollection = $this->dm->getDocumentCollection($className);
749 35
            $criteria = $this->cm->merge(
750 35
                array('_id' => array('$in' => array_values($ids))),
751 35
                $this->dm->getFilterCollection()->getFilterCriteria($class),
752 35
                isset($mapping['criteria']) ? $mapping['criteria'] : array()
753
            );
754 35
            $criteria = $this->uow->getDocumentPersister($className)->prepareQueryOrNewObj($criteria);
755 35
            $cursor = $mongoCollection->find($criteria);
756 35
            if (isset($mapping['sort'])) {
757 35
                $cursor->sort($mapping['sort']);
758
            }
759 35
            if (isset($mapping['limit'])) {
760
                $cursor->limit($mapping['limit']);
761
            }
762 35
            if (isset($mapping['skip'])) {
763
                $cursor->skip($mapping['skip']);
764
            }
765 35
            if ( ! empty($hints[Query::HINT_SLAVE_OKAY])) {
766
                $cursor->slaveOkay(true);
767
            }
768 35 View Code Duplication
            if ( ! empty($hints[Query::HINT_READ_PREFERENCE])) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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
                $cursor->setReadPreference($hints[Query::HINT_READ_PREFERENCE], $hints[Query::HINT_READ_PREFERENCE_TAGS]);
770
            }
771 35
            $documents = $cursor->toArray(false);
772 35
            foreach ($documents as $documentData) {
773 34
                $document = $this->uow->getById($documentData['_id'], $class);
774 34
                if ($document instanceof Proxy && ! $document->__isInitialized()) {
775 34
                    $data = $this->hydratorFactory->hydrate($document, $documentData);
776 34
                    $this->uow->setOriginalDocumentData($document, $data);
777 34
                    $document->__isInitialized__ = true;
0 ignored issues
show
Bug introduced by
Accessing __isInitialized__ on the interface Doctrine\ODM\MongoDB\Proxy\Proxy suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
778
                }
779 34
                if ($sorted) {
780 35
                    $collection->add($document);
781
                }
782
            }
783
        }
784 55
    }
785
786 15
    private function loadReferenceManyCollectionInverseSide(PersistentCollectionInterface $collection)
787
    {
788 15
        $query = $this->createReferenceManyInverseSideQuery($collection);
789 15
        $documents = $query->execute()->toArray(false);
790 15
        foreach ($documents as $key => $document) {
791 14
            $collection->add($document);
792
        }
793 15
    }
794
795
    /**
796
     * @param PersistentCollectionInterface $collection
797
     *
798
     * @return Query
799
     */
800 18
    public function createReferenceManyInverseSideQuery(PersistentCollectionInterface $collection)
801
    {
802 18
        $hints = $collection->getHints();
803 18
        $mapping = $collection->getMapping();
804 18
        $owner = $collection->getOwner();
805 18
        $ownerClass = $this->dm->getClassMetadata(get_class($owner));
806 18
        $targetClass = $this->dm->getClassMetadata($mapping['targetDocument']);
807 18
        $mappedByMapping = isset($targetClass->fieldMappings[$mapping['mappedBy']]) ? $targetClass->fieldMappings[$mapping['mappedBy']] : array();
808 18
        $mappedByFieldName = isset($mappedByMapping['storeAs']) && $mappedByMapping['storeAs'] === ClassMetadataInfo::REFERENCE_STORE_AS_ID ? $mapping['mappedBy'] : $mapping['mappedBy'] . '.$id';
809 18
        $criteria = $this->cm->merge(
810 18
            array($mappedByFieldName => $ownerClass->getIdentifierObject($owner)),
811 18
            $this->dm->getFilterCollection()->getFilterCriteria($targetClass),
812 18
            isset($mapping['criteria']) ? $mapping['criteria'] : array()
813
        );
814 18
        $criteria = $this->uow->getDocumentPersister($mapping['targetDocument'])->prepareQueryOrNewObj($criteria);
815 18
        $qb = $this->dm->createQueryBuilder($mapping['targetDocument'])
816 18
            ->setQueryArray($criteria);
817
818 18
        if (isset($mapping['sort'])) {
819 18
            $qb->sort($mapping['sort']);
820
        }
821 18
        if (isset($mapping['limit'])) {
822 2
            $qb->limit($mapping['limit']);
823
        }
824 18
        if (isset($mapping['skip'])) {
825
            $qb->skip($mapping['skip']);
826
        }
827 18
        if ( ! empty($hints[Query::HINT_SLAVE_OKAY])) {
828
            $qb->slaveOkay(true);
829
        }
830 18 View Code Duplication
        if ( ! empty($hints[Query::HINT_READ_PREFERENCE])) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
831
            $qb->setReadPreference($hints[Query::HINT_READ_PREFERENCE], $hints[Query::HINT_READ_PREFERENCE_TAGS]);
832
        }
833 18
        foreach ($mapping['prime'] as $field) {
834 4
            $qb->field($field)->prime(true);
835
        }
836
837 18
        return $qb->getQuery();
838
    }
839
840 5
    private function loadReferenceManyWithRepositoryMethod(PersistentCollectionInterface $collection)
841
    {
842 5
        $cursor = $this->createReferenceManyWithRepositoryMethodCursor($collection);
843 4
        $mapping = $collection->getMapping();
844 4
        $documents = $cursor->toArray(false);
0 ignored issues
show
Unused Code introduced by
The call to CursorInterface::toArray() has too many arguments starting with false.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
845 4
        foreach ($documents as $key => $obj) {
846 4
            if (CollectionHelper::isHash($mapping['strategy'])) {
847 1
                $collection->set($key, $obj);
848
            } else {
849 4
                $collection->add($obj);
850
            }
851
        }
852 4
    }
853
854
    /**
855
     * @param PersistentCollectionInterface $collection
856
     *
857
     * @return CursorInterface
858
     */
859 6
    public function createReferenceManyWithRepositoryMethodCursor(PersistentCollectionInterface $collection)
860
    {
861 6
        $hints = $collection->getHints();
862 6
        $mapping = $collection->getMapping();
863 6
        $repositoryMethod = $mapping['repositoryMethod'];
864 6
        $cursor = $this->dm->getRepository($mapping['targetDocument'])
865 6
            ->$repositoryMethod($collection->getOwner());
866
867 6
        if ( ! $cursor instanceof CursorInterface) {
868
            throw new \BadMethodCallException("Expected repository method {$repositoryMethod} to return a CursorInterface");
869
        }
870
871 6
        if (!empty($mapping['prime']) && $cursor instanceof Cursor) {
872 2
            $referencePrimer = new ReferencePrimer($this->dm, $this->dm->getUnitOfWork());
873 2
            $primers = array_combine($mapping['prime'], array_fill(0, count($mapping['prime']), true));
874
875 2
            $cursor->enableReferencePriming($primers, $referencePrimer);
876
        }
877
878 5
        if (isset($mapping['sort'])) {
879 5
            $cursor->sort($mapping['sort']);
880
        }
881 5
        if (isset($mapping['limit'])) {
882 1
            $cursor->limit($mapping['limit']);
883
        }
884 5
        if (isset($mapping['skip'])) {
885
            $cursor->skip($mapping['skip']);
886
        }
887 5
        if ( ! empty($hints[Query::HINT_SLAVE_OKAY])) {
888
            $cursor->slaveOkay(true);
889
        }
890 5 View Code Duplication
        if ( ! empty($hints[Query::HINT_READ_PREFERENCE])) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
891
            $cursor->setReadPreference($hints[Query::HINT_READ_PREFERENCE], $hints[Query::HINT_READ_PREFERENCE_TAGS]);
892
        }
893
894 5
        return $cursor;
895
    }
896
897
    /**
898
     * Prepare a sort or projection array by converting keys, which are PHP
899
     * property names, to MongoDB field names.
900
     *
901
     * @param array $fields
902
     * @return array
903
     */
904 145
    public function prepareSortOrProjection(array $fields)
905
    {
906 145
        $preparedFields = array();
907
908 145
        foreach ($fields as $key => $value) {
909 39
            $preparedFields[$this->prepareFieldName($key)] = $value;
910
        }
911
912 145
        return $preparedFields;
913
    }
914
915
    /**
916
     * Prepare a mongodb field name and convert the PHP property names to MongoDB field names.
917
     *
918
     * @param string $fieldName
919
     * @return string
920
     */
921 95
    public function prepareFieldName($fieldName)
922
    {
923 95
        $fieldNames = $this->prepareQueryElement($fieldName, null, null, false);
924
925 95
        return $fieldNames[0][0];
926
    }
927
928
    /**
929
     * Adds discriminator criteria to an already-prepared query.
930
     *
931
     * This method should be used once for query criteria and not be used for
932
     * nested expressions. It should be called before
933
     * {@link DocumentPerister::addFilterToPreparedQuery()}.
934
     *
935
     * @param array $preparedQuery
936
     * @return array
937
     */
938 531
    public function addDiscriminatorToPreparedQuery(array $preparedQuery)
939
    {
940
        /* If the class has a discriminator field, which is not already in the
941
         * criteria, inject it now. The field/values need no preparation.
942
         */
943 531
        if ($this->class->hasDiscriminator() && ! isset($preparedQuery[$this->class->discriminatorField])) {
944 29
            $discriminatorValues = $this->getClassDiscriminatorValues($this->class);
945 29
            if (count($discriminatorValues) === 1) {
946 21
                $preparedQuery[$this->class->discriminatorField] = $discriminatorValues[0];
947
            } else {
948 10
                $preparedQuery[$this->class->discriminatorField] = array('$in' => $discriminatorValues);
949
            }
950
        }
951
952 531
        return $preparedQuery;
953
    }
954
955
    /**
956
     * Adds filter criteria to an already-prepared query.
957
     *
958
     * This method should be used once for query criteria and not be used for
959
     * nested expressions. It should be called after
960
     * {@link DocumentPerister::addDiscriminatorToPreparedQuery()}.
961
     *
962
     * @param array $preparedQuery
963
     * @return array
964
     */
965 532
    public function addFilterToPreparedQuery(array $preparedQuery)
966
    {
967
        /* If filter criteria exists for this class, prepare it and merge
968
         * over the existing query.
969
         *
970
         * @todo Consider recursive merging in case the filter criteria and
971
         * prepared query both contain top-level $and/$or operators.
972
         */
973 532
        if ($filterCriteria = $this->dm->getFilterCollection()->getFilterCriteria($this->class)) {
974 18
            $preparedQuery = $this->cm->merge($preparedQuery, $this->prepareQueryOrNewObj($filterCriteria));
975
        }
976
977 532
        return $preparedQuery;
978
    }
979
980
    /**
981
     * Prepares the query criteria or new document object.
982
     *
983
     * PHP field names and types will be converted to those used by MongoDB.
984
     *
985
     * @param array $query
986
     * @param bool $isNewObj
987
     * @return array
988
     */
989 557
    public function prepareQueryOrNewObj(array $query, $isNewObj = false)
990
    {
991 557
        $preparedQuery = array();
992
993 557
        foreach ($query as $key => $value) {
994
            // Recursively prepare logical query clauses
995 517
            if (in_array($key, array('$and', '$or', '$nor')) && is_array($value)) {
996 20
                foreach ($value as $k2 => $v2) {
997 20
                    $preparedQuery[$key][$k2] = $this->prepareQueryOrNewObj($v2, $isNewObj);
998
                }
999 20
                continue;
1000
            }
1001
1002 517
            if (isset($key[0]) && $key[0] === '$' && is_array($value)) {
1003 26
                $preparedQuery[$key] = $this->prepareQueryOrNewObj($value, $isNewObj);
1004 26
                continue;
1005
            }
1006
1007 517
            $preparedQueryElements = $this->prepareQueryElement($key, $value, null, true, $isNewObj);
1008 517
            foreach ($preparedQueryElements as list($preparedKey, $preparedValue)) {
1009 517
                $preparedQuery[$preparedKey] = is_array($preparedValue)
1010 131
                    ? array_map('\Doctrine\ODM\MongoDB\Types\Type::convertPHPToDatabaseValue', $preparedValue)
1011 517
                    : Type::convertPHPToDatabaseValue($preparedValue);
1012
            }
1013
        }
1014
1015 557
        return $preparedQuery;
1016
    }
1017
1018
    /**
1019
     * Prepares a query value and converts the PHP value to the database value
1020
     * if it is an identifier.
1021
     *
1022
     * It also handles converting $fieldName to the database name if they are different.
1023
     *
1024
     * @param string $fieldName
1025
     * @param mixed $value
1026
     * @param ClassMetadata $class        Defaults to $this->class
1027
     * @param bool $prepareValue Whether or not to prepare the value
1028
     * @param bool $inNewObj Whether or not newObj is being prepared
1029
     * @return array An array of tuples containing prepared field names and values
1030
     */
1031 551
    private function prepareQueryElement($fieldName, $value = null, $class = null, $prepareValue = true, $inNewObj = false)
1032
    {
1033 551
        $class = isset($class) ? $class : $this->class;
1034
1035
        // @todo Consider inlining calls to ClassMetadataInfo methods
1036
1037
        // Process all non-identifier fields by translating field names
1038 551
        if ($class->hasField($fieldName) && ! $class->isIdentifier($fieldName)) {
1039 261
            $mapping = $class->fieldMappings[$fieldName];
1040 261
            $fieldName = $mapping['name'];
1041
1042 261
            if ( ! $prepareValue) {
1043 69
                return [[$fieldName, $value]];
1044
            }
1045
1046
            // Prepare mapped, embedded objects
1047 215
            if ( ! empty($mapping['embedded']) && is_object($value) &&
1048 215
                ! $this->dm->getMetadataFactory()->isTransient(get_class($value))) {
1049 3
                return [[$fieldName, $this->pb->prepareEmbeddedDocumentValue($mapping, $value)]];
1050
            }
1051
1052 213
            if (! empty($mapping['reference']) && is_object($value) && ! ($value instanceof \MongoId)) {
1053
                try {
1054 13
                    return $this->prepareDbRefElement($fieldName, $value, $mapping, $inNewObj);
1055 1
                } catch (MappingException $e) {
1056
                    // do nothing in case passed object is not mapped document
1057
                }
1058
            }
1059
1060
            // No further preparation unless we're dealing with a simple reference
1061
            // We can't have expressions in empty() with PHP < 5.5, so store it in a variable
1062 201
            $arrayValue = (array) $value;
1063 201
            if (empty($mapping['reference']) || $mapping['storeAs'] !== ClassMetadataInfo::REFERENCE_STORE_AS_ID || empty($arrayValue)) {
1064 124
                return [[$fieldName, $value]];
1065
            }
1066
1067
            // Additional preparation for one or more simple reference values
1068 105
            $targetClass = $this->dm->getClassMetadata($mapping['targetDocument']);
1069
1070 105
            if ( ! is_array($value)) {
1071 101
                return [[$fieldName, $targetClass->getDatabaseIdentifierValue($value)]];
1072
            }
1073
1074
            // Objects without operators or with DBRef fields can be converted immediately
1075 6 View Code Duplication
            if ( ! $this->hasQueryOperators($value) || $this->hasDBRefFields($value)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
1076 3
                return [[$fieldName, $targetClass->getDatabaseIdentifierValue($value)]];
1077
            }
1078
1079 6
            return [[$fieldName, $this->prepareQueryExpression($value, $targetClass)]];
1080
        }
1081
1082
        // Process identifier fields
1083 407
        if (($class->hasField($fieldName) && $class->isIdentifier($fieldName)) || $fieldName === '_id') {
1084 337
            $fieldName = '_id';
1085
1086 337
            if ( ! $prepareValue) {
1087 20
                return [[$fieldName, $value]];
1088
            }
1089
1090 320
            if ( ! is_array($value)) {
1091 297
                return [[$fieldName, $class->getDatabaseIdentifierValue($value)]];
1092
            }
1093
1094
            // Objects without operators or with DBRef fields can be converted immediately
1095 58 View Code Duplication
            if ( ! $this->hasQueryOperators($value) || $this->hasDBRefFields($value)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
1096 6
                return [[$fieldName, $class->getDatabaseIdentifierValue($value)]];
1097
            }
1098
1099 53
            return [[$fieldName, $this->prepareQueryExpression($value, $class)]];
1100
        }
1101
1102
        // No processing for unmapped, non-identifier, non-dotted field names
1103 110
        if (strpos($fieldName, '.') === false) {
1104 49
            return [[$fieldName, $value]];
1105
        }
1106
1107
        /* Process "fieldName.objectProperty" queries (on arrays or objects).
1108
         *
1109
         * We can limit parsing here, since at most three segments are
1110
         * significant: "fieldName.objectProperty" with an optional index or key
1111
         * for collections stored as either BSON arrays or objects.
1112
         */
1113 67
        $e = explode('.', $fieldName, 4);
1114
1115
        // No further processing for unmapped fields
1116 67
        if ( ! isset($class->fieldMappings[$e[0]])) {
1117 4
            return [[$fieldName, $value]];
1118
        }
1119
1120 64
        $mapping = $class->fieldMappings[$e[0]];
1121 64
        $e[0] = $mapping['name'];
1122
1123
        // Hash and raw fields will not be prepared beyond the field name
1124 64
        if ($mapping['type'] === Type::HASH || $mapping['type'] === Type::RAW) {
1125 1
            $fieldName = implode('.', $e);
1126
1127 1
            return [[$fieldName, $value]];
1128
        }
1129
1130 63
        if ($mapping['type'] == 'many' && CollectionHelper::isHash($mapping['strategy'])
1131 63
                && isset($e[2])) {
1132 1
            $objectProperty = $e[2];
1133 1
            $objectPropertyPrefix = $e[1] . '.';
1134 1
            $nextObjectProperty = implode('.', array_slice($e, 3));
1135 62
        } elseif ($e[1] != '$') {
1136 61
            $fieldName = $e[0] . '.' . $e[1];
1137 61
            $objectProperty = $e[1];
1138 61
            $objectPropertyPrefix = '';
1139 61
            $nextObjectProperty = implode('.', array_slice($e, 2));
1140 1
        } elseif (isset($e[2])) {
1141 1
            $fieldName = $e[0] . '.' . $e[1] . '.' . $e[2];
1142 1
            $objectProperty = $e[2];
1143 1
            $objectPropertyPrefix = $e[1] . '.';
1144 1
            $nextObjectProperty = implode('.', array_slice($e, 3));
1145
        } else {
1146 1
            $fieldName = $e[0] . '.' . $e[1];
1147
1148 1
            return [[$fieldName, $value]];
1149
        }
1150
1151
        // No further processing for fields without a targetDocument mapping
1152 63
        if ( ! isset($mapping['targetDocument'])) {
1153 3
            if ($nextObjectProperty) {
1154
                $fieldName .= '.'.$nextObjectProperty;
1155
            }
1156
1157 3
            return [[$fieldName, $value]];
1158
        }
1159
1160 60
        $targetClass = $this->dm->getClassMetadata($mapping['targetDocument']);
1161
1162
        // No further processing for unmapped targetDocument fields
1163 60
        if ( ! $targetClass->hasField($objectProperty)) {
1164 28
            if ($nextObjectProperty) {
1165
                $fieldName .= '.'.$nextObjectProperty;
1166
            }
1167
1168 28
            return [[$fieldName, $value]];
1169
        }
1170
1171 35
        $targetMapping = $targetClass->getFieldMapping($objectProperty);
1172 35
        $objectPropertyIsId = $targetClass->isIdentifier($objectProperty);
1173
1174
        // Prepare DBRef identifiers or the mapped field's property path
1175 35
        $fieldName = ($objectPropertyIsId && ! empty($mapping['reference']) && $mapping['storeAs'] !== ClassMetadataInfo::REFERENCE_STORE_AS_ID)
1176 13
            ? $e[0] . '.$id'
1177 35
            : $e[0] . '.' . $objectPropertyPrefix . $targetMapping['name'];
1178
1179
        // Process targetDocument identifier fields
1180 35
        if ($objectPropertyIsId) {
1181 14
            if ( ! $prepareValue) {
1182 1
                return [[$fieldName, $value]];
1183
            }
1184
1185 13
            if ( ! is_array($value)) {
1186 2
                return [[$fieldName, $targetClass->getDatabaseIdentifierValue($value)]];
1187
            }
1188
1189
            // Objects without operators or with DBRef fields can be converted immediately
1190 12 View Code Duplication
            if ( ! $this->hasQueryOperators($value) || $this->hasDBRefFields($value)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
1191 3
                return [[$fieldName, $targetClass->getDatabaseIdentifierValue($value)]];
1192
            }
1193
1194 12
            return [[$fieldName, $this->prepareQueryExpression($value, $targetClass)]];
1195
        }
1196
1197
        /* The property path may include a third field segment, excluding the
1198
         * collection item pointer. If present, this next object property must
1199
         * be processed recursively.
1200
         */
1201 21
        if ($nextObjectProperty) {
1202
            // Respect the targetDocument's class metadata when recursing
1203 14
            $nextTargetClass = isset($targetMapping['targetDocument'])
1204 8
                ? $this->dm->getClassMetadata($targetMapping['targetDocument'])
1205 14
                : null;
1206
1207 14
            $fieldNames = $this->prepareQueryElement($nextObjectProperty, $value, $nextTargetClass, $prepareValue);
1208
1209
            return array_map(function ($preparedTuple) use ($fieldName) {
1210 14
                list($key, $value) = $preparedTuple;
1211
1212 14
                return [$fieldName . '.' . $key, $value];
1213 14
            }, $fieldNames);
1214
        }
1215
1216 9
        return [[$fieldName, $value]];
1217
    }
1218
1219
    /**
1220
     * Prepares a query expression.
1221
     *
1222
     * @param array|object  $expression
1223
     * @param ClassMetadata $class
1224
     * @return array
1225
     */
1226 71
    private function prepareQueryExpression($expression, $class)
1227
    {
1228 71
        foreach ($expression as $k => $v) {
1229
            // Ignore query operators whose arguments need no type conversion
1230 71
            if (in_array($k, array('$exists', '$type', '$mod', '$size'))) {
1231 12
                continue;
1232
            }
1233
1234
            // Process query operators whose argument arrays need type conversion
1235 71
            if (in_array($k, array('$in', '$nin', '$all')) && is_array($v)) {
1236 69
                foreach ($v as $k2 => $v2) {
1237 69
                    $expression[$k][$k2] = $class->getDatabaseIdentifierValue($v2);
1238
                }
1239 69
                continue;
1240
            }
1241
1242
            // Recursively process expressions within a $not operator
1243 14
            if ($k === '$not' && is_array($v)) {
1244 11
                $expression[$k] = $this->prepareQueryExpression($v, $class);
1245 11
                continue;
1246
            }
1247
1248 14
            $expression[$k] = $class->getDatabaseIdentifierValue($v);
1249
        }
1250
1251 71
        return $expression;
1252
    }
1253
1254
    /**
1255
     * Checks whether the value has DBRef fields.
1256
     *
1257
     * This method doesn't check if the the value is a complete DBRef object,
1258
     * although it should return true for a DBRef. Rather, we're checking that
1259
     * the value has one or more fields for a DBref. In practice, this could be
1260
     * $elemMatch criteria for matching a DBRef.
1261
     *
1262
     * @param mixed $value
1263
     * @return boolean
1264
     */
1265 72
    private function hasDBRefFields($value)
1266
    {
1267 72
        if ( ! is_array($value) && ! is_object($value)) {
1268
            return false;
1269
        }
1270
1271 72
        if (is_object($value)) {
1272
            $value = get_object_vars($value);
1273
        }
1274
1275 72
        foreach ($value as $key => $_) {
1276 72
            if ($key === '$ref' || $key === '$id' || $key === '$db') {
1277 72
                return true;
1278
            }
1279
        }
1280
1281 71
        return false;
1282
    }
1283
1284
    /**
1285
     * Checks whether the value has query operators.
1286
     *
1287
     * @param mixed $value
1288
     * @return boolean
1289
     */
1290 76
    private function hasQueryOperators($value)
1291
    {
1292 76
        if ( ! is_array($value) && ! is_object($value)) {
1293
            return false;
1294
        }
1295
1296 76
        if (is_object($value)) {
1297
            $value = get_object_vars($value);
1298
        }
1299
1300 76
        foreach ($value as $key => $_) {
1301 76
            if (isset($key[0]) && $key[0] === '$') {
1302 76
                return true;
1303
            }
1304
        }
1305
1306 9
        return false;
1307
    }
1308
1309
    /**
1310
     * Gets the array of discriminator values for the given ClassMetadata
1311
     *
1312
     * @param ClassMetadata $metadata
1313
     * @return array
1314
     */
1315 29
    private function getClassDiscriminatorValues(ClassMetadata $metadata)
1316
    {
1317 29
        $discriminatorValues = array($metadata->discriminatorValue);
1318 29
        foreach ($metadata->subClasses as $className) {
1319 8
            if ($key = array_search($className, $metadata->discriminatorMap)) {
1320 8
                $discriminatorValues[] = $key;
1321
            }
1322
        }
1323
1324
        // If a defaultDiscriminatorValue is set and it is among the discriminators being queries, add NULL to the list
1325 29 View Code Duplication
        if ($metadata->defaultDiscriminatorValue && array_search($metadata->defaultDiscriminatorValue, $discriminatorValues) !== false) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
1326 2
            $discriminatorValues[] = null;
1327
        }
1328
1329 29
        return $discriminatorValues;
1330
    }
1331
1332 610
    private function handleCollections($document, $options)
1333
    {
1334
        // Collection deletions (deletions of complete collections)
1335 610
        foreach ($this->uow->getScheduledCollections($document) as $coll) {
1336 107
            if ($this->uow->isCollectionScheduledForDeletion($coll)) {
1337 107
                $this->cp->delete($coll, $options);
1338
            }
1339
        }
1340
        // Collection updates (deleteRows, updateRows, insertRows)
1341 610
        foreach ($this->uow->getScheduledCollections($document) as $coll) {
1342 107
            if ($this->uow->isCollectionScheduledForUpdate($coll)) {
1343 107
                $this->cp->update($coll, $options);
1344
            }
1345
        }
1346
        // Take new snapshots from visited collections
1347 610
        foreach ($this->uow->getVisitedCollections($document) as $coll) {
1348 257
            $coll->takeSnapshot();
1349
        }
1350 610
    }
1351
1352
    /**
1353
     * If the document is new, ignore shard key field value, otherwise throw an exception.
1354
     * Also, shard key field should be present in actual document data.
1355
     *
1356
     * @param object $document
1357
     * @param string $shardKeyField
1358
     * @param array  $actualDocumentData
1359
     *
1360
     * @throws MongoDBException
1361
     */
1362 9
    private function guardMissingShardKey($document, $shardKeyField, $actualDocumentData)
1363
    {
1364 9
        $dcs = $this->uow->getDocumentChangeSet($document);
1365 9
        $isUpdate = $this->uow->isScheduledForUpdate($document);
1366
1367 9
        $fieldMapping = $this->class->getFieldMappingByDbFieldName($shardKeyField);
1368 9
        $fieldName = $fieldMapping['fieldName'];
1369
1370 9
        if ($isUpdate && isset($dcs[$fieldName]) && $dcs[$fieldName][0] != $dcs[$fieldName][1]) {
1371 2
            throw MongoDBException::shardKeyFieldCannotBeChanged($shardKeyField, $this->class->getName());
1372
        }
1373
1374 7
        if (!isset($actualDocumentData[$fieldName])) {
1375
            throw MongoDBException::shardKeyFieldMissing($shardKeyField, $this->class->getName());
1376
        }
1377 7
    }
1378
1379
    /**
1380
     * Get shard key aware query for single document.
1381
     *
1382
     * @param object $document
1383
     *
1384
     * @return array
1385
     */
1386 300
    private function getQueryForDocument($document)
1387
    {
1388 300
        $id = $this->uow->getDocumentIdentifier($document);
1389 300
        $id = $this->class->getDatabaseIdentifierValue($id);
1390
1391 300
        $shardKeyQueryPart = $this->getShardKeyQuery($document);
1392 298
        $query = array_merge(array('_id' => $id), $shardKeyQueryPart);
1393
1394 298
        return $query;
1395
    }
1396
1397
    /**
1398
     * @param array $options
1399
     *
1400
     * @return array
1401
     */
1402 611
    private function getWriteOptions(array $options = array())
1403
    {
1404 611
        $defaultOptions = $this->dm->getConfiguration()->getDefaultCommitOptions();
1405 611
        $documentOptions = [];
1406 611
        if ($this->class->hasWriteConcern()) {
1407 9
            $documentOptions['w'] = $this->class->getWriteConcern();
1408
        }
1409
1410 611
        return array_merge($defaultOptions, $documentOptions, $options);
1411
    }
1412
1413
    /**
1414
     * @param string $fieldName
1415
     * @param mixed $value
1416
     * @param array $mapping
1417
     * @param bool $inNewObj
1418
     * @return array
1419
     */
1420 13
    private function prepareDbRefElement($fieldName, $value, array $mapping, $inNewObj)
1421
    {
1422 13
        $dbRef = $this->dm->createDBRef($value, $mapping);
1423 12
        if ($inNewObj) {
1424 6
            return [[$fieldName, $dbRef]];
1425
        }
1426 6
        $keys = ['$ref' => true, '$id' => true, '$db' => true];
1427 6
        if ($mapping['storeAs'] === ClassMetadataInfo::REFERENCE_STORE_AS_ID) {
1428 2
            unset($keys['$db']);
1429
        }
1430 6
        if (isset($mapping['targetDocument'])) {
1431 5
            unset($keys['$ref'], $keys['$db']);
1432
        }
1433
1434 6
        if ($mapping['storeAs'] === ClassMetadataInfo::REFERENCE_STORE_AS_ID) {
1435 2
            return [[$fieldName, $dbRef]];
1436 4
        } elseif ($mapping['type'] === 'many') {
1437 2
            return [[$fieldName, ['$elemMatch' => array_intersect_key($dbRef, $keys)]]];
1438
        } else {
1439 2
            return array_map(
1440 2
                function ($key) use ($dbRef, $fieldName) {
1441 2
                    return [$fieldName . '.' . $key, $dbRef[$key]];
1442 2
                },
1443
                array_keys($keys)
1444
            );
1445
        }
1446
    }
1447
}
1448