StatementPrefetch.php 13.5 KB
Newer Older
1 2
<?php

Crell's avatar
Crell committed
3 4 5 6 7
/**
 * @file
 * Definition of Drupal\Core\Database\StatementPrefetch
 */

8
namespace Drupal\Core\Database;
9

10
use Drupal\Core\Database\Connection;
11 12
use Iterator;
use PDO;
13
use PDOException;
14 15 16 17 18 19 20

/**
 * An implementation of DatabaseStatementInterface that prefetches all data.
 *
 * This class behaves very similar to a PDOStatement but as it always fetches
 * every row it is possible to manipulate those results.
 */
21
class StatementPrefetch implements Iterator, StatementInterface {
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

  /**
   * The query string.
   *
   * @var string
   */
  protected $queryString;

  /**
   * Driver-specific options. Can be used by child classes.
   *
   * @var Array
   */
  protected $driverOptions;

  /**
   * Reference to the database connection object for this statement.
   *
   * The name $dbh is inherited from PDOStatement.
   *
42
   * @var Drupal\Core\Database\Connection
43 44 45 46 47 48 49 50 51 52 53
   */
  public $dbh;

  /**
   * Main data store.
   *
   * @var Array
   */
  protected $data = array();

  /**
54
   * The current row, retrieved in PDO::FETCH_ASSOC format.
55
   *
56
   * @var Array
57
   */
58 59 60 61 62 63 64 65
  protected $currentRow = NULL;

  /**
   * The key of the current row.
   *
   * @var int
   */
  protected $currentKey = NULL;
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

  /**
   * The list of column names in this result set.
   *
   * @var Array
   */
  protected $columnNames = NULL;

  /**
   * The number of rows affected by the last query.
   *
   * @var int
   */
  protected $rowCount = NULL;

  /**
   * The number of rows in this result set.
   *
   * @var int
   */
  protected $resultRowCount = 0;

  /**
   * Holds the current fetch style (which will be used by the next fetch).
90
   * @see PDOStatement::fetch()
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
   *
   * @var int
   */
  protected $fetchStyle = PDO::FETCH_OBJ;

  /**
   * Holds supplementary current fetch options (which will be used by the next fetch).
   *
   * @var Array
   */
  protected $fetchOptions = array(
    'class' => 'stdClass',
    'constructor_args' => array(),
    'object' => NULL,
    'column' => 0,
  );

  /**
   * Holds the default fetch style.
   *
   * @var int
   */
  protected $defaultFetchStyle = PDO::FETCH_OBJ;

  /**
   * Holds supplementary default fetch options.
   *
   * @var Array
   */
  protected $defaultFetchOptions = array(
    'class' => 'stdClass',
    'constructor_args' => array(),
    'object' => NULL,
    'column' => 0,
  );

127
  public function __construct(Connection $connection, $query, array $driver_options = array()) {
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
    $this->dbh = $connection;
    $this->queryString = $query;
    $this->driverOptions = $driver_options;
  }

  /**
   * Executes a prepared statement.
   *
   * @param $args
   *   An array of values with as many elements as there are bound parameters in the SQL statement being executed.
   * @param $options
   *   An array of options for this query.
   * @return
   *   TRUE on success, or FALSE on failure.
   */
143
  public function execute($args = array(), $options = array()) {
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
    if (isset($options['fetch'])) {
      if (is_string($options['fetch'])) {
        // Default to an object. Note: db fields will be added to the object
        // before the constructor is run. If you need to assign fields after
        // the constructor is run, see http://drupal.org/node/315092.
        $this->setFetchMode(PDO::FETCH_CLASS, $options['fetch']);
      }
      else {
        $this->setFetchMode($options['fetch']);
      }
    }

    $logger = $this->dbh->getLogger();
    if (!empty($logger)) {
      $query_start = microtime(TRUE);
    }

    // Prepare the query.
    $statement = $this->getStatement($this->queryString, $args);
    if (!$statement) {
      $this->throwPDOException();
    }

    $return = $statement->execute($args);
    if (!$return) {
      $this->throwPDOException();
    }

    // Fetch all the data from the reply, in order to release any lock
    // as soon as possible.
    $this->rowCount = $statement->rowCount();
    $this->data = $statement->fetchAll(PDO::FETCH_ASSOC);
176
    // Destroy the statement as soon as possible. See
177
    // DatabaseConnection_sqlite::PDOPrepare() for explanation.
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
    unset($statement);

    $this->resultRowCount = count($this->data);

    if ($this->resultRowCount) {
      $this->columnNames = array_keys($this->data[0]);
    }
    else {
      $this->columnNames = array();
    }

    if (!empty($logger)) {
      $query_end = microtime(TRUE);
      $logger->log($this, $args, $query_end - $query_start);
    }

194 195
    // Initialize the first row in $this->currentRow.
    $this->next();
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218

    return $return;
  }

