Class \Prado\Data\TDbDataReader

TDbDataReader class.

TDbDataReader represents a forward-only stream of rows from a query result set.

To read the current row of data, call read. The method readAll returns all the rows in a single array.

One can also retrieve the rows of data in TDbDataReader by using foreach:

foreach($reader as $row)
    // $row represents a row of data

Since TDbDataReader is a forward-only stream, you can only traverse it once.

It is possible to use a specific mode of data fetching by setting \Prado\Data\setFetchMode. See http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php for more details.

Class hierarchy

\Prado\Data\TDbDataReader implements Iterator

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct(TDbCommand $command) : mixed` Constructor.
`public`	`bindColumn(mixed $column, mixed &$value[, null\|int $dataType = null ]) : mixed` Binds a column to a PHP variable. When rows of data are being fetched, the corresponding column value will be set in the variable. Note, the fetch mode must include PDO::FETCH_BOUND.
`public`	`close() : mixed` Closes the reader. Any further data reading will result in an exception.
`public`	`current() : mixed` Returns the current row. This method is required by the interface Iterator.
`public`	`getColumnCount() : int`
`public`	`getIsClosed() : bool`
`public`	`getRowCount() : int`
`public`	`key() : int` Returns the index of the current row. This method is required by the interface Iterator.
`public`	`next() : void` Moves the internal pointer to the next row. This method is required by the interface Iterator.
`public`	`nextResult() : mixed` Advances the reader to the next result when reading the results of a batch of statements. This method is only useful when there are multiple result sets returned by the query. Not all DBMS support this feature.
`public`	`read() : array<string\|int, mixed>\|false` Advances the reader to the next row in a result set.
`public`	`readAll() : array<string\|int, mixed>` Reads the whole result set into an array.
`public`	`readColumn(int $columnIndex) : false\|mixed` Returns a single column from the next row of a result set.
`public`	`readObject(string $className, array<string\|int, mixed> $fields) : false\|mixed` Returns a single column from the next row of a result set.
`public`	`rewind() : void` Resets the iterator to the initial state. This method is required by the interface Iterator.
`public`	`setFetchMode(mixed $mode) : mixed`
`public`	`valid() : bool` Returns whether there is a row of data at current position. This method is required by the interface Iterator.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Data\TDbDataReader

Class hierarchy