Select.php 22.8 KB
Newer Older
1 2
<?php

Crell's avatar
Crell committed
3 4
/**
 * @file
5
 * Contains \Drupal\Core\Database\Query\Select.
Crell's avatar
Crell committed
6 7
 */

8
namespace Drupal\Core\Database\Query;
9

10 11
use Drupal\Core\Database\Database;
use Drupal\Core\Database\Connection;
12 13 14 15


/**
 * Query builder for SELECT statements.
16 17
 *
 * @ingroup database
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
 */
class Select extends Query implements SelectInterface {

  /**
   * The fields to SELECT.
   *
   * @var array
   */
  protected $fields = array();

  /**
   * The expressions to SELECT as virtual fields.
   *
   * @var array
   */
  protected $expressions = array();

  /**
   * The tables against which to JOIN.
   *
   * This property is a nested array. Each entry is an array representing
   * a single table against which to join. The structure of each entry is:
   *
   * array(
   *   'type' => $join_type (one of INNER, LEFT OUTER, RIGHT OUTER),
   *   'table' => $table,
   *   'alias' => $alias_of_the_table,
   *   'condition' => $condition_clause_on_which_to_join,
   *   'arguments' => $array_of_arguments_for_placeholders_in_the condition.
   *   'all_fields' => TRUE to SELECT $alias.*, FALSE or NULL otherwise.
   * )
   *
   * If $table is a string, it is taken as the name of a table. If it is
51
   * a Select query object, it is taken as a subquery.
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
   *
   * @var array
   */
  protected $tables = array();

  /**
   * The fields by which to order this query.
   *
   * This is an associative array. The keys are the fields to order, and the value
   * is the direction to order, either ASC or DESC.
   *
   * @var array
   */
  protected $order = array();

  /**
   * The fields by which to group.
   *
   * @var array
   */
  protected $group = array();

  /**
   * The conditional object for the WHERE clause.
   *
77
   * @var \Drupal\Core\Database\Query\Condition
78 79 80 81 82 83
   */
  protected $where;

  /**
   * The conditional object for the HAVING clause.
   *
84
   * @var \Drupal\Core\Database\Query\Condition
85 86 87 88 89 90
   */
  protected $having;

  /**
   * Whether or not this query should be DISTINCT
   *
91
   * @var bool
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
   */
  protected $distinct = FALSE;

  /**
   * The range limiters for this query.
   *
   * @var array
   */
  protected $range;

  /**
   * An array whose elements specify a query to UNION, and the UNION type. The
   * 'type' key may be '', 'ALL', or 'DISTINCT' to represent a 'UNION',
   * 'UNION ALL', or 'UNION DISTINCT' statement, respectively.
   *
   * All entries in this array will be applied from front to back, with the
   * first query to union on the right of the original query, the second union
   * to the right of the first, etc.
   *
   * @var array
   */
  protected $union = array();

  /**
   * Indicates if preExecute() has already been called.
117
   * @var bool
118 119 120 121 122 123 124 125
   */
  protected $prepared = FALSE;

