[PHPVortex-Commit] phpvortex/doc/html/Vortex/DB FT_List.html,NONE,1.1 FT_ListArray.html,NONE,1.1 _FT
Brought to you by:
nop144666
Menu
▾
▴
[PHPVortex-Commit] phpvortex/doc/html/Vortex/DB FT_List.html,NONE,1.1 FT_ListArray.html,NONE,1.1 _FT_ListArray_class_php.html,NONE,1.1 _FT_List_class_php.html,NONE,1.1
|
From: Thiago R. <nop...@us...> - 2004-11-05 16:19:17
|
Update of /cvsroot/phpvortex/phpvortex/doc/html/Vortex/DB In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27825/doc/html/Vortex/DB Added Files: FT_List.html FT_ListArray.html _FT_ListArray_class_php.html _FT_List_class_php.html Log Message: Updated Documentation --- NEW FILE: FT_ListArray.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 FT_ListArray</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 FT_ListArray</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">Database field, List (<select>) with contents in a array.</p> <p class="notes"> Located in <a class="field" href="_FT_ListArray_class_php.html">/FT_ListArray.class.php</a> (line <span class="field"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a21">21</a></span>) </p> <pre><a href="../../Vortex/DB/FT_Base.html">FT_Base</a> | --FT_ListArray</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="#$default" title="details" class="var-name">$default</a> </div> <div class="var-title"> <span class="var-type">array</span> <a href="#$list_array" title="details" class="var-name">$list_array</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">string</span> <a href="#ConsistFormat" title="details" class="method-name">ConsistFormat</a> (<span class="var-type">string</span> <span class="var-name">&$field</span>) </div> <div class="method-definition"> <span class="method-result">bool</span> <a href="#ConsistTest" title="details" class="method-name">ConsistTest</a> (<span class="var-type">string</span> <span class="var-name">&$field</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#JSConsist" title="details" class="method-name">JSConsist</a> () </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#ShowForm" title="details" class="method-name">ShowForm</a> (<span class="var-type">string</span> <span class="var-name">$value</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#ShowPlain" title="details" class="method-name">ShowPlain</a> (<span class="var-type">string</span> <span class="var-name">$value</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$default" id="$default"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$default</span> = <span class="var-default"> '-1'</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a28">28</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Default value of the field.</p> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#var$default">FT_Base::$default</a></dt> <dd>Default value of the field.</dd> </dl> </div> <a name="var$list_array" id="$list_array"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$list_array</span> = <span class="var-default">array()</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a37">37</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Array to get the list from.</p> <p class="description"><p>List itens as 'key' => 'label'</p></p> </div> <h4>Inherited Variables</h4> <A NAME='inherited_vars'><!-- --></A> <p>Inherited from <span class="classname"><a href="../../Vortex/DB/FT_Base.html">FT_Base</a></span></p> <blockquote> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$db">FT_Base::$db</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$label">FT_Base::$label</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$name">FT_Base::$name</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$name_db">FT_Base::$name_db</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$name_form">FT_Base::$name_form</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$pkey">FT_Base::$pkey</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$required">FT_Base::$required</a></span><br> </span> </blockquote> </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="methodConsistFormat" id="ConsistFormat"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">ConsistFormat</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a95">95</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Format the field for database insertion.</p> <ul class="tags"> <li><span class="field">return:</span> Returns the formated field.</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> ConsistFormat </span> (<span class="var-type">string</span> <span class="var-name">&$field</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The data from the field to be formated.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodConsistFormat">FT_Base::ConsistFormat()</a></dt> <dd>Format the field for database insertion.</dd> </dl> </div> <a name="methodConsistTest" id="ConsistTest"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">ConsistTest</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a83">83</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Test the field consistency.</p> <ul class="tags"> <li><span class="field">return:</span> Returns TRUE if the field is consistent, FALSE otherwise.</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> ConsistTest </span> (<span class="var-type">string</span> <span class="var-name">&$field</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The data from the field to be tested.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodConsistTest">FT_Base::ConsistTest()</a></dt> <dd>Test the field consistency.</dd> </dl> </div> <a name="methodJSConsist" id="JSConsist"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">JSConsist</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a69">69</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Output the field consistency testing in JavaScript.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> JSConsist </span> () </div> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodJSConsist">FT_Base::JSConsist()</a></dt> <dd>Output the field consistency testing in JavaScript.</dd> </dl> </div> <a name="methodShowForm" id="ShowForm"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">ShowForm</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a44">44</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Output the field as a HTML Form.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> ShowForm </span> (<span class="var-type">string</span> <span class="var-name">$value</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$value</span><span class="var-description">: Value to load the control with.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodShowForm">FT_Base::ShowForm()</a></dt> <dd>Output the field as a HTML Form.</dd> </dl> </div> <a name="methodShowPlain" id="ShowPlain"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">ShowPlain</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a61">61</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Output the field as plain text.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> ShowPlain </span> (<span class="var-type">string</span> <span class="var-name">$value</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$value</span><span class="var-description">: Value to load the control with.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodShowPlain">FT_Base::ShowPlain()</a></dt> <dd>Output the field as plain text.</dd> </dl> </div> <h4>Inherited Methods</h4> <a name='inherited_methods'><!-- --></a> <!-- =========== Summary =========== --> <p>Inherited From <span class="classname"><a href="../../Vortex/DB/FT_Base.html">FT_Base</a></span></p> <blockquote> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodFT_Base">FT_Base::FT_Base()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodConsist">FT_Base::Consist()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodConsistFormat">FT_Base::ConsistFormat()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodConsistTest">FT_Base::ConsistTest()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodJSConsist">FT_Base::JSConsist()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodShow">FT_Base::Show()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodShowForm">FT_Base::ShowForm()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodShowPlain">FT_Base::ShowPlain()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodWhere">FT_Base::Where()</a></span><br> </blockquote> </div> </div> <p class="notes" id="credit"> Documentation generated on Fri, 5 Nov 2004 14:12:08 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: _FT_List_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 FT_List.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">/FT_List.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 FT_List.</p> <ul class="tags"> <li><span class="field">filesource:</span> <a href="../..//__filesource/fsource_Vortex_DB_FT_List.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/DB/FT_List.html">FT_List</a> </td> <td> Database field, List (<select>) with contents in a table. </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="_FT_Base_class_php"><!-- --></a> <div class="evenrow"> <div> <span class="include-title"> <span class="include-type">require_once</span> (<span class="include-name"><a href="../../Vortex/DB/_FT_Base_class_php.html">'FT_Base.class.php'</a></span>) (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a13">13</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Require the base class</p> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Fri, 5 Nov 2004 14:12:06 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: _FT_ListArray_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 FT_ListArray.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">/FT_ListArray.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 FT_ListArray.</p> <ul class="tags"> <li><span class="field">filesource:</span> <a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.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/DB/FT_ListArray.html">FT_ListArray</a> </td> <td> Database field, List (<select>) with contents in a array. </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="_FT_Base_class_php"><!-- --></a> <div class="evenrow"> <div> <span class="include-title"> <span class="include-type">require_once</span> (<span class="include-name"><a href="../../Vortex/DB/_FT_Base_class_php.html">'FT_Base.class.php'</a></span>) (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_ListArray.class.php.html#a13">13</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Require the base class</p> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Fri, 5 Nov 2004 14:12:07 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: FT_List.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 FT_List</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 FT_List</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">Database field, List (<select>) with contents in a table.</p> <p class="notes"> Located in <a class="field" href="_FT_List_class_php.html">/FT_List.class.php</a> (line <span class="field"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a21">21</a></span>) </p> <pre><a href="../../Vortex/DB/FT_Base.html">FT_Base</a> | --FT_List</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="#$default" title="details" class="var-name">$default</a> </div> <div class="var-title"> <span class="var-type">string</span> <a href="#$rel_key" title="details" class="var-name">$rel_key</a> </div> <div class="var-title"> <span class="var-type">string</span> <a href="#$rel_label" title="details" class="var-name">$rel_label</a> </div> <div class="var-title"> <span class="var-type">string</span> <a href="#$rel_order" title="details" class="var-name">$rel_order</a> </div> <div class="var-title"> <span class="var-type">string</span> <a href="#$rel_table" title="details" class="var-name">$rel_table</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">FT_List</span> <a href="#FT_List" title="details" class="method-name">FT_List</a> (<span class="var-type"><a href="../../Vortex/DB/DB_Base.html">DB_Base</a></span> <span class="var-name">&$db</span>, [<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">string</span> <a href="#ConsistFormat" title="details" class="method-name">ConsistFormat</a> (<span class="var-type">string</span> <span class="var-name">&$field</span>) </div> <div class="method-definition"> <span class="method-result">bool</span> <a href="#ConsistTest" title="details" class="method-name">ConsistTest</a> (<span class="var-type">string</span> <span class="var-name">&$field</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#JSConsist" title="details" class="method-name">JSConsist</a> () </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#ShowForm" title="details" class="method-name">ShowForm</a> (<span class="var-type">string</span> <span class="var-name">$value</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#ShowPlain" title="details" class="method-name">ShowPlain</a> (<span class="var-type">string</span> <span class="var-name">$value</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$default" id="$default"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$default</span> = <span class="var-default"> '-1'</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a28">28</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Default value of the field.</p> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#var$default">FT_Base::$default</a></dt> <dd>Default value of the field.</dd> </dl> </div> <a name="var$rel_key" id="$rel_key"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$rel_key</span> = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a42">42</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Field to use as key in the table.</p> </div> <a name="var$rel_label" id="$rel_label"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$rel_label</span> = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a49">49</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Field to use as label in the table.</p> </div> <a name="var$rel_order" id="$rel_order"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$rel_order</span> = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a58">58</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Field to order by in the table.</p> <p class="description"><p>Default: <a href="../../Vortex/DB/FT_List.html#var$rel_label">$rel_label</a></p></p> </div> <a name="var$rel_table" id="$rel_table"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$rel_table</span> = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a35">35</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Table to get the list from.</p> </div> <h4>Inherited Variables</h4> <A NAME='inherited_vars'><!-- --></A> <p>Inherited from <span class="classname"><a href="../../Vortex/DB/FT_Base.html">FT_Base</a></span></p> <blockquote> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$db">FT_Base::$db</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$label">FT_Base::$label</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$name">FT_Base::$name</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$name_db">FT_Base::$name_db</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$name_form">FT_Base::$name_form</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$pkey">FT_Base::$pkey</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/FT_Base.html#var$required">FT_Base::$required</a></span><br> </span> </blockquote> </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="methodFT_List" id="FT_List"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Constructor FT_List</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a66">66</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">FT_List</span> <span class="method-name"> FT_List </span> (<span class="var-type"><a href="../../Vortex/DB/DB_Base.html">DB_Base</a></span> <span class="var-name">&$db</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"><a href="../../Vortex/DB/DB_Base.html">DB_Base</a></span> <span class="var-name">$db</span><span class="var-description">: Database where the field is.</span> </li> <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="methodConsistFormat" id="ConsistFormat"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">ConsistFormat</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a139">139</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Format the field for database insertion.</p> <ul class="tags"> <li><span class="field">return:</span> Returns the formated field.</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> ConsistFormat </span> (<span class="var-type">string</span> <span class="var-name">&$field</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The data from the field to be formated.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodConsistFormat">FT_Base::ConsistFormat()</a></dt> <dd>Format the field for database insertion.</dd> </dl> </div> <a name="methodConsistTest" id="ConsistTest"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">ConsistTest</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a127">127</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Test the field consistency.</p> <ul class="tags"> <li><span class="field">return:</span> Returns TRUE if the field is consistent, FALSE otherwise.</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> ConsistTest </span> (<span class="var-type">string</span> <span class="var-name">&$field</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The data from the field to be tested.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodConsistTest">FT_Base::ConsistTest()</a></dt> <dd>Test the field consistency.</dd> </dl> </div> <a name="methodJSConsist" id="JSConsist"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">JSConsist</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a113">113</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Output the field consistency testing in JavaScript.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> JSConsist </span> () </div> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodJSConsist">FT_Base::JSConsist()</a></dt> <dd>Output the field consistency testing in JavaScript.</dd> </dl> </div> <a name="methodShowForm" id="ShowForm"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">ShowForm</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a77">77</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Output the field as a HTML Form.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> ShowForm </span> (<span class="var-type">string</span> <span class="var-name">$value</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$value</span><span class="var-description">: Value to load the control with.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodShowForm">FT_Base::ShowForm()</a></dt> <dd>Output the field as a HTML Form.</dd> </dl> </div> <a name="methodShowPlain" id="ShowPlain"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">ShowPlain</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_List.class.php.html#a99">99</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Output the field as plain text.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> ShowPlain </span> (<span class="var-type">string</span> <span class="var-name">$value</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$value</span><span class="var-description">: Value to load the control with.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/FT_Base.html#methodShowPlain">FT_Base::ShowPlain()</a></dt> <dd>Output the field as plain text.</dd> </dl> </div> <h4>Inherited Methods</h4> <a name='inherited_methods'><!-- --></a> <!-- =========== Summary =========== --> <p>Inherited From <span class="classname"><a href="../../Vortex/DB/FT_Base.html">FT_Base</a></span></p> <blockquote> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodFT_Base">FT_Base::FT_Base()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodConsist">FT_Base::Consist()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodConsistFormat">FT_Base::ConsistFormat()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodConsistTest">FT_Base::ConsistTest()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodJSConsist">FT_Base::JSConsist()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodShow">FT_Base::Show()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodShowForm">FT_Base::ShowForm()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodShowPlain">FT_Base::ShowPlain()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/FT_Base.html#methodWhere">FT_Base::Where()</a></span><br> </blockquote> </div> </div> <p class="notes" id="credit"> Documentation generated on Fri, 5 Nov 2004 14:12:07 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> |
