Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Styling\Variables\CurrencyInterface Interface Reference

Interface for a monetary value embedded in a template. More...

+ Inheritance diagram for Erebot\Styling\Variables\CurrencyInterface:

Public Member Functions

 getCurrency ()
 
- Public Member Functions inherited from Erebot\Styling\VariableInterface
 getValue ()
 
 render (\Erebot\IntlInterface $translator)
 

Detailed Description

Interface for a monetary value embedded in a template.

Definition at line 27 of file CurrencyInterface.php.

Member Function Documentation

Erebot\Styling\Variables\CurrencyInterface::getCurrency ( )

Returns the currency the amount is expressed in.

Return values
stringThe name of the currency used to express the amount.
NULLNULL is returned in case no currency was given at construction, meaning that the currency will automatically be selected at runtime.

Implemented in Erebot\Styling\Variables\CurrencyVariable.


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