[PHPVortex-Commit] phpvortex/doc/html/Vortex/DB DB_Base.html,NONE,1.1 DB_MySQL.html,NONE,1.1 FT_Base
Brought to you by:
nop144666
Menu
▾
▴
[PHPVortex-Commit] phpvortex/doc/html/Vortex/DB DB_Base.html,NONE,1.1 DB_MySQL.html,NONE,1.1 FT_Base.html,NONE,1.1 FT_Text.html,NONE,1.1 RS_Base.html,NONE,1.1 RS_MySQL.html,NONE,1.1 TB_Base.html,NONE,1.1 _DB_Base_class_php.html,NONE,1.1 _DB_MySQL_class_php.html,NONE,1.1 _FT_Base_class_php.html,NONE,1.1 _FT_Text_class_php.html,NONE,1.1 _RS_Base_class_php.html,NONE,1.1 _RS_MySQL_class_php.html,NONE,1.1 _TB_Base_class_php.html,NONE,1.1
|
From: Thiago R. <nop...@us...> - 2004-09-30 13:37:37
|
Update of /cvsroot/phpvortex/phpvortex/doc/html/Vortex/DB In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv30714/doc/html/Vortex/DB Added Files: DB_Base.html DB_MySQL.html FT_Base.html FT_Text.html RS_Base.html RS_MySQL.html TB_Base.html _DB_Base_class_php.html _DB_MySQL_class_php.html _FT_Base_class_php.html _FT_Text_class_php.html _RS_Base_class_php.html _RS_MySQL_class_php.html _TB_Base_class_php.html Log Message: Added the documentation to the CVS --- NEW FILE: RS_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 RS_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 RS_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-descendents">Descendents</a> | <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 RecordSets.</p> <p class="notes"> Located in <a class="field" href="_RS_Base_class_php.html">/RS_Base.class.php</a> (line <span class="field"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a34">34</a></span>) </p> <pre></pre> </div> </div> <a name="sec-descendents"></a> <div class="info-box"> <div class="info-box-title">Direct descendents</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Descendents</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"> <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"><a href="../../Vortex/DB/RS_MySQL.html">RS_MySQL</a></td> <td> Class for MySQL RecordSets. </td> </tr> </table> </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> | <a href="#sec-descendents">Descendents</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"><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">mixed</span> <a href="#$result" title="details" class="var-name">$result</a> </div> <div class="var-title"> <span class="var-type">int</span> <a href="#$row" title="details" class="var-name">$row</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-descendents">Descendents</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">RS_Base</span> <a href="#RS_Base" title="details" class="method-name">RS_Base</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">mixed</span> <span class="var-name">$result</span>) </div> <div class="method-definition"> <span class="method-result">array</span> <a href="#All" title="details" class="method-name">All</a> ([<span class="var-type">int</span> <span class="var-name">$type</span> = <span class="var-default">RS_ROW_ASSOC</span>]) </div> <div class="method-definition"> <span class="method-result">bool</span> <a href="#Close" title="details" class="method-name">Close</a> () </div> <div class="method-definition"> <span class="method-result">string</span> <a href="#Error" title="details" class="method-name">Error</a> () </div> <div class="method-definition"> <span class="method-result">int</span> <a href="#LastId" title="details" class="method-name">LastId</a> () </div> <div class="method-definition"> <span class="method-result">array</span> <a href="#Row" title="details" class="method-name">Row</a> ([<span class="var-type">int</span> <span class="var-name">$row</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$type</span> = <span class="var-default">RS_ROW_ASSOC</span>]) </div> <div class="method-definition"> <span class="method-result">int</span> <a href="#RowCount" title="details" class="method-name">RowCount</a> () </div> <div class="method-definition"> <span class="method-result">bool</span> <a href="#SetRow" title="details" class="method-name">SetRow</a> (<span class="var-type">int</span> <span class="var-name">$row</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-descendents">Descendents</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$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> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a40">40</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Database.</p> </div> <a name="var$result" id="$result"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">mixed</span> <span class="var-name">$result</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a46">46</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Result from query.</p> </div> <a name="var$row" id="$row"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">int</span> <span class="var-name">$row</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a52">52</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Current row.</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-descendents">Descendents</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="methodRS_Base" id="RS_Base"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">Constructor RS_Base</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a60">60</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Constructor: Init the RecordSet from the result of a query.</p> <div class="method-signature"> <span class="method-result">RS_Base</span> <span class="method-name"> RS_Base </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">mixed</span> <span class="var-name">$result</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.</span> </li> <li> <span class="var-type">mixed</span> <span class="var-name">$result</span><span class="var-description">: Result from query.</span> </li> </ul> </div> <a name="methodAll" id="All"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">All</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a109">109</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get all rows from the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns all the rows from the RecordSet.</li> <li><span class="field">abstract:</span> </li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> All </span> ([<span class="var-type">int</span> <span class="var-name">$type</span> = <span class="var-default">RS_ROW_ASSOC</span>]) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$type</span><span class="var-description">: Type of array to return (RS_ROW_NUM | RS_ROW_ASSOC | RS_ROW_BOTH).</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefined in descendants as:</div> <ul class="redefinitions"> <li> <a href="../../Vortex/DB/RS_MySQL.html#methodAll">RS_MySQL::All()</a> : Get all rows from the RecordSet. </li> </ul> </div> <a name="methodClose" id="Close"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">Close</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a140">140</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Close the RecordSet and free the memory.</p> <ul class="tags"> <li><span class="field">return:</span> Returns TRUE if the RecordSet was closed, FALSE if it failed.</li> <li><span class="field">abstract:</span> </li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> Close </span> () </div> <hr class="separator" /> <div class="notes">Redefined in descendants as:</div> <ul class="redefinitions"> <li> <a href="../../Vortex/DB/RS_MySQL.html#methodClose">RS_MySQL::Close()</a> : Close the RecordSet and free the memory. </li> </ul> </div> <a name="methodError" id="Error"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Error</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a129">129</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get the last error message from the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns a string describing the last error that occurred in the RecordSet.</li> <li><span class="field">abstract:</span> </li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> Error </span> () </div> <hr class="separator" /> <div class="notes">Redefined in descendants as:</div> <ul class="redefinitions"> <li> <a href="../../Vortex/DB/RS_MySQL.html#methodError">RS_MySQL::Error()</a> : Get the last error message from the RecordSet. </li> </ul> </div> <a name="methodLastId" id="LastId"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">LastId</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a119">119</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get the last auto-generated ID from the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns the last auto-generated ID from the RecordSet.</li> <li><span class="field">abstract:</span> </li> </ul> <div class="method-signature"> <span class="method-result">int</span> <span class="method-name"> LastId </span> () </div> <hr class="separator" /> <div class="notes">Redefined in descendants as:</div> <ul class="redefinitions"> <li> <a href="../../Vortex/DB/RS_MySQL.html#methodLastId">RS_MySQL::LastId()</a> : Get the last auto-generated ID from the RecordSet. </li> </ul> </div> <a name="methodRow" id="Row"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Row</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a87">87</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get a row from the RecordSet.</p> <p class="description"><p>Case $row is set, return that row, case else, return the next row.</p></p> <ul class="tags"> <li><span class="field">return:</span> Returns the row from the RecordSet, or FALSE if EOF.</li> <li><span class="field">abstract:</span> </li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> Row </span> ([<span class="var-type">int</span> <span class="var-name">$row</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$type</span> = <span class="var-default">RS_ROW_ASSOC</span>]) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$row</span><span class="var-description">: Row to return, defaults to next.</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$type</span><span class="var-description">: Type of array to return (RS_ROW_NUM | RS_ROW_ASSOC | RS_ROW_BOTH).</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefined in descendants as:</div> <ul class="redefinitions"> <li> <a href="../../Vortex/DB/RS_MySQL.html#methodRow">RS_MySQL::Row()</a> : Get a row from the RecordSet. </li> </ul> </div> <a name="methodRowCount" id="RowCount"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">RowCount</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a73">73</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get the count of rows in the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns the number of rows in the RecordSet.</li> <li><span class="field">abstract:</span> </li> </ul> <div class="method-signature"> <span class="method-result">int</span> <span class="method-name"> RowCount </span> () </div> <hr class="separator" /> <div class="notes">Redefined in descendants as:</div> <ul class="redefinitions"> <li> <a href="../../Vortex/DB/RS_MySQL.html#methodRowCount">RS_MySQL::RowCount()</a> : Get the count of rows in the RecordSet. </li> </ul> </div> <a name="methodSetRow" id="SetRow"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">SetRow</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_Base.class.php.html#a98">98</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Go to a row int the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns TRUE on success, FALSE if failed.</li> <li><span class="field">abstract:</span> </li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> SetRow </span> (<span class="var-type">int</span> <span class="var-name">$row</span>) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$row</span><span class="var-description">: Row to go to.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefined in descendants as:</div> <ul class="redefinitions"> <li> <a href="../../Vortex/DB/RS_MySQL.html#methodSetRow">RS_MySQL::SetRow()</a> : Go to a row int the RecordSet. </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 30 Sep 2004 10:35:40 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: RS_MySQL.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 RS_MySQL</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 RS_MySQL</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-vars">Vars</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">Class for MySQL RecordSets.</p> <p class="notes"> Located in <a class="field" href="_RS_MySQL_class_php.html">/RS_MySQL.class.php</a> (line <span class="field"><a href="../..//__filesource/fsource_Vortex_DB_RS_MySQL.class.php.html#a21">21</a></span>) </p> <pre><a href="../../Vortex/DB/RS_Base.html">RS_Base</a> | --RS_MySQL</pre> </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-vars">Vars</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">array</span> <a href="#All" title="details" class="method-name">All</a> ([<span class="var-type">int</span> <span class="var-name">$type</span> = <span class="var-default">RS_ROW_ASSOC</span>]) </div> <div class="method-definition"> <span class="method-result">bool</span> <a href="#Close" title="details" class="method-name">Close</a> () </div> <div class="method-definition"> <span class="method-result">string</span> <a href="#Error" title="details" class="method-name">Error</a> () </div> <div class="method-definition"> <span class="method-result">int</span> <a href="#LastId" title="details" class="method-name">LastId</a> () </div> <div class="method-definition"> <span class="method-result">array</span> <a href="#Row" title="details" class="method-name">Row</a> ([<span class="var-type">int</span> <span class="var-name">$row</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$type</span> = <span class="var-default">RS_ROW_ASSOC</span>]) </div> <div class="method-definition"> <span class="method-result">int</span> <a href="#RowCount" title="details" class="method-name">RowCount</a> () </div> <div class="method-definition"> <span class="method-result">bool</span> <a href="#SetRow" title="details" class="method-name">SetRow</a> (<span class="var-type">int</span> <span class="var-name">$row</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"> <h4>Inherited Variables</h4> <A NAME='inherited_vars'><!-- --></A> <p>Inherited from <span class="classname"><a href="../../Vortex/DB/RS_Base.html">RS_Base</a></span></p> <blockquote> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/RS_Base.html#var$db">RS_Base::$db</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/RS_Base.html#var$result">RS_Base::$result</a></span><br> </span> <span class="var-title"> <span class="var-name"><a href="../../Vortex/DB/RS_Base.html#var$row">RS_Base::$row</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-vars">Vars</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="methodAll" id="All"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">All</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_MySQL.class.php.html#a82">82</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get all rows from the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns all the rows from the RecordSet.</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> All </span> ([<span class="var-type">int</span> <span class="var-name">$type</span> = <span class="var-default">RS_ROW_ASSOC</span>]) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$type</span><span class="var-description">: Type of array to return (RS_ROW_NUM | RS_ROW_ASSOC | RS_ROW_BOTH).</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/RS_Base.html#methodAll">RS_Base::All()</a></dt> <dd>Get all rows from the RecordSet.</dd> </dl> </div> <a name="methodClose" id="Close"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">Close</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_MySQL.class.php.html#a115">115</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Close the RecordSet and free the memory.</p> <ul class="tags"> <li><span class="field">return:</span> Returns TRUE if the RecordSet was closed, FALSE if it failed.</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> Close </span> () </div> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/RS_Base.html#methodClose">RS_Base::Close()</a></dt> <dd>Close the RecordSet and free the memory.</dd> </dl> </div> <a name="methodError" id="Error"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Error</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_MySQL.class.php.html#a105">105</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get the last error message from the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns a string describing the last error that occurred in the RecordSet.</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> Error </span> () </div> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/RS_Base.html#methodError">RS_Base::Error()</a></dt> <dd>Get the last error message from the RecordSet.</dd> </dl> </div> <a name="methodLastId" id="LastId"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">LastId</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_MySQL.class.php.html#a95">95</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get the last auto-generated ID from the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns the last auto-generated ID from the RecordSet.</li> </ul> <div class="method-signature"> <span class="method-result">int</span> <span class="method-name"> LastId </span> () </div> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/RS_Base.html#methodLastId">RS_Base::LastId()</a></dt> <dd>Get the last auto-generated ID from the RecordSet.</dd> </dl> </div> <a name="methodRow" id="Row"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Row</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_MySQL.class.php.html#a42">42</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get a row from the RecordSet.</p> <p class="description"><p>Case $row is set, return that row, case else, return the next row.</p></p> <ul class="tags"> <li><span class="field">return:</span> Returns the row from the RecordSet, or FALSE if EOF.</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> Row </span> ([<span class="var-type">int</span> <span class="var-name">$row</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$type</span> = <span class="var-default">RS_ROW_ASSOC</span>]) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$row</span><span class="var-description">: Row to return, defaults to next.</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$type</span><span class="var-description">: Type of array to return (RS_ROW_NUM | RS_ROW_ASSOC | RS_ROW_BOTH).</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/RS_Base.html#methodRow">RS_Base::Row()</a></dt> <dd>Get a row from the RecordSet.</dd> </dl> </div> <a name="methodRowCount" id="RowCount"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">RowCount</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_MySQL.class.php.html#a28">28</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Get the count of rows in the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns the number of rows in the RecordSet.</li> </ul> <div class="method-signature"> <span class="method-result">int</span> <span class="method-name"> RowCount </span> () </div> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/RS_Base.html#methodRowCount">RS_Base::RowCount()</a></dt> <dd>Get the count of rows in the RecordSet.</dd> </dl> </div> <a name="methodSetRow" id="SetRow"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">SetRow</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_RS_MySQL.class.php.html#a69">69</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Go to a row int the RecordSet.</p> <ul class="tags"> <li><span class="field">return:</span> Returns TRUE on success, FALSE if failed.</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> SetRow </span> (<span class="var-type">int</span> <span class="var-name">$row</span>) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$row</span><span class="var-description">: Row to go to.</span> </li> </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> <dt><a href="../../Vortex/DB/RS_Base.html#methodSetRow">RS_Base::SetRow()</a></dt> <dd>Go to a row int the RecordSet.</dd> </dl> </div> <h4>Inherited Methods</h4> <a name='inherited_methods'><!-- --></a> <!-- =========== Summary =========== --> <p>Inherited From <span class="classname"><a href="../../Vortex/DB/RS_Base.html">RS_Base</a></span></p> <blockquote> <span class="method-name"><a href="../../Vortex/DB/RS_Base.html#methodRS_Base">RS_Base::RS_Base()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/RS_Base.html#methodAll">RS_Base::All()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/RS_Base.html#methodClose">RS_Base::Close()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/RS_Base.html#methodError">RS_Base::Error()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/RS_Base.html#methodLastId">RS_Base::LastId()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/RS_Base.html#methodRow">RS_Base::Row()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/RS_Base.html#methodRowCount">RS_Base::RowCount()</a></span><br> <span class="method-name"><a href="../../Vortex/DB/RS_Base.html#methodSetRow">RS_Base::SetRow()</a></span><br> </blockquote> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 30 Sep 2004 10:35:41 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: _TB_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 TB_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">/TB_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> </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">File for class TB_Base.</p> <ul class="tags"> <li><span class="field">filesource:</span> <a href="../..//__filesource/fsource_Vortex_DB_TB_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> </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/TB_Base.html">TB_Base</a> </td> <td> Base class for tables in databases. </td> </tr> </table> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 30 Sep 2004 10:35:43 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: _FT_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 FT_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">/FT_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> </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">File for class FT_Base.</p> <ul class="tags"> <li><span class="field">filesource:</span> <a href="../..//__filesource/fsource_Vortex_DB_FT_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> </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_Base.html">FT_Base</a> </td> <td> Base class for all database fields. </td> </tr> </table> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 30 Sep 2004 10:35:36 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: TB_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 TB_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 TB_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 tables in databases.</p> <p class="notes"> Located in <a class="field" href="_TB_Base_class_php.html">/TB_Base.class.php</a> (line <span class="field"><a href="../..//__filesource/fsource_Vortex_DB_TB_Base.class.php.html#a18">18</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">array</span> <a href="#$data" title="details" class="var-name">$data</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="#$fields" title="details" class="var-name">$fields</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">TB_Base</span> <a href="#TB_Base" title="details" class="method-name">TB_Base</a> (<span class="var-type"><a href="../../Vortex/DB/DB_Base.html">DB_Base</a></span> <span class="var-name">&$db</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$data" id="$data"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$data</span> = <span class="var-default">array()</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_TB_Base.class.php.html#a36">36</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Array the current row of the table, for output, edit or search.</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> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_TB_Base.class.php.html#a24">24</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Database where the table is.</p> </div> <a name="var$fields" id="$fields"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$fields</span> = <span class="var-default">array()</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_TB_Base.class.php.html#a30">30</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Array containing all the fields of the table (FT_* classes).</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="methodTB_Base" id="TB_Base"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Constructor TB_Base</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_TB_Base.class.php.html#a43">43</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Constructor: Init the object, and define the table's fields and relationships.</p> <div class="method-signature"> <span class="method-result">TB_Base</span> <span class="method-name"> TB_Base </span> (<span class="var-type"><a href="../../Vortex/DB/DB_Base.html">DB_Base</a></span> <span class="var-name">&$db</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 table is.</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 30 Sep 2004 10:35:43 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> </p> </div></body> </html> --- NEW FILE: FT_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 FT_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 FT_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-descendents">Descendents</a> | <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 all database fields.</p> <p class="notes"> Located in <a class="field" href="_FT_Base_class_php.html">/FT_Base.class.php</a> (line <span class="field"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a18">18</a></span>) </p> <pre></pre> </div> </div> <a name="sec-descendents"></a> <div class="info-box"> <div class="info-box-title">Direct descendents</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Descendents</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"> <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"><a href="../../Vortex/DB/FT_Text.html">FT_Text</a></td> <td> Database field, Text type. </td> </tr> </table> </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> | <a href="#sec-descendents">Descendents</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="#$label" title="details" class="var-name">$label</a> </div> <div class="var-title"> <span class="var-type">string</span> <a href="#$name" title="details" class="var-name">$name</a> </div> <div class="var-title"> <span class="var-type">string</span> <a href="#$name_db" title="details" class="var-name">$name_db</a> </div> <div class="var-title"> <span class="var-type">string</span> <a href="#$name_form" title="details" class="var-name">$name_form</a> </div> <div class="var-title"> <span class="var-type">bool</span> <a href="#$pkey" title="details" class="var-name">$pkey</a> </div> <div class="var-title"> <span class="var-type">bool</span> <a href="#$required" title="details" class="var-name">$required</a> </div> <div class="var-title"> <span class="var-type"><a href="../../Vortex/DB/TB_Base.html">TB_Base</a></span> <a href="#$table" title="details" class="var-name">$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-descendents">Descendents</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_Base</span> <a href="#FT_Base" title="details" class="method-name">FT_Base</a> (<span class="var-type"><a href="../../Vortex/DB/TB_Base.html">TB_Base</a></span> <span class="var-name">&$table</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="#Consist" title="details" class="method-name">Consist</a> (<span class="var-type">array</span> <span class="var-name">&$vars</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="#Show" title="details" class="method-name">Show</a> ([<span class="var-type">bool</span> <span class="var-name">$form</span> = <span class="var-default">TRUE</span>]) </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-descendents">Descendents</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"> ''</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a77">77</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Default value of the field.</p> </div> <a name="var$label" id="$label"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$label</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a56">56</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Label to the field.</p> <p class="description"><p>Default = <a href="../../Vortex/DB/FT_Base.html#var$name">$name</a></p></p> </div> <a name="var$name" id="$name"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$name</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a32">32</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Field name.</p> </div> <a name="var$name_db" id="$name_db"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$name_db</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a40">40</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Name of the field in the database.</p> <p class="description"><p>Default = <a href="../../Vortex/DB/FT_Base.html#var$name">$name</a></p></p> </div> <a name="var$name_form" id="$name_form"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$name_form</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a48">48</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Name of the field in the forms.</p> <p class="description"><p>Default = <a href="../../Vortex/DB/FT_Base.html#var$name">$name</a></p></p> </div> <a name="var$pkey" id="$pkey"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">bool</span> <span class="var-name">$pkey</span> = <span class="var-default"> FALSE</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a63">63</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Is the field a Primary Key?</p> </div> <a name="var$required" id="$required"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">bool</span> <span class="var-name">$required</span> = <span class="var-default"> FALSE</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a70">70</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Is the field required(obligatory)?</p> </div> <a name="var$table" id="$table"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type"><a href="../../Vortex/DB/TB_Base.html">TB_Base</a></span> <span class="var-name">$table</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a25">25</a></span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Table which the field comes from.</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-descendents">Descendents</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_Base" id="FT_Base"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">Constructor FT_Base</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a85">85</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_Base</span> <span class="method-name"> FT_Base </span> (<span class="var-type"><a href="../../Vortex/DB/TB_Base.html">TB_Base</a></span> <span class="var-name">&$table</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/TB_Base.html">TB_Base</a></span> <span class="var-name">$table</span><span class="var-description">: Table which the field comes from.</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="methodConsist" id="Consist"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Consist</span> (line <span class="line-number"><a href="../..//__filesource/fsource_Vortex_DB_FT_Base.class.php.html#a153">153</a></span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Extract the field from $vars, test the field consistency and return it ready for database insertion.</p> <ul class="tags"> <li><span class="field">return:</span> Returns a string containing the parsed field data, or FALSE if the field is invalid.</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> Consist </span> (<span class="var-type">array</span> <span class="var-name">&$vars</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$vars</span><span class="var-description">: Array containing the FORM data (usually $_POST).</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_Base.class.php.html#a184">184</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> ... [truncated message content] |
