function StatementInterface::fetchCol

Same name in other branches
  1. 9 core/lib/Drupal/Core/Database/StatementInterface.php \Drupal\Core\Database\StatementInterface::fetchCol()
  2. 8.9.x core/lib/Drupal/Core/Database/StatementInterface.php \Drupal\Core\Database\StatementInterface::fetchCol()
  3. 10 core/lib/Drupal/Core/Database/StatementInterface.php \Drupal\Core\Database\StatementInterface::fetchCol()

Returns an entire single column of a result set as an indexed array.

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

Parameters

int $index: The index of the column number to fetch.

Return value

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

Throws

\ValueError If there is at least one record but the column index is not defined.

2 methods override StatementInterface::fetchCol()
StatementPrefetchIterator::fetchCol in core/lib/Drupal/Core/Database/StatementPrefetchIterator.php
Returns an entire single column of a result set as an indexed array.
StatementWrapperIterator::fetchCol in core/lib/Drupal/Core/Database/StatementWrapperIterator.php
Returns an entire single column of a result set as an indexed array.

File

core/lib/Drupal/Core/Database/StatementInterface.php, line 175

Class

StatementInterface
Represents a prepared statement.

Namespace

Drupal\Core\Database

Code

public function fetchCol($index = 0);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.