<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <!-- Generated with PHPDoc, http://www.phpdoc.de --> <html> <head> <title>PHPDoc - - Class: FileDB</title> <link href="phpdoc.css" rel="stylesheet" type="text/css"> </head> <body> <table width="100%" border="0"> <tr> <td align="left" valign="top" bgcolor="#B0BAFF"> <table width="100%"> <tr> <td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td> <td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td> <td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td> <td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td> <td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td> <td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td> </tr> </table> </td> </tr> <tr> <td height="20" align="left" valign="top"><hr></td> </tr> <tr> <td align="left" valign="top"> File: <a href="file://../../projects/4phpdoc/FileDB.php" target="_new">../../projects/4phpdoc/FileDB.php</a> <h5>PHPDoc - </h5> <h1>FileDB</h1> FileDB<br> <p> Class for handling bin data in a database <p> </td> </tr> <tr> <td align="left" valign="top"> <h4>private class FileDB </h4> Class for handling bin data in a database <br> <p> <table> <tr><td align="left" valign="top">Authors</td><td align="left" valign="top">Lennart Groetzbach <<a href="mailto:hide@address.com">hide@address.com</a>></td></tr> <tr><td align="left" valign="top">Version</td><td align="left" valign="top">0.52 BETA - 2003/01/17 <p> History / Changes<br> <table border="1" width="100%" cellpadding="3"><tr> <th>Version</th> <th>Reported By</th> <th>File / Function Changed</th> <th>Date of Change</th> <th>Commment</th> </tr><tr> <td>0.51</td> <td>Matthias Haldimann</td> <td>sendFile()</td> <td>2002/12/15</td> <td>added parameter for content type</td> </tr><tr> <td>0.52</td> <td>-</td> <td>sendFile()</td> <td>2002/01/17</td> <td>made download compatible for most browser</td> </tr> </table></td></tr> <tr><td align="left" valign="top">Copyright</td><td align="left" valign="top">Lennart Groetzbach <hide@address.com> - distributed under the LGPL</td></tr> </table> </td> </tr> <tr> <td height="10" align="left" valign="top"> </td> </tr> <tr> <td height="20" align="left" valign="top"><hr></td> </tr> <tr> <td align="left" valign="top"> <table width="100%" border="0"> <tr> <td colspan="2" align="left" valign="top"><h2>Public Method Summary</h2></td> </tr> <tr> <td align="right" valign="top">void</td> <td align="left" valign="top" width="100%"><a href="#function_FileDB()"><h4>FileDB(Object &$db, String $host, String $database, String $user, String $password)</h4></a>Constructor</td> </tr> <tr> <td align="right" valign="top">boolean</td> <td align="left" valign="top" width="100%"><a href="#function_add()"><h4>add(String $file_name, [ String $file_descr ])</h4></a>Adds file to the db</td> </tr> <tr> <td align="right" valign="top">boolean</td> <td align="left" valign="top" width="100%"><a href="#function_edit()"><h4>edit(Array $array)</h4></a>Edits file data</td> </tr> <tr> <td align="right" valign="top">boolean</td> <td align="left" valign="top" width="100%"><a href="#function_remove()"><h4>remove(Integer $id)</h4></a>Removes file to the db</td> </tr> <tr> <td align="right" valign="top">boolean</td> <td align="left" valign="top" width="100%"><a href="#function_sendFile()"><h4>sendFile(Integer $id, [ String $contentType ])</h4></a>Creates user download dialog</td> </tr> <tr> <td align="right" valign="top">mixed</td> <td align="left" valign="top" width="100%"><a href="#function_get()"><h4>get(Integer $id, [ boolean $addHit ])</h4></a>Returns the full file information</td> </tr> <tr> <td align="right" valign="top">mixed</td> <td align="left" valign="top" width="100%"><a href="#function_getWhere()"><h4>getWhere(String $select, [ String $where, boolean $addHit ])</h4></a>Returns specified file information</td> </tr> <tr> <td align="right" valign="top">mixed</td> <td align="left" valign="top" width="100%"><a href="#function_getFile()"><h4>getFile(Integer $id, [ boolean $addHit ])</h4></a>Returns the binary file data</td> </tr> <tr> <td align="right" valign="top">mixed</td> <td align="left" valign="top" width="100%"><a href="#function_getFileData()"><h4>getFileData(Integer $id)</h4></a>Returns the file information</td> </tr> <tr> <td align="right" valign="top">mixed</td> <td align="left" valign="top" width="100%"><a href="#function_getIds()"><h4>getIds()</h4></a>Returns all file ids</td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top"> <table width="100%" border="0"> <tr> <td colspan="2" align="left" valign="top"><h2>Private Method Summary</h2></td> </tr> <tr> <td align="right" valign="top">mixed</td> <td align="left" valign="top" width="100%"><a href="#function__getFileContent()"><h4>_getFileContent(String $file_name)</h4></a>Returns the content of a file</td> </tr> <tr> <td align="right" valign="top">Boolean</td> <td align="left" valign="top" width="100%"><a href="#function_array_key_exists()"><h4>array_key_exists(String $key, Array $array)</h4></a>Does a given key exists</td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top"> <table width="100%" border="0"> <tr> <td colspan="2" align="left" valign="top"><h2>Public Field Summary</h2></td> </tr> <tr> <td align="right" valign="top">integer</td> <td align="left" valign="top" width="100%"><a href="#variable_$file_count"><h4>$file_count</h4></a>number of files in db</td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top"> <table width="100%" border="0"> <tr> <td colspan="2" align="left" valign="top"><h2>Private Field Summary</h2></td> </tr> <tr> <td align="right" valign="top">string</td> <td align="left" valign="top" width="100%"><a href="#variable_$_db"><h4>$_db</h4></a>db abstraction layer</td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top"> <table width="100%" border="0"> <tr> <td colspan="2" align="left" valign="top"><h2>Public Method Details</h2></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_FileDB()"><h4>FileDB</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public void FileDB( Object &$db, String $host, String $database, String $user, String $password )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Constructor <br> Opens the connection to the db <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">Object</td> <td align="left" valign="top">&$db</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$host</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$database</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$user</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$password</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>void <p></td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_add()"><h4>add</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public boolean add( String $file_name, [ String $file_descr ] )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Adds file to the db <br> Adds file to the db and increases the file count <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$file_name</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$file_descr</td> <td align="left" valign="top"><code>= >>''<<</code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>boolean <p>TRUE if successful</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_edit()"><h4>edit</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public boolean edit( Array $array )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Edits file data <br> Edits an entry in the db <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">Array</td> <td align="left" valign="top">$array</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top">array(<br /> "id" => the identifier *<br /> "file_name" => name of the file<br /> "file_descr" => description of the file<br /> "bin_data" => file data<br /> "hits" => number of downloads<br /> )<br /> (*) is mandatory</td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>boolean <p>TRUE if successful</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_remove()"><h4>remove</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public boolean remove( Integer $id )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Removes file to the db <br> Removes file and decreass file count <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">Integer</td> <td align="left" valign="top">$id</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>boolean <p>TRUE if successful</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_sendFile()"><h4>sendFile</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public boolean sendFile( Integer $id, [ String $contentType ] )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Creates user download dialog <br> Sends the file to the user, should be called in an empty page <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">Integer</td> <td align="left" valign="top">$id</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$contentType</td> <td align="left" valign="top"><code>= >>'application/save'<<</code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>boolean <p>FALSE on error</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_get()"><h4>get</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public mixed get( Integer $id, [ boolean $addHit ] )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Returns the full file information <br> Returns the full file information <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">Integer</td> <td align="left" valign="top">$id</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">boolean</td> <td align="left" valign="top">$addHit</td> <td align="left" valign="top"><code>= >>true<<</code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>mixed <p>an Array or FALSE if an error occurs</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_getWhere()"><h4>getWhere</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public mixed getWhere( String $select, [ String $where, boolean $addHit ] )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Returns specified file information <br> Free definable select and where clauses for file information <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$select</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$where</td> <td align="left" valign="top"><code>= >>''<<</code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">boolean</td> <td align="left" valign="top">$addHit</td> <td align="left" valign="top"><code>= >>true<<</code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>mixed <p>an Array or FALSE if an error occurs</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_getFile()"><h4>getFile</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public mixed getFile( Integer $id, [ boolean $addHit ] )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Returns the binary file data <br> Returns the binary file data <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">Integer</td> <td align="left" valign="top">$id</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">boolean</td> <td align="left" valign="top">$addHit</td> <td align="left" valign="top"><code>= >>true<<</code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>mixed <p>a String or FALSE if an error occurs</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_getFileData()"><h4>getFileData</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public mixed getFileData( Integer $id )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Returns the file information <br> Returns the file information without the binary data <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">Integer</td> <td align="left" valign="top">$id</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>mixed <p>a String or FALSE if an error occurs</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_getIds()"><h4>getIds</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public mixed getIds( )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Returns all file ids <br> Returns an array with all file ids <p> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>mixed <p>an Array or FALSE if an error occurs</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> </table> </tr> <tr> <td align="left" valign="top"> <table width="100%" border="0"> <tr> <td colspan="2" align="left" valign="top"><h2>Private Method Details</h2></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function__getFileContent()"><h4>_getFileContent</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>private mixed _getFileContent( String $file_name )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Returns the content of a file <br> Returns binary data <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$file_name</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>mixed <p>a String or FALSE if an error occurs</td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="function_array_key_exists()"><h4>array_key_exists</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>private Boolean array_key_exists( String $key, Array $array )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Does a given key exists <br> For php versions < 4.1 <p> </td> </tr> <tr> <td colspan="2" align="left" valign="top">Parameter</td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">String</td> <td align="left" valign="top">$key</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td></td> <td align="left" valign="top"> <table> <tr> <td align="left" valign="top">Array</td> <td align="left" valign="top">$array</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top"></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>Boolean <p></td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> </table> </tr> <tr> <td align="left" valign="top"> <table width="100%" border="0"> <tr> <td colspan="2" align="left" valign="top"><h2>Public Field Details</h2></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="variable_$file_count"><h4>$file_count</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public integer $file_count</b> <p> >><code>-1</code><< <p> number of files in db <br> </td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> </table> </tr> <tr> <td align="left" valign="top"> <table width="100%" border="0"> <tr> <td colspan="2" align="left" valign="top"><h2>Private Field Details</h2></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="variable_$_db"><h4>$_db</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>private string $_db</b> <p> >><code>null</code><< <p> db abstraction layer <br> </td> </tr> <tr> <td colspan="2" align="left" valign="top"><hr></td> </tr> </table> </tr> <tr> <td height="10" align="left" valign="top"><hr></td> </tr> <tr> <td align="left" valign="top" bgcolor="#C0C0C0"> <table> <tr> <td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td> <td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td> <td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td> <td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td> <td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td> <td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">PHPDoc 1.0beta</td> </tr> </table> </body> </html>