class ArrayStatement implements IteratorAggregate, ResultStatement (View source)

Methods

__construct(array $data)

No description

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, mixed $arg2 = null, mixed $arg3 = null)

Sets the fetch mode to use while iterating this statement.

getIterator()

{@inheritdoc}

mixed
fetch(int|null $fetchMode = null, int $cursorOrientation = PDO::FETCH_ORI_NEXT, int $cursorOffset = 0)

Returns the next row of a result set.

mixed[]
fetchAll(int|null $fetchMode = null, int|null $fetchArgument = null, mixed[]|null $ctorArgs = null)

Returns an array containing all of the result set rows.

mixed|false
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

__construct(array $data)

Parameters

array $data

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, mixed $arg2 = null, mixed $arg3 = null)

Sets the fetch mode to use while iterating this statement.

Parameters

int $fetchMode The fetch mode must be one of the {@link \Doctrine\DBAL\FetchMode} constants.
mixed $arg2
mixed $arg3

Return Value

bool

getIterator()

{@inheritdoc}

mixed fetch(int|null $fetchMode = null, int $cursorOrientation = PDO::FETCH_ORI_NEXT, int $cursorOffset = 0)

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}.
int $cursorOrientation For a ResultStatement object representing a scrollable cursor, this value determines which row will be returned to the caller. This value must be one of the \PDO::FETCH_ORI_* constants, defaulting to \PDO::FETCH_ORI_NEXT. To request a scrollable cursor for your ResultStatement object, you must set the \PDO::ATTR_CURSOR attribute to \PDO::CURSOR_SCROLL when you prepare the SQL statement with \PDO::prepare().
int $cursorOffset For a ResultStatement object representing a scrollable cursor for which the cursorOrientation parameter is set to \PDO::FETCH_ORI_ABS, this value specifies the absolute number of the row in the result set that shall be fetched. For a ResultStatement object representing a scrollable cursor for which the cursorOrientation parameter is set to \PDO::FETCH_ORI_REL, this value specifies the row to fetch relative to the cursor position before ResultStatement::fetch() was called.

Return Value

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

mixed[] fetchAll(int|null $fetchMode = null, int|null $fetchArgument = null, mixed[]|null $ctorArgs = null)

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}.
int|null $fetchArgument This argument has a different meaning depending on the value of the $fetchMode parameter: * {@link \Doctrine\DBAL\FetchMode::COLUMN}: Returns the indicated 0-indexed column. * {@link \Doctrine\DBAL\FetchMode::CUSTOM_OBJECT}: Returns instances of the specified class, mapping the columns of each row to named properties in the class. * \PDO::FETCH_FUNC: Returns the results of calling the specified function, using each row's columns as parameters in the call.
mixed[]|null $ctorArgs 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}.

Return Value

mixed[]

mixed|false 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, fetches the first column.

Return Value

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