1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Database
  7. \
  8. StatementInterface

StatementInterface

interface StatementInterface implements Traversable (View source)

Represents a prepared statement.

Child implementations should either extend PDOStatement:

Methods

true
execute($args = [], $options = [])

Executes a prepared statement.

The
getQueryString()

Gets the query string of this statement.

The
rowCount()

Returns the number of rows affected by the last SQL statement.

setFetchMode($mode, $a1 = NULL, $a2 = [])

Sets the default fetch mode for this statement.

A
fetch($mode = NULL, $cursor_orientation = NULL, $cursor_offset = NULL)

Fetches the next row from a result set.

A
fetchField($index = 0)

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

mixed
fetchObject()

Fetches the next row and returns it as an object.

An
fetchAssoc()

Fetches the next row and returns it as an associative array.

An
fetchAll($mode = NULL, $column_index = NULL, $constructor_arguments = NULL)

Returns an array containing all of the result set rows.

An
fetchCol($index = 0)

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

An
fetchAllKeyed($key_index = 0, $value_index = 1)

Returns the entire result set as a single associative array.

An
fetchAllAssoc($key, $fetch = NULL)

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

Details

at line 35
true execute($args = [], $options = [])

Executes a prepared statement.

Parameters

$args

An array of values with as many elements as there are bound parameters in the SQL statement being executed. This can be NULL.
$options

An array of options for this query.

Return Value

true

on success, or FALSE on failure.

at line 43
The getQueryString()

Gets the query string of this statement.

Return Value

The

query string, in its form with placeholders.

at line 65
The rowCount()

Returns the number of rows affected by the last SQL statement.

Return Value

The

number of rows affected by the last DELETE, INSERT, or UPDATE statement executed or throws \Drupal\Core\Database\RowCountException if the last executed statement was SELECT.

Exceptions

RowCountException

at line 84
setFetchMode($mode, $a1 = NULL, $a2 = [])

Sets the default fetch mode for this statement.

See http://php.net/manual/pdo.constants.php for the definition of the constants used.

Parameters

$mode

One of the PDO::FETCH_* constants.
$a1

An option depending of the fetch mode specified by $mode:

  • for PDO::FETCH_COLUMN, the index of the column to fetch
  • for PDO::FETCH_CLASS, the name of the class to create
  • for PDO::FETCH_INTO, the object to add the data to
$a2

If $mode is PDO::FETCH_CLASS, the optional arguments to pass to the constructor.

at line 103
A fetch($mode = NULL, $cursor_orientation = NULL, $cursor_offset = NULL)

Fetches the next row from a result set.

See http://php.net/manual/pdo.constants.php for the definition of the constants used.

Parameters

$mode

One of the PDO::FETCH_* constants. Default to what was specified by setFetchMode().
$cursor_orientation

Not implemented in all database drivers, don't use.
$cursor_offset

Not implemented in all database drivers, don't use.

Return Value

A

result, formatted according to $mode.

at line 114
A fetchField($index = 0)

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

A

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

at line 135
mixed fetchObject()

Fetches the next row and returns it as an object.

The object will be of the class specified by StatementInterface::setFetchMode() or stdClass if not specified.

phpcs:disable Drupal.Commenting

Remove PHPCS overrides https://www.drupal.org/node/3194677.

Return Value

mixed

The object of specified class or \stdClass if not specified. Returns FALSE or NULL if there is no next row.

at line 147
An fetchAssoc()

Fetches the next row and returns it as an associative array.

This method corresponds to PDOStatement::fetchObject(), but for associative arrays. For some reason PDOStatement does not have a corresponding array helper method, so one is added.

Return Value

An

associative array, or FALSE if there is no next row.

at line 162
An fetchAll($mode = NULL, $column_index = NULL, $constructor_arguments = NULL)

Returns an array containing all of the result set rows.

Parameters

$mode

One of the PDO::FETCH_* constants.
$column_index

If $mode is PDO::FETCH_COLUMN, the index of the column to fetch.
$constructor_arguments

If $mode is PDO::FETCH_CLASS, the arguments to pass to the constructor.

Return Value

An

array of results.

at line 175
An fetchCol($index = 0)

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

$index

The index of the column number to fetch.

Return Value

An

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

at line 195
An fetchAllKeyed($key_index = 0, $value_index = 1)

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.

at line 214
An 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.