Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Interfaces\Collated Interface Reference

Interface for an object that uses a collation. More...

+ Inheritance diagram for Erebot\Interfaces\Collated:

Public Member Functions

 getCollator ()
 
 setCollator (\Erebot\Interfaces\IrcCollator $collator)
 

Detailed Description

Interface for an object that uses a collation.

Definition at line 27 of file Collated.php.

Member Function Documentation

Erebot\Interfaces\Collated::getCollator ( )

Returns the collator associated with this connection.

Return values
Erebot::Interfaces::IrcCollatorThe collator currently in use for this connection.

Implemented in Erebot\IrcConnection.

Erebot\Interfaces\Collated::setCollator ( \Erebot\Interfaces\IrcCollator  $collator)

Sets the collator associated with this connection.

Parameters
Erebot::Interfaces::IrcCollator$collatorThe new collator to use.

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