Completed
Push — master ( 315dca...845f07 )
by Andreas
12s
created

createReferenceManyInverseSideQuery()   D

Complexity

Conditions 10
Paths 128

Size

Total Lines 40
Code Lines 28

Duplication

Lines 3
Ratio 7.5 %

Code Coverage

Tests 25
CRAP Score 10.1228

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 3
loc 40
ccs 25
cts 28
cp 0.8929
rs 4.606
cc 10
eloc 28
nc 128
nop 1
crap 10.1228

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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 779
    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 779
        $this->pb = $pb;
141 779
        $this->dm = $dm;
142 779
        $this->evm = $evm;
143 779
        $this->cm = $cm ?: new CriteriaMerger();
144 779
        $this->uow = $uow;
145 779
        $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 779
        $this->class = $class;
147 779
        $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 779
        $this->cp = $this->uow->getCollectionPersister();
149 779
    }
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 544
    public function addInsert($document)
175
    {
176 544
        $this->queuedInserts[spl_object_hash($document)] = $document;
177 544
    }
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 88
    public function addUpsert($document)
203
    {
204 88
        $this->queuedUpserts[spl_object_hash($document)] = $document;
205 88
    }
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 544
    public function executeInserts(array $options = array())
228
    {
229 544
        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 544
        $inserts = array();
234 544
        $options = $this->getWriteOptions($options);
235 544
        foreach ($this->queuedInserts as $oid => $document) {
236 544
            $data = $this->pb->prepareInsertData($document);
237
238
            // Set the initial version for each insert
239 543 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 543
            $inserts[$oid] = $data;
253
        }
254
255 543
        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 543
                $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 543
        foreach ($this->queuedInserts as $document) {
269 543
            $this->handleCollections($document, $options);
270
        }
271
272 543
        $this->queuedInserts = array();
273 543
    }
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 88
    public function executeUpserts(array $options = array())
285
    {
286 88
        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 88
        $options = $this->getWriteOptions($options);
291 88
        foreach ($this->queuedUpserts as $oid => $document) {
292
            try {
293 88
                $this->executeUpsert($document, $options);
294 88
                $this->handleCollections($document, $options);
295 88
                unset($this->queuedUpserts[$oid]);
296
            } catch (\MongoException $e) {
297
                unset($this->queuedUpserts[$oid]);
298 88
                throw $e;
299
            }
300
        }
301 88
    }
302
303
    /**
304
     * Executes a single upsert in {@link executeUpserts}
305
     *
306
     * @param object $document
307
     * @param array  $options
308
     */
309 88
    private function executeUpsert($document, array $options)
