-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
SelectQuery.php
1801 lines (1650 loc) · 55.2 KB
/
SelectQuery.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
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 4.5.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\ORM\Query;
use ArrayObject;
use Cake\Collection\Iterator\MapReduce;
use Cake\Database\Expression\QueryExpression;
use Cake\Database\ExpressionInterface;
use Cake\Database\Query\SelectQuery as DbSelectQuery;
use Cake\Database\TypedResultInterface;
use Cake\Database\TypeMap;
use Cake\Database\ValueBinder;
use Cake\Datasource\Exception\RecordNotFoundException;
use Cake\Datasource\QueryCacher;
use Cake\Datasource\QueryInterface;
use Cake\Datasource\ResultSetDecorator;
use Cake\Datasource\ResultSetInterface;
use Cake\ORM\Association;
use Cake\ORM\EagerLoader;
use Cake\ORM\ResultSetFactory;
use Cake\ORM\Table;
use Closure;
use InvalidArgumentException;
use JsonSerializable;
use Psr\SimpleCache\CacheInterface;
/**
* Extends the Cake\Database\Query\SelectQuery class to provide new methods related to association
* loading, automatic fields selection, automatic type casting and to wrap results
* into a specific iterator that will be responsible for hydrating results if
* required.
*
* @template TSubject of \Cake\Datasource\EntityInterface|array
* @extends \Cake\Database\Query\SelectQuery<TSubject>
*/
class SelectQuery extends DbSelectQuery implements JsonSerializable, QueryInterface
{
use CommonQueryTrait;
/**
* Indicates that the operation should append to the list
*
* @var int
*/
public const APPEND = 0;
/**
* Indicates that the operation should prepend to the list
*
* @var int
*/
public const PREPEND = 1;
/**
* Indicates that the operation should overwrite the list
*
* @var bool
*/
public const OVERWRITE = true;
/**
* Whether the user select any fields before being executed, this is used
* to determined if any fields should be automatically be selected.
*
* @var bool|null
*/
protected ?bool $_hasFields = null;
/**
* Tracks whether the original query should include
* fields from the top level table.
*
* @var bool|null
*/
protected ?bool $_autoFields = null;
/**
* Whether to hydrate results into entity objects
*
* @var bool
*/
protected bool $_hydrate = true;
/**
* Whether aliases are generated for fields.
*
* @var bool
*/
protected bool $aliasingEnabled = true;
/**
* A callback used to calculate the total amount of
* records this query will match when not using `limit`
*
* @var \Closure|null
*/
protected ?Closure $_counter = null;
/**
* Instance of a class responsible for storing association containments and
* for eager loading them when this query is executed
*
* @var \Cake\ORM\EagerLoader|null
*/
protected ?EagerLoader $_eagerLoader = null;
/**
* Whether the query is standalone or the product of an eager load operation.
*
* @var bool
*/
protected bool $_eagerLoaded = false;
/**
* True if the beforeFind event has already been triggered for this query
*
* @var bool
*/
protected bool $_beforeFindFired = false;
/**
* The COUNT(*) for the query.
*
* When set, count query execution will be bypassed.
*
* @var int|null
*/
protected ?int $_resultsCount = null;
/**
* Resultset factory
*
* @var \Cake\ORM\ResultSetFactory<\Cake\Datasource\EntityInterface|array>
*/
protected ResultSetFactory $resultSetFactory;
/**
* A ResultSet.
*
* When set, SelectQuery execution will be bypassed.
*
* @var iterable|null
* @see \Cake\Datasource\QueryTrait::setResult()
*/
protected ?iterable $_results = null;
/**
* List of map-reduce routines that should be applied over the query
* result
*
* @var array
*/
protected array $_mapReduce = [];
/**
* List of formatter classes or callbacks that will post-process the
* results when fetched
*
* @var array<\Closure>
*/
protected array $_formatters = [];
/**
* A query cacher instance if this query has caching enabled.
*
* @var \Cake\Datasource\QueryCacher|null
*/
protected ?QueryCacher $_cache = null;
/**
* Holds any custom options passed using applyOptions that could not be processed
* by any method in this class.
*
* @var array
*/
protected array $_options = [];
/**
* Constructor
*
* @param \Cake\ORM\Table $table The table this query is starting on
*/
public function __construct(Table $table)
{
parent::__construct($table->getConnection());
$this->setRepository($table);
$this->addDefaultTypes($table);
}
/**
* Set the result set for a query.
*
* Setting the resultset of a query will make execute() a no-op. Instead
* of executing the SQL query and fetching results, the ResultSet provided to this
* method will be returned.
*
* This method is most useful when combined with results stored in a persistent cache.
*
* @param iterable $results The results this query should return.
* @return $this
*/
public function setResult(iterable $results)
{
$this->_results = $results;
return $this;
}
/**
* Executes this query and returns a results iterator. This function is required
* for implementing the IteratorAggregate interface and allows the query to be
* iterated without having to call execute() manually, thus making it look like
* a result set instead of the query itself.
*
* @return \Cake\Datasource\ResultSetInterface<\Cake\Datasource\EntityInterface|array>
*/
public function getIterator(): ResultSetInterface
{
return $this->all();
}
/**
* Enable result caching for this query.
*
* If a query has caching enabled, it will do the following when executed:
*
* - Check the cache for $key. If there are results no SQL will be executed.
* Instead the cached results will be returned.
* - When the cached data is stale/missing the result set will be cached as the query
* is executed.
*
* ### Usage
*
* ```
* // Simple string key + config
* $query->cache('my_key', 'db_results');
*
* // Function to generate key.
* $query->cache(function ($q) {
* $key = serialize($q->clause('select'));
* $key .= serialize($q->clause('where'));
* return md5($key);
* });
*
* // Using a pre-built cache engine.
* $query->cache('my_key', $engine);
*
* // Disable caching
* $query->cache(false);
* ```
*
* @param \Closure|string|false $key Either the cache key or a function to generate the cache key.
* When using a function, this query instance will be supplied as an argument.
* @param \Psr\SimpleCache\CacheInterface|string $config Either the name of the cache config to use, or
* a cache engine instance.
* @return $this
*/
public function cache(Closure|string|false $key, CacheInterface|string $config = 'default')
{
if ($key === false) {
$this->_cache = null;
return $this;
}
$this->_cache = new QueryCacher($key, $config);
return $this;
}
/**
* Returns the current configured query `_eagerLoaded` value
*
* @return bool
*/
public function isEagerLoaded(): bool
{
return $this->_eagerLoaded;
}
/**
* Sets the query instance to be an eager loaded query. If no argument is
* passed, the current configured query `_eagerLoaded` value is returned.
*
* @param bool $value Whether to eager load.
* @return $this
*/
public function eagerLoaded(bool $value)
{
$this->_eagerLoaded = $value;
return $this;
}
/**
* Returns a key => value array representing a single aliased field
* that can be passed directly to the select() method.
* The key will contain the alias and the value the actual field name.
*
* If the field is already aliased, then it will not be changed.
* If no $alias is passed, the default table for this query will be used.
*
* @param string $field The field to alias
* @param string|null $alias the alias used to prefix the field
* @return array<string, string>
*/
public function aliasField(string $field, ?string $alias = null): array
{
if (str_contains($field, '.')) {
$aliasedField = $field;
[$alias, $field] = explode('.', $field);
} else {
$alias = $alias ?: $this->getRepository()->getAlias();
$aliasedField = $alias . '.' . $field;
}
$key = sprintf('%s__%s', $alias, $field);
return [$key => $aliasedField];
}
/**
* Runs `aliasField()` for each field in the provided list and returns
* the result under a single array.
*
* @param array $fields The fields to alias
* @param string|null $defaultAlias The default alias
* @return array<string, string>
*/
public function aliasFields(array $fields, ?string $defaultAlias = null): array
{
$aliased = [];
foreach ($fields as $alias => $field) {
if (is_numeric($alias) && is_string($field)) {
$aliased += $this->aliasField($field, $defaultAlias);
continue;
}
$aliased[$alias] = $field;
}
return $aliased;
}
/**
* Fetch the results for this query.
*
* Will return either the results set through setResult(), or execute this query
* and return the ResultSetDecorator object ready for streaming of results.
*
* ResultSetDecorator is a traversable object that implements the methods found
* on Cake\Collection\Collection.
*
* @return \Cake\Datasource\ResultSetInterface<mixed>
*/
public function all(): ResultSetInterface
{
if ($this->_results !== null) {
if (!($this->_results instanceof ResultSetInterface)) {
$this->_results = $this->_decorateResults($this->_results);
}
return $this->_results;
}
$results = null;
if ($this->_cache) {
$results = $this->_cache->fetch($this);
}
if ($results === null) {
$results = $this->_decorateResults($this->_execute());
if ($this->_cache) {
$this->_cache->store($this, $results);
}
}
$this->_results = $results;
return $this->_results;
}
/**
* Returns an array representation of the results after executing the query.
*
* @return array
*/
public function toArray(): array
{
return $this->all()->toArray();
}
/**
* Register a new MapReduce routine to be executed on top of the database results
*
* The MapReduce routing will only be run when the query is executed and the first
* result is attempted to be fetched.
*
* If the third argument is set to true, it will erase previous map reducers
* and replace it with the arguments passed.
*
* @param \Closure|null $mapper The mapper function
* @param \Closure|null $reducer The reducing function
* @param bool $overwrite Set to true to overwrite existing map + reduce functions.
* @return $this
* @see \Cake\Collection\Iterator\MapReduce for details on how to use emit data to the map reducer.
*/
public function mapReduce(?Closure $mapper = null, ?Closure $reducer = null, bool $overwrite = false)
{
if ($overwrite) {
$this->_mapReduce = [];
}
if ($mapper === null) {
if (!$overwrite) {
throw new InvalidArgumentException('$mapper can be null only when $overwrite is true.');
}
return $this;
}
$this->_mapReduce[] = compact('mapper', 'reducer');
return $this;
}
/**
* Returns the list of previously registered map reduce routines.
*
* @return array
*/
public function getMapReducers(): array
{
return $this->_mapReduce;
}
/**
* Registers a new formatter callback function that is to be executed when trying
* to fetch the results from the database.
*
* If the second argument is set to true, it will erase previous formatters
* and replace them with the passed first argument.
*
* Callbacks are required to return an iterator object, which will be used as
* the return value for this query's result. Formatter functions are applied
* after all the `MapReduce` routines for this query have been executed.
*
* Formatting callbacks will receive two arguments, the first one being an object
* implementing `\Cake\Collection\CollectionInterface`, that can be traversed and
* modified at will. The second one being the query instance on which the formatter
* callback is being applied.
*
* Usually the query instance received by the formatter callback is the same query
* instance on which the callback was attached to, except for in a joined
* association, in that case the callback will be invoked on the association source
* side query, and it will receive that query instance instead of the one on which
* the callback was originally attached to - see the examples below!
*
* ### Examples:
*
* Return all results from the table indexed by id:
*
* ```
* $query->select(['id', 'name'])->formatResults(function ($results) {
* return $results->indexBy('id');
* });
* ```
*
* Add a new column to the ResultSet:
*
* ```
* $query->select(['name', 'birth_date'])->formatResults(function ($results) {
* return $results->map(function ($row) {
* $row['age'] = $row['birth_date']->diff(new DateTime)->y;
*
* return $row;
* });
* });
* ```
*
* Add a new column to the results with respect to the query's hydration configuration:
*
* ```
* $query->formatResults(function ($results, $query) {
* return $results->map(function ($row) use ($query) {
* $data = [
* 'bar' => 'baz',
* ];
*
* if ($query->isHydrationEnabled()) {
* $row['foo'] = new Foo($data)
* } else {
* $row['foo'] = $data;
* }
*
* return $row;
* });
* });
* ```
*
* Retaining access to the association target query instance of joined associations,
* by inheriting the contain callback's query argument:
*
* ```
* // Assuming a `Articles belongsTo Authors` association that uses the join strategy
*
* $articlesQuery->contain('Authors', function ($authorsQuery) {
* return $authorsQuery->formatResults(function ($results, $query) use ($authorsQuery) {
* // Here `$authorsQuery` will always be the instance
* // where the callback was attached to.
*
* // The instance passed to the callback in the second
* // argument (`$query`), will be the one where the
* // callback is actually being applied to, in this
* // example that would be `$articlesQuery`.
*
* // ...
*
* return $results;
* });
* });
* ```
*
* @param \Closure|null $formatter The formatting function
* @param int|bool $mode Whether to overwrite, append or prepend the formatter.
* @return $this
* @throws \InvalidArgumentException
*/
public function formatResults(?Closure $formatter = null, int|bool $mode = self::APPEND)
{
if ($mode === self::OVERWRITE) {
$this->_formatters = [];
}
if ($formatter === null) {
if ($mode !== self::OVERWRITE) {
throw new InvalidArgumentException('$formatter can be null only when $mode is overwrite.');
}
return $this;
}
if ($mode === self::PREPEND) {
array_unshift($this->_formatters, $formatter);
return $this;
}
$this->_formatters[] = $formatter;
return $this;
}
/**
* Returns the list of previously registered format routines.
*
* @return array<\Closure>
*/
public function getResultFormatters(): array
{
return $this->_formatters;
}
/**
* Returns the first result out of executing this query, if the query has not been
* executed before, it will set the limit clause to 1 for performance reasons.
*
* ### Example:
*
* ```
* $singleUser = $query->select(['id', 'username'])->first();
* ```
*
* @return mixed The first result from the ResultSet.
*/
public function first(): mixed
{
if ($this->_dirty) {
$this->limit(1);
}
return $this->all()->first();
}
/**
* Get the first result from the executing query or raise an exception.
*
* @throws \Cake\Datasource\Exception\RecordNotFoundException When there is no first record.
* @return mixed The first result from the ResultSet.
*/
public function firstOrFail(): mixed
{
$entity = $this->first();
if (!$entity) {
$table = $this->getRepository();
throw new RecordNotFoundException(sprintf(
'Record not found in table `%s`.',
$table->getTable()
));
}
return $entity;
}
/**
* Returns an array with the custom options that were applied to this query
* and that were not already processed by another method in this class.
*
* ### Example:
*
* ```
* $query->applyOptions(['doABarrelRoll' => true, 'fields' => ['id', 'name']);
* $query->getOptions(); // Returns ['doABarrelRoll' => true]
* ```
*
* @see \Cake\Datasource\QueryInterface::applyOptions() to read about the options that will
* be processed by this class and not returned by this function
* @return array
* @see applyOptions()
*/
public function getOptions(): array
{
return $this->_options;
}
/**
* Populates or adds parts to current query clauses using an array.
* This is handy for passing all query clauses at once.
*
* The method accepts the following query clause related options:
*
* - fields: Maps to the select method
* - conditions: Maps to the where method
* - limit: Maps to the limit method
* - order: Maps to the order method
* - offset: Maps to the offset method
* - group: Maps to the group method
* - having: Maps to the having method
* - contain: Maps to the contain options for eager loading
* - join: Maps to the join method
* - page: Maps to the page method
*
* All other options will not affect the query, but will be stored
* as custom options that can be read via `getOptions()`. Furthermore
* they are automatically passed to `Model.beforeFind`.
*
* ### Example:
*
* ```
* $query->applyOptions([
* 'fields' => ['id', 'name'],
* 'conditions' => [
* 'created >=' => '2013-01-01'
* ],
* 'limit' => 10,
* ]);
* ```
*
* Is equivalent to:
*
* ```
* $query
* ->select(['id', 'name'])
* ->where(['created >=' => '2013-01-01'])
* ->limit(10)
* ```
*
* Custom options can be read via `getOptions()`:
*
* ```
* $query->applyOptions([
* 'fields' => ['id', 'name'],
* 'custom' => 'value',
* ]);
* ```
*
* Here `$options` will hold `['custom' => 'value']` (the `fields`
* option will be applied to the query instead of being stored, as
* it's a query clause related option):
*
* ```
* $options = $query->getOptions();
* ```
*
* @param array<string, mixed> $options The options to be applied
* @return $this
* @see getOptions()
*/
public function applyOptions(array $options)
{
$valid = [
'select' => 'select',
'fields' => 'select',
'conditions' => 'where',
'where' => 'where',
'join' => 'join',
'order' => 'orderBy',
'orderBy' => 'orderBy',
'limit' => 'limit',
'offset' => 'offset',
'group' => 'groupBy',
'groupBy' => 'groupBy',
'having' => 'having',
'contain' => 'contain',
'page' => 'page',
];
ksort($options);
foreach ($options as $option => $values) {
if (isset($valid[$option], $values)) {
$this->{$valid[$option]}($values);
} else {
$this->_options[$option] = $values;
}
}
return $this;
}
/**
* Decorates the results iterator with MapReduce routines and formatters
*
* @param iterable $result Original results
* @return \Cake\Datasource\ResultSetInterface<\Cake\Datasource\EntityInterface|mixed>
*/
protected function _decorateResults(iterable $result): ResultSetInterface
{
$decorator = $this->_decoratorClass();
if ($this->_mapReduce) {
foreach ($this->_mapReduce as $functions) {
$result = new MapReduce($result, $functions['mapper'], $functions['reducer']);
}
$result = new $decorator($result);
}
if (!($result instanceof ResultSetInterface)) {
$result = new $decorator($result);
}
if ($this->_formatters) {
foreach ($this->_formatters as $formatter) {
$result = $formatter($result, $this);
}
if (!($result instanceof ResultSetInterface)) {
$result = new $decorator($result);
}
}
return $result;
}
/**
* Returns the name of the class to be used for decorating results
*
* @return class-string<\Cake\Datasource\ResultSetInterface>
*/
protected function _decoratorClass(): string
{
return ResultSetDecorator::class;
}
/**
* Adds new fields to be returned by a `SELECT` statement when this query is
* executed. Fields can be passed as an array of strings, array of expression
* objects, a single expression or a single string.
*
* If an array is passed, keys will be used to alias fields using the value as the
* real field to be aliased. It is possible to alias strings, Expression objects or
* even other Query objects.
*
* If a callback is passed, the returning array of the function will
* be used as the list of fields.
*
* By default this function will append any passed argument to the list of fields
* to be selected, unless the second argument is set to true.
*
* ### Examples:
*
* ```
* $query->select(['id', 'title']); // Produces SELECT id, title
* $query->select(['author' => 'author_id']); // Appends author: SELECT id, title, author_id as author
* $query->select('id', true); // Resets the list: SELECT id
* $query->select(['total' => $countQuery]); // SELECT id, (SELECT ...) AS total
* $query->select(function ($query) {
* return ['article_id', 'total' => $query->count('*')];
* })
* ```
*
* By default no fields are selected, if you have an instance of `Cake\ORM\Query` and try to append
* fields you should also call `Cake\ORM\Query::enableAutoFields()` to select the default fields
* from the table.
*
* If you pass an instance of a `Cake\ORM\Table` or `Cake\ORM\Association` class,
* all the fields in the schema of the table or the association will be added to
* the select clause.
*
* @param \Cake\Database\ExpressionInterface|\Cake\ORM\Table|\Cake\ORM\Association|\Closure|array|string|float|int $fields Fields
* to be added to the list.
* @param bool $overwrite whether to reset fields with passed list or not
* @return $this
*/
public function select(
ExpressionInterface|Table|Association|Closure|array|string|float|int $fields = [],
bool $overwrite = false
) {
if ($fields instanceof Association) {
$fields = $fields->getTarget();
}
if ($fields instanceof Table) {
if ($this->aliasingEnabled) {
$fields = $this->aliasFields($fields->getSchema()->columns(), $fields->getAlias());
} else {
$fields = $fields->getSchema()->columns();
}
}
return parent::select($fields, $overwrite);
}
/**
* Behaves the exact same as `select()` except adds the field to the list of fields selected and
* does not disable auto-selecting fields for Associations.
*
* Use this instead of calling `select()` then `enableAutoFields()` to re-enable auto-fields.
*
* @param \Cake\Database\ExpressionInterface|\Cake\ORM\Table|\Cake\ORM\Association|\Closure|array|string|float|int $fields Fields
* to be added to the list.
* @return $this
*/
public function selectAlso(
ExpressionInterface|Table|Association|Closure|array|string|float|int $fields
) {
$this->select($fields);
$this->_autoFields = true;
return $this;
}
/**
* All the fields associated with the passed table except the excluded
* fields will be added to the select clause of the query. Passed excluded fields should not be aliased.
* After the first call to this method, a second call cannot be used to remove fields that have already
* been added to the query by the first. If you need to change the list after the first call,
* pass overwrite boolean true which will reset the select clause removing all previous additions.
*
* @param \Cake\ORM\Table|\Cake\ORM\Association $table The table to use to get an array of columns
* @param list<string> $excludedFields The un-aliased column names you do not want selected from $table
* @param bool $overwrite Whether to reset/remove previous selected fields
* @return $this
*/
public function selectAllExcept(Table|Association $table, array $excludedFields, bool $overwrite = false)
{
if ($table instanceof Association) {
$table = $table->getTarget();
}
$fields = array_diff($table->getSchema()->columns(), $excludedFields);
if ($this->aliasingEnabled) {
$fields = $this->aliasFields($fields);
}
return $this->select($fields, $overwrite);
}
/**
* Sets the instance of the eager loader class to use for loading associations
* and storing containments.
*
* @param \Cake\ORM\EagerLoader $instance The eager loader to use.
* @return $this
*/
public function setEagerLoader(EagerLoader $instance)
{
$this->_eagerLoader = $instance;
return $this;
}
/**
* Returns the currently configured instance.
*
* @return \Cake\ORM\EagerLoader
*/
public function getEagerLoader(): EagerLoader
{
return $this->_eagerLoader ??= new EagerLoader();
}
/**
* Sets the list of associations that should be eagerly loaded along with this
* query. The list of associated tables passed must have been previously set as
* associations using the Table API.
*
* ### Example:
*
* ```
* // Bring articles' author information
* $query->contain('Author');
*
* // Also bring the category and tags associated to each article
* $query->contain(['Category', 'Tag']);
* ```
*
* Associations can be arbitrarily nested using dot notation or nested arrays,
* this allows this object to calculate joins or any additional queries that
* must be executed to bring the required associated data.
*
* ### Example:
*
* ```
* // Eager load the product info, and for each product load other 2 associations
* $query->contain(['Product' => ['Manufacturer', 'Distributor']);
*
* // Which is equivalent to calling
* $query->contain(['Products.Manufactures', 'Products.Distributors']);
*
* // For an author query, load his region, state and country
* $query->contain('Regions.States.Countries');
* ```
*
* It is possible to control the conditions and fields selected for each of the
* contained associations:
*
* ### Example:
*
* ```
* $query->contain(['Tags' => function ($q) {
* return $q->where(['Tags.is_popular' => true]);
* }]);
*
* $query->contain(['Products.Manufactures' => function ($q) {
* return $q->select(['name'])->where(['Manufactures.active' => true]);
* }]);
* ```
*
* Each association might define special options when eager loaded, the allowed
* options that can be set per association are:
*
* - `foreignKey`: Used to set a different field to match both tables, if set to false
* no join conditions will be generated automatically. `false` can only be used on
* joinable associations and cannot be used with hasMany or belongsToMany associations.
* - `fields`: An array with the fields that should be fetched from the association.
* - `finder`: The finder to use when loading associated records. Either the name of the
* finder as a string, or an array to define options to pass to the finder.
* - `queryBuilder`: Equivalent to passing a callback instead of an options array.
*
* ### Example:
*
* ```
* // Set options for the hasMany articles that will be eagerly loaded for an author
* $query->contain([
* 'Articles' => [
* 'fields' => ['title', 'author_id']
* ]
* ]);
* ```
*
* Finders can be configured to use options.
*
* ```
* // Retrieve translations for the articles, but only those for the `en` and `es` locales
* $query->contain([
* 'Articles' => [
* 'finder' => [
* 'translations' => [
* 'locales' => ['en', 'es']
* ]
* ]
* ]
* ]);
* ```
*
* When containing associations, it is important to include foreign key columns.
* Failing to do so will trigger exceptions.
*
* ```
* // Use a query builder to add conditions to the containment
* $query->contain('Authors', function ($q) {
* return $q->where(...); // add conditions
* });
* // Use special join conditions for multiple containments in the same method call
* $query->contain([
* 'Authors' => [
* 'foreignKey' => false,
* 'queryBuilder' => function ($q) {
* return $q->where(...); // Add full filtering conditions
* }
* ],