<!-- 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: Cinisis 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>Cinisis Class Reference</h1><!-- doxytag: class="Cinisis" -->
<p><a href="classCinisis-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="classCinisis.html#ab9cb7a94d6a5dfb13d50e83e58a4cc10">__construct</a> ($config=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#ad5ebe493037aad5a2d8a2f6c51fab09f">open</a> ($config)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#a0bd044303b01793f1a59c54040ff0242">load</a> ($file)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#ae8d2f767bfb149031b1ac7077c45c7d6">parse</a> ($config, $class=__CLASS__)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#add6ffac62cffb6ba5e5b0bec552b2cee">yaml</a> ($file)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#ae6f679192f136ba61e85130ccab8e7ef">check</a> ($config)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#a125ecd4426e15e2c27daa16d4aaac3f2">base</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#aac686f5d4862085721eb0de1d6203a57">file</a> ($config=NULL, $section= 'config')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#a0163d3358b31657bd6e91f94aa618918">join_subfields</a> ($format)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#ac470ab9dc1f8c02545708f1c7b820d9e">main_field_name</a> ($format, $key)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#ae8aedec88384439c95da89f423a219c0">$db</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisis.html#ae537c5305e84e86ae7dd305d2cd253fc">$implementation</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classCinisis.html">Cinisis</a> main class. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab9cb7a94d6a5dfb13d50e83e58a4cc10"></a><!-- doxytag: member="Cinisis::__construct" ref="ab9cb7a94d6a5dfb13d50e83e58a4cc10" args="($config=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cinisis::__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>
<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>Optional parameter to set alternative config file or array with configuration. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a125ecd4426e15e2c27daa16d4aaac3f2"></a><!-- doxytag: member="Cinisis::base" ref="a125ecd4426e15e2c27daa16d4aaac3f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Cinisis::base </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get library base folder.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Return base folder. </dd></dl>
</div>
</div>
<a class="anchor" id="ae6f679192f136ba61e85130ccab8e7ef"></a><!-- doxytag: member="Cinisis::check" ref="ae6f679192f136ba61e85130ccab8e7ef" args="($config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Cinisis::check </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>config</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check configuration.</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 with configuration.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with configuration or FALSE on error. </dd></dl>
</div>
</div>
<a class="anchor" id="aac686f5d4862085721eb0de1d6203a57"></a><!-- doxytag: member="Cinisis::file" ref="aac686f5d4862085721eb0de1d6203a57" args="($config=NULL, $section= 'config')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Cinisis::file </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>config</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>section</em> = <code>'config'</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a file path.</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 name (either relative to the library or absolute) or array with configuration.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$section</em> </td><td>Config file section (ignored for absolute files).</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Return the assembled file path. </dd></dl>
</div>
</div>
<a class="anchor" id="a0163d3358b31657bd6e91f94aa618918"></a><!-- doxytag: member="Cinisis::join_subfields" ref="a0163d3358b31657bd6e91f94aa618918" args="($format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Cinisis::join_subfields </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>format</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether to join field and subfields in a single 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>$format</em> </td><td>Database format.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Boolean. </dd></dl>
</div>
</div>
<a class="anchor" id="a0bd044303b01793f1a59c54040ff0242"></a><!-- doxytag: member="Cinisis::load" ref="a0bd044303b01793f1a59c54040ff0242" args="($file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cinisis::load </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>file</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Config file load.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$file</em> </td><td>Config file.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with configuration or FALSE if error. </dd></dl>
</div>
</div>
<a class="anchor" id="ac470ab9dc1f8c02545708f1c7b820d9e"></a><!-- doxytag: member="Cinisis::main_field_name" ref="ac470ab9dc1f8c02545708f1c7b820d9e" args="($format, $key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Cinisis::main_field_name </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine the main field name depending on db configuration.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<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>$format</em> </td><td>Database format.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Main field name, 'field' by default. </dd></dl>
</div>
</div>
<a class="anchor" id="ad5ebe493037aad5a2d8a2f6c51fab09f"></a><!-- doxytag: member="Cinisis::open" ref="ad5ebe493037aad5a2d8a2f6c51fab09f" args="($config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cinisis::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 an ISIS 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>Optional parameter to set alternative config file or array with configuration. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae8d2f767bfb149031b1ac7077c45c7d6"></a><!-- doxytag: member="Cinisis::parse" ref="ae8d2f767bfb149031b1ac7077c45c7d6" args="($config, $class=__CLASS__)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cinisis::parse </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>class</em> = <code>__CLASS__</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse configuration.</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 with configuration.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$class</em> </td><td>Configuration class name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with configuration or FALSE on error. </dd></dl>
</div>
</div>
<a class="anchor" id="add6ffac62cffb6ba5e5b0bec552b2cee"></a><!-- doxytag: member="Cinisis::yaml" ref="add6ffac62cffb6ba5e5b0bec552b2cee" args="($file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Cinisis::yaml </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>file</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load YAML into array using backend libraries.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$file</em> </td><td>Config file.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with configuration or FALSE if error. </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae8aedec88384439c95da89f423a219c0"></a><!-- doxytag: member="Cinisis::$db" ref="ae8aedec88384439c95da89f423a219c0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cinisis::$db</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Database resource. </p>
</div>
</div>
<a class="anchor" id="ae537c5305e84e86ae7dd305d2cd253fc"></a><!-- doxytag: member="Cinisis::$implementation" ref="ae537c5305e84e86ae7dd305d2cd253fc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cinisis::$implementation</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Database implementation. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>classes/Cinisis.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 Thu Sep 16 11:13:07 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>