Erebot\Interfaces\NumericReference Interface Reference

Interface for a class that holds a reference to an IRC numeric. More...

Inheritance diagram for Erebot\Interfaces\NumericReference:

Public Member Functions
	getName ()
	getValue ()

Detailed Description

Interface for 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 33 of file NumericReference.php.

Member Function Documentation

Erebot\Interfaces\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".

Implemented in Erebot\NumericReference.

Erebot\Interfaces\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.

Implemented in Erebot\NumericReference.

---

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

• vendor/erebot/api/src/Interfaces/NumericReference.php