diff options
Diffstat (limited to 'doc/html/classCinisisDb.html')
| -rw-r--r-- | doc/html/classCinisisDb.html | 375 |
1 files changed, 375 insertions, 0 deletions
diff --git a/doc/html/classCinisisDb.html b/doc/html/classCinisisDb.html new file mode 100644 index 0000000..3f17635 --- /dev/null +++ b/doc/html/classCinisisDb.html @@ -0,0 +1,375 @@ +<!-- 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: CinisisDb 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>CinisisDb Class Reference</h1><!-- doxytag: class="CinisisDb" --> +<p><a href="classCinisisDb-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="classCinisisDb.html#a0693dfb4a5bb8b039f3c7e7848dc1861">__construct</a> ($config=NULL)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisisDb.html#ab6fe06865770b4ade264116627cab487">open</a> ($config)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisisDb.html#a517ae044290df8ccea6b04ad91d19a7f">load</a> ($file)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisisDb.html#a5b0ec2897d714c79c673d5950dde8e14">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="classCinisisDb.html#ad1691843692ee6e9461e5bcb692263c8">check</a> ($config)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisisDb.html#ab44fe0ebdf6a954bc02d50bc7bcc3464">base</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisisDb.html#ac44f1e510c52d21090aab8b903c6ddf5">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="classCinisisDb.html#a18c5fa49b8683ed0e80cdf72d360d50a">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="classCinisisDb.html#a5f0fe8ae1b21721f759bde7fc260a283">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="classCinisisDb.html#af5032dd536f8b50a71871dd35c8be175">$db</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCinisisDb.html#af236be4b737a41fff5e97cf4471f1c00">$implementation</a></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p><a class="el" href="classCinisisDb.html">CinisisDb</a> main class. </p> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a0693dfb4a5bb8b039f3c7e7848dc1861"></a><!-- doxytag: member="CinisisDb::__construct" ref="a0693dfb4a5bb8b039f3c7e7848dc1861" args="($config=NULL)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">CinisisDb::__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="ab44fe0ebdf6a954bc02d50bc7bcc3464"></a><!-- doxytag: member="CinisisDb::base" ref="ab44fe0ebdf6a954bc02d50bc7bcc3464" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static CinisisDb::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="ad1691843692ee6e9461e5bcb692263c8"></a><!-- doxytag: member="CinisisDb::check" ref="ad1691843692ee6e9461e5bcb692263c8" args="($config)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static CinisisDb::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="ac44f1e510c52d21090aab8b903c6ddf5"></a><!-- doxytag: member="CinisisDb::file" ref="ac44f1e510c52d21090aab8b903c6ddf5" args="($config=NULL, $section= 'config')" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static CinisisDb::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="a18c5fa49b8683ed0e80cdf72d360d50a"></a><!-- doxytag: member="CinisisDb::join_subfields" ref="a18c5fa49b8683ed0e80cdf72d360d50a" args="($format)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static CinisisDb::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="a517ae044290df8ccea6b04ad91d19a7f"></a><!-- doxytag: member="CinisisDb::load" ref="a517ae044290df8ccea6b04ad91d19a7f" args="($file)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">CinisisDb::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="a5f0fe8ae1b21721f759bde7fc260a283"></a><!-- doxytag: member="CinisisDb::main_field_name" ref="a5f0fe8ae1b21721f759bde7fc260a283" args="($format, $key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static CinisisDb::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="ab6fe06865770b4ade264116627cab487"></a><!-- doxytag: member="CinisisDb::open" ref="ab6fe06865770b4ade264116627cab487" args="($config)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">CinisisDb::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="a5b0ec2897d714c79c673d5950dde8e14"></a><!-- doxytag: member="CinisisDb::parse" ref="a5b0ec2897d714c79c673d5950dde8e14" args="($config, $class=__CLASS__)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">CinisisDb::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> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="af5032dd536f8b50a71871dd35c8be175"></a><!-- doxytag: member="CinisisDb::$db" ref="af5032dd536f8b50a71871dd35c8be175" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">CinisisDb::$db</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Database resource. </p> + +</div> +</div> +<a class="anchor" id="af236be4b737a41fff5e97cf4471f1c00"></a><!-- doxytag: member="CinisisDb::$implementation" ref="af236be4b737a41fff5e97cf4471f1c00" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">CinisisDb::$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/CinisisDb.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 Wed Aug 4 14:38:54 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> |