Erebot  latest
A modular IRC bot for PHP 7.0+
Erebot\Event\Numeric Class Reference

A class representing a numeric event. More...

+ Inheritance diagram for Erebot\Event\Numeric:

Public Member Functions

 __construct (\Erebot\Interfaces\Connection $connection, $numeric, $source, $target, $text)
 
 __destruct ()
 Destructor.
 
 getCode ()
 
 getConnection ()
 
 getSource ()
 
 getTarget ()
 
 getText ()
 
 preventDefault ($prevent=null)
 

Protected Attributes

 $connection
 The connection object this numeric event came from.
 
 $halt
 Whether the default action should be prevented or not.
 
 $numeric
 Numeric code.
 
 $source
 Source of the numeric event.
 
 $target
 Target of the numeric event; this is usually the bot.
 
 $text
 Content of the numeric event.
 

Detailed Description

A class representing a numeric event.

Definition at line 27 of file Numeric.php.

Constructor & Destructor Documentation

Erebot\Event\Numeric::__construct ( \Erebot\Interfaces\Connection  $connection,
  $numeric,
  $source,
  $target,
  $text 
)

Constructs a numeric event.

Parameters
Erebot::Interfaces::Connection$connectionThe connection this message came from.
int$numericThe numeric code for the message.
string$sourceThe source of the numeric message. This will generally be the name of an IRC server.
string$targetThe target of the numeric message. This will generally be the bot's nickname.
string$textThe numeric content of the message.
Note
No attempt is made at parsing the content of the message.

Definition at line 65 of file Numeric.php.

References Erebot\Event\Numeric\$connection, Erebot\Event\Numeric\$numeric, Erebot\Event\Numeric\$source, Erebot\Event\Numeric\$target, and Erebot\Event\Numeric\$text.


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