diff options
Diffstat (limited to 'doc/html/classIsisFinder.html')
| -rw-r--r-- | doc/html/classIsisFinder.html | 245 |
1 files changed, 245 insertions, 0 deletions
diff --git a/doc/html/classIsisFinder.html b/doc/html/classIsisFinder.html new file mode 100644 index 0000000..d6ad631 --- /dev/null +++ b/doc/html/classIsisFinder.html @@ -0,0 +1,245 @@ +<!-- 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: IsisFinder 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>IsisFinder Class Reference</h1><!-- doxytag: class="IsisFinder" --><!-- doxytag: inherits="IsisConnector" --><div class="dynheader"> +Inheritance diagram for IsisFinder:</div> +<div class="dynsection"> + <div class="center"> + <img src="classIsisFinder.png" usemap="#IsisFinder_map" alt=""/> + <map id="IsisFinder_map" name="IsisFinder_map"> +<area href="classIsisConnector.html" alt="IsisConnector" shape="rect" coords="0,112,89,136"/> +<area href="classIsisMap.html" alt="IsisMap" shape="rect" coords="0,56,89,80"/> +<area href="classIsisReader.html" alt="IsisReader" shape="rect" coords="0,0,89,24"/> +<area href="classIsisAudit.html" alt="IsisAudit" shape="rect" coords="0,224,89,248"/> +</map> + </div> +</div> + +<p><a href="classIsisFinder-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="classIsisFinder.html#ac4e3a8f45995cbf940b3f2899b71bd1e">nextRepetition</a> ($field, $entry=1)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisFinder.html#a7d708e281bea35ee38f5875c8f2cad8d">nextField</a> ($field, $entry=1)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisFinder.html#aa367980783d341197e003684a639ff1a">nextSubfield</a> ($field, $subfield, $entry=1)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisFinder.html#a41410b18c4462c05ac669e4ee889d8a7">hasSubfieldInRows</a> ($field, $subfield)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Provides Isis Database search methods. </p> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a41410b18c4462c05ac669e4ee889d8a7"></a><!-- doxytag: member="IsisFinder::hasSubfieldInRows" ref="a41410b18c4462c05ac669e4ee889d8a7" args="($field, $subfield)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisFinder::hasSubfieldInRows </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>subfield</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Check if a field result has a given subfield.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field data.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$subfield</em> </td><td>Subfield.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>True if result has the subfield, false otherwise. </dd></dl> + +</div> +</div> +<a class="anchor" id="a7d708e281bea35ee38f5875c8f2cad8d"></a><!-- doxytag: member="IsisFinder::nextField" ref="a7d708e281bea35ee38f5875c8f2cad8d" args="($field, $entry=1)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisFinder::nextField </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>entry</em> = <code>1</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Find the next occurrence of a field.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$entry</em> </td><td>Start entry number to begin the search.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field data.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Next occurrence. </dd></dl> + +</div> +</div> +<a class="anchor" id="ac4e3a8f45995cbf940b3f2899b71bd1e"></a><!-- doxytag: member="IsisFinder::nextRepetition" ref="ac4e3a8f45995cbf940b3f2899b71bd1e" args="($field, $entry=1)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisFinder::nextRepetition </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>entry</em> = <code>1</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Find the next repetition of a field.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$entry</em> </td><td>Start entry number to begin the search.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field data.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Next repetition entry and result. </dd></dl> + +</div> +</div> +<a class="anchor" id="aa367980783d341197e003684a639ff1a"></a><!-- doxytag: member="IsisFinder::nextSubfield" ref="aa367980783d341197e003684a639ff1a" args="($field, $subfield, $entry=1)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisFinder::nextSubfield </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>subfield</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>entry</em> = <code>1</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Find the next occurrence of a subfield.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$entry</em> </td><td>Start entry number to begin the search.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field data.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$subfield</em> </td><td>Subfield name.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Next occurrence. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>classes/IsisFinder.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 Fri Aug 20 15:38:20 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> |