[Pureuseradmin-cvs] PureUserAdmin/docs/default _pureuserclass_php.html,NONE,1.1 _pc_php.html,NONE,1.
Status: Abandoned
Brought to you by:
mvanbaak
|
From: Michiel v. B. <mva...@us...> - 2004-10-03 16:11:04
|
Update of /cvsroot/pureuseradmin/PureUserAdmin/docs/default In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27765/docs/default Added Files: _pureuserclass_php.html _pc_php.html _index_php.html pureuseradmin.html _functions_mysql_php.html _functions_postgres_php.html Log Message: api docs --- NEW FILE: _functions_mysql_php.html --- <html> <head> <title>Docs for page functions_mysql.php</title> <link rel="stylesheet" type="text/css" href="../media/style.css"> </head> <body> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr> <td class="header_top">default</td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> <tr> <td class="header_menu"> [ <a href="../classtrees_default.html" class="menu">class tree: default</a> ] [ <a href="../elementindex_default.html" class="menu">index: default</a> ] [ <a href="../elementindex.html" class="menu">all elements</a> ] </td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> </table> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="200" class="menu"> <div id="ric"> <p><a href="../ric_CHANGELOG.html">CHANGELOG</a></p> <p><a href="../ric_README.html">README</a></p> </div> <b>Packages:</b><br /> <a href="../li_default.html">default</a><br /> <br /><br /> <b>Files:</b><br /> <div class="package"> <a href="../default/_functions_mysql_php.html"> functions_mysql.php </a><br> <a href="../default/_functions_postgres_php.html"> functions_postgres.php </a><br> <a href="../default/_index_php.html"> index.php </a><br> <a href="../default/_pc_php.html"> pc.php </a><br> <a href="../default/_pureuserclass_php.html"> pureuserclass.php </a><br> </div><br /> <b>Classes:</b><br /> <div class="package"> <a href="../default/pureuseradmin.html">pureuseradmin</a><br /> </div> </td> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <h1>Procedural File: functions_mysql.php</h1> Source Location: /functions_mysql.php<br /><br /> <br> <br> <h2>Page Details:</h2> <br /><br /> <br /><br /> <br /><br /> <br /> <hr /> <a name="functionsql_affected_rows"></a> <h3>sql_affected_rows <span class="smalllinenumber">[line 69]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_affected_rows( [mixed $result = ""])</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_data_seek"></a> <h3>sql_data_seek <span class="smalllinenumber">[line 73]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_data_seek( mixed $result, mixed $pos)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_error"></a> <h3>sql_error <span class="smalllinenumber">[line 81]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_error( mixed $filename, mixed $linenumber, [mixed $query = ""])</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_fetch_array"></a> <h3>sql_fetch_array <span class="smalllinenumber">[line 44]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_fetch_array( mixed $result)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_fetch_assoc"></a> <h3>sql_fetch_assoc <span class="smalllinenumber">[line 52]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_fetch_assoc( mixed $result)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_fetch_row"></a> <h3>sql_fetch_row <span class="smalllinenumber">[line 48]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_fetch_row( mixed $result)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_insert_id"></a> <h3>sql_insert_id <span class="smalllinenumber">[line 77]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_insert_id( )</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_num_rows"></a> <h3>sql_num_rows <span class="smalllinenumber">[line 65]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_num_rows( [mixed $result = ""])</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_query"></a> <h3>sql_query <span class="smalllinenumber">[line 39]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_query( mixed $query)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_result"></a> <h3>sql_result <span class="smalllinenumber">[line 56]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_result( mixed $result, [mixed $pos = 0], [mixed $field = ""])</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsql_trigger_error"></a> <h3>sql_trigger_error <span class="smalllinenumber">[line 2]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void sql_trigger_error( mixed $query, mixed $err)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <div class="credit"> <hr /> Documentation generated on Sun, 3 Oct 2004 18:02:14 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html> --- NEW FILE: _pureuserclass_php.html --- <html> <head> <title>Docs for page pureuserclass.php</title> <link rel="stylesheet" type="text/css" href="../media/style.css"> </head> <body> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr> <td class="header_top">default</td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> <tr> <td class="header_menu"> [ <a href="../classtrees_default.html" class="menu">class tree: default</a> ] [ <a href="../elementindex_default.html" class="menu">index: default</a> ] [ <a href="../elementindex.html" class="menu">all elements</a> ] </td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> </table> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="200" class="menu"> <div id="ric"> <p><a href="../ric_CHANGELOG.html">CHANGELOG</a></p> <p><a href="../ric_README.html">README</a></p> </div> <b>Packages:</b><br /> <a href="../li_default.html">default</a><br /> <br /><br /> <b>Files:</b><br /> <div class="package"> <a href="../default/_functions_mysql_php.html"> functions_mysql.php </a><br> <a href="../default/_functions_postgres_php.html"> functions_postgres.php </a><br> <a href="../default/_index_php.html"> index.php </a><br> <a href="../default/_pc_php.html"> pc.php </a><br> <a href="../default/_pureuserclass_php.html"> pureuserclass.php </a><br> </div><br /> <b>Classes:</b><br /> <div class="package"> <a href="../default/pureuseradmin.html">pureuseradmin</a><br /> </div> </td> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <h1>Procedural File: pureuserclass.php</h1> Source Location: /pureuserclass.php<br /><br /> <br> <br> <div class="contents"> <h2>Classes:</h2> <dt><a href="../default/pureuseradmin.html">pureuseradmin</a></dt> <dd>Manage virtual users for PureFTPd.</dd> </div><br /><br /> <h2>Page Details:</h2> <br /><br /> <br /><br /> <br /><br /> <br /> <div class="credit"> <hr /> Documentation generated on Sun, 3 Oct 2004 18:02:15 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html> --- NEW FILE: pureuseradmin.html --- <html> <head> <title>Docs For Class pureuseradmin</title> <link rel="stylesheet" type="text/css" href="../media/style.css"> </head> <body> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr> <td class="header_top">default</td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> <tr> <td class="header_menu"> [ <a href="../classtrees_default.html" class="menu">class tree: default</a> ] [ <a href="../elementindex_default.html" class="menu">index: default</a> ] [ <a href="../elementindex.html" class="menu">all elements</a> ] </td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> </table> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="200" class="menu"> <div id="ric"> <p><a href="../ric_CHANGELOG.html">CHANGELOG</a></p> <p><a href="../ric_README.html">README</a></p> </div> <b>Packages:</b><br /> <a href="../li_default.html">default</a><br /> <br /><br /> <b>Files:</b><br /> <div class="package"> <a href="../default/_functions_mysql_php.html"> functions_mysql.php </a><br> <a href="../default/_functions_postgres_php.html"> functions_postgres.php </a><br> <a href="../default/_index_php.html"> index.php </a><br> <a href="../default/_pc_php.html"> pc.php </a><br> <a href="../default/_pureuserclass_php.html"> pureuserclass.php </a><br> </div><br /> <b>Classes:</b><br /> <div class="package"> <a href="../default/pureuseradmin.html">pureuseradmin</a><br /> </div> </td> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <h1>Class: pureuseradmin</h1> Source Location: /pureuserclass.php<br /><br /> <table width="100%" border="0"> <tr><td valign="top"> <h3><a href="#class_details">Class Overview</a></h3> <pre></pre><br /> <div class="description">Manage virtual users for PureFTPd.</div><br /><br /> <h4>Author(s):</h4> <ul> <li>Michiel van Baak <<a href="mailto:mva...@us...">mva...@us...</a>></li> </ul> <h4>Version:</h4> <ul> <li>0.2.0</li> </ul> <h4>Copyright:</h4> <ul> <li>Copyright 2004, Michiel van Baak</li> </ul> </td> <td valign="top"> <h3><a href="#class_vars">Variables</a></h3> <ul> <li><a href="../default/pureuseradmin.html#var$gids">$gids</a></li> <li><a href="../default/pureuseradmin.html#var$settings">$settings</a></li> <li><a href="../default/pureuseradmin.html#var$uids">$uids</a></li> </ul> </td> <td valign="top"> <h3><a href="#class_consts">Constants</a></h3> <ul> <li><a href="../default/pureuseradmin.html#constDEBUG">DEBUG</a></li> </ul> </td> <td valign="top"> <h3><a href="#class_methods">Methods</a></h3> <ul> <li><a href="../default/pureuseradmin.html#method__construct">__construct</a></li> <li><a href="../default/pureuseradmin.html#methodchangeSetting">changeSetting</a></li> <li><a href="../default/pureuseradmin.html#methodcheck_access">check_access</a></li> <li><a href="../default/pureuseradmin.html#methoddb_init">db_init</a></li> <li><a href="../default/pureuseradmin.html#methoddelete_user">delete_user</a></li> <li><a href="../default/pureuseradmin.html#methodget_all_users">get_all_users</a></li> <li><a href="../default/pureuseradmin.html#methodget_user">get_user</a></li> <li><a href="../default/pureuseradmin.html#methodload_gids">load_gids</a></li> <li><a href="../default/pureuseradmin.html#methodload_sql">load_sql</a></li> <li><a href="../default/pureuseradmin.html#methodload_uids">load_uids</a></li> <li><a href="../default/pureuseradmin.html#methodmkpass">mkpass</a></li> <li><a href="../default/pureuseradmin.html#methodsave_user">save_user</a></li> </ul> </td> </tr></table> <hr /> <table width="100%" border="0"><tr> </tr></table> <hr /> <a name="class_details"></a> <h3>Class Details</h3> <div class="tags"> [line 14]<br /> Manage virtual users for PureFTPd.<br /><br /><p>This class provides every function you need to manage virtual users. It can handle users stored in a MySQL or PostgreSQL database.</p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>copyright:</b> </td><td>Copyright 2004, Michiel van Baak</td> </tr> <tr> <td><b>author:</b> </td><td>Michiel van Baak <<a href="mailto:mva...@us...">mva...@us...</a>></td> </tr> <tr> <td><b>link:</b> </td><td><a href="http://pureuseradmin.sourceforge.net">Project home.</a></td> </tr> <tr> <td><b>license:</b> </td><td><a href="http://www.gnu.org/licenses/gpl.html">GPL</a></td> </tr> <tr> <td><b>version:</b> </td><td>0.2.0</td> </tr> </table> </div> </div><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /> <hr /> <a name="class_vars"></a> <h3>Class Variables</h3> <div class="tags"> <a name="var$gids"></a> <p></p> <h4>$gids = <span class="value">array()</span></h4> <p>[line 34]</p> This variable is filled in the constructor.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>var:</b> </td><td>gids on the system.</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>Type:</b> </td> <td>array</td> </tr> </table> </div><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /> <a name="var$settings"></a> <p></p> <h4>$settings = <span class="value">array()</span></h4> <p>[line 22]</p> This variable is filled in the constructor. It can be changed with a public function.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>var:</b> </td><td>all settings needed</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>Type:</b> </td> <td>array</td> </tr> </table> </div><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /> <a name="var$uids"></a> <p></p> <h4>$uids = <span class="value">array()</span></h4> <p>[line 28]</p> This variable is filled in the constructor.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>var:</b> </td><td>uids on the system.</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>Type:</b> </td> <td>array</td> </tr> </table> </div><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /> </div><br /> <hr /> <a name="class_methods"></a> <h3>Class Methods</h3> <div class="tags"> <hr /> <a name="method__construct"></a> <h3>constructor __construct <span class="smalllinenumber">[line 153]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>pureuseradmin __construct( )</code> </td></tr></table> </td></tr></table><br /> Class constructor<br /><br /><p>This function is called as soon as an instance of the class is created. It will init the settings, connect to the database and load the uids and gids on the system. <div class="listing"><pre><ol><li> <span class="src-var">$instance </span>= <span class="src-key">new </span><span class="src-id"><a href="../default/pureuseradmin.html">pureuseradmin</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>access:</b> </td><td>protected</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodchangeSetting"></a> <h3>method changeSetting <span class="smalllinenumber">[line 193]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void changeSetting( string $setting, string $value)</code> </td></tr></table> </td></tr></table><br /> Overwrite a predefined setting,<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-var">$instance</span><span class="src-sym">-></span><a href="../default/pureuseradmin.html#methodchangeSetting">changeSetting</a><span class="src-sym">(</span><span class="src-str">"setting"</span><span class="src-sym">, </span><span class="src-str">"value"</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">string </td> <td><b>$setting</b> </td> <td>The setting to overwrite.</td> </tr> <tr> <td class="type">string </td> <td><b>$value</b> </td> <td>The new value.</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodcheck_access"></a> <h3>method check_access <span class="smalllinenumber">[line 305]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>array check_access( string $homedir, int $uid, int $gid)</code> </td></tr></table> </td></tr></table><br /> Check what type of access the user has.<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-var">$permission </span>= <span class="src-var">$instance</span><span class="src-sym">-></span><a href="../default/pureuseradmin.html#methodcheck_access">check_access</a><span class="src-sym">(</span><span class="src-str">"/home/test"</span><span class="src-sym">,</span><span class="src-num">1001</span><span class="src-sym">,</span><span class="src-num">1001</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>owner,group,world octal permission and read and write flag.</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">string </td> <td><b>$homedir</b> </td> <td>The home directory of the user processed.</td> </tr> <tr> <td class="type">int </td> <td><b>$uid</b> </td> <td>The main userid of the user.</td> </tr> <tr> <td class="type">int </td> <td><b>$gid</b> </td> <td>The main groupid of the user.</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methoddb_init"></a> <h3>method db_init <span class="smalllinenumber">[line 65]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void db_init( )</code> </td></tr></table> </td></tr></table><br /> Database connection<br /><br /><p>Make connection to the database server, select the right database and include the file with database specific functions. <div class="listing"><pre><ol><li> <span class="src-id">self</span><span class="src-sym">::</span><span class="src-id">dbinit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>access:</b> </td><td>private</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methoddelete_user"></a> <h3>method delete_user <span class="smalllinenumber">[line 260]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>boolean delete_user( array $userinfo)</code> </td></tr></table> </td></tr></table><br /> Delete a user from the database.<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-var">$result </span>= <span class="src-var">$instance</span><span class="src-sym">-></span><a href="../default/pureuseradmin.html#methoddelete_user">delete_user</a><span class="src-sym">(</span><span class="src-var">$userinfo</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>true when success, false on error.</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">array </td> <td><b>$userinfo</b> </td> <td></td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodget_all_users"></a> <h3>method get_all_users <span class="smalllinenumber">[line 286]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>array get_all_users( )</code> </td></tr></table> </td></tr></table><br /> Get all users from the database, in alphabetic order.<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-var">$userlist </span>= <span class="src-var">$instance</span><span class="src-sym">-></span><a href="../default/pureuseradmin.html#methodget_all_users">get_all_users</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>All users with all info that is in the database.</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodget_user"></a> <h3>method get_user <span class="smalllinenumber">[line 273]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>array get_user( array $userinfo)</code> </td></tr></table> </td></tr></table><br /> Get a user from the database.<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-var">$userlist </span>= <span class="src-var">$instance</span><span class="src-sym">-></span><a href="../default/pureuseradmin.html#methodget_user">get_user</a><span class="src-sym">(</span><span class="src-var">$userinfo</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>A user with all info that is in the database.</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">array </td> <td><b>$userinfo</b> </td> <td></td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodload_gids"></a> <h3>method load_gids <span class="smalllinenumber">[line 135]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>array load_gids( )</code> </td></tr></table> </td></tr></table><br /> Load all the gids and groupnames on the system.<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-id">self</span><span class="src-sym">::</span><span class="src-id">load_gids</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>gids as key and groupnames as value.</td> </tr> <tr> <td><b>access:</b> </td><td>private</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodload_sql"></a> <h3>method load_sql <span class="smalllinenumber">[line 85]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void load_sql( string $sql_type)</code> </td></tr></table> </td></tr></table><br /> PHP database support<br /><br /><p>Check wether the needed database module is loaded as php module. If not, try to load it now. <div class="listing"><pre><ol><li> <span class="src-id">self</span><span class="src-sym">::</span><span class="src-id">load_sql</span><span class="src-sym">(</span><span class="src-var">$sql_type</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>access:</b> </td><td>private</td> </tr> </table> </div> <br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">string </td> <td><b>$sql_type</b> </td> <td>database server type. "mysql" or "postgres"</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodload_uids"></a> <h3>method load_uids <span class="smalllinenumber">[line 119]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>array load_uids( )</code> </td></tr></table> </td></tr></table><br /> Load all the uids and usernames on the system.<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-id">self</span><span class="src-sym">::</span><span class="src-id">load_uids</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>uids as key and usernames as value.</td> </tr> <tr> <td><b>access:</b> </td><td>private</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodmkpass"></a> <h3>method mkpass <span class="smalllinenumber">[line 43]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>string mkpass( string $passwd)</code> </td></tr></table> </td></tr></table><br /> Generate a password statement for the database query.<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-var">$pass </span>= <span class="src-id">self</span><span class="src-sym">::</span><span class="src-id">mkpass</span><span class="src-sym">(</span><span class="src-str">"password"</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>The string to use in the sql statement.</td> </tr> <tr> <td><b>access:</b> </td><td>private</td> </tr> </table> </div> <br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">string </td> <td><b>$passwd</b> </td> <td>The password to insert into the database.</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodsave_user"></a> <h3>method save_user <span class="smalllinenumber">[line 204]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>boolean save_user( array $userinfo)</code> </td></tr></table> </td></tr></table><br /> Save a user in the database.<br /><br /><p><div class="listing"><pre><ol><li> <span class="src-var">$result </span>= <span class="src-var">$instance</span><span class="src-sym">-></span><a href="../default/pureuseradmin.html#methodsave_user">save_user</a><span class="src-sym">(</span><span class="src-var">$userinfo</span><span class="src-sym">)</span><span class="src-sym">;</span></li> </ol></pre></div></p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>true when success, false on error.</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">array </td> <td><b>$userinfo</b> </td> <td></td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> </div><br /> <hr /> <a name="class_constss"></a> <h3>Class Constants</h3> <div class="tags"> <a name="constDEBUG"></a> <p></p> <h4>DEBUG = <span class="value"> 0</span></h4> <p>[line 16]</p> <br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /> </div><br /> <div class="credit"> <hr /> Documentation generated on Sun, 3 Oct 2004 18:02:15 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html> --- NEW FILE: _pc_php.html --- <html> <head> <title>Docs for page pc.php</title> <link rel="stylesheet" type="text/css" href="../media/style.css"> </head> <body> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr> <td class="header_top">default</td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> <tr> <td class="header_menu"> [ <a href="../classtrees_default.html" class="menu">class tree: default</a> ] [ <a href="../elementindex_default.html" class="menu">index: default</a> ] [ <a href="../elementindex.html" class="menu">all elements</a> ] </td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> </table> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="200" class="menu"> <div id="ric"> <p><a href="../ric_CHANGELOG.html">CHANGELOG</a></p> <p><a href="../ric_README.html">README</a></p> </div> <b>Packages:</b><br /> <a href="../li_default.html">default</a><br /> <br /><br /> <b>Files:</b><br /> <div class="package"> <a href="../default/_functions_mysql_php.html"> functions_mysql.php </a><br> <a href="../default/_functions_postgres_php.html"> functions_postgres.php </a><br> <a href="../default/_index_php.html"> index.php </a><br> <a href="../default/_pc_php.html"> pc.php </a><br> <a href="../default/_pureuserclass_php.html"> pureuserclass.php </a><br> </div><br /> <b>Classes:</b><br /> <div class="package"> <a href="../default/pureuseradmin.html">pureuseradmin</a><br /> </div> </td> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <h1>Procedural File: pc.php</h1> Source Location: /pc.php<br /><br /> <br> <br> <h2>Page Details:</h2> <br /><br /> <br /><br /> <br /><br /> <br /> <hr /> <a name="functioncheck_access"></a> <h3>check_access <span class="smalllinenumber">[line 609]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void check_access( mixed $homedir, mixed $uid, mixed $gid)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functiondb_init"></a> <h3>db_init <span class="smalllinenumber">[line 121]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void db_init( )</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functiondelete_user"></a> <h3>delete_user <span class="smalllinenumber">[line 592]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void delete_user( mixed $userinfo)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionedit_user"></a> <h3>edit_user <span class="smalllinenumber">[line 425]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void edit_user( [mixed $username = ""])</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionerror"></a> <h3>error <span class="smalllinenumber">[line 705]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void error( mixed $title, mixed $text)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functiongen_list"></a> <h3>gen_list <span class="smalllinenumber">[line 337]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void gen_list( [mixed $search = ""], [mixed $start = 0])</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionhtml_footer"></a> <h3>html_footer <span class="smalllinenumber">[line 309]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void html_footer( )</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionhtml_header"></a> <h3>html_header <span class="smalllinenumber">[line 181]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void html_header( mixed $title)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionload_gids"></a> <h3>load_gids <span class="smalllinenumber">[line 162]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void load_gids( )</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionload_sql"></a> <h3>load_sql <span class="smalllinenumber">[line 84]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void load_sql( mixed $sql_type)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionload_uids"></a> <h3>load_uids <span class="smalllinenumber">[line 143]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void load_uids( )</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionsave_user"></a> <h3>save_user <span class="smalllinenumber">[line 517]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void save_user( mixed $userinfo)</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <hr /> <a name="functionwelcome"></a> <h3>welcome <span class="smalllinenumber">[line 645]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void welcome( )</code> </td></tr></table> </td></tr></table><br /> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /><br /> </div> <div class="credit"> <hr /> Documentation generated on Sun, 3 Oct 2004 18:02:15 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html> --- NEW FILE: _index_php.html --- <html> <head> <title>Docs for page index.php</title> <link rel="stylesheet" type="text/css" href="../media/style.css"> </head> <body> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr> <td class="header_top">default</td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> <tr> <td class="header_menu"> [ <a href="../classtrees_default.html" class="menu">class tree: default</a> ] [ <a href="../elementindex_default.html" class="menu">index: default</a> ] [ <a href="../elementindex.html" class="menu">all elements</a> ] </td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> </table> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="200" class="menu"> <div id="ric"> <p><a href="../ric_CHANGELOG.html">CHANGELOG</a></p> <p><a href="../ric_README.html">README</a></p> </div> <b>Packages:</b><br /> <a href="../li_default.html">default</a><br /> <br /><br /> <b>Files:</b><br /> <div class="package"> <a href="../default/_functions_mysql_php.html"> functions_mysql.php </a><br> <a href="../default/_functions_postgres_php.html"> functions_postgres.php </a><br> <a href="../default/_index_php.html"> index.php </a><br> <a href="../default/_pc_php.html"> pc.php </a><br> <a href="../default/_pureuserclass_php.html"> pureuserclass.php </a><br> </div><br /> <b>Classes:</b><br /> <div class="package"> <a href="../default/pureuseradmin.html">pureuseradmin</a><br /> </div> </td> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <h1>Procedural File: index.php</h1> Source Location: /index.php<br /><br /> <br> <br> <h2>Page Details:</h2> <br /><br /> <h4>Includes:</h4> <div class="tags"> require(<a href="../default/_pureuserclass_php.html">"pureuserclass.php"</a>) [line 2]<br /> </div> <br /><br /> <br /><br /> <br /> <div class="credit"> <hr /> Documentation generated on Sun, 3 Oct 2004 18:02:15 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html> --- NEW FILE: _functions_postgres_php.html --- <html> <head> <title>Docs for page functions_postgres.php</title> <link rel="stylesheet" type="text/css" href="../media/style.css"> </head> <body> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr> <td class="header_top">default</td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> <tr> <td class="header_menu"> [ <a href="../classtrees_default.html" class="menu">class tree: default</a> ] [ <a href="../elementindex_default.html" class="menu">index: default</a> ] [ <a href="../elementindex.html" class="menu">all elements</a> ] </td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> </table> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="200" class="menu"> <div id="ric"> <p><a href="../ric_CHANGELOG.html">CHANGELOG</a></p> <p><a href="../ric_README.html">README</a></p> </div> <b>Packages:</b><br /> <a href="../li_default.html">default</a><br /> <br /><br /> <b>Files:</b><br /> <div class="package"> <a href="../default/_functions_mysql_php.html"> functions_mysql.php </a><br> <a href="../default/_functions_postgres_php.html"> functions_postgres.php </a><br> <a href="../default/_index_php.html"> index.php </a><br> <a href="../default/_pc_php.html"> pc.php </a><br> <a href="../default/_pureuserclass_php.html"> pureuserclass.php </a><br> </div><br /> <b>Classes:</b><br /> <div class="package"> <a href="../default/pureuseradmin.html">pureuseradmin</a><br /> </div> </td> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <h1>Procedural File: functions_postgres.php</h1> Source Location: /functions_postgres.php<br /><br /> <br> <br> <h2>Page Details:</h2> <br /><br /> <br /><br /> <br /><br /> <br /> <div class="credit"> <hr /> Documentation generated on Sun, 3 Oct 2004 18:02:14 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html> |