<!-- 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: IsisReader 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>IsisReader Class Reference</h1><!-- doxytag: class="IsisReader" --><div class="dynheader">
Inheritance diagram for IsisReader:</div>
<div class="dynsection">
<div class="center">
<img src="classIsisReader.png" usemap="#IsisReader_map" alt=""/>
<map id="IsisReader_map" name="IsisReader_map">
<area href="classIsisMap.html" alt="IsisMap" shape="rect" coords="0,56,89,80"/>
<area href="classIsisConnector.html" alt="IsisConnector" shape="rect" coords="0,112,89,136"/>
<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="classIsisReader-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="classIsisReader.html#a70d1444cf56269795b4947dd82b2a4ac">__construct</a> ($config=null)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#afa6e3d3d94854913e5ed2604919d2316">open</a> ($config)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#a630791a319bec2bc55d0102cbb7f93df">read</a> ($entry)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#a99ce7b10b2997dad6a64558ac1f9f10e">removeBrackets</a> ($value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#a60ece3bbe11a2b4ac6afa6e65f282724">removeBracketsFromArray</a> (&$values)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#a4610ebcf69c197e2c596965e2dc0358e">explodeBrackets</a> ($subject)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#aa6099ed6bd276b32bd7bba184f144529">filterBrackets</a> ($values)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#a109a6ef49b2190bfbcee796dae954baf">hasBrackets</a> ($value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#a3cc08df25da082046d496db93778709b">explodeValue</a> ($value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisReader.html#ae65e172e3b5c9ac3c8a5e1352ba80904">joinSubfields</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Provides basic Isis read capabilities around <a class="el" href="classCinisis.html">Cinisis</a>. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a70d1444cf56269795b4947dd82b2a4ac"></a><!-- doxytag: member="IsisReader::__construct" ref="a70d1444cf56269795b4947dd82b2a4ac" args="($config=null)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::__construct </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>config</em> = <code>null</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4610ebcf69c197e2c596965e2dc0358e"></a><!-- doxytag: member="IsisReader::explodeBrackets" ref="a4610ebcf69c197e2c596965e2dc0358e" args="($subject)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::explodeBrackets </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>subject</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Explode a bracketed string into values. Just strings inside brackets are returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$subject</em> </td><td>Strings containing brackets.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array of matched strings. </dd></dl>
</div>
</div>
<a class="anchor" id="a3cc08df25da082046d496db93778709b"></a><!-- doxytag: member="IsisReader::explodeValue" ref="a3cc08df25da082046d496db93778709b" args="($value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::explodeValue </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Explode values from fields or subfields. Split values inside brackets if needed, but then doesn't return any value outside brackets.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$value</em> </td><td>String with values.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with values. </dd></dl>
</div>
</div>
<a class="anchor" id="aa6099ed6bd276b32bd7bba184f144529"></a><!-- doxytag: member="IsisReader::filterBrackets" ref="aa6099ed6bd276b32bd7bba184f144529" args="($values)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::filterBrackets </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>values</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Filter out brackets from strings.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$values</em> </td><td>String (or array filled with strings) to be filtered.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Filtered string or array. </dd></dl>
</div>
</div>
<a class="anchor" id="a109a6ef49b2190bfbcee796dae954baf"></a><!-- doxytag: member="IsisReader::hasBrackets" ref="a109a6ef49b2190bfbcee796dae954baf" args="($value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::hasBrackets </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if a string has brackets.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$value</em> </td><td>String to be compared.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if string has brackets, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="ae65e172e3b5c9ac3c8a5e1352ba80904"></a><!-- doxytag: member="IsisReader::joinSubfields" ref="ae65e172e3b5c9ac3c8a5e1352ba80904" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::joinSubfields </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether to join field and subfields in a single array.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Boolean. </dd></dl>
</div>
</div>
<a class="anchor" id="afa6e3d3d94854913e5ed2604919d2316"></a><!-- doxytag: member="IsisReader::open" ref="afa6e3d3d94854913e5ed2604919d2316" args="($config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::open </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>config</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a database.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$config</em> </td><td>Config file or array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a630791a319bec2bc55d0102cbb7f93df"></a><!-- doxytag: member="IsisReader::read" ref="a630791a319bec2bc55d0102cbb7f93df" args="($entry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::read </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>entry</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Alias to $isis->db-><a class="el" href="classIsisReader.html#a630791a319bec2bc55d0102cbb7f93df">read()</a>.</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>Row number.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Resulting data. </dd></dl>
</div>
</div>
<a class="anchor" id="a99ce7b10b2997dad6a64558ac1f9f10e"></a><!-- doxytag: member="IsisReader::removeBrackets" ref="a99ce7b10b2997dad6a64558ac1f9f10e" args="($value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::removeBrackets </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove brackets from strings whithin an array.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$value</em> </td><td>Array with bracketed strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a60ece3bbe11a2b4ac6afa6e65f282724"></a><!-- doxytag: member="IsisReader::removeBracketsFromArray" ref="a60ece3bbe11a2b4ac6afa6e65f282724" args="(&$values)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisReader::removeBracketsFromArray </td>
<td>(</td>
<td class="paramtype">&$ </td>
<td class="paramname"> <em>values</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove brackets from strings whithin an array.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&$values</em> </td><td>Array with bracketed strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>classes/IsisReader.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 18:50:27 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>