-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathBaseModel.php
More file actions
1993 lines (1713 loc) · 59.2 KB
/
BaseModel.php
File metadata and controls
1993 lines (1713 loc) · 59.2 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
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter;
use Closure;
use CodeIgniter\Database\BaseConnection;
use CodeIgniter\Database\BaseResult;
use CodeIgniter\Database\Exceptions\DatabaseException;
use CodeIgniter\Database\Exceptions\DataException;
use CodeIgniter\Database\Query;
use CodeIgniter\Database\RawSql;
use CodeIgniter\DataCaster\Cast\CastInterface;
use CodeIgniter\DataConverter\DataConverter;
use CodeIgniter\Entity\Cast\CastInterface as EntityCastInterface;
use CodeIgniter\Entity\Entity;
use CodeIgniter\Exceptions\InvalidArgumentException;
use CodeIgniter\Exceptions\ModelException;
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\Pager;
use CodeIgniter\Validation\ValidationInterface;
use Config\Feature;
use ReflectionClass;
use ReflectionException;
use ReflectionProperty;
use stdClass;
/**
* The BaseModel class provides a number of convenient features that
* makes working with a databases less painful. Extending this class
* provide means of implementing various database systems.
*
* It will:
* - simplifies pagination
* - allow specifying the return type (array, object, etc) with each call
* - automatically set and update timestamps
* - handle soft deletes
* - ensure validation is run against objects when saving items
* - process various callbacks
* - allow intermingling calls to the db connection
*
* @phpstan-type row_array array<int|string, float|int|null|object|string|bool>
* @phpstan-type event_data_beforeinsert array{data: row_array}
* @phpstan-type event_data_afterinsert array{id: int|string, data: row_array, result: bool}
* @phpstan-type event_data_beforefind array{id?: int|string, method: string, singleton: bool, limit?: int, offset?: int}
* @phpstan-type event_data_afterfind array{id: int|string|null|list<int|string>, data: row_array|list<row_array>|object|null, method: string, singleton: bool}
* @phpstan-type event_data_beforeupdate array{id: null|list<int|string>, data: row_array}
* @phpstan-type event_data_afterupdate array{id: null|list<int|string>, data: row_array|object, result: bool}
* @phpstan-type event_data_beforedelete array{id: null|list<int|string>, purge: bool}
* @phpstan-type event_data_afterdelete array{id: null|list<int|string>, data: null, purge: bool, result: bool}
*/
abstract class BaseModel
{
/**
* Pager instance.
*
* Populated after calling `$this->paginate()`.
*
* @var Pager
*/
public $pager;
/**
* Database Connection.
*
* @var BaseConnection
*/
protected $db;
/**
* Last insert ID.
*
* @var int|string
*/
protected $insertID = 0;
/**
* The Database connection group that
* should be instantiated.
*
* @var non-empty-string|null
*/
protected $DBGroup;
/**
* The format that the results should be returned as.
*
* Will be overridden if the `$this->asArray()`, `$this->asObject()` methods are used.
*
* @var 'array'|'object'|class-string
*/
protected $returnType = 'array';
/**
* The temporary format of the result.
*
* Used by `$this->asArray()` and `$this->asObject()` to provide
* temporary overrides of model default.
*
* @var 'array'|'object'|class-string
*/
protected $tempReturnType;
/**
* Array of column names and the type of value to cast.
*
* @var array<string, string> Array order `['column' => 'type']`.
*/
protected array $casts = [];
/**
* Custom convert handlers.
*
* @var array<string, class-string<CastInterface|EntityCastInterface>> Array order `['type' => 'classname']`.
*/
protected array $castHandlers = [];
protected ?DataConverter $converter = null;
/**
* Determines whether the model should protect field names during
* mass assignment operations such as $this->insert(), $this->update().
*
* When set to `true`, only the fields explicitly defined in the `$allowedFields`
* property will be allowed for mass assignment. This helps prevent
* unintended modification of database fields and improves security
* by avoiding mass assignment vulnerabilities.
*
* @var bool
*/
protected $protectFields = true;
/**
* An array of field names that are allowed
* to be set by the user in inserts/updates.
*
* @var list<string>
*/
protected $allowedFields = [];
/**
* If true, will set created_at, and updated_at
* values during insert and update routines.
*
* @var bool
*/
protected $useTimestamps = false;
/**
* The type of column that created_at and updated_at
* are expected to.
*
* @var 'date'|'datetime'|'int'
*/
protected $dateFormat = 'datetime';
/**
* The column used for insert timestamps.
*
* @var string
*/
protected $createdField = 'created_at';
/**
* The column used for update timestamps.
*
* @var string
*/
protected $updatedField = 'updated_at';
/**
* If this model should use "softDeletes" and
* simply set a date when rows are deleted, or
* do hard deletes.
*
* @var bool
*/
protected $useSoftDeletes = false;
/**
* Used by $this->withDeleted() to override the
* model's "softDelete" setting.
*
* @var bool
*/
protected $tempUseSoftDeletes;
/**
* The column used to save soft delete state.
*
* @var string
*/
protected $deletedField = 'deleted_at';
/**
* Whether to allow inserting empty data.
*/
protected bool $allowEmptyInserts = false;
/**
* Whether to update Entity's only changed data.
*/
protected bool $updateOnlyChanged = true;
/**
* Rules used to validate data in insert(), update(), save(),
* insertBatch(), and updateBatch() methods.
*
* The array must match the format of data passed to the `Validation`
* library.
*
* @see https://codeigniter4.github.io/userguide/models/model.html#setting-validation-rules
*
* @var array<string, array<string, array<string, string>|string>|string>|string
*/
protected $validationRules = [];
/**
* Contains any custom error messages to be
* used during data validation.
*
* @var array<string, array<string, string>> The column is used as the keys.
*/
protected $validationMessages = [];
/**
* Skip the model's validation.
*
* Used in conjunction with `$this->skipValidation()`
* to skip data validation for any future calls.
*
* @var bool
*/
protected $skipValidation = false;
/**
* Whether rules should be removed that do not exist
* in the passed data. Used in updates.
*
* @var bool
*/
protected $cleanValidationRules = true;
/**
* Our validator instance.
*
* @var ValidationInterface|null
*/
protected $validation;
/*
* Callbacks.
*
* Each array should contain the method names (within the model)
* that should be called when those events are triggered.
*
* "Update" and "delete" methods are passed the same items that
* are given to their respective method.
*
* "Find" methods receive the ID searched for (if present), and
* 'afterFind' additionally receives the results that were found.
*/
/**
* Whether to trigger the defined callbacks.
*
* @var bool
*/
protected $allowCallbacks = true;
/**
* Used by $this->allowCallbacks() to override the
* model's $allowCallbacks setting.
*
* @var bool
*/
protected $tempAllowCallbacks;
/**
* Callbacks for "beforeInsert" event.
*
* @var list<string>
*/
protected $beforeInsert = [];
/**
* Callbacks for "afterInsert" event.
*
* @var list<string>
*/
protected $afterInsert = [];
/**
* Callbacks for "beforeUpdate" event.
*
* @var list<string>
*/
protected $beforeUpdate = [];
/**
* Callbacks for "afterUpdate" event.
*
* @var list<string>
*/
protected $afterUpdate = [];
/**
* Callbacks for "beforeInsertBatch" event.
*
* @var list<string>
*/
protected $beforeInsertBatch = [];
/**
* Callbacks for "afterInsertBatch" event.
*
* @var list<string>
*/
protected $afterInsertBatch = [];
/**
* Callbacks for "beforeUpdateBatch" event.
*
* @var list<string>
*/
protected $beforeUpdateBatch = [];
/**
* Callbacks for "afterUpdateBatch" event.
*
* @var list<string>
*/
protected $afterUpdateBatch = [];
/**
* Callbacks for "beforeFind" event.
*
* @var list<string>
*/
protected $beforeFind = [];
/**
* Callbacks for "afterFind" event.
*
* @var list<string>
*/
protected $afterFind = [];
/**
* Callbacks for "beforeDelete" event.
*
* @var list<string>
*/
protected $beforeDelete = [];
/**
* Callbacks for "afterDelete" event.
*
* @var list<string>
*/
protected $afterDelete = [];
public function __construct(?ValidationInterface $validation = null)
{
$this->tempReturnType = $this->returnType;
$this->tempUseSoftDeletes = $this->useSoftDeletes;
$this->tempAllowCallbacks = $this->allowCallbacks;
$this->validation = $validation;
$this->initialize();
$this->createDataConverter();
}
/**
* Creates DataConverter instance.
*/
protected function createDataConverter(): void
{
if ($this->useCasts()) {
$this->converter = new DataConverter(
$this->casts,
$this->castHandlers,
$this->db,
);
}
}
/**
* Are casts used?
*/
protected function useCasts(): bool
{
return $this->casts !== [];
}
/**
* Initializes the instance with any additional steps.
* Optionally implemented by child classes.
*
* @return void
*/
protected function initialize()
{
}
/**
* Fetches the row(s) of database with a primary key
* matching $id.
* This method works only with DB calls.
*
* @param bool $singleton Single or multiple results.
* @param int|list<int|string>|string|null $id One primary key or an array of primary keys.
*
* @return ($singleton is true ? object|row_array|null : list<object|row_array>) The resulting row of data or `null`.
*/
abstract protected function doFind(bool $singleton, $id = null);
/**
* Fetches the column of database.
* This method works only with DB calls.
*
* @return list<row_array>|null The resulting row of data or `null` if no data found.
*
* @throws DataException
*/
abstract protected function doFindColumn(string $columnName);
/**
* Fetches all results, while optionally limiting them.
* This method works only with DB calls.
*
* @return list<object|row_array>
*/
abstract protected function doFindAll(?int $limit = null, int $offset = 0);
/**
* Returns the first row of the result set.
* This method works only with DB calls.
*
* @return object|row_array|null
*/
abstract protected function doFirst();
/**
* Inserts data into the current database.
* This method works only with DB calls.
*
* @param row_array $row
*
* @return bool
*/
abstract protected function doInsert(array $row);
/**
* Compiles batch insert and runs the queries, validating each row prior.
* This method works only with DB calls.
*
* @param list<object|row_array>|null $set An associative array of insert values.
* @param bool|null $escape Whether to escape values.
* @param int $batchSize The size of the batch to run.
* @param bool $testing `true` means only number of records is returned, `false` will execute the query.
*
* @return false|int|list<string> Number of rows affected or `false` on failure, SQL array when test mode
*/
abstract protected function doInsertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false);
/**
* Updates a single record in the database.
* This method works only with DB calls.
*
* @param int|list<int|string>|string|null $id
* @param row_array|null $row
*/
abstract protected function doUpdate($id = null, $row = null): bool;
/**
* Compiles an update and runs the query.
* This method works only with DB calls.
*
* @param list<object|row_array>|null $set An associative array of update values.
* @param string|null $index The where key.
* @param int $batchSize The size of the batch to run.
* @param bool $returnSQL `true` means SQL is returned, `false` will execute the query.
*
* @return false|int|list<string> Number of rows affected or `false` on failure, SQL array when test mode
*
* @throws DatabaseException
*/
abstract protected function doUpdateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false);
/**
* Deletes a single record from the database where $id matches
* the table's primary key.
* This method works only with DB calls.
*
* @param int|list<int|string>|string|null $id The rows primary key(s).
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return bool|string Returns a SQL string if in test mode.
*
* @throws DatabaseException
*/
abstract protected function doDelete($id = null, bool $purge = false);
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (value of column $deletedField is not null).
* This method works only with DB calls.
*
* @return bool|string Returns a SQL string if in test mode.
*/
abstract protected function doPurgeDeleted();
/**
* Works with the $this->find* methods to return only the rows that
* have been deleted (value of column $deletedField is not null).
* This method works only with DB calls.
*
* @return void
*/
abstract protected function doOnlyDeleted();
/**
* Compiles a replace and runs the query.
* This method works only with DB calls.
*
* @param row_array|null $row
* @param bool $returnSQL `true` means SQL is returned, `false` will execute the query.
*
* @return BaseResult|false|Query|string
*/
abstract protected function doReplace(?array $row = null, bool $returnSQL = false);
/**
* Grabs the last error(s) that occurred from the Database connection.
* This method works only with DB calls.
*
* @return array<string, string>
*/
abstract protected function doErrors();
/**
* Public getter to return the ID value for the data array or object.
* For example with SQL this will return `$data->{$this->primaryKey}`.
*
* @param object|row_array $row
*
* @return int|string|null
*/
abstract public function getIdValue($row);
/**
* Override countAllResults to account for soft deleted accounts.
* This method works only with DB calls.
*
* @param bool $reset When `false`, the `$tempUseSoftDeletes` will be
* dependent on `$useSoftDeletes` value because we don't
* want to add the same "where" condition for the second time.
* @param bool $test `true` returns the number of all records, `false` will execute the query.
*
* @return int|string Returns a SQL string if in test mode.
*/
abstract public function countAllResults(bool $reset = true, bool $test = false);
/**
* Loops over records in batches, allowing you to operate on them.
* This method works only with DB calls.
*
* @param Closure(array<string, string>|object): mixed $userFunc
*
* @return void
*
* @throws DataException
* @throws InvalidArgumentException if $size is not a positive integer
*/
abstract public function chunk(int $size, Closure $userFunc);
/**
* Fetches the row of database.
*
* @param int|list<int|string>|string|null $id One primary key or an array of primary keys.
*
* @return ($id is int|string ? object|row_array|null : list<object|row_array>)
*/
public function find($id = null)
{
$singleton = is_numeric($id) || is_string($id);
if ($this->tempAllowCallbacks) {
// Call the before event and check for a return
$eventData = $this->trigger('beforeFind', [
'id' => $id,
'method' => 'find',
'singleton' => $singleton,
]);
if (isset($eventData['returnData']) && $eventData['returnData'] === true) {
return $eventData['data'];
}
}
$eventData = [
'id' => $id,
'data' => $this->doFind($singleton, $id),
'method' => 'find',
'singleton' => $singleton,
];
if ($this->tempAllowCallbacks) {
$eventData = $this->trigger('afterFind', $eventData);
}
$this->tempReturnType = $this->returnType;
$this->tempUseSoftDeletes = $this->useSoftDeletes;
$this->tempAllowCallbacks = $this->allowCallbacks;
return $eventData['data'];
}
/**
* Fetches the column of database.
*
* @return list<bool|float|int|list<mixed>|object|string|null>|null The resulting row of data, or `null` if no data found.
*
* @throws DataException
*/
public function findColumn(string $columnName)
{
if (str_contains($columnName, ',')) {
throw DataException::forFindColumnHaveMultipleColumns();
}
$resultSet = $this->doFindColumn($columnName);
return $resultSet !== null ? array_column($resultSet, $columnName) : null;
}
/**
* Fetches all results, while optionally limiting them.
*
* @return list<object|row_array>
*/
public function findAll(?int $limit = null, int $offset = 0)
{
$limitZeroAsAll = config(Feature::class)->limitZeroAsAll ?? true;
if ($limitZeroAsAll) {
$limit ??= 0;
}
if ($this->tempAllowCallbacks) {
// Call the before event and check for a return
$eventData = $this->trigger('beforeFind', [
'method' => 'findAll',
'limit' => $limit,
'offset' => $offset,
'singleton' => false,
]);
if (isset($eventData['returnData']) && $eventData['returnData'] === true) {
return $eventData['data'];
}
}
$eventData = [
'data' => $this->doFindAll($limit, $offset),
'limit' => $limit,
'offset' => $offset,
'method' => 'findAll',
'singleton' => false,
];
if ($this->tempAllowCallbacks) {
$eventData = $this->trigger('afterFind', $eventData);
}
$this->tempReturnType = $this->returnType;
$this->tempUseSoftDeletes = $this->useSoftDeletes;
$this->tempAllowCallbacks = $this->allowCallbacks;
return $eventData['data'];
}
/**
* Returns the first row of the result set.
*
* @return object|row_array|null
*/
public function first()
{
if ($this->tempAllowCallbacks) {
// Call the before event and check for a return
$eventData = $this->trigger('beforeFind', [
'method' => 'first',
'singleton' => true,
]);
if (isset($eventData['returnData']) && $eventData['returnData'] === true) {
return $eventData['data'];
}
}
$eventData = [
'data' => $this->doFirst(),
'method' => 'first',
'singleton' => true,
];
if ($this->tempAllowCallbacks) {
$eventData = $this->trigger('afterFind', $eventData);
}
$this->tempReturnType = $this->returnType;
$this->tempUseSoftDeletes = $this->useSoftDeletes;
$this->tempAllowCallbacks = $this->allowCallbacks;
return $eventData['data'];
}
/**
* A convenience method that will attempt to determine whether the
* data should be inserted or updated.
*
* Will work with either an array or object.
* When using with custom class objects,
* you must ensure that the class will provide access to the class
* variables, even if through a magic method.
*
* @param object|row_array $row
*
* @throws ReflectionException
*/
public function save($row): bool
{
if ((array) $row === []) {
return true;
}
if ($this->shouldUpdate($row)) {
$response = $this->update($this->getIdValue($row), $row);
} else {
$response = $this->insert($row, false);
if ($response !== false) {
$response = true;
}
}
return $response;
}
/**
* This method is called on save to determine if entry have to be updated.
* If this method returns `false` insert operation will be executed.
*
* @param object|row_array $row
*/
protected function shouldUpdate($row): bool
{
$id = $this->getIdValue($row);
return ! in_array($id, [null, [], ''], true);
}
/**
* Returns last insert ID or 0.
*
* @return int|string
*/
public function getInsertID()
{
return is_numeric($this->insertID) ? (int) $this->insertID : $this->insertID;
}
/**
* Validates that the primary key values are valid for update/delete/insert operations.
* Throws exception if invalid.
*
* @param bool $allowArray Whether to allow array of IDs (true for update/delete, false for insert)
*
* @phpstan-assert non-zero-int|non-empty-list<int|string>|RawSql|non-falsy-string $id
* @throws InvalidArgumentException
*/
protected function validateID(mixed $id, bool $allowArray = true): void
{
if (is_array($id)) {
// Check if arrays are allowed
if (! $allowArray) {
throw new InvalidArgumentException(
'Invalid primary key: only a single value is allowed, not an array.',
);
}
// Check for empty array
if ($id === []) {
throw new InvalidArgumentException('Invalid primary key: cannot be an empty array.');
}
// Validate each ID in the array recursively
foreach ($id as $key => $valueId) {
if (is_array($valueId)) {
throw new InvalidArgumentException(
sprintf('Invalid primary key at index %s: nested arrays are not allowed.', $key),
);
}
// Recursive call for each value (single values only in recursion)
$this->validateID($valueId, false);
}
return;
}
// Allow RawSql objects for complex scenarios
if ($id instanceof RawSql) {
return;
}
// Check for invalid single values
if (in_array($id, [null, 0, '0', '', true, false], true)) {
$type = is_bool($id) ? 'boolean ' . var_export($id, true) : var_export($id, true);
throw new InvalidArgumentException(
sprintf('Invalid primary key: %s is not allowed.', $type),
);
}
// Only allow int and string at this point
if (! is_int($id) && ! is_string($id)) {
throw new InvalidArgumentException(
sprintf('Invalid primary key: must be int or string, %s given.', get_debug_type($id)),
);
}
}
/**
* Inserts data into the database. If an object is provided,
* it will attempt to convert it to an array.
*
* @param object|row_array|null $row
* @param bool $returnID Whether insert ID should be returned or not.
*
* @return ($returnID is true ? false|int|string : bool)
*
* @throws ReflectionException
*/
public function insert($row = null, bool $returnID = true)
{
$this->insertID = 0;
// Set $cleanValidationRules to false temporary.
$cleanValidationRules = $this->cleanValidationRules;
$this->cleanValidationRules = false;
$row = $this->transformDataToArray($row, 'insert');
// Validate data before saving.
if (! $this->skipValidation && ! $this->validate($row)) {
// Restore $cleanValidationRules
$this->cleanValidationRules = $cleanValidationRules;
return false;
}
// Restore $cleanValidationRules
$this->cleanValidationRules = $cleanValidationRules;
// Must be called first, so we don't
// strip out created_at values.
$row = $this->doProtectFieldsForInsert($row);
// doProtectFields() can further remove elements from
// $row, so we need to check for empty dataset again
if (! $this->allowEmptyInserts && $row === []) {
throw DataException::forEmptyDataset('insert');
}
// Set created_at and updated_at with same time
$date = $this->setDate();
$row = $this->setCreatedField($row, $date);
$row = $this->setUpdatedField($row, $date);
$eventData = ['data' => $row];
if ($this->tempAllowCallbacks) {
$eventData = $this->trigger('beforeInsert', $eventData);
}
$result = $this->doInsert($eventData['data']);
$eventData = [
'id' => $this->insertID,
'data' => $eventData['data'],
'result' => $result,
];
if ($this->tempAllowCallbacks) {
// Trigger afterInsert events with the inserted data and new ID
$this->trigger('afterInsert', $eventData);
}
$this->tempAllowCallbacks = $this->allowCallbacks;
// If insertion failed, get out of here
if (! $result) {
return $result;
}
// otherwise return the insertID, if requested.
return $returnID ? $this->insertID : $result;
}
/**
* Set datetime to created field.
*
* @param row_array $row
* @param int|string $date Timestamp or datetime string.
*
* @return row_array
*/
protected function setCreatedField(array $row, $date): array
{
if ($this->useTimestamps && $this->createdField !== '' && ! array_key_exists($this->createdField, $row)) {
$row[$this->createdField] = $date;
}
return $row;
}
/**
* Set datetime to updated field.
*
* @param row_array $row
* @param int|string $date Timestamp or datetime string
*
* @return row_array
*/
protected function setUpdatedField(array $row, $date): array
{
if ($this->useTimestamps && $this->updatedField !== '' && ! array_key_exists($this->updatedField, $row)) {
$row[$this->updatedField] = $date;
}
return $row;
}
/**
* Compiles batch insert runs the queries, validating each row prior.
*
* @param list<object|row_array>|null $set An associative array of insert values.
* @param bool|null $escape Whether to escape values.
* @param int $batchSize The size of the batch to run.
* @param bool $testing `true` means only number of records is returned, `false` will execute the query.
*
* @return false|int|list<string> Number of rows inserted or `false` on failure.
*
* @throws ReflectionException
*/
public function insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false)
{
// Set $cleanValidationRules to false temporary.
$cleanValidationRules = $this->cleanValidationRules;
$this->cleanValidationRules = false;
if (is_array($set)) {
foreach ($set as &$row) {
$row = $this->transformDataToArray($row, 'insert');
// Validate every row.
if (! $this->skipValidation && ! $this->validate($row)) {
// Restore $cleanValidationRules
$this->cleanValidationRules = $cleanValidationRules;
return false;
}
// Must be called first so we don't
// strip out created_at values.
$row = $this->doProtectFieldsForInsert($row);
// Set created_at and updated_at with same time
$date = $this->setDate();
$row = $this->setCreatedField($row, $date);
$row = $this->setUpdatedField($row, $date);
}
}
// Restore $cleanValidationRules
$this->cleanValidationRules = $cleanValidationRules;