Measure/Binary.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

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

Package: Zend\Measure\Zend\Measure\Binary
Class for handling binary conversions
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

>VConstant  STANDARD = 'BYTE'
>VConstant  BIT = 'BIT'
>VConstant  CRUMB = 'CRUMB'
>VConstant  NIBBLE = 'NIBBLE'
>VConstant  BYTE = 'BYTE'
>VConstant  KILOBYTE = 'KILOBYTE'
>VConstant  KIBIBYTE = 'KIBIBYTE'
>VConstant  KILO_BINARY_BYTE = 'KILO_BINARY_BYTE'
>VConstant  KILOBYTE_SI = 'KILOBYTE_SI'
>VConstant  MEGABYTE = 'MEGABYTE'
>VConstant  MEBIBYTE = 'MEBIBYTE'
>VConstant  MEGA_BINARY_BYTE = 'MEGA_BINARY_BYTE'
>VConstant  MEGABYTE_SI = 'MEGABYTE_SI'
>VConstant  GIGABYTE = 'GIGABYTE'
>VConstant  GIBIBYTE = 'GIBIBYTE'
>VConstant  GIGA_BINARY_BYTE = 'GIGA_BINARY_BYTE'
>VConstant  GIGABYTE_SI = 'GIGABYTE_SI'
>VConstant  TERABYTE = 'TERABYTE'
>VConstant  TEBIBYTE = 'TEBIBYTE'
>VConstant  TERA_BINARY_BYTE = 'TERA_BINARY_BYTE'
>VConstant  TERABYTE_SI = 'TERABYTE_SI'
>VConstant  PETABYTE = 'PETABYTE'
>VConstant  PEBIBYTE = 'PEBIBYTE'
>VConstant  PETA_BINARY_BYTE = 'PETA_BINARY_BYTE'
>VConstant  PETABYTE_SI = 'PETABYTE_SI'
>VConstant  EXABYTE = 'EXABYTE'
>VConstant  EXBIBYTE = 'EXBIBYTE'
>VConstant  EXA_BINARY_BYTE = 'EXA_BINARY_BYTE'
>VConstant  EXABYTE_SI = 'EXABYTE_SI'
>VConstant  ZETTABYTE = 'ZETTABYTE'
>VConstant  ZEBIBYTE = 'ZEBIBYTE'
>VConstant  ZETTA_BINARY_BYTE = 'ZETTA_BINARY_BYTE'
>VConstant  ZETTABYTE_SI = 'ZETTABYTE_SI'
>VConstant  YOTTABYTE = 'YOTTABYTE'
>VConstant  YOBIBYTE = 'YOBIBYTE'
>VConstant  YOTTA_BINARY_BYTE = 'YOTTA_BINARY_BYTE'
>VConstant  YOTTABYTE_SI = 'YOTTABYTE_SI'

Properties

