MDB2_Iterator Class Reference

Inheritance diagram for MDB2_Iterator:

Collaboration diagram for MDB2_Iterator:

Public Member Functions
	__construct ($result, $fetchmode=MDB2_FETCHMODE_DEFAULT)
	Constructor. More...
	seek ($rownum)
	Seek forward to a specific row in a result set. More...
	next ()
	Fetch next row of data. More...
	current ()
	return a row of data More...
	valid ()
	Check if the end of the result set has been reached. More...
	free ()
	Free the internal resources associated with result. More...
	key ()
	Returns the row number. More...
	rewind ()
	Seek to the first row in a result set. More...
	__destruct ()
	Destructor. More...

Protected Attributes
	$fetchmode
	$result
	$row

Detailed Description

Definition at line 54 of file Iterator.php.

Constructor & Destructor Documentation

__construct()

MDB2_Iterator::__construct	(		$result,
			$fetchmode = MDB2_FETCHMODE_DEFAULT
	)

Constructor.

Definition at line 65 of file Iterator.php.

    {
        $this->result = $result;
        $this->fetchmode = $fetchmode;
    }

References $fetchmode, and $result.

__destruct()

MDB2_Iterator::__destruct

(

)

Destructor.

Definition at line 194 of file Iterator.php.

    {
        $this->free();
    }

References free().

Here is the call graph for this function:

Member Function Documentation

current()

MDB2_Iterator::current

(

)

return a row of data

Returns

void @access public

Definition at line 113 of file Iterator.php.

    {
        if (is_null($this->row)) {
            $row = $this->result->fetchRow($this->fetchmode);
            if (PEAR::isError($row)) {
                $row = false;
            }
            $this->row = $row;
        }
        return $this->row;
    }

References $row, and PEAR\isError().

Referenced by valid().

Here is the call graph for this function:

Here is the caller graph for this function:

free()

MDB2_Iterator::free

(

)

Free the internal resources associated with result.

Returns

bool|MDB2_Error true on success, false|MDB2_Error if result is invalid @access public

Definition at line 148 of file Iterator.php.

    {
        if ($this->result) {
            return $this->result->free();
        }
        $this->result = false;
        $this->row = null;
        return false;
    }

Referenced by __destruct().

Here is the caller graph for this function:

key()

MDB2_Iterator::key

(

)

Returns the row number.

Returns

int|bool|MDB2_Error true on success, false|MDB2_Error if result is invalid @access public

Definition at line 167 of file Iterator.php.

    {
        if ($this->result) {
            return $this->result->rowCount();
        }
        return false;
    }

next()

MDB2_Iterator::next

(

)

Fetch next row of data.

Returns

void @access public

Definition at line 99 of file Iterator.php.

    {
        $this->row = null;
    }

rewind()

MDB2_Iterator::rewind

(

)

Seek to the first row in a result set.

Returns

void @access public

Reimplemented in MDB2_BufferedIterator.

Definition at line 184 of file Iterator.php.

    {
    }

seek()

MDB2_Iterator::seek

(

$rownum

)

Seek forward to a specific row in a result set.

Parameters

int	number of the row where the data can be found

Returns

void @access public

Definition at line 82 of file Iterator.php.

    {
        $this->row = null;
        if ($this->result) {
            $this->result->seek($rownum);
        }
    }

Referenced by MDB2_BufferedIterator\rewind().

Here is the caller graph for this function:

valid()

MDB2_Iterator::valid

(

)

Check if the end of the result set has been reached.

Returns

bool true/false, false is also returned on failure @access public

Reimplemented in MDB2_BufferedIterator.

Definition at line 134 of file Iterator.php.

    {
        return (bool)$this->current();
    }

References current().

Here is the call graph for this function:

Field Documentation

$fetchmode

MDB2_Iterator::$fetchmode

protected

Definition at line 56 of file Iterator.php.

Referenced by __construct().

$result

MDB2_Iterator::$result

protected

Definition at line 57 of file Iterator.php.

Referenced by __construct().

$row

MDB2_Iterator::$row

protected

Definition at line 58 of file Iterator.php.

Referenced by current().

---

The documentation for this class was generated from the following file:

• Services/PEAR/lib/MDB2/Iterator.php