A filter which matches when the source of the event equals some predefined value. More...

Inheritance diagram for Erebot\Event\Match\Source:

Public Member Functions
	__construct ($source)

	getSource ()

	match (\Erebot\Interfaces\Event\Base\Generic $event)

	setSource ($source)

Protected Attributes
	$source
	Source to use in the comparison, as a string.

Detailed Description

A filter which matches when the source of the event equals some predefined value.

Definition at line 31 of file Source.php.

Constructor & Destructor Documentation

Erebot\Event\Match\Source::__construct ( $source )

Creates a new instance of the filter.

Parameters

$source string|object Source to match incoming events against.

Exceptions

Erebot::InvalidValueException The given source is invalid.

Definition at line 45 of file Source.php.

Erebot\Event\Match\Source::getSource ( )

Returns the source associated with this filter.

Return values

string Source associated with this filter.

Definition at line 56 of file Source.php.

Erebot\Event\Match\Source::match ( \Erebot\Interfaces\Event\Base\Generic $event )

Decides whether the given event passes the filter or not.

Parameters

$event An event to try to match to the criterion expressed by this filter.

Return values

bool	true if the event matches the criterion, false otherwise.

Definition at line 79 of file Source.php.

Erebot\Event\Match\Source::setSource ( $source )

Sets the source used in comparisons.

Parameters

$source string|object Source to match incoming events against.

Exceptions

Erebot::InvalidValueException The given source is invalid.

Definition at line 70 of file Source.php.

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