  /**
   * The FOR UPDATE status
   */
  protected $forUpdate = FALSE;

126 127 128 129 130 131 132 133 134 135 136 137
  /**
   * Constructs a Select object.
   *
   * @param string $table
   *   The name of the table that is being queried.
   * @param string $alias
   *   The alias for the table.
   * @param \Drupal\Core\Database\Connection $connection
   *   Database connection object.
   * @param array $options
   *   Array of query options.
   */
138 139 140
  public function __construct($table, $alias = NULL, Connection $connection, $options = array()) {
    $options['return'] = Database::RETURN_STATEMENT;
    parent::__construct($connection, $options);
141 142 143
    $conjunction = isset($options['conjunction']) ? $options['conjunction'] : 'AND';
    $this->where = new Condition($conjunction);
    $this->having = new Condition($conjunction);
144 145 146
    $this->addJoin(NULL, $table, $alias);
  }

147 148 149
  /**
   * {@inheritdoc}
   */
150 151 152 153 154
  public function addTag($tag) {
    $this->alterTags[$tag] = 1;
    return $this;
  }

155 156 157
  /**
   * {@inheritdoc}
   */
158 159 160 161
  public function hasTag($tag) {
    return isset($this->alterTags[$tag]);
  }

162 163 164
  /**
   * {@inheritdoc}
   */
165 166 167 168
  public function hasAllTags() {
    return !(boolean)array_diff(func_get_args(), array_keys($this->alterTags));
  }

169 170 171
  /**
   * {@inheritdoc}
   */
172 173 174 175
  public function hasAnyTag() {
    return (boolean)array_intersect(func_get_args(), array_keys($this->alterTags));
  }

176 177 178
  /**
   * {@inheritdoc}
   */
179 180 181 182 183
  public function addMetaData($key, $object) {
    $this->alterMetaData[$key] = $object;
    return $this;
  }

184 185 186
  /**
   * {@inheritdoc}
   */
187 188 189 190
  public function getMetaData($key) {
    return isset($this->alterMetaData[$key]) ? $this->alterMetaData[$key] : NULL;
  }

191 192 193
  /**
   * {@inheritdoc}
   */
194
  public function condition($field, $value = NULL, $operator = '=') {
195 196 197 198
    $this->where->condition($field, $value, $operator);
    return $this;
  }

199 200 201
  /**
   * {@inheritdoc}
   */
202 203 204 205
  public function &conditions() {
    return $this->where->conditions();
  }

206 207 208
  /**
   * {@inheritdoc}
   */
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
  public function arguments() {
    if (!$this->compiled()) {
      return NULL;
    }

    $args = $this->where->arguments() + $this->having->arguments();

    foreach ($this->tables as $table) {
      if ($table['arguments']) {
        $args += $table['arguments'];
      }
      // If this table is a subquery, grab its arguments recursively.
      if ($table['table'] instanceof SelectInterface) {
        $args += $table['table']->arguments();
      }
    }

    foreach ($this->expressions as $expression) {
      if ($expression['arguments']) {
        $args += $expression['arguments'];
      }
    }

    // If there are any dependent queries to UNION,
    // incorporate their arguments recursively.
    foreach ($this->union as $union) {
      $args += $union['query']->arguments();
    }

    return $args;
  }

241 242 243
  /**
   * {@inheritdoc}
   */
244 245 246 247 248
  public function where($snippet, $args = array()) {
    $this->where->where($snippet, $args);
    return $this;
  }

249 250 251
  /**
   * {@inheritdoc}
   */
252 253 254 255 256
  public function isNull($field) {
    $this->where->isNull($field);
    return $this;
  }

257 258 259
  /**
   * {@inheritdoc}
   */
260 261 262 263 264
  public function isNotNull($field) {
    $this->where->isNotNull($field);
    return $this;
  }

265 266 267
  /**
   * {@inheritdoc}
   */
268 269 270 271 272
  public function exists(SelectInterface $select) {
    $this->where->exists($select);
    return $this;
  }

273 274 275
  /**
   * {@inheritdoc}
   */
276 277 278 279 280
  public function notExists(SelectInterface $select) {
    $this->where->notExists($select);
    return $this;
  }

281 282 283
  /**
   * {@inheritdoc}
   */
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
  public function compile(Connection $connection, PlaceholderInterface $queryPlaceholder) {
    $this->where->compile($connection, $queryPlaceholder);
    $this->having->compile($connection, $queryPlaceholder);

    foreach ($this->tables as $table) {
      // If this table is a subquery, compile it recursively.
      if ($table['table'] instanceof SelectInterface) {
        $table['table']->compile($connection, $queryPlaceholder);
      }
    }

    // If there are any dependent queries to UNION, compile it recursively.
    foreach ($this->union as $union) {
      $union['query']->compile($connection, $queryPlaceholder);
    }
  }

301 302 303
  /**
   * {@inheritdoc}
   */
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
  public function compiled() {
    if (!$this->where->compiled() || !$this->having->compiled()) {
      return FALSE;
    }

    foreach ($this->tables as $table) {
      // If this table is a subquery, check its status recursively.
      if ($table['table'] instanceof SelectInterface) {
        if (!$table['table']->compiled()) {
          return FALSE;
        }
      }
    }

    foreach ($this->union as $union) {
      if (!$union['query']->compiled()) {
        return FALSE;
      }
    }

    return TRUE;
  }

327 328 329
  /**
   * {@inheritdoc}
   */
330 331 332 333 334
  public function havingCondition($field, $value = NULL, $operator = NULL) {
    $this->having->condition($field, $value, $operator);
    return $this;
  }

335
  /**
336
   * {@inheritdoc}
337
   */
338 339 340 341
  public function &havingConditions() {
    return $this->having->conditions();
  }

342
  /**
343
   * {@inheritdoc}
344
   */
345 346 347 348
  public function havingArguments() {
    return $this->having->arguments();
  }

349
  /**
350
   * {@inheritdoc}
351
   */
352 353 354 355 356
  public function having($snippet, $args = array()) {
    $this->having->where($snippet, $args);
    return $this;
  }

357
  /**
358
   * {@inheritdoc}
359
   */
360
  public function havingCompile(Connection $connection) {
361
    $this->having->compile($connection, $this);
362 363
  }

364 365 366
  /**
   * {@inheritdoc}
   */
367 368 369 370 371 372 373 374
  public function extend($extender_name) {
    $override_class = $extender_name . '_' . $this->connection->driver();
    if (class_exists($override_class)) {
      $extender_name = $override_class;
    }
    return new $extender_name($this, $this->connection);
  }

375
  /**
376
   * {@inheritdoc}
377
   */
378 379 380 381 382
  public function havingIsNull($field) {
    $this->having->isNull($field);
    return $this;
  }

383
  /**
384
   * {@inheritdoc}
385
   */
386 387 388 389 390
  public function havingIsNotNull($field) {
    $this->having->isNotNull($field);
    return $this;
  }

391
  /**
392
   * {@inheritdoc}
393
   */
394 395 396 397 398
  public function havingExists(SelectInterface $select) {
    $this->having->exists($select);
    return $this;
  }

399
  /**
400
   * {@inheritdoc}
401
   */
402 403 404 405 406
  public function havingNotExists(SelectInterface $select) {
    $this->having->notExists($select);
    return $this;
  }

407 408 409
  /**
   * {@inheritdoc}
   */
410 411 412 413 414 415 416
  public function forUpdate($set = TRUE) {
    if (isset($set)) {
      $this->forUpdate = $set;
    }
    return $this;
  }

417 418 419
  /**
   * {@inheritdoc}
   */
420 421 422 423
  public function &getFields() {
    return $this->fields;
  }

424 425 426
  /**
   * {@inheritdoc}
   */
427 428 429 430
  public function &getExpressions() {
    return $this->expressions;
  }

431 432 433
  /**
   * {@inheritdoc}
   */
434 435 436 437
  public function &getOrderBy() {
    return $this->order;
  }

438 439 440
  /**
   * {@inheritdoc}
   */
441 442 443 444
  public function &getGroupBy() {
    return $this->group;
  }

445 446 447
  /**
   * {@inheritdoc}
   */
448 449 450 451
  public function &getTables() {
    return $this->tables;
  }

452 453 454
  /**
   * {@inheritdoc}
   */
455 456 457 458
  public function &getUnion() {
    return $this->union;
  }

459 460 461 462 463 464 465
  /**
   * {@inheritdoc}
   */
  public function escapeLike($string) {
    return $this->connection->escapeLike($string);
  }

466 467 468
  /**
   * {@inheritdoc}
   */
469 470 471 472 473 474 475 476 477
  public function getArguments(PlaceholderInterface $queryPlaceholder = NULL) {
    if (!isset($queryPlaceholder)) {
      $queryPlaceholder = $this;
    }
    $this->compile($this->connection, $queryPlaceholder);
    return $this->arguments();
  }

