Measure/Binary.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Measure
- Version
- $Id: Binary.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Measure_Binary
- Parent(s)
- \Zend_Measure_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


string $_locale = null
null
Details- Type
- string
- Inherited_from
- \Zend_Measure_Abstract::$$_locale


array $_units = array('BIT' => array('0.125', 'b'), 'CRUMB' => array('0.25', 'crumb'), 'NIBBLE' => array('0.5', 'nibble'), 'BYTE' => array('1', 'B'), 'KILOBYTE' => array('1024', 'kB'), 'KIBIBYTE' => array('1024', 'KiB'), 'KILO_BINARY_BYTE' => array('1024', 'KiB'), 'KILOBYTE_SI' => array('1000', 'kB.'), 'MEGABYTE' => array('1048576', 'MB'), 'MEBIBYTE' => array('1048576', 'MiB'), 'MEGA_BINARY_BYTE' => array('1048576', 'MiB'), 'MEGABYTE_SI' => array('1000000', 'MB.'), 'GIGABYTE' => array('1073741824', 'GB'), 'GIBIBYTE' => array('1073741824', 'GiB'), 'GIGA_BINARY_BYTE' => array('1073741824', 'GiB'), 'GIGABYTE_SI' => array('1000000000', 'GB.'), 'TERABYTE' => array('1099511627776', 'TB'), 'TEBIBYTE' => array('1099511627776', 'TiB'), 'TERA_BINARY_BYTE' => array('1099511627776', 'TiB'), 'TERABYTE_SI' => array('1000000000000', 'TB.'), 'PETABYTE' => array('1125899906842624', 'PB'), 'PEBIBYTE' => array('1125899906842624', 'PiB'), 'PETA_BINARY_BYTE' => array('1125899906842624', 'PiB'), 'PETABYTE_SI' => array('1000000000000000', 'PB.'), 'EXABYTE' => array('1152921504606846976', 'EB'), 'EXBIBYTE' => array('1152921504606846976', 'EiB'), 'EXA_BINARY_BYTE' => array('1152921504606846976', 'EiB'), 'EXABYTE_SI' => array('1000000000000000000', 'EB.'), 'ZETTABYTE' => array('1180591620717411303424', 'ZB'), 'ZEBIBYTE' => array('1180591620717411303424', 'ZiB'), 'ZETTA_BINARY_BYTE' => array('1180591620717411303424', 'ZiB'), 'ZETTABYTE_SI' => array('1000000000000000000000', 'ZB.'), 'YOTTABYTE' => array('1208925819614629174706176', 'YB'), 'YOBIBYTE' => array('1208925819614629174706176', 'YiB'), 'YOTTA_BINARY_BYTE' => array('1208925819614629174706176', 'YiB'), 'YOTTABYTE_SI' => array('1000000000000000000000000', 'YB.'), 'STANDARD' => 'BYTE')
array('BIT' => array('0.125', 'b'), 'CRUMB' => array('0.25', 'crumb'), 'NIBBLE' => array('0.5', 'nibble'), 'BYTE' => array('1', 'B'), 'KILOBYTE' => array('1024', 'kB'), 'KIBIBYTE' => array('1024', 'KiB'), 'KILO_BINARY_BYTE' => array('1024', 'KiB'), 'KILOBYTE_SI' => array('1000', 'kB.'), 'MEGABYTE' => array('1048576', 'MB'), 'MEBIBYTE' => array('1048576', 'MiB'), 'MEGA_BINARY_BYTE' => array('1048576', 'MiB'), 'MEGABYTE_SI' => array('1000000', 'MB.'), 'GIGABYTE' => array('1073741824', 'GB'), 'GIBIBYTE' => array('1073741824', 'GiB'), 'GIGA_BINARY_BYTE' => array('1073741824', 'GiB'), 'GIGABYTE_SI' => array('1000000000', 'GB.'), 'TERABYTE' => array('1099511627776', 'TB'), 'TEBIBYTE' => array('1099511627776', 'TiB'), 'TERA_BINARY_BYTE' => array('1099511627776', 'TiB'), 'TERABYTE_SI' => array('1000000000000', 'TB.'), 'PETABYTE' => array('1125899906842624', 'PB'), 'PEBIBYTE' => array('1125899906842624', 'PiB'), 'PETA_BINARY_BYTE' => array('1125899906842624', 'PiB'), 'PETABYTE_SI' => array('1000000000000000', 'PB.'), 'EXABYTE' => array('1152921504606846976', 'EB'), 'EXBIBYTE' => array('1152921504606846976', 'EiB'), 'EXA_BINARY_BYTE' => array('1152921504606846976', 'EiB'), 'EXABYTE_SI' => array('1000000000000000000', 'EB.'), 'ZETTABYTE' => array('1180591620717411303424', 'ZB'), 'ZEBIBYTE' => array('1180591620717411303424', 'ZiB'), 'ZETTA_BINARY_BYTE' => array('1180591620717411303424', 'ZiB'), 'ZETTABYTE_SI' => array('1000000000000000000000', 'ZB.'), 'YOTTABYTE' => array('1208925819614629174706176', 'YB'), 'YOBIBYTE' => array('1208925819614629174706176', 'YiB'), 'YOTTA_BINARY_BYTE' => array('1208925819614629174706176', 'YiB'), 'YOTTABYTE_SI' => array('1000000000000000000000000', 'YB.'), 'STANDARD' => 'BYTE')
Details- Type
- array
Methods


