An abstract Event which applies to a channel, has a source, a target and even some text. More...

Inheritance diagram for Erebot\Event\WithChanSourceTargetTextAbstract:

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

	getText ()

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)

Protected Attributes
	$text
	Content of this event.

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 applies to a channel, has a source, a target and even some text.

Constructor & Destructor Documentation

Erebot\Event\WithChanSourceTargetTextAbstract::__construct	(	\Erebot\Interfaces\Connection	$connection,
			$chan,
			$source,
			$target,
			$text
	)

Creates a new event containing some text and for which a source, a destination (target) and a channel can be identified.

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	$target	Target identified for this event.
string	$text	Text contained in this event.

Erebot\Event\WithChanSourceTargetTextAbstract::getText ( )

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

Return values

string The content of this message.

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