An abstract Event which applies to a channel and has a source and a target. More...

Inheritance diagram for Erebot\Event\WithChanSourceTargetAbstract:

Public Member Functions
	__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
	$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 and has a source and a target.

Constructor & Destructor Documentation

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

Creates a new event 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.

Erebot\Event\WithChanSourceTargetAbstract::getChan ( )

Returns the name of the channel this event relates to.

Return values

string Name of the channel affected by the event.

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