<!-- 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.1 -->
<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#a0f8b918be2f0f1d2c68955b3295034fe">__construct</a> ($config= 'config/config.yaml')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinIsis.html#a831607c2fe9ffac63be8de42e1c9dbae">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#afa9cbac9e165ebed194b24487344d2fb">parse</a> ($config, $type= 'cinisis')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinIsis.html#acd7e7486428fac5a0a85ad46b0486820">check</a> ($config)</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#ada0e16c222436f776f040e0fe1a25184">$db</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinIsis.html#aea1086b32d45308f6875f6ed0a6db2fc">$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="a0f8b918be2f0f1d2c68955b3295034fe"></a><!-- doxytag: member="CinIsis::__construct" ref="a0f8b918be2f0f1d2c68955b3295034fe" args="($config= 'config/config.yaml')" -->
<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>'config/config.yaml'</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="acd7e7486428fac5a0a85ad46b0486820"></a><!-- doxytag: member="CinIsis::check" ref="acd7e7486428fac5a0a85ad46b0486820" args="($config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CinIsis::check </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>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="a831607c2fe9ffac63be8de42e1c9dbae"></a><!-- doxytag: member="CinIsis::load" ref="a831607c2fe9ffac63be8de42e1c9dbae" 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. </dd></dl>
</div>
</div>
<a class="anchor" id="afa9cbac9e165ebed194b24487344d2fb"></a><!-- doxytag: member="CinIsis::parse" ref="afa9cbac9e165ebed194b24487344d2fb" args="($config, $type= 'cinisis')" -->
<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>type</em> = <code>'cinisis'</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>$type</em> </td><td>Configuration type (either 'cinisis' or 'schema').</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with configuration or FALSE on error.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Config and system check. </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ada0e16c222436f776f040e0fe1a25184"></a><!-- doxytag: member="CinIsis::$db" ref="ada0e16c222436f776f040e0fe1a25184" 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="aea1086b32d45308f6875f6ed0a6db2fc"></a><!-- doxytag: member="CinIsis::$implementation" ref="aea1086b32d45308f6875f6ed0a6db2fc" 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 size="1"/><address style="text-align: right;"><small>Generated on Tue Apr 6 12:36:23 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.1 </small></address>
</body>
</html>