  /**
   * Throw a PDO Exception based on the last PDO error.
   */
  protected function throwPDOException() {
    $error_info = $this->dbh->errorInfo();
    // We rebuild a message formatted in the same way as PDO.
    $exception = new PDOException("SQLSTATE[" . $error_info[0] . "]: General error " . $error_info[1] . ": " . $error_info[2]);
    $exception->errorInfo = $error_info;
    throw $exception;
  }

  /**
   * Grab a PDOStatement object from a given query and its arguments.
   *
   * Some drivers (including SQLite) will need to perform some preparation
   * themselves to get the statement right.
   *
   * @param $query
   *   The query.
219
   * @param array $args
220
   *   An array of arguments.
221
   * @return PDOStatement
222 223 224 225 226 227 228 229 230 231 232 233 234 235
   *   A PDOStatement object.
   */
  protected function getStatement($query, &$args = array()) {
    return $this->dbh->prepare($query);
  }

  /**
   * Return the object's SQL query string.
   */
  public function getQueryString() {
    return $this->queryString;
  }

  /**
236
   * @see PDOStatement::setFetchMode()
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
   */
  public function setFetchMode($fetchStyle, $a2 = NULL, $a3 = NULL) {
    $this->defaultFetchStyle = $fetchStyle;
    switch ($fetchStyle) {
      case PDO::FETCH_CLASS:
        $this->defaultFetchOptions['class'] = $a2;
        if ($a3) {
          $this->defaultFetchOptions['constructor_args'] = $a3;
        }
        break;
      case PDO::FETCH_COLUMN:
        $this->defaultFetchOptions['column'] = $a2;
        break;
      case PDO::FETCH_INTO:
        $this->defaultFetchOptions['object'] = $a2;
        break;
    }

    // Set the values for the next fetch.
    $this->fetchStyle = $this->defaultFetchStyle;
    $this->fetchOptions = $this->defaultFetchOptions;
  }

  /**
   * Return the current row formatted according to the current fetch style.
   *
   * This is the core method of this class. It grabs the value at the current
   * array position in $this->data and format it according to $this->fetchStyle
   * and $this->fetchMode.
   *
   * @return
   *  The current row formatted as requested.
   */
  public function current() {
271
    if (isset($this->currentRow)) {
272 273
      switch ($this->fetchStyle) {
        case PDO::FETCH_ASSOC:
274
          return $this->currentRow;
275
        case PDO::FETCH_BOTH:
276 277 278
          // PDO::FETCH_BOTH returns an array indexed by both the column name
          // and the column number.
          return $this->currentRow + array_values($this->currentRow);
279
        case PDO::FETCH_NUM:
280
          return array_values($this->currentRow);
281 282 283 284
        case PDO::FETCH_LAZY:
          // We do not do lazy as everything is fetched already. Fallback to
          // PDO::FETCH_OBJ.
        case PDO::FETCH_OBJ:
285
          return (object) $this->currentRow;
286
        case PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE:
287
          $class_name = array_unshift($this->currentRow);
288 289 290 291 292 293
          // Deliberate no break.
        case PDO::FETCH_CLASS:
          if (!isset($class_name)) {
            $class_name = $this->fetchOptions['class'];
          }
          if (count($this->fetchOptions['constructor_args'])) {
294
            $reflector = new \ReflectionClass($class_name);
295 296 297 298 299
            $result = $reflector->newInstanceArgs($this->fetchOptions['constructor_args']);
          }
          else {
            $result = new $class_name();
          }
300
          foreach ($this->currentRow as $k => $v) {
301 302 303 304
            $result->$k = $v;
          }
          return $result;
        case PDO::FETCH_INTO:
305
          foreach ($this->currentRow as $k => $v) {
306 307 308 309 310
            $this->fetchOptions['object']->$k = $v;
          }
          return $this->fetchOptions['object'];
        case PDO::FETCH_COLUMN:
          if (isset($this->columnNames[$this->fetchOptions['column']])) {
311
            return $this->currentRow[$k][$this->columnNames[$this->fetchOptions['column']]];
312 313 314 315 316 317 318 319 320 321 322
          }
          else {
            return;
          }
      }
    }
  }

  /* Implementations of Iterator. */

  public function key() {
323
    return $this->currentKey;
324 325 326
  }

  public function rewind() {
327
    // Nothing to do: our DatabaseStatement can't be rewound.
328 329 330
  }

  public function next() {
331 332 333 334 335 336 337
    if (!empty($this->data)) {
      $this->currentRow = reset($this->data);
      $this->currentKey = key($this->data);
      unset($this->data[$this->currentKey]);
    }
    else {
      $this->currentRow = NULL;
338 339 340 341
    }
  }

  public function valid() {
342
    return isset($this->currentRow);
343 344 345 346 347 348 349 350 351
  }

  /* Implementations of DatabaseStatementInterface. */

  public function rowCount() {
    return $this->rowCount;
  }

