diff options
Diffstat (limited to 'doc/html/classSchemaDb.html')
| -rw-r--r-- | doc/html/classSchemaDb.html | 168 |
1 files changed, 168 insertions, 0 deletions
diff --git a/doc/html/classSchemaDb.html b/doc/html/classSchemaDb.html new file mode 100644 index 0000000..a2b55a1 --- /dev/null +++ b/doc/html/classSchemaDb.html @@ -0,0 +1,168 @@ +<!-- 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: SchemaDb 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>SchemaDb Class Reference</h1><!-- doxytag: class="SchemaDb" --> +<p><a href="classSchemaDb-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="classSchemaDb.html#af5c9271759bed2f9cccc80a05f7c5da8">optional</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSchemaDb.html#a923a94169459c4dee3f74000b4aa1807">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classSchemaDb.html#a31db21bccb179162b5bb02b14b72d3e3">required</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSchemaDb.html#a42acc85b08a20b121204b1caf3a83e61">check</a> ($schema, $section=NULL)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p><a class="el" href="classSchemaDb.html">SchemaDb</a> class with standard database procedures and configuration. </p> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a42acc85b08a20b121204b1caf3a83e61"></a><!-- doxytag: member="SchemaDb::check" ref="a42acc85b08a20b121204b1caf3a83e61" args="($schema, $section=NULL)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static SchemaDb::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><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Recursively check for required fields in a database schema.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#af681b8f990b579f1835aa7ba4c83f1b8">IsisDb::check()</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="a923a94169459c4dee3f74000b4aa1807"></a><!-- doxytag: member="SchemaDb::example" ref="a923a94169459c4dee3f74000b4aa1807" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SchemaDb::example </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return an example database schema.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#a857c10d90da64067efa17afb2f32edb6">IsisDb::example()</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="af5c9271759bed2f9cccc80a05f7c5da8"></a><!-- doxytag: member="SchemaDb::optional" ref="af5c9271759bed2f9cccc80a05f7c5da8" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SchemaDb::optional </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return the optional database config.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Array with optional config. </dd></dl> + +</div> +</div> +<a class="anchor" id="a31db21bccb179162b5bb02b14b72d3e3"></a><!-- doxytag: member="SchemaDb::required" ref="a31db21bccb179162b5bb02b14b72d3e3" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static SchemaDb::required </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return the required database config.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Array with required config. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>classes/backends/SchemaDb.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> |