Erebot  latest
A modular IRC bot for PHP 5.3+
Public Member Functions | List of all members
Erebot\Interfaces\IrcConnection Interface Reference

Interface for IRC(S) connections. More...

+ Inheritance diagram for Erebot\Interfaces\IrcConnection:

Public Member Functions

 getEventsProducer ()
 
 getNumericProfile ()
 
 isChannel ($chan)
 
 setNumericProfile (\Erebot\NumericProfile\Base $profile)
 
- Public Member Functions inherited from Erebot\Interfaces\ModuleContainer
 getModule ($name, $chan=null, $autoload=true)
 
 getModules ($chan=null)
 
 loadModule ($module, $chan=null)
 
- Public Member Functions inherited from Erebot\Interfaces\EventDispatcher
 addEventHandler (\Erebot\Interfaces\EventHandler $handler)
 
 addNumericHandler (\Erebot\Interfaces\NumericHandler $handler)
 
 dispatch (\Erebot\Interfaces\Event\Base\Generic $event)
 
 removeEventHandler (\Erebot\Interfaces\EventHandler $handler)
 
 removeNumericHandler (\Erebot\Interfaces\NumericHandler $handler)
 
- Public Member Functions inherited from Erebot\Interfaces\SendingConnection
 write ()
 
- Public Member Functions inherited from Erebot\Interfaces\Connection
 connect ()
 
 disconnect ($quitMessage=null)
 
 getBot ()
 
 getConfig ($chan)
 
 getIO ()
 
 getSocket ()
 
 isConnected ()
 
- Public Member Functions inherited from Erebot\Interfaces\ReceivingConnection
 process ()
 
 read ()
 
- Public Member Functions inherited from Erebot\Interfaces\Collated
 getCollator ()
 
 setCollator (\Erebot\Interfaces\IrcCollator $collator)
 

Detailed Description

Interface for IRC(S) connections.

This interface provides the necessary methods to handle an IRC(S) connection.

Definition at line 30 of file IrcConnection.php.

Member Function Documentation

Erebot\Interfaces\IrcConnection::getEventsProducer ( )

Returns the object used to produce events.

Return values
Erebot::Interfaces::IrcParserObject used to produce events.
Note
This method is somewhat misnamed, since in reality the object it returns does more than merely producing events—it is a full-blown IRC parser.

Implemented in Erebot\IrcConnection.

Erebot\Interfaces\IrcConnection::getNumericProfile ( )

Returns the numeric profile associated with this connection.

Return values
Erebot::NumericProfile::BaseThe numeric profile associated with this connection.

Implemented in Erebot\IrcConnection.

Erebot\Interfaces\IrcConnection::isChannel (   $chan)

Determines if the given string is a valid channel name or not. A channel name usually starts with the hash symbol (#). Valid characters for the rest of the name vary between IRC networks.

Parameters
$chanTentative channel name.
Return values
booltrue if $chan is a valid channel name, false otherwise.
Exceptions
Erebot::InvalidValueException::$chanis not a string or is empty.

Implemented in Erebot\IrcConnection.

Erebot\Interfaces\IrcConnection::setNumericProfile ( \Erebot\NumericProfile\Base  $profile)

Sets the new numeric profile for this connection.

Parameters
Erebot::NumericProfile::Base$profileThe new numeric profile to use for this connection.

Implemented in Erebot\IrcConnection.

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