interface IFetchAbstract (View source)

This interface defines the contract for fetching data from a database.

Implementing classes should provide concrete implementations for the methods declared in this interface to handle data retrieval operations.

Methods

object|false
internalFetchClass(array|null $constructorArguments = null, string|null $aClassOrObject = '\\stdClass')

Fetches a single row from the result set, or false if there are no more rows.

bool|array
internalFetchBoth()

Fetches the current row as both an associative and a numeric array.

array|null|false
internalFetchAssoc()

Fetches a single row from the result set as a numerically indexed array, converting all values to strings, or returns false if there are no more rows.

array|false|null
internalFetchNum()

Fetches the current row as a numeric array.

false|string
internalFetchColumn(int $columnIndex = 0)

Fetches a single value from the result set, or false if there are no more rows.

array
internalFetchAllAssoc()

Fetches all rows from the result set as an associative array, or an empty array if there are no more rows.

array
internalFetchAllNum()

Fetches all rows from the result set as a numerically indexed array of arrays, converting all values to strings, or an empty array if there are no more rows.

array
internalFetchAllBoth()

Fetches all rows from the result set as an array of arrays, where each row is both numerically and associatively indexed.

array
internalFetchAllColumn(int $columnIndex = 0)

Fetches all values of a single column from the result set as an array of strings.

array
internalFetchAllClass(array|null $constructorArguments = [], string|null $aClassOrObject = '\\stdClass')

Fetches all rows from the result set as an array of objects, each one being an instance of the provided class.

Details

object|false internalFetchClass(array|null $constructorArguments = null, string|null $aClassOrObject = '\\stdClass')

Fetches a single row from the result set, or false if there are no more rows.

Parameters

array|null $constructorArguments

Arguments to pass to the class constructor.

string|null $aClassOrObject

Class name or object to hydrate.

Return Value

object|false

Exceptions

ReflectionException

bool|array internalFetchBoth()

Fetches the current row as both an associative and a numeric array.

Return Value

bool|array

Returns an associative and numeric array if successful, false on failure.

array|null|false internalFetchAssoc()

Fetches a single row from the result set as a numerically indexed array, converting all values to strings, or returns false if there are no more rows.

Return Value

array|null|false

A numerically indexed array of the row values as strings, false if no more rows, or null on error.

array|false|null internalFetchNum()

Fetches the current row as a numeric array.

Return Value

array|false|null

Returns a numeric array if successful, null if no row was found, or false on failure.

false|string internalFetchColumn(int $columnIndex = 0)

Fetches a single value from the result set, or false if there are no more rows.

Parameters

int $columnIndex

Index of the value to fetch. If not provided, fetches the first column.

Return Value

false|string

The value of the row at the specified index, false if no more rows, or null on error.

array internalFetchAllAssoc()

Fetches all rows from the result set as an associative array, or an empty array if there are no more rows.

Return Value

array

An associative array of the row values as strings, or an empty array if no more rows, or null on error.

array internalFetchAllNum()

Fetches all rows from the result set as a numerically indexed array of arrays, converting all values to strings, or an empty array if there are no more rows.

Return Value

array

A numerically indexed array of the row values as strings, or an empty array if no more rows, or null on error.

array internalFetchAllBoth()

Fetches all rows from the result set as an array of arrays, where each row is both numerically and associatively indexed.

All values are converted to strings. If there are no more rows, an empty array is returned.

Return Value

array

An array of the row values as strings, with both numerical and associative indexes, or an empty array if no more rows, or null on error.

array internalFetchAllColumn(int $columnIndex = 0)

Fetches all values of a single column from the result set as an array of strings.

Parameters

int $columnIndex

Index of the value to fetch. If not provided, fetches the first column.

Return Value

array

An array of the column values as strings, or an empty array if no more rows, or null on error.

array internalFetchAllClass(array|null $constructorArguments = [], string|null $aClassOrObject = '\\stdClass')

Fetches all rows from the result set as an array of objects, each one being an instance of the provided class.

The class is created with the provided constructor arguments and properties are set with the values from the row. If there are no more rows, an empty array is returned.

Parameters

array|null $constructorArguments

Arguments to pass to the class constructor.

string|null $aClassOrObject

Class name or object to hydrate.

Return Value

array

An array of the row values as objects, or an empty array if no more rows, or null on error.

Exceptions

ReflectionException