An Inx_Api_BOResultSet is effectively a list of Inx_Api_BusinessObjects.
An Inx_Api_BOResultSet is effectively a list of Inx_Api_BusinessObjects. The result set can be used to browse through this list, and to remove elements of the list. As of Inxmail Professional API 1.11.1, Inx_Api_BOResultSet implements Iterator. This enables you to use a for-each loop on an Inx_Api_BOResultSet.
<strong>Note:</strong> An Inx_Api_BOResultSet object <strong>must</strong> 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 a Inx_Api_BOResultSet, as of Inxmail Professional API 1.11.1:
$oMailings = $oSession->getMailingManager()->selectAll(); foreach( $oMailings as $oMailing ) { echo 'Mailing: ' . $oMailing->getName() . '<br>'; } $oMailings->close();
Located in /Api/BOResultSet.php (line 33)
Iterator | --Inx_Api_BOResultSet
Closes this result set and releases any resources associated with the result set.
Closes this result set and releases any resources associated with the result set. An Inx_Api_BOResultSet object <strong>must</strong> be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.
Returns the Inx_Api_BusinessObject with the specified index.
Returns the Inx_Api_BusinessObject with the specified index.
Removes all business objects that are selected. have been removed.
Removes all business objects that are selected. The method returns true if and only if all selected elements have been removed. In some case it is possible that some elements cannot be removed (e.g. Inx_Api_List_SystemListContext, Properties, ... ).
Returns the number of business objects in this result set.
Returns the number of business objects in this result set.
Documentation generated on Thu, 17 Sep 2015 14:27:21 +0200 by phpDocumentor 1.3.2