Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Event\NotificationAbstract Class Reference

An abstract Event for WATCH list notifications. More...

+ Inheritance diagram for Erebot\Event\NotificationAbstract:

Public Member Functions

 __construct (\Erebot\Interfaces\Connection $connection, $source, $ident, $host,\DateTime $timestamp, $text)
 
 getTimestamp ()
 
- Public Member Functions inherited from Erebot\Event\WithSourceTextAbstract
 __construct (\Erebot\Interfaces\Connection $connection, $source, $text)
 
 getSource ()
 
- Public Member Functions inherited from Erebot\Event\WithTextAbstract
 __construct (\Erebot\Interfaces\Connection $connection, $text)
 
 getText ()
 
- Public Member Functions inherited from Erebot\Event\AbstractEvent
 __construct (\Erebot\Interfaces\Connection $connection)
 
 getConnection ()
 
 preventDefault ($prevent=null)
 

Protected Attributes

 $timestamp
 Timestamp the notification was issued at.
 
- Protected Attributes inherited from Erebot\Event\WithSourceTextAbstract
 $source
 Source the event originated from.
 
- Protected Attributes inherited from Erebot\Event\WithTextAbstract
 $text
 Content of this event.
 
- 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 for WATCH list notifications.

Definition at line 27 of file NotificationAbstract.php.

Constructor & Destructor Documentation

Erebot\Event\NotificationAbstract::__construct ( \Erebot\Interfaces\Connection  $connection,
  $source,
  $ident,
  $host,
\DateTime  $timestamp,
  $text 
)

Constructs a new event related to a notification.

Parameters
Erebot::Interfaces::Connection$connectionConnection the event originated from.
string$sourceNickname of the IRC user this notification is about.
string$identIdentity of the IRC user this notification is about.
string$hostHostname of the IRC user this notification is about.
DateTime$timestampObject that keeps track of when the notification was issued.
string$textMessage explaining why the notification was triggered.

Definition at line 54 of file NotificationAbstract.php.

References Erebot\Event\WithSourceTextAbstract\$source, Erebot\Event\WithTextAbstract\$text, and Erebot\Event\NotificationAbstract\$timestamp.

Member Function Documentation

Erebot\Event\NotificationAbstract::getTimestamp ( )

Returns the timestamp at which the notification was issued.

Return values
DateTimeTimestamp of the notification.

Definition at line 76 of file NotificationAbstract.php.

References Erebot\Event\NotificationAbstract\$timestamp.


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