__construct(mixed $value, int $type = null, \Zend_Locale $locale = null) : void
Zend_Measure_Abstract is an abstract class for the different measurement types
Inherited from: \Zend_Measure_Abstract::__construct()Name | Type | Description |
---|---|---|
$value | mixed | Value as string, integer, real or float |
$type | int | OPTIONAL a measure type f.e. Zend_Measure_Length::METER |
$locale | \Zend_Locale | OPTIONAL a Zend_Locale Type |
Exception | Description |
---|---|
\Zend_Measure_Exception |


add(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
\Zend_Measure_Abstract |


compare(\Zend_Measure_Abstract $object) : boolean
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
boolean |


convertTo(string $type, integer $round = 2, string | \Zend_Locale $locale = null) : string
Alias function for setType returning the converted unit
Inherited from: \Zend_Measure_Abstract::convertTo()Name | Type | Description |
---|---|---|
$type | string | Constant Type |
$round | integer | (Optional) Rounds the value to a given precision |
$locale | string | \Zend_Locale | (Optional) Locale to set for the number |
Type | Description |
---|---|
string |


equals(\Zend_Measure_Abstract $object) : boolean
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object to compare |
Type | Description |
---|---|
boolean |


getValue(integer $round = -1, string | \Zend_Locale $locale = null) : integer | string
Name | Type | Description |
---|---|---|
$round | integer | (Optional) Rounds the value to an given precision, Default is -1 which returns without rounding |
$locale | string | \Zend_Locale | (Optional) Locale for number representation |
Type | Description |
---|---|
integer | string |


setLocale(string | \Zend_Locale $locale = null, boolean $check = false) : \Zend_Measure_Abstract
Sets a new locale for the value representation
Inherited from: \Zend_Measure_Abstract::setLocale()Name | Type | Description |
---|---|---|
$locale | string | \Zend_Locale | (Optional) New locale to set |
$check | boolean | False, check but don't set; True, set the new locale |
Type | Description |
---|---|
\Zend_Measure_Abstract |


setType(string $type) : \Zend_Measure_Abstract
Name | Type | Description |
---|---|---|
$type | string | New type to set |
Type | Description |
---|---|
\Zend_Measure_Abstract |
Exception | Description |
---|---|
\Zend_Measure_Exception |


setValue(integer | string $value, string $type = null, string | \Zend_Locale $locale = null) : \Zend_Measure_Abstract
Name | Type | Description |
---|---|---|
$value | integer | string | Value as string, integer, real or float |
$type | string | OPTIONAL A measure type f.e. Zend_Measure_Length::METER |
$locale | string | \Zend_Locale | OPTIONAL Locale for parsing numbers |
Type | Description |
---|---|
\Zend_Measure_Abstract |
Exception | Description |
---|---|
\Zend_Measure_Exception |


sub(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
\Zend_Measure_Abstract |


toString(integer $round = -1, string | \Zend_Locale $locale = null) : string
Name | Type | Description |
---|---|---|
$round | integer | (Optional) Runds the value to an given exception |
$locale | string | \Zend_Locale | (Optional) Locale to set for the number |
Type | Description |
---|---|
string |