  /**
478
   * {@inheritdoc}
479 480 481 482 483 484
   */
  public function isPrepared() {
    return $this->prepared;
  }

  /**
485
   * {@inheritdoc}
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
   */
  public function preExecute(SelectInterface $query = NULL) {
    // If no query object is passed in, use $this.
    if (!isset($query)) {
      $query = $this;
    }

    // Only execute this once.
    if ($query->isPrepared()) {
      return TRUE;
    }

    // Modules may alter all queries or only those having a particular tag.
    if (isset($this->alterTags)) {
      $hooks = array('query');
      foreach ($this->alterTags as $tag => $value) {
        $hooks[] = 'query_' . $tag;
      }
504
      \Drupal::moduleHandler()->alter($hooks, $query);
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
    }

    $this->prepared = TRUE;

    // Now also prepare any sub-queries.
    foreach ($this->tables as $table) {
      if ($table['table'] instanceof SelectInterface) {
        $table['table']->preExecute();
      }
    }

    foreach ($this->union as $union) {
      $union['query']->preExecute();
    }

    return $this->prepared;
  }

523 524 525
  /**
   * {@inheritdoc}
   */
526 527 528 529 530 531 532 533 534 535 536
  public function execute() {
    // If validation fails, simply return NULL.
    // Note that validation routines in preExecute() may throw exceptions instead.
    if (!$this->preExecute()) {
      return NULL;
    }

    $args = $this->getArguments();
    return $this->connection->query((string) $this, $args, $this->queryOptions);
  }

537 538 539
  /**
   * {@inheritdoc}
   */
540 541 542 543 544
  public function distinct($distinct = TRUE) {
    $this->distinct = $distinct;
    return $this;
  }

545 546 547
  /**
   * {@inheritdoc}
   */
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
  public function addField($table_alias, $field, $alias = NULL) {
    // If no alias is specified, first try the field name itself.
    if (empty($alias)) {
      $alias = $field;
    }

    // If that's already in use, try the table name and field name.
    if (!empty($this->fields[$alias])) {
      $alias = $table_alias . '_' . $field;
    }

    // If that is already used, just add a counter until we find an unused alias.
    $alias_candidate = $alias;
    $count = 2;
    while (!empty($this->fields[$alias_candidate])) {
      $alias_candidate = $alias . '_' . $count++;
    }
    $alias = $alias_candidate;

    $this->fields[$alias] = array(
      'field' => $field,
      'table' => $table_alias,
      'alias' => $alias,
    );

    return $alias;
  }

576 577 578
  /**
   * {@inheritdoc}
   */
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
  public function fields($table_alias, array $fields = array()) {
    if ($fields) {
      foreach ($fields as $field) {
        // We don't care what alias was assigned.
        $this->addField($table_alias, $field);
      }
    }
    else {
      // We want all fields from this table.
      $this->tables[$table_alias]['all_fields'] = TRUE;
    }

    return $this;
  }

594 595 596
  /**
   * {@inheritdoc}
   */
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
  public function addExpression($expression, $alias = NULL, $arguments = array()) {
    if (empty($alias)) {
      $alias = 'expression';
    }

    $alias_candidate = $alias;
    $count = 2;
    while (!empty($this->expressions[$alias_candidate])) {
      $alias_candidate = $alias . '_' . $count++;
    }
    $alias = $alias_candidate;

    $this->expressions[$alias] = array(
      'expression' => $expression,
      'alias' => $alias,
      'arguments' => $arguments,
    );

    return $alias;
  }

618 619 620
  /**
   * {@inheritdoc}
   */
621 622 623 624
  public function join($table, $alias = NULL, $condition = NULL, $arguments = array()) {
    return $this->addJoin('INNER', $table, $alias, $condition, $arguments);
  }

625 626 627
  /**
   * {@inheritdoc}
   */
628 629 630 631
  public function innerJoin($table, $alias = NULL, $condition = NULL, $arguments = array()) {
    return $this->addJoin('INNER', $table, $alias, $condition, $arguments);
  }

632 633 634
  /**
   * {@inheritdoc}
   */
635 636 637 638
  public function leftJoin($table, $alias = NULL, $condition = NULL, $arguments = array()) {
    return $this->addJoin('LEFT OUTER', $table, $alias, $condition, $arguments);
  }

639 640 641
  /**
   * {@inheritdoc}
   */
642 643 644 645
  public function rightJoin($table, $alias = NULL, $condition = NULL, $arguments = array()) {
    return $this->addJoin('RIGHT OUTER', $table, $alias, $condition, $arguments);
  }

646 647 648
  /**
   * {@inheritdoc}
   */
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
  public function addJoin($type, $table, $alias = NULL, $condition = NULL, $arguments = array()) {
    if (empty($alias)) {
      if ($table instanceof SelectInterface) {
        $alias = 'subquery';
      }
      else {
        $alias = $table;
      }
    }

    $alias_candidate = $alias;
    $count = 2;
    while (!empty($this->tables[$alias_candidate])) {
      $alias_candidate = $alias . '_' . $count++;
    }
    $alias = $alias_candidate;

    if (is_string($condition)) {
      $condition = str_replace('%alias', $alias, $condition);
    }

    $this->tables[$alias] = array(
      'join type' => $type,
      'table' => $table,
      'alias' => $alias,
      'condition' => $condition,
      'arguments' => $arguments,
    );

    return $alias;
  }

681 682 683
  /**
   * {@inheritdoc}
   */
684
  public function orderBy($field, $direction = 'ASC') {
685 686
    // Only allow ASC and DESC, default to ASC.
    $direction = strtoupper($direction) == 'DESC' ? 'DESC' : 'ASC';
687 688 689 690
    $this->order[$field] = $direction;
    return $this;
  }

691 692 693
  /**
   * {@inheritdoc}
   */
694 695 696 697 698 699
  public function orderRandom() {
    $alias = $this->addExpression('RAND()', 'random_field');
    $this->orderBy($alias);
    return $this;
  }

700 701 702
  /**
   * {@inheritdoc}
   */
703 704 705 706 707
  public function range($start = NULL, $length = NULL) {
    $this->range = func_num_args() ? array('start' => $start, 'length' => $length) : array();
    return $this;
  }

708 709 710
  /**
   * {@inheritdoc}
   */
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
  public function union(SelectInterface $query, $type = '') {
    // Handle UNION aliasing.
    switch ($type) {
      // Fold UNION DISTINCT to UNION for better cross database support.
      case 'DISTINCT':
      case '':
        $type = 'UNION';
        break;

      case 'ALL':
        $type = 'UNION ALL';
      default:
    }

    $this->union[] = array(
      'type' => $type,
      'query' => $query,
    );

    return $this;
  }

733 734 735
  /**
   * {@inheritdoc}
   */
736 737 738 739 740
  public function groupBy($field) {
    $this->group[$field] = $field;
    return $this;
  }

741
  /**
742
   * {@inheritdoc}
743
   */
744
  public function countQuery() {
745 746
    $count = $this->prepareCountQuery();

747
    $query = $this->connection->select($count, NULL, $this->queryOptions);
748 749 750 751 752 753 754 755
    $query->addExpression('COUNT(*)');

    return $query;
  }

