Interface Inx_Api_InxRowSet

Description

Inx_Api_InxRowSet provides a common interface for row set navigation. Inx_Api_InxRowSet are next() and close(). iterate over the rows of the row set.

Inx_Api_InxRowSet provides a common interface for row set navigation. The most important methods of Inx_Api_InxRowSet are next() and close(). The next() method can be used to iterate over the rows of the row set. The following snippet shows how to iterate over a Inx_Api_InxRowSet:

 $oInxRowSet = ... //get an InxRowSet implementation

 while($oInxRowSet->next())
 {
    //retrieve some information from the row set.
 }

 $oInxRowSet->close();
Be sure to call next() before the first retrieval statement on the row set. Initially the cursor is before the first row, thus no data can be retrieved from the row set before calling next(). Doing so will trigger an Inx_Api_DataException. Note: An Inx_Api_InxRowSet object must be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

  • author: chge, 16.05.2013
  • since: API 1.11.1

Located in /Api/InxRowSet.php (line 28)


	
			
Direct descendents
Class Description
Inx_Api_DataAccess_DataRowSet Since API version 1. which provides the common base for all row sets. more information.
Inx_Api_ManipulationRowSet Inx_Api_ManipulationRowSet provides a common base for row sets which enable the manipulation of the contained data. data in the currently selected row.
Inx_Api_Recipient_ReadOnlyRecipientRowSet
  1. ReadOnlyRecipientRowSet
provides a common base for all row sets with the ability to retrieve recipient meta data (i. #getObject(Attribute).
Inx_Api_Sending_IndividualSendingRowSet The Inx_Api_Sending_IndividualSendingRowSet gives information regarding the reaction of recipients to sendings.
Method Summary
void afterLastRow ()
void beforeFirstRow ()
void close ()
int getRow ()
int getRowCount ()
bool next ()
bool previous ()
void setRow (int $iRow)
Methods
afterLastRow (line 41)

Moves the cursor to the end of this row set, just after the last row. contains no rows.

Moves the cursor to the end of this row set, just after the last row. This method has no effect if the result set contains no rows.

  • access: public
void afterLastRow ()
beforeFirstRow (line 34)

Moves the cursor to the front of this row set, just before the first row. set contains no rows.

Moves the cursor to the front of this row set, just before the first row. This method has no effect if the result set contains no rows.

  • access: public
void beforeFirstRow ()
close (line 90)

Releases the resources associated with this row set on the server immediately. closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

Releases the resources associated with this row set on the server immediately. A row set must be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

  • access: public
void close ()
getRow (line 57)

Retrieves the current row number.

Retrieves the current row number. The first row is number 0, the second number 1, and so on.

  • return: the current row number.
  • access: public
int getRow ()
getRowCount (line 83)

Returns the number of rows in this row set.

Returns the number of rows in this row set.

  • return: the number of rows.
  • access: public
int getRowCount ()
next (line 67)

Moves the cursor down one row from its current position. first row; the first call to the method next() makes the first row the current row; the second call makes the second row the current row, and so on.

Moves the cursor down one row from its current position. Initially, the row set cursor is positioned before the first row; the first call to the method next() makes the first row the current row; the second call makes the second row the current row, and so on.

  • return: true if the new current row is valid, false if there are no more rows.
  • access: public
bool next ()
previous (line 75)

Moves the cursor to the previous row in this row set.

Moves the cursor to the previous row in this row set.

  • return: true if the new current row is valid, false if it is off the result set.
  • access: public
bool previous ()
setRow (line 49)

Moves the cursor to the given row number in this row set.

Moves the cursor to the given row number in this row set. The first row is row 0, the second is row 1, and so on.

  • access: public
void setRow (int $iRow)
  • int $iRow: the number of the row to which the cursor should move.

Documentation generated on Thu, 17 Sep 2015 14:27:26 +0200 by phpDocumentor 1.3.2