<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <!-- Generated with PHPDoc, http://www.phpdoc.de --> <html> <head> <title>PHPDoc - - Class: Smileys</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/bookmarks/smilies/Smileys.php" target="_new">../../projects/bookmarks/smilies/Smileys.php</a> <h5>PHPDoc - </h5> <h1>Smileys</h1> Smileys<br> <p> This class replaces smileys tags with smiley images. <p> </td> </tr> <tr> <td align="left" valign="top"> <h4>public class Smileys </h4> This class replaces smileys tags with smiley images. <br> Useful for forums or guestbooks. <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.81 BETA - 2002/10/01 <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.81</td> <td>H.Rettinger</td> <td>_resetSmileys()</td> <td>2002/10/20</td> <td>error in if clause</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">int</td> <td align="left" valign="top" width="100%"><a href="#function_smileys()"><h4>smileys(String $url)</h4></a>Constructor</td> </tr> <tr> <td align="right" valign="top">String</td> <td align="left" valign="top" width="100%"><a href="#function_insertSmileys()"><h4>insertSmileys(String $str)</h4></a>Adds the smileys to a string</td> </tr> <tr> <td align="right" valign="top">Array</td> <td align="left" valign="top" width="100%"><a href="#function_getSmileys()"><h4>getSmileys()</h4></a>Returns all smileys</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">int</td> <td align="left" valign="top" width="100%"><a href="#function__resetSmileys()"><h4>_resetSmileys(String $url)</h4></a>Parses the smileys definition file</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">string</td> <td align="left" valign="top" width="100%"><a href="#variable_$error_message"><h4>$error_message</h4></a>The generated error messages, line feed seperated</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">array</td> <td align="left" valign="top" width="100%"><a href="#variable_$_smileys"><h4>$_smileys</h4></a>Contains the smiley information</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_smileys()"><h4>smileys</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public int smileys( String $url )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Constructor <br> Creates a new smileys class from the smiley definition <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">$url</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top">url to the smiley definition file</td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>int <p> -1 if 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_insertSmileys()"><h4>insertSmileys</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public String insertSmileys( String $str )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Adds the smileys to a string <br> Adds the html tags for each smiley code found <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">$str</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>String <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_getSmileys()"><h4>getSmileys</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public Array getSmileys( )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Returns all smileys <br> Returns an array of arrays. <p> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>Array <p>One entry contains the smiley tag, the image path, the width and the height.</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__resetSmileys()"><h4>_resetSmileys</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>private int _resetSmileys( String $url )</b><p> </td> </tr> <tr> <td width="10" align="left" valign="top"> </td> <td align="left" valign="top"> Parses the smileys definition file <br> Parses the smileys definition file into the _smileys array <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">$url</td> <td align="left" valign="top"><code></code></td> </tr> <tr> <td></td> <td colspan="2" align="left" valign="top">the smileys definition file</td> </tr> </table> </td> </tr> <tr> <td align="left" valign="top">Returns</td> <td>int <p> -1 if 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>Public Field Details</h2></td> </tr> <tr><td colspan="2" align="left" valign="top"><a name="variable_$error_message"><h4>$error_message</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>public string $error_message</b> <p> >><code>''</code><< <p> The generated error messages, line feed seperated <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_$_smileys"><h4>$_smileys</h4></a></td></tr> <tr> <td colspan="2" align="left" valign="top"> <b>private array $_smileys</b> <p> >><code>array()</code><< <p> Contains the smiley information <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>