  /**
   * Prepares a count query from the current query object.
   *
756
   * @return \Drupal\Core\Database\Query\Select
757 758 759
   *   A new query object ready to have COUNT(*) performed on it.
   */
  protected function prepareCountQuery() {
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
    // Create our new query object that we will mutate into a count query.
    $count = clone($this);

    $group_by = $count->getGroupBy();
    $having = $count->havingConditions();

    if (!$count->distinct && !isset($having[0])) {
      // When not executing a distinct query, we can zero-out existing fields
      // and expressions that are not used by a GROUP BY or HAVING. Fields
      // listed in a GROUP BY or HAVING clause need to be present in the
      // query.
      $fields =& $count->getFields();
      foreach (array_keys($fields) as $field) {
        if (empty($group_by[$field])) {
          unset($fields[$field]);
        }
      }

      $expressions =& $count->getExpressions();
      foreach (array_keys($expressions) as $field) {
        if (empty($group_by[$field])) {
          unset($expressions[$field]);
        }
      }

      // Also remove 'all_fields' statements, which are expanded into tablename.*
      // when the query is executed.
787
      foreach ($count->tables as &$table) {
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
        unset($table['all_fields']);
      }
    }

    // If we've just removed all fields from the query, make sure there is at
    // least one so that the query still runs.
    $count->addExpression('1');

    // Ordering a count query is a waste of cycles, and breaks on some
    // databases anyway.
    $orders = &$count->getOrderBy();
    $orders = array();

    if ($count->distinct && !empty($group_by)) {
      // If the query is distinct and contains a GROUP BY, we need to remove the
      // distinct because SQL99 does not support counting on distinct multiple fields.
      $count->distinct = FALSE;
    }

807 808 809 810 811
    // If there are any dependent queries to UNION, prepare each of those for
    // the count query also.
    foreach ($count->union as &$union) {
      $union['query'] = $union['query']->prepareCountQuery();
    }
812

813
    return $count;
814 815
  }

816 817 818
  /**
   * {@inheritdoc}
   */
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
  public function __toString() {
    // For convenience, we compile the query ourselves if the caller forgot
    // to do it. This allows constructs like "(string) $query" to work. When
    // the query will be executed, it will be recompiled using the proper
    // placeholder generator anyway.
    if (!$this->compiled()) {
      $this->compile($this->connection, $this);
    }

    // Create a sanitized comment string to prepend to the query.
    $comments = $this->connection->makeComment($this->comments);

    // SELECT
    $query = $comments . 'SELECT ';
    if ($this->distinct) {
      $query .= 'DISTINCT ';
    }

    // FIELDS and EXPRESSIONS
    $fields = array();
    foreach ($this->tables as $alias => $table) {
      if (!empty($table['all_fields'])) {
        $fields[] = $this->connection->escapeTable($alias) . '.*';
      }
    }
844
    foreach ($this->fields as $field) {
845 846 847 848
      // Always use the AS keyword for field aliases, as some
      // databases require it (e.g., PostgreSQL).
      $fields[] = (isset($field['table']) ? $this->connection->escapeTable($field['table']) . '.' : '') . $this->connection->escapeField($field['field']) . ' AS ' . $this->connection->escapeAlias($field['alias']);
    }
849
    foreach ($this->expressions as $expression) {
850 851 852 853 854 855 856
      $fields[] = $expression['expression'] . ' AS ' . $this->connection->escapeAlias($expression['alias']);
    }
    $query .= implode(', ', $fields);


    // FROM - We presume all queries have a FROM, as any query that doesn't won't need the query builder anyway.
    $query .= "\nFROM ";
857
    foreach ($this->tables as $table) {
858 859 860 861 862 863 864 865 866 867 868 869 870
      $query .= "\n";
      if (isset($table['join type'])) {
        $query .= $table['join type'] . ' JOIN ';
      }

      // If the table is a subquery, compile it and integrate it into this query.
      if ($table['table'] instanceof SelectInterface) {
        // Run preparation steps on this sub-query before converting to string.
        $subquery = $table['table'];
        $subquery->preExecute();
        $table_string = '(' . (string) $subquery . ')';
      }
      else {
871 872 873 874 875
        $table_string = $this->connection->escapeTable($table['table']);
        // Do not attempt prefixing cross database / schema queries.
        if (strpos($table_string, '.') === FALSE) {
          $table_string = '{' . $table_string . '}';
        }
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
      }

      // Don't use the AS keyword for table aliases, as some
      // databases don't support it (e.g., Oracle).
      $query .=  $table_string . ' ' . $this->connection->escapeTable($table['alias']);

      if (!empty($table['condition'])) {
        $query .= ' ON ' . $table['condition'];
      }
    }

    // WHERE
    if (count($this->where)) {
      // There is an implicit string cast on $this->condition.
      $query .= "\nWHERE " . $this->where;
    }

    // GROUP BY
    if ($this->group) {
      $query .= "\nGROUP BY " . implode(', ', $this->group);
    }

    // HAVING
    if (count($this->having)) {
      // There is an implicit string cast on $this->having.
      $query .= "\nHAVING " . $this->having;
    }

    // ORDER BY
    if ($this->order) {
      $query .= "\nORDER BY ";
      $fields = array();
      foreach ($this->order as $field => $direction) {
909
        $fields[] = $this->connection->escapeField($field) . ' ' . $direction;
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
      }
      $query .= implode(', ', $fields);
    }

    // RANGE
    // There is no universal SQL standard for handling range or limit clauses.
    // Fortunately, all core-supported databases use the same range syntax.
    // Databases that need a different syntax can override this method and
    // do whatever alternate logic they need to.
    if (!empty($this->range)) {
      $query .= "\nLIMIT " . (int) $this->range['length'] . " OFFSET " . (int) $this->range['start'];
    }

    // UNION is a little odd, as the select queries to combine are passed into
    // this query, but syntactically they all end up on the same level.
    if ($this->union) {
      foreach ($this->union as $union) {
        $query .= ' ' . $union['type'] . ' ' . (string) $union['query'];
      }
    }

    if ($this->forUpdate) {
      $query .= ' FOR UPDATE';
    }

    return $query;
  }

938 939 940
  /**
   * {@inheritdoc}
   */
941 942 943 944 945 946 947 948 949 950 951
  public function __clone() {
    // On cloning, also clone the dependent objects. However, we do not
    // want to clone the database connection object as that would duplicate the
    // connection itself.

    $this->where = clone($this->where);
    $this->having = clone($this->having);
    foreach ($this->union as $key => $aggregate) {
      $this->union[$key]['query'] = clone($aggregate['query']);
    }
  }
952

953
}