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 <?php
/*
* This file is part of the ICanBoogie package.
*
* (c) Olivier Laviale <olivier.laviale@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace ICanBoogie\ActiveRecord;
use ICanBoogie\ActiveRecord;
use ICanBoogie\DateTime;
use ICanBoogie\Prototype\MethodNotDefined;
use ICanBoogie\PrototypeTrait;
/**
* The class offers many features to compose model queries. Most query related
* methods of the {@link Model} class create a {@link Query} object that is returned for
* further specification, such as filters or limits.
*
* @method Query and() and($conditions, $conditions_args=null) Alias to {@link where()}.
*
* @property-read array $all An array with all the records matching the query.
* @property-read mixed $one The first record matching the query.
* @property-read array $pairs An array of key/value pairs.
* @property-read array $rc The first column of the first row matching the query.
* @property-read int $count The number of records matching the query.
* @property-read bool|array $exists `true` if a record matching the query exists, `false`
* otherwise. If there is multiple records, the property is an array of booleans.
*
* @property-read Model $model The target model of the query.
* @property-read array $joints The joints collection from {@link join()}.
* @property-read array $joints_args The arguments to the joints.
* @property-read array $conditions The conditions collected from {@link where()}, {@link and()},
* `filter_by_*`, and scopes.
* @property-read array $conditions_args The arguments to the conditions.
* @property-read array $having_args The arguments to the `HAVING` clause.
* @property-read array $args Returns the arguments to the query.
* @property-read Query $prepared Return a prepared query.
*/
class Query implements \IteratorAggregate
{
use PrototypeTrait
{
PrototypeTrait::__call as private __prototype_call;
}
const LIMIT_MAX = '18446744073709551615';
/**
* Part of the `SELECT` clause.
*
* @var string
*/
protected $select;
/**
* `JOIN` clauses.
*
* @var array
*/
protected $joints = [];
/**
* @return array
*/
protected function get_joints()
{
return $this->joints;
}
/**
* Joints arguments.
*
* @var array
*/
protected $joints_args = [];
/**
* @return array
*/
protected function get_joints_args()
{
return $this->joints_args;
}
/**
* The conditions collected from {@link where()}, {@link and()}, `filter_by_*`, and scopes.
*
* @var array
*/
protected $conditions = [];
/**
* @return array
*/
protected function get_conditions()
{
return $this->conditions;
}
/**
* Arguments for the conditions.
*
* @var array
*/
protected $conditions_args = [];
/**
* @return array
*/
protected function get_conditions_args()
{
return $this->conditions_args;
}
/**
* Part of the `GROUP BY` clause.
*
* @var string
*/
protected $group;
/**
* Part of the `ORDER BY` clause.
*
* @var mixed
*/
protected $order;
/**
* Part of the `HAVING` clause.
*
* @var string
*/
protected $having;
/**
* Arguments to the `HAVING` clause.
*
* @var array
*/
protected $having_args = [];
/**
* @return array
*/
protected function get_having_args()
{
return $this->having_args;
}
/**
* The number of records the skip before fetching.
*
* @var int
*/
protected $offset;
/**
* The maximum number of records to fetch.
*
* @var int
*/
protected $limit;
/**
* Fetch mode.
*
* @var mixed
*/
protected $mode;
/**
* The target model of the query.
*
* @var Model
*/
protected $model;
/**
* @return Model
*/
protected function get_model()
{
return $this->model;
}
/**
* Returns the arguments to the query, which include joints arguments, conditions arguments,
* and _having_ arguments.
*
* @return array
*/
protected function get_args()
{
return array_merge($this->joints_args, $this->conditions_args, $this->having_args);
}
/**
* Constructor.
*
* @param Model $model The model to query.
*/
public function __construct(Model $model)
{
$this->model = $model;
}
/**
* Adds support for model's scopes.
*
* @inheritdoc
*/
public function __get($property)
{
$scopes = $this->get_model_scope();
if (in_array($property, $scopes))
{
return $this->model->scope($property, [ $this ]);
}
return self::accessor_get($property);
}
/**
* Override the method to handle magic 'filter_by_' methods.
*
* @inheritdoc
*/
public function __call($method, $arguments)
{
if ($method === 'and')
{
return call_user_func_array([ $this, 'where' ], $arguments);
}
if (strpos($method, 'filter_by_') === 0)
{
return $this->dynamic_filter(substr($method, 10), $arguments); // 10 is for: strlen('filter_by_')
}
$scopes = $this->get_model_scope();
if (in_array($method, $scopes))
{
array_unshift($arguments, $this);
return $this->model->scope($method, $arguments);
}
try
{
return self::__prototype_call($method, $arguments);
}
catch (MethodNotDefined $e)
{
throw new ScopeNotDefined($method, $this->model, 500, $e);
}
}
/*
* Rendering
*/
/**
* Convert the query into a string.
*
* @return string
*/
public function __toString()
{
return $this->resolve_statement
(
$this->render_select() . ' ' .
$this->render_from() .
$this->render_main()
);
}
/**
* Render the `SELECT` clause.
*
* @return string
*/
protected function render_select()
{
return 'SELECT ' . ($this->select ? $this->select : '*');
}
/**
* Render the `FROM` clause.
*
* The rendered `FROM` clause might include some JOINS too.
*
* @return string
*/
protected function render_from()
{
return 'FROM {self_and_related}';
}
/**
* Renders the `JOIN` clauses.
*
* @return string
*/
protected function render_joints()
{
return implode(' ', $this->joints);
}
/**
* Render the main body of the query, without the `SELECT` and `FROM` clauses.
*
* @return string
*/
protected function render_main()
{
$query = '';
if ($this->joints)
{
$query = ' ' . $this->render_joints();
}
$conditions = $this->conditions;
if ($conditions)
{
$query .= ' WHERE ' . implode(' AND ', $conditions);
}
$group = $this->group;
if ($group)
{
$query .= ' GROUP BY ' . $group;
$having = $this->having;
if ($having)
{
$query .= ' HAVING ' . $having;
}
}
$order = $this->order;
if ($order)
{
$query .= ' ' . $this->render_order($order);
}
$offset = $this->offset;
$limit = $this->limit;
if ($offset || $limit)
{
$query .= ' ' . $this->render_offset_and_limit($offset, $limit);
}
return $query;
}
/**
* Render the `ORDER` clause.
*
* @param mixed $order
*
* @return string
*/
protected function render_order($order)
{
if (count($order) == 1)
{
return 'ORDER BY ' . $order[0];
}
$connection = $this->model->connection;
$field = array_shift($order);
$field_values = is_array($order[0]) ? $order[0] : $order;
$field_values = array_map(function($v) use($connection) {
return $connection->quote($v);
}, $field_values);
return "ORDER BY FIELD($field, " . implode(', ', $field_values) . ")";
}
/**
* Render the `LIMIT` and `OFFSET` clauses.
*
* @param int $offset
* @param int $limit
*
* @return string
*/
protected function render_offset_and_limit($offset, $limit)
{
if ($offset && $limit)
{
return "LIMIT $offset, $limit";
}
else if ($offset)
{
return "LIMIT $offset, " . self::LIMIT_MAX;
}
else if ($limit)
{
return "LIMIT $limit";
}
return '';
}
/*
*
*/
/**
* Resolve the placeholders of a statement.
*
* Note: Currently, the method simply forwards the statement to the model's
* resolve_statement() method.
*
* @param string $statement
*
* @return string
*/
protected function resolve_statement($statement)
{
return $this->model->resolve_statement($statement);
}
/**
* Cache available scopes by model class.
*
* @var array
*/
static protected $scopes_by_classes = [];
/**
* Return the available scopes for a model class.
*
* The method uses reflexion to find the scopes, the result is cached.
*
* @return array
*/
protected function get_model_scope()
{
$class = get_class($this->model);
if (isset(self::$scopes_by_classes[$class]))
{
return self::$scopes_by_classes[$class];
}
$reflexion = new \ReflectionClass($class);
$methods = $reflexion->getMethods(\ReflectionMethod::IS_PROTECTED);
$scopes = [];
foreach ($methods as $method)
{
$name = $method->name;
if (strpos($name, 'scope_') !== 0)
{
continue;
}
$scopes[] = substr($name, 6);
}
return self::$scopes_by_classes[$class] = $scopes;
}
/**
* Define the `SELECT` clause.
*
* @param string $expression The expression of the `SELECT` clause. e.g. 'nid, title'.
*
* @return Query
*/
public function select($expression)
{
$this->select = $expression;
return $this;
}
/**
* Add a `JOIN` clause.
*
* @param string|Query $expression A join can be created from a model reference,
* another query, or a custom `JOIN` clause.
*
* - When `$expression` is a string starting with `:` it is considered as a model
* reference matching the pattern ":<model_id>" where `<model_id>` is the identifier of a model
* that can be retrieved using the model collection associated with the query's model.
*
* - When `$expression` is a {@link Query} instance, it is rendered as a string and used as a
* subquery of the `JOIN` clause. The `$options` parameter can be used to customize the
* output.
*
* - Otherwise `$expression` is considered as a raw `JOIN` clause.
*
* @param array $options Only used if `$expression` is a {@link Query} instance. The following
* options are available:
* - `mode`: Join mode. Default: "INNER"
* - `alias`: The alias of the subquery. Default: The query's model alias.
* - `on`: The column on which to joint is created. Default: The query's model primary key.
*
* <pre>
* <?php
*
* # using a model identifier
*
* $query->join(':nodes');
*
* # using a subquery
*
* $subquery = get_model('updates')
* ->select('updated_at, $subscriber_id, update_hash')
* ->order('updated_at DESC')
*
* $query->join($subquery, [ 'on' => 'subscriber_id' ]);
*
* # using a raw clause
*
* $query->join("INNER JOIN `articles` USING(`nid`)");
* </pre>
*
* @return Query
*/
public function join($expression, $options = [])
{
if (is_string($expression) && $expression{0} == ':')
{
$expression = $this->model->models[substr($expression, 1)];
}
if ($expression instanceof self)
{
$this->join_with_query($expression, $options);
return $this;
}
if ($expression instanceof Model)
{
$this->join_with_model($expression, $options);
return $this;
}
$this->joints[] = $expression;
return $this;
}
/**
* Join a subquery to the query.
*
* @param Query $query
* @param array $options The following options are available:
* - `mode`: Join mode. Default: "INNER".
* - `as`: The alias of the subquery. Default: The query's model alias.
* - `on`: The column on which the joint is created. Default: The query's model primary key.
*/
private function join_with_query(Query $query, array $options = [])
{
$options += [
'mode' => 'INNER',
'as' => $query->model->alias,
'on' => $query->model->primary
];
$mode = $options['mode'];
$as = $options['as'];
$on = $options['on'];
if ($options['on'])
{
$on = $this->render_join_on($options['on'], $as, $query);
}
if ($on)
{
$on = ' ' . $on;
}
$this->joints[] = "$mode JOIN($query) `$as`{$on}";
$this->joints_args = array_merge($this->joints_args, $query->args);
}
/**
* Join a model to the query.
*
* @param Model $model
* @param array $options The following options are available:
* - `mode`: Join mode. Default: "INNER".
* - `alias`: The alias of the model. Default: The model's alias.
* - `on`: The column on which the joint is created, or an _ON_ expression. Default:
* The model's primary key. @todo
*/
private function join_with_model(Model $model, array $options = [])
{
$primary = $this->model->primary;
$model_schema = $model->extended_schema;
if (is_array($primary))
{
foreach ($primary as $column)
{
if (isset($model_schema[$column]))
{
$primary = $column;
break;
}
}
}
else if (empty($model_schema[$primary]))
{
$primary = $model_schema->primary;
if (is_array($primary))
{
$primary = reset($primary);
}
}
$options += [
'mode' => 'INNER',
'as' => $model->alias,
'on' => $primary
];
$mode = $options['mode'];
$as = $options['as'];
$this->joints[] = "$mode JOIN `$model->name` AS `$as` USING(`$primary`)";
}
/**
* Render the `on` join option.
*
* The method tries to determine the best solution between `ON` and `USING`.
*
* @param string $column
* @param string $as
* @param Query $query
*
* @return string
*/
private function render_join_on($column, $as, Query $query)
{
if (isset($query->model->schema[$column]) && isset($this->model->schema[$column]))
{
return "USING(`$column`)";
}
return "ON `$as`.`$column` = `{$this->model->alias}`.`$column`";
}
/**
* Parse the conditions for the {@link where()} and {@link having()} methods.
*
* {@link \DateTime} conditions are converted to strings.
*
* @return array An array made of the condition string and its arguments.
*/
private function deferred_parse_conditions()
{
$args = debug_backtrace(0, 2)[1]['args'];
$conditions = array_shift($args);
if (is_array($conditions))
{
$c = '';
$conditions_args = [];
foreach ($conditions as $column => $arg)
{
if (is_array($arg) || $arg instanceof self)
{
$joined = '';
if (is_array($arg))
{
foreach ($arg as $value)
{
$joined .= ',' . (is_numeric($value) ? $value : $this->model->quote($value));
}
$joined = substr($joined, 1);
}
else
{
$joined = (string) $arg;
$conditions_args = array_merge($conditions_args, $arg->args);
}
$c .= ' AND `' . ($column{0} == '!' ? substr($column, 1) . '` NOT' : $column . '`') . ' IN(' . $joined . ')';
}
else
{
$conditions_args[] = $arg;
$c .= ' AND `' . ($column{0} == '!' ? substr($column, 1) . '` !' : $column . '` ') . '= ?';
}
}
$conditions = substr($c, 5);
}
else
{
$conditions_args = [];
if ($args)
{
if (is_array($args[0]))
{
$conditions_args = $args[0];
}
else
{
#
# We dereference values otherwise the caller would get a corrupted array.
#
foreach ($args as $key => $value)
{
$conditions_args[$key] = $value;
}
}
}
}
foreach ($conditions_args as &$value)
{
if ($value instanceof \DateTime)
{
$value = DateTime::from($value)->utc->as_db;
}
}
return [ $conditions ? '(' . $conditions . ')' : null, $conditions_args ];
}
/**
* Handles dynamic filters.
*
* @param string $filter
* @param array $conditions_args
*
* @return Query
*/
private function dynamic_filter($filter, array $conditions_args = [])
{
$conditions = explode('_and_', $filter);
return $this->where(array_combine($conditions, $conditions_args));
}
/**
* Add conditions to the SQL statement.
*
* Conditions can either be specified as string or array.
*
* 1. Pure string conditions
*
* If you'de like to add conditions to your statement, you could just specify them in there,
* just like `$model->where('order_count = 2');`. This will find all the entries, where the
* `order_count` field's value is 2.
*
* 2. Array conditions
*
* Now what if that number could vary, say as an argument from somewhere, or perhaps from the
* user’s level status somewhere? The find then becomes something like:
*
* `$model->where('order_count = ?', 2);`
*
* or
*
* `$model->where([ 'order_count' => 2 ]);`
*
* Or if you want to specify two conditions, you can do it like:
*
* `$model->where('order_count = ? AND locked = ?', 2, false);`
*
* or
*
* `$model->where([ 'order_count' => 2, 'locked' => false ]);`
*
* Or if you want to specify subset conditions:
*
* `$model->where([ 'order_id' => [ 123, 456, 789 ] ]);`
*
* This will return the orders with the `order_id` 123, 456 or 789.
*
* 3. Modifiers
*
* When using the "identifier" => "value" notation, you can switch the comparison method by
* prefixing the identifier with a bang "!"
*
* `$model->where([ '!order_id' => [ 123, 456, 789 ]]);`
*
* This will return the orders with the `order_id` different than 123, 456 and 789.
*
* `$model->where([ '!order_count' => 2 ];`
*
* This will return the orders with the `order_count` different than 2.
*
* @param mixed $conditions
* @param mixed $conditions_args
* @param mixed $_ [optional]
*
* @return Query
*/
public function where($conditions, $conditions_args=null, $_ = null)
{
list($conditions, $conditions_args) = $this->deferred_parse_conditions();
if ($conditions)
{
$this->conditions[] = $conditions;
if ($conditions_args)
{
$this->conditions_args = array_merge($this->conditions_args, $conditions_args);
}
}
return $this;
}
/**
* Defines the `ORDER` clause.
*
* @param string $order_or_field_name The order for the `ORDER` clause e.g.
* 'weight, date DESC', or field to order with, in which case `$field_values` is required.
* @param array $field_values Values of the field specified by `$order_or_field_name`.
*
* @return Query
*/
public function order($order_or_field_name, $field_values = null)
{
$this->order = func_get_args();
return $this;
}
/**
* Defines the `GROUP` clause.
*
* @param string $group
*
* @return Query
*/
public function group($group)
{
$this->group = $group;
return $this;
}
/**
* Defines the `HAVING` clause.
*
* @param mixed $conditions
* @param mixed $conditions_args
*
* @return Query
*/
public function having($conditions, $conditions_args=null)
{
if (!$this->group)
{
throw new \LogicException("having() cannot be used without invoking group() first.");
}
list($having, $having_args) = $this->deferred_parse_conditions();
$this->having = $having;
$this->having_args = $having_args;
return $this;
}
/**
* Define the offset of the `LIMIT` clause.
*
* @param $offset
*
* @return Query
*/
public function offset($offset)
{
$this->offset = (int) $offset;
return $this;
}
/**
* Apply the limit and/or offset to the SQL fired.
*
* You can use the limit to specify the number of records to be retrieved, ad use the offset to
* specify the number of records to skip before starting to return records:
*
* $model->limit(10);
*
* Will return a maximum of 10 clients and because ti specifies no offset it will return the
* first 10 in the table:
*
* $model->limit(5, 10);
*
* Will return a maximum of 10 clients beginning with the 5th.
*
* @param int $limit
*
* @return Query
*/
public function limit($limit)
{
$offset = null;
if (func_num_args() == 2)
{
$offset = $limit;
$limit = func_get_arg(1);
}
$this->offset = (int) $offset;
$this->limit = (int) $limit;
return $this;
}
/**
* Set the fetch mode for the query.
*
* @param mixed $mode
*
* @return Query
*
* @see http://www.php.net/manual/en/pdostatement.setfetchmode.php
*/
public function mode($mode)
{
$this->mode = func_get_args();
return $this;
}
/**
* Prepare the query.
*
* We use the connection's prepare() method because the statement has already been resolved
* during the __toString() method and we don't want for the statement to be parsed twice.
*
* @return Statement
*/
protected function prepare()
{
return $this->model->connection->prepare((string) $this);
}
/**
* Return a prepared query.
*
* @return Statement
*/
protected function get_prepared()
{
return $this->prepare();
}
/**
* Prepare and executes the query.
*
* @return Statement
*/
public function query()
{
$statement = $this->prepare();
$statement->execute($this->args);
return $statement;
}
/*
* FINISHER
*/
/**
* Resolves fetch mode from backtrace.
*
* @return array
*/
private function resolve_fetch_mode()
{
$trace = debug_backtrace(0, 2);
if ($trace[1]['args'])
{
$args = $trace[1]['args'];
}
else if ($this->mode)
{
$args = $this->mode;
}
else if ($this->select)
{
$args = [ \PDO::FETCH_ASSOC ];
}
else if ($this->model->activerecord_class)
{
$args = [ \PDO::FETCH_CLASS, $this->model->activerecord_class, [ $this->model ]];
}
else
{
$args = [ \PDO::FETCH_CLASS, ActiveRecord::class, [ $this->model ]];
}
return $args;
}
/**
* Execute the query and returns an array of records.
*
* @param mixed $_ [optional]
*
* @return array
*/
public function all($_ = null)
{
$statement = $this->query();
$args = $this->resolve_fetch_mode();
return call_user_func_array([ $statement, 'fetchAll' ], $args);
}
/**
* Getter for the {@link $all} magic property.
*
* @return array
*/
protected function get_all()
{
return $this->all();
}
/**
* Return the first result of the query and close the cursor.
*
* @param $_ [optional] Fetch mode.
*
* @return mixed The return value of this function on success depends on the fetch mode. In
* all cases, FALSE is returned on failure.
*/
public function one($_ = null)
{
$query = clone $this;
$query->limit = 1;
$statement = $query->query();
$args = $query->resolve_fetch_mode();
if (count($args) > 1 && $args[0] == \PDO::FETCH_CLASS)
{
array_shift($args);
$rc = call_user_func_array([ $statement, 'fetchObject' ], $args);
$statement->closeCursor();
return $rc;
}
return call_user_func_array([ $statement, 'fetchAndClose' ], $args);
}
/**
* Getter for the {@link $one} magic property.
*
* @return mixed
*
* @see one()
*/
protected function get_one()
{
return $this->one();
}
/**
* Execute que query and return an array of key/value pairs, where the key is the value of
* the first column and the value of the key the value of the second column.
*
* @return array
*/
protected function get_pairs()
{
return $this->all(\PDO::FETCH_KEY_PAIR);
}
/**
* Return the value of the first column of the first row.
*
* @return string
*/
protected function get_rc()
{
$previous_limit = $this->limit;
$this->limit = 1;
$statement = $this->query();
$this->limit = $previous_limit;
return $statement->fetchColumnAndClose();
}
/**
* Check the existence of records in the model.
*
* $model->exists;
* $model->where('name = "max"')->exists;
* $model->exists(1);
* $model->exists(1, 2);
* $model->exists([ 1, 2 ]);
*
* @param mixed $key
*
* @return bool|array
*/
public function exists($key = null)
{
if ($key !== null && func_num_args() > 1)
{
$key = func_get_args();
}
$query = clone $this;
#
# Checking if the query matches any record.
#
if ($key === null)
{
return !!$query
->select('1')
->limit(1)
->rc;
}
#
# Checking if the query matches the specified record keys.
#
$rc = $query
->select('`{primary}`')
->and([ '{primary}' => $key ])
->limit(0, 0)
->all(\PDO::FETCH_COLUMN);
if ($rc && is_array($key))
{
$exists = array_combine($key, array_fill(0, count($key), false));
foreach ($rc as $key)
{
$exists[$key] = true;
}
foreach ($exists as $v)
{
if (!$v)
{
return $exists;
}
}
# all true
return true;
}
return !empty($rc);
}
/**
* Getter for the {@link $exists} magic property.
*
* @return bool|array
*
* @see exists()
*/
protected function get_exists()
{
return $this->exists();
}
/**
* Handle all the computations.
*
* @param string $method
* @param string $column
*
* @return int|array
*/
private function compute($method, $column)
{
$query = 'SELECT ';
if ($column)
{
if ($method == 'COUNT')
{
$query .= "`$column`, $method(`$column`)";
$this->group($column);
}
else
{
$query .= "$method(`$column`)";
}
}
else
{
$query .= $method . '(*)';
}
$query .= ' AS count ' . $this->render_from() . $this->render_main();
$query = $this->model->query($query, $this->args);
if ($method == 'COUNT' && $column)
{
return $query->fetchAll(\PDO::FETCH_KEY_PAIR);
}
return (int) $query->fetchColumnAndClose();
}
/**
* Implement the 'COUNT' computation.
*
* @param string $column The name of the column to count.
*
* @return int|array
*/
public function count($column = null)
{
return $this->compute('COUNT', $column);
}
/**
* Getter for the {@link $count} magic property.
*
* @return int
*/
protected function get_count()
{
return $this->count();
}
/**
* Implement the 'AVG' computation.
*
* @param string $column
*
* @return int
*/
public function average($column)
{
return $this->compute('AVG', $column);
}
/**
* Implement the 'MIN' computation.
*
* @param string $column
*
* @return int
*/
public function minimum($column)
{
return $this->compute('MIN', $column);
}
/**
* Implement the 'MAX' computation.
*
* @param string $column
*
* @return int
*/
public function maximum($column)
{
return $this->compute('MAX', $column);
}
/**
* Implement the 'SUM' computation.
*
* @param string $column
*
* @return int
*/
public function sum($column)
{
return $this->compute('SUM', $column);
}
/**
* Delete the records matching the conditions and limits of the query.
*
* @param string $tables When using a JOIN, `$tables` is used to specify the tables in which
* records should be deleted. Default: The alias of queried model, only if at least one join
* clause has been defined using the {@link join()} method.
*
* @return bool The result of the operation.
*
* @todo-20140901: reflect on join to add the required tables by default, discarding tables
* joined with the LEFT mode.
*/
public function delete($tables = null)
{
if (!$tables && $this->joints)
{
$tables = "`{alias}`";
}
if ($tables)
{
$query = "DELETE {$tables} FROM {self} AS `{alias}`";
}
else
{
$query = "DELETE FROM {self}";
}
$query .= $this->render_main();
return $this->model->execute($query, $this->args);
}
/**
* Return an iterator for the query.
*/
public function getIterator()
{
return new \ArrayIterator($this->all());
}
}