Erebot\Interfaces\Event\Match Interface Reference
Interface for an event filter. More...
Inheritance diagram for Erebot\Interfaces\Event\Match:
Public Member Functions | |
| match (\Erebot\Interfaces\Event\Base\Generic $event) | |
Detailed Description
Interface for an event filter.
Subclasses should implement the match() method to provide an algorithm which decides if a given event matches or not.
Member Function Documentation
| Erebot\Interfaces\Event\Match::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.
Implemented in Erebot\Event\Match\TextAbstract, Erebot\Event\Match\Type, Erebot\Event\Match\Chan, Erebot\Event\Match\Source, Erebot\Event\Match\Not, Erebot\Event\Match\All, Erebot\Event\Match\Any, Erebot\Event\Match\Always, and Erebot\Event\Match\Never.
The documentation for this interface was generated from the following file:
- vendor/erebot/api/src/Interfaces/Event/Match.php
