-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Table.php
1575 lines (1450 loc) · 48.5 KB
/
Table.php
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
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\ORM;
use Cake\Core\App;
use Cake\Database\Schema\Table as Schema;
use Cake\Database\Type;
use Cake\Event\Event;
use Cake\Event\EventListener;
use Cake\Event\EventManager;
use Cake\ORM\Associations;
use Cake\ORM\Association\BelongsTo;
use Cake\ORM\Association\BelongsToMany;
use Cake\ORM\Association\HasMany;
use Cake\ORM\Association\HasOne;
use Cake\ORM\BehaviorRegistry;
use Cake\ORM\Entity;
use Cake\ORM\Error\MissingEntityException;
use Cake\ORM\Marshaller;
use Cake\Utility\Inflector;
use Cake\Validation\Validator;
/**
* Represents a single database table.
*
* Exposes methods for retrieving data out of it, and manages the associations
* this table has to other tables. Multiple instances of this class can be created
* for the same database table with different aliases, this allows you to address
* your database structure in a richer and more expressive way.
*
* ### Retrieving data
*
* The primary way to retrieve data is using Table::find(). See that method
* for more information.
*
* ### Dynamic finders
*
* In addition to the standard find($type) finder methods, CakePHP provides dynamic
* finder methods. These methods allow you to easily set basic conditions up. For example
* to filter users by username you would call
*
* {{{
* $query = $users->findByUsername('mark');
* }}}
*
* You can also combine conditions on multiple fields using either `Or` or `And`:
*
* {{{
* $query = $users->findByUsernameOrEmail('mark', 'mark@example.org');
* }}}
*
* ### Bulk updates/deletes
*
* You can use Table::updateAll() and Table::deleteAll() to do bulk updates/deletes.
* You should be aware that events will *not* be fired for bulk updates/deletes.
*
* ### Callbacks/events
*
* Table objects provide a few callbacks/events you can hook into to augment/replace
* find operations. Each event uses the standard event subsystem in CakePHP
*
* - `beforeFind($event, $query, $options)` - Fired before each find operation. By stopping
* the event and supplying a return value you can bypass the find operation entirely. Any
* changes done to the $query instance will be retained for the rest of the find.
* - `beforeValidate($event, $entity, $options, $validator)` - Fired before an entity is validated.
* By stopping this event, you can abort the validate + save operations.
* - `afterValidate($event, $entity, $options, $validator)` - Fired after an entity is validated.
* - `beforeSave($event, $entity, $options)` - Fired before each entity is saved. Stopping this
* event will abort the save operation. When the event is stopped the result of the event will
* be returned.
* - `afterSave($event, $entity, $options)` - Fired after an entity is saved.
* - `beforeDelete($event, $entity, $options)` - Fired before an entity is deleted.
* By stopping this event you will abort the delete operation.
* - `afterDelete($event, $entity, $options)` - Fired after an entity has been deleted.
*
* @see Cake\Event\EventManager for reference on the events system.
*/
class Table implements EventListener {
/**
* Name of the table as it can be found in the database
*
* @var string
*/
protected $_table;
/**
* Human name giving to this particular instance. Multiple objects representing
* the same database table can exist by using different aliases.
*
* @var string
*/
protected $_alias;
/**
* Connection instance
*
* @var \Cake\Database\Connection
*/
protected $_connection;
/**
* The schema object containing a description of this table fields
*
* @var \Cake\Database\Schema\Table
*/
protected $_schema;
/**
* The name of the field that represents the primary key in the table
*
* @var array
*/
protected $_primaryKey;
/**
* The name of the field that represents a human readable representation of a row
*
* @var string
*/
protected $_displayField;
/**
* The associations container for this Table.
*
* @var Cake\ORM\Associations
*/
protected $_associated;
/**
* EventManager for this table.
*
* All model/behavior callbacks will be dispatched on this manager.
*
* @var Cake\Event\EventManager
*/
protected $_eventManager;
/**
* BehaviorRegistry for this table
*
* @var Cake\ORM\BehaviorRegistry
*/
protected $_behaviors;
/**
* The name of the class that represent a single row for this table
*
* @var string
*/
protected $_entityClass;
/**
* A list of validation objects indexed by name
*
* @var array
*/
protected $_validators = [];
/**
* Initializes a new instance
*
* The $config array understands the following keys:
*
* - table: Name of the database table to represent
* - alias: Alias to be assigned to this table (default to table name)
* - connection: The connection instance to use
* - entityClass: The fully namespaced class name of the entity class that will
* represent rows in this table.
* - schema: A \Cake\Database\Schema\Table object or an array that can be
* passed to it.
* - eventManager: An instance of an event manager to use for internal events
* - behaviors: A BehaviorRegistry. Generally not used outside of tests.
*
* @param array config Lsit of options for this table
* @return void
*/
public function __construct(array $config = []) {
if (!empty($config['table'])) {
$this->table($config['table']);
}
if (!empty($config['alias'])) {
$this->alias($config['alias']);
}
if (!empty($config['connection'])) {
$this->connection($config['connection']);
}
if (!empty($config['schema'])) {
$this->schema($config['schema']);
}
if (!empty($config['entityClass'])) {
$this->entityClass($config['entityClass']);
}
$eventManager = $behaviors = null;
if (!empty($config['eventManager'])) {
$eventManager = $config['eventManager'];
}
if (!empty($config['behaviors'])) {
$behaviors = $config['behaviors'];
}
$associations = null;
if (!empty($config['associations'])) {
$associations = $config['associations'];
}
$this->_eventManager = $eventManager ?: new EventManager();
$this->_associated = $associations ?: new Associations();
$this->_behaviors = $behaviors ?: new BehaviorRegistry($this);
$this->initialize($config);
$this->_eventManager->attach($this);
}
/**
* Get the default connection name.
*
* This method is used to get the fallback connection name if an
* instance is created through the TableRegistry without a connection.
*
* @return string
* @see Cake\ORM\TableRegistry::get()
*/
public static function defaultConnectionName() {
return 'default';
}
/**
* Initialize a table instance. Called after the constructor.
*
* You can use this method to define associations, attach behaviors
* define validation and do any other initialization logic you need.
*
* {{{
* public function initialize(array $config) {
* $this->belongsTo('Users');
* $this->belongsToMany('Tagging.Tags');
* $this->primaryKey('something_else');
* }
* }}}
*
* @param array $config Configuration options passed to the constructor
* @return void
*/
public function initialize(array $config) {
}
/**
* Returns the database table name or sets a new one
*
* @param string $table the new table name
* @return string
*/
public function table($table = null) {
if ($table !== null) {
$this->_table = $table;
}
if ($this->_table === null) {
$table = namespaceSplit(get_class($this));
$table = substr(end($table), 0, -5);
if (empty($table)) {
$table = $this->alias();
}
$this->_table = Inflector::underscore($table);
}
return $this->_table;
}
/**
* Returns the table alias or sets a new one
*
* @param string $table the new table alias
* @return string
*/
public function alias($alias = null) {
if ($alias !== null) {
$this->_alias = $alias;
}
if ($this->_alias === null) {
$alias = namespaceSplit(get_class($this));
$alias = substr(end($alias), 0, -5) ?: $this->_table;
$this->_alias = $alias;
}
return $this->_alias;
}
/**
* Returns the connection instance or sets a new one
*
* @param \Cake\Database\Connection $conn the new connection instance
* @return \Cake\Database\Connection
*/
public function connection($conn = null) {
if ($conn === null) {
return $this->_connection;
}
return $this->_connection = $conn;
}
/**
* Get the event manager for this Table.
*
* @return Cake\Event\EventManager
*/
public function getEventManager() {
return $this->_eventManager;
}
/**
* Returns the schema table object describing this table's properties.
*
* If an \Cake\Database\Schema\Table is passed, it will be used for this table
* instead of the default one.
*
* If an array is passed, a new \Cake\Database\Schema\Table will be constructed
* out of it and used as the schema for this table.
*
* @param array|\Cake\Database\Schema\Table new schema to be used for this table
* @return \Cake\Database\Schema\Table
*/
public function schema($schema = null) {
if ($schema === null) {
if ($this->_schema === null) {
$this->_schema = $this->connection()
->schemaCollection()
->describe($this->table());
}
return $this->_schema;
}
if (is_array($schema)) {
$constraints = [];
if (isset($schema['_constraints'])) {
$constraints = $schema['_constraints'];
unset($schema['_constraints']);
}
$schema = new Schema($this->table(), $schema);
foreach ($constraints as $name => $value) {
$schema->addConstraint($name, $value);
}
}
return $this->_schema = $schema;
}
/**
* Test to see if a Table has a specific field/column.
*
* Delegates to the schema object and checks for column presence
* using the Schema\Table instance.
*
* @param string $field The field to check for.
* @return boolean True if the field exists, false if it does not.
*/
public function hasField($field) {
$schema = $this->schema();
return $schema->column($field) !== null;
}
/**
* Returns the primary key field name or sets a new one
*
* @param string $key sets a new name to be used as primary key
* @return string
*/
public function primaryKey($key = null) {
if ($key !== null) {
$this->_primaryKey = $key;
}
if ($this->_primaryKey === null) {
$key = current((array)$this->schema()->primaryKey());
$this->_primaryKey = $key ?: null;
}
return $this->_primaryKey;
}
/**
* Returns the display field or sets a new one
*
* @param string $key sets a new name to be used as display field
* @return string
*/
public function displayField($key = null) {
if ($key !== null) {
$this->_displayField = $key;
}
if ($this->_displayField === null) {
$schema = $this->schema();
$this->_displayField = $this->primaryKey();
if ($schema->column('title')) {
$this->_displayField = 'title';
}
if ($schema->column('name')) {
$this->_displayField = 'name';
}
}
return $this->_displayField;
}
/**
* Returns the class used to hydrate rows for this table or sets
* a new one
*
* @param string $name the name of the class to use
* @throws \Cake\ORM\Error\MissingEntityException when the entity class cannot be found
* @return string
*/
public function entityClass($name = null) {
if ($name === null && !$this->_entityClass) {
$default = '\Cake\ORM\Entity';
$self = get_called_class();
$parts = explode('\\', $self);
if ($self === __CLASS__ || count($parts) < 3) {
return $this->_entityClass = $default;
}
$alias = Inflector::singularize(substr(array_pop($parts), 0, -5));
$name = implode('\\', array_slice($parts, 0, -1)) . '\Entity\\' . $alias;
if (!class_exists($name)) {
return $this->_entityClass = $default;
}
}
if ($name !== null) {
$class = App::classname($name, 'Model/Entity');
$this->_entityClass = $class;
}
if (!$this->_entityClass) {
throw new MissingEntityException([$name]);
}
return $this->_entityClass;
}
/**
* Add a behavior.
*
* Adds a behavior to this table's behavior collection. Behaviors
* provide an easy way to create horizontally re-usable features
* that can provide trait like functionality, and allow for events
* to be listened to.
*
* Example:
*
* Load a behavior, with some settings.
*
* {{{
* $this->addBehavior('Tree', ['parent' => 'parentId']);
* }}}
*
* Behaviors are generally loaded during Table::initialize().
*
* @param string $name The name of the behavior. Can be a short class reference.
* @param array $options The options for the behavior to use.
* @return void
* @see Cake\ORM\Behavior
*/
public function addBehavior($name, $options = []) {
$this->_behaviors->load($name, $options);
}
/**
* Get the list of Behaviors loaded.
*
* This method will return the *aliases* of the behaviors attached
* to this instance.
*
* @return array
*/
public function behaviors() {
return $this->_behaviors->loaded();
}
/**
* Check if a behavior with the given alias has been loaded.
*
* @param string $name The behavior alias to check.
* @return array
*/
public function hasBehavior($name) {
return $this->_behaviors->loaded($name);
}
/**
* Returns a association objected configured for the specified alias if any
*
* @param string $name the alias used for the association
* @return Cake\ORM\Association
*/
public function association($name) {
return $this->_associated->get($name);
}
/**
* Creates a new BelongsTo association between this table and a target
* table. A "belongs to" association is a N-1 relationship where this table
* is the N side, and where there is a single associated record in the target
* table for each one in this table.
*
* Target table can be inferred by its name, which is provided in the
* first argument, or you can either pass the to be instantiated or
* an instance of it directly.
*
* The options array accept the following keys:
*
* - className: The class name of the target table object
* - targetTable: An instance of a table object to be used as the target table
* - foreignKey: The name of the field to use as foreign key, if false none
* will be used
* - conditions: array with a list of conditions to filter the join with
* - joinType: The type of join to be used (e.g. INNER)
*
* This method will return the association object that was built.
*
* @param string $associated the alias for the target table. This is used to
* uniquely identify the association
* @param array $options list of options to configure the association definition
* @return Cake\ORM\Association\BelongsTo
*/
public function belongsTo($associated, array $options = []) {
$options += ['sourceTable' => $this];
$association = new BelongsTo($associated, $options);
return $this->_associated->add($association->name(), $association);
}
/**
* Creates a new HasOne association between this table and a target
* table. A "has one" association is a 1-1 relationship.
*
* Target table can be inferred by its name, which is provided in the
* first argument, or you can either pass the class name to be instantiated or
* an instance of it directly.
*
* The options array accept the following keys:
*
* - className: The class name of the target table object
* - targetTable: An instance of a table object to be used as the target table
* - foreignKey: The name of the field to use as foreign key, if false none
* will be used
* - dependent: Set to true if you want CakePHP to cascade deletes to the
* associated table when an entity is removed on this table. Set to false
* if you don't want CakePHP to remove associated data, for when you are using
* database constraints.
* - cascadeCallbacks: Set to true if you want CakePHP to fire callbacks on
* cascaded deletes. If false the ORM will use deleteAll() to remove data.
* When true records will be loaded and then deleted.
* - conditions: array with a list of conditions to filter the join with
* - joinType: The type of join to be used (e.g. LEFT)
*
* This method will return the association object that was built.
*
* @param string $associated the alias for the target table. This is used to
* uniquely identify the association
* @param array $options list of options to configure the association definition
* @return Cake\ORM\Association\HasOne
*/
public function hasOne($associated, array $options = []) {
$options += ['sourceTable' => $this];
$association = new HasOne($associated, $options);
return $this->_associated->add($association->name(), $association);
}
/**
* Creates a new HasMany association between this table and a target
* table. A "has many" association is a 1-N relationship.
*
* Target table can be inferred by its name, which is provided in the
* first argument, or you can either pass the class name to be instantiated or
* an instance of it directly.
*
* The options array accept the following keys:
*
* - className: The class name of the target table object
* - targetTable: An instance of a table object to be used as the target table
* - foreignKey: The name of the field to use as foreign key, if false none
* will be used
* - dependent: Set to true if you want CakePHP to cascade deletes to the
* associated table when an entity is removed on this table. Set to false
* if you don't want CakePHP to remove associated data, for when you are using
* database constraints.
* - cascadeCallbacks: Set to true if you want CakePHP to fire callbacks on
* cascaded deletes. If false the ORM will use deleteAll() to remove data.
* When true records will be loaded and then deleted.
* - conditions: array with a list of conditions to filter the join with
* - sort: The order in which results for this association should be returned
* - strategy: The strategy to be used for selecting results Either 'select'
* or 'subquery'. If subquery is selected the query used to return results
* in the source table will be used as conditions for getting rows in the
* target table.
*
* This method will return the association object that was built.
*
* @param string $associated the alias for the target table. This is used to
* uniquely identify the association
* @param array $options list of options to configure the association definition
* @return Cake\ORM\Association\HasMany
*/
public function hasMany($associated, array $options = []) {
$options += ['sourceTable' => $this];
$association = new HasMany($associated, $options);
return $this->_associated->add($association->name(), $association);
}
/**
* Creates a new BelongsToMany association between this table and a target
* table. A "belongs to many" association is a M-N relationship.
*
* Target table can be inferred by its name, which is provided in the
* first argument, or you can either pass the class name to be instantiated or
* an instance of it directly.
*
* The options array accept the following keys:
*
* - className: The class name of the target table object
* - targetTable: An instance of a table object to be used as the target table
* - foreignKey: The name of the field to use as foreign key
* - joinTable: The name of the table representing the link between the two
* - through: If you choose to use an already instantiated link table, set this
* key to a configured Table instance containing associations to both the source
* and target tables in this association.
* - cascadeCallbacks: Set to true if you want CakePHP to fire callbacks on
* cascaded deletes. If false the ORM will use deleteAll() to remove data.
* When true join/junction table records will be loaded and then deleted.
* - conditions: array with a list of conditions to filter the join with
* - sort: The order in which results for this association should be returned
* - strategy: The strategy to be used for selecting results Either 'select'
* or 'subquery'. If subquery is selected the query used to return results
* in the source table will be used as conditions for getting rows in the
* target table.
* - saveStrategy: Either 'append' or 'replace'. Indicates the mode to be used
* for saving associated entities. The former will only create new links
* between both side of the relation and the latter will do a wipe and
* replace to create the links between the passed entities when saving.
*
* This method will return the association object that was built.
*
* @param string $associated the alias for the target table. This is used to
* uniquely identify the association
* @param array $options list of options to configure the association definition
* @return Cake\ORM\Association\BelongsToMany
*/
public function belongsToMany($associated, array $options = []) {
$options += ['sourceTable' => $this];
$association = new BelongsToMany($associated, $options);
return $this->_associated->add($association->name(), $association);
}
/**
* Creates a new Query for this table and applies some defaults based on the
* type of search that was selected.
*
* ### Model.beforeFind event
*
* Each find() will trigger a `Model.beforeFind` event for all attached
* listeners. Any listener can set a valid result set using $query
*
* @param string $type the type of query to perform
* @param array $options
* @return \Cake\ORM\Query
*/
public function find($type, $options = []) {
$query = $this->_buildQuery();
$query->select()->applyOptions($options);
return $this->callFinder($type, $query, $options);
}
/**
* Returns the query as passed
*
* @param \Cake\ORM\Query $query
* @param array $options
* @return \Cake\ORM\Query
*/
public function findAll(Query $query, array $options = []) {
return $query;
}
/**
* Sets up a query object so results appear as an indexed array, useful for any
* place where you would want a list such as for populating input select boxes.
*
* When calling this finder, the fields passed are used to determine what should
* be used as the array key, value and optionally what to group the results by.
* By default the primary key for the model is used for the key, and the display
* field as value.
*
* The results of this finder will be in the following form:
*
* [
* 1 => 'value for id 1',
* 2 => 'value for id 2',
* 4 => 'value for id 4'
* ]
*
* @param \Cake\ORM\Query $query
* @param array $options
* @return \Cake\ORM\Query
*/
public function findList(Query $query, array $options = []) {
$options += [
'idField' => $this->primaryKey(),
'valueField' => $this->displayField(),
'groupField' => false
];
$mapper = function($key, $row, $mapReduce) use ($options) {
$rowKey = $options['idField'];
$rowVal = $options['valueField'];
if (!($options['groupField'])) {
$mapReduce->emit($row[$rowVal], $row[$rowKey]);
return;
}
$key = $row[$options['groupField']];
$mapReduce->emitIntermediate($key, [$row[$rowKey] => $row[$rowVal]]);
};
$reducer = function($key, $values, $mapReduce) {
$result = [];
foreach ($values as $value) {
$result += $value;
}
$mapReduce->emit($result, $key);
};
return $query->mapReduce($mapper, $reducer);
}
/**
* Results for this finder will be a nested array, and is appropriate if you want
* to use the parent_id field of your model data to build nested results.
*
* Values belonging to a parent row based on their parent_id value will be
* recursively nested inside the parent row values using the `children` property
*
* @param \Cake\ORM\Query $query
* @param array $options
* @return \Cake\ORM\Query
*/
public function findThreaded(Query $query, array $options = []) {
$parents = [];
$hydrate = $query->hydrate();
$mapper = function($key, $row, $mapReduce) use (&$parents) {
$row['children'] = [];
$parents[$row['id']] =& $row;
$mapReduce->emitIntermediate($row['parent_id'], $row['id']);
};
$reducer = function($key, $values, $mapReduce) use (&$parents, $hydrate) {
if (empty($key) || !isset($parents[$key])) {
foreach ($values as $id) {
$parents[$id] = $hydrate ? $parents[$id] : new \ArrayObject($parents[$id]);
$mapReduce->emit($parents[$id]);
}
return;
}
foreach ($values as $id) {
$parents[$key]['children'][] =& $parents[$id];
}
};
$query->mapReduce($mapper, $reducer);
if (!$hydrate) {
$query->mapReduce(function($key, $row, $mapReduce) {
$mapReduce->emit($row->getArrayCopy());
});
}
return $query;
}
/**
* Creates a new Query instance for this table
*
* @return \Cake\ORM\Query
*/
protected function _buildQuery() {
return new Query($this->connection(), $this);
}
/**
* Update all matching rows.
*
* Sets the $fields to the provided values based on $conditions.
* This method will *not* trigger beforeSave/afterSave events. If you need those
* first load a collection of records and update them.
*
* @param array $fields A hash of field => new value.
* @param array $conditions An array of conditions, similar to those used with find()
* @return boolean Success Returns true if one or more rows are effected.
*/
public function updateAll($fields, $conditions) {
$query = $this->_buildQuery();
$query->update($this->table())
->set($fields)
->where($conditions);
$statement = $query->executeStatement();
$success = $statement->rowCount() > 0;
$statement->closeCursor();
return $success;
}
/**
* Returns the validation rules tagged with $name. It is possible to have
* multiple different named validation sets, this is useful when you need
* to use varying rules when saving from different routines in your system.
*
* There are two different ways of creating and naming validation sets: by
* creating a new method inside your own Table subclass, or by building
* the validator object yourself and storing it using this method.
*
* For example, if you wish to create a validation set called 'forSubscription',
* you will need to create a method in your Table subclass as follows:
*
* {{{
* public function validationForSubscription($validator) {
* return $validator
* ->add('email', 'valid-email', ['rule' => 'email'])
* ->add('password', 'valid', ['rule' => 'notEmpty']);
* ->validatePresence('username')
* }
* }}}
*
* Otherwise, you can build the object by yourself and store it in the Table object:
*
* {{{
* $validator = new \Cake\Validation\Validator($table);
* $validator
* ->add('email', 'valid-email', ['rule' => 'email'])
* ->add('password', 'valid', ['rule' => 'notEmpty'])
* ->allowEmpty('bio');
* $table->validator('forSubscription', $validator);
* }}}
*
* You can implement the method in `validationDefault` in your Table subclass
* should you wish to have a validation set that applies in cases where no other
* set is specified.
*
* @param string $name the name of the validation set to return
* @param \Cake\Validation\Validator $validator
* @return \Cake\Validation\Validator
*/
public function validator($name = 'default', Validator $instance = null) {
if ($instance === null && isset($this->_validators[$name])) {
return $this->_validators[$name];
}
if ($instance !== null) {
return $this->_validators[$name] = $instance;
}
$validator = new Validator;
$validator = $this->{'validation' . ucfirst($name)}($validator);
return $this->_validators[$name] = $validator;
}
/**
* Returns the default validator object. Subclasses can override this function
* to add a default validation set to the validator object.
*
* @param \Cake\Validation\Validator $validator The validator that can be modified to
* add some rules to it.
* @return \Cake\Validation\Validator
*/
public function validationDefault(Validator $validator) {
return $validator;
}
/**
* Delete all matching rows.
*
* Deletes all rows matching the provided conditions.
*
* This method will *not* trigger beforeDelete/afterDelete events. If you
* need those first load a collection of records and delete them.
*
* This method will *not* execute on associations `cascade` attribute. You should
* use database foreign keys + ON CASCADE rules if you need cascading deletes combined
* with this method.
*
* @param array $conditions An array of conditions, similar to those used with find()
* @return boolean Success Returns true if one or more rows are effected.
* @see Cake\ORM\Table::delete()
*/
public function deleteAll($conditions) {
$query = $this->_buildQuery();
$query->delete($this->table())
->where($conditions);
$statement = $query->executeStatement();
$success = $statement->rowCount() > 0;
$statement->closeCursor();
return $success;
}
/**
* Returns true if there is any row in this table matching the specified
* conditions.
*
* @param array $conditions list of conditions to pass to the query
* @return boolean
*/
public function exists(array $conditions) {
return (bool)count($this->find('all')
->select(['existing' => 1])
->where($conditions)
->limit(1)
->hydrate(false)
->toArray());
}
/**
* Persists an entity based on the fields that are marked as dirty and
* returns the same entity after a successful save or false in case
* of any error.
*
* ### Options
*
* The options array can receive the following keys:
*
* - atomic: Whether to execute the save and callbacks inside a database
* transaction (default: true)
* - validate: Whether or not validate the entity before saving, if validation
* fails, it will abort the save operation. If this key is set to a string value,
* the validator object registered in this table under the provided name will be
* used instead of the default one. (default:true)
* - associated: If true it will save all associated entities as they are found
* in the passed `$entity` whenever the property defined for the association
* is marked as dirty. Associated records are saved recursively unless told
* otherwise. If an array, it will be interpreted as the list of associations
* to be saved. It is possible to provide different options for saving on associated
* table objects using this key by making the custom options the array value.
* If false no associated records will be saved. (default: true)
*
* ### Events
*
* When saving, this method will trigger four events:
*
* - Model.beforeValidate: Will be triggered right before any validation is done
* for the passed entity if the validate key in $options is not set to false.
* Listeners will receive as arguments the entity, the options array and the
* validation object to be used for validating the entity. If the event is
* stopped the validation result will be set to the result of the event itself.
* - Model.afterValidate: Will be triggered right after the `validate()` method is
* called in the entity. Listeners will receive as arguments the entity, the
* options array and the validation object to be used for validating the entity.
* If the event is stopped the validation result will be set to the result of
* the event itself.
* - Model.beforeSave: Will be triggered just before the list of fields to be
* persisted is calculated. It receives both the entity and the options as
* arguments. The options array is passed as an ArrayObject, so any changes in
* it will be reflected in every listener and remembered at the end of the event
* so it can be used for the rest of the save operation. Returning false in any
* of the listeners will abort the saving process. If the event is stopped
* using the event API, the event object's `result` property will be returned.
* This can be useful when having your own saving strategy implemented inside a
* listener.
* - Model.afterSave: Will be triggered after a successful insert or save,
* listeners will receive the entity and the options array as arguments. The type
* of operation performed (insert or update) can be determined by checking the
* entity's method `isNew`, true meaning an insert and false an update.
*
* This method will determine whether the passed entity needs to be
* inserted or updated in the database. It does that by checking the `isNew`
* method on the entity, if no information can be found there, it will go
* directly to the database to check the entity's status.
*
* ### Saving on associated tables
*
* This method will by default persist entities belonging to associated tables,
* whenever a dirty property matching the name of the property name set for an
* association in this table. It is possible to control what associations will
* be saved and to pass additional option for saving them.
*
* {{{
* // Only save the comments association
* $articles->save($entity, ['associated' => ['Comments']);
*
* // Save the company, the employees and related addresses for each of them.
* // For employees use the 'special' validation group
* $companies->save($entity, [
* 'associated' => [
* 'Employees' => [
* 'associated' => ['Addresses'],
* 'validate' => 'special'
* ]