  public function fetch($fetch_style = NULL, $cursor_orientation = PDO::FETCH_ORI_NEXT, $cursor_offset = NULL) {
352
    if (isset($this->currentRow)) {
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
      // Set the fetch parameter.
      $this->fetchStyle = isset($fetch_style) ? $fetch_style : $this->defaultFetchStyle;
      $this->fetchOptions = $this->defaultFetchOptions;

      // Grab the row in the format specified above.
      $return = $this->current();
      // Advance the cursor.
      $this->next();

      // Reset the fetch parameters to the value stored using setFetchMode().
      $this->fetchStyle = $this->defaultFetchStyle;
      $this->fetchOptions = $this->defaultFetchOptions;
      return $return;
    }
    else {
      return FALSE;
    }
  }

372
  public function fetchColumn($index = 0) {
373
    if (isset($this->currentRow) && isset($this->columnNames[$index])) {
374
      // We grab the value directly from $this->data, and format it.
375
      $return = $this->currentRow[$this->columnNames[$index]];
376 377 378 379 380 381 382 383
      $this->next();
      return $return;
    }
    else {
      return FALSE;
    }
  }

384 385 386 387
  public function fetchField($index = 0) {
    return $this->fetchColumn($index);
  }

388
  public function fetchObject($class_name = NULL, $constructor_args = array()) {
389
    if (isset($this->currentRow)) {
390 391
      if (!isset($class_name)) {
        // Directly cast to an object to avoid a function call.
392
        $result = (object) $this->currentRow;
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
      }
      else {
        $this->fetchStyle = PDO::FETCH_CLASS;
        $this->fetchOptions = array('constructor_args' => $constructor_args);
        // Grab the row in the format specified above.
        $result = $this->current();
        // Reset the fetch parameters to the value stored using setFetchMode().
        $this->fetchStyle = $this->defaultFetchStyle;
        $this->fetchOptions = $this->defaultFetchOptions;
      }

      $this->next();

      return $result;
    }
    else {
      return FALSE;
    }
  }

  public function fetchAssoc() {
414 415
    if (isset($this->currentRow)) {
      $result = $this->currentRow;
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
      $this->next();
      return $result;
    }
    else {
      return FALSE;
    }
  }

  public function fetchAll($fetch_style = NULL, $fetch_column = NULL, $constructor_args = NULL) {
    $this->fetchStyle = isset($fetch_style) ? $fetch_style : $this->defaultFetchStyle;
    $this->fetchOptions = $this->defaultFetchOptions;
    if (isset($fetch_column)) {
      $this->fetchOptions['column'] = $fetch_column;
    }
    if (isset($constructor_args)) {
      $this->fetchOptions['constructor_args'] = $constructor_args;
    }

    $result = array();
    // Traverse the array as PHP would have done.
436
    while (isset($this->currentRow)) {
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
      // Grab the row in the format specified above.
      $result[] = $this->current();
      $this->next();
    }

    // Reset the fetch parameters to the value stored using setFetchMode().
    $this->fetchStyle = $this->defaultFetchStyle;
    $this->fetchOptions = $this->defaultFetchOptions;
    return $result;
  }

  public function fetchCol($index = 0) {
    if (isset($this->columnNames[$index])) {
      $column = $this->columnNames[$index];
      $result = array();
      // Traverse the array as PHP would have done.
453 454
      while (isset($this->currentRow)) {
        $result[] = $this->currentRow[$this->columnNames[$index]];
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
        $this->next();
      }
      return $result;
    }
    else {
      return array();
    }
  }

  public function fetchAllKeyed($key_index = 0, $value_index = 1) {
    if (!isset($this->columnNames[$key_index]) || !isset($this->columnNames[$value_index]))
      return array();

    $key = $this->columnNames[$key_index];
    $value = $this->columnNames[$value_index];

    $result = array();
    // Traverse the array as PHP would have done.
473 474
    while (isset($this->currentRow)) {
      $result[$this->currentRow[$key]] = $this->currentRow[$value];
475 476 477 478 479
      $this->next();
    }
    return $result;
  }

480 481
  public function fetchAllAssoc($key, $fetch_style = NULL) {
    $this->fetchStyle = isset($fetch_style) ? $fetch_style : $this->defaultFetchStyle;
482 483 484 485
    $this->fetchOptions = $this->defaultFetchOptions;

    $result = array();
    // Traverse the array as PHP would have done.
486
    while (isset($this->currentRow)) {
487
      // Grab the row in its raw PDO::FETCH_ASSOC format.
488
      $row = $this->currentRow;
489 490
      // Grab the row in the format specified above.
      $result_row = $this->current();
491
      $result[$this->currentRow[$key]] = $result_row;
492 493 494 495 496 497 498 499 500 501
      $this->next();
    }

    // Reset the fetch parameters to the value stored using setFetchMode().
    $this->fetchStyle = $this->defaultFetchStyle;
    $this->fetchOptions = $this->defaultFetchOptions;
    return $result;
  }

}