310
    {
311 88
        $options['upsert'] = true;
312 88
        $criteria = $this->getQueryForDocument($document);
313
314 88
        $data = $this->pb->prepareUpsertData($document);
315
316
        // Set the initial version for each upsert
317 88 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 88
        foreach (array_keys($criteria) as $field) {
331 88
            unset($data['$set'][$field]);
332
        }
333
334
        // Do not send an empty $set modifier
335 88
        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 88
        if (empty($data)) {
353 17
            $retry = true;
354 17
            $data = array('$set' => array('_id' => $criteria['_id']));
355
        }
356
357
        try {
358 88
            $this->collection->update($criteria, $data, $options);
359 88
            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 227
    public function update($document, array $options = array())
377
    {
378 227
        $update = $this->pb->prepareUpdateData($document);
379
380 227
        $query = $this->getQueryForDocument($document);
381
382 225
        foreach (array_keys($query) as $field) {
383 225
            unset($update['$set'][$field]);
384
        }
385
386 225
        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 225
        $nextVersion = null;
395 225
        if ($this->class->isVersioned) {
396 33
            $versionMapping = $this->class->fieldMappings[$this->class->versionField];
397 33
            $currentVersion = $this->class->reflFields[$this->class->versionField]->getValue($document);
398 33
            if ($versionMapping['type'] === 'int') {
399 30
                $nextVersion = $currentVersion + 1;
400 30
                $update['$inc'][$versionMapping['name']] = 1;
401 30
                $query[$versionMapping['name']] = $currentVersion;
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
            }
407
        }
408
409 225
        if ( ! empty($update)) {
410
            // Include locking logic so that if the document object in memory is currently
411
            // locked then it will remove it, otherwise it ensures the document is not locked.
412 157
            if ($this->class->isLockable) {
413 11
                $isLocked = $this->class->reflFields[$this->class->lockField]->getValue($document);
414 11
                $lockMapping = $this->class->fieldMappings[$this->class->lockField];
415 11
                if ($isLocked) {
416 2
                    $update['$unset'] = array($lockMapping['name'] => true);
417
                } else {
418 9
                    $query[$lockMapping['name']] = array('$exists' => false);
419
                }
420
            }
421
422 157
            $options = $this->getWriteOptions($options);
423
424 157
            $result = $this->collection->update($query, $update, $options);
425
426 157
            if (($this->class->isVersioned || $this->class->isLockable) && ! $result['n']) {
427 6
                throw LockException::lockFailed($document);
428 152
            } elseif ($this->class->isVersioned) {
429 28
                $this->class->reflFields[$this->class->versionField]->setValue($document, $nextVersion);
430
            }
431
        }
432
433 220
        $this->handleCollections($document, $options);
434 220
    }
435
436
    /**
437
     * Removes document from mongo
438
     *
439
     * @param mixed $document
440
     * @param array $options Array of options to be used with remove()
441
     * @throws \Doctrine\ODM\MongoDB\LockException
442
     */
443 35
    public function delete($document, array $options = array())
444
    {
445 35
        $query = $this->getQueryForDocument($document);
446
447 35
        if ($this->class->isLockable) {
448 2
            $query[$this->class->lockField] = array('$exists' => false);
449
        }
450
451 35
        $options = $this->getWriteOptions($options);
452
453 35
        $result = $this->collection->remove($query, $options);
454
455 35
        if (($this->class->isVersioned || $this->class->isLockable) && ! $result['n']) {
456 2
            throw LockException::lockFailed($document);
457
        }
458 33
    }
459
460
    /**
461
     * Refreshes a managed document.
462
     *
463
     * @param string $id
464
     * @param object $document The document to refresh.
465
     *
466
     * @deprecated The first argument is deprecated.
467
     */
468 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...
469
    {
470 22
        $query = $this->getQueryForDocument($document);
471 22
        $data = $this->collection->findOne($query);
472 22
        $data = $this->hydratorFactory->hydrate($document, $data);
473 22
        $this->uow->setOriginalDocumentData($document, $data);
474 22
    }
475
476
    /**
477
     * Finds a document by a set of criteria.
478
     *
479
     * If a scalar or MongoId is provided for $criteria, it will be used to
480
     * match an _id value.
481
     *
482
     * @param mixed   $criteria Query criteria
483
     * @param object  $document Document to load the data into. If not specified, a new document is created.
484
     * @param array   $hints    Hints for document creation
485
     * @param integer $lockMode
486
     * @param array   $sort     Sort array for Cursor::sort()
487
     * @throws \Doctrine\ODM\MongoDB\LockException
488
     * @return object|null The loaded and managed document instance or null if no document was found
489
     * @todo Check identity map? loadById method? Try to guess whether $criteria is the id?
490
     */
491 384
    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...
492
    {
493
        // TODO: remove this
494 384
        if ($criteria === null || is_scalar($criteria) || $criteria instanceof \MongoId) {
495
            $criteria = array('_id' => $criteria);
496
        }
497
498 384
        $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...
499 384
        $criteria = $this->addDiscriminatorToPreparedQuery($criteria);
500 384
        $criteria = $this->addFilterToPreparedQuery($criteria);
501
502 384
        $cursor = $this->collection->find($criteria);
503
504 384
        if (null !== $sort) {
505 105
            $cursor->sort($this->prepareSortOrProjection($sort));
506
        }
507
508 384
        $result = $cursor->getSingleResult();
509
510 384
        if ($this->class->isLockable) {
511 1
            $lockMapping = $this->class->fieldMappings[$this->class->lockField];
512 1
            if (isset($result[$lockMapping['name']]) && $result[$lockMapping['name']] === LockMode::PESSIMISTIC_WRITE) {
513 1
                throw LockException::lockFailed($result);
514
            }
515
        }
516
517 383
        return $this->createDocument($result, $document, $hints);
518
    }
519
520
    /**
521
     * Finds documents by a set of criteria.
522
     *
523
     * @param array        $criteria Query criteria
524
     * @param array        $sort     Sort array for Cursor::sort()
525
     * @param integer|null $limit    Limit for Cursor::limit()
526
     * @param integer|null $skip     Skip for Cursor::skip()
527
     * @return Cursor
528
     */
529 26
    public function loadAll(array $criteria = array(), array $sort = null, $limit = null, $skip = null)
530
    {
531 26
        $criteria = $this->prepareQueryOrNewObj($criteria);
532 26
        $criteria = $this->addDiscriminatorToPreparedQuery($criteria);
533 26
        $criteria = $this->addFilterToPreparedQuery($criteria);
534
535 26
        $baseCursor = $this->collection->find($criteria);
536 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...
537
538 26
        if (null !== $sort) {
539 3
            $cursor->sort($sort);
540
        }
541
542 26
        if (null !== $limit) {
543 2
            $cursor->limit($limit);
544
        }
545
546 26
        if (null !== $skip) {
547 2
            $cursor->skip($skip);
548
        }
549
550 26
        return $cursor;
551
    }
552
553
    /**
554
     * @param object $document
555
     *
556
     * @return array
557
     * @throws MongoDBException
558
     */
559 307
    private function getShardKeyQuery($document)
560
    {
561 307
        if ( ! $this->class->isSharded()) {
562 298
            return array();
563
        }
564
565 9
        $shardKey = $this->class->getShardKey();
566 9
        $keys = array_keys($shardKey['keys']);
567 9
        $data = $this->uow->getDocumentActualData($document);
568
569 9
        $shardKeyQueryPart = array();
570 9
        foreach ($keys as $key) {
571 9
            $mapping = $this->class->getFieldMappingByDbFieldName($key);
572 9
            $this->guardMissingShardKey($document, $key, $data);
573 7
            $value = Type::getType($mapping['type'])->convertToDatabaseValue($data[$mapping['fieldName']]);
574 7
            $shardKeyQueryPart[$key] = $value;
575
        }
576
577 7
        return $shardKeyQueryPart;
578
    }
579
580
    /**
581
     * Wraps the supplied base cursor in the corresponding ODM class.
582
     *
583
     * @param CursorInterface $baseCursor
584
     * @return Cursor
585
     */
586 26
    private function wrapCursor(CursorInterface $baseCursor)
587
    {
588 26
        return new Cursor($baseCursor, $this->dm->getUnitOfWork(), $this->class);
589
    }
590
591
    /**
592
     * Checks whether the given managed document exists in the database.
593
     *
594
     * @param object $document
595
     * @return boolean TRUE if the document exists in the database, FALSE otherwise.
596
     */
597 3
    public function exists($document)
598
    {
599 3
        $id = $this->class->getIdentifierObject($document);
600 3
        return (boolean) $this->collection->findOne(array('_id' => $id), array('_id'));
601
    }
602
603
    /**
604
     * Locks document by storing the lock mode on the mapped lock field.
605
     *
606
     * @param object $document
607
     * @param int $lockMode
608
     */
609 5
    public function lock($document, $lockMode)
610
    {
611 5
        $id = $this->uow->getDocumentIdentifier($document);
612 5
        $criteria = array('_id' => $this->class->getDatabaseIdentifierValue($id));
613 5
        $lockMapping = $this->class->fieldMappings[$this->class->lockField];
614 5
        $this->collection->update($criteria, array('$set' => array($lockMapping['name'] => $lockMode)));
615 5
        $this->class->reflFields[$this->class->lockField]->setValue($document, $lockMode);
616 5
    }
617
618
    /**
619
     * Releases any lock that exists on this document.
620
     *
621
     * @param object $document
622
     */
623 1
    public function unlock($document)
624
    {
625 1
        $id = $this->uow->getDocumentIdentifier($document);
626 1
        $criteria = array('_id' => $this->class->getDatabaseIdentifierValue($id));
627 1
        $lockMapping = $this->class->fieldMappings[$this->class->lockField];
628 1
        $this->collection->update($criteria, array('$unset' => array($lockMapping['name'] => true)));
629 1
        $this->class->reflFields[$this->class->lockField]->setValue($document, null);
630 1
    }
631
632
    /**
633
     * Creates or fills a single document object from an query result.
634
     *
635
     * @param object $result The query result.
636
     * @param object $document The document object to fill, if any.
637
     * @param array $hints Hints for document creation.
638
     * @return object The filled and managed document object or NULL, if the query result is empty.
639
     */
640 383
    private function createDocument($result, $document = null, array $hints = array())
641
    {
642 383
        if ($result === null) {
643 126
            return null;
644
        }
645
646 330
        if ($document !== null) {
647 38
            $hints[Query::HINT_REFRESH] = true;
648 38
            $id = $this->class->getPHPIdentifierValue($result['_id']);
649 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...
650
        }
651
652 330
        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...
653
    }
654
655
    /**
656
     * Loads a PersistentCollection data. Used in the initialize() method.
657
     *
658
     * @param PersistentCollectionInterface $collection
659
     */
660 173
    public function loadCollection(PersistentCollectionInterface $collection)
661
    {
662 173
        $mapping = $collection->getMapping();
663 173
        switch ($mapping['association']) {
664 173
            case ClassMetadata::EMBED_MANY:
665 119
                $this->loadEmbedManyCollection($collection);
666 119
                break;
667
668 71
            case ClassMetadata::REFERENCE_MANY:
669 71
                if (isset($mapping['repositoryMethod']) && $mapping['repositoryMethod']) {
670 5
                    $this->loadReferenceManyWithRepositoryMethod($collection);
671
                } else {
672 66
                    if ($mapping['isOwningSide']) {
673 55
                        $this->loadReferenceManyCollectionOwningSide($collection);
674
                    } else {
675 15
                        $this->loadReferenceManyCollectionInverseSide($collection);
676
                    }
677
                }
678 70
                break;
679
        }
680 172
    }
681
682 119
    private function loadEmbedManyCollection(PersistentCollectionInterface $collection)
683
    {
684 119
        $embeddedDocuments = $collection->getMongoData();
685 119
        $mapping = $collection->getMapping();
686 119
        $owner = $collection->getOwner();
687 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...
688 90
            foreach ($embeddedDocuments as $key => $embeddedDocument) {
689 90
                $className = $this->uow->getClassNameForAssociation($mapping, $embeddedDocument);
690 90
                $embeddedMetadata = $this->dm->getClassMetadata($className);
691 90
                $embeddedDocumentObject = $embeddedMetadata->newInstance();
692
693 90
                $this->uow->setParentAssociation($embeddedDocumentObject, $mapping, $owner, $mapping['name'] . '.' . $key);
694
695 90
                $data = $this->hydratorFactory->hydrate($embeddedDocumentObject, $embeddedDocument, $collection->getHints());
696 90
                $id = $embeddedMetadata->identifier && isset($data[$embeddedMetadata->identifier])
697 23
                    ? $data[$embeddedMetadata->identifier]
698 90
                    : null;
699
700 90
                if (empty($collection->getHints()[Query::HINT_READ_ONLY])) {
701 89
                    $this->uow->registerManaged($embeddedDocumentObject, $id, $data);
702
                }
703 90
                if (CollectionHelper::isHash($mapping['strategy'])) {
704 25
                    $collection->set($key, $embeddedDocumentObject);
705
                } else {
706 90
                    $collection->add($embeddedDocumentObject);
707
                }
708
            }
709
        }
710 119
    }
711
712 55
    private function loadReferenceManyCollectionOwningSide(PersistentCollectionInterface $collection)
713
    {
714 55
        $hints = $collection->getHints();
715 55
        $mapping = $collection->getMapping();
716 55
        $groupedIds = array();
717
718 55
        $sorted = isset($mapping['sort']) && $mapping['sort'];
719
720 55
        foreach ($collection->getMongoData() as $key => $reference) {
721 50
            $className = $this->uow->getClassNameForAssociation($mapping, $reference);
722 50
            $mongoId = ClassMetadataInfo::getReferenceId($reference, $mapping['storeAs']);
723 50
            $id = $this->dm->getClassMetadata($className)->getPHPIdentifierValue($mongoId);
724
725
            // create a reference to the class and id
726 50
            $reference = $this->dm->getReference($className, $id);
727
728
            // no custom sort so add the references right now in the order they are embedded
729 50
            if ( ! $sorted) {
730 49
                if (CollectionHelper::isHash($mapping['strategy'])) {
731 2
                    $collection->set($key, $reference);
732
                } else {
733 47
                    $collection->add($reference);
734
                }
735
            }
736
737
            // only query for the referenced object if it is not already initialized or the collection is sorted
738 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...
739 50
                $groupedIds[$className][] = $mongoId;
740
            }
741
        }
742 55
        foreach ($groupedIds as $className => $ids) {
743 35
            $class = $this->dm->getClassMetadata($className);
744 35
            $mongoCollection = $this->dm->getDocumentCollection($className);
745 35
            $criteria = $this->cm->merge(
746 35
                array('_id' => array('$in' => array_values($ids))),
747 35
                $this->dm->getFilterCollection()->getFilterCriteria($class),
748 35
                isset($mapping['criteria']) ? $mapping['criteria'] : array()
749
            );
750 35
            $criteria = $this->uow->getDocumentPersister($className)->prepareQueryOrNewObj($criteria);
751 35
            $cursor = $mongoCollection->find($criteria);
752 35
            if (isset($mapping['sort'])) {
753 35
                $cursor->sort($mapping['sort']);
754
            }
755 35
            if (isset($mapping['limit'])) {
756
                $cursor->limit($mapping['limit']);
757
            }
758 35
            if (isset($mapping['skip'])) {
759
                $cursor->skip($mapping['skip']);
760
            }
761 35
            if ( ! empty($hints[Query::HINT_SLAVE_OKAY])) {
0 ignored issues
show
Deprecated Code introduced by
The constant Doctrine\ODM\MongoDB\Query\Query::HINT_SLAVE_OKAY has been deprecated.

This class constant has been deprecated.

Loading history...
762
                $cursor->slaveOkay(true);
763
            }
764 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...
765
                $cursor->setReadPreference($hints[Query::HINT_READ_PREFERENCE], $hints[Query::HINT_READ_PREFERENCE_TAGS]);
766
            }
767 35
            $documents = $cursor->toArray(false);
768 35
            foreach ($documents as $documentData) {
769 34
                $document = $this->uow->getById($documentData['_id'], $class);
770 34
                if ($document instanceof Proxy && ! $document->__isInitialized()) {
771 34
                    $data = $this->hydratorFactory->hydrate($document, $documentData);
772 34
                    $this->uow->setOriginalDocumentData($document, $data);
773 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...
774
                }
775 34
                if ($sorted) {
776 35
                    $collection->add($document);
777
                }
778
            }
779
        }
