public function DatabaseStatementBase::fetchAllAssoc

public DatabaseStatementBase::fetchAllAssoc($key, $fetch = NULL)

Returns the result set as an associative array keyed by the given field.

If the given key appears multiple times, later records will overwrite earlier ones.

Parameters

$key: The name of the field on which to index the array.

$fetch: The fetchmode to use. If set to PDO::FETCH_ASSOC, PDO::FETCH_NUM, or PDO::FETCH_BOTH the returned value with be an array of arrays. For any other value it will be an array of objects. By default, the fetch mode set for the query will be used.

Return value

An associative array, or an empty array if there is no result set.

Overrides DatabaseStatementInterface::fetchAllAssoc

File

includes/database/database.inc, line 2222
Core systems for the database layer.

Class

DatabaseStatementBase
Default implementation of DatabaseStatementInterface.

Code

public function fetchAllAssoc($key, $fetch = NULL) {
  $return = array();
  if (isset($fetch)) {
    if (is_string($fetch)) {
      $this->setFetchMode(PDO::FETCH_CLASS, $fetch);
    }
    else {
      $this->setFetchMode($fetch);
    }
  }

  foreach ($this as $record) {
    $record_key = is_object($record) ? $record->$key : $record[$key];
    $return[$record_key] = $record;
  }

  return $return;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!database!database.inc/function/DatabaseStatementBase::fetchAllAssoc/7.x