Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Styling\Variables\FloatVariable Class Reference

A class used to format floating-point values. More...

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

Public Member Functions

 __construct ($value)
 
 getValue ()
 
 render (\Erebot\IntlInterface $translator)
 

Protected Attributes

 $value
 The float-point value to format.
 

Detailed Description

A class used to format floating-point values.

Definition at line 27 of file FloatVariable.php.

Constructor & Destructor Documentation

Erebot\Styling\Variables\FloatVariable::__construct (   $value)

Constructor.

Parameters
float$valueThe floating-point value to format.

Definition at line 38 of file FloatVariable.php.

References Erebot\Styling\Variables\FloatVariable\$value.

Member Function Documentation

Erebot\Styling\Variables\FloatVariable::getValue ( )

Returns the value stored in this object.

Return values
mixedValue stored in this object.

Implements Erebot\Styling\VariableInterface.

Definition at line 53 of file FloatVariable.php.

References Erebot\Styling\Variables\FloatVariable\$value.

Erebot\Styling\Variables\FloatVariable::render ( \Erebot\IntlInterface  $translator)

Renders the content of this variable.

Parameters
Erebot::IntlInterface$translatorA translator that can be used to change the rendering depending on the target locale.
Return values
stringThe variable rendered as a string.

Implements Erebot\Styling\VariableInterface.

Definition at line 43 of file FloatVariable.php.

References Erebot\IntlInterface\LC_NUMERIC.


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