>VPropertyprotectedstring $_locale = null
inherited
Locale identifier
Inherited from: \Zend_Measure_Abstract::$$_locale
Default valuenullDetails
Type
string
Inherited_from
\Zend_Measure_Abstract::$$_locale  
>VPropertyprotectedstring $_type
inherited
Original type for this unit
Inherited from: \Zend_Measure_Abstract::$$_type
Details
Type
string
Inherited_from
\Zend_Measure_Abstract::$$_type  
>VPropertyprotectedarray $_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')
Calculations for all binary units
Default valuearray('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
>VPropertyprotectedstring $_value
inherited
Plain value in standard unit
Inherited from: \Zend_Measure_Abstract::$$_value
Details
Type
string
Inherited_from
\Zend_Measure_Abstract::$$_value  

Methods

methodpublic__construct(mixed $value, int $type = null, \Zend_Locale $locale = null) : void
inherited

Zend_Measure_Abstract is an abstract class for the different measurement types

Inherited from: \Zend_Measure_Abstract::__construct()
Parameters
NameTypeDescription
$valuemixed

Value as string, integer, real or float

$typeint

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

$locale\Zend_Locale

OPTIONAL a Zend_Locale Type

Throws
ExceptionDescription
\Zend_Measure_Exception
methodpublic__toString() : string
inherited

Returns a string representation

Inherited from: \Zend_Measure_Abstract::__toString()
Returns
TypeDescription
string
methodpublicadd(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
inherited

Adds an unit to another one

Inherited from: \Zend_Measure_Abstract::add()
Parameters
NameTypeDescription
$object\Zend_Measure_Abstract

object of same unit type

Returns
TypeDescription
\Zend_Measure_Abstract
methodpubliccompare(\Zend_Measure_Abstract $object) : boolean
inherited

Compares two units

Inherited from: \Zend_Measure_Abstract::compare()
Parameters
NameTypeDescription
$object\Zend_Measure_Abstract

object of same unit type

Returns
TypeDescription
boolean
methodpublicconvertTo(string $type, integer $round = 2, string | \Zend_Locale $locale = null) : string
inherited

Alias function for setType returning the converted unit

Inherited from: \Zend_Measure_Abstract::convertTo()
Parameters
NameTypeDescription
$typestring

Constant Type

$roundinteger

(Optional) Rounds the value to a given precision

$localestring | \Zend_Locale

(Optional) Locale to set for the number

Returns
TypeDescription
string
methodpublicequals(\Zend_Measure_Abstract $object) : boolean
inherited

Compare if the value and type is equal

Inherited from: \Zend_Measure_Abstract::equals()
Parameters
NameTypeDescription
$object\Zend_Measure_Abstract

object to compare

Returns
TypeDescription
boolean
methodpublicgetConversionList() : array
inherited

Returns the conversion list

Inherited from: \Zend_Measure_Abstract::getConversionList()
Returns
TypeDescription
array
methodpublicgetLocale() : string
inherited

Returns the actual set locale

Inherited from: \Zend_Measure_Abstract::getLocale()
Returns
TypeDescription
string
methodpublicgetType() : \type
inherited

Returns the original type

Inherited from: \Zend_Measure_Abstract::getType()
Returns
TypeDescription
\type
methodpublicgetValue(integer $round = -1, string | \Zend_Locale $locale = null) : integer | string
inherited

Returns the internal value

Inherited from: \Zend_Measure_Abstract::getValue()
Parameters
NameTypeDescription
$roundinteger

(Optional) Rounds the value to an given precision, Default is -1 which returns without rounding

$localestring | \Zend_Locale

(Optional) Locale for number representation

Returns
TypeDescription
integer | string
methodpublicsetLocale(string | \Zend_Locale $locale = null, boolean $check = false) : \Zend_Measure_Abstract
inherited

Sets a new locale for the value representation

Inherited from: \Zend_Measure_Abstract::setLocale()
Parameters
NameTypeDescription
$localestring | \Zend_Locale

(Optional) New locale to set

$checkboolean

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

Returns
TypeDescription
\Zend_Measure_Abstract
methodpublicsetType(string $type) : \Zend_Measure_Abstract
inherited

Set a new type, and convert the value

Inherited from: \Zend_Measure_Abstract::setType()
Parameters
NameTypeDescription
$typestring

New type to set

Returns
TypeDescription
\Zend_Measure_Abstract
Throws
ExceptionDescription
\Zend_Measure_Exception
methodpublicsetValue(integer | string $value, string $type = null, string | \Zend_Locale $locale = null) : \Zend_Measure_Abstract
inherited

Set a new value

Inherited from: \Zend_Measure_Abstract::setValue()
Parameters
NameTypeDescription
$valueinteger | string

Value as string, integer, real or float

$typestring

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

$localestring | \Zend_Locale

OPTIONAL Locale for parsing numbers

Returns
TypeDescription
\Zend_Measure_Abstract
Throws
ExceptionDescription
\Zend_Measure_Exception
methodpublicsub(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
inherited

Substracts an unit from another one

Inherited from: \Zend_Measure_Abstract::sub()
Parameters
NameTypeDescription
$object\Zend_Measure_Abstract

object of same unit type

Returns
TypeDescription
\Zend_Measure_Abstract
methodpublictoString(integer $round = -1, string | \Zend_Locale $locale = null) : string
inherited

Returns a string representation

Inherited from: \Zend_Measure_Abstract::toString()
Parameters
NameTypeDescription
$roundinteger

(Optional) Runds the value to an given exception

$localestring | \Zend_Locale

(Optional) Locale to set for the number

Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.