An abstract CTCP Event which applies to the bot and contains some text. More...

Inheritance diagram for Erebot\Event\WithSourceCtcpAbstract:

Public Member Functions
	__construct (\Erebot\Interfaces\Connection $connection, $source, $ctcpType, $text)

	getCtcpType ()

Public Member Functions inherited from Erebot\Event\WithSourceTextAbstract
	__construct (\Erebot\Interfaces\Connection $connection, $source, $text)

	getSource ()

Public Member Functions inherited from Erebot\Event\WithTextAbstract
	__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
	$ctcpType
	The type of CTCP message represented by this event.

Protected Attributes inherited from Erebot\Event\WithSourceTextAbstract
	$source
	Source the event originated from.

Protected Attributes inherited from Erebot\Event\WithTextAbstract
	$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 CTCP Event which applies to the bot and contains some text.

Definition at line 28 of file WithSourceCtcpAbstract.php.

Constructor & Destructor Documentation

Erebot\Event\WithSourceCtcpAbstract::__construct	(	\Erebot\Interfaces\Connection	$connection,
			$source,
			$ctcpType,
			$text
	)

Creates a new event representing a CTCP message.

Parameters

Erebot::Interfaces::Connection	$connection	The connection this event came from.
string	$source	Source identified for this event.
string	$ctcpType	Type of CTCP message being represented.
string	$text	Text contained in this CTCP message.

Definition at line 49 of file WithSourceCtcpAbstract.php.

Erebot\Event\WithSourceCtcpAbstract::getCtcpType ( )

Returns the type of CTCP message conveyed by this event.

Return values

string Type of this CTCP message.

Definition at line 59 of file WithSourceCtcpAbstract.php.

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