Interface Inx_Api_ROBOResultSet

Description

An Inx_Api_ROBOResultSet is effectively a list of Inx_Api_ReadOnlyBusinessObjects.

An Inx_Api_ROBOResultSet is effectively a list of Inx_Api_ReadOnlyBusinessObjects. The result set can be used to browse through this list. Same as Inx_Api_BOResultSet, Inx_Api_ROBOResultSet implements Iterator. This enables you to use a for-each loop on an Inx_Api_ROBOResultSet.

Note: An Inx_Api_ROBOResultSet object must be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

The following snippet demonstrates the preferable way to iterate over an Inx_Api_ROBOResultSet:

 $oSendings = $oSession->getSendingHistoryManager()->selectAll();

 foreach( $oSendings as $oSending )
 {
 	echo 'Mailing ' . $oSending->getMailingId() . ' has been sent to: '
          . implode( ',', $oSending->getRecipientIDs() ) . '<br>';
 }

 $oSendings->close();

Located in /Api/ROBOResultSet.php (line 30)

Iterator
   |
   --Inx_Api_ROBOResultSet
Method Summary
void close ()
int size ()
Methods
close (line 53)

Closes this result set and releases any resources associated with the result set. Inx_Api_ROBOResultSet object must be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

Closes this result set and releases any resources associated with the result set. An Inx_Api_ROBOResultSet object must be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

  • access: public
void close ()
get (line 39)

Returns the Inx_Api_ReadOnlyBusinessObject with the specified index.

Returns the Inx_Api_ReadOnlyBusinessObject with the specified index.

  • return: the ReadOnlyBusinessObject with the specified index.
  • throws: DataException if no Inx_Api_ReadOnlyBusinessObject could be found (e.g. the object was deleted).
  • access: public
Inx_Api_ReadOnlyBusinessObject get (int $iIndex)
  • int $iIndex: the index of the Inx_Api_ReadOnlyBusinessObject to retrieve in this result set.
size (line 46)

Returns the number of read-only business objects in this result set.

Returns the number of read-only business objects in this result set.

  • return: the number of read-only business objects.
  • access: public
int size ()

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