Modules
Num
extends Kohana_Num
Number helper class. Provides additional formatting methods that for working with numbers.
Class declared in SYSPATH/classes/num.php on line 3.
Methods
public static format( float $number , integer $places [, boolean $monetary = bool FALSE ] ) (defined in Kohana_Num)
Locale-aware number and monetary formatting.
// In English, "1,200.05"
// In Spanish, "1200,05"
// In Portuguese, "1 200,05"
echo Num::format(1200.05, 2);
// In English, "1,200.05"
// In Spanish, "1.200,05"
// In Portuguese, "1.200.05"
echo Num::format(1200.05, 2, TRUE);
Parameters
-
float$number required - Number to format -
integer$places required - Decimal places -
boolean$monetary = bool FALSE - Monetary formatting?
Tags
Return Values
string
Source Code
public static function format($number, $places, $monetary = FALSE)
{
$info = localeconv();
if ($monetary)
{
$decimal = $info['mon_decimal_point'];
$thousands = $info['mon_thousands_sep'];
}
else
{
$decimal = $info['decimal_point'];
$thousands = $info['thousands_sep'];
}
return number_format($number, $places, $decimal, $thousands);
}public static ordinal( integer $number ) (defined in Kohana_Num)
Returns the English ordinal suffix (th, st, nd, etc) of a number.
echo 2, Num::ordinal(2); // "2nd"
echo 10, Num::ordinal(10); // "10th"
echo 33, Num::ordinal(33); // "33rd"
Parameters
-
integer$number required - Number
Return Values
string
Source Code
public static function ordinal($number)
{
if ($number % 100 > 10 AND $number % 100 < 14)
{
return 'th';
}
switch ($number % 10)
{
case 1:
return 'st';
case 2:
return 'nd';
case 3:
return 'rd';
default:
return 'th';
}
}