-
Notifications
You must be signed in to change notification settings - Fork 0
/
Model.class.php
executable file
·1220 lines (951 loc) · 30.5 KB
/
Model.class.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
namespace Disco\classes;
/**
* This file hold the Model class.
*/
/**
* Turn a class into SQL layer abstraction for easy query building.
* These extending classes must set `$table` and `$ids`.
*/
class Model {
/**
* @var string The SQL Table associated with this model.
*/
public $table;
/**
* @var string|array The SQL primary key or composite key associated with this model.
*/
public $ids;
/**
* @var string|null An alias to apply to the model when making queries.
*/
public $alias=null;
/**
* @var boolean Was the alias set by method call?
*/
public $aliasWasSet = false;
/**
* @var array The working select statement.
*/
private $select;
/**
* @var string The working update statement.
*/
private $update='';
/**
* @var string The where condition or the working query.
*/
private $where='';
/**
* @var array The tables we should join on with the working query.
*/
private $joinOn=Array();
/**
* @var array The limit and potential limit offset to apply to the working query.
*/
private $limit=Array('offset' => null, 'limit' => null);
/**
* @var array The ordering of the working query.
*/
private $order=Array();
/**
* @var string The last query this model executed.
*/
public $lastQuery;
/**
* Reset our model conditions.
*
*
* @return void
*/
public final function clearData(){
$this->where='';
$this->joinOn=Array();
$this->limit=Array('offset' => null, 'limit' => null);
$this->order=Array();
$this->update='';
$this->alias = null;
}//clearData
/**
* Alias the table name of the model. Use when performing joins.
*
*
* @param string $alias The alias.
*
* @return self
*/
public final function alias($alias){
$this->alias = $alias;
$this->aliasWasSet = true;
return $this;
}//alias
/**
* Prepare a SELECT condition.
* Accepts its arguments through func_get_args().
*
*
* @return self
*/
public final function select(){
$data = func_get_args();
if(is_array($data[0])){
$this->select = $data[0];
}//if
else if(!isset($data[1])){
$data[0] = explode(',',$data[0]);
$this->select = $data[0];
}//elif
else {
$this->select = $data;
}//el
return $this;
}//if
/**
* Prepare an UPDATE statement.
* Uses func_get_args() to accept parameters.
*
*
* @return self
*/
public final function update(){
$this->clearData();
$data = func_get_args();
if($this->update){
$this->update = ',' . $this->update;
}//if
$this->update .= str_replace('IS NULL','=NULL',$this->prepareCondition($data,','));
return $this;
}//update
/**
* Execute the UPDATE statement that was previously prepared.
*
*
* @return mixed Return whether the update was successful.
*/
public final function finalize(){
if(!$this->update){
throw new \InvalidArgumentException;
}//if
$where = $this->where;
if($where) {
$where='WHERE '.$where;
}//if
return $this->executeQuery("UPDATE {$this->table} SET {$this->update} {$where}");
}//finalize
/**
* Alias of `$this->finalize()`.
*/
public final function commit(){
return $this->finalize();
}//commit
/**
* Execute an INSERT statement.
* Accepts its arguments through func_get_args().
*
*
* @return boolean Was the insert successful?
*/
public final function insert(){
$this->clearData();
$data = func_get_args();
$insert='';
$values='';
$tempValues=Array();
if(is_array($data[0])){
foreach($data[0] as $k=>$v){
$insert.=$k.',';
$values.='?,';
$tempValues[]=$v;
}//foreach
}//if
else if(is_array($data[1])){
$insert = $data[0];
$tempValues = $data[1];
$l=count($tempValues);
$i=0;
while($i<$l){
$values.='?,';
$i++;
}//while
}//elif
$insert = rtrim($insert,',');
$values = rtrim($values,',');
$query = "INSERT INTO {$this->table} ({$insert}) VALUES ({$values})";
if($this->executeQuery(\App::with('DB')->set($query,$tempValues))){
return \App::with('DB')->lastId();
}//if
}//insert
/**
* Execute a DELETE statement.
* Accepts its arguments through func_get_args().
*
* Delete records where all the key/value pairs match.
*
* @return mixed Whether or not the delete was successful.
*/
public final function delete(){
$this->clearData();
$this->where = $this->prepareCondition(func_get_args(),'AND');
return $this->executeQuery("DELETE FROM {$this->table} WHERE {$this->where}");
}//delete
/**
* Execute a DELETE statement.
* Accepts its arguments through func_get_args().
*
* Will delete any records that match any of the key/values pairs.
*
*
* @return mixed Whether or not the delete was successful.
*/
public final function deleteOr(){
$this->clearData();
$this->where = $this->prepareCondition(func_get_args(),'OR');
return $this->executeQuery("DELETE FROM {$this->table} WHERE {$this->where}");
}//deleteOr
/**
* Prepare a DELETE condition for the query.
*
* Delete records where a value is in the key/value pairs.
*
*
* @param string $field The field to look in.
* @param string|array $array A string of comma separated values, or an array of values.
*
* @return mixed
*/
public final function deleteIn($field,$array){
$this->clearData();
$array = $this->buildWhereInArray($array);
$this->where = "{$field} IN ({$array})";
return $this->executeQuery("DELETE FROM {$this->table} WHERE {$this->where}");
}//deleteIn
/**
* Specify a WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Will find records where all key/value pairs match.
*
* @return self
*/
public final function where(){
if($this->where){
$this->where = "{$this->where} AND ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND');
return $this;
}//where
/**
* Specify a WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Will find records where any of the key/value pairs match.
*
* @return self
*/
public final function whereOr(){
if($this->where){
$this->where = "{$this->where} AND ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'OR');
return $this;
}//where
/**
* Specify a WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
*
* Will find records where key/values pairs do not match any conditions.
*
* @return self
*/
public final function whereNotOr(){
if($this->where){
$this->where = "{$this->where} AND ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'OR','<>');
return $this;
}//where
/**
* Specify a WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Starts a new condition group by wrapping the previous condition in parenthesis and starting the new
* condition group with an AND. Then in the new condition group match records where all of the key/value pairs
* match.
* @return self
*/
public final function whereAlso(){
if($this->where){
$this->where = "{$this->where} AND ALSO ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND');
return $this;
}//where
/**
* Specify a WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Find record where none of the values match the key/value pairs.
*
* @return self
*/
public final function whereNot(){
if($this->where){
$this->where = "{$this->where} AND ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND','<>');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Starts a new condition group by wrapping the previous condition in parenthesis and starting the new
* condition group with an AND. Then in the new condition group match records where none of the key/value pairs
* match.
*
* @return self
*/
public final function whereNotAlso(){
if($this->where){
$this->where = "{$this->where} AND ALSO ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND','<>');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Find records that are like the key/value pairs. AKA a regexp.
*
* @return self
*/
public final function whereLike(){
if($this->where){
$this->where = "{$this->where} AND ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND',' LIKE ');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Starts a new condition group by wrapping the previous condition in parenthesis and starting the new
* condition group with an AND. Then in the new condition group match records that are like the key/value pairs.
*
* @return self
*/
public final function whereAlsoLike(){
if($this->where){
$this->where = "{$this->where} AND ALSO ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND',' LIKE ');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Find records that are not like the key/value pairs.
*
* @return self
*/
public final function whereNotLike(){
if($this->where){
$this->where = "{$this->where} AND ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND',' NOT LIKE ');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Starts a new condition group by wrapping the previous condition in parenthesis and starting the new
* condition group with an AND. Then in the new condition group match records that are not like the key/value pairs.
*
* @return self
*/
public final function whereNotAlsoLike(){
if($this->where){
$this->where = "{$this->where} AND ALSO ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND',' NOT LIKE ');
return $this;
}//where
/**
* Prepare a WHERE condition for the query.
*
* Find records where a value is in the key/value pairs.
*
*
* @param string $field The field to look in.
* @param string|array $array A string of comma separated values, or an array of values.
*
* @return self
*/
public final function whereIn($field,$array){
$array = $this->buildWhereInArray($array);
if($this->where){
$this->where = "{$this->where} AND ";
}//if
$this->where .= "{$field} IN ({$array})";
return $this;
}//whereIn
/**
* Prepare a WHERE IN condition for the query.
*
* Find records where a value is not in the key/value pairs.
*
*
* @param string $field The field to look in.
* @param string|array $array A string of comma separated values, or an array of values.
*
* @return self
*/
public final function whereNotIn($field,$array){
$array = $this->buildWhereInArray($array);
if($this->where){
$this->where = "{$this->where} AND ";
}//if
$this->where .= "{$field} NOT IN ({$array})";
return $this;
}//whereNotIn
/**
* Prepare a WHERE IN condition for the query.
*
* Find records where a value is in the key/value pairs.
*
* @param string $field The field to look in.
* @param string|array $array A string of comma separated values, or an array of values.
*
* @return self
*/
public final function whereOrIn($field,$array){
$array = $this->buildWhereInArray($array);
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= "{$field} IN ({$array})";
return $this;
}//whereOrIn
/**
* Prepare a WHERE IN condition for the query.
*
* Find records where a value is not in the key/value pairs.
*
* @param string $field The field to look in.
* @param string|array $array A string of comma separated values, or an array of values.
*
* @return self
*/
public final function whereOrNotIn($field,$array){
$array = $this->buildWhereInArray($array);
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= "{$field} NOT IN ({$array})";
return $this;
}//whereOrNotIn
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Find records where the key/value pairs match.
*
* @return self
*/
public final function orWhere(){
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Find records where any of the key/value pairs match.
*
* @return self
*/
public final function orWhereOr(){
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'OR');
return $this;
}//where
/**
* Alias of `$this->orWhereOr()`.
*/
public final function otherwise(){
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'OR');
return $this;
}//otherwise
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Will find records where key/values pairs do not match any conditions.
*
* @return self
*/
public final function orWhereNotOr(){
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'OR','<>');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Find record where none of the values match the key/value pairs.
*
* @return self
*/
public final function orWhereNot(){
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND','<>');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Find records that are like the key/value pairs. AKA a regexp.
*
* @return self
*/
public final function orWhereLike(){
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND',' LIKE ');
return $this;
}//where
/**
* Prepare the WHERE condition for the working query.
* Accepts its arguments through func_get_args().
*
* Find records that are not like the key/value pairs.
*
* @return self
*/
public final function orWhereNotLike(){
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= $this->prepareCondition(func_get_args(),'AND',' NOT LIKE ');
return $this;
}//where
/**
* Prepare a WHERE IN condition for the query.
*
* Find records where a value is in the key/value pairs.
*
* @param string $field The field to look in.
* @param string|array $array A string of comma separated values, or an array of values.
*
* @return self
*/
public final function orWhereIn($field,$array){
$array = $this->buildWhereInArray($array);
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= "{$field} IN ({$array})";
return $this;
}//orWhereIn
/**
* Prepare a WHERE IN condition for the query.
*
* Find records where a value is not in the key/value pairs.
*
* @param string $field The field to look in.
* @param string|array $array A string of comma separated values, or an array of values.
*
* @return self
*/
public final function orWhereNotIn($field,$array){
$array = $this->buildWhereInArray($array);
if($this->where){
$this->where = "{$this->where} OR ";
}//if
$this->where .= "{$field} NOT IN ({$array})";
return $this;
}//orWhereNotIn
/**
* Get a commas delimited string of values for use in an IN query.
*
*
* @param array $array The array of values.
* @return string
*/
private final function buildWhereInArray($array){
if(!is_array($array)){
return $array;
}//if
$values = '';
foreach($array as $v){
$v = \App::with('DB')->clean($v);
$values .= "{$v},";
}//foreach
return rtrim($values,',');
}//buildWhereInArray
/**
* Build the final where condition to be used in the query statement.
*
*
* @return string
*/
private final function buildWhere(){
$pieces = explode(' AND ALSO ',$this->where);
if(!isset($pieces[1])){
return $this->where;
}//if
$where = '';
foreach($pieces as $part){
$where .= "({$part}) AND ";
}//foreach
$where = substr($where,0,strlen($where)-5);
return $where;
}//buildWhere
/**
* Return an aliased field name.
*
*
* @param string $k The field name to alias.
*
* @return string
*/
private function fieldAlias($k){
if(stripos($k,'.') === false){
if($this->alias){
return $this->alias.'.'.$k;
}//if
return $this->table.'.'.$k;
}//if
return $k;
}//fieldAlias
/**
* Return an aliased table name.
*
*
* @return string
*/
private function tableAlias(){
if($this->alias){
return $this->alias;
}//if
return $this->table;
}//tableAlias
/**
* Prepare the JOIN condition for the working SELECT query.
* To join through the ORM you must have a defined Model which extends BaseModel and
* has its $table and $ids values set as this will be used to execute the join on.
*
*
* @param string $modelName The name of the Model you will join on.
* @param string|array $on The condition used to join on.
* @param mixed $data Data that should be bound into the `$on` condition.
* @param string $joinType The type of JOIN that should be used, this is hidden from the user.
*
* @return self
*/
public final function join($modelName, $on=null, $data=null, $joinType = 'INNER JOIN'){
$tableAlias = '';
if(stripos($modelName,' as ') !== false){
$modelName = explode(' AS ',$modelName);
$alias = $modelName[1];
$tableAlias = " AS $alias";
$modelName = $modelName[0];
}//if
else {
$alias = $modelName;
}//el
$joinTable = \App::with($modelName)->table;
$table = $this->tableAlias();
$joinType .= " {$joinTable}{$tableAlias} ";
if($on !== null){
if(is_array($on)){
$joinType .= 'ON ' . $this->prepareCondition(Array($on),'AND');
}//if
else if($data !== null){
$joinType .= 'ON ' . \App::with('DB')->set($on,$data).' ';
}//el
else {
$joinType .= "ON {$on} ";
}//el
}//if
else {
$baseIds = (is_array($this->ids)) ? $this->ids : Array($this->ids);
$ids = \App::with($modelName)->ids;
$ids = (is_array($ids)) ? $ids : Array($ids);
$ids = array_intersect($baseIds,$ids);
$multipleIds = false;
foreach($ids as $id){
$joinType.= "ON {$table}.{$id}={$alias}.{$id} AND ";
$multipleIds = true;
}//id
$jl = strlen($joinType);
if($multipleIds && substr($joinType,$jl-4,$jl)){
$joinType = substr($joinType,0,$jl-4);
}//if
}//el
$this->joinOn[]=$joinType;
return $this;
}//join
/**
* Read docs on join function first, this simply extends that function and
* passes in a LEFT JOIN as the second argument.
*
*
* @param string $modelName The name of the Model you will join on.
* @param string|array $on The condition used to join on.
* @param mixed $data Data that should be bound into the `$on` condition.
*
* @return self
*/
public final function ljoin($modelName,$on=null,$data=null){
$this->join($modelName,$on,$data,'LEFT JOIN');
return $this;
}//ljoin
/**
* Read docs on join function first, this simply extends that function and
* passes in a RIGHT JOIN as the second argument.
*
*
* @param string $modelName The name of the Model you will join on.
* @param string|array $on The condition used to join on.
* @param mixed $data Data that should be bound into the `$on` condition.
*
* @return self
*/
public final function rjoin($modelName,$on=null,$data=null){
$this->join($modelName,$on,$data,'RIGHT JOIN');
return $this;
}//rjoin
/**
* Set an ORDER BY condition for the current SELECT query.
* Accepts its parameters through func_get_args().
* Takes strings and numbers.
*
*
* @return self
*/
public final function order(){
$data = func_get_args();
if(is_array($data[0])){
$order = Array();
foreach($data[0] as $k=>$v){
$order[] = $k.' '.$v;
}//foreach
}//if
else {
$order = $data;
}//el
foreach($data as $k=>$v){
$data[$k] = $v;
}//foreach
$this->order = array_merge($this->order,$order);
return $this;
}//order
/**
* Set a LIMIT condition on the current SELECT query.
*
*
* @param int $start Starting position of LIMIT or the number of tuple's to return contingent upon the
* existence of the second parameter $limit.
* @param null|int $limit The number of tuple's to return.
*
* @return self
*/
public final function limit($start,$limit=null){
if($limit !== null){
$this->limit['offset'] = $start;
$this->limit['limit'] = $limit;