Changeset 57 for trunk/Phergie/README

Timestamp:

02/12/08 05:39:20 (5 years ago)

Author:

tobias382

Message:

* Removed _ convention from non-public class properties
* Converted static properties in plugins to instance properties
* Modified base event handler class to cache short name
* Removed event parameter in base event handler methods, added setEvent method
to be called by the driver, modified streams driver to use it, and updated
method declarations in existing plugins accordingly
* Moved Event/Handler? to Plugin and updated class names accordingly
* Changed Client/Driver? interface to Driver/Abstract? abstract class and updated
Bot accordingly
* Removed use of reflection API in Bot as it is not longer needed since abstract
plugin classes are not contained in the same directory as concrete plugin
classes
* Moved parseHostmask method from the streams driver to the abstract driver
* Consolidated connect and disconnect into run, removed isConnected, and added
enableDebugging and enableLogging in the streams and abstract driver classes
* Added automatic include_path updating to Bot and removed related instructions
for manually updating it from the README file
* Removed an unneeded argument from Event_Request::getArguments
* Created Plugin/Abstract? to store abstract plugin classes (this commit is an
intermediary step to rename contained files)

Files:

• trunk/Phergie/README (modified) (1 diff)

trunk/Phergie/README

@@ -22 +22 @@
 http://bluelyte.sytes.net/phergie.tar.gz
 
-Update the include_path setting in your php.ini file to include the path to 
-the directory containing the Phergie directory extracted from the tarball. 
-So, for example, if you decompressed the tarball in /home/matt, then add 
-that path to include_path.
-
-Also, make sure that register_argc_argv is enabled. It's often disabled in 
-CGI environments since it's generally only needed for CLI purposes. If you 
-have not run PHP from the command line before, it may be a good idea to read 
-the related manual section at the URL below.
+Make sure that register_argc_argv is enabled if you want to use a 
+configuration file that is not in the Phergie directory or is not named 
+phergie.ini. register_argc_argv is often disabled in CGI environments since 
+it's generally only needed for CLI purposes. If you have not run PHP from the 
+command line before, it may be a good idea to read the related manual section 
+at the URL below.
 
 http://us.php.net/manual/en/features.commandline.php
 
-Once you've made the necessary PHP configuration changes, navigate to the 
-Phergie directory. From there, open the phergie.ini file and update 
-configuration settings there as needed. Once finished, open up a command 
-prompt/terminal/shell. Execute the PHP interpreter in CLI mode and pass it  
-the filename Bot.php, as shown below.
+Once you've made any necessary PHP configuration changes, navigate to the 
+Phergie directory. From there, open your Phergie configuration file and 
+update configuration settings there as needed. Once finished, open up a 
+command prompt/terminal/shell. Execute the PHP interpreter in CLI mode and 
+pass it the filename Bot.php, as shown below.
 
 % php Bot.php