NumberHelper Class Reference

Inheritance diagram for NumberHelper:

List of all members.

Public Member Functions
	currency ($number, $currency= 'USD', $options=array())
Static Public Member Functions
	format ($number, $options=false)
	precision ($number, $precision=3)
	toPercentage ($number, $precision=2)
	toReadableSize ($size)

---

Detailed Description

Definition at line 35 of file number.php.

---

Member Function Documentation

NumberHelper::currency	(	$	number,
		$	currency = 'USD',
		$	options = array()
	)

Formats a number into a currency format.

Parameters:

	float	$number
	string	$currency Shortcut to default options. Valid values are 'USD', 'EUR', 'GBP', otherwise set at least 'before' and 'after' options.
	array	$options

Returns:

string Number formatted as a currency.

Definition at line 131 of file number.php.

References format().

NumberHelper::format	(	$	number,
		$	options = false
	)			[static]

Formats a number into a currency format.

Parameters:

	float	$number A floating point number
	integer	$options if int then places, if string then before, if (,.-) then use it or array with places and before keys

Returns:

string formatted number

Definition at line 88 of file number.php.

References $out.

Referenced by currency().

NumberHelper::precision	(	$	number,
		$	precision = 3
	)			[static]

Formats a number with a level of precision.

Parameters:

	float	$number A floating point number.
	integer	$precision The precision of the returned number.

Returns:

float Enter description here...

Definition at line 44 of file number.php.

Referenced by toPercentage(), and toReadableSize().

NumberHelper::toPercentage	(	$	number,
		$	precision = 2
	)			[static]

Formats a number into a percentage string.

Parameters:

	float	$number A floating point number
	integer	$precision The precision of the returned number

Returns:

string Percentage string

Definition at line 76 of file number.php.

References precision().

NumberHelper::toReadableSize

(

$

size

)

[static]

Returns a formatted-for-humans file size.

Parameters:

integer

$length Size in bytes

Returns:

string Human readable size

Definition at line 54 of file number.php.

References __(), __n(), and precision().

---

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

• libs/view/helpers/number.php

---