aboutsummaryrefslogtreecommitdiff
path: root/doc/html/interfaceIsisDb.html
diff options
context:
space:
mode:
authorSilvio <silvio@devlet.com.br>2010-08-20 15:39:56 -0300
committerSilvio <silvio@devlet.com.br>2010-08-20 15:39:56 -0300
commitb879f0fcc8651b49ae46a6db64d7eb1a27c7af1a (patch)
tree5fd92d1ec675d64bf1a79e8f246a99c2e47f8e2b /doc/html/interfaceIsisDb.html
parent298ac8892db90e518da71540c8fab72f885d66ff (diff)
downloadcinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.gz
cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.bz2
Adding generated docs
Diffstat (limited to 'doc/html/interfaceIsisDb.html')
-rw-r--r--doc/html/interfaceIsisDb.html234
1 files changed, 234 insertions, 0 deletions
diff --git a/doc/html/interfaceIsisDb.html b/doc/html/interfaceIsisDb.html
new file mode 100644
index 0000000..7317e9e
--- /dev/null
+++ b/doc/html/interfaceIsisDb.html
@@ -0,0 +1,234 @@
+<!-- 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: IsisDb Interface 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&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
+ <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>IsisDb Interface Reference</h1><!-- doxytag: class="IsisDb" --><div class="dynheader">
+Inheritance diagram for IsisDb:</div>
+<div class="dynsection">
+ <div class="center">
+ <img src="interfaceIsisDb.png" usemap="#IsisDb_map" alt=""/>
+ <map id="IsisDb_map" name="IsisDb_map">
+<area href="classBiblioIsisDb.html" alt="BiblioIsisDb" shape="rect" coords="0,56,77,80"/>
+<area href="classMaleteDb.html" alt="MaleteDb" shape="rect" coords="87,56,164,80"/>
+<area href="classPhpIsisDb.html" alt="PhpIsisDb" shape="rect" coords="174,56,251,80"/>
+</map>
+ </div>
+</div>
+
+<p><a href="interfaceIsisDb-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIsisDb.html#ae1c0a3496d55f710d34c5c19ada7a66b">__construct</a> ($schema)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIsisDb.html#a68335ec0db01ef03f0725621b38b5686">read</a> ($id)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIsisDb.html#a86f38eca2b6d0835b60770d8a4e511ff">entries</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIsisDb.html#a857c10d90da64067efa17afb2f32edb6">example</a> ()</td></tr>
+<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIsisDb.html#af681b8f990b579f1835aa7ba4c83f1b8">check</a> ($schema, $section=NULL)</td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Generic interface for reading Isis databases. </p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="ae1c0a3496d55f710d34c5c19ada7a66b"></a><!-- doxytag: member="IsisDb::__construct" ref="ae1c0a3496d55f710d34c5c19ada7a66b" args="($schema)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisDb::__construct </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>schema</em></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Constructor.</p>
+<p>The implementation constructor should accept a database schema definition and setup the appropriate db resource.</p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$schema</em>&nbsp;</td><td>High level database schema description.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Database resource or FALSE in case of error.</dd></dl>
+<dl class="see"><dt><b>See also:</b></dt><dd>default_schema() </dd></dl>
+
+<p>Implemented in <a class="el" href="classBiblioIsisDb.html#ab2c5ec782b324847e104d8ad35a230af">BiblioIsisDb</a>, <a class="el" href="classMaleteDb.html#a60f87371bc1ec156b010e5b38b4c22e2">MaleteDb</a>, and <a class="el" href="classPhpIsisDb.html#abb6db51373d065baf9135fd278653bc5">PhpIsisDb</a>.</p>
+
+</div>
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="af681b8f990b579f1835aa7ba4c83f1b8"></a><!-- doxytag: member="IsisDb::check" ref="af681b8f990b579f1835aa7ba4c83f1b8" args="($schema, $section=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">static IsisDb::check </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>schema</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>section</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td><code> [static]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Configuration check.</p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$schema</em>&nbsp;</td><td>Database schema to check.</td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$section</em>&nbsp;</td><td>Configuration section.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Database schema or FALSE if error. </dd></dl>
+
+<p>Implemented in <a class="el" href="classBiblioIsisDb.html#a929467f1907d3aeaeebe493f0c188c5b">BiblioIsisDb</a>, <a class="el" href="classMaleteDb.html#ab2da32d84af17df79d947ae32257b4ec">MaleteDb</a>, and <a class="el" href="classPhpIsisDb.html#a23761cc04114090a2863467b2accc80a">PhpIsisDb</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a86f38eca2b6d0835b60770d8a4e511ff"></a><!-- doxytag: member="IsisDb::entries" ref="a86f38eca2b6d0835b60770d8a4e511ff" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisDb::entries </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Return number of entries in the database.</p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Number of entries in the database. </dd></dl>
+
+<p>Implemented in <a class="el" href="classBiblioIsisDb.html#ab6b0a977c066c25c6bdca5c1d3a083e8">BiblioIsisDb</a>, <a class="el" href="classMaleteDb.html#a5c6cb09a072e5d2ddce31c77098ccba4">MaleteDb</a>, and <a class="el" href="classPhpIsisDb.html#a0491ce84e5a85e775f811f18e63ef0fb">PhpIsisDb</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a857c10d90da64067efa17afb2f32edb6"></a><!-- doxytag: member="IsisDb::example" ref="a857c10d90da64067efa17afb2f32edb6" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisDb::example </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Return an example database schema.</p>
+<p>The example schema should have all information the implementation needs to be able to open and read a database.</p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Array with a sample database schema. </dd></dl>
+
+<p>Implemented in <a class="el" href="classBiblioIsisDb.html#a8e76b289b9e3a9893b9469094753d2bc">BiblioIsisDb</a>, <a class="el" href="classMaleteDb.html#a4f16c48facae498d0db1a042e9727d04">MaleteDb</a>, and <a class="el" href="classPhpIsisDb.html#a7f4f3a9fd6dab86bd3cb3149d65f92cd">PhpIsisDb</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a68335ec0db01ef03f0725621b38b5686"></a><!-- doxytag: member="IsisDb::read" ref="a68335ec0db01ef03f0725621b38b5686" args="($id)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">IsisDb::read </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>id</em></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Read an entry from the 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>$id</em>&nbsp;</td><td>Database entry id. </td></tr>
+ </table>
+ </dd>
+</dl>
+
+<p>Implemented in <a class="el" href="classMaleteDb.html#ad2a65876db24adc388afce465e0c153e">MaleteDb</a>, and <a class="el" href="classPhpIsisDb.html#af2266931746f6f2335b831be8b8333fb">PhpIsisDb</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this interface was generated from the following file:<ul>
+<li>classes/backends/IsisDb.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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</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&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
+</body>
+</html>