Interface for an event which has a source. More...
Inherits Erebot\Interfaces\Event\Base\Generic.
Inherited by Erebot\Event\WithChanSourceAbstract, Erebot\Event\WithSourceTargetAbstract, Erebot\Event\WithSourceTextAbstract, Erebot\Interfaces\Event\Ban, Erebot\Interfaces\Event\ChanAction, Erebot\Interfaces\Event\ChanCtcp, Erebot\Interfaces\Event\ChanCtcpReply, Erebot\Interfaces\Event\ChanNotice, Erebot\Interfaces\Event\ChanText, 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\Join, Erebot\Interfaces\Event\Kick, Erebot\Interfaces\Event\Nick, Erebot\Interfaces\Event\Notify, Erebot\Interfaces\Event\Numeric, Erebot\Interfaces\Event\Op, Erebot\Interfaces\Event\Owner, Erebot\Interfaces\Event\Part, 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\Protect, Erebot\Interfaces\Event\Quit, Erebot\Interfaces\Event\RawMode, Erebot\Interfaces\Event\Topic, Erebot\Interfaces\Event\UnBan, Erebot\Interfaces\Event\UnExcept, Erebot\Interfaces\Event\UnNotify, Erebot\Interfaces\Event\UserMode, and Erebot\Interfaces\Event\Voice.
Public Member Functions | |
| getSource () | |
 Public Member Functions inherited from Erebot\Interfaces\Event\Base\Generic | |
| getConnection () | |
| preventDefault ($prevent=null) | |
Detailed Description
Interface for an event which has a source.
Definition at line 27 of file Source.php.
Member Function Documentation
| Erebot\Interfaces\Event\Base\Source::getSource | ( | ) |
Returns the source of the current message. This will usually be some user's nickname or the name of an IRC server.
- Return values
-
Erebot::Interfaces::Identity The source of this message.
Implemented in Erebot\Event\Numeric, Erebot\Event\WithChanSourceAbstract, Erebot\Event\WithSourceTargetAbstract, and Erebot\Event\WithSourceTextAbstract.
The documentation for this interface was generated from the following file:
- vendor/erebot/api/src/Interfaces/Event/Base/Source.php
