aboutsummaryrefslogtreecommitdiff
path: root/doc/html/classIsisItemIterator.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/classIsisItemIterator.html')
-rw-r--r--doc/html/classIsisItemIterator.html216
1 files changed, 216 insertions, 0 deletions
diff --git a/doc/html/classIsisItemIterator.html b/doc/html/classIsisItemIterator.html
new file mode 100644
index 0000000..a0c30e0
--- /dev/null
+++ b/doc/html/classIsisItemIterator.html
@@ -0,0 +1,216 @@
+<!-- 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: IsisItemIterator 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&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
+ <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>IsisItemIterator Class Reference</h1><!-- doxytag: class="IsisItemIterator" -->
+<p><a href="classIsisItemIterator-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisItemIterator.html#a6ee7fe126baaffa77ad2cf177fefc46a">__construct</a> ($class, $field, $main=false)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisItemIterator.html#ab87a4387a9fd745366ccf8e138a9f60c">rewind</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisItemIterator.html#ab51757f546b7d9efb9decd701a38b8b5">key</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisItemIterator.html#a3f602399a600d7b95d23b87111d0e72b">current</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisItemIterator.html#a17c6a2e50a0ca67feb92f4ffc4cbec23">next</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisItemIterator.html#aacea6ed6fd269ef1549ce86820da8b3b">valid</a> ()</td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Isis field iterator. Iterates over a field for each result row. </p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="a6ee7fe126baaffa77ad2cf177fefc46a"></a><!-- doxytag: member="IsisItemIterator::__construct" ref="a6ee7fe126baaffa77ad2cf177fefc46a" args="($class, $field, $main=false)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisItemIterator::__construct </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>class</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>field</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>main</em> = <code>false</code></td><td>&nbsp;</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>&nbsp;</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>&nbsp;</td><td>Field to iterate over.</td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$main</em>&nbsp;</td><td>Control to which item the main field should be mapped to. By default no mapping is made. </td></tr>
+ </table>
+ </dd>
+</dl>
+
+</div>
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a3f602399a600d7b95d23b87111d0e72b"></a><!-- doxytag: member="IsisItemIterator::current" ref="a3f602399a600d7b95d23b87111d0e72b" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisItemIterator::current </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Return the current element. </p>
+
+</div>
+</div>
+<a class="anchor" id="ab51757f546b7d9efb9decd701a38b8b5"></a><!-- doxytag: member="IsisItemIterator::key" ref="ab51757f546b7d9efb9decd701a38b8b5" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisItemIterator::key </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Return the key of the current element. </p>
+
+</div>
+</div>
+<a class="anchor" id="a17c6a2e50a0ca67feb92f4ffc4cbec23"></a><!-- doxytag: member="IsisItemIterator::next" ref="a17c6a2e50a0ca67feb92f4ffc4cbec23" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisItemIterator::next </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Move forward to next element. </p>
+
+</div>
+</div>
+<a class="anchor" id="ab87a4387a9fd745366ccf8e138a9f60c"></a><!-- doxytag: member="IsisItemIterator::rewind" ref="ab87a4387a9fd745366ccf8e138a9f60c" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisItemIterator::rewind </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Rewind the Iterator to the first element. </p>
+
+</div>
+</div>
+<a class="anchor" id="aacea6ed6fd269ef1549ce86820da8b3b"></a><!-- doxytag: member="IsisItemIterator::valid" ref="aacea6ed6fd269ef1549ce86820da8b3b" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisItemIterator::valid </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Check if there is a current element after calls to <a class="el" href="classIsisItemIterator.html#ab87a4387a9fd745366ccf8e138a9f60c">rewind()</a> or <a class="el" href="classIsisItemIterator.html#a17c6a2e50a0ca67feb92f4ffc4cbec23">next()</a>. </p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>classes/iterators/IsisItemIterator.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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</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 Fri Aug 20 15:38:20 2010 for Cinisis Database Reader by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
+</body>
+</html>