Modules

  1. –Kohana
    2. Debug
    3. HTTP_Cache
    4. I18n
    5. Kohana
    6. Kohana_Config_Writer
    7. Kohana_Core
    8. Request
    9. Request_Client
    10. Request_Client_Curl
    11. Request_Client_External
    12. Request_Client_HTTP
    13. Request_Client_Internal
    14. Request_Client_Stream
    15. Response
    16. Route
    17. UTF8
    18. View
    19. +Configuration
      1. Config
      2. Config_File
      3. Config_Group
      4. Kohana_Config_File_Reader
      5. Kohana_Config_Reader
      6. Kohana_Config_Source
    20. +Controller
      1. Controller
      2. Controller_Template
      3. Controller_Welcome
    21. +Exceptions
      1. HTTP_Exception
      2. HTTP_Exception_400
      3. HTTP_Exception_401
      4. HTTP_Exception_402
      5. HTTP_Exception_403
      6. HTTP_Exception_404
      7. HTTP_Exception_405
      8. HTTP_Exception_406
      9. HTTP_Exception_407
      10. HTTP_Exception_408
      11. HTTP_Exception_409
      12. HTTP_Exception_410
      13. HTTP_Exception_411
      14. HTTP_Exception_412
      15. HTTP_Exception_413
      16. HTTP_Exception_414
      17. HTTP_Exception_415
      18. HTTP_Exception_416
      19. HTTP_Exception_417
      20. HTTP_Exception_500
      21. HTTP_Exception_501
      22. HTTP_Exception_502
      23. HTTP_Exception_503
      24. HTTP_Exception_504
      25. HTTP_Exception_505
      26. Kohana_Exception
      27. Request_Exception
      28. Session_Exception
      29. UTF8_Exception
      30. Validation_Exception
      31. View_Exception
    22. +HTTP
      1. HTTP
      2. HTTP_Header
      3. HTTP_Message
      4. HTTP_Request
      5. HTTP_Response
    23. –Helpers
      1. Arr
      2. CLI
      3. Cookie
      4. Date
      5. Feed
      6. File
      7. Form
      8. Fragment
      9. HTML
      10. Inflector
      11. Num
      12. Profiler
      13. Text
      14. URL
      15. Upload
    24. +Logging
      1. Log
      2. Log_File
      3. Log_StdErr
      4. Log_StdOut
      5. Log_Syslog
      6. Log_Writer
    25. +Models
      1. Model
    26. +Security
      1. Encrypt
      2. Security
      3. Valid
      4. Validation
    27. +Session
      1. Session
      2. Session_Cookie
      3. Session_Native
  2. +Kohana/Auth
    2. Auth
    3. Auth_File
    4. Auth_ORM
    5. Model_Auth_Role
    6. Model_Auth_User
    7. Model_Auth_User_Token
    8. Model_Role
    9. Model_User
    10. Model_User_Token
  3. +Kohana/Cache
    2. Cache
    3. Cache_Apc
    4. Cache_Arithmetic
    5. Cache_Exception
    6. Cache_File
    7. Cache_GarbageCollect
    8. Cache_Memcache
    9. Cache_MemcacheTag
    10. Cache_Sqlite
    11. Cache_Tagging
    12. Cache_Wincache
  4. +Kohana/Codebench
    2. Codebench
    3. +Controllers
      1. Controller_Codebench
    4. +Tests
      1. Bench_ArrCallback
      2. Bench_AutoLinkEmails
      3. Bench_DateSpan
      4. Bench_ExplodeLimit
      5. Bench_GruberURL
      6. Bench_LtrimDigits
      7. Bench_MDDoBaseURL
      8. Bench_MDDoImageURL
      9. Bench_MDDoIncludeViews
      10. Bench_StripNullBytes
      11. Bench_Transliterate
      12. Bench_URLSite
      13. Bench_UserFuncArray
      14. Bench_ValidColor
      15. Bench_ValidURL
  5. +Kohana/Database
    2. DB
    3. Database
    4. Database_Expression
    5. +Configuration
      1. Config_Database
      2. Config_Database_Reader
      3. Config_Database_Writer
    6. +Drivers
      1. Database_MySQL
      2. Database_PDO
    7. +Exceptions
      1. Database_Exception
    8. +Models
      1. Model_Database
    9. +Query
      1. Database_Query
      2. Database_Query_Builder
      3. Database_Query_Builder_Delete
      4. Database_Query_Builder_Insert
      5. Database_Query_Builder_Join
      6. Database_Query_Builder_Select
      7. Database_Query_Builder_Update
      8. Database_Query_Builder_Where
    10. +Query/Result
      1. Database_MySQL_Result
      2. Database_Result
      3. Database_Result_Cached
    11. +Session
      1. Session_Database
  6. +Kohana/Image
    2. Image
    3. +Drivers
      1. Image_GD
      2. Image_Imagick
  7. +Kohana/ORM
    2. ORM
    3. ORM_Validation_Exception
  8. +Kohana/UnitTest
    2. Unittest_Database_TestCase
    3. Unittest_Tests
  9. +Kohana/Userguide
    2. Kodoc
    3. Kodoc_Class
    4. Kodoc_Markdown
    5. Kodoc_Method
    6. Kodoc_Method_Param
    7. Kodoc_Property
    8. +Controllers
      1. Controller_Userguide
    9. +Undocumented
      1. Kodoc_Missing
  10. +[Unknown]
    2. Unittest_Helpers
    3. Unittest_TestCase
    4. Unittest_TestSuite

