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

An abstract Event containing some text. More...

+ Inheritance diagram for Erebot\Event\WithTextAbstract:

Public Member Functions

 __construct (\Erebot\Interfaces\Connection $connection, $text)
 
 getText ()
 
- Public Member Functions inherited from Erebot\Event\AbstractEvent
 __construct (\Erebot\Interfaces\Connection $connection)
 
 getConnection ()
 
 preventDefault ($prevent=null)
 

Protected Attributes

 $text
 Content of this event.
 
- 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 containing some text.

Definition at line 27 of file WithTextAbstract.php.

Constructor & Destructor Documentation

Erebot\Event\WithTextAbstract::__construct ( \Erebot\Interfaces\Connection  $connection,
  $text 
)

Creates a new event containing some text.

Parameters
Erebot::Interfaces::Connection$connectionThe connection this event came from.
string$textText contained in this event.

Definition at line 42 of file WithTextAbstract.php.

References Erebot\Event\WithTextAbstract\$text.

Member Function Documentation

Erebot\Event\WithTextAbstract::getText ( )

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

Return values
stringThe content of this message.

Implements Erebot\Interfaces\Event\Base\Text.

Definition at line 50 of file WithTextAbstract.php.

References Erebot\Event\WithTextAbstract\$text.


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