D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
lampp
/
lib
/
php
/
doc
/
Net_SmartIRC
/
docs
/
HTML
/
Filename :
ric_README.html
back
Copy
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>PEAR API Documentation :: Net_SmartIRC</title> <link rel="stylesheet" href="media/style.css" /> <script language="javascript" type="text/javascript"> var subdir = ""; </script> <script src="media/lib/classTree.js"></script> <link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="media/lib/tab.webfx.css" /> <script type="text/javascript" src="media/lib/tabpane.js"></script> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> <script language="javascript" type="text/javascript" src="media/TreeMenu.js"></script> <script language="javascript" type="text/javascript" src="media/lib/ua.js"></script> <script language="javascript" type="text/javascript"> var imgPlus = new Image(); var imgMinus = new Image(); imgPlus.src = "media/images/plus.gif"; imgMinus.src = "media/images/minus.gif"; function showNode(Node){ switch(navigator.family){ case 'nn4': // Nav 4.x code fork... var oTable = document.layers["span" + Node]; var oImg = document.layers["img" + Node]; break; case 'ie4': // IE 4/5 code fork... var oTable = document.all["span" + Node]; var oImg = document.all["img" + Node]; break; case 'gecko': // Standards Compliant code fork... var oTable = document.getElementById("span" + Node); var oImg = document.getElementById("img" + Node); break; } oImg.src = imgMinus.src; oTable.style.display = "block"; } function hideNode(Node){ switch(navigator.family){ case 'nn4': // Nav 4.x code fork... var oTable = document.layers["span" + Node]; var oImg = document.layers["img" + Node]; break; case 'ie4': // IE 4/5 code fork... var oTable = document.all["span" + Node]; var oImg = document.all["img" + Node]; break; case 'gecko': // Standards Compliant code fork... var oTable = document.getElementById("span" + Node); var oImg = document.getElementById("img" + Node); break; } oImg.src = imgPlus.src; oTable.style.display = "none"; } function nodeIsVisible(Node){ switch(navigator.family){ case 'nn4': // Nav 4.x code fork... var oTable = document.layers["span" + Node]; break; case 'ie4': // IE 4/5 code fork... var oTable = document.all["span" + Node]; break; case 'gecko': // Standards Compliant code fork... var oTable = document.getElementById("span" + Node); break; } return (oTable && oTable.style.display == "block"); } function toggleNodeVisibility(Node){ if (nodeIsVisible(Node)){ hideNode(Node); }else{ showNode(Node); } } </script> </head> <body topmargin="0" leftmargin="0" marginheight="0" marginwidth="0" bgcolor="#ffffff" text="#000000" link="#006600" alink="#cccc00" vlink="#003300" > <a name="TOP" /></a> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr bgcolor="#339900"> <td align="left" width="120"> <a href="http://pear.php.net"> <img src="media/images/pearlogo.gif" width="104" height="50" vspace="2" hspace="5" alt="PEAR" border="0"> </a> </td> <td align="left" valign="middle" width="20"> </td> <td align="left" valign="middle"> <span class="Headline">PEAR API Documentation :: Net_SmartIRC</span> </td> <td align="right" valign="bottom" class="upperright"> <a href="http://pear.php.net/package-info.php?package=Net_SmartIRC" class="upperright">Package Homepage</a> | <a href="http://pear.php.net/package-info.php?package=Net_SmartIRC" class="upperright">Download ApiDoc</a> <br> </td> </tr> <tr bgcolor="#003300"><td colspan="4"></td></tr> <tr bgcolor="#006600"> <td align="right" valign="top" colspan="4" class="menu"> [ <a href="classtrees_Net_SmartIRC.html" class="menu">class tree: Net_SmartIRC</a> ] [ <a href="elementindex_Net_SmartIRC.html" class="menu">index: Net_SmartIRC</a> ] [ <a href="elementindex.html" class="menu">all elements</a> ] <br /> </td> </tr> <tr bgcolor="#003300"><td colspan="4"></td></tr> </table> <table cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td bgcolor="#f0f0f0" width="100"> <table width="280" border="0" cellpadding="4" cellspacing="0"> <tr valign="top"> <td style="font-size: 90%" align="left" width="280"> <div id="ric"> <a href="ric_CHANGELOG.html">CHANGELOG</a><br /> <a href="ric_README.html">README</a><br /> </div> <br> <span class="green"><b>Packages:</b></span><br /> <ul> <li><a href="li_Net_SmartIRC.html">Net_SmartIRC</a></li> </ul> <br /><br /> <div class="menu"> <script language="Javascript"> if (document.getElementById) { var tree = new WebFXTree('Package : Net_SmartIRC', 'li_Net_SmartIRC.html'); tree.setBehavior('classic'); tree.openIcon = 'media/images/Disk.gif'; tree.icon = 'media/images/Disk.gif'; var elements = new WebFXTreeItem('Index of elements', 'elementindex_Net_SmartIRC.html'); elements.openIcon = 'media/images/file.png'; elements.icon = 'media/images/file.png'; tree.add(elements); var tree_function = new WebFXTreeItem('Function(s)', ''); tree_function.openIcon = 'media/images/Functions.gif'; tree_function.icon = 'media/images/Functions.gif'; tree.add(tree_function); var iconClassFolder = 'media/images/classFolder.gif'; var iconClass = 'media/images/Class.gif'; var iconFunctionFolder = 'media/images/Functions.gif'; var iconFunction = 'media/images/PublicMethod.gif'; var iconFileFolderOpen = 'media/images/FolderOpened.gif'; var iconFileFolderClosed = 'media/images/foldericon.png'; var iconFile = 'media/images/file.png'; var subpackagetree_classe = new WebFXTreeItem('Class(es)', 'classtrees_Net_SmartIRC.html'); subpackagetree_classe.openIcon = iconClassFolder;; subpackagetree_classe.icon = iconClassFolder; tree.add(subpackagetree_classe); var subpackagetree_classe = new WebFXTreeItem('File(s)', ''); subpackagetree_classe.openIcon = iconFileFolderOpen; subpackagetree_classe.icon = iconFileFolderClosed; tree.add(subpackagetree_classe); document.write(tree); } </script> </div> <noscript> <img src="media/images/Disk.gif" border="0" align="top"> <a href="li_Net_SmartIRC.html" class="green" ><span valign="middle" class="green">Package: Net_SmartIRC</span></a><br> <img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="elementindex_Net_SmartIRC.html" class="green" ><span valign="middle" class="green">Index of elements</span></a><br> <img src="media/images/T.png" border="0" align="top"><img src="media/images/Functions.gif" border="0" align="top"> <span valign="middle" class="green">Function(s)</span><br> <img src="media/images/Tminus.png" border="0" align="top"><img src="media/images/classFolder.gif" border="0" align="top"> <a href="classtrees_Net_SmartIRC.html" class="green" ><span valign="middle" class="green">Class(es)</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/mybot.html" class="green" ><span valign="middle" class="green">mybot</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC.html" class="green" ><span valign="middle" class="green">Net_SmartIRC</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_actionhandler.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_actionhandler</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_base.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_base</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_channel.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_channel</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_channeluser.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_channeluser</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_data.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_data</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_Error.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_Error</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_irccommands.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_irccommands</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_ircuser.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_ircuser</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_listenfor.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_listenfor</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_messagehandler.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_messagehandler</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_timehandler.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_timehandler</span></a><br> <img src="media/images/I.png" border="0" align="top"><img src="media/images/L.png" border="0" align="top"><img src="media/images/Class.gif" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/Net_SmartIRC_user.html" class="green" ><span valign="middle" class="green">Net_SmartIRC_user</span></a><br> <img src="media/images/Lminus.png" border="0" align="top"><img src="media/images/FolderOpened.gif" border="0" align="top"> <span valign="middle" class="green">File(s)</span><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_SmartIRC_defines_php.html" class="green" ><span valign="middle" class="green">defines.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_examples_example_php.html" class="green" ><span valign="middle" class="green">example.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_examples_example2_php.html" class="green" ><span valign="middle" class="green">example2.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_examples_example3_php.html" class="green" ><span valign="middle" class="green">example3.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_examples_example4_php.html" class="green" ><span valign="middle" class="green">example4.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_examples_example5_php.html" class="green" ><span valign="middle" class="green">example5.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_examples_example6_php.html" class="green" ><span valign="middle" class="green">example6.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_examples_example7_php.html" class="green" ><span valign="middle" class="green">example7.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_SmartIRC_irccommands_php.html" class="green" ><span valign="middle" class="green">irccommands.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/T.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_SmartIRC_messagehandler_php.html" class="green" ><span valign="middle" class="green">messagehandler.php</span></a><br> <img src="media/images/spacer2.gif" border="0" align="top"><img src="media/images/L.png" border="0" align="top"><img src="media/images/file.png" border="0" align="top"> <a href="{$subdir}Net_SmartIRC/_SmartIRC-0.5.5_SmartIRC_php.html" class="green" ><span valign="middle" class="green">SmartIRC.php</span></a><br> </noscript> </td> </tr> </table> </td> <td bgcolor="#cccccc" width="2" background="media/images/checkerboard.gif"><img src="media/images/spacer.gif" width="2" height="1" border="0" alt="" /><br /></td> <td> <table width="100%" cellpadding="10" cellspacing="0"> <tr> <td valign="top"> <h1 align="center">README</h1> <pre> /** * $Id: ric_README.html 135710 2003-07-23 18:08:55Z meebey $ * $Revision: 135710 $ * $Author: meebey $ * $Date: 2003-07-24 03:38:55 +0930 (Thu, 24 Jul 2003) $ */ Net_SmartIRC ---------------- What is this? Net_SmartIRC is a PHP class for communication with IRC networks, which conforms to the RFC 2812 (IRC Protocol). It's an API that handles all IRC protocol messages. It is designed for creating IRC bots, chats and show irc related info on webpages. Please report bugs to: http://sourceforge.net/tracker/?group_id=60664&atid=494859 Project Homepage: http://sourceforge.net/projects/phpsmartirc official PEAR package page: http://pear.php.net/package-info.php?package=Net_SmartIRC files included in SmartIRC -------------------------- SmartIRC.php The class itself. FEATURES A full list of features that SmartIRC includes CHANGELOG Listing of changes between all versions. README this file LICENSE The license of Net_SmartIRC. CREDITS Creditlist with people that work/help on Net_SmartIRC. SmartIRC/ defines.php Nessesary IRC related defines (IRC reply codes). messagehandler.php All defined messagehandler that SmartIRC currently uses for channelsynching and some other API handling. irccommands.php All supported IRC commands (like join/part/kick/etc..) docs/ DOCUMENTATION Appendix to the HTML documention for developers. HOWTO Mini howto with detailed information, step by step. HTML/ index.html the full documenation of SmartIRC examples/ example.php An example of how you can use this class for a mini php bot. example2.php This example shows how to display the amount of users in a specific IRC channel on your homepage. example3.php This bot echos the oplist if !ops is said on the channel. example4.php This bot checks all realnames of people that are on the channel and displays the result. example5.php This bot can kicks users when !kick NICKNAME is said on the channel. example6.php This example shows how an onjoin greeting can be done with SmartIRC. example7.php This is an example how timers can be used and how to unregister them. </pre> <div class="credit"> <hr /> Documentation generated on by <a href="http://www.phpdoc.org" class="green">phpDocumentor 1.2.0beta1c</a><br> HTML layout done by <a href="http://pear.php.net/wishlist.php/dickmann" class="green">Christian Dickmann</a> and originally <i>inspired by </i><a href="http://www.phpedit.com" class="green">PHPEdit</a><br> </div> </td> </tr> </table> </td> </tr> </table> </body> </html>