CDbDataReader

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

Property Details

columnCount property read-only

public integer getColumnCount()

Returns the number of columns in the result set. Note, even there's no row in the reader, this still gives correct column number.

isClosed property read-only

public boolean getIsClosed()

whether the reader is closed or not.

rowCount property read-only

public integer getRowCount()

Returns the number of rows in the result set. Note, most DBMS may not give a meaningful count. In this case, use "SELECT COUNT(*) FROM tableName" to obtain the number of rows.

Method Details

__construct() method

public void __construct(CDbCommand $command)

public function __construct(CDbCommand $command)
{
    $this->_statement=$command->getPdoStatement();
    $this->_statement->setFetchMode(PDO::FETCH_ASSOC);
}

Constructor.

bindColumn() method

public void bindColumn(mixed $column, mixed &$value, integer $dataType=NULL)

public function bindColumn($column, &$value, $dataType=null)
{
    if($dataType===null)
        $this->_statement->bindColumn($column,$value);
    else
        $this->_statement->bindColumn($column,$value,$dataType);
}

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.

close() method

public void close()

public function close()
{
    $this->_statement->closeCursor();
    $this->_closed=true;
}

Closes the reader. This frees up the resources allocated for executing this SQL statement. Read attempts after this method call are unpredictable.

count() method

public integer count()

public function count()
{
    return $this->getRowCount();
}

Returns the number of rows in the result set. This method is required by the Countable interface. Note, most DBMS may not give a meaningful count. In this case, use "SELECT COUNT(*) FROM tableName" to obtain the number of rows.

current() method

public mixed current()

public function current()
{
    return $this->_row;
}

Returns the current row. This method is required by the interface Iterator.

getColumnCount() method

public integer getColumnCount()

public function getColumnCount()
{
    return $this->_statement->columnCount();
}

Returns the number of columns in the result set. Note, even there's no row in the reader, this still gives correct column number.

getIsClosed() method

public boolean getIsClosed()

public function getIsClosed()
{
    return $this->_closed;
}

whether the reader is closed or not.

getRowCount() method

public integer getRowCount()

public function getRowCount()
{
    return $this->_statement->rowCount();
}

Returns the number of rows in the result set. Note, most DBMS may not give a meaningful count. In this case, use "SELECT COUNT(*) FROM tableName" to obtain the number of rows.

key() method

public integer key()

public function key()
{
    return $this->_index;
}

Returns the index of the current row. This method is required by the interface Iterator.

next() method

public void next()

public function next()
{
    $this->_row=$this->_statement->fetch();
    $this->_index++;
}

Moves the internal pointer to the next row. This method is required by the interface Iterator.

nextResult() method

public boolean nextResult()

public function nextResult()
{
    if(($result=$this->_statement->nextRowset())!==false)
        $this->_index=-1;
    return $result;
}

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.

read() method

public array|false read()

public function read()
{
    return $this->_statement->fetch();
}

Advances the reader to the next row in a result set.

readAll() method

public array readAll()

public function readAll()
{
    return $this->_statement->fetchAll();
}

Reads the whole result set into an array.

readColumn() method

public mixed|false readColumn(integer $columnIndex)

public function readColumn($columnIndex)
{
    return $this->_statement->fetchColumn($columnIndex);
}

Returns a single column from the next row of a result set.

readObject() method

public mixed|false readObject(string $className, array $fields)

public function readObject($className,$fields)
{
    return $this->_statement->fetchObject($className,$fields);
}

Returns an object populated with the next row of data.

rewind() method

public void rewind()

public function rewind()
{
    if($this->_index<0)
    {
        $this->_row=$this->_statement->fetch();
        $this->_index=0;
    }
    else
        throw new CDbException(Yii::t('yii','CDbDataReader cannot rewind. It is a forward-only reader.'));
}

Resets the iterator to the initial state. This method is required by the interface Iterator.

setFetchMode() method

public void setFetchMode(mixed $mode)

public function setFetchMode($mode)
{
    $params=func_get_args();
    call_user_func_array(array($this->_statement,'setFetchMode'),$params);
}

Set the default fetch mode for this statement

valid() method

public boolean valid()

public function valid()
{
    return $this->_row!==false;
}

Returns whether there is a row of data at current position. This method is required by the interface Iterator.