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

Interface for an event which has a target. More...

Inherits Erebot\Interfaces\Event\Base\Generic.

Inherited by Erebot\Event\WithSourceTargetAbstract, Erebot\Interfaces\Event\Ban, Erebot\Interfaces\Event\DeHalfop, Erebot\Interfaces\Event\DeOp, Erebot\Interfaces\Event\DeOwner, Erebot\Interfaces\Event\DeProtect, Erebot\Interfaces\Event\DeVoice, Erebot\Interfaces\Event\Except, Erebot\Interfaces\Event\Halfop, Erebot\Interfaces\Event\Invite, Erebot\Interfaces\Event\Kick, Erebot\Interfaces\Event\Nick, Erebot\Interfaces\Event\Numeric, Erebot\Interfaces\Event\Op, Erebot\Interfaces\Event\Owner, Erebot\Interfaces\Event\Protect, Erebot\Interfaces\Event\UnBan, Erebot\Interfaces\Event\UnExcept, Erebot\Interfaces\Event\UserMode, and Erebot\Interfaces\Event\Voice.

Public Member Functions

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

Detailed Description

Interface for an event which has a target.

Definition at line 27 of file Target.php.

Member Function Documentation

Erebot\Interfaces\Event\Base\Target::getTarget ( )

Returns the target of the current message. This will generally be the bot's nickname or some other user's nickname.

Return values
stringThe target of this message.

Implemented in Erebot\Event\Numeric, and Erebot\Event\WithSourceTargetAbstract.


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