Class for handling binary conversions

category Zend
package Zend_Measure
subpackage Zend_Measure_Binary
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Measure_Abstract

 Methods

Zend_Measure_Abstract is an abstract class for the different measurement types

__construct(mixed $value, integer $type = null, \Zend_Locale $locale = null
Inherited

Parameters

$value

mixed

Value as string, integer, real or float

$type

integer

OPTIONAL a measure type f.e. Zend_Measure_Length::METER

$locale

\Zend_Locale

OPTIONAL a Zend_Locale Type

Exceptions

\Zend_Measure_Exception

Returns a string representation

__toString() : string
Inherited

Returns

string

Adds an unit to another one

add(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

\Zend_Measure_Abstract

Compares two units

compare(\Zend_Measure_Abstract $object) : boolean
Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

boolean

Alias function for setType returning the converted unit

convertTo(string $type, integer $round = 2, string|\Zend_Locale $locale = null) : string
Inherited

Parameters

$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

Returns

string

Compare if the value and type is equal

equals(\Zend_Measure_Abstract $object) : boolean
Inherited

Parameters

$object

\Zend_Measure_Abstract

object to compare

Returns

boolean

Returns the conversion list

getConversionList() : array
Inherited

Returns

array

Returns the actual set locale

getLocale() : string
Inherited

Returns

string

Returns the original type

getType() : \type
Inherited

Returns

\type

Returns the internal value

getValue(integer $round = -1, string|\Zend_Locale $locale = null) : integer | string
Inherited

Parameters

$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

Returns

integerstring

Sets a new locale for the value representation

setLocale(string|\Zend_Locale $locale = null, boolean $check = false) : \Zend_Measure_Abstract
Inherited

Parameters

$locale

string\Zend_Locale

(Optional) New locale to set

$check

boolean

False, check but don't set; True, set the new locale

Returns

\Zend_Measure_Abstract

Set a new type, and convert the value

setType(string $type) : \Zend_Measure_Abstract
Inherited

Parameters

$type

string

New type to set

Exceptions

\Zend_Measure_Exception

Returns

\Zend_Measure_Abstract

Set a new value

setValue(integer|string $value, string $type = null, string|\Zend_Locale $locale = null) : \Zend_Measure_Abstract
Inherited

Parameters

$value

integerstring

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

Exceptions

\Zend_Measure_Exception

Returns

\Zend_Measure_Abstract

Substracts an unit from another one

sub(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

\Zend_Measure_Abstract

Returns a string representation

toString(integer $round = -1, string|\Zend_Locale $locale = null) : string
Inherited

Parameters

$round

integer

(Optional) Runds the value to an given exception

$locale

string\Zend_Locale

(Optional) Locale to set for the number

Returns

string

 Properties

 

Locale identifier

$_locale : string

Default

null
 

Original type for this unit

$_type : string

Default

 

Calculations for all binary units

$_units : array

Default

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')
inherited_from \Zend_Measure_Abstract::_units
 

Unit types for this measurement

$_units 

Default

array()
 

Plain value in standard unit

$_value : string

Default

 Constants

 

BIT

BIT = 'BIT' 
 

BYTE

BYTE = 'BYTE' 
 

CRUMB

CRUMB = 'CRUMB' 
 

EXABYTE

EXABYTE = 'EXABYTE' 
 

EXABYTE_SI

EXABYTE_SI = 'EXABYTE_SI' 
 

EXA_BINARY_BYTE

EXA_BINARY_BYTE = 'EXA_BINARY_BYTE' 
 

EXBIBYTE

EXBIBYTE = 'EXBIBYTE' 
 

GIBIBYTE

GIBIBYTE = 'GIBIBYTE' 
 

GIGABYTE

GIGABYTE = 'GIGABYTE' 
 

GIGABYTE_SI

GIGABYTE_SI = 'GIGABYTE_SI' 
 

GIGA_BINARY_BYTE

GIGA_BINARY_BYTE = 'GIGA_BINARY_BYTE' 
 

KIBIBYTE

KIBIBYTE = 'KIBIBYTE' 
 

KILOBYTE

KILOBYTE = 'KILOBYTE' 
 

KILOBYTE_SI

KILOBYTE_SI = 'KILOBYTE_SI' 
 

KILO_BINARY_BYTE

KILO_BINARY_BYTE = 'KILO_BINARY_BYTE' 
 

MEBIBYTE

MEBIBYTE = 'MEBIBYTE' 
 

MEGABYTE

MEGABYTE = 'MEGABYTE' 
 

MEGABYTE_SI

MEGABYTE_SI = 'MEGABYTE_SI' 
 

MEGA_BINARY_BYTE

MEGA_BINARY_BYTE = 'MEGA_BINARY_BYTE' 
 

NIBBLE

NIBBLE = 'NIBBLE' 
 

PEBIBYTE

PEBIBYTE = 'PEBIBYTE' 
 

PETABYTE

PETABYTE = 'PETABYTE' 
 

PETABYTE_SI

PETABYTE_SI = 'PETABYTE_SI' 
 

PETA_BINARY_BYTE

PETA_BINARY_BYTE = 'PETA_BINARY_BYTE' 
 

STANDARD

STANDARD = 'BYTE' 
 

TEBIBYTE

TEBIBYTE = 'TEBIBYTE' 
 

TERABYTE

TERABYTE = 'TERABYTE' 
 

TERABYTE_SI

TERABYTE_SI = 'TERABYTE_SI' 
 

TERA_BINARY_BYTE

TERA_BINARY_BYTE = 'TERA_BINARY_BYTE' 
 

YOBIBYTE

YOBIBYTE = 'YOBIBYTE' 
 

YOTTABYTE

YOTTABYTE = 'YOTTABYTE' 
 

YOTTABYTE_SI

YOTTABYTE_SI = 'YOTTABYTE_SI' 
 

YOTTA_BINARY_BYTE

YOTTA_BINARY_BYTE = 'YOTTA_BINARY_BYTE' 
 

ZEBIBYTE

ZEBIBYTE = 'ZEBIBYTE' 
 

ZETTABYTE

ZETTABYTE = 'ZETTABYTE' 
 

ZETTABYTE_SI

ZETTABYTE_SI = 'ZETTABYTE_SI' 
 

ZETTA_BINARY_BYTE

ZETTA_BINARY_BYTE = 'ZETTA_BINARY_BYTE'