diff options
| author | Silvio <silvio@devlet.com.br> | 2010-08-20 15:39:56 -0300 |
|---|---|---|
| committer | Silvio <silvio@devlet.com.br> | 2010-08-20 15:39:56 -0300 |
| commit | b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a (patch) | |
| tree | 5fd92d1ec675d64bf1a79e8f246a99c2e47f8e2b /doc/html/classMaleteDb.html | |
| parent | 298ac8892db90e518da71540c8fab72f885d66ff (diff) | |
| download | cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.gz cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.bz2 | |
Adding generated docs
Diffstat (limited to 'doc/html/classMaleteDb.html')
| -rw-r--r-- | doc/html/classMaleteDb.html | 329 |
1 files changed, 329 insertions, 0 deletions
diff --git a/doc/html/classMaleteDb.html b/doc/html/classMaleteDb.html new file mode 100644 index 0000000..eed9039 --- /dev/null +++ b/doc/html/classMaleteDb.html @@ -0,0 +1,329 @@ +<!-- 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: MaleteDb 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>MaleteDb Class Reference</h1><!-- doxytag: class="MaleteDb" --><!-- doxytag: inherits="IsisDb" --><div class="dynheader"> +Inheritance diagram for MaleteDb:</div> +<div class="dynsection"> + <div class="center"> + <img src="classMaleteDb.png" usemap="#MaleteDb_map" alt=""/> + <map id="MaleteDb_map" name="MaleteDb_map"> +<area href="interfaceIsisDb.html" alt="IsisDb" shape="rect" coords="0,0,66,24"/> +</map> + </div> +</div> + +<p><a href="classMaleteDb-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="classMaleteDb.html#a60f87371bc1ec156b010e5b38b4c22e2">__construct</a> ($schema)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#ad2a65876db24adc388afce465e0c153e">read</a> ($id)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#a5c6cb09a072e5d2ddce31c77098ccba4">entries</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#a4f16c48facae498d0db1a042e9727d04">example</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#ab2da32d84af17df79d947ae32257b4ec">check</a> ($schema, $section=NULL)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#ac87c3ac1b3d9a6297be8574aa303e033">tag</a> ($results)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#a17562c1c53594762454d65be823fcdb5">logger</a> ($message)</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="classMaleteDb.html#af2cd60ce81381edc3ca09a6812cf79fd">$fdt</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#a4b970df3631d2763f001c96ee417f27a">$db</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#a833fed4faae9537306053ee966c06197">$format</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMaleteDb.html#ae1c8cefd1a6e661fb03c214f47336368">$log</a></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Malete implementation of <a class="el" href="interfaceIsisDb.html">IsisDb</a>.</p> +<dl class="warning"><dt><b>Warning:</b></dt><dd>This implementation is currently outdated and lacks basic functionalities such as subfield handling and therefore it's use is not recommended. </dd></dl> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a60f87371bc1ec156b010e5b38b4c22e2"></a><!-- doxytag: member="MaleteDb::__construct" ref="a60f87371bc1ec156b010e5b38b4c22e2" args="($schema)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::__construct </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>schema</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Constructor.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#ae1c0a3496d55f710d34c5c19ada7a66b">IsisDb::__construct()</a> </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#ae1c0a3496d55f710d34c5c19ada7a66b">IsisDb</a>.</p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ab2da32d84af17df79d947ae32257b4ec"></a><!-- doxytag: member="MaleteDb::check" ref="ab2da32d84af17df79d947ae32257b4ec" args="($schema, $section=NULL)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::check </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>schema</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>section</em> = <code>NULL</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Check configuration.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#af681b8f990b579f1835aa7ba4c83f1b8">IsisDb::check()</a> </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#af681b8f990b579f1835aa7ba4c83f1b8">IsisDb</a>.</p> + +</div> +</div> +<a class="anchor" id="a5c6cb09a072e5d2ddce31c77098ccba4"></a><!-- doxytag: member="MaleteDb::entries" ref="a5c6cb09a072e5d2ddce31c77098ccba4" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::entries </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return number of entries in the database.</p> +<p>The Malete API doen't implement such feature so we have to emulate it by iterating over all entries until <a class="el" href="classMaleteDb.html#ad2a65876db24adc388afce465e0c153e">MaleteDb::read()</a> returns FALSE.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#a86f38eca2b6d0835b60770d8a4e511ff">IsisDb::entries()</a> </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#a86f38eca2b6d0835b60770d8a4e511ff">IsisDb</a>.</p> + +</div> +</div> +<a class="anchor" id="a4f16c48facae498d0db1a042e9727d04"></a><!-- doxytag: member="MaleteDb::example" ref="a4f16c48facae498d0db1a042e9727d04" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::example </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return an example schema.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#a857c10d90da64067efa17afb2f32edb6">IsisDb::example()</a> </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#a857c10d90da64067efa17afb2f32edb6">IsisDb</a>.</p> + +</div> +</div> +<a class="anchor" id="a17562c1c53594762454d65be823fcdb5"></a><!-- doxytag: member="MaleteDb::logger" ref="a17562c1c53594762454d65be823fcdb5" args="($message)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::logger </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>message</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Class logger.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$message</em> </td><td>Log message. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ad2a65876db24adc388afce465e0c153e"></a><!-- doxytag: member="MaleteDb::read" ref="ad2a65876db24adc388afce465e0c153e" args="($id)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::read </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>id</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Read an entry.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#a68335ec0db01ef03f0725621b38b5686">IsisDb::read()</a></dd></dl> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Subfield handling. </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#a68335ec0db01ef03f0725621b38b5686">IsisDb</a>.</p> + +</div> +</div> +<a class="anchor" id="ac87c3ac1b3d9a6297be8574aa303e033"></a><!-- doxytag: member="MaleteDb::tag" ref="ac87c3ac1b3d9a6297be8574aa303e033" args="($results)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::tag </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>results</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Tag results of a db query.</p> +<p>This function converts the keys of query result from field numbers to names and and also puts repetition fields into place as Malete deals with field repetition by using a 'tag' property in the resulting query object.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$results</em> </td><td>Database query results.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Tagged database result. </dd></dl> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a4b970df3631d2763f001c96ee417f27a"></a><!-- doxytag: member="MaleteDb::$db" ref="a4b970df3631d2763f001c96ee417f27a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::$db</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Database resource. </p> + +</div> +</div> +<a class="anchor" id="af2cd60ce81381edc3ca09a6812cf79fd"></a><!-- doxytag: member="MaleteDb::$fdt" ref="af2cd60ce81381edc3ca09a6812cf79fd" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::$fdt</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Field description table. </p> + +</div> +</div> +<a class="anchor" id="a833fed4faae9537306053ee966c06197"></a><!-- doxytag: member="MaleteDb::$format" ref="a833fed4faae9537306053ee966c06197" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::$format</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Database format, derived from $schema. </p> + +</div> +</div> +<a class="anchor" id="ae1c8cefd1a6e661fb03c214f47336368"></a><!-- doxytag: member="MaleteDb::$log" ref="ae1c8cefd1a6e661fb03c214f47336368" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MaleteDb::$log</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Class action log. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>classes/backends/MaleteDb.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 15:38:20 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> |