<!-- This comment will put IE 6, 7 and 8 in quirks mode --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Cinisis Database Reader: IsisRowIterator Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javaScript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.6.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <img id="MSearchSelect" src="search/search.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </div> </li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>IsisRowIterator Class Reference</h1><!-- doxytag: class="IsisRowIterator" --> <p><a href="classIsisRowIterator-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisRowIterator.html#acaab99d2bf18f6f958ddf07db55cb15d">__construct</a> ($class, $field)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisRowIterator.html#a5ef72f942cc738bf24cf251018c28edf">rewind</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisRowIterator.html#a96f65bca7f2e048a449e6f316d802e6f">key</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisRowIterator.html#abe18cfd484f70348fb5832444186b10d">current</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisRowIterator.html#ad084ce947a265969f738e7d7dc8a1853">next</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisRowIterator.html#a69cb2b1c6e8feaffcfe65363a9178b72">valid</a> ()</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Iterates over all rows from a field result. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="acaab99d2bf18f6f958ddf07db55cb15d"></a><!-- doxytag: member="IsisRowIterator::__construct" ref="acaab99d2bf18f6f958ddf07db55cb15d" args="($class, $field)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">IsisRowIterator::__construct </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"> <em>class</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>field</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>$class</em> </td><td>Instance of <a class="el" href="classIsisConnector.html">IsisConnector</a> or child class.</td></tr> <tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field to iterate over. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="abe18cfd484f70348fb5832444186b10d"></a><!-- doxytag: member="IsisRowIterator::current" ref="abe18cfd484f70348fb5832444186b10d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">IsisRowIterator::current </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Return the current element. </p> </div> </div> <a class="anchor" id="a96f65bca7f2e048a449e6f316d802e6f"></a><!-- doxytag: member="IsisRowIterator::key" ref="a96f65bca7f2e048a449e6f316d802e6f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">IsisRowIterator::key </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Return the key of the current element. </p> </div> </div> <a class="anchor" id="ad084ce947a265969f738e7d7dc8a1853"></a><!-- doxytag: member="IsisRowIterator::next" ref="ad084ce947a265969f738e7d7dc8a1853" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">IsisRowIterator::next </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Move forward to next element. </p> </div> </div> <a class="anchor" id="a5ef72f942cc738bf24cf251018c28edf"></a><!-- doxytag: member="IsisRowIterator::rewind" ref="a5ef72f942cc738bf24cf251018c28edf" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">IsisRowIterator::rewind </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Rewind the Iterator to the first element. </p> </div> </div> <a class="anchor" id="a69cb2b1c6e8feaffcfe65363a9178b72"></a><!-- doxytag: member="IsisRowIterator::valid" ref="a69cb2b1c6e8feaffcfe65363a9178b72" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">IsisRowIterator::valid </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Check if there is a current element after calls to <a class="el" href="classIsisRowIterator.html#a5ef72f942cc738bf24cf251018c28edf">rewind()</a> or <a class="el" href="classIsisRowIterator.html#ad084ce947a265969f738e7d7dc8a1853">next()</a>. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>classes/iterators/IsisRowIterator.php</li> </ul> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 23 16:26:23 2010 for Cinisis Database Reader by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>