Num
extends Kohana_Num

Number helper class. Provides additional formatting methods that for working with numbers.

package
Kohana
category
Helpers
author
Kohana Team
copyright
© 2009-2012 Kohana Team
license
http://kohanaframework.org/license

Class declared in SYSPATH/classes/num.php on line 3.

Constants

Properties

Methods

Constants

ROUND_HALF_UP

integer 1

ROUND_HALF_DOWN

integer 2

ROUND_HALF_EVEN

integer 3

ROUND_HALF_ODD

integer 4

Properties

public static array $byte_units

Valid byte units => power of 2 that defines the unit's size

array(33) (
    "B" => integer 0
    "K" => integer 10
    "Ki" => integer 10
    "KB" => integer 10
    "KiB" => integer 10
    "M" => integer 20
    "Mi" => integer 20
    "MB" => integer 20
    "MiB" => integer 20
    "G" => integer 30
    "Gi" => integer 30
    "GB" => integer 30
    "GiB" => integer 30
    "T" => integer 40
    "Ti" => integer 40
    "TB" => integer 40
    "TiB" => integer 40
    "P" => integer 50
    "Pi" => integer 50
    "PB" => integer 50
    "PiB" => integer 50
    "E" => integer 60
    "Ei" => integer 60
    "EB" => integer 60
    "EiB" => integer 60
    "Z" => integer 70
    "Zi" => integer 70
    "ZB" => integer 70
    "ZiB" => integer 70
    "Y" => integer 80
    "Yi" => integer 80
    "YB" => integer 80
    "YiB" => integer 80
)

Methods

public static bytes( string $size ) (defined in Kohana_Num)

Converts a file size number to a byte value. File sizes are defined in the format: SB, where S is the size (1, 8.5, 300, etc.) and B is the byte unit (K, MiB, GB, etc.). All valid byte units are defined in Num::$byte_units

?
echo Num::bytes('200K');  // 204800
echo Num::bytes('5MiB');  // 5242880
echo Num::bytes('1000');  // 1000
echo Num::bytes('2.5GB'); // 2684354560

Parameters

  • string $size required - $bytes file size in SB format

Return Values

  • float

Source Code

?
public static function bytes($size)
{
    // Prepare the size
    $size = trim( (string) $size);
 
    // Construct an OR list of byte units for the regex
    $accepted = implode('|', array_keys(Num::$byte_units));
 
    // Construct the regex pattern for verifying the size format
    $pattern = '/^([0-9]+(?:\.[0-9]+)?)('.$accepted.')?$/Di';
 
    // Verify the size format and store the matching parts
    if ( ! preg_match($pattern, $size, $matches))
        throw new Kohana_Exception('The byte unit size, ":size", is improperly formatted.', array(
            ':size' => $size,
        ));
 
    // Find the float value of the size
    $size = (float) $matches[1];
 
    // Find the actual unit, assume B if no unit specified
    $unit = Arr::get($matches, 2, 'B');
 
    // Convert the size into bytes
    $bytes = $size * pow(2, Num::$byte_units[$unit]);
 
    return $bytes;
}

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

  • Since - 3.0.2

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';
    }
}

public static round( float $value [, integer $precision = integer 0 , integer $mode = integer 1 , boolean $native = bool TRUE ] ) (defined in Kohana_Num)

Round a number to a specified precision, using a specified tie breaking technique

Parameters

  • float $value required - Number to round
  • integer $precision = integer 0 - Desired precision
  • integer $mode = integer 1 - Tie breaking mode, accepts the PHP_ROUND_HALF_* constants
  • boolean $native = bool TRUE - Set to false to force use of the userland implementation

Return Values

  • float - Rounded number

Source Code

?
public static function round($value, $precision = 0, $mode = self::ROUND_HALF_UP, $native = true)
{
    if (version_compare(PHP_VERSION, '5.3', '>=') AND $native)
    {
        return round($value, $precision, $mode);
    }
 
    if ($mode === self::ROUND_HALF_UP)
    {
        return round($value, $precision);
    }
    else
    {
        $factor = ($precision === 0) ? 1 : pow(10, $precision);
 
        switch ($mode)
        {
            case self::ROUND_HALF_DOWN:
            case self::ROUND_HALF_EVEN:
            case self::ROUND_HALF_ODD:
                // Check if we have a rounding tie, otherwise we can just call round()
                if (($value * $factor) - floor($value * $factor) === 0.5)
                {
                    if ($mode === self::ROUND_HALF_DOWN)
                    {
                        // Round down operation, so we round down unless the value
                        // is -ve because up is down and down is up down there. ;)
                        $up = ($value < 0);
                    }
                    else
                    {
                        // Round up if the integer is odd and the round mode is set to even
                        // or the integer is even and the round mode is set to odd.
                        // Any other instance round down.
                        $up = ( ! ( ! (floor($value * $factor) & 1)) === ($mode === self::ROUND_HALF_EVEN));
                    }
 
                    if ($up)
                    {
                        $value = ceil($value * $factor);
                    }
                    else
                    {
                        $value = floor($value * $factor);
                    }
                    return $value / $factor;
                }
                else
                {
                    return round($value, $precision);
                }
            break;
        }
    }
}