780 55
    }
781
782 15
    private function loadReferenceManyCollectionInverseSide(PersistentCollectionInterface $collection)
783
    {
784 15
        $query = $this->createReferenceManyInverseSideQuery($collection);
785 15
        $documents = $query->execute()->toArray(false);
786 15
        foreach ($documents as $key => $document) {
787 14
            $collection->add($document);
788
        }
789 15
    }
790
791
    /**
792
     * @param PersistentCollectionInterface $collection
793
     *
794
     * @return Query
795
     */
796 18
    public function createReferenceManyInverseSideQuery(PersistentCollectionInterface $collection)
797
    {
798 18
        $hints = $collection->getHints();
799 18
        $mapping = $collection->getMapping();
800 18
        $owner = $collection->getOwner();
801 18
        $ownerClass = $this->dm->getClassMetadata(get_class($owner));
802 18
        $targetClass = $this->dm->getClassMetadata($mapping['targetDocument']);
803 18
        $mappedByMapping = isset($targetClass->fieldMappings[$mapping['mappedBy']]) ? $targetClass->fieldMappings[$mapping['mappedBy']] : array();
804 18
        $mappedByFieldName = ClassMetadataInfo::getReferenceFieldName(isset($mappedByMapping['storeAs']) ? $mappedByMapping['storeAs'] : ClassMetadataInfo::REFERENCE_STORE_AS_DB_REF, $mapping['mappedBy']);
805
806 18
        $criteria = $this->cm->merge(
807 18
            array($mappedByFieldName => $ownerClass->getIdentifierObject($owner)),
808 18
            $this->dm->getFilterCollection()->getFilterCriteria($targetClass),
809 18
            isset($mapping['criteria']) ? $mapping['criteria'] : array()
810
        );
811 18
        $criteria = $this->uow->getDocumentPersister($mapping['targetDocument'])->prepareQueryOrNewObj($criteria);
812 18
        $qb = $this->dm->createQueryBuilder($mapping['targetDocument'])
813 18
            ->setQueryArray($criteria);
814
815 18
        if (isset($mapping['sort'])) {
816 18
            $qb->sort($mapping['sort']);
817
        }
818 18
        if (isset($mapping['limit'])) {
819 2
            $qb->limit($mapping['limit']);
820
        }
821 18
        if (isset($mapping['skip'])) {
822
            $qb->skip($mapping['skip']);
823
        }
824 18
        if ( ! empty($hints[Query::HINT_SLAVE_OKAY])) {
0 ignored issues
show
Deprecated Code introduced by
The constant Doctrine\ODM\MongoDB\Query\Query::HINT_SLAVE_OKAY has been deprecated.

This class constant has been deprecated.

Loading history...
825
            $qb->slaveOkay(true);
0 ignored issues
show
Deprecated Code introduced by
The method Doctrine\ODM\MongoDB\Query\Builder::slaveOkay() has been deprecated with message: in version 1.2 - use setReadPreference instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
826
        }
827 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...
828
            $qb->setReadPreference($hints[Query::HINT_READ_PREFERENCE], $hints[Query::HINT_READ_PREFERENCE_TAGS]);
829
        }
