-
Notifications
You must be signed in to change notification settings - Fork 46
Expand file tree
/
Copy pathCollection.php
More file actions
1627 lines (1429 loc) · 47 KB
/
Collection.php
File metadata and controls
1627 lines (1429 loc) · 47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* This file is part of the PHPMongo package.
*
* (c) Dmytro Sokil <dmytro.sokil@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Sokil\Mongo;
use Sokil\Mongo\Document\InvalidDocumentException;
use Sokil\Mongo\Exception\FeatureNotSupportedException;
use Sokil\Mongo\Collection\Definition;
use Sokil\Mongo\Enum\Language;
/**
* Instance of this class is a representation of mongo collection.
* It aggregates \MongoCollection instance.
*
* @link https://github.com/sokil/php-mongo#selecting-database-and-collection Selecting collection
* @link https://github.com/sokil/php-mongo#querying-documents Querying documents
* @link https://github.com/sokil/php-mongo#update-few-documents Update few documents
* @link https://github.com/sokil/php-mongo#deleting-collections-and-documents Deleting collection
*
* @author Dmytro Sokil <dmytro.sokil@gmail.com>
*/
class Collection implements \Countable
{
/**
* @var string fully qualified class name of collection
*/
protected $mongoCollectionClassName = '\MongoCollection';
/**
* @var string expression class. This class may be overloaded to define
* own query methods (whereUserAgeGreatedThan(), etc.)
* @deprecated since 1.13 Use 'expressionClass' declaration in mapping
*/
protected $_queryExpressionClass;
/**
* @deprecated since 1.13 Use 'documentClass' declaration in mapping
* @var string Default class for document
*/
private $documentClass;
/**
* List of arrays, where each item array is an index definition.
* Every index definition must contain key 'keys' with list of fields and orders,
* and optional options from @link http://php.net/manual/en/mongocollection.createindex.php:
*
* Example:
* array(
* array(
* 'keys' => array('field1' => 1, 'field2' => -1),
* 'unique' => true
* ),
* ...
* )
* @var array list of indexes
* @deprecated since 1.13 Use 'index' declaration in mapping
*/
protected $_index;
/**
*
* @var Database
*/
private $database;
/**
*
* @var \MongoCollection
*/
private $collection;
/**
* @var string
*/
private $collectionName;
/**
* Implementation of identity map pattern
*
* @var array list of cached documents
*/
private $documentPool = array();
/**
* @deprecated since 1.13 Use 'versioning' declaration in mapping
* @var bool default value of versioning
*/
protected $versioning;
/**
* @var \Sokil\Mongo\Collection\Definition collection options
*/
private $definition;
public function __construct(
Database $database,
$collection,
Definition $definition = null
) {
// define db
$this->database = $database;
// init mongo collection
if ($collection instanceof \MongoCollection) {
$this->collectionName = $collection->getName();
$this->collection = $collection;
} else {
$this->collectionName = $collection;
}
// init definition
$this->definition = $definition ? $definition : new Definition();
if (!empty($this->documentClass)) {
$this->definition->setOption('documentClass', $this->documentClass);
}
if ($this->versioning !== null) {
$this->definition->setOption('versioning', $this->versioning);
}
if (!empty($this->_index)) {
$this->definition->setOption('index', $this->_index);
}
if (!empty($this->_queryExpressionClass)) {
$this->definition->setOption('expressionClass', $this->_queryExpressionClass);
}
}
/**
* Start versioning documents on modify
*
* @deprecated since 1.13 Use 'versioning' declaration in mapping
* @return \Sokil\Mongo\Collection
*/
public function enableVersioning()
{
$this->definition->setOption('versioning', true);
return $this;
}
/**
* Check if versioning enabled
*
* @deprecated since 1.13 Use 'versioning' declaration in mapping
* @return bool
*/
public function isVersioningEnabled()
{
return $this->definition->getOption('versioning');
}
/**
* Get option
*
* @param string|int $name
* @return mixed
*/
public function getOption($name)
{
return $this->definition->getOption($name);
}
public function getOptions()
{
return $this->definition->getOptions();
}
public function __get($name)
{
// support of deprecated property, use selg::getMongoCollection instead
if ($name === '_mongoCollection') {
return $this->getMongoCollection();
}
return $this->getDocument($name);
}
/**
* Get name of collection
*
* @return string name of collection
*/
public function getName()
{
return $this->collectionName;
}
/**
* Get native collection instance of mongo driver
*
* @return \MongoCollection
*/
public function getMongoCollection()
{
if (empty($this->collection)) {
$mongoCollectionClassName = $this->mongoCollectionClassName;
$this->collection = new $mongoCollectionClassName(
$this->database->getMongoDB(),
$this->collectionName
);
}
return $this->collection;
}
/**
*
* @return \Sokil\Mongo\Database
*/
public function getDatabase()
{
return $this->database;
}
/**
* Delete collection
*
* @return \Sokil\Mongo\Collection
* @throws \Sokil\Mongo\Exception
*/
public function delete()
{
$status = $this->getMongoCollection()->drop();
// Drop function in mongodb >= 3.6 with unacknowledged write concern return empty result
if ($status === array()) {
$writeConcern = $this->getWriteConcern();
$status = ($writeConcern['w'] === 0 ? array('ok' => 1):array('ok' => 0, 'errmsg' => 'unknown error'));
}
if ($status['ok'] != 1) {
// check if collection exists
if ('ns not found' !== $status['errmsg']) {
// collection exist
throw new Exception('Error deleting collection ' . $this->getName() . ': ' . $status['errmsg']);
}
}
return $this;
}
/**
* Override to define class name of document by document data
*
* @param array $documentData
* @return string Document class data
*/
public function getDocumentClassName(array $documentData = null)
{
$documentClass = $this->definition->getOption('documentClass');
if (is_callable($documentClass)) {
return call_user_func($documentClass, $documentData);
}
if (class_exists($documentClass)) {
return $documentClass;
}
throw new Exception('Property "documentClass" must be callable or valid name of class');
}
/**
* Factory method to get not stored Document instance from array
*
* @param array $data
*
* @return Document
*
* @throws Exception
*/
public function createDocument(array $data = null)
{
$className = $this->getDocumentClassName($data);
/* @var $document \Sokil\Mongo\Document */
$document = new $className(
$this,
$data,
array('stored' => false) + $this->definition->getOptions()
);
// store document to identity map
if ($this->isDocumentPoolEnabled()) {
$collection = $this;
$document->onAfterInsert(function (\Sokil\Mongo\Event $event) use ($collection) {
$collection->addDocumentToDocumentPool($event->getTarget());
});
}
return $document;
}
/**
* Factory method to get document object from array of stored document
*
* @param array $data
* @return \Sokil\Mongo\Document
*/
public function hydrate($data, $useDocumentPool = true)
{
if (!is_array($data) || !isset($data['_id'])) {
throw new Exception('Document must be stored and has _id key');
}
// if document already in pool - return it
if ($useDocumentPool && $this->isDocumentPoolEnabled() && $this->isDocumentInDocumentPool($data['_id'])) {
return $this
->getDocumentFromDocumentPool($data['_id'])
->mergeUnmodified($data);
}
// init document instance
$className = $this->getDocumentClassName($data);
$document = new $className(
$this,
$data,
array('stored' => true) + $this->definition->getOptions()
);
// store document in cache
if ($useDocumentPool && $this->isDocumentPoolEnabled()) {
$this->addDocumentToDocumentPool($document);
}
return $document;
}
/**
* Total count of documents in collection
*
* @return int
*/
public function count()
{
return $this->find()->count();
}
/**
* Retrieve a list of distinct values for the given key across a collection.
*
* @param string $selector field selector
* @param array|callable|\Sokil\Mongo\Expression $expression expression to search documents
* @return array distinct values
*/
public function getDistinct($selector, $expression = null)
{
if ($expression) {
return $this->getMongoCollection()->distinct(
$selector,
Expression::convertToArray($expression)
);
}
return $this->getMongoCollection()->distinct($selector);
}
/**
* Create new Expression instance to use in query builder or update operations
*
* @return \Sokil\Mongo\Expression
*/
public function expression()
{
$className = $this->definition->getExpressionClass();
return new $className;
}
/**
* Create Operator instance to use in update operations
*
* @return \Sokil\Mongo\Operator
*/
public function operator()
{
return new Operator();
}
/**
* Create document query builder
*
* @param $callable callable|null Function to configure query builder&
*
* @return Cursor
*/
public function find($callable = null)
{
/** @var Cursor $cursor */
$cursor = new Cursor($this, array(
'expressionClass' => $this->definition->getExpressionClass(),
'batchSize' => $this->definition->getOption('batchSize'),
'clientTimeout' => $this->definition->getOption('cursorClientTimeout'),
'serverTimeout' => $this->definition->getOption('cursorServerTimeout'),
));
if (is_callable($callable)) {
$callable($cursor->getExpression());
}
return $cursor;
}
/**
* Create document query builder
*
* @param callable|null $callable
*
* @return \Sokil\Mongo\Cursor
*/
public function findAsArray($callable = null)
{
return $this
->find($callable)
->asArray();
}
/**
* Stop storing found documents to pool
*
* @return \Sokil\Mongo\Collection
*/
public function disableDocumentPool()
{
$this->definition->setOption('documentPool', false);
return $this;
}
/**
* Start storing found documents to pool
*
* @return \Sokil\Mongo\Collection
*/
public function enableDocumentPool()
{
$this->definition->setOption('documentPool', true);
return $this;
}
/**
* Check if document pool enabled and requested documents store to it
*
* @return bool
*/
public function isDocumentPoolEnabled()
{
return $this->definition->getOption('documentPool');
}
public function clearDocumentPool()
{
$this->documentPool = array();
return $this;
}
/**
* Check if documents are in pool
*
* @return bool
*/
public function isDocumentPoolEmpty()
{
return !$this->documentPool;
}
/**
* Store document to pool
*
* @param array $document
* @return \Sokil\Mongo\Collection
*/
public function addDocumentToDocumentPool(Document $document)
{
$documentId = (string) $document->getId();
if (!isset($this->documentPool[$documentId])) {
$this->documentPool[$documentId] = $document;
} else {
// merging because document after
// load and before getting in second place may be changed
// and this changes must be preserved:
//
// 1. Document loads and modifies in current session
// 2. Document loads modified in another session
// 3. Document loads once again in current session. Changes from stage 2 merges as unmodified
$this->documentPool[$documentId]->mergeUnmodified($document->toArray());
}
return $this;
}
/**
* Store documents to identity map
*
* @param array $documents list of Document instances
* @return \Sokil\Mongo\Collection
*/
public function addDocumentsToDocumentPool(array $documents)
{
foreach ($documents as $document) {
$this->addDocumentToDocumentPool($document);
}
return $this;
}
/**
* Remove document instance from identity map
*
* @param \Sokil\Mongo\Document $document
* @return \Sokil\Mongo\Collection
*/
public function removeDocumentFromDocumentPool(Document $document)
{
unset($this->documentPool[(string) $document]);
return $this;
}
/**
* Get document from identity map by it's id
*
* @param string|int|\MongoId $id
* @return \Sokil\Mongo\Document
*/
public function getDocumentFromDocumentPool($id)
{
return $this->documentPool[(string) $id];
}
/**
* Get documents from pool if they stored
*
* @param array $ids
*/
public function getDocumentsFromDocumentPool(array $ids = null)
{
if (!$ids) {
return $this->documentPool;
}
return array_intersect_key(
$this->documentPool,
array_flip(array_map('strval', $ids))
);
}
/**
* Get number of documents in document pool
*
* @return int
*/
public function documentPoolCount()
{
return count($this->documentPool);
}
/**
* Check if document exists in identity map
*
* @param \Sokil\Mongo\Document|\MongoId|int|string $document Document instance or it's id
* @return boolean
*/
public function isDocumentInDocumentPool($document)
{
if ($document instanceof Document) {
$document = $document->getId();
}
return isset($this->documentPool[(string) $document]);
}
/**
* Get document by id
* If callable specified, document always loaded directly omitting document pool.
* Method may return document as array if cursor configured through Cursor::asArray()
*
* @param string|\MongoId $id
* @param callable $callable cursor callable used to configure cursor
* @return \Sokil\Mongo\Document|array|null
*/
public function getDocument($id, $callable = null)
{
if (!$this->isDocumentPoolEnabled()) {
return $this->getDocumentDirectly($id, $callable);
}
if (!$callable && $this->isDocumentInDocumentPool($id)) {
return $this->getDocumentFromDocumentPool($id);
}
$document = $this->getDocumentDirectly($id, $callable);
// if callable configure cursor to return document as array,
// than it can't be stored to document pool
if ($document instanceof Document) {
$this->addDocumentToDocumentPool($document);
}
return $document;
}
/**
* Get Document instance by it's reference
*
* @param array $ref reference to document
* @param bool $useDocumentPool try to get document from pool or fetch document from database
*
* @return Document|null
*/
public function getDocumentByReference(array $ref, $useDocumentPool = true)
{
$documentArray = $this->getMongoCollection()->getDBRef($ref);
if (null === $documentArray) {
return null;
}
return $this->hydrate($documentArray, $useDocumentPool);
}
/**
* Get document by id directly omitting cache
* Method may return document as array if cursor configured through Cursor::asArray()
*
* @param string|\MongoId $id
* @param callable $callable cursor callable used to configure cursor
* @return \Sokil\Mongo\Document|array|null
*/
public function getDocumentDirectly($id, $callable = null)
{
$cursor = $this->find();
if (is_callable($callable)) {
call_user_func($callable, $cursor);
}
return $cursor
->byId($id)
->skipDocumentPool()
->findOne();
}
/**
* Check if document belongs to collection
*
* @param Document $document
*
* @return bool
*/
public function hasDocument(Document $document)
{
$documentCollection = $document->getCollection();
$documentDatabase = $documentCollection->getDatabase();
// check connection
if ($documentDatabase->getClient()->getDsn() !== $this->getDatabase()->getClient()->getDsn()) {
return false;
}
// check database
if ($documentDatabase->getName() !== $this->getDatabase()->getName()) {
return false;
}
// check collection
return $documentCollection->getName() == $this->getName();
}
/**
* Get documents by list of id
*
* @param array $idList list of ids
* @param callable $callable cursor callable used to configure cursor
*
* @return Document[]
*/
public function getDocuments(array $idList, $callable = null)
{
$idListToFindDirectly = $idList;
// try to egt document from pool if enabled
$documentsInDocumentPool = array();
if ($this->isDocumentPoolEnabled() && !$callable) {
$documentsInDocumentPool = $this->getDocumentsFromDocumentPool($idList);
if (count($documentsInDocumentPool) === count($idList)) {
return $documentsInDocumentPool;
}
// skip ids already found in pool
$idListToFindDirectly = array_diff_key(
array_map('strval', $idList),
array_keys($documentsInDocumentPool)
);
}
// get documents directly
$cursor = $this->find();
if (is_callable($callable)) {
call_user_func($callable, $cursor);
}
$documentsGettingDirectly = $cursor->byIdList($idListToFindDirectly)->findAll();
if (empty($documentsGettingDirectly)) {
return $documentsInDocumentPool ? $documentsInDocumentPool : array();
}
if ($this->isDocumentPoolEnabled()) {
$this->addDocumentsToDocumentPool($documentsGettingDirectly);
}
return $documentsGettingDirectly + $documentsInDocumentPool;
}
/**
* Creates batch insert operation handler
* @param int|string $writeConcern Write concern. Default is 1 (Acknowledged)
* @param int $timeout Timeout for write concern. Default is 10000 milliseconds
* @param bool $ordered Determins if MongoDB must apply this batch in order (sequentally,
* one item at a time) or can rearrange it. Defaults to TRUE
* @return BatchInsert
*/
public function createBatchInsert($writeConcern = null, $timeout = null, $ordered = null)
{
return new BatchInsert(
$this,
$writeConcern,
$timeout,
$ordered
);
}
/**
* Creates batch update operation handler
* @param int|string $writeConcern Write concern. Default is 1 (Acknowledged)
* @param int $timeout Timeout for write concern. Default is 10000 milliseconds
* @param bool $ordered Determins if MongoDB must apply this batch in order (sequentally,
* one item at a time) or can rearrange it. Defaults to TRUE
* @return BatchUpdate
*/
public function createBatchUpdate($writeConcern = null, $timeout = null, $ordered = null)
{
return new BatchUpdate(
$this,
$writeConcern,
$timeout,
$ordered
);
}
/**
* Creates batch delete operation handler
* @param int|string $writeConcern Write concern. Default is 1 (Acknowledged)
* @param int $timeout Timeout for write concern. Default is 10000 milliseconds
* @param bool $ordered Determins if MongoDB must apply this batch in order (sequentally,
* one item at a time) or can rearrange it. Defaults to TRUE
* @return BatchDelete
*/
public function createBatchDelete($writeConcern = null, $timeout = null, $ordered = null)
{
return new BatchDelete(
$this,
$writeConcern,
$timeout,
$ordered
);
}
/**
* @deprecated since 1.13. Use Document::delete()
* @param \Sokil\Mongo\Document $document
* @return \Sokil\Mongo\Collection
*/
public function deleteDocument(Document $document)
{
$document->delete();
return $this;
}
/**
* Delete documents by expression
*
* @param Expression|callable|array $expression
*
* @return Collection
*
* @throws Exception
*/
public function batchDelete($expression)
{
// remove
$result = $this->getMongoCollection()->remove(
Expression::convertToArray($expression)
);
// check result
if (true !== $result && $result['ok'] != 1) {
throw new Exception('Error removing documents from collection: ' . $result['err']);
}
return $this;
}
/**
* @deprecated since 1.13. Use Collection::batchDelete();
*
* @param Expression|callable|array $expression
*
* @return Collection
*
* @throws Exception
*
*/
public function deleteDocuments($expression = array())
{
return $this->batchDelete($expression);
}
/**
* Insert multiple documents defined as arrays
*
* Prior to version 1.5.0 of the driver it was possible to use MongoCollection::batchInsert(),
* however, as of 1.5.0 that method is now discouraged.
*
* You can use Collection::createBatchInsert()
*
* @param array $rows list of documents to insert, defined as arrays
* @return \Sokil\Mongo\Collection
* @throws \Sokil\Mongo\Document\InvalidDocumentException
* @throws \Sokil\Mongo\Exception
*/
public function batchInsert($rows, $validate = true)
{
if ($validate) {
$document = $this->createDocument();
foreach ($rows as $row) {
$document->merge($row);
if (!$document->isValid()) {
throw new InvalidDocumentException('Document is invalid on batch insert');
}
$document->reset();
}
}
$result = $this->getMongoCollection()->batchInsert($rows);
// If the w parameter is set to acknowledge the write,
// returns an associative array with the status of the inserts ("ok")
// and any error that may have occurred ("err").
if (is_array($result)) {
if ($result['ok'] != 1) {
throw new Exception('Batch insert error: ' . $result['err']);
}
return $this;
}
// Otherwise, returns TRUE if the batch insert was successfully sent,
// FALSE otherwise.
if (!$result) {
throw new Exception('Batch insert error');
}
return $this;
}
/**
* @deprecated since 1.13 Use Collection::batchInsert()
*/
public function insertMultiple($rows, $validate = true)
{
return $this->batchInsert($rows, $validate);
}
/**
* Direct insert of array to MongoDB without creating document object and validation
*
* @param array $document
* @return \Sokil\Mongo\Collection
* @throws Exception
*/
public function insert(array $document)
{
$result = $this->getMongoCollection()->insert($document);
// if write concern acknowledged
if (is_array($result)) {
if ($result['ok'] != 1) {
throw new Exception('Insert error: ' . $result['err'] . ': ' . $result['errmsg']);
}
return $this;
}
// if write concern unacknowledged
if (!$result) {
throw new Exception('Insert error');
}
return $this;
}
/**
* Update multiple documents
*
* @param \Sokil\Mongo\Expression|array|callable $expression expression to define
* which documents will change.
* @param \Sokil\Mongo\Operator|array|callable $updateData new data or operators to update
* @param array $options update options, see http://php.net/manual/ru/mongocollection.update.php
* @return \Sokil\Mongo\Collection
* @throws \Sokil\Mongo\Exception
*/
public function update($expression, $updateData, array $options = array())
{
// execute update operator
$result = $this->getMongoCollection()->update(
Expression::convertToArray($expression),
Operator::convertToArray($updateData),
$options
);
// if write concern acknowledged
if (is_array($result)) {
if ($result['ok'] != 1) {
throw new Exception(sprintf('Update error: %s: %s', $result['err'], $result['errmsg']));
}
return $this;
}
// if write concern unacknowledged
if (!$result) {
throw new Exception('Update error');
}
return $this;
}
/**
* Update multiple documents
*
* @param \Sokil\Mongo\Expression|array|callable $expression expression to define
* which documents will change.
* @param \Sokil\Mongo\Operator|array|callable $updateData new data or operators
* to update
* @return \Sokil\Mongo\Collection
* @throws \Sokil\Mongo\Exception
*/
public function batchUpdate($expression, $updateData)
{
return $this->update($expression, $updateData, array(
'multiple' => true,
));
}
/**
* @deprecated since 1.13 Use Collection::batchUpdate()
*/
public function updateMultiple($expression, $updateData)
{
return $this->batchUpdate($expression, $updateData);
}
/**
* Update all documents
*
* @deprecated since 1.13. Use Collection::batchUpdate([])
* @param \Sokil\Mongo\Operator|array|callable $updateData new data or operators
* @return \Sokil\Mongo\Collection
* @throws \Sokil\Mongo\Exception
*/
public function updateAll($updateData)
{
return $this->update(array(), $updateData, array(
'multiple' => true,
));
}
/**
* Start aggregation
*
* @link http://docs.mongodb.org/manual/reference/operator/aggregation/
* @return \Sokil\Mongo\Pipeline
*/
public function createAggregator()
{
return new Pipeline($this);
}
/**