An abstract CTCP Event which applies to a channel and contains some text. More...

Inheritance diagram for Erebot\Event\WithChanSourceCtcpAbstract:

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

	getCtcpType ()

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

	getText ()

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

	getChan ()

	getSource ()

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\WithChanSourceTextAbstract
	$text
	Content of this event.

Protected Attributes inherited from Erebot\Event\WithChanSourceAbstract
	$chan
	IRC channel this event relates to.

	$source
	Source the event originated from.

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 a channel and contains some text.

Constructor & Destructor Documentation

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

Creates a new event dealing with a CTCP message addressed to an IRC channel.

Parameters

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

Erebot\Event\WithChanSourceCtcpAbstract::getCtcpType ( )

Returns the type of CTCP message conveyed by this event.

Return values

string Type of this CTCP message.

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