interface ResultStatement implements Traversable (View source)

Interface for the reading part of a prepare statement only.

Methods

bool
closeCursor()

Closes the cursor, enabling the statement to be executed again.

int
columnCount()

Returns the number of columns in the result set

bool
setFetchMode(int $fetchMode, array ...$args)

Sets the fetch mode to use while iterating this statement.

mixed
fetch(int|null $fetchMode = null, array ...$args)

Returns the next row of a result set.

array
fetchAll(int|null $fetchMode = null, array ...$args)

Returns an array containing all of the result set rows.

string|boolean
fetchColumn(int $columnIndex = 0)

Returns a single column from the next row of a result set or FALSE if there are no more rows.

Details

bool closeCursor()

Closes the cursor, enabling the statement to be executed again.

Return Value

bool TRUE on success or FALSE on failure.

int columnCount()

Returns the number of columns in the result set

Return Value

int The number of columns in the result set represented by the PDOStatement object. If there is no result set, this method should return 0.

bool setFetchMode(int $fetchMode, array ...$args)

Sets the fetch mode to use while iterating this statement.

Parameters

int $fetchMode Controls how the next row will be returned to the caller. The value must be one of the {@link \Doctrine\DBAL\FetchMode} constants.
array ...$args Optional mode-specific arguments (see {@link self::fetchAll()}).

Return Value

bool

mixed fetch(int|null $fetchMode = null, array ...$args)

Returns the next row of a result set.

Parameters

int|null $fetchMode Controls how the next row will be returned to the caller. The value must be one of the {@link \Doctrine\DBAL\FetchMode} constants, defaulting to {@link \Doctrine\DBAL\FetchMode::MIXED}.
array ...$args Optional mode-specific arguments (see {@link self::fetchAll()}).

Return Value

mixed The return value of this method on success depends on the fetch mode. In all cases, FALSE is returned on failure.

array fetchAll(int|null $fetchMode = null, array ...$args)

Returns an array containing all of the result set rows.

Parameters

int|null $fetchMode Controls how the next row will be returned to the caller. The value must be one of the {@link \Doctrine\DBAL\FetchMode} constants, defaulting to {@link \Doctrine\DBAL\FetchMode::MIXED}.
array ...$args Optional mode-specific arguments. Supported modes: * {@link \Doctrine\DBAL\FetchMode::COLUMN} 1. The 0-indexed column to be returned. * {@link \Doctrine\DBAL\FetchMode::CUSTOM_OBJECT} 1. The classname of the object to be created, 2. Array of constructor arguments

Return Value

array

string|boolean fetchColumn(int $columnIndex = 0)

Returns a single column from the next row of a result set or FALSE if there are no more rows.

Parameters

int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no value is supplied, PDOStatement->fetchColumn() fetches the first column.

Return Value

string|boolean A single column in the next row of a result set, or FALSE if there are no more rows.