830 18
        foreach ($mapping['prime'] as $field) {
831 4
            $qb->field($field)->prime(true);
832
        }
833
834 18
        return $qb->getQuery();
835
    }
836
837 5
    private function loadReferenceManyWithRepositoryMethod(PersistentCollectionInterface $collection)
838
    {
839 5
        $cursor = $this->createReferenceManyWithRepositoryMethodCursor($collection);
840 4
        $mapping = $collection->getMapping();
841 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...
842 4
        foreach ($documents as $key => $obj) {
843 4
            if (CollectionHelper::isHash($mapping['strategy'])) {
844 1
                $collection->set($key, $obj);
845
            } else {
846 4
                $collection->add($obj);
847
            }
848
        }
849 4
    }
850
851
    /**
852
     * @param PersistentCollectionInterface $collection
853
     *
854
     * @return CursorInterface
855
     */
856 6
    public function createReferenceManyWithRepositoryMethodCursor(PersistentCollectionInterface $collection)
857
    {
858 6
        $hints = $collection->getHints();
859 6
        $mapping = $collection->getMapping();
860 6
        $repositoryMethod = $mapping['repositoryMethod'];
861 6
        $cursor = $this->dm->getRepository($mapping['targetDocument'])
862 6
            ->$repositoryMethod($collection->getOwner());
863
864 6
        if ( ! $cursor instanceof CursorInterface) {
865
            throw new \BadMethodCallException("Expected repository method {$repositoryMethod} to return a CursorInterface");
866
        }
867
868 6
        if (!empty($mapping['prime'])) {
869 2
            if (!$cursor instanceof Cursor) {
870
                throw new \BadMethodCallException("Expected repository method {$repositoryMethod} to return a Cursor to allow for priming");
871
            }
872
873 2
            $referencePrimer = new ReferencePrimer($this->dm, $this->dm->getUnitOfWork());
874 2
            $primers = array_combine($mapping['prime'], array_fill(0, count($mapping['prime']), true));
875
876 2
            $cursor->enableReferencePriming($primers, $referencePrimer);
877
        }
878
879 5
        if (isset($mapping['sort'])) {
880 5
            $cursor->sort($mapping['sort']);
881
        }
882 5
        if (isset($mapping['limit'])) {
883 1
            $cursor->limit($mapping['limit']);
884
        }
885 5
        if (isset($mapping['skip'])) {
886
            $cursor->skip($mapping['skip']);
887
        }
888 5
        if ( ! empty($hints[Query::HINT_SLAVE_OKAY])) {
0 ignored issues
show
Deprecated Code introduced by
The constant Doctrine\ODM\MongoDB\Query\Query::HINT_SLAVE_OKAY has been deprecated.

This class constant has been deprecated.

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