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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
|
<?php namespace Illuminate\Database\Query;
use Closure; use Illuminate\Support\Collection; use Illuminate\Database\ConnectionInterface; use Illuminate\Database\Query\Grammars\Grammar; use Illuminate\Database\Query\Processors\Processor;
class Builder {
/** * The database connection instance. * * @var \Illuminate\Database\Connection */ protected $connection;
/** * The database query grammar instance. * * @var \Illuminate\Database\Query\Grammars\Grammar */ protected $grammar;
/** * The database query post processor instance. * * @var \Illuminate\Database\Query\Processors\Processor */ protected $processor;
/** * The current query value bindings. * * @var array */ protected $bindings = array();
/** * An aggregate function and column to be run. * * @var array */ public $aggregate;
/** * The columns that should be returned. * * @var array */ public $columns;
/** * Indicates if the query returns distinct results. * * @var bool */ public $distinct = false;
/** * The table which the query is targeting. * * @var string */ public $from;
/** * The table joins for the query. * * @var array */ public $joins;
/** * The where constraints for the query. * * @var array */ public $wheres;
/** * The groupings for the query. * * @var array */ public $groups;
/** * The having constraints for the query. * * @var array */ public $havings;
/** * The orderings for the query. * * @var array */ public $orders;
/** * The maximum number of records to return. * * @var int */ public $limit;
/** * The number of records to skip. * * @var int */ public $offset;
/** * The query union statements. * * @var array */ public $unions;
/** * Indicates whether row locking is being used. * * @var string|bool */ public $lock;
/** * The backups of fields while doing a pagination count. * * @var array */ protected $backups = array();
/** * The key that should be used when caching the query. * * @var string */ protected $cacheKey;
/** * The number of minutes to cache the query. * * @var int */ protected $cacheMinutes;
/** * The tags for the query cache. * * @var array */ protected $cacheTags;
/** * The cache driver to be used. * * @var string */ protected $cacheDriver;
/** * All of the available clause operators. * * @var array */ protected $operators = array( '=', '<', '>', '<=', '>=', '<>', '!=', 'like', 'not like', 'between', 'ilike', '&', '|', '^', '<<', '>>', );
/** * Create a new query builder instance. * * @param \Illuminate\Database\ConnectionInterface $connection * @param \Illuminate\Database\Query\Grammars\Grammar $grammar * @param \Illuminate\Database\Query\Processors\Processor $processor * @return void */ public function __construct(ConnectionInterface $connection, Grammar $grammar, Processor $processor) { $this->grammar = $grammar; $this->processor = $processor; $this->connection = $connection; }
/** * Set the columns to be selected. * * @param array $columns * @return \Illuminate\Database\Query\Builder|static */ public function select($columns = array('*')) { $this->columns = is_array($columns) ? $columns : func_get_args();
return $this; }
/** * Add a new "raw" select expression to the query. * * @param string $expression * @return \Illuminate\Database\Query\Builder|static */ public function selectRaw($expression) { return $this->select(new Expression($expression)); }
/** * Add a new select column to the query. * * @param mixed $column * @return \Illuminate\Database\Query\Builder|static */ public function addSelect($column) { $column = is_array($column) ? $column : func_get_args();
$this->columns = array_merge((array) $this->columns, $column);
return $this; }
/** * Force the query to only return distinct results. * * @return \Illuminate\Database\Query\Builder|static */ public function distinct() { $this->distinct = true;
return $this; }
/** * Set the table which the query is targeting. * * @param string $table * @return \Illuminate\Database\Query\Builder|static */ public function from($table) { $this->from = $table;
return $this; }
/** * Add a join clause to the query. * * @param string $table * @param string $first * @param string $operator * @param string $two * @param string $type * @param bool $where * @return \Illuminate\Database\Query\Builder|static */ public function join($table, $one, $operator = null, $two = null, $type = 'inner', $where = false) { // If the first "column" of the join is really a Closure instance the developer // is trying to build a join with a complex "on" clause containing more than // one condition, so we'll add the join and call a Closure with the query. if ($one instanceof Closure) { $this->joins[] = new JoinClause($this, $type, $table);
call_user_func($one, end($this->joins)); }
// If the column is simply a string, we can assume the join simply has a basic // "on" clause with a single condition. So we will just build the join with // this simple join clauses attached to it. There is not a join callback. else { $join = new JoinClause($this, $type, $table);
$this->joins[] = $join->on( $one, $operator, $two, 'and', $where ); }
return $this; }
/** * Add a "join where" clause to the query. * * @param string $table * @param string $first * @param string $operator * @param string $two * @param string $type * @return \Illuminate\Database\Query\Builder|static */ public function joinWhere($table, $one, $operator, $two, $type = 'inner') { return $this->join($table, $one, $operator, $two, $type, true); }
/** * Add a left join to the query. * * @param string $table * @param string $first * @param string $operator * @param string $second * @return \Illuminate\Database\Query\Builder|static */ public function leftJoin($table, $first, $operator = null, $second = null) { return $this->join($table, $first, $operator, $second, 'left'); }
/** * Add a "join where" clause to the query. * * @param string $table * @param string $first * @param string $operator * @param string $two * @return \Illuminate\Database\Query\Builder|static */ public function leftJoinWhere($table, $one, $operator, $two) { return $this->joinWhere($table, $one, $operator, $two, 'left'); }
/** * Add a basic where clause to the query. * * @param string $column * @param string $operator * @param mixed $value * @param string $boolean * @return \Illuminate\Database\Query\Builder|static * * @throws \InvalidArgumentException */ public function where($column, $operator = null, $value = null, $boolean = 'and') { if (func_num_args() == 2) { list($value, $operator) = array($operator, '='); } elseif ($this->invalidOperatorAndValue($operator, $value)) { throw new \InvalidArgumentException("Value must be provided."); }
// If the columns is actually a Closure instance, we will assume the developer // wants to begin a nested where statement which is wrapped in parenthesis. // We'll add that Closure to the query then return back out immediately. if ($column instanceof Closure) { return $this->whereNested($column, $boolean); }
// If the given operator is not found in the list of valid operators we will // assume that the developer is just short-cutting the '=' operators and // we will set the operators to '=' and set the values appropriately. if ( ! in_array(strtolower($operator), $this->operators, true)) { list($value, $operator) = array($operator, '='); }
// If the value is a Closure, it means the developer is performing an entire // sub-select within the query and we will need to compile the sub-select // within the where clause to get the appropriate query record results. if ($value instanceof Closure) { return $this->whereSub($column, $operator, $value, $boolean); }
// If the value is "null", we will just assume the developer wants to add a // where null clause to the query. So, we will allow a short-cut here to // that method for convenience so the developer doesn't have to check. if (is_null($value)) { return $this->whereNull($column, $boolean, $operator != '='); }
// Now that we are working with just a simple query we can put the elements // in our array and add the query binding to our array of bindings that // will be bound to each SQL statements when it is finally executed. $type = 'Basic';
$this->wheres[] = compact('type', 'column', 'operator', 'value', 'boolean');
if ( ! $value instanceof Expression) { $this->bindings[] = $value; }
return $this; }
/** * Add an "or where" clause to the query. * * @param string $column * @param string $operator * @param mixed $value * @return \Illuminate\Database\Query\Builder|static */ public function orWhere($column, $operator = null, $value = null) { return $this->where($column, $operator, $value, 'or'); }
/** * Determine if the given operator and value combination is legal. * * @param string $operator * @param mixed $value * @return bool */ protected function invalidOperatorAndValue($operator, $value) { $isOperator = in_array($operator, $this->operators);
return ($isOperator && $operator != '=' && is_null($value)); }
/** * Add a raw where clause to the query. * * @param string $sql * @param array $bindings * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereRaw($sql, array $bindings = array(), $boolean = 'and') { $type = 'raw';
$this->wheres[] = compact('type', 'sql', 'boolean');
$this->bindings = array_merge($this->bindings, $bindings);
return $this; }
/** * Add a raw or where clause to the query. * * @param string $sql * @param array $bindings * @return \Illuminate\Database\Query\Builder|static */ public function orWhereRaw($sql, array $bindings = array()) { return $this->whereRaw($sql, $bindings, 'or'); }
/** * Add a where between statement to the query. * * @param string $column * @param array $values * @param string $boolean * @param bool $not * @return \Illuminate\Database\Query\Builder|static */ public function whereBetween($column, array $values, $boolean = 'and', $not = false) { $type = 'between';
$this->wheres[] = compact('column', 'type', 'boolean', 'not');
$this->bindings = array_merge($this->bindings, $values);
return $this; }
/** * Add an or where between statement to the query. * * @param string $column * @param array $values * @return \Illuminate\Database\Query\Builder|static */ public function orWhereBetween($column, array $values) { return $this->whereBetween($column, $values, 'or'); }
/** * Add a where not between statement to the query. * * @param string $column * @param array $values * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereNotBetween($column, array $values, $boolean = 'and') { return $this->whereBetween($column, $values, $boolean, true); }
/** * Add an or where not between statement to the query. * * @param string $column * @param array $values * @return \Illuminate\Database\Query\Builder|static */ public function orWhereNotBetween($column, array $values) { return $this->whereNotBetween($column, $values, 'or'); }
/** * Add a nested where statement to the query. * * @param \Closure $callback * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereNested(Closure $callback, $boolean = 'and') { // To handle nested queries we'll actually create a brand new query instance // and pass it off to the Closure that we have. The Closure can simply do // do whatever it wants to a query then we will store it for compiling. $query = $this->newQuery();
$query->from($this->from);
call_user_func($callback, $query);
return $this->addNestedWhereQuery($query, $boolean); }
/** * Add another query builder as a nested where to the query builder. * * @param \Illuminate\Database\Query\Builder|static $query * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function addNestedWhereQuery($query, $boolean = 'and') { if (count($query->wheres)) { $type = 'Nested';
$this->wheres[] = compact('type', 'query', 'boolean');
$this->mergeBindings($query); }
return $this; }
/** * Add a full sub-select to the query. * * @param string $column * @param string $operator * @param \Closure $callback * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ protected function whereSub($column, $operator, Closure $callback, $boolean) { $type = 'Sub';
$query = $this->newQuery();
// Once we have the query instance we can simply execute it so it can add all // of the sub-select's conditions to itself, and then we can cache it off // in the array of where clauses for the "main" parent query instance. call_user_func($callback, $query);
$this->wheres[] = compact('type', 'column', 'operator', 'query', 'boolean');
$this->mergeBindings($query);
return $this; }
/** * Add an exists clause to the query. * * @param \Closure $callback * @param string $boolean * @param bool $not * @return \Illuminate\Database\Query\Builder|static */ public function whereExists(Closure $callback, $boolean = 'and', $not = false) { $type = $not ? 'NotExists' : 'Exists';
$query = $this->newQuery();
// Similar to the sub-select clause, we will create a new query instance so // the developer may cleanly specify the entire exists query and we will // compile the whole thing in the grammar and insert it into the SQL. call_user_func($callback, $query);
$this->wheres[] = compact('type', 'operator', 'query', 'boolean');
$this->mergeBindings($query);
return $this; }
/** * Add an or exists clause to the query. * * @param \Closure $callback * @param bool $not * @return \Illuminate\Database\Query\Builder|static */ public function orWhereExists(Closure $callback, $not = false) { return $this->whereExists($callback, 'or', $not); }
/** * Add a where not exists clause to the query. * * @param \Closure $callback * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereNotExists(Closure $callback, $boolean = 'and') { return $this->whereExists($callback, $boolean, true); }
/** * Add a where not exists clause to the query. * * @param \Closure $callback * @return \Illuminate\Database\Query\Builder|static */ public function orWhereNotExists(Closure $callback) { return $this->orWhereExists($callback, true); }
/** * Add a "where in" clause to the query. * * @param string $column * @param mixed $values * @param string $boolean * @param bool $not * @return \Illuminate\Database\Query\Builder|static */ public function whereIn($column, $values, $boolean = 'and', $not = false) { $type = $not ? 'NotIn' : 'In';
// If the value of the where in clause is actually a Closure, we will assume that // the developer is using a full sub-select for this "in" statement, and will // execute those Closures, then we can re-construct the entire sub-selects. if ($values instanceof Closure) { return $this->whereInSub($column, $values, $boolean, $not); }
$this->wheres[] = compact('type', 'column', 'values', 'boolean');
$this->bindings = array_merge($this->bindings, $values);
return $this; }
/** * Add an "or where in" clause to the query. * * @param string $column * @param mixed $values * @return \Illuminate\Database\Query\Builder|static */ public function orWhereIn($column, $values) { return $this->whereIn($column, $values, 'or'); }
/** * Add a "where not in" clause to the query. * * @param string $column * @param mixed $values * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereNotIn($column, $values, $boolean = 'and') { return $this->whereIn($column, $values, $boolean, true); }
/** * Add an "or where not in" clause to the query. * * @param string $column * @param mixed $values * @return \Illuminate\Database\Query\Builder|static */ public function orWhereNotIn($column, $values) { return $this->whereNotIn($column, $values, 'or'); }
/** * Add a where in with a sub-select to the query. * * @param string $column * @param \Closure $callback * @param string $boolean * @param bool $not * @return \Illuminate\Database\Query\Builder|static */ protected function whereInSub($column, Closure $callback, $boolean, $not) { $type = $not ? 'NotInSub' : 'InSub';
// To create the exists sub-select, we will actually create a query and call the // provided callback with the query so the developer may set any of the query // conditions they want for the in clause, then we'll put it in this array. call_user_func($callback, $query = $this->newQuery());
$this->wheres[] = compact('type', 'column', 'query', 'boolean');
$this->mergeBindings($query);
return $this; }
/** * Add a "where null" clause to the query. * * @param string $column * @param string $boolean * @param bool $not * @return \Illuminate\Database\Query\Builder|static */ public function whereNull($column, $boolean = 'and', $not = false) { $type = $not ? 'NotNull' : 'Null';
$this->wheres[] = compact('type', 'column', 'boolean');
return $this; }
/** * Add an "or where null" clause to the query. * * @param string $column * @return \Illuminate\Database\Query\Builder|static */ public function orWhereNull($column) { return $this->whereNull($column, 'or'); }
/** * Add a "where not null" clause to the query. * * @param string $column * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereNotNull($column, $boolean = 'and') { return $this->whereNull($column, $boolean, true); }
/** * Add an "or where not null" clause to the query. * * @param string $column * @return \Illuminate\Database\Query\Builder|static */ public function orWhereNotNull($column) { return $this->whereNotNull($column, 'or'); }
/** * Add a "where day" statement to the query. * * @param string $column * @param string $operator * @param int $value * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereDay($column, $operator, $value, $boolean = 'and') { return $this->addDateBasedWhere('Day', $column, $operator, $value, $boolean); }
/** * Add a "where month" statement to the query. * * @param string $column * @param string $operator * @param int $value * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereMonth($column, $operator, $value, $boolean = 'and') { return $this->addDateBasedWhere('Month', $column, $operator, $value, $boolean); }
/** * Add a "where year" statement to the query. * * @param string $column * @param string $operator * @param int $value * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function whereYear($column, $operator, $value, $boolean = 'and') { return $this->addDateBasedWhere('Year', $column, $operator, $value, $boolean); }
/** * Add a date based (year, month, day) statement to the query. * * @param string $type * @param string $column * @param string $operator * @param int $value * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ protected function addDateBasedWhere($type, $column, $operator, $value, $boolean = 'and') { $this->wheres[] = compact('column', 'type', 'boolean', 'operator', 'value');
$this->bindings[] = $value;
return $this; }
/** * Handles dynamic "where" clauses to the query. * * @param string $method * @param string $parameters * @return \Illuminate\Database\Query\Builder|static */ public function dynamicWhere($method, $parameters) { $finder = substr($method, 5);
$segments = preg_split('/(And|Or)(?=[A-Z])/', $finder, -1, PREG_SPLIT_DELIM_CAPTURE);
// The connector variable will determine which connector will be used for the // query condition. We will change it as we come across new boolean values // in the dynamic method strings, which could contain a number of these. $connector = 'and';
$index = 0;
foreach ($segments as $segment) { // If the segment is not a boolean connector, we can assume it is a column's name // and we will add it to the query as a new constraint as a where clause, then // we can keep iterating through the dynamic method string's segments again. if ($segment != 'And' && $segment != 'Or') { $this->addDynamic($segment, $connector, $parameters, $index);
$index++; }
// Otherwise, we will store the connector so we know how the next where clause we // find in the query should be connected to the previous ones, meaning we will // have the proper boolean connector to connect the next where clause found. else { $connector = $segment; } }
return $this; }
/** * Add a single dynamic where clause statement to the query. * * @param string $segment * @param string $connector * @param array $parameters * @param int $index * @return void */ protected function addDynamic($segment, $connector, $parameters, $index) { // Once we have parsed out the columns and formatted the boolean operators we // are ready to add it to this query as a where clause just like any other // clause on the query. Then we'll increment the parameter index values. $bool = strtolower($connector);
$this->where(snake_case($segment), '=', $parameters[$index], $bool); }
/** * Add a "group by" clause to the query. * * @param dynamic $columns * @return \Illuminate\Database\Query\Builder|static */ public function groupBy() { $this->groups = array_merge((array) $this->groups, func_get_args());
return $this; }
/** * Add a "having" clause to the query. * * @param string $column * @param string $operator * @param string $value * @return \Illuminate\Database\Query\Builder|static */ public function having($column, $operator = null, $value = null) { $type = 'basic';
$this->havings[] = compact('type', 'column', 'operator', 'value');
$this->bindings[] = $value;
return $this; }
/** * Add a raw having clause to the query. * * @param string $sql * @param array $bindings * @param string $boolean * @return \Illuminate\Database\Query\Builder|static */ public function havingRaw($sql, array $bindings = array(), $boolean = 'and') { $type = 'raw';
$this->havings[] = compact('type', 'sql', 'boolean');
$this->bindings = array_merge($this->bindings, $bindings);
return $this; }
/** * Add a raw or having clause to the query. * * @param string $sql * @param array $bindings * @return \Illuminate\Database\Query\Builder|static */ public function orHavingRaw($sql, array $bindings = array()) { return $this->havingRaw($sql, $bindings, 'or'); }
/** * Add an "order by" clause to the query. * * @param string $column * @param string $direction * @return \Illuminate\Database\Query\Builder|static */ public function orderBy($column, $direction = 'asc') { $direction = strtolower($direction) == 'asc' ? 'asc' : 'desc';
$this->orders[] = compact('column', 'direction');
return $this; }
/** * Add an "order by" clause for a timestamp to the query. * * @param string $column * @return \Illuminate\Database\Query\Builder|static */ public function latest($column = 'created_at') { return $this->orderBy($column, 'desc'); }
/** * Add an "order by" clause for a timestamp to the query. * * @param string $column * @return \Illuminate\Database\Query\Builder|static */ public function oldest($column = 'created_at') { return $this->orderBy($column, 'asc'); }
/** * Add a raw "order by" clause to the query. * * @param string $sql * @param array $bindings * @return \Illuminate\Database\Query\Builder|static */ public function orderByRaw($sql, $bindings = array()) { $type = 'raw';
$this->orders[] = compact('type', 'sql');
$this->bindings = array_merge($this->bindings, $bindings);
return $this; }
/** * Set the "offset" value of the query. * * @param int $value * @return \Illuminate\Database\Query\Builder|static */ public function offset($value) { $this->offset = max(0, $value);
return $this; }
/** * Alias to set the "offset" value of the query. * * @param int $value * @return \Illuminate\Database\Query\Builder|static */ public function skip($value) { return $this->offset($value); }
/** * Set the "limit" value of the query. * * @param int $value * @return \Illuminate\Database\Query\Builder|static */ public function limit($value) { if ($value > 0) $this->limit = $value;
return $this; }
/** * Alias to set the "limit" value of the query. * * @param int $value * @return \Illuminate\Database\Query\Builder|static */ public function take($value) { return $this->limit($value); }
/** * Set the limit and offset for a given page. * * @param int $page * @param int $perPage * @return \Illuminate\Database\Query\Builder|static */ public function forPage($page, $perPage = 15) { return $this->skip(($page - 1) * $perPage)->take($perPage); }
/** * Add a union statement to the query. * * @param \Illuminate\Database\Query\Builder|\Closure $query * @param bool $all * @return \Illuminate\Database\Query\Builder|static */ public function union($query, $all = false) { if ($query instanceof Closure) { call_user_func($query, $query = $this->newQuery()); }
$this->unions[] = compact('query', 'all');
return $this->mergeBindings($query); }
/** * Add a union all statement to the query. * * @param \Illuminate\Database\Query\Builder|\Closure $query * @return \Illuminate\Database\Query\Builder|static */ public function unionAll($query) { return $this->union($query, true); }
/** * Lock the selected rows in the table. * * @param bool $update * @return \Illuminate\Database\Query\Builder */ public function lock($value = true) { $this->lock = $value;
return $this; }
/** * Lock the selected rows in the table for updating. * * @return \Illuminate\Database\Query\Builder */ public function lockForUpdate() { return $this->lock(true); }
/** * Share lock the selected rows in the table. * * @return \Illuminate\Database\Query\Builder */ public function sharedLock() { return $this->lock(false); }
/** * Get the SQL representation of the query. * * @return string */ public function toSql() { return $this->grammar->compileSelect($this); }
/** * Indicate that the query results should be cached. * * @param \DateTime|int $minutes * @param string $key * @return \Illuminate\Database\Query\Builder|static */ public function remember($minutes, $key = null) { list($this->cacheMinutes, $this->cacheKey) = array($minutes, $key);
return $this; }
/** * Indicate that the query results should be cached forever. * * @param string $key * @return \Illuminate\Database\Query\Builder|static */ public function rememberForever($key = null) { return $this->remember(-1, $key); }
/** * Indicate that the results, if cached, should use the given cache tags. * * @param array|dynamic $cacheTags * @return \Illuminate\Database\Query\Builder|static */ public function cacheTags($cacheTags) { $this->cacheTags = $cacheTags;
return $this; }
/** * Indicate that the results, if cached, should use the given cache driver. * * @param string $cacheDriver * @return \Illuminate\Database\Query\Builder|static */ public function cacheDriver($cacheDriver) { $this->cacheDriver = $cacheDriver;
return $this; }
/** * Execute a query for a single record by ID. * * @param int $id * @param array $columns * @return mixed|static */ public function find($id, $columns = array('*')) { return $this->where('id', '=', $id)->first($columns); }
/** * Pluck a single column's value from the first result of a query. * * @param string $column * @return mixed */ public function pluck($column) { $result = (array) $this->first(array($column));
return count($result) > 0 ? reset($result) : null; }
/** * Execute the query and get the first result. * * @param array $columns * @return mixed|static */ public function first($columns = array('*')) { $results = $this->take(1)->get($columns);
return count($results) > 0 ? reset($results) : null; }
/** * Execute the query as a "select" statement. * * @param array $columns * @return array|static[] */ public function get($columns = array('*')) { if ( ! is_null($this->cacheMinutes)) return $this->getCached($columns);
return $this->getFresh($columns); }
/** * Execute the query as a fresh "select" statement. * * @param array $columns * @return array|static[] */ public function getFresh($columns = array('*')) { if (is_null($this->columns)) $this->columns = $columns;
return $this->processor->processSelect($this, $this->runSelect()); }
/** * Run the query as a "select" statement against the connection. * * @return array */ protected function runSelect() { return $this->connection->select($this->toSql(), $this->bindings); }
/** * Execute the query as a cached "select" statement. * * @param array $columns * @return array */ public function getCached($columns = array('*')) { if (is_null($this->columns)) $this->columns = $columns;
// If the query is requested to be cached, we will cache it using a unique key // for this database connection and query statement, including the bindings // that are used on this query, providing great convenience when caching. list($key, $minutes) = $this->getCacheInfo();
$cache = $this->getCache();
$callback = $this->getCacheCallback($columns);
// If the "minutes" value is less than zero, we will use that as the indicator // that the value should be remembered values should be stored indefinitely // and if we have minutes we will use the typical remember function here. if ($minutes < 0) { return $cache->rememberForever($key, $callback); } else { return $cache->remember($key, $minutes, $callback); } }
/** * Get the cache object with tags assigned, if applicable. * * @return \Illuminate\Cache\CacheManager */ protected function getCache() { $cache = $this->connection->getCacheManager()->driver($this->cacheDriver);
return $this->cacheTags ? $cache->tags($this->cacheTags) : $cache; }
/** * Get the cache key and cache minutes as an array. * * @return array */ protected function getCacheInfo() { return array($this->getCacheKey(), $this->cacheMinutes); }
/** * Get a unique cache key for the complete query. * * @return string */ public function getCacheKey() { return $this->cacheKey ?: $this->generateCacheKey(); }
/** * Generate the unique cache key for the query. * * @return string */ public function generateCacheKey() { $name = $this->connection->getName();
return md5($name.$this->toSql().serialize($this->bindings)); }
/** * Get the Closure callback used when caching queries. * * @param array $columns * @return \Closure */ protected function getCacheCallback($columns) { $me = $this;
return function() use ($me, $columns) { return $me->getFresh($columns); }; }
/** * Chunk the results of the query. * * @param int $count * @param callable $callback * @return void */ public function chunk($count, $callback) { $results = $this->forPage($page = 1, $count)->get();
while (count($results) > 0) { // On each chunk result set, we will pass them to the callback and then let the // developer take care of everything within the callback, which allows us to // keep the memory low for spinning through large result sets for working. call_user_func($callback, $results);
$page++;
$results = $this->forPage($page, $count)->get(); } }
/** * Get an array with the values of a given column. * * @param string $column * @param string $key * @return array */ public function lists($column, $key = null) { $columns = $this->getListSelect($column, $key);
// First we will just get all of the column values for the record result set // then we can associate those values with the column if it was specified // otherwise we can just give these values back without a specific key. $results = new Collection($this->get($columns));
$values = $results->fetch($columns[0])->all();
// If a key was specified and we have results, we will go ahead and combine // the values with the keys of all of the records so that the values can // be accessed by the key of the rows instead of simply being numeric. if ( ! is_null($key) && count($results) > 0) { $keys = $results->fetch($key)->all();
return array_combine($keys, $values); }
return $values; }
/** * Get the columns that should be used in a list array. * * @param string $column * @param string $key * @return array */ protected function getListSelect($column, $key) { $select = is_null($key) ? array($column) : array($column, $key);
// If the selected column contains a "dot", we will remove it so that the list // operation can run normally. Specifying the table is not needed, since we // really want the names of the columns as it is in this resulting array. if (($dot = strpos($select[0], '.')) !== false) { $select[0] = substr($select[0], $dot + 1); }
return $select; }
/** * Concatenate values of a given column as a string. * * @param string $column * @param string $glue * @return string */ public function implode($column, $glue = null) { if (is_null($glue)) return implode($this->lists($column));
return implode($glue, $this->lists($column)); }
/** * Get a paginator for the "select" statement. * * @param int $perPage * @param array $columns * @return \Illuminate\Pagination\Paginator */ public function paginate($perPage = 15, $columns = array('*')) { $paginator = $this->connection->getPaginator();
if (isset($this->groups)) { return $this->groupedPaginate($paginator, $perPage, $columns); } else { return $this->ungroupedPaginate($paginator, $perPage, $columns); } }
/** * Create a paginator for a grouped pagination statement. * * @param \Illuminate\Pagination\Environment $paginator * @param int $perPage * @param array $columns * @return \Illuminate\Pagination\Paginator */ protected function groupedPaginate($paginator, $perPage, $columns) { $results = $this->get($columns);
return $this->buildRawPaginator($paginator, $results, $perPage); }
/** * Build a paginator instance from a raw result array. * * @param \Illuminate\Pagination\Environment $paginator * @param array $results * @param int $perPage * @return \Illuminate\Pagination\Paginator */ public function buildRawPaginator($paginator, $results, $perPage) { // For queries which have a group by, we will actually retrieve the entire set // of rows from the table and "slice" them via PHP. This is inefficient and // the developer must be aware of this behavior; however, it's an option. $start = ($paginator->getCurrentPage() - 1) * $perPage;
$sliced = array_slice($results, $start, $perPage);
return $paginator->make($sliced, count($results), $perPage); }
/** * Create a paginator for an un-grouped pagination statement. * * @param \Illuminate\Pagination\Environment $paginator * @param int $perPage * @param array $columns * @return \Illuminate\Pagination\Paginator */ protected function ungroupedPaginate($paginator, $perPage, $columns) { $total = $this->getPaginationCount();
// Once we have the total number of records to be paginated, we can grab the // current page and the result array. Then we are ready to create a brand // new Paginator instances for the results which will create the links. $page = $paginator->getCurrentPage($total);
$results = $this->forPage($page, $perPage)->get($columns);
return $paginator->make($results, $total, $perPage); }
/** * Get the count of the total records for pagination. * * @return int */ public function getPaginationCount() { $this->backupFieldsForCount();
// Because some database engines may throw errors if we leave the ordering // statements on the query, we will "back them up" and remove them from // the query. Once we have the count we will put them back onto this. $total = $this->count();
$this->restoreFieldsForCount();
return $total; }
/** * Backup certain fields for a pagination count. * * @return void */ protected function backupFieldsForCount() { foreach (array('orders', 'limit', 'offset') as $field) { $this->backups[$field] = $this->{$field};
$this->{$field} = null; }
}
/** * Restore certain fields for a pagination count. * * @return void */ protected function restoreFieldsForCount() { foreach (array('orders', 'limit', 'offset') as $field) { $this->{$field} = $this->backups[$field]; }
$this->backups = array(); }
/** * Determine if any rows exist for the current query. * * @return bool */ public function exists() { return $this->count() > 0; }
/** * Retrieve the "count" result of the query. * * @param string $columns * @return int */ public function count($columns = '*') { if ( ! is_array($columns)) { $columns = array($columns); }
return (int) $this->aggregate(__FUNCTION__, $columns); }
/** * Retrieve the minimum value of a given column. * * @param string $column * @return mixed */ public function min($column) { return $this->aggregate(__FUNCTION__, array($column)); }
/** * Retrieve the maximum value of a given column. * * @param string $column * @return mixed */ public function max($column) { return $this->aggregate(__FUNCTION__, array($column)); }
/** * Retrieve the sum of the values of a given column. * * @param string $column * @return mixed */ public function sum($column) { $result = $this->aggregate(__FUNCTION__, array($column));
return $result ?: 0; }
/** * Retrieve the average of the values of a given column. * * @param string $column * @return mixed */ public function avg($column) { return $this->aggregate(__FUNCTION__, array($column)); }
/** * Execute an aggregate function on the database. * * @param string $function * @param array $columns * @return mixed */ public function aggregate($function, $columns = array('*')) { $this->aggregate = compact('function', 'columns');
$previousColumns = $this->columns;
$results = $this->get($columns);
// Once we have executed the query, we will reset the aggregate property so // that more select queries can be executed against the database without // the aggregate value getting in the way when the grammar builds it. $this->aggregate = null;
$this->columns = $previousColumns;
if (isset($results[0])) { $result = array_change_key_case((array) $results[0]);
return $result['aggregate']; } }
/** * Insert a new record into the database. * * @param array $values * @return bool */ public function insert(array $values) { // Since every insert gets treated like a batch insert, we will make sure the // bindings are structured in a way that is convenient for building these // inserts statements by verifying the elements are actually an array. if ( ! is_array(reset($values))) { $values = array($values); }
// Since every insert gets treated like a batch insert, we will make sure the // bindings are structured in a way that is convenient for building these // inserts statements by verifying the elements are actually an array. else { foreach ($values as $key => $value) { ksort($value); $values[$key] = $value; } }
// We'll treat every insert like a batch insert so we can easily insert each // of the records into the database consistently. This will make it much // easier on the grammars to just handle one type of record insertion. $bindings = array();
foreach ($values as $record) { $bindings = array_merge($bindings, array_values($record)); }
$sql = $this->grammar->compileInsert($this, $values);
// Once we have compiled the insert statement's SQL we can execute it on the // connection and return a result as a boolean success indicator as that // is the same type of result returned by the raw connection instance. $bindings = $this->cleanBindings($bindings);
return $this->connection->insert($sql, $bindings); }
/** * Insert a new record and get the value of the primary key. * * @param array $values * @param string $sequence * @return int */ public function insertGetId(array $values, $sequence = null) { $sql = $this->grammar->compileInsertGetId($this, $values, $sequence);
$values = $this->cleanBindings($values);
return $this->processor->processInsertGetId($this, $sql, $values, $sequence); }
/** * Update a record in the database. * * @param array $values * @return int */ public function update(array $values) { $bindings = array_values(array_merge($values, $this->bindings));
$sql = $this->grammar->compileUpdate($this, $values);
return $this->connection->update($sql, $this->cleanBindings($bindings)); }
/** * Increment a column's value by a given amount. * * @param string $column * @param int $amount * @param array $extra * @return int */ public function increment($column, $amount = 1, array $extra = array()) { $wrapped = $this->grammar->wrap($column);
$columns = array_merge(array($column => $this->raw("$wrapped + $amount")), $extra);
return $this->update($columns); }
/** * Decrement a column's value by a given amount. * * @param string $column * @param int $amount * @param array $extra * @return int */ public function decrement($column, $amount = 1, array $extra = array()) { $wrapped = $this->grammar->wrap($column);
$columns = array_merge(array($column => $this->raw("$wrapped - $amount")), $extra);
return $this->update($columns); }
/** * Delete a record from the database. * * @param mixed $id * @return int */ public function delete($id = null) { // If an ID is passed to the method, we will set the where clause to check // the ID to allow developers to simply and quickly remove a single row // from their database without manually specifying the where clauses. if ( ! is_null($id)) $this->where('id', '=', $id);
$sql = $this->grammar->compileDelete($this);
return $this->connection->delete($sql, $this->bindings); }
/** * Run a truncate statement on the table. * * @return void */ public function truncate() { foreach ($this->grammar->compileTruncate($this) as $sql => $bindings) { $this->connection->statement($sql, $bindings); } }
/** * Get a new instance of the query builder. * * @return \Illuminate\Database\Query\Builder */ public function newQuery() { return new Builder($this->connection, $this->grammar, $this->processor); }
/** * Merge an array of where clauses and bindings. * * @param array $wheres * @param array $bindings * @return void */ public function mergeWheres($wheres, $bindings) { $this->wheres = array_merge((array) $this->wheres, (array) $wheres);
$this->bindings = array_values(array_merge($this->bindings, (array) $bindings)); }
/** * Remove all of the expressions from a list of bindings. * * @param array $bindings * @return array */ protected function cleanBindings(array $bindings) { return array_values(array_filter($bindings, function($binding) { return ! $binding instanceof Expression; })); }
/** * Create a raw database expression. * * @param mixed $value * @return \Illuminate\Database\Query\Expression */ public function raw($value) { return $this->connection->raw($value); }
/** * Get the current query value bindings. * * @return array */ public function getBindings() { return $this->bindings; }
/** * Set the bindings on the query builder. * * @param array $bindings * @return \Illuminate\Database\Query\Builder */ public function setBindings(array $bindings) { $this->bindings = $bindings;
return $this; }
/** * Add a binding to the query. * * @param mixed $value * @return \Illuminate\Database\Query\Builder */ public function addBinding($value) { $this->bindings[] = $value;
return $this; }
/** * Merge an array of bindings into our bindings. * * @param \Illuminate\Database\Query\Builder $query * @return \Illuminate\Database\Query\Builder */ public function mergeBindings(Builder $query) { $this->bindings = array_values(array_merge($this->bindings, $query->bindings));
return $this; }
/** * Get the database connection instance. * * @return \Illuminate\Database\ConnectionInterface */ public function getConnection() { return $this->connection; }
/** * Get the database query processor instance. * * @return \Illuminate\Database\Query\Processors\Processor */ public function getProcessor() { return $this->processor; }
/** * Get the query grammar instance. * * @return \Illuminate\Database\Grammar */ public function getGrammar() { return $this->grammar; }
/** * Handle dynamic method calls into the method. * * @param string $method * @param array $parameters * @return mixed * * @throws \BadMethodCallException */ public function __call($method, $parameters) { if (starts_with($method, 'where')) { return $this->dynamicWhere($method, $parameters); }
$className = get_class($this);
throw new \BadMethodCallException("Call to undefined method {$className}::{$method}()"); }
}
|