diff options
| author | Silvio <silvio@devlet.com.br> | 2010-08-20 15:39:56 -0300 |
|---|---|---|
| committer | Silvio <silvio@devlet.com.br> | 2010-08-20 15:39:56 -0300 |
| commit | b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a (patch) | |
| tree | 5fd92d1ec675d64bf1a79e8f246a99c2e47f8e2b /doc/html/classIsisConnector.html | |
| parent | 298ac8892db90e518da71540c8fab72f885d66ff (diff) | |
| download | cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.gz cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.bz2 | |
Adding generated docs
Diffstat (limited to 'doc/html/classIsisConnector.html')
| -rw-r--r-- | doc/html/classIsisConnector.html | 760 |
1 files changed, 760 insertions, 0 deletions
diff --git a/doc/html/classIsisConnector.html b/doc/html/classIsisConnector.html new file mode 100644 index 0000000..357f641 --- /dev/null +++ b/doc/html/classIsisConnector.html @@ -0,0 +1,760 @@ +<!-- 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: IsisConnector 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>IsisConnector Class Reference</h1><!-- doxytag: class="IsisConnector" --><!-- doxytag: inherits="IsisMap" --><div class="dynheader"> +Inheritance diagram for IsisConnector:</div> +<div class="dynsection"> + <div class="center"> + <img src="classIsisConnector.png" usemap="#IsisConnector_map" alt=""/> + <map id="IsisConnector_map" name="IsisConnector_map"> +<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="classIsisFinder.html" alt="IsisFinder" shape="rect" coords="0,168,89,192"/> +<area href="classIsisAudit.html" alt="IsisAudit" shape="rect" coords="0,224,89,248"/> +</map> + </div> +</div> + +<p><a href="classIsisConnector-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="classIsisConnector.html#a0d1ebc176fe54568044aae02d7932c9b">getRows</a> ($field)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#ad806dcc5be703fe9aea63d72d68af0a2">getValues</a> ($field)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#aa16bb24a54837048eee6244957cbf091">getItem</a> ($field, $item, $row=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#aa928456a26e0264bf0c1a4869a02cbb3">getItems</a> ($field, $item)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#a21c7c4e9fec2440f8c7d36f8a632c8c2">getMainItem</a> ($field, $row=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#a2bace7162ec3bf49df9f7acd9367c360">getMainItems</a> ($field)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#a1ddaff24266ee02d652de9a752c1be8e">getSubfield</a> ($field, $subfield, $row=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#ad8af0f5cef3b139649d9fb317264df10">getSubfields</a> ($field, $subfield)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#afc97554b42b8b9e98f396811bbfa13d8">explodeSubfield</a> ($field, $subfield, $row)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#acfea4d86a683cc7455d258cdb80db478">explodeItem</a> ($field, $item, $row)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#a8baad24b6abc2ef29d8968f353ea6dae">filterSubfield</a> ($field, $subfield, $row)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#ad88ed9012aac0687aef1c8554879cd52">hasItem</a> ($field, $item, $row=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#a7bc914f2aa6c523404f368dc0b7b130b">hasMainItem</a> ($field, $row)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#a2e6970a3aca76a1dbb5b4bb5ac3adda1">hasSubfield</a> ($field, $subfield, $row)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#a10669b49c4145a86dc3662c77733d74d">existingItemKeys</a> ($field, $row=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#afbcef48a723b073a2777d5a5ed73d280">hasFieldSubfieldCondition</a> ($field, $subfield, $key, $subkey)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisConnector.html#a9050227e8d8f10821a4df08a5705832a">specialItem</a> ($field, $subfield, $return= 'boolean')</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p><a class="el" href="classIsisConnector.html">IsisConnector</a>: provides an easy interface to connect an application with <a class="el" href="classCinisis.html">Cinisis</a>. </p> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a10669b49c4145a86dc3662c77733d74d"></a><!-- doxytag: member="IsisConnector::existingItemKeys" ref="a10669b49c4145a86dc3662c77733d74d" args="($field, $row=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::existingItemKeys </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>row</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return the existing key items for a result.</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>$row</em> </td><td>Row number.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Array with existing item keys</dd></dl> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Test. </dd></dl> + +</div> +</div> +<a class="anchor" id="acfea4d86a683cc7455d258cdb80db478"></a><!-- doxytag: member="IsisConnector::explodeItem" ref="acfea4d86a683cc7455d258cdb80db478" args="($field, $item, $row)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::explodeItem </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>item</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>row</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Explode brackets for a given item, avoiding null entries.</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>$item</em> </td><td>Item.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$row</em> </td><td>Row number.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Exploded item data. </dd></dl> + +</div> +</div> +<a class="anchor" id="afc97554b42b8b9e98f396811bbfa13d8"></a><!-- doxytag: member="IsisConnector::explodeSubfield" ref="afc97554b42b8b9e98f396811bbfa13d8" args="($field, $subfield, $row)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::explodeSubfield </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>row</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Explode brackets for a given subfield, avoiding null entries.</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> + <tr><td valign="top"></td><td valign="top"><em>$row</em> </td><td>Row number.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Exploded subfield data. </dd></dl> + +</div> +</div> +<a class="anchor" id="a8baad24b6abc2ef29d8968f353ea6dae"></a><!-- doxytag: member="IsisConnector::filterSubfield" ref="a8baad24b6abc2ef29d8968f353ea6dae" args="($field, $subfield, $row)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::filterSubfield </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>row</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Filter brackets for 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> + <tr><td valign="top"></td><td valign="top"><em>$row</em> </td><td>Row number.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Filterd subfield data. </dd></dl> + +</div> +</div> +<a class="anchor" id="aa16bb24a54837048eee6244957cbf091"></a><!-- doxytag: member="IsisConnector::getItem" ref="aa16bb24a54837048eee6244957cbf091" args="($field, $item, $row=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::getItem </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>item</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>row</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get both main field or subfields from a given field and row.</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 array.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$item</em> </td><td>item name (field or subfield).</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$row</em> </td><td>row number.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Item data. </dd></dl> + +</div> +</div> +<a class="anchor" id="aa928456a26e0264bf0c1a4869a02cbb3"></a><!-- doxytag: member="IsisConnector::getItems" ref="aa928456a26e0264bf0c1a4869a02cbb3" args="($field, $item)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::getItems </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>item</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get all rows both main field or subfields from a given 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>$field</em> </td><td>field array.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$item</em> </td><td>item name (field or subfield).</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Item data. </dd></dl> + +</div> +</div> +<a class="anchor" id="a21c7c4e9fec2440f8c7d36f8a632c8c2"></a><!-- doxytag: member="IsisConnector::getMainItem" ref="a21c7c4e9fec2440f8c7d36f8a632c8c2" args="($field, $row=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::getMainItem </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>row</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the value of a given 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>$field</em> </td><td>Field array.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$row</em> </td><td>Optional row number if repetitive field.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Field data. </dd></dl> + +</div> +</div> +<a class="anchor" id="a2bace7162ec3bf49df9f7acd9367c360"></a><!-- doxytag: member="IsisConnector::getMainItems" ref="a2bace7162ec3bf49df9f7acd9367c360" args="($field)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::getMainItems </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>field</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get all values of a given 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>$field</em> </td><td>Field array.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Field data. </dd></dl> + +</div> +</div> +<a class="anchor" id="a0d1ebc176fe54568044aae02d7932c9b"></a><!-- doxytag: member="IsisConnector::getRows" ref="a0d1ebc176fe54568044aae02d7932c9b" args="($field)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::getRows </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>field</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the number of resulting rows for a given 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>$field</em> </td><td>Field array.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Number of rows. </dd></dl> + +</div> +</div> +<a class="anchor" id="a1ddaff24266ee02d652de9a752c1be8e"></a><!-- doxytag: member="IsisConnector::getSubfield" ref="a1ddaff24266ee02d652de9a752c1be8e" args="($field, $subfield, $row=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::getSubfield </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>row</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the value of 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 array.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$subfield</em> </td><td>Subfield name.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$row</em> </td><td>Row number if repetitive data.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Subfield data. </dd></dl> + +</div> +</div> +<a class="anchor" id="ad8af0f5cef3b139649d9fb317264df10"></a><!-- doxytag: member="IsisConnector::getSubfields" ref="ad8af0f5cef3b139649d9fb317264df10" args="($field, $subfield)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::getSubfields </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>Get all values of 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 array.</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>Subfield data. </dd></dl> + +</div> +</div> +<a class="anchor" id="ad806dcc5be703fe9aea63d72d68af0a2"></a><!-- doxytag: member="IsisConnector::getValues" ref="ad806dcc5be703fe9aea63d72d68af0a2" args="($field)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::getValues </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>field</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get all values of a given 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>$field</em> </td><td>Field array.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Field data. </dd></dl> + +</div> +</div> +<a class="anchor" id="afbcef48a723b073a2777d5a5ed73d280"></a><!-- doxytag: member="IsisConnector::hasFieldSubfieldCondition" ref="afbcef48a723b073a2777d5a5ed73d280" args="($field, $subfield, $key, $subkey)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::hasFieldSubfieldCondition </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>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>subkey</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 and subfield match a given condition.</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> + <tr><td valign="top"></td><td valign="top"><em>$key</em> </td><td>Field key.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$subkey</em> </td><td>Subfield key.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>True if condition match, false otherwise. </dd></dl> + +</div> +</div> +<a class="anchor" id="ad88ed9012aac0687aef1c8554879cd52"></a><!-- doxytag: member="IsisConnector::hasItem" ref="ad88ed9012aac0687aef1c8554879cd52" args="($field, $item, $row=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::hasItem </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>item</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>row</em> = <code>0</code></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 an item.</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>$item</em> </td><td>Item code ('main' for the main item).</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$row</em> </td><td>Row number.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>True if result has the main item, false otherwise. </dd></dl> + +</div> +</div> +<a class="anchor" id="a7bc914f2aa6c523404f368dc0b7b130b"></a><!-- doxytag: member="IsisConnector::hasMainItem" ref="a7bc914f2aa6c523404f368dc0b7b130b" args="($field, $row)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::hasMainItem </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>row</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 main item.</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>$row</em> </td><td>Row number.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>True if result has the main item, false otherwise. </dd></dl> + +</div> +</div> +<a class="anchor" id="a2e6970a3aca76a1dbb5b4bb5ac3adda1"></a><!-- doxytag: member="IsisConnector::hasSubfield" ref="a2e6970a3aca76a1dbb5b4bb5ac3adda1" args="($field, $subfield, $row)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::hasSubfield </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>row</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 and row 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> + <tr><td valign="top"></td><td valign="top"><em>$row</em> </td><td>Row number.</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="a9050227e8d8f10821a4df08a5705832a"></a><!-- doxytag: member="IsisConnector::specialItem" ref="a9050227e8d8f10821a4df08a5705832a" args="($field, $subfield, $return= 'boolean')" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">IsisConnector::specialItem </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>return</em> = <code>'boolean'</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Deal with special items.</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 from ISIS database schema.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$subfield</em> </td><td>Subfield name.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$return</em> </td><td>Specify return type.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>True if special subfield, false otherwise of special return type </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>classes/IsisConnector.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> |