Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Event\ServerCapabilities Class Reference

Triggered when the bot has determined what features the IRC server supports. More...

+ Inheritance diagram for Erebot\Event\ServerCapabilities:

Public Member Functions

 __construct (\Erebot\Interfaces\Connection $connection,\Erebot\Module\Base $module)
 
 getModule ()
 
- Public Member Functions inherited from Erebot\Event\AbstractEvent
 __construct (\Erebot\Interfaces\Connection $connection)
 
 getConnection ()
 
 preventDefault ($prevent=null)
 

Protected Attributes

 $module
 Module containing the server's capabilities.
 
- Protected Attributes inherited from Erebot\Event\AbstractEvent
 $connection
 Connection the event originated from.
 
 $halt
 Whether the default action should be prevented or not. More...
 

Detailed Description

Triggered when the bot has determined what features the IRC server supports.

Definition at line 28 of file ServerCapabilities.php.

Constructor & Destructor Documentation

Erebot\Event\ServerCapabilities::__construct ( \Erebot\Interfaces\Connection  $connection,
\Erebot\Module\Base  $module 
)

Constructs a new event dealing with server capabilities.

Parameters
Erebot::Interfaces::Connection$connectionThe connection this event relates to.
Erebot::Module::Base$moduleThe module containing information about the server's capabilities.

Definition at line 45 of file ServerCapabilities.php.

References Erebot\Event\ServerCapabilities\$module.

Member Function Documentation

Erebot\Event\ServerCapabilities::getModule ( )

Returns the module associated with this event.

Return values
Erebot::Module::ServerCapabilitiesThe module associated with this event. It can be used to determine what the current IRC server is capable of.

Implements Erebot\Interfaces\Event\ServerCapabilities.

Definition at line 53 of file ServerCapabilities.php.

References Erebot\Event\ServerCapabilities\$module.


The documentation for this class was generated from the following file: