Class Swift_Iterator_MySQLResult

Description

Implements interfaces:

Swift Mailer MySQL Resultset Iterator.

Iterates over MySQL Resultset from mysql_query().

Located in /Swift/Iterator/MySQLResult.php (line 20)


	
			
Variable Summary
array $currentRow
int $numRows
int $pos
resource $resultSet
Method Summary
Swift_Iterator_MySQLResult __construct (resource $rs)
int getPosition ()
resource getResultSet ()
mixed. getValue ()
boolean hasNext ()
boolean next ()
boolean seekTo (int $pos)
Variables
array $currentRow = array(null, null) (line 31)

The current row (array) in the resultset.

  • access: protected
int $numRows = 0 (line 41)

The total number of rows in the resultset.

  • access: protected
int $pos = -1 (line 36)

The current array position.

  • access: protected
resource $resultSet (line 26)

The MySQL resource.

  • access: protected
Methods
Constructor __construct (line 47)

Ctor.

  • access: public
Swift_Iterator_MySQLResult __construct (resource $rs)
  • resource $rs: The resultset iterate over.
getPosition (line 117)

Gets the current numeric position within the array.

  • access: public
int getPosition ()

Implementation of:
Swift_Iterator::getPosition()
Get the current list position.
getResultSet (line 56)

Get the resultset.

  • access: public
resource getResultSet ()
getValue (line 105)

Returns the value at the current position, or NULL otherwise.

  • access: public
mixed. getValue ()

Implementation of:
Swift_Iterator::getValue()
Get the value of the list at the current position.
hasNext (line 64)

Returns true if there is a value after the current one.

  • access: public
boolean hasNext ()

Implementation of:
Swift_Iterator::hasNext()
Check if there is a value in the list after the current one.
next (line 72)

Moves to the next array element if possible.

  • access: public
boolean next ()

Implementation of:
Swift_Iterator::next()
Move to the next position in the list if possible.
seekTo (line 88)

Goes directly to the given element in the array if possible.

  • access: public
boolean seekTo (int $pos)
  • int $pos: Numeric position

Implementation of:
Swift_Iterator::seekTo()
Seek to the given numeric index in the list of possible.

Documentation generated on Wed, 26 Mar 2008 20:33:09 +1100 by phpDocumentor 1.3.1