class StatementWrapperIterator
Same name and namespace in other branches
- 10 core/lib/Drupal/Core/Database/StatementWrapperIterator.php \Drupal\Core\Database\StatementWrapperIterator
StatementInterface iterator implementation.
Hierarchy
- class \Drupal\Core\Database\Statement\StatementBase extends \Drupal\Core\Database\Statement\Iterator, \Drupal\Core\Database\StatementInterface uses \Drupal\Core\Database\FetchModeTrait, \Drupal\Core\Database\Statement\PdoTrait, \Drupal\Core\Database\StatementIteratorTrait
- class \Drupal\Core\Database\StatementWrapperIterator implements \Drupal\Core\Database\Statement\StatementBase
Expanded class hierarchy of StatementWrapperIterator
3 files declare their use of StatementWrapperIterator
- Connection.php in core/
modules/ mysql/ src/ Driver/ Database/ mysql/ Connection.php - Connection.php in core/
modules/ pgsql/ src/ Driver/ Database/ pgsql/ Connection.php - StubConnection.php in core/
tests/ Drupal/ Tests/ Core/ Database/ Stub/ StubConnection.php
File
-
core/
lib/ Drupal/ Core/ Database/ StatementWrapperIterator.php, line 12
Namespace
Drupal\Core\DatabaseView source
class StatementWrapperIterator extends StatementBase {
/**
* Holds the default fetch mode.
*
* @deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. Use
* $fetchMode instead.
*
* @see https://www.drupal.org/node/3510455
*/
protected FetchAs $defaultFetchMode = FetchAs::Object;
/**
* Constructs a StatementWrapperIterator object.
*
* @param \Drupal\Core\Database\Connection $connection
* Drupal database connection object.
* @param object $clientConnection
* Client database connection object, for example \PDO.
* @param string $query
* The SQL query string.
* @param array $options
* Array of query options.
* @param bool $rowCountEnabled
* (optional) Enables counting the rows matched. Defaults to FALSE.
*/
public function __construct(Connection $connection, object $clientConnection, string $query, array $options, bool $rowCountEnabled = FALSE) {
parent::__construct($connection, $clientConnection, $query, $rowCountEnabled);
$this->clientStatement = $this->clientConnection
->prepare($query, $options);
$this->setFetchMode(FetchAs::Object);
}
/**
* Returns the client-level database PDO statement object.
*
* This method should normally be used only within database driver code.
*
* @return \PDOStatement
* The client-level database PDO statement.
*
* @throws \RuntimeException
* If the client-level statement is not set.
*/
public function getClientStatement() : \PDOStatement {
if (isset($this->clientStatement)) {
assert($this->clientStatement instanceof \PDOStatement);
return $this->clientStatement;
}
throw new \LogicException('\\PDOStatement not initialized');
}
/**
* {@inheritdoc}
*/
public function execute($args = [], $options = []) {
if (isset($options['fetch']) && is_int($options['fetch'])) {
@trigger_error("Passing the 'fetch' key as an integer to \$options in execute() is deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. Use a case of \\Drupal\\Core\\Database\\Statement\\FetchAs enum instead. See https://www.drupal.org/node/3488338", E_USER_DEPRECATED);
}
if (isset($options['fetch'])) {
if (is_string($options['fetch'])) {
$this->setFetchMode(FetchAs::ClassObject, $options['fetch']);
}
else {
$this->setFetchMode($options['fetch']);
}
}
$startEvent = $this->dispatchStatementExecutionStartEvent($args ?? []);
try {
$return = $this->clientExecute($args, $options);
$this->result = new PdoResult($this->fetchMode, $this->fetchOptions, $this->getClientStatement());
$this->markResultsetIterable($return);
} catch (\Exception $e) {
$this->dispatchStatementExecutionFailureEvent($startEvent, $e);
throw $e;
}
$this->dispatchStatementExecutionEndEvent($startEvent);
return $return;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|---|
FetchModeTrait::$fetchModeLiterals | protected | property | Map FETCH_* modes to their literal for inclusion in messages. | ||
FetchModeTrait::$supportedFetchModes | protected | property | The fetch modes supported. | ||
FetchModeTrait::assocToClass | protected | function | Converts a row of data in FETCH_ASSOC format to FETCH_CLASS. | ||
FetchModeTrait::assocToColumn | protected | function | Converts a row of data in FETCH_ASSOC format to FETCH_COLUMN. | ||
FetchModeTrait::assocToFetchMode | protected | function | Converts a row of data in associative format to a specified format. | ||
FetchModeTrait::assocToNum | protected | function | Converts a row of data in FETCH_ASSOC format to FETCH_NUM. | ||
FetchModeTrait::assocToObj | protected | function | Converts a row of data in FETCH_ASSOC format to FETCH_OBJ. | ||
PdoTrait::clientExecute | protected | function | Executes the prepared PDO statement. | ||
PdoTrait::clientFetch | protected | function | Fetches the next row from the PDO statement. | ||
PdoTrait::clientFetchAll | protected | function | Returns an array containing all of the result set rows. | ||
PdoTrait::clientFetchColumn | protected | function | Returns a single column from the next row of a result set. | ||
PdoTrait::clientFetchObject | protected | function | Fetches the next row and returns it as an object. | ||
PdoTrait::clientQueryString | protected | function | Returns the query string used to prepare the statement. | ||
PdoTrait::clientRowCount | protected | function | Returns the number of rows affected by the last SQL statement. | ||
PdoTrait::clientSetFetchMode | protected | function | Sets the default fetch mode for the PDO statement. | ||
PdoTrait::fetchAsToPdo | protected | function | Converts a FetchAs mode to a \PDO::FETCH_* constant value. | ||
PdoTrait::pdoToFetchAs | protected | function | Converts a \PDO::FETCH_* constant value to a FetchAs mode. | ||
StatementBase::$clientStatement | protected | property | The client database Statement object. | ||
StatementBase::$fetchMode | protected | property | Holds the default fetch mode. | ||
StatementBase::$fetchOptions | protected | property | Holds fetch options. | ||
StatementBase::$result | protected | property | The results of a data query language (DQL) statement. | ||
StatementBase::dispatchStatementExecutionEndEvent | protected | function | Dispatches an event informing that the statement execution succeeded. | ||
StatementBase::dispatchStatementExecutionFailureEvent | protected | function | Dispatches an event informing of the statement execution failure. | ||
StatementBase::dispatchStatementExecutionStartEvent | protected | function | Dispatches an event informing that the statement execution begins. | ||
StatementBase::fetch | public | function | Fetches the next row from a result set. | Overrides StatementInterface::fetch | |
StatementBase::fetchAll | public | function | Returns an array containing all of the result set rows. | Overrides StatementInterface::fetchAll | |
StatementBase::fetchAllAssoc | public | function | Returns the result set as an associative array keyed by the given field. | Overrides StatementInterface::fetchAllAssoc | |
StatementBase::fetchAllKeyed | public | function | Returns the entire result set as a single associative array. | Overrides StatementInterface::fetchAllKeyed | |
StatementBase::fetchAssoc | public | function | Fetches the next row and returns it as an associative array. | Overrides StatementInterface::fetchAssoc | |
StatementBase::fetchCol | public | function | Returns an entire single column of a result set as an indexed array. | Overrides StatementInterface::fetchCol | |
StatementBase::fetchField | public | function | Returns a single field from the next record of a result set. | Overrides StatementInterface::fetchField | |
StatementBase::fetchObject | public | function | Fetches the next row and returns it as an object. | Overrides StatementInterface::fetchObject | |
StatementBase::getConnectionTarget | public | function | Returns the target connection this statement is associated with. | Overrides StatementInterface::getConnectionTarget | |
StatementBase::getQueryString | public | function | Gets the query string of this statement. | Overrides StatementInterface::getQueryString | |
StatementBase::hasClientStatement | public | function | Determines if the client-level database statement object exists. | ||
StatementBase::rowCount | public | function | Returns the number of rows matched by the last SQL statement. | Overrides StatementInterface::rowCount | |
StatementBase::setFetchMode | public | function | Sets the default fetch mode for this statement. | Overrides StatementInterface::setFetchMode | |
StatementIteratorTrait::$isResultsetIterable | private | property | Traces if rows can be fetched from the resultset. | ||
StatementIteratorTrait::$resultsetKey | private | property | The key of the current row. | ||
StatementIteratorTrait::$resultsetRow | private | property | The current row, retrieved in the current fetch format. | ||
StatementIteratorTrait::current | public | function | Returns the current element. | ||
StatementIteratorTrait::getResultsetCurrentRowIndex | protected | function | Returns the row index of the current element in the resultset. | ||
StatementIteratorTrait::key | public | function | Returns the key of the current element. | ||
StatementIteratorTrait::markResultsetFetchingComplete | protected | function | Informs the iterator that no more rows can be fetched from the resultset. | ||
StatementIteratorTrait::markResultsetIterable | protected | function | Informs the iterator whether rows can be fetched from the resultset. | ||
StatementIteratorTrait::next | public | function | Moves the current position to the next element. | ||
StatementIteratorTrait::rewind | public | function | Rewinds back to the first element of the Iterator. | ||
StatementIteratorTrait::setResultsetCurrentRow | protected | function | Sets the current resultset row for the iterator, and increments the key. | ||
StatementIteratorTrait::valid | public | function | Checks if current position is valid. | ||
StatementWrapperIterator::$defaultFetchMode | Deprecated | protected | property | Holds the default fetch mode. | |
StatementWrapperIterator::execute | public | function | Executes a prepared statement. | Overrides StatementBase::execute | |
StatementWrapperIterator::getClientStatement | public | function | Returns the client-level database PDO statement object. | Overrides StatementBase::getClientStatement | |
StatementWrapperIterator::__construct | public | function | Constructs a StatementWrapperIterator object. | Overrides StatementBase::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.