Element index for package Phergie
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ _ ]
_
- __call
- in file Request.php, method Phergie_Event_Request::__call()
Provides access to named parameters via virtual "getter" methods.
- __call
- in file Handler.php, method Phergie_Plugin_Handler::__call()
Proxies method calls to all plugins containing the called method.
- __call
- in file Abstract.php, method Phergie_Plugin_Abstract::__call()
Provides do* methods with signatures identical to those of Phergie_Driver_Abstract but that queue up events to be dispatched later.
- __construct
- in file Async.php, method Phergie_Process_Async::__construct()
Overrides the parent class to set the poll time.
- __construct
- in file Hostmask.php, method Phergie_Hostmask::__construct()
Constructor to initialize components of the hostmask.
- __construct
- in file Handler.php, method Phergie_Event_Handler::__construct()
Constructor to initialize the event queue.
- __construct
- in file Abstract.php, method Phergie_Process_Abstract::__construct()
Gets the required class refences from Phergie_Bot.
- __construct
- in file Handler.php, method Phergie_Plugin_Handler::__construct()
Constructor to initialize class properties and add the path for core plugins.
- __construct
- in file Autoload.php, method Phergie_Autoload::__construct()
Constructor to add the base Phergie path to the include_path.
- __construct
- in file Connection.php, method Phergie_Connection::__construct()
Constructor to initialize instance properties.
- __construct
- in file Console.php, method Phergie_Ui_Console::__construct()
Constructor to initialize object properties.
- __construct
- in file Handler.php, method Phergie_Connection_Handler::__construct()
Constructor to initialize storage for connections.
- __get
- in file Handler.php, method Phergie_Plugin_Handler::__get()
Allows plugin instances to be accessed as properties of the handler.
- __isset
- in file Handler.php, method Phergie_Plugin_Handler::__isset()
Allows plugin instances to be detected as properties of the handler.
- __toString
- in file Hostmask.php, method Phergie_Hostmask::__toString()
Returns the hostmask for the originating server or user.
- __unset
- in file Handler.php, method Phergie_Plugin_Handler::__unset()
Allows plugin instances to be removed as properties of handler.
top
top
top
c
- $code
- in file Response.php, variable Phergie_Event_Response::$code
Reply code sent by the server, which can be compared to the ERR_* and RPL_* constants
- $config
- in file Handler.php, variable Phergie_Plugin_Handler::$config
Phergie_Config instance that should be passed in to any plugin instantiated within the handler
- $config
- in file Bot.php, variable Phergie_Bot::$config
Current configuration instance
- $config
- in file Abstract.php, variable Phergie_Plugin_Abstract::$config
Current configuration handler
- $connection
- in file Abstract.php, variable Phergie_Plugin_Abstract::$connection
Current connection instance
- $connection
- in file Abstract.php, variable Phergie_Driver_Abstract::$connection
Currently active connection
- $connections
- in file Abstract.php, variable Phergie_Process_Abstract::$connections
Current connection handler instance
- $connections
- in file Bot.php, variable Phergie_Bot::$connections
Current connection handler instance
- $connections
- in file Handler.php, variable Phergie_Connection_Handler::$connections
Map of connections indexed by hostmask
- checkSetting
- in file Connection.php, method Phergie_Connection::checkSetting()
Emits an error related to a required connection setting does not have value set for it.
- clearEvents
- in file Handler.php, method Phergie_Event_Handler::clearEvents()
Clears the event queue.
- connect
- in file Streams.php, method Phergie_Driver_Streams::connect()
Establishes a socket connection, separatedly mainly to allow for stubbing during unit testing.
- console
- in file Console.php, method Phergie_Ui_Console::console()
Outputs a timestamped line to the console if console output is enabled.
- count
- in file Handler.php, method Phergie_Connection_Handler::count()
Returns the number of connections in the list.
- count
- in file Handler.php, method Phergie_Event_Handler::count()
Returns the number of events in the event queue
- count
- in file Handler.php, method Phergie_Plugin_Handler::count()
Returns the number of plugins contained within the handler.
- Config.php
- procedural page Config.php
- Connection.php
- procedural page Connection.php
- Command.php
- procedural page Command.php
- Console.php
- procedural page Console.php
top
d
- $description
- in file Response.php, variable Phergie_Event_Response::$description
Reply code description sent by the server.
- $driver
- in file Abstract.php, variable Phergie_Process_Abstract::$driver
Current driver instance
- $driver
- in file Bot.php, variable Phergie_Bot::$driver
Current driver instance
- doAction
- in file Abstract.php, method Phergie_Driver_Abstract::doAction()
Sends a CTCP ACTION (/me) command to a nick or channel.
- doAction
- in file Streams.php, method Phergie_Driver_Streams::doAction()
Sends a CTCP ACTION (/me) command to a nick or channel.
- doConnect
- in file Abstract.php, method Phergie_Driver_Abstract::doConnect()
Initiates a connection with the server.
- doConnect
- in file Streams.php, method Phergie_Driver_Streams::doConnect()
Initiates a connection with the server.
- doCtcp
- in file Streams.php, method Phergie_Driver_Streams::doCtcp()
Sends a CTCP response to a user.
- doFinger
- in file Abstract.php, method Phergie_Driver_Abstract::doFinger()
Sends a CTCP FINGER request to a user.
- doFinger
- in file Streams.php, method Phergie_Driver_Streams::doFinger()
Sends a CTCP FINGER request to a user.
- doInvite
- in file Abstract.php, method Phergie_Driver_Abstract::doInvite()
Invites a user to an invite-only channel.
- doInvite
- in file Streams.php, method Phergie_Driver_Streams::doInvite()
Invites a user to an invite-only channel.
- doJoin
- in file Abstract.php, method Phergie_Driver_Abstract::doJoin()
Joins a channel.
- doJoin
- in file Streams.php, method Phergie_Driver_Streams::doJoin()
Joins a channel.
- doKick
- in file Abstract.php, method Phergie_Driver_Abstract::doKick()
Kicks a user from a channel.
- doKick
- in file Streams.php, method Phergie_Driver_Streams::doKick()
Kicks a user from a channel.
- doList
- in file Abstract.php, method Phergie_Driver_Abstract::doList()
Obtains a list of channel names and topics.
- doList
- in file Streams.php, method Phergie_Driver_Streams::doList()
Obtains a list of channel names and topics.
- doMode
- in file Streams.php, method Phergie_Driver_Streams::doMode()
Retrieves or changes a channel or user mode.
- doMode
- in file Abstract.php, method Phergie_Driver_Abstract::doMode()
Retrieves or changes a channel or user mode.
- doNames
- in file Abstract.php, method Phergie_Driver_Abstract::doNames()
Obtains a list of nicks of users in specified channels.
- doNames
- in file Streams.php, method Phergie_Driver_Streams::doNames()
Obtains a list of nicks of usrs in currently joined channels.
- doNick
- in file Streams.php, method Phergie_Driver_Streams::doNick()
Changes the client nick.
- doNick
- in file Abstract.php, method Phergie_Driver_Abstract::doNick()
Changes the client nick.
- doNotice
- in file Streams.php, method Phergie_Driver_Streams::doNotice()
Sends a notice to a nick or channel.
- doNotice
- in file Abstract.php, method Phergie_Driver_Abstract::doNotice()
Sends a notice to a nick or channel.
- doPart
- in file Streams.php, method Phergie_Driver_Streams::doPart()
Leaves a channel.
- doPart
- in file Abstract.php, method Phergie_Driver_Abstract::doPart()
Leaves a channel.
- doPing
- in file Streams.php, method Phergie_Driver_Streams::doPing()
Sends a CTCP PING request or response (they are identical) to a user.
- doPing
- in file Abstract.php, method Phergie_Driver_Abstract::doPing()
Sends a CTCP PING request to a user.
- doPong
- in file Abstract.php, method Phergie_Driver_Abstract::doPong()
Responds to a server test of client responsiveness.
- doPong
- in file Streams.php, method Phergie_Driver_Streams::doPong()
Responds to a server test of client responsiveness.
- doPrivmsg
- in file Streams.php, method Phergie_Driver_Streams::doPrivmsg()
Sends a message to a nick or channel.
- doPrivmsg
- in file Abstract.php, method Phergie_Driver_Abstract::doPrivmsg()
Sends a message to a nick or channel.
- doQuit
- in file Abstract.php, method Phergie_Driver_Abstract::doQuit()
Terminates the connection with the server.
- doQuit
- in file Streams.php, method Phergie_Driver_Streams::doQuit()
Terminates the connection with the server.
- doRaw
- in file Streams.php, method Phergie_Driver_Streams::doRaw()
Sends a raw command to the server.
- doRaw
- in file Abstract.php, method Phergie_Driver_Abstract::doRaw()
Sends a raw command to the server.
- doTime
- in file Streams.php, method Phergie_Driver_Streams::doTime()
Sends a CTCP TIME request to a user.
- doTime
- in file Abstract.php, method Phergie_Driver_Abstract::doTime()
Sends a CTCP TIME request to a user.
- doTopic
- in file Abstract.php, method Phergie_Driver_Abstract::doTopic()
Retrieves or changes a channel topic.
- doTopic
- in file Streams.php, method Phergie_Driver_Streams::doTopic()
Retrieves or changes a channel topic.
- doVersion
- in file Streams.php, method Phergie_Driver_Streams::doVersion()
Sends a CTCP VERSION request or response to a user.
- doVersion
- in file Abstract.php, method Phergie_Driver_Abstract::doVersion()
Sends a CTCP VERSION request or response to a user.
- doWhois
- in file Streams.php, method Phergie_Driver_Streams::doWhois()
Retrieves information about a nick.
- doWhois
- in file Abstract.php, method Phergie_Driver_Abstract::doWhois()
Retrieves information about a nick.
top
e
- $enabled
- in file Console.php, variable Phergie_Ui_Console::$enabled
Flag that toggles all console output
- $encoding
- in file Connection.php, variable Phergie_Connection::$encoding
Encoding method for the connection, defaults to ISO-8859-1 but can be set to UTF8 if necessary
- $event
- in file Abstract.php, variable Phergie_Plugin_Abstract::$event
Current incoming event being handled
- $events
- in file Abstract.php, variable Phergie_Process_Abstract::$events
Current event handler instance
- $events
- in file Handler.php, variable Phergie_Plugin_Handler::$events
Phergie_Event_Handler instance that should be passed in to any plugin instantiated within the handler
- $events
- in file Handler.php, variable Phergie_Event_Handler::$events
Current queue of events
- $events
- in file Bot.php, variable Phergie_Bot::$events
Current event handler instance
- $events
- in file Abstract.php, variable Phergie_Plugin_Abstract::$events
Current event handler instance for outgoing events
- ERR_ALREADYREGISTRED
- in file Response.php, class constant Phergie_Event_Response::ERR_ALREADYREGISTRED
You may not reregister
- ERR_ARRAY_NOT_RETURNED
- in file Exception.php, class constant Phergie_Config_Exception::ERR_ARRAY_NOT_RETURNED
Error indicating that a read configuration file does not return an
- ERR_BADCHANNELKEY
- in file Response.php, class constant Phergie_Event_Response::ERR_BADCHANNELKEY
<channel> Cannot join channel (+k)
- ERR_BANNEDFROMCHAN
- in file Response.php, class constant Phergie_Event_Response::ERR_BANNEDFROMCHAN
<channel> Cannot join channel (+b)
- ERR_CANNOTSENDTOCHAN
- in file Response.php, class constant Phergie_Event_Response::ERR_CANNOTSENDTOCHAN
<channel name> Cannot send to channel
- ERR_CANTKILLSERVER
- in file Response.php, class constant Phergie_Event_Response::ERR_CANTKILLSERVER
You cant kill a server!
- ERR_CHANNELISFULL
- in file Response.php, class constant Phergie_Event_Response::ERR_CHANNELISFULL
<channel> Cannot join channel (+l)
- ERR_CHANOPRIVSNEEDED
- in file Response.php, class constant Phergie_Event_Response::ERR_CHANOPRIVSNEEDED
<channel> You're not channel operator
- ERR_CLASS_NOT_FOUND
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_CLASS_NOT_FOUND
Error indicating that an attempt was made to locate the class for a
- ERR_CLASS_NOT_INSTANTIABLE
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_CLASS_NOT_INSTANTIABLE
Error indicating that an attempt was made to locate the class for a
- ERR_CONNECTION_ATTEMPT_FAILED
- in file Exception.php, class constant Phergie_Driver_Exception::ERR_CONNECTION_ATTEMPT_FAILED
Error indicating that an attempt to initiate a connection failed
- ERR_CONNECTION_WRITE_FAILED
- in file Exception.php, class constant Phergie_Driver_Exception::ERR_CONNECTION_WRITE_FAILED
Error indicating that an attempt to send data via a connection failed
- ERR_DIRECTORY_NOT_READABLE
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_DIRECTORY_NOT_READABLE
Error indicating that a path containing plugins was specified, but
- ERR_ENCODING_NOT_SUPPORTED
- in file Exception.php, class constant Phergie_Connection_Exception::ERR_ENCODING_NOT_SUPPORTED
Error indicating that a connection is configured to use an encoding,
- ERR_ERRONEUSNICKNAME
- in file Response.php, class constant Phergie_Event_Response::ERR_ERRONEUSNICKNAME
<nick> Erroneus nickname
- ERR_FATAL_ERROR
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_FATAL_ERROR
Error indicating that a fatal runtime issue was encountered within a
- ERR_FILEERROR
- in file Response.php, class constant Phergie_Event_Response::ERR_FILEERROR
File error doing <file op> on <file>
- ERR_FILE_NOT_FOUND
- in file Exception.php, class constant Phergie_Config_Exception::ERR_FILE_NOT_FOUND
Error indicating that an attempt was made to read a configuration
- ERR_FILE_NOT_READABLE
- in file Exception.php, class constant Phergie_Config_Exception::ERR_FILE_NOT_READABLE
Error indicating that an attempt was made to read a configuration
- ERR_INCORRECT_BASE_CLASS
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_INCORRECT_BASE_CLASS
Error indicating that an attempt was made to locate the class for a
- ERR_INVALID_ARGUMENT
- in file Exception.php, class constant Phergie_Event_Exception::ERR_INVALID_ARGUMENT
Error indicating that an event argument was specified, but either no
- ERR_INVALID_CALL
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_INVALID_CALL
Error indicating that a call was made to a nonexistent plugin method
- ERR_INVALID_HOSTMASK
- in file Exception.php, class constant Phergie_Hostmask_Exception::ERR_INVALID_HOSTMASK
Error indicating that an invalid hostmask string was specified
- ERR_INVALID_ITERATOR_CLASS
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_INVALID_ITERATOR_CLASS
Error indicating that a class specified to be used for iterating
- ERR_INVALID_METHOD_CALL
- in file Exception.php, class constant Phergie_Event_Exception::ERR_INVALID_METHOD_CALL
Error indicating that an undefined method was called on an event
- ERR_INVITEONLYCHAN
- in file Response.php, class constant Phergie_Event_Response::ERR_INVITEONLYCHAN
<channel> Cannot join channel (+i)
- ERR_KEYSET
- in file Response.php, class constant Phergie_Event_Response::ERR_KEYSET
<channel> Channel key already set
- ERR_MISSING_HOSTMASK
- in file Exception.php, class constant Phergie_Event_Exception::ERR_MISSING_HOSTMASK
Error indicating that an operation requiring an event hostmask was
- ERR_NEEDMOREPARAMS
- in file Response.php, class constant Phergie_Event_Response::ERR_NEEDMOREPARAMS
<command> Not enough parameters
- ERR_NICKCOLLISION
- in file Response.php, class constant Phergie_Event_Response::ERR_NICKCOLLISION
<nick> Nickname collision KILL
- ERR_NICKNAMEINUSE
- in file Response.php, class constant Phergie_Event_Response::ERR_NICKNAMEINUSE
<nick> Nickname is already in use
- ERR_NOADMININFO
- in file Response.php, class constant Phergie_Event_Response::ERR_NOADMININFO
<server> No administrative info available
- ERR_NOLOGIN
- in file Response.php, class constant Phergie_Event_Response::ERR_NOLOGIN
<user> User not logged in
- ERR_NOMOTD
- in file Response.php, class constant Phergie_Event_Response::ERR_NOMOTD
MOTD File is missing
- ERR_NONICKNAMEGIVEN
- in file Response.php, class constant Phergie_Event_Response::ERR_NONICKNAMEGIVEN
No nickname given
- ERR_NOOPERHOST
- in file Response.php, class constant Phergie_Event_Response::ERR_NOOPERHOST
No O-lines for your host
- ERR_NOORIGIN
- in file Response.php, class constant Phergie_Event_Response::ERR_NOORIGIN
No origin specified
- ERR_NOPERMFORHOST
- in file Response.php, class constant Phergie_Event_Response::ERR_NOPERMFORHOST
Your host isn't among the privileged
- ERR_NOPRIVILEGES
- in file Response.php, class constant Phergie_Event_Response::ERR_NOPRIVILEGES
Permission Denied- You're not an IRC operator
- ERR_NORECIPIENT
- in file Response.php, class constant Phergie_Event_Response::ERR_NORECIPIENT
No recipient given (<command>)
- ERR_NOSUCHCHANNEL
- in file Response.php, class constant Phergie_Event_Response::ERR_NOSUCHCHANNEL
<channel name> No such channel
- ERR_NOSUCHNICK
- in file Response.php, class constant Phergie_Event_Response::ERR_NOSUCHNICK
<nickname> No such nick/channel
- ERR_NOSUCHSERVER
- in file Response.php, class constant Phergie_Event_Response::ERR_NOSUCHSERVER
<server name> No such server
- ERR_NOTEXTTOSEND
- in file Response.php, class constant Phergie_Event_Response::ERR_NOTEXTTOSEND
No text to send
- ERR_NOTONCHANNEL
- in file Response.php, class constant Phergie_Event_Response::ERR_NOTONCHANNEL
<channel> You're not on that channel
- ERR_NOTOPLEVEL
- in file Response.php, class constant Phergie_Event_Response::ERR_NOTOPLEVEL
<mask> No toplevel domain specified
- ERR_NOTREGISTERED
- in file Response.php, class constant Phergie_Event_Response::ERR_NOTREGISTERED
You have not registered
- ERR_NO_ACTIVE_CONNECTION
- in file Exception.php, class constant Phergie_Driver_Exception::ERR_NO_ACTIVE_CONNECTION
Error indicating that an operation was requested requiring an active
- ERR_NO_CONFIG_HANDLER
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_NO_CONFIG_HANDLER
Error indicating that an attempt was made to access the configuration
- ERR_NO_CONNECTION
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_NO_CONNECTION
Error indicating that an attempt was made to access the connection
- ERR_NO_EVENT
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_NO_EVENT
Error indicating that an attempt was made to access the current
- ERR_NO_EVENT_HANDLER
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_NO_EVENT_HANDLER
Error indicating that an attempt was made to access the event
- ERR_NO_PLUGIN_HANDLER
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_NO_PLUGIN_HANDLER
Error indicating that an attempt was made to access the plugin
- ERR_PASSWDMISMATCH
- in file Response.php, class constant Phergie_Event_Response::ERR_PASSWDMISMATCH
Password incorrect
- ERR_PLUGIN_NOT_LOADED
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_PLUGIN_NOT_LOADED
Error indicating that an attempt was made to access a plugin that had
- ERR_REQUIRED_SETTING_MISSING
- in file Exception.php, class constant Phergie_Connection_Exception::ERR_REQUIRED_SETTING_MISSING
Error indicating that an operation was attempted requiring a value
- ERR_REQUIREMENT_UNSATISFIED
- in file Exception.php, class constant Phergie_Plugin_Exception::ERR_REQUIREMENT_UNSATISFIED
Error indicating that a dependency of the plugin was unavailable at
- ERR_SUMMONDISABLED
- in file Response.php, class constant Phergie_Event_Response::ERR_SUMMONDISABLED
SUMMON has been disabled
- ERR_TOOMANYCHANNELS
- in file Response.php, class constant Phergie_Event_Response::ERR_TOOMANYCHANNELS
<channel name> You have joined too many channels
- ERR_TOOMANYTARGETS
- in file Response.php, class constant Phergie_Event_Response::ERR_TOOMANYTARGETS
<target> Duplicate recipients. No message delivered
- ERR_TRANSPORT_NOT_SUPPORTED
- in file Exception.php, class constant Phergie_Connection_Exception::ERR_TRANSPORT_NOT_SUPPORTED
Error indicating that a connection is configured to use a transport,
- ERR_UMODEUNKNOWNFLAG
- in file Response.php, class constant Phergie_Event_Response::ERR_UMODEUNKNOWNFLAG
Unknown MODE flag
- ERR_UNKNOWNCOMMAND
- in file Response.php, class constant Phergie_Event_Response::ERR_UNKNOWNCOMMAND
<command> Unknown command
- ERR_UNKNOWNMODE
- in file Response.php, class constant Phergie_Event_Response::ERR_UNKNOWNMODE
<char> is unknown mode char to me
- ERR_UNKNOWN_EVENT_TYPE
- in file Exception.php, class constant Phergie_Event_Exception::ERR_UNKNOWN_EVENT_TYPE
Error indicating that an attempt was made to create an event of an
- ERR_USERNOTINCHANNEL
- in file Response.php, class constant Phergie_Event_Response::ERR_USERNOTINCHANNEL
<nick> <channel> They aren't on that channel
- ERR_USERONCHANNEL
- in file Response.php, class constant Phergie_Event_Response::ERR_USERONCHANNEL
<user> <channel> is already on channel
- ERR_USERSDISABLED
- in file Response.php, class constant Phergie_Event_Response::ERR_USERSDISABLED
USERS has been disabled
- ERR_USERSDONTMATCH
- in file Response.php, class constant Phergie_Event_Response::ERR_USERSDONTMATCH
Cant change mode for other users
- ERR_WASNOSUCHNICK
- in file Response.php, class constant Phergie_Event_Response::ERR_WASNOSUCHNICK
<nickname> There was no such nickname
- ERR_WILDTOPLEVEL
- in file Response.php, class constant Phergie_Event_Response::ERR_WILDTOPLEVEL
<mask> Wildcard in toplevel domain
- ERR_YOUREBANNEDCREEP
- in file Response.php, class constant Phergie_Event_Response::ERR_YOUREBANNEDCREEP
You are banned from this server
- Exception.php
- procedural page Exception.php
- Exception.php
- procedural page Exception.php
- Exception.php
- procedural page Exception.php
- Exception.php
- procedural page Exception.php
- Exception.php
- procedural page Exception.php
- Exception.php
- procedural page Exception.php
- Exception.php
- procedural page Exception.php
- Exception.php
- procedural page Exception.php
top
f
- $files
- in file Config.php, variable Phergie_Config::$files
Mapping of configuration file paths to an array of names of settings they contain
- $format
- in file Console.php, variable Phergie_Ui_Console::$format
Format for timestamps included in console output
- fail
- in file Abstract.php, method Phergie_Plugin_Abstract::fail()
Indicates that the plugin failed to load due to an unsatisfied runtime requirement, such as a missing dependency.
- fromString
- in file Hostmask.php, method Phergie_Hostmask::fromString()
Parses a string containing the entire hostmask into a new instance of this class.
top
g
- getActiveReadSockets
- in file Streams.php, method Phergie_Driver_Streams::getActiveReadSockets()
Returns a list of hostmasks corresponding to sockets with data to read.
- getArgument
- in file Request.php, method Phergie_Event_Request::getArgument()
Returns a single specified argument for the request.
- getArgumentMapping
- in file Request.php, method Phergie_Event_Request::getArgumentMapping()
Returns a mapping of commands to their respective arguments.
- getArguments
- in file Request.php, method Phergie_Event_Request::getArguments()
Returns the arguments for the request.
- getAutoload
- in file Handler.php, method Phergie_Plugin_Handler::getAutoload()
Returns the value of a flag used to determine whether plugins should be loaded automatically if they have not been explicitly loaded.
- getCode
- in file Response.php, method Phergie_Event_Response::getCode()
Returns the reply code sent by the server.
- getConfig
- in file Abstract.php, method Phergie_Plugin_Abstract::getConfig()
Returns the current configuration handler or the value of a single setting from it.
- getConfig
- in file Bot.php, method Phergie_Bot::getConfig()
Returns the entire configuration in use or the value of a specific configuration setting.
- getConnection
- in file Abstract.php, method Phergie_Plugin_Abstract::getConnection()
Returns the current event connection.
- getConnection
- in file Abstract.php, method Phergie_Driver_Abstract::getConnection()
Returns the currently active connection.
- getConnectionHandler
- in file Bot.php, method Phergie_Bot::getConnectionHandler()
Returns a connection handler instance, creating it if it does not already exist and using a default class if none has been set.
- getConnections
- in file Handler.php, method Phergie_Connection_Handler::getConnections()
Returns a list of specified connection objects.
- getDescription
- in file Response.php, method Phergie_Event_Response::getDescription()
Returns the reply code description sent by the server.
- getDriver
- in file Bot.php, method Phergie_Bot::getDriver()
Returns a driver instance, creating one of the default class if none has been set.
- getEncoding
- in file Connection.php, method Phergie_Connection::getEncoding()
Returns the encoding in use by the connection.
- getEvent
- in file Abstract.php, method Phergie_Driver_Abstract::getEvent()
Returns an event if one has been received from the server.
- getEvent
- in file Streams.php, method Phergie_Driver_Streams::getEvent()
Listens for an event on the current connection.
- getEvent
- in file Abstract.php, method Phergie_Plugin_Abstract::getEvent()
Returns the current incoming event to be handled.
- getEventHandler
- in file Abstract.php, method Phergie_Plugin_Abstract::getEventHandler()
Returns the current event handler.
- getEventHandler
- in file Bot.php, method Phergie_Bot::getEventHandler()
Returns an event handler instance, creating it if it does not already exist and using a default class if none has been set.
- getEvents
- in file Handler.php, method Phergie_Event_Handler::getEvents()
Returns the current event queue.
- getEventsOfType
- in file Handler.php, method Phergie_Event_Handler::getEventsOfType()
Returns a list of events of a specified type.
- getFormat
- in file Console.php, method Phergie_Ui_Console::getFormat()
Returns the format used for timestamps in console output.
- getHost
- in file Connection.php, method Phergie_Connection::getHost()
Returns the host to which the client will connect if it is set or emits an error if it is not set.
- getHost
- in file Hostmask.php, method Phergie_Hostmask::getHost()
Returns the hostname.
- getHostmask
- in file Request.php, method Phergie_Event_Request::getHostmask()
Returns the hostmask representing the originating user.
- getHostmask
- in file Connection.php, method Phergie_Connection::getHostmask()
Returns a hostmask that uniquely identifies the connection.
- getIterator
- in file Handler.php, method Phergie_Event_Handler::getIterator()
Returns an iterator for the current event queue.
- getIterator
- in file Handler.php, method Phergie_Connection_Handler::getIterator()
Returns an iterator for the connection list.
- getIterator
- in file Handler.php, method Phergie_Plugin_Handler::getIterator()
Returns an iterator for all currently loaded plugin instances.
- getName
- in file Abstract.php, method Phergie_Plugin_Abstract::getName()
Returns the short name for the plugin based on its class name.
- getNick
- in file Request.php, method Phergie_Event_Request::getNick()
Returns the nick of the user who originated the event.
- getNick
- in file Hostmask.php, method Phergie_Hostmask::getNick()
Returns the nick of the user.
- getNick
- in file Connection.php, method Phergie_Connection::getNick()
Returns the nick that the client will use.
- getPassword
- in file Connection.php, method Phergie_Connection::getPassword()
Returns the password that the client will use.
- getPlugin
- in file Command.php, method Phergie_Event_Command::getPlugin()
Returns a reference to the plugin instance that created the event.
- getPlugin
- in file Handler.php, method Phergie_Plugin_Handler::getPlugin()
Returns the corresponding instance for a specified plugin, loading it if it is not already loaded and autoloading is enabled.
- getPluginHandler
- in file Bot.php, method Phergie_Bot::getPluginHandler()
Returns a plugin handler instance, creating it if it does not already exist and using a default class if none has been set.
- getPluginHandler
- in file Abstract.php, method Phergie_Plugin_Abstract::getPluginHandler()
Returns the current plugin handler.
- getPluginInfo
- in file Handler.php, method Phergie_Plugin_Handler::getPluginInfo()
Returns metadata corresponding to a specified plugin.
- getPlugins
- in file Handler.php, method Phergie_Plugin_Handler::getPlugins()
Returns the corresponding instances for multiple specified plugins, loading them if they are not already loaded and autoloading is enabled.
- getPort
- in file Connection.php, method Phergie_Connection::getPort()
Returns the port on which the client will connect.
- getProcessor
- in file Bot.php, method Phergie_Bot::getProcessor()
Returns a processer instance, creating one if none exists.
- getRawData
- in file Request.php, method Phergie_Event_Request::getRawData()
Returns the raw buffer sent from the server for the event.
- getRawData
- in file Response.php, method Phergie_Event_Response::getRawData()
Returns the raw buffer that was sent from the server for that event
- getRealname
- in file Connection.php, method Phergie_Connection::getRealname()
Returns the realname that the client will use.
- getSource
- in file Request.php, method Phergie_Event_Request::getSource()
Returns the channel name if the event occurred in a channel or the user nick if the event was a private message directed at the bot by a user.
- getTimeout
- in file Streams.php, method Phergie_Driver_Streams::getTimeout()
Returns the amount of time to wait for a new event each time the socket is polled.
- getTransport
- in file Connection.php, method Phergie_Connection::getTransport()
Returns the transport in use by the connection.
- getType
- in file Abstract.php, method Phergie_Event_Abstract::getType()
Returns the event type.
- getUi
- in file Bot.php, method Phergie_Bot::getUi()
Returns an end-user interface instance, creating it if it does not already exist and using a default class if none has been set.
- getUsername
- in file Connection.php, method Phergie_Connection::getUsername()
Returns the username that the client will use.
- getUsername
- in file Hostmask.php, method Phergie_Hostmask::getUsername()
Returns the username of the user.
top
h
- $host
- in file Hostmask.php, variable Phergie_Hostmask::$host
Host
- $host
- in file Connection.php, variable Phergie_Connection::$host
Host to which the client will connect
- $hostmask
- in file Request.php, variable Phergie_Event_Request::$hostmask
Hostmask representing the originating user, if applicable
- $hostmask
- in file Connection.php, variable Phergie_Connection::$hostmask
Hostmask for the connection
- handleEvents
- in file Abstract.php, method Phergie_Process_Abstract::handleEvents()
Obtains and processes incoming events.
- handleEvents
- in file Standard.php, method Phergie_Process_Standard::handleEvents()
Obtains and processes incoming events, then sends resulting outgoing events.
- handleEvents
- in file Async.php, method Phergie_Process_Async::handleEvents()
Waits for stream activity and performs event processing on connections with data to read.
- hasEventOfType
- in file Handler.php, method Phergie_Event_Handler::hasEventOfType()
Returns whether an event of the given type exists in the queue.
- hasPlugin
- in file Handler.php, method Phergie_Plugin_Handler::hasPlugin()
Returns whether or not at least one instance of a specified plugin class is loaded.
- Handler.php
- procedural page Handler.php
- Handler.php
- procedural page Handler.php
- Hostmask.php
- procedural page Hostmask.php
- Handler.php
- procedural page Handler.php
top
top
top
top
top
o
- $options
- in file Abstract.php, variable Phergie_Process_Abstract::$options
List of arguments for use within the instance
- offsetExists
- in file Config.php, method Phergie_Config::offsetExists()
Checks to see if a configuration setting is assigned a value.
- offsetExists
- in file Request.php, method Phergie_Event_Request::offsetExists()
Checks to see if an event argument is assigned a value.
- offsetGet
- in file Request.php, method Phergie_Event_Request::offsetGet()
Returns the value of an event argument.
- offsetGet
- in file Config.php, method Phergie_Config::offsetGet()
Returns the value of a configuration setting.
- offsetSet
- in file Config.php, method Phergie_Config::offsetSet()
Sets the value of a configuration setting.
- offsetSet
- in file Request.php, method Phergie_Event_Request::offsetSet()
Sets the value of an event argument.
- offsetUnset
- in file Request.php, method Phergie_Event_Request::offsetUnset()
Removes the value set for an event argument.
- offsetUnset
- in file Config.php, method Phergie_Config::offsetUnset()
Removes the value set for a configuration setting.
- onAction
- in file Abstract.php, method Phergie_Plugin_Abstract::onAction()
Handler for when the bot receives a CTCP ACTION request.
- onCommand
- in file Abstract.php, method Phergie_Ui_Abstract::onCommand()
Handler for when the bot sends a command to a server.
- onCommand
- in file Console.php, method Phergie_Ui_Console::onCommand()
Outputs a prompt when the bot sends a command to a server.
- onConnect
- in file Abstract.php, method Phergie_Ui_Abstract::onConnect()
Handler for when a server connection is attempted.
- onConnect
- in file Abstract.php, method Phergie_Plugin_Abstract::onConnect()
Handler for when the bot initially connects to a server.
- onConnect
- in file Console.php, method Phergie_Ui_Console::onConnect()
Outputs a prompt when a server connection is attempted.
- onCtcp
- in file Abstract.php, method Phergie_Plugin_Abstract::onCtcp()
Handler for when the bot receives a CTCP request of an unknown type.
- onCtcpPing
- in file Abstract.php, method Phergie_Plugin_Abstract::onCtcpPing()
Handler for when the bot receives a CTCP PING request.
- onCtcpReply
- in file Abstract.php, method Phergie_Plugin_Abstract::onCtcpReply()
Handler for when a reply received for a CTCP request of an unknown type.
- onEvent
- in file Console.php, method Phergie_Ui_Console::onEvent()
Outputs a prompt when the bot receives an IRC event.
- onEvent
- in file Abstract.php, method Phergie_Ui_Abstract::onEvent()
Handler for when the bot receives an IRC event.
- onInvite
- in file Abstract.php, method Phergie_Plugin_Abstract::onInvite()
Handler for when the bot receives an invitation to join a channel.
- onJoin
- in file Abstract.php, method Phergie_Plugin_Abstract::onJoin()
Handler for when a user joins a channel.
- onKick
- in file Abstract.php, method Phergie_Plugin_Abstract::onKick()
Handler for when a user is kicked from a channel.
- onKill
- in file Abstract.php, method Phergie_Plugin_Abstract::onKill()
Handler for when the bot receives a kill request from a server.
- onLoad
- in file Abstract.php, method Phergie_Plugin_Abstract::onLoad()
Handler for when the plugin is initially loaded - useful for checking runtime dependencies or performing any setup necessary for the plugin to function properly such as initializing a database.
- onMode
- in file Abstract.php, method Phergie_Plugin_Abstract::onMode()
Handler for when a user or channel mode is changed.
- onNick
- in file Abstract.php, method Phergie_Plugin_Abstract::onNick()
Handler for when the server prompts the client for a nick.
- onNotice
- in file Abstract.php, method Phergie_Plugin_Abstract::onNotice()
Handler for when a notice is received.
- onOper
- in file Abstract.php, method Phergie_Plugin_Abstract::onOper()
Handler for when a user obtains operator privileges.
- onPart
- in file Abstract.php, method Phergie_Plugin_Abstract::onPart()
Handler for when a user leaves a channel.
- onPing
- in file Abstract.php, method Phergie_Plugin_Abstract::onPing()
Handler for when the bot receives a ping event from a server, at which point it is expected to respond with a pong request within a short period else the server may terminate its connection.
- onPingReply
- in file Abstract.php, method Phergie_Plugin_Abstract::onPingReply()
Handler for when a reply is received for a CTCP PING request sent by the bot.
- onPluginFailure
- in file Console.php, method Phergie_Ui_Console::onPluginFailure()
Outputs a prompt when a plugin fails to load.
- onPluginFailure
- in file Abstract.php, method Phergie_Ui_Abstract::onPluginFailure()
Handler for when a plugin fails to load.
- onPluginLoad
- in file Console.php, method Phergie_Ui_Console::onPluginLoad()
Outputs a prompt when a plugin is loaded successfully.
- onPluginLoad
- in file Abstract.php, method Phergie_Ui_Abstract::onPluginLoad()
Handler for when an attempt is made to load a plugin.
- onPrivmsg
- in file Abstract.php, method Phergie_Plugin_Abstract::onPrivmsg()
Handler for when a message is received from a channel or user.
- onQuit
- in file Console.php, method Phergie_Ui_Console::onQuit()
Outputs a prompt when the bot terminates a connection to a server.
- onQuit
- in file Abstract.php, method Phergie_Plugin_Abstract::onQuit()
Handler for when the client session is about to be terminated.
- onQuit
- in file Abstract.php, method Phergie_Ui_Abstract::onQuit()
Handler for when the bot terminates a connection to a server.
- onResponse
- in file Abstract.php, method Phergie_Plugin_Abstract::onResponse()
Handler for when a server response is received to a command issued by the bot.
- onShutdown
- in file Abstract.php, method Phergie_Ui_Abstract::onShutdown()
Handler for when the bot shuts down after terminating all server connections.
- onShutdown
- in file Console.php, method Phergie_Ui_Console::onShutdown()
Outputs a prompt when the bot shuts down after terminating all server connections.
- onTick
- in file Abstract.php, method Phergie_Plugin_Abstract::onTick()
Handler for each tick, a single iteration of the continuous loop executed by the bot to receive, handle, and send events - useful for repeated execution of tasks on a time interval.
- onTime
- in file Abstract.php, method Phergie_Plugin_Abstract::onTime()
Handler for when the bot receives a CTCP TIME request.
- onTimeReply
- in file Abstract.php, method Phergie_Plugin_Abstract::onTimeReply()
Handler for when a reply is received for a CTCP TIME request sent by the bot.
- onTopic
- in file Abstract.php, method Phergie_Plugin_Abstract::onTopic()
Handler for when a channel topic is viewed or changed.
- onVersion
- in file Abstract.php, method Phergie_Plugin_Abstract::onVersion()
Handler for when the bot receives a CTCP VERSION request.
- onVersionReply
- in file Abstract.php, method Phergie_Plugin_Abstract::onVersionReply()
Handler for when a reply is received for a CTCP VERSION request sent by the bot.
top
p
- $password
- in file Connection.php, variable Phergie_Connection::$password
Password that the client will use
- $paths
- in file Handler.php, variable Phergie_Plugin_Handler::$paths
Paths in which to search for plugin class files
- $plugin
- in file Command.php, variable Phergie_Event_Command::$plugin
Reference to the plugin instance that created the event
- $plugins
- in file Bot.php, variable Phergie_Bot::$plugins
Current plugin handler instance
- $plugins
- in file Handler.php, variable Phergie_Plugin_Handler::$plugins
Current list of plugin instances
- $plugins
- in file Abstract.php, variable Phergie_Plugin_Abstract::$plugins
Plugin handler used to provide access to other plugins
- $plugins
- in file Abstract.php, variable Phergie_Process_Abstract::$plugins
Current plugin handler instance
- $port
- in file Connection.php, variable Phergie_Connection::$port
Port on which the client will connect, defaults to the standard IRC port
- $processor
- in file Bot.php, variable Phergie_Bot::$processor
Current processor instance
- parseArguments
- in file Streams.php, method Phergie_Driver_Streams::parseArguments()
Supporting method to parse event argument strings where the last argument may contain a colon.
- phergie.php
- procedural page phergie.php
- Phergie_Autoload
- in file Autoload.php, class Phergie_Autoload
Autoloader for Phergie classes.
- Phergie_Bot
- in file Bot.php, class Phergie_Bot
Composite class for other components to represent the bot.
- Phergie_Config
- in file Config.php, class Phergie_Config
Reads from and writes to PHP configuration files and provides access to the settings they contain.
- Phergie_Config_Exception
- in file Exception.php, class Phergie_Config_Exception
Exception related to configuration.
- Phergie_Connection
- in file Connection.php, class Phergie_Connection
Data structure for connection metadata.
- Phergie_Connection_Exception
- in file Exception.php, class Phergie_Connection_Exception
Exception related to a connection to an IRC server.
- Phergie_Connection_Handler
- in file Handler.php, class Phergie_Connection_Handler
Handles connections initiated by the bot.
- Phergie_Driver_Abstract
- in file Abstract.php, class Phergie_Driver_Abstract
Base class for drivers which handle issuing client commands to the IRC server and converting responses into usable data objects.
- Phergie_Driver_Exception
- in file Exception.php, class Phergie_Driver_Exception
Exception related to driver operations.
- Phergie_Driver_Streams
- in file Streams.php, class Phergie_Driver_Streams
Driver that uses the sockets wrapper of the streams extension for communicating with the server and handles formatting and parsing of events using PHP.
- Phergie_Event_Abstract
- in file Abstract.php, class Phergie_Event_Abstract
Base class for events.
- Phergie_Event_Command
- in file Command.php, class Phergie_Event_Command
Event originating from a plugin for the bot.
- Phergie_Event_Exception
- in file Exception.php, class Phergie_Event_Exception
Exception related to outgoing events.
- Phergie_Event_Handler
- in file Handler.php, class Phergie_Event_Handler
Handles events initiated by plugins.
- Phergie_Event_Request
- in file Request.php, class Phergie_Event_Request
Autonomous event originating from a user or the server.
- Phergie_Event_Response
- in file Response.php, class Phergie_Event_Response
Event originating from the server in response to an event sent by the current client.
- Phergie_Exception
- in file Exception.php, class Phergie_Exception
Base class for all Phergie-related exceptions.
- Phergie_Hostmask
- in file Hostmask.php, class Phergie_Hostmask
Data structure for a hostmask.
- Phergie_Hostmask_Exception
- in file Exception.php, class Phergie_Hostmask_Exception
Exception related to hostmask handling.
- Phergie_Plugin_Abstract
- in file Abstract.php, class Phergie_Plugin_Abstract
Base class for plugins to provide event handler stubs and commonly needed functionality.
- Phergie_Plugin_Exception
- in file Exception.php, class Phergie_Plugin_Exception
Exception related to plugin handling.
- Phergie_Plugin_Handler
- in file Handler.php, class Phergie_Plugin_Handler
Handles on-demand loading of, iteration over, and access to plugins.
- Phergie_Process_Abstract
- in file Abstract.php, class Phergie_Process_Abstract
Base class for obtaining and processing incoming events.
- Phergie_Process_Async
- in file Async.php, class Phergie_Process_Async
Connection data processor which polls to handle input in an asynchronous manner. Will also cause the application tick at the user-defined wait time.
- Phergie_Process_Exception
- in file Exception.php, class Phergie_Process_Exception
Exception related to event processor operations.
- Phergie_Process_Standard
- in file Standard.php, class Phergie_Process_Standard
Connection data processor which reads all connections looking for a response.
- Phergie_Ui_Abstract
- in file Abstract.php, class Phergie_Ui_Abstract
Base class for end-user interfaces.
- Phergie_Ui_Console
- in file Console.php, class Phergie_Ui_Console
End-user interface that produces console output when running the bot from a shell.
- postDispatch
- in file Abstract.php, method Phergie_Plugin_Abstract::postDispatch()
Handler for after any events triggered by plugins in response to a received event are sent to the server.
- preDispatch
- in file Abstract.php, method Phergie_Plugin_Abstract::preDispatch()
Handler for after plugin processing of an event has concluded but before any events triggered in response by plugins are sent to the server - useful for modifying outgoing events before they are sent.
- preEvent
- in file Abstract.php, method Phergie_Plugin_Abstract::preEvent()
Handler for when any event is received but has not yet been dispatched to the plugin handler method specific to its event type.
- processEvents
- in file Abstract.php, method Phergie_Process_Abstract::processEvents()
Sends resulting outgoing events from earlier processing in handleEvents().
top
r
- $rawData
- in file Request.php, variable Phergie_Event_Request::$rawData
Raw data sent by the server
- $rawData
- in file Response.php, variable Phergie_Event_Response::$rawData
Raw data sent by the server
- $realname
- in file Connection.php, variable Phergie_Connection::$realname
Realname that the client will use
- $regex
- in file Hostmask.php, variable Phergie_Hostmask::$regex
Regular expression used to parse a hostmask
- Request.php
- procedural page Request.php
- Response.php
- procedural page Response.php
- read
- in file Config.php, method Phergie_Config::read()
Includes a specified PHP configuration file and incorporates its return value (which should be an associative array) into the current configuration settings.
- readArray
- in file Config.php, method Phergie_Config::readArray()
Merges an associative array of configuration setting values into the current configuration settings.
- registerAutoloader
- in file Autoload.php, method Phergie_Autoload::registerAutoloader()
Registers an instance of this class as an autoloader.
- removeArgument
- in file Request.php, method Phergie_Event_Request::removeArgument()
Removes an argument value from the request.
- removeConnection
- in file Handler.php, method Phergie_Connection_Handler::removeConnection()
Removes a connection from the connection list.
- removeEvent
- in file Handler.php, method Phergie_Event_Handler::removeEvent()
Removes a single event from the event queue.
- removePlugin
- in file Handler.php, method Phergie_Plugin_Handler::removePlugin()
Removes a plugin instance from the handler.
- replaceEvents
- in file Handler.php, method Phergie_Event_Handler::replaceEvents()
Replaces the current event queue with a given queue of events.
- resolveArgument
- in file Request.php, method Phergie_Event_Request::resolveArgument()
Resolves an argument specification to an integer position.
- RPL_ADMINEMAIL
- in file Response.php, class constant Phergie_Event_Response::RPL_ADMINEMAIL
<admin info>
- RPL_ADMINLOC1
- in file Response.php, class constant Phergie_Event_Response::RPL_ADMINLOC1
<admin info>
- RPL_ADMINLOC2
- in file Response.php, class constant Phergie_Event_Response::RPL_ADMINLOC2
<admin info>
- RPL_ADMINME
- in file Response.php, class constant Phergie_Event_Response::RPL_ADMINME
<server> Administrative info
- RPL_AWAY
- in file Response.php, class constant Phergie_Event_Response::RPL_AWAY
<nick> <away message>
- RPL_BANLIST
- in file Response.php, class constant Phergie_Event_Response::RPL_BANLIST
<channel> <banid>
- RPL_CHANNELMODEIS
- in file Response.php, class constant Phergie_Event_Response::RPL_CHANNELMODEIS
<channel> <mode> <mode params>
- RPL_ENDOFBANLIST
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFBANLIST
<channel> End of channel ban list
- RPL_ENDOFINFO
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFINFO
End of /INFO list
- RPL_ENDOFLINKS
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFLINKS
<mask> End of /LINKS list
- RPL_ENDOFMOTD
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFMOTD
End of /MOTD command
- RPL_ENDOFNAMES
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFNAMES
<channel> End of /NAMES list
- RPL_ENDOFSTATS
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFSTATS
<stats letter> End of /STATS report
- RPL_ENDOFUSERS
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFUSERS
End of users
- RPL_ENDOFWHO
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFWHO
<name> End of /WHO list
- RPL_ENDOFWHOIS
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFWHOIS
<nick> End of /WHOIS list
- RPL_ENDOFWHOWAS
- in file Response.php, class constant Phergie_Event_Response::RPL_ENDOFWHOWAS
<nick> End of WHOWAS
- RPL_INFO
- in file Response.php, class constant Phergie_Event_Response::RPL_INFO
<string>
- RPL_INVITING
- in file Response.php, class constant Phergie_Event_Response::RPL_INVITING
<channel> <nick>
- RPL_ISON
- in file Response.php, class constant Phergie_Event_Response::RPL_ISON
[<nick> {<space><nick>}]
- RPL_LINKS
- in file Response.php, class constant Phergie_Event_Response::RPL_LINKS
<mask> <server> <hopcount> <server info>
- RPL_LIST
- in file Response.php, class constant Phergie_Event_Response::RPL_LIST
<channel> <# visible> <topic>
- RPL_LISTEND
- in file Response.php, class constant Phergie_Event_Response::RPL_LISTEND
End of /LIST
- RPL_LISTSTART
- in file Response.php, class constant Phergie_Event_Response::RPL_LISTSTART
Channel Users Name
- RPL_LUSERCHANNELS
- in file Response.php, class constant Phergie_Event_Response::RPL_LUSERCHANNELS
<integer> channels formed
- RPL_LUSERCLIENT
- in file Response.php, class constant Phergie_Event_Response::RPL_LUSERCLIENT
There are <integer> users and <integer> invisible on <integer> servers
- RPL_LUSERME
- in file Response.php, class constant Phergie_Event_Response::RPL_LUSERME
I have <integer> clients and <integer> servers
- RPL_LUSEROP
- in file Response.php, class constant Phergie_Event_Response::RPL_LUSEROP
<integer> operator(s) online
- RPL_LUSERUNKNOWN
- in file Response.php, class constant Phergie_Event_Response::RPL_LUSERUNKNOWN
<integer> unknown connection(s)
- RPL_MOTD
- in file Response.php, class constant Phergie_Event_Response::RPL_MOTD
- <text>
- RPL_MOTDSTART
- in file Response.php, class constant Phergie_Event_Response::RPL_MOTDSTART
- <server> Message of the day -
- RPL_NAMREPLY
- in file Response.php, class constant Phergie_Event_Response::RPL_NAMREPLY
<channel> [[@|+]<nick> [[@|+]<nick> [...]]]
- RPL_NONE
- in file Response.php, class constant Phergie_Event_Response::RPL_NONE
Dummy reply number. Not used.
- RPL_NOTOPIC
- in file Response.php, class constant Phergie_Event_Response::RPL_NOTOPIC
<channel> No topic is set
- RPL_NOUSERS
- in file Response.php, class constant Phergie_Event_Response::RPL_NOUSERS
Nobody logged in
- RPL_NOWAWAY
- in file Response.php, class constant Phergie_Event_Response::RPL_NOWAWAY
You have been marked as being away
- RPL_REHASHING
- in file Response.php, class constant Phergie_Event_Response::RPL_REHASHING
<config file> Rehashing
- RPL_STATSCLINE
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSCLINE
C <host> * <name> <port> <class>
- RPL_STATSCOMMANDS
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSCOMMANDS
<command> <count>
- RPL_STATSHLINE
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSHLINE
H <hostmask> * <servername>
- RPL_STATSILINE
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSILINE
I <host> * <host> <port> <class>
- RPL_STATSKLINE
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSKLINE
K <host> * <username> <port> <class>
- RPL_STATSLINKINFO
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSLINKINFO
<linkname> <sendq> <sent messages> <sent bytes> <received messages> <received
- RPL_STATSLLINE
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSLLINE
L <hostmask> * <servername> <maxdepth>
- RPL_STATSNLINE
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSNLINE
N <host> * <name> <port> <class>
- RPL_STATSOLINE
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSOLINE
O <hostmask> * <name>
- RPL_STATSUPTIME
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSUPTIME
Server Up %d days %d%02d%02d
- RPL_STATSYLINE
- in file Response.php, class constant Phergie_Event_Response::RPL_STATSYLINE
Y <class> <ping frequency> <connect frequency> <max sendq>
- RPL_SUMMONING
- in file Response.php, class constant Phergie_Event_Response::RPL_SUMMONING
<user> Summoning user to IRC
- RPL_TIME
- in file Response.php, class constant Phergie_Event_Response::RPL_TIME
<server> <string showing server's local time>
- RPL_TOPIC
- in file Response.php, class constant Phergie_Event_Response::RPL_TOPIC
<channel> <topic>
- RPL_TRACECONNECTING
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACECONNECTING
Try. <class> <server>
- RPL_TRACEHANDSHAKE
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACEHANDSHAKE
H.S. <class> <server>
- RPL_TRACELINK
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACELINK
Link <version & debug level> <destination> <next server>
- RPL_TRACELOG
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACELOG
File <logfile> <debug level>
- RPL_TRACENEWTYPE
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACENEWTYPE
<newtype> 0 <client name>
- RPL_TRACEOPERATOR
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACEOPERATOR
Oper <class> <nick>
- RPL_TRACESERVER
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACESERVER
Serv <class> <int>S <int>C <server> <nick!user|*!*>@<host|server>
- RPL_TRACEUNKNOWN
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACEUNKNOWN
???? <class> [<client IP address in dot form>]
- RPL_TRACEUSER
- in file Response.php, class constant Phergie_Event_Response::RPL_TRACEUSER
User <class> <nick>
- RPL_UMODEIS
- in file Response.php, class constant Phergie_Event_Response::RPL_UMODEIS
<user mode string>
- RPL_UNAWAY
- in file Response.php, class constant Phergie_Event_Response::RPL_UNAWAY
You are no longer marked as being away
- RPL_USERHOST
- in file Response.php, class constant Phergie_Event_Response::RPL_USERHOST
[<reply>{<space><reply>}]
- RPL_USERS
- in file Response.php, class constant Phergie_Event_Response::RPL_USERS
%-8s %-9s %-8s
- RPL_USERSSTART
- in file Response.php, class constant Phergie_Event_Response::RPL_USERSSTART
UserID Terminal Host
- RPL_VERSION
- in file Response.php, class constant Phergie_Event_Response::RPL_VERSION
<version>.<debuglevel> <server> <comments>
- RPL_WHOISCHANNELS
- in file Response.php, class constant Phergie_Event_Response::RPL_WHOISCHANNELS
<nick> {[@|+]<channel><space>}
- RPL_WHOISIDLE
- in file Response.php, class constant Phergie_Event_Response::RPL_WHOISIDLE
<nick> <integer> seconds idle
- RPL_WHOISOPERATOR
- in file Response.php, class constant Phergie_Event_Response::RPL_WHOISOPERATOR
<nick> is an IRC operator
- RPL_WHOISSERVER
- in file Response.php, class constant Phergie_Event_Response::RPL_WHOISSERVER
<nick> <server> <server info>
- RPL_WHOISUSER
- in file Response.php, class constant Phergie_Event_Response::RPL_WHOISUSER
<nick> <user> <host> * <real name>
- RPL_WHOREPLY
- in file Response.php, class constant Phergie_Event_Response::RPL_WHOREPLY
<channel> <user> <host> <server> <nick> <H|G>[*][@|+] <hopcount> <real name>
- RPL_WHOWASUSER
- in file Response.php, class constant Phergie_Event_Response::RPL_WHOWASUSER
<nick> <user> <host> * <real name>
- RPL_YOUREOPER
- in file Response.php, class constant Phergie_Event_Response::RPL_YOUREOPER
You are now an IRC operator
- run
- in file Bot.php, method Phergie_Bot::run()
Establishes server connections and initiates an execution loop to continuously receive and process events.
top
s
- $sec
- in file Async.php, variable Phergie_Process_Async::$sec
Length of time to poll for stream activity (seconds)
- $settings
- in file Config.php, variable Phergie_Config::$settings
Mapping of setting names to their current corresponding values
- $socket
- in file Streams.php, variable Phergie_Driver_Streams::$socket
Reference to the currently active socket handler
- $sockets
- in file Streams.php, variable Phergie_Driver_Streams::$sockets
Socket handlers
- Streams.php
- procedural page Streams.php
- Standard.php
- procedural page Standard.php
- send
- in file Streams.php, method Phergie_Driver_Streams::send()
Handles construction of command strings and their transmission to the server.
- setArgument
- in file Request.php, method Phergie_Event_Request::setArgument()
Sets the value of a single argument for the request.
- setArguments
- in file Request.php, method Phergie_Event_Request::setArguments()
Sets the arguments for the request.
- setAutoload
- in file Handler.php, method Phergie_Plugin_Handler::setAutoload()
Sets a flag used to determine whether plugins should be loaded automatically if they have not been explicitly loaded.
- setCode
- in file Response.php, method Phergie_Event_Response::setCode()
Sets the reply code sent by the server.
- setConfig
- in file Bot.php, method Phergie_Bot::setConfig()
Sets the configuration to use.
- setConfig
- in file Abstract.php, method Phergie_Plugin_Abstract::setConfig()
Sets the current configuration handler.
- setConnection
- in file Streams.php, method Phergie_Driver_Streams::setConnection()
Overrides the parent class to set the currently active socket handler when the active connection is changed.
- setConnection
- in file Abstract.php, method Phergie_Plugin_Abstract::setConnection()
Sets the current connection.
- setConnection
- in file Abstract.php, method Phergie_Driver_Abstract::setConnection()
Sets the currently active connection.
- setConnectionHandler
- in file Bot.php, method Phergie_Bot::setConnectionHandler()
Sets the connection handler instance to use.
- setDescription
- in file Response.php, method Phergie_Event_Response::setDescription()
Sets the reply code description sent by the server.
- setDriver
- in file Bot.php, method Phergie_Bot::setDriver()
Sets the driver instance to use.
- setEnabled
- in file Console.php, method Phergie_Ui_Console::setEnabled()
Sets whether console output is enabled.
- setEncoding
- in file Connection.php, method Phergie_Connection::setEncoding()
Sets the encoding for the connection to use.
- setEvent
- in file Abstract.php, method Phergie_Plugin_Abstract::setEvent()
Sets the current incoming event to be handled.
- setEventHandler
- in file Abstract.php, method Phergie_Plugin_Abstract::setEventHandler()
Sets the current event handler.
- setEventHandler
- in file Bot.php, method Phergie_Bot::setEventHandler()
Sets the event handler instance to use.
- setFormat
- in file Console.php, method Phergie_Ui_Console::setFormat()
Sets the format used for timestamps in console output, overwriting any previous format used.
- setHost
- in file Hostmask.php, method Phergie_Hostmask::setHost()
Sets the hostname.
- setHost
- in file Connection.php, method Phergie_Connection::setHost()
Sets the host to which the client will connect.
- setHostmask
- in file Request.php, method Phergie_Event_Request::setHostmask()
Sets the hostmask representing the originating user.
- setIteratorClass
- in file Handler.php, method Phergie_Plugin_Handler::setIteratorClass()
Sets the iterator class used for all currently loaded plugin instances.
- setName
- in file Abstract.php, method Phergie_Plugin_Abstract::setName()
Sets the short name for the plugin.
- setNick
- in file Connection.php, method Phergie_Connection::setNick()
Sets the nick that the client will use.
- setNick
- in file Hostmask.php, method Phergie_Hostmask::setNick()
Sets the nick of the user.
- setOptions
- in file Connection.php, method Phergie_Connection::setOptions()
Sets multiple connection settings using an array.
- setPassword
- in file Connection.php, method Phergie_Connection::setPassword()
Sets the password that the client will use.
- setPlugin
- in file Command.php, method Phergie_Event_Command::setPlugin()
Stores a reference to the plugin instance that created the event.
- setPluginHandler
- in file Bot.php, method Phergie_Bot::setPluginHandler()
Sets the plugin handler instance to use.
- setPluginHandler
- in file Abstract.php, method Phergie_Plugin_Abstract::setPluginHandler()
Sets the current plugin handler.
- setPort
- in file Connection.php, method Phergie_Connection::setPort()
Sets the port on which the client will connect.
- setProcessor
- in file Bot.php, method Phergie_Bot::setProcessor()
Sets the processer instance to use.
- setRawData
- in file Request.php, method Phergie_Event_Request::setRawData()
Sets the raw buffer for the event.
- setRawData
- in file Response.php, method Phergie_Event_Response::setRawData()
Sets the raw buffer for the given event
- setRealname
- in file Connection.php, method Phergie_Connection::setRealname()
Sets the realname that the client will use.
- setTimeout
- in file Streams.php, method Phergie_Driver_Streams::setTimeout()
Sets the amount of time to wait for a new event each time the socket is polled.
- setTransport
- in file Connection.php, method Phergie_Connection::setTransport()
Sets the transport for the connection to use.
- setType
- in file Abstract.php, method Phergie_Event_Abstract::setType()
Sets the event type.
- setUi
- in file Bot.php, method Phergie_Bot::setUi()
Sets the end-user interface instance to use.
- setUsername
- in file Hostmask.php, method Phergie_Hostmask::setUsername()
Sets the username of the user.
- setUsername
- in file Connection.php, method Phergie_Connection::setUsername()
Sets the username that the client will use.
top
t
- $timeout
- in file Streams.php, variable Phergie_Driver_Streams::$timeout
Amount of time in seconds to wait to receive an event each time the socket is polled
- $transport
- in file Connection.php, variable Phergie_Connection::$transport
Transport for the connection, defaults to tcp but can be set to ssl or variations thereof to connect over SSL
- $type
- in file Abstract.php, variable Phergie_Event_Abstract::$type
Event type, used for determining the callback to execute in response
- $type
- in file Response.php, variable Phergie_Event_Response::$type
Event type
- TYPE_ACTION
- in file Request.php, class constant Phergie_Event_Request::TYPE_ACTION
CTCP ACTION command event type
- TYPE_ERROR
- in file Request.php, class constant Phergie_Event_Request::TYPE_ERROR
ERROR message type
- TYPE_FINGER
- in file Request.php, class constant Phergie_Event_Request::TYPE_FINGER
CTCP FINGER command event type
- TYPE_INVITE
- in file Request.php, class constant Phergie_Event_Request::TYPE_INVITE
Invite message event type
- TYPE_JOIN
- in file Request.php, class constant Phergie_Event_Request::TYPE_JOIN
Join message event type
- TYPE_KICK
- in file Request.php, class constant Phergie_Event_Request::TYPE_KICK
Kick message event type
- TYPE_MODE
- in file Request.php, class constant Phergie_Event_Request::TYPE_MODE
Mode message event type
- TYPE_NICK
- in file Request.php, class constant Phergie_Event_Request::TYPE_NICK
Nick message event type
- TYPE_NOTICE
- in file Request.php, class constant Phergie_Event_Request::TYPE_NOTICE
Notice message event type
- TYPE_PART
- in file Request.php, class constant Phergie_Event_Request::TYPE_PART
Part message event type
- TYPE_PING
- in file Request.php, class constant Phergie_Event_Request::TYPE_PING
CTCP PING command event type
- TYPE_PONG
- in file Request.php, class constant Phergie_Event_Request::TYPE_PONG
Pong message event type
- TYPE_PRIVMSG
- in file Request.php, class constant Phergie_Event_Request::TYPE_PRIVMSG
Private message command event type
- TYPE_QUIT
- in file Request.php, class constant Phergie_Event_Request::TYPE_QUIT
Quit command event type
- TYPE_RAW
- in file Request.php, class constant Phergie_Event_Request::TYPE_RAW
Raw event type
- TYPE_TIME
- in file Request.php, class constant Phergie_Event_Request::TYPE_TIME
CTCP TIME command event type
- TYPE_TOPIC
- in file Request.php, class constant Phergie_Event_Request::TYPE_TOPIC
Topic message event type
- TYPE_VERSION
- in file Request.php, class constant Phergie_Event_Request::TYPE_VERSION
CTCP VERSION command event type
- TYPE_WHOIS
- in file Request.php, class constant Phergie_Event_Request::TYPE_WHOIS
Whois message event type
top
top
top
top
|
|
