[PHPVortex-Commit] phpvortex/doc/html/Vortex/Util APP_Base.html,NONE,1.1 _APP_Base_class_php.html,NO
Brought to you by:
nop144666
Menu
▾
▴
[PHPVortex-Commit] phpvortex/doc/html/Vortex/Util APP_Base.html,NONE,1.1 _APP_Base_class_php.html,NONE,1.1
|
From: Thiago R. <nop...@us...> - 2004-11-05 16:19:19
|
Update of /cvsroot/phpvortex/phpvortex/doc/html/Vortex/Util In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27825/doc/html/Vortex/Util Added Files: APP_Base.html _APP_Base_class_php.html Log Message: Updated Documentation --- NEW FILE: _APP_Base_class_php.html --- <?xml version="1.0" encoding="iso-8859-1"?> <!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> <!-- template designed by Marco Von Ballmoos --> <title>Docs for page APP_Base.class.php</title> <link rel="stylesheet" href="../../media/stylesheet.css" /> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> <body> <div class="page-body"> <h2 class="file-name">/APP_Base.class.php</h2> <a name="sec-description"></a> <div class="info-box"> <div class="info-box-title">Description</div> <div class="nav-bar"> <span class="disabled">Description</span> | <a href="#sec-classes">Classes</a> | <a href="#sec-includes">Includes</a> </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">File for class APP_Base.</p> <ul class="tags"> <li><span class="field">filesource:</span> <a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html">Source Code for this file</a></li> <li><span class="field">license:</span> <a href="http://opensource.org/licenses/lgpl-license.php">GNU Lesser General Public License</a></li> <li><span class="field">copyright:</span> Copyright 2004, Thiago Ramon Gonçalves Montoya</li> <li><span class="field">author:</span> Thiago Ramon Gonçalves Montoya</li> </ul> </div> </div> <a name="sec-classes"></a> <div class="info-box"> <div class="info-box-title">Classes</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Classes</span> | <a href="#sec-includes">Includes</a> </div> <div class="info-box-body"> <table cellpadding="2" cellspacing="0" class="class-table"> <tr> <th class="class-table-header">Class</th> <th class="class-table-header">Description</th> </tr> <tr> <td style="padding-right: 2em; vertical-align: top"> <a href="../../Vortex/Util/APP_Base.html">APP_Base</a> </td> <td> Base class for applications. </td> </tr> </table> </div> </div> <a name="sec-includes"></a> <div class="info-box"> <div class="info-box-title">Includes</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-classes">Classes</a> | <span class="disabled">Includes</span> </div> <div class="info-box-body"> <a name="_SEC_Page_class_php"><!-- --></a> <div class="oddrow"> <div> <span class="include-title"> <span class="include-type">require_once</span> (<span class="include-name"><a href="../../Vortex/Page/_SEC_Page_class_php.html">'SEC_Page.class.php'</a></span>) (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a13">13</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Require the header for SEC_Page functionality.</p> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Fri, 5 Nov 2004 14:11:58 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: APP_Base.html --- <?xml version="1.0" encoding="iso-8859-1"?> <!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> <!-- template designed by Marco Von Ballmoos --> <title>Docs For Class APP_Base</title> <link rel="stylesheet" href="../../media/stylesheet.css" /> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> <body> <div class="page-body"> <h2 class="class-name">Class APP_Base</h2> <a name="sec-description"></a> <div class="info-box"> <div class="info-box-title">Description</div> <div class="nav-bar"> <span class="disabled">Description</span> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Base class for applications.</p> <p class="notes"> Located in <a class="field" href="_APP_Base_class_php.html">/APP_Base.class.php</a> (line <span class="field"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a21">21</a></span>) </p> <pre></pre> </div> </div> <a name="sec-var-summary"></a> <div class="info-box"> <div class="info-box-title">Variable Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="var-summary"> <div class="var-title"> <span class="var-type">string</span> <a href="#$connection_class" title="details" class="var-name">$connection_class</a> </div> <div class="var-title"> <span class="var-type">array</span> <a href="#$connection_opts" title="details" class="var-name">$connection_opts</a> </div> <div class="var-title"> <span class="var-type"><a href="../../Vortex/DB/DB_Base.html">DB_Base</a></span> <a href="#$db" title="details" class="var-name">$db</a> </div> <div class="var-title"> <span class="var-type">array</span> <a href="#$layout" title="details" class="var-name">$layout</a> </div> <div class="var-title"> <span class="var-type">array</span> <a href="#$pages" title="details" class="var-name">$pages</a> </div> <div class="var-title"> <span class="var-type">array</span> <a href="#$styles" title="details" class="var-name">$styles</a> </div> <div class="var-title"> <span class="var-type">string</span> <a href="#$title" title="details" class="var-name">$title</a> </div> </div> </div> </div> <a name="sec-method-summary"></a> <div class="info-box"> <div class="info-box-title">Method Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="method-summary"> <div class="method-definition"> <span class="method-result">APP_Base</span> <a href="#APP_Base" title="details" class="method-name">APP_Base</a> ([<span class="var-type">array</span> <span class="var-name">$opts</span> = <span class="var-default">array()</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#Show" title="details" class="method-name">Show</a> (<span class="var-type">string</span> <span class="var-name">$page</span>) </div> </div> </div> </div> <a name="sec-vars"></a> <div class="info-box"> <div class="info-box-title">Variables</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <a name="var$connection_class" id="$connection_class"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$connection_class</span> = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a27">27</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Class of DB connection.</p> </div> <a name="var$connection_opts" id="$connection_opts"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$connection_opts</span> = <span class="var-default">array()</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a33">33</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Parameters to the DB connection.</p> </div> <a name="var$db" id="$db"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type"><a href="../../Vortex/DB/DB_Base.html">DB_Base</a></span> <span class="var-name">$db</span> = <span class="var-default"> NULL</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a39">39</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">DB connection.</p> </div> <a name="var$layout" id="$layout"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$layout</span> = <span class="var-default">array()</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a75">75</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Array with the default layout of the site.</p> <p class="description"><p>The layout is an array containing arrays in the following form: <pre> array( 'name' => 'Section Name', 'class' => 'Section Class', 'opts' => array('Section options') );</pre></p></p> </div> <a name="var$pages" id="$pages"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$pages</span> = <span class="var-default">array()</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a61">61</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Array all the pages of an application.</p> <p class="description"><p>The $pages is an array containing arrays in the following form: <pre> 'page_name' => array( 'class' => 'SEC_* Class', 'opts' => array('Section options'), [ 'title' => 'Page Title', ] [ 'style' => array('Page style sheet',...), ] [ 'layout' => array('page layout (see below)') ] ), ...</pre> If exists, the $db member variable is added to the 'opts' of the page. If 'title' is set, it is used instead of the default title. If 'style' is set, it is used instead of the default styles. If 'layout' is set, it is used instead of the default layout.</p></p> </div> <a name="var$styles" id="$styles"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$styles</span> = <span class="var-default">array()</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a82">82</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Array containing URLs to the default style sheets of the site.</p> </div> <a name="var$title" id="$title"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a89">89</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Default title to site pages.</p> </div> </div> </div> <a name="sec-methods"></a> <div class="info-box"> <div class="info-box-title">Methods</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) </div> <div class="info-box-body"> <A NAME='method_detail'></A> <a name="methodAPP_Base" id="APP_Base"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">Constructor APP_Base</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a96">96</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Constructor: Load all parameters into member variables.</p> <div class="method-signature"> <span class="method-result">APP_Base</span> <span class="method-name"> APP_Base </span> ([<span class="var-type">array</span> <span class="var-name">$opts</span> = <span class="var-default">array()</span>]) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$opts</span><span class="var-description">: Parameters for the object, as 'var' => 'value'.</span> </li> </ul> </div> <a name="methodShow" id="Show"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Show</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_Util_APP_Base.class.php.html#a115">115</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Outputs the page to the client.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> Show </span> (<span class="var-type">string</span> <span class="var-name">$page</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$page</span><span class="var-description">: Page to show.</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Fri, 5 Nov 2004 14:11:59 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> |
