public function StatementPrefetch::fetchAllKeyed in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Database/StatementPrefetch.php \Drupal\Core\Database\StatementPrefetch::fetchAllKeyed()

Returns the entire result set as a single associative array.

This method is only useful for two-column result sets. It will return an associative array where the key is one column from the result set and the value is another field. In most cases, the default of the first two columns is appropriate.

Note that this method will run the result set to the end.

Parameters

$key_index: The numeric index of the field to use as the array key.

$value_index: The numeric index of the field to use as the array value.

Return value

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

Overrides StatementInterface::fetchAllKeyed

File

core/lib/Drupal/Core/Database/StatementPrefetch.php, line 511

Class

StatementPrefetch

An implementation of StatementInterface that prefetches all data.

Namespace

Drupal\Core\Database

Code

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

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