Phergie
[ class tree: Phergie ] [ index: Phergie ] [ all elements ]
Packages:
Phergie


Files:
Abstract.php
Abstract.php
Abstract.php
Abstract.php
Abstract.php
Async.php
Autoload.php
Bot.php
Command.php
Config.php
Connection.php
Console.php
Exception.php
Exception.php
Exception.php
Exception.php
Exception.php
Exception.php
Exception.php
Exception.php
Handler.php
Handler.php
Handler.php
Hostmask.php
phergie.php
Request.php
Response.php
Standard.php
Streams.php

Classes:
Phergie_Autoload
Phergie_Bot
Phergie_Config
Phergie_Config_Exception
Phergie_Connection
Phergie_Connection_Exception
Phergie_Connection_Handler
Phergie_Driver_Abstract
Phergie_Driver_Exception
Phergie_Driver_Streams
Phergie_Event_Abstract
Phergie_Event_Command
Phergie_Event_Exception
Phergie_Event_Handler
Phergie_Event_Request
Phergie_Event_Response
Phergie_Exception
Phergie_Hostmask
Phergie_Hostmask_Exception
Phergie_Plugin_Abstract
Phergie_Plugin_Exception
Phergie_Plugin_Handler
Phergie_Process_Abstract
Phergie_Process_Async
Phergie_Process_Exception
Phergie_Process_Standard
Phergie_Ui_Abstract
Phergie_Ui_Console

Class: Phergie_Event_Command

Source Location: /Phergie/Event/Command.php

Class Overview

Phergie_Event_Abstract
   |
   --Phergie_Event_Request
      |
      --Phergie_Event_Command

Event originating from a plugin for the bot.


Author(s):

Variables

Methods

Inherited Constants

Class: Phergie_Event_Request

Phergie_Event_Request::TYPE_ACTION
Phergie_Event_Request::TYPE_ERROR
Phergie_Event_Request::TYPE_FINGER
Phergie_Event_Request::TYPE_INVITE
Phergie_Event_Request::TYPE_JOIN
Phergie_Event_Request::TYPE_KICK
Phergie_Event_Request::TYPE_MODE
Phergie_Event_Request::TYPE_NICK
Phergie_Event_Request::TYPE_NOTICE
Phergie_Event_Request::TYPE_PART
Phergie_Event_Request::TYPE_PING
Phergie_Event_Request::TYPE_PONG
Phergie_Event_Request::TYPE_PRIVMSG
Phergie_Event_Request::TYPE_QUIT
Phergie_Event_Request::TYPE_RAW
Phergie_Event_Request::TYPE_TIME
Phergie_Event_Request::TYPE_TOPIC
Phergie_Event_Request::TYPE_VERSION
Phergie_Event_Request::TYPE_WHOIS

Inherited Variables

Class: Phergie_Event_Request

Phergie_Event_Request::$arguments
Phergie_Event_Request::$hostmask
Phergie_Event_Request::$map
Phergie_Event_Request::$rawData

Class: Phergie_Event_Abstract

Phergie_Event_Abstract::$type

Inherited Methods

Class: Phergie_Event_Request

Phergie_Event_Request::getArgument()
Returns a single specified argument for the request.
Phergie_Event_Request::getArgumentMapping()
Returns a mapping of commands to their respective arguments.
Phergie_Event_Request::getArguments()
Returns the arguments for the request.
Phergie_Event_Request::getHostmask()
Returns the hostmask representing the originating user.
Phergie_Event_Request::getNick()
Returns the nick of the user who originated the event.
Phergie_Event_Request::getRawData()
Returns the raw buffer sent from the server for the event.
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.
Phergie_Event_Request::isChannelName()
Determines whether a given string is a valid IRC channel name.
Phergie_Event_Request::isFromServer()
Returns whether or not the event originated from the server.
Phergie_Event_Request::isFromUser()
Returns whether or not the event originated from a user.
Phergie_Event_Request::isInChannel()
Returns whether or not the event occurred within a channel.
Phergie_Event_Request::offsetExists()
Checks to see if an event argument is assigned a value.
Phergie_Event_Request::offsetGet()
Returns the value of an event argument.
Phergie_Event_Request::offsetSet()
Sets the value of an event argument.
Phergie_Event_Request::offsetUnset()
Removes the value set for an event argument.
Phergie_Event_Request::removeArgument()
Removes an argument value from the request.
Phergie_Event_Request::resolveArgument()
Resolves an argument specification to an integer position.
Phergie_Event_Request::setArgument()
Sets the value of a single argument for the request.
Phergie_Event_Request::setArguments()
Sets the arguments for the request.
Phergie_Event_Request::setHostmask()
Sets the hostmask representing the originating user.
Phergie_Event_Request::setRawData()
Sets the raw buffer for the event.
Phergie_Event_Request::__call()
Provides access to named parameters via virtual "getter" methods.

Class: Phergie_Event_Abstract

Phergie_Event_Abstract::getType()
Returns the event type.
Phergie_Event_Abstract::setType()
Sets the event type.

Class Details

[line 31]
Event originating from a plugin for the bot.



Tags:

author:  Phergie Development Team <team@phergie.org>
link:  http://pear.phergie.org/package/Phergie
license:  New BSD License


[ Top ]

Class Variables

$plugin =

[line 38]

Reference to the plugin instance that created the event



Tags:

access:  protected

Type:   Phergie_Plugin_Abstract


[ Top ]


Class Methods

method getPlugin [line 59]

Phergie_Plugin_Abstract|null getPlugin( )

Returns a reference to the plugin instance that created the event.



Tags:

return:  Plugin instance or NULL if none has been set
access:  public


[ Top ]

method setPlugin [line 47]

Phergie_Event_Command setPlugin( Phergie_Plugin_Abstract $plugin)

Stores a reference to the plugin instance that created the event.



Tags:

return:  Provides a fluent interface
access:  public


Parameters:

Phergie_Plugin_Abstract   $plugin   Plugin instance

[ Top ]

Documentation generated on Mon, 27 Sep 2010 23:03:46 -0500 by phpDocumentor 1.4.3