Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Event\ChanUserModeAbstract Class Reference

An abstract Event which represents a usermode change on a channel. More...

+ Inheritance diagram for Erebot\Event\ChanUserModeAbstract:

Public Member Functions

 getMode ()
 
- Public Member Functions inherited from Erebot\Event\WithChanSourceTargetAbstract
 __construct (\Erebot\Interfaces\Connection $connection, $chan, $source, $target)
 
 getChan ()
 
- Public Member Functions inherited from Erebot\Event\WithSourceTargetAbstract
 __construct (\Erebot\Interfaces\Connection $connection, $source, $target)
 
 getSource ()
 
 getTarget ()
 
- Public Member Functions inherited from Erebot\Event\AbstractEvent
 __construct (\Erebot\Interfaces\Connection $connection)
 
 getConnection ()
 
 preventDefault ($prevent=null)
 

Additional Inherited Members

- Protected Attributes inherited from Erebot\Event\WithChanSourceTargetAbstract
 $chan
 IRC channel this event relates to.
 
- Protected Attributes inherited from Erebot\Event\WithSourceTargetAbstract
 $source
 Source the event originated from.
 
 $target
 Target of the event (usually the bot).
 
- Protected Attributes inherited from Erebot\Event\AbstractEvent
 $connection
 Connection the event originated from.
 
 $halt
 Whether the default action should be prevented or not. More...
 

Detailed Description

An abstract Event which represents a usermode change on a channel.

Definition at line 28 of file ChanUserModeAbstract.php.

Member Function Documentation

Erebot\Event\ChanUserModeAbstract::getMode ( )

Returns a description of the mode this event refers to, including any leading operator.

Return values
stringTextual representation of this mode, eg. "+o".

Definition at line 38 of file ChanUserModeAbstract.php.


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