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 $connection Connection object this reference is valid for. string $name Name associated with the numeric this object should reference (such as "RPL_WELCOME").
Definition at line 50 of file NumericReference.php.
Member Function Documentation
| Erebot\NumericReference::getName | ( | ) |
Returns the name of the numeric this object holds a reference for.
- Return values
-
string Name of the numeric, such as "RPL_WELCOME".
Implements Erebot\Interfaces\NumericReference.
Definition at line 58 of file NumericReference.php.
| Erebot\NumericReference::getValue | ( | ) |
Retrieve the actual numeric code associated with this reference.
- Return values
-
int Numeric code associated with this reference, such as 1 for "RPL_WELCOME".
- Note
- The actual value may vary depending on the current numeric profile for the connection associated with this reference. Do not use a cache for this value.
Implements Erebot\Interfaces\NumericReference.
Definition at line 63 of file NumericReference.php.
The documentation for this class was generated from the following file:
