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

A class that holds a reference to an IRC numeric. More...

+ Inheritance diagram for Erebot\NumericReference:

Public Member Functions

 __construct (\Erebot\Interfaces\Connection $connection, $name)
 
 getName ()
 
 getValue ()
 

Protected Attributes

 $connection
 IRC connection this reference is valid for.
 
 $name
 Name of the numeric (eg. "RPL_WELCOME").
 

Detailed Description

A class that holds a reference to an IRC numeric.

This class holds a reference to an IRC numeric using its name (eg. "RPL_WELCOME"). The actual numeric code associated with this reference may vary dynamically depending on the numeric profile currently loaded for the connection.

Definition at line 32 of file NumericReference.php.

Constructor & Destructor Documentation

Erebot\NumericReference::__construct ( \Erebot\Interfaces\Connection  $connection,
  $name 
)

Constructs a new reference to a numeric.

Parameters
Erebot::Interfaces::Connection$connectionConnection object this reference is valid for.
string$nameName associated with the numeric this object should reference (such as "RPL_WELCOME").

Definition at line 50 of file NumericReference.php.


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