Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Interfaces\Event\Base\Text Interface Reference

Interface for an event which contains some text. More...

Inherits Erebot\Interfaces\Event\Base\Generic.

Inherited by Erebot\Event\WithChanSourceTargetTextAbstract, Erebot\Event\WithChanSourceTextAbstract, Erebot\Event\WithSourceTargetTextAbstract, Erebot\Event\WithTextAbstract, Erebot\Interfaces\Event\ChanAction, Erebot\Interfaces\Event\ChanCtcp, Erebot\Interfaces\Event\ChanCtcpReply, Erebot\Interfaces\Event\ChanNotice, Erebot\Interfaces\Event\ChanText, Erebot\Interfaces\Event\Error, Erebot\Interfaces\Event\Kick, Erebot\Interfaces\Event\Notify, Erebot\Interfaces\Event\Numeric, Erebot\Interfaces\Event\Part, Erebot\Interfaces\Event\Ping, Erebot\Interfaces\Event\Pong, Erebot\Interfaces\Event\PrivateAction, Erebot\Interfaces\Event\PrivateCtcp, Erebot\Interfaces\Event\PrivateCtcpReply, Erebot\Interfaces\Event\PrivateNotice, Erebot\Interfaces\Event\PrivateText, Erebot\Interfaces\Event\Quit, Erebot\Interfaces\Event\RawMode, Erebot\Interfaces\Event\Topic, Erebot\Interfaces\Event\UnNotify, and Erebot\Interfaces\Event\UserMode.

Public Member Functions

 getText ()
 
- Public Member Functions inherited from Erebot\Interfaces\Event\Base\Generic
 getConnection ()
 
 preventDefault ($prevent=null)
 

Detailed Description

Interface for an event which contains some text.

Definition at line 27 of file Text.php.

Member Function Documentation

Erebot\Interfaces\Event\Base\Text::getText ( )

Returns the raw content of the current message. No attempt is made at parsing the content.

Return values
stringThe content of this message.

Implemented in Erebot\Event\Numeric, Erebot\Event\WithChanSourceTargetTextAbstract, Erebot\Event\WithChanSourceTextAbstract, Erebot\Event\WithSourceTargetTextAbstract, and Erebot\Event\WithTextAbstract.


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