function StatementWrapperIterator::fetchField

Returns a single field from the next record of a result set.

Parameters

$index: The numeric index of the field to return. Defaults to the first field.

Return value

mixed A single field from the next record, or FALSE if there is no next record.

Overrides StatementInterface::fetchField

File

core/lib/Drupal/Core/Database/StatementWrapperIterator.php, line 215

Class

StatementWrapperIterator
StatementInterface iterator implementation.

Namespace

Drupal\Core\Database

Code

public function fetchField($index = 0) {
  // Call \PDOStatement::fetchColumn to fetch the field.
  $column = $this->clientStatement
    ->fetchColumn($index);
  if ($column === FALSE) {
    $this->markResultsetFetchingComplete();
    return FALSE;
  }
  $this->setResultsetCurrentRow($column);
  return $column;
}

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