MDB2
[ class tree: MDB2 ] [ index: MDB2 ] [ all elements ]

Class: MDB2_Iterator

Source Location: /MDB2-2.5.0b5/MDB2/Iterator.php

Class Overview


PHP5 Iterator


Author(s):

Variables

Methods


Child classes:

MDB2_BufferedIterator
PHP5 buffered Iterator

Inherited Variables

Inherited Methods


Class Details

[line 54]
PHP5 Iterator


[ Top ]


Class Variables

$fetchmode =

[line 56]

  • Access: protected

Type:   mixed


[ Top ]

$result =

[line 60]

  • Access: protected

Type:   MDB2_Result_Common


[ Top ]

$row =

[line 61]

  • Access: protected

Type:   mixed


[ Top ]



Method Detail

__construct (Constructor)   [line 68]

MDB2_Iterator __construct( MDB2_Result_Common $result, [ $fetchmode = MDB2_FETCHMODE_DEFAULT])

Constructor
  • Access: public

Parameters:

MDB2_Result_Common   $result     
   $fetchmode     

[ Top ]

__destruct (Destructor)   [line 197]

void __destruct( )

Destructor
  • Access: public

[ Top ]

current   [line 116]

void current( )

return a row of data
  • Access: public

[ Top ]

free   [line 151]

bool|MDB2_Error free( )

Free the internal resources associated with result.
  • Return: true on success, false|MDB2_Error if result is invalid
  • Access: public

[ Top ]

key   [line 170]

int|bool|MDB2_Error key( )

Returns the row number
  • Return: true on success, false|MDB2_Error if result is invalid
  • Access: public

[ Top ]

next   [line 102]

void next( )

Fetch next row of data
  • Access: public

[ Top ]

rewind   [line 187]

void rewind( )

Seek to the first row in a result set
  • Access: public

Overridden in child classes as:

MDB2_BufferedIterator::rewind()
Seek to the first row in a result set

[ Top ]

seek   [line 85]

void seek( int $rownum)

Seek forward to a specific row in a result set
  • Access: public

Parameters:

int   $rownum     number of the row where the data can be found

[ Top ]

valid   [line 137]

bool valid( )

Check if the end of the result set has been reached
  • Return: true/false, false is also returned on failure
  • Access: public

Overridden in child classes as:

MDB2_BufferedIterator::valid()
Check if the end of the result set has been reached

[ Top ]


Documentation generated on Mon, 29 Oct 2012 16:00:10 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.