interface ResultStatement implements Traversable (View source)

Interface for the reading part of a prepare statement only.

Methods

boolean
closeCursor()

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

integer
columnCount()

Returns the number of columns in the result set

boolean
setFetchMode(integer $fetchMode, mixed $arg2 = null, mixed $arg3 = null)

Sets the fetch mode to use while iterating this statement.

mixed
fetch(integer|null $fetchMode = null)

Returns the next row of a result set.

array
fetchAll(integer|null $fetchMode = null)

Returns an array containing all of the result set rows.

string|boolean
fetchColumn(integer $columnIndex = 0)

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

Details

boolean closeCursor()

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

Return Value

boolean TRUE on success or FALSE on failure.

integer columnCount()

Returns the number of columns in the result set

Return Value

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

boolean setFetchMode(integer $fetchMode, mixed $arg2 = null, mixed $arg3 = null)

Sets the fetch mode to use while iterating this statement.

Parameters

integer $fetchMode The fetch mode must be one of the PDO::FETCH_* constants.
mixed $arg2
mixed $arg3

Return Value

boolean

See also

PDO::FETCH_* constants.

mixed fetch(integer|null $fetchMode = null)

Returns the next row of a result set.

Parameters

integer|null $fetchMode Controls how the next row will be returned to the caller. The value must be one of the PDO::FETCH_* constants, defaulting to PDO::FETCH_BOTH.

Return Value

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

See also

PDO::FETCH_* constants.

array fetchAll(integer|null $fetchMode = null)

Returns an array containing all of the result set rows.

Parameters

integer|null $fetchMode Controls how the next row will be returned to the caller. The value must be one of the PDO::FETCH_* constants, defaulting to PDO::FETCH_BOTH.

Return Value

array

See also

PDO::FETCH_* constants.

string|boolean fetchColumn(integer $columnIndex = 0)

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

Parameters

integer $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.