-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPicoDatabasePersistence.php
More file actions
4309 lines (4052 loc) · 155 KB
/
PicoDatabasePersistence.php
File metadata and controls
4309 lines (4052 loc) · 155 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
namespace MagicObject\Database;
use DateTime;
use Exception;
use MagicObject\Exceptions\ClassNotFoundException;
use MagicObject\Exceptions\DataRetrievalException;
use MagicObject\Exceptions\NoRecordFoundException;
use MagicObject\Exceptions\EntityException;
use MagicObject\Exceptions\InvalidAnnotationException;
use MagicObject\Exceptions\InvalidFilterException;
use MagicObject\Exceptions\InvalidParameterException;
use MagicObject\Exceptions\NoInsertableColumnException;
use MagicObject\Exceptions\NoColumnMatchException;
use MagicObject\Exceptions\NoDatabaseConnectionException;
use MagicObject\Exceptions\NoUpdatableColumnException;
use MagicObject\Exceptions\NoPrimaryKeyDefinedException;
use MagicObject\Exceptions\UnknownErrorException;
use MagicObject\MagicObject;
use MagicObject\Util\ClassUtil\ExtendedReflectionClass;
use MagicObject\Util\ClassUtil\PicoAnnotationParser;
use MagicObject\Util\ClassUtil\PicoEmptyParameter;
use MagicObject\Util\Database\PicoDatabaseUtil;
use MagicObject\Util\Database\PicoTimeZoneChanger;
use PDO;
use PDOException;
use PDOStatement;
use ReflectionProperty;
use stdClass;
/**
* Database persistence
*
* @author Kamshory
* @package MagicObject\Database
* @link https://github.com/Planetbiru/MagicObject
*/
class PicoDatabasePersistence // NOSONAR
{
const ANNOTATION_TABLE = "Table";
const ANNOTATION_CACHE = "Cache";
const ANNOTATION_COLUMN = "Column";
const ANNOTATION_JOIN_COLUMN = "JoinColumn";
const ANNOTATION_VAR = "var";
const ANNOTATION_ID = "Id";
const ANNOTATION_GENERATED_VALUE = "GeneratedValue";
const ANNOTATION_NOT_NULL = "NotNull";
const ANNOTATION_DEFAULT_COLUMN = "DefaultColumn";
const ANNOTATION_JSON_FORMAT = "JsonFormat";
const ANNOTATION_PACKAGE = "package";
const SQL_DATE_TIME_FORMAT = "SqlDateTimeFormat";
const KEY_NAME = "name";
const KEY_REFERENCE_COLUMN_NAME = "referenceColumnName";
const KEY_NULL = "null";
const KEY_NOT_NULL = "notnull";
const KEY_NULLABLE = "nullable";
const KEY_INSERTABLE = "insertable";
const KEY_UPDATABLE = "updatable";
const KEY_STRATEGY = "strategy";
const KEY_GENERATOR = "generator";
const KEY_PROPERTY_TYPE = "propertyType";
const KEY_VALUE = "value";
const KEY_TYPE = "type";
const KEY_ENABLE = "enable";
const KEY_ENTITY_OBJECT = "entityObject";
const VALUE_TRUE = "true";
const VALUE_FALSE = "false";
const ORDER_ASC = "asc";
const ORDER_DESC = "desc";
const MESSAGE_NO_PRIMARY_KEY_DEFINED = "No primary key is defined.";
const MESSAGE_NO_RECORD_FOUND = "No records found.";
const MESSAGE_INVALID_FILTER = "Invalid filter";
const SQL_DATETIME_FORMAT = "Y-m-d H:i:s";
const DATE_TIME_FORMAT = "datetimeformat";
const NAMESPACE_SEPARATOR = "\\";
const JOIN_TABLE_SUBFIX = "__jn__";
const MAX_LINE_LENGTH = 80;
const COMMA = ", ";
const COMMA_RETURN = ", \r\n";
const INLINE_TRIM = " \r\n\t ";
const ALWAYS_TRUE = "(1=1)";
const IS_NULL = " is null";
const CLAUSE_AND = " and ";
/**
* Database connection
*
* @var PicoDatabase
*/
protected $database;
/**
* Object
*
* @var MagicObject
*/
protected $object;
/**
* Class name
* @var string
*/
protected $className = "";
/**
* Skip null
*
* @var bool
*/
private $flagIncludeNull = false;
/**
* Imported class list
*
* @var array
*/
private $importedClassList = array();
/**
* Flag that class list has been processed or not
*
* @var bool
*/
private $processClassList = false;
/**
* Get namespace of class
*
* @var string
*/
private $namespaceName = "";
/**
* Flag that generated value has been added
*
* @var bool
*/
private $generatedValue = false;
/**
* Flag that entity require database autoincrement
*
* @var bool
*/
private $requireDbAutoincrement = false;
/**
* Flag that database autoincrement has been completed
*
* @var bool
*/
private $dbAutoinrementCompleted = false;
/**
* Table Info
*
* @var PicoTableInfo
*/
private $tableInfoProp = null;
/**
* Entity table cache
*
* @var array
*/
private $entityTable = array();
/**
* Join map
*
* @var PicoJoinMap[]
*/
protected $joinColumMaps = array();
/**
* Flag that WHERE is defined first
*
* @var bool
*/
protected $whereIsDefinedFirst = false;
/**
* WHERE saved on previous
*
* @var string
*/
protected $whereStr = null;
/**
* Specification
*
* @var PicoSpecification
*/
protected $specification;
/**
* Pageable
*
* @var PicoPageable
*/
protected $pageable;
/**
* Sortable
*
* @var PicoSortable
*/
protected $sortable;
/**
* Join cache
*
* @var array
*/
private $joinCache = array();
/**
* The timezone offset for the current session, in the format '+hh:mm' or '-hh:mm'.
* This offset represents the time difference between the current session's timezone and UTC.
*
* @var string
*/
private $timeZoneOffset;
/**
* The system's timezone offset, representing the offset used by the system's configuration,
* in the format '+hh:mm' or '-hh:mm'.
* This offset is typically used when interacting with the system's time settings.
*
* @var string
*/
private $timeZoneOffsetSystem;
/**
* The timezone identifier for the current session, e.g., 'Asia/Jakarta'.
* This timezone is used for time-related operations within the session.
*
* @var string
*/
private $timeZone;
/**
* The system's timezone identifier, representing the timezone used by the system,
* e.g., 'Europe/London'.
* This timezone is typically used for system-level time settings.
*
* @var string
*/
private $timeZoneSystem;
/**
* Class constructor to initialize database connection and entity object.
*
* @param PicoDatabase|null $database Database connection or null
* @param MagicObject|mixed $object Entity object to be handled
*/
public function __construct($database, $object)
{
$this->database = $database;
$this->className = get_class($object);
$this->object = $object;
$timeZoneSystem = null;
$currentTimeZone = date_default_timezone_get();
if(isset($database))
{
$databaseConfig = $this->database->getDatabaseCredentials();
$timeZoneSystem = $databaseConfig->getTimeZoneSystem();
}
if(!isset($timeZoneSystem))
{
$timeZoneSystem = $currentTimeZone;
}
$this->timeZone = $currentTimeZone;
$this->timeZoneSystem = $timeZoneSystem;
$this->timeZoneOffset = PicoDatabase::getTimeZoneOffsetFromString($currentTimeZone);
$this->timeZoneOffsetSystem = PicoDatabase::getTimeZoneOffsetFromString($timeZoneSystem);
}
/**
* Check if a given string is null or empty.
*
* @param string $string The string to check
* @return bool true if the string is null or empty, false otherwise
*/
public static function nullOrEmpty($string)
{
return $string == null || empty($string);
}
/**
* Check if a given string is not null and not empty.
*
* @param string $string The string to check
* @return bool true if the string is not null and not empty, false otherwise
*/
public static function notNullAndNotEmpty($string)
{
return $string != null && !empty($string);
}
/**
* Apply results from a subquery to master data.
*
* @param array $data Master data to which subquery results will be applied
* @param array $row Reference data containing subquery results
* @param array $subqueryMap Mapping information for subqueries
* @return array Updated master data with applied subquery results
*/
public static function applySubqueryResult($data, $row, $subqueryMap)
{
if(isset($subqueryMap) && is_array($subqueryMap))
{
foreach($subqueryMap as $info)
{
$objectName = $info['objectName'];
$objectNameSub = $info['objectName'];
if(isset($row[$objectNameSub]))
{
$data[$objectName] = (new MagicObject())
->set($info['primaryKey'], $row[$info['columnName']])
->set($info['propertyName'], $row[$objectNameSub])
;
}
else
{
$data[$objectName] = new MagicObject();
}
}
}
return $data;
}
/**
* Set a flag to include or skip null columns in the operation.
*
* @param bool $skip Flag indicating whether to skip null columns
* @return self Returns the current instance for method chaining.
*/
public function includeNull($skip)
{
$this->flagIncludeNull = $skip;
return $this;
}
/**
* Parse a key-value string using a specified parser.
*
* @param PicoAnnotationParser $reflexClass The class used for parsing
* @param string $queryString The key-value string to parse
* @param string $parameter The name of the parameter being parsed
* @return array Parsed key-value pairs
* @throws InvalidAnnotationException If the annotations are invalid or cannot be parsed.
*/
private function parseKeyValue($reflexClass, $queryString, $parameter)
{
try
{
return $reflexClass->parseKeyValue($queryString);
}
catch(InvalidAnnotationException $e)
{
throw new InvalidAnnotationException("Invalid annotation @".$parameter);
}
}
/**
* Add column name to the columns array based on provided parameters.
*
* @param array $columns The current columns array
* @param PicoAnnotationParser $reflexProp The property parser
* @param ReflectionProperty $prop The property reflection instance
* @param array $parameters Parameters containing column name annotations
* @return array Updated columns array with new column names
*/
private function addColumnName($columns, $reflexProp, $prop, $parameters)
{
foreach($parameters as $param=>$val)
{
if(strcasecmp($param, self::ANNOTATION_COLUMN) == 0)
{
$values = $this->parseKeyValue($reflexProp, $val, $param);
if(!empty($values))
{
if(isset($values['default_value']))
{
// Add defaultValue
$values[MagicObject::KEY_DEFAULT_VALUE] = $values['default_value'];
}
$columns[$prop->name] = $values;
}
}
}
return $columns;
}
/**
* Add column type information to the columns array.
*
* @param array $columns The current columns array
* @param PicoAnnotationParser $reflexProp The property parser
* @param ReflectionProperty $prop The property reflection instance
* @param array $parameters Parameters containing column type annotations
* @return array Updated columns array with new column types
*/
private function addColumnType($columns, $reflexProp, $prop, $parameters)
{
foreach($parameters as $param=>$val)
{
if(strcasecmp($param, self::ANNOTATION_VAR) == 0 && isset($columns[$prop->name]))
{
$type = explode(' ', trim($val, self::INLINE_TRIM))[0];
$columns[$prop->name][self::KEY_PROPERTY_TYPE] = $type;
}
if(strcasecmp($param, self::SQL_DATE_TIME_FORMAT) == 0)
{
$values = $this->parseKeyValue($reflexProp, $val, $param);
if(isset($values['pattern']))
{
$columns[$prop->name][self::DATE_TIME_FORMAT] = $values['pattern'];
}
}
}
return $columns;
}
/**
* Add a join column name to the join columns array.
*
* @param array $joinColumns The current join columns array
* @param PicoAnnotationParser $reflexProp The property parser for the current property
* @param ReflectionProperty $prop The reflection property instance
* @param array $parameters Parameters containing join column annotations
* @return array Updated join columns array with the new column name
*/
private function addJoinColumnName($joinColumns, $reflexProp, $prop, $parameters)
{
foreach($parameters as $param=>$val)
{
if(strcasecmp($param, self::ANNOTATION_JOIN_COLUMN) == 0)
{
$values = $this->parseKeyValue($reflexProp, $val, $param);
if(!empty($values))
{
$joinColumns[$prop->name] = $values;
}
}
}
return $joinColumns;
}
/**
* Add a join column type to the join columns array.
*
* @param array $joinColumns The current join columns array
* @param ReflectionProperty $prop The reflection property instance
* @param array $parameters Parameters containing join column type annotations
* @return array Updated join columns array with the new column type
*/
private function addJoinColumnType($joinColumns, $prop, $parameters)
{
foreach($parameters as $param=>$val)
{
if(strcasecmp($param, self::ANNOTATION_VAR) == 0 && isset($joinColumns[$prop->name]))
{
$type = explode(' ', trim($val, self::INLINE_TRIM))[0];
$joinColumns[$prop->name][self::KEY_PROPERTY_TYPE] = $type;
$joinColumns[$prop->name][self::KEY_ENTITY_OBJECT] = true;
}
}
return $joinColumns;
}
/**
* Add primary key information to the primary keys array.
*
* @param array $primaryKeys The current primary keys array
* @param array $columns The columns array
* @param ReflectionProperty $prop The reflection property instance
* @param array $parameters Parameters containing primary key annotations
* @return array Updated primary keys array with the new primary key
*/
private function addPrimaryKey($primaryKeys, $columns, $prop, $parameters)
{
foreach($parameters as $param=>$val)
{
if(strcasecmp($param, self::ANNOTATION_ID) == 0 && isset($columns[$prop->name]))
{
$primaryKeys[$prop->name] = array(self::KEY_NAME=>$columns[$prop->name][self::KEY_NAME]);
}
}
return $primaryKeys;
}
/**
* Add autogenerated key information to the auto-increment keys array.
*
* @param array $autoIncrementKeys The current auto-increment keys array
* @param array $columns The columns array
* @param PicoAnnotationParser $reflexClass The property parser
* @param ReflectionProperty $prop The reflection property instance
* @param array $parameters Parameters containing auto-generated value annotations
* @return array Updated auto-increment keys array with new autogenerated key
*/
private function addAutogenerated($autoIncrementKeys, $columns, $reflexClass, $prop, $parameters)
{
foreach($parameters as $param=>$val)
{
if(strcasecmp($param, self::ANNOTATION_GENERATED_VALUE) == 0 && isset($columns[$prop->name]))
{
$vals = $this->parseKeyValue($reflexClass, $val, $param);
$autoIncrementKeys[$prop->name] = array(
self::KEY_NAME=>isset($columns[$prop->name][self::KEY_NAME])?$columns[$prop->name][self::KEY_NAME]:null,
self::KEY_STRATEGY=>isset($vals[self::KEY_STRATEGY])?$vals[self::KEY_STRATEGY]:null,
self::KEY_GENERATOR=>isset($vals[self::KEY_GENERATOR])?$vals[self::KEY_GENERATOR]:null
);
}
}
return $autoIncrementKeys;
}
/**
* Add default value information to the default values array.
*
* @param array $defaultValue The current default values array
* @param array $columns The columns array
* @param PicoAnnotationParser $reflexClass The property parser
* @param ReflectionProperty $prop The reflection property instance
* @param array $parameters Parameters containing default value annotations
* @return array Updated default values array with new default value
*/
private function addDefaultValue($defaultValue, $columns, $reflexClass, $prop, $parameters)
{
foreach($parameters as $param=>$val)
{
if(strcasecmp($param, self::ANNOTATION_DEFAULT_COLUMN) == 0)
{
$vals = $this->parseKeyValue($reflexClass, $val, $param);
if(isset($vals[self::KEY_VALUE]))
{
$defaultValue[$prop->name] = array(
self::KEY_NAME=>isset($columns[$prop->name][self::KEY_NAME])?$columns[$prop->name][self::KEY_NAME]:null,
self::KEY_VALUE=>$vals[self::KEY_VALUE],
self::KEY_PROPERTY_TYPE=>$columns[$prop->name][self::KEY_PROPERTY_TYPE]
);
}
}
}
return $defaultValue;
}
/**
* Add not-null column information to the not-null columns array.
*
* @param array $notNullColumns The current not-null columns array
* @param array $columns The columns array
* @param ReflectionProperty $prop The reflection property instance
* @param array $parameters Parameters containing not-null annotations
* @return array Updated not-null columns array with new not-null column
*/
private function addNotNull($notNullColumns, $columns, $prop, $parameters)
{
foreach($parameters as $param=>$val)
{
if(strcasecmp($param, self::ANNOTATION_NOT_NULL) == 0 && isset($columns[$prop->name]))
{
$notNullColumns[$prop->name] = array(self::KEY_NAME=>$columns[$prop->name][self::KEY_NAME]);
}
}
return $notNullColumns;
}
/**
* Get table information by parsing class and property annotations.
*
* @return PicoTableInfo Table information based on parsed annotations
* @throws EntityException If the entity is invalid
*/
public function getTableInfo()
{
if(!isset($this->tableInfoProp))
{
$noCache = false;
$reflexClass = new PicoAnnotationParser($this->className);
$table = $reflexClass->getParameter(self::ANNOTATION_TABLE);
$cache = $reflexClass->getParameter(self::ANNOTATION_CACHE);
$package = $reflexClass->getParameter(self::ANNOTATION_PACKAGE);
if(!isset($table))
{
throw new EntityException($this->className . " is not valid entity");
}
if(isset($cache))
{
$noCache = isset($cache[self::KEY_ENABLE]) && self::VALUE_FALSE == strtolower($cache[self::KEY_ENABLE]);
}
if(empty($package))
{
$package = null;
}
$values = $this->parseKeyValue($reflexClass, $table, self::ANNOTATION_TABLE);
$picoTableName = isset($values[self::KEY_NAME]) ? $values[self::KEY_NAME] : "";
$columns = array();
$joinColumns = array();
$primaryKeys = array();
$autoIncrementKeys = array();
$notNullColumns = array();
$props = $reflexClass->getProperties();
$defaultValue = array();
// iterate each properties of the class
foreach($props as $prop)
{
$reflexProp = new PicoAnnotationParser($this->className, $prop->name, PicoAnnotationParser::PROPERTY);
$parameters = $reflexProp->getParameters();
// get column name of each parameters
$columns = $this->addColumnName($columns, $reflexProp, $prop, $parameters);
// set column type
$columns = $this->addColumnType($columns, $reflexProp, $prop, $parameters);
// get join column name of each parameters
$joinColumns = $this->addJoinColumnName($joinColumns, $reflexProp, $prop, $parameters);
// set join column type
$joinColumns = $this->addJoinColumnType($joinColumns, $prop, $parameters);
// list primary key
$primaryKeys = $this->addPrimaryKey($primaryKeys, $columns, $prop, $parameters);
// list autogenerated column
$autoIncrementKeys = $this->addAutogenerated($autoIncrementKeys, $columns, $reflexClass, $prop, $parameters);
// define default column value
$defaultValue = $this->addDefaultValue($defaultValue, $columns, $reflexClass, $prop, $parameters);
// list not null column
$notNullColumns = $this->addNotNull($notNullColumns, $columns, $prop, $parameters);
}
// bring it together
$this->tableInfoProp = new PicoTableInfo($picoTableName, $columns, $joinColumns, $primaryKeys, $autoIncrementKeys, $defaultValue, $notNullColumns, $noCache, $package);
}
return $this->tableInfoProp;
}
/**
* Check if the given PDO statement matches any rows.
*
* @param PDOStatement $stmt PDO statement to check.
* @param string|null $databaseType Optional database type, for specific behavior (e.g., SQLite).
* @return bool true if rows match, false otherwise.
*/
public function matchRow($stmt, $databaseType = null)
{
if(isset($databaseType) && $databaseType == PicoDatabaseType::DATABASE_TYPE_SQLITE)
{
return true;
}
if($stmt == null)
{
return false;
}
$rowCount = $stmt->rowCount();
return $rowCount != null && $rowCount > 0;
}
/**
* Save the current object to the database.
*
* @param bool $includeNull Whether to include NULL values in the save operation.
* @return PDOStatement|EntityException Returns the executed statement on success or throws an exception on failure.
*/
public function save($includeNull = false)
{
$this->flagIncludeNull = $includeNull;
$queryBuilder = new PicoDatabaseQueryBuilder($this->database);
$info = $this->getTableInfo();
$stmt = null;
try
{
$where = $this->getWhere($info, $queryBuilder);
if(!$this->isValidFilter($where))
{
throw new InvalidFilterException(self::MESSAGE_INVALID_FILTER);
}
$data2saved = clone $this->object->value();
$data = $this->_select($info, $queryBuilder, $where);
if($data != null)
{
// save current data
foreach($data2saved as $prop=>$value)
{
if($value != null)
{
$this->object->set($prop, $value);
}
}
$stmt = $this->_update($info, $queryBuilder, $where);
}
else
{
$stmt = $this->_insert($info, $queryBuilder);
}
}
catch(Exception $e)
{
$stmt = $this->_insert($info, $queryBuilder);
}
return $stmt;
}
/**
* Construct a query for saving the current object data.
*
* @param bool $includeNull Whether to include NULL values in the query.
* @return PicoDatabaseQueryBuilder Returns the constructed query builder for the save operation.
* @throws EntityException If an error occurs while constructing the query.
*/
public function saveQuery($includeNull = false)
{
$this->flagIncludeNull = $includeNull;
$queryBuilder = new PicoDatabaseQueryBuilder($this->database);
$query = new PicoDatabaseQueryBuilder($this->database);
$info = $this->getTableInfo();
try
{
$where = $this->getWhere($info, $queryBuilder);
if(!$this->isValidFilter($where))
{
throw new InvalidFilterException(self::MESSAGE_INVALID_FILTER);
}
$data2saved = clone $this->object->value();
$data = $this->_select($info, $queryBuilder, $where);
if($data != null)
{
// save current data
foreach($data2saved as $prop=>$value)
{
if($value != null)
{
$this->object->set($prop, $value);
}
}
$query = $this->_updateQuery($info, $queryBuilder, $where);
}
else
{
$query = $this->_insertQuery($info, $queryBuilder);
}
}
catch(Exception $e)
{
$query = $this->_insertQuery($info, $queryBuilder);
}
return $query;
}
/**
* Retrieve the values of the object for database operations.
*
* @param PicoTableInfo $info Table information containing column definitions.
* @param PicoDatabaseQueryBuilder $queryBuilder Query builder for escaping values.
* @return array Associative array of column names and their corresponding values.
*/
private function getValues($info, $queryBuilder)
{
$values = array();
foreach($info->getColumns() as $property=>$column)
{
$columnName = $column[self::KEY_NAME];
$value = $this->object->get($property);
$value = $this->fixInput($value, $column);
if($this->flagIncludeNull || $value !== null)
{
$value = $queryBuilder->escapeValue($value);
$values[$columnName] = $value;
}
}
return $values;
}
/**
* Get a list of columns that should be set to NULL.
*
* @param PicoTableInfo $info Table information containing column definitions.
* @return array List of column names that should be set to NULL.
*/
private function getNullCols($info)
{
$nullCols = array();
$nullList = $this->object->nullPropertyList();
if(self::isArray($nullList))
{
foreach($nullList as $key=>$val)
{
if($val === true && isset($info->getColumns()[$key]))
{
$columnName = $info->getColumns()[$key][self::KEY_NAME];
$nullCols[] = $columnName;
}
}
}
return $nullCols;
}
/**
* Retrieve a list of columns that are not insertable.
*
* @param PicoTableInfo $info Table information containing column definitions.
* @return array List of non-insertable column names.
*/
private function getNonInsertableCols($info)
{
$nonInsertableCols = array();
foreach($info->getColumns() as $params)
{
if(isset($params)
&& isset($params[self::KEY_INSERTABLE])
&& strcasecmp($params[self::KEY_INSERTABLE], self::VALUE_FALSE) == 0
)
{
$columnName = $params[self::KEY_NAME];
$nonInsertableCols[] = $columnName;
}
}
return $nonInsertableCols;
}
/**
* Retrieve a list of columns that are not updatable.
*
* @param PicoTableInfo $info Table information containing column definitions.
* @return array List of non-updatable column names.
*/
private function getNonUpdatableCols($info)
{
$nonUpdatableCols = array();
foreach($info->getColumns() as $params)
{
if(isset($params)
&& isset($params[self::KEY_UPDATABLE])
&& strcasecmp($params[self::KEY_UPDATABLE], self::VALUE_FALSE) == 0
)
{
$columnName = $params[self::KEY_NAME];
$nonUpdatableCols[] = $columnName;
}
}
return $nonUpdatableCols;
}
/**
* Construct the SET clause for an SQL UPDATE operation.
*
* Iterates over the table columns, applies value escaping, and builds
* the assignment expressions for the update statement. Columns that
* are marked as non-updatable or explicitly skipped will be excluded.
* Null columns are explicitly set to NULL.
*
* @param PicoTableInfo $info Table information containing column definitions.
* @param PicoDatabaseQueryBuilder $queryBuilder Query builder used to escape values safely.
* @param string[]|null $skippedColumns Columns to skip from being updated (optional).
* @return string The constructed SET clause for the UPDATE statement.
* @throws NoUpdatableColumnException If no updatable columns are found.
*/
private function getSet($info, $queryBuilder, $skippedColumns = null)
{
if(!isset($skippedColumns))
{
$skippedColumns = array();
}
$sets = array();
$nullCols = $this->getNullCols($info);
$nonUpdatableCols = $this->getNonUpdatableCols($info);
foreach($info->getColumns() as $property=>$column)
{
$columnName = $column[self::KEY_NAME];
$value = $this->object->get($property);
$value = $this->fixInput($value, $column);
if(($this->flagIncludeNull || $value !== null)
&& !in_array($columnName, $nullCols)
&& !in_array($columnName, $nonUpdatableCols)
)
{
if(in_array($columnName, $skippedColumns))
{
continue;
}
$value = $queryBuilder->escapeValue($value);
$sets[] = $columnName . " = " . $value;
}
}
foreach($nullCols as $columnName)
{
$sets[] = "$columnName = null";
}
if(empty($sets))
{
throw new NoUpdatableColumnException("No updatable column");
}
return $this->joinStringArray($sets, self::MAX_LINE_LENGTH, self::COMMA, self::COMMA_RETURN);
}
/**
* Construct the WHERE statement for SQL operations.
*
* @param PicoTableInfo $info Table information containing primary key definitions.
* @param PicoDatabaseQueryBuilder $queryBuilder Query builder for escaping values.
* @return string The constructed WHERE clause.
* @throws NoPrimaryKeyDefinedException If no primary keys are defined.
*/
private function getWhere($info, $queryBuilder)
{
if($this->whereIsDefinedFirst && !empty($this->whereStr))
{
return $this->whereStr;
}
$wheres = array();
foreach($info->getPrimaryKeys() as $property=>$column)
{
$columnName = $column[self::KEY_NAME];
$value = $this->object->get($property);
$value = $queryBuilder->escapeValue($value);
if(strcasecmp($value, self::KEY_NULL) == 0)
{
$wheres[] = $columnName . self::IS_NULL;
}
else
{
$wheres[] = $columnName . " = " . $value;
}
}
if(empty($wheres))
{
throw new NoPrimaryKeyDefinedException("No primary key defined");
}
return implode(self::CLAUSE_AND, $wheres);
}
/**
* Builds a WHERE clause based on the table's primary key columns.
*
* This method constructs a WHERE clause for an SQL query using the primary keys
* defined in the provided table information. It retrieves the values from the
* current object, escapes them using the query builder, and generates conditions
* for each primary key. If a value is null, the condition will use "IS NULL".
*
* @param PicoTableInfo $info Table information containing primary key definitions.
* @param PicoDatabaseQueryBuilder $queryBuilder Query builder used to escape values safely.
* @return stdClass An object containing:
* - columns: associative array of column names and their values
* - whereClause: the constructed WHERE clause string
* @throws NoPrimaryKeyDefinedException If no primary keys are defined in the table.
*/
private function getWhereWithColumns($info, $queryBuilder)
{
$result = new stdClass;
if($this->whereIsDefinedFirst && !empty($this->whereStr))
{
$result->columns = array();
$result->whereClause = $this->whereStr;
return $result;
}
$wheres = array();
$columns = array();
foreach($info->getPrimaryKeys() as $property=>$column)
{
$columnName = $column[self::KEY_NAME];
$value = $this->object->get($property);
$escapedValue = $queryBuilder->escapeValue($value);
if(strcasecmp($escapedValue, self::KEY_NULL) == 0)
{
$wheres[] = $columnName . self::IS_NULL;
$columns[$columnName] = null;
}
else
{
$wheres[] = $columnName . " = " . $escapedValue;
$columns[$columnName] = $value;
}
}
if(empty($wheres))
{
throw new NoPrimaryKeyDefinedException("No primary key defined");
}
$result->columns = $columns;
$result->whereClause = implode(self::CLAUSE_AND, $wheres);
return $result;
}