Zend Framework API Documentation » \Zend_Measure

Class for handling area conversions

category	Zend
package	Zend_Measure
subpackage	Zend_Measure_Area
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 area units

$_units : array

Default

array('ACRE' => array('4046.856422', 'A'), 'ACRE_COMMERCIAL' => array('3344.50944', 'A'), 'ACRE_SURVEY' => array('4046.872627', 'A'), 'ACRE_IRELAND' => array('6555', 'A'), 'ARE' => array('100', 'a'), 'ARPENT' => array('3418.89', 'arpent'), 'BARN' => array('1e-28', 'b'), 'BOVATE' => array('60000', 'bovate'), 'BUNDER' => array('10000', 'bunder'), 'CABALLERIA' => array('400000', 'caballeria'), 'CABALLERIA_AMERICA' => array('450000', 'caballeria'), 'CABALLERIA_CUBA' => array('134200', 'caballeria'), 'CARREAU' => array('12900', 'carreau'), 'CARUCATE' => array('486000', 'carucate'), 'CAWNEY' => array('5400', 'cawney'), 'CENTIARE' => array('1', 'ca'), 'CONG' => array('1000', 'cong'), 'COVER' => array('2698', 'cover'), 'CUERDA' => array('3930', 'cda'), 'DEKARE' => array('1000', 'dekare'), 'DESSIATINA' => array('10925', 'dessiantina'), 'DHUR' => array('16.929', 'dhur'), 'DUNUM' => array('1000', 'dunum'), 'DUNHAM' => array('1000', 'dunham'), 'FALL_SCOTS' => array('32.15', 'fall'), 'FALL' => array('47.03', 'fall'), 'FANEGA' => array('6430', 'fanega'), 'FARTHINGDALE' => array('1012', 'farthingdale'), 'HACIENDA' => array('89600000', 'hacienda'), 'HECTARE' => array('10000', 'ha'), 'HIDE' => array('486000', 'hide'), 'HOMESTEAD' => array('647500', 'homestead'), 'HUNDRED' => array('50000000', 'hundred'), 'JERIB' => array('2000', 'jerib'), 'JITRO' => array('5755', 'jitro'), 'JOCH' => array('5755', 'joch'), 'JUTRO' => array('5755', 'jutro'), 'JO' => array('1.62', 'jo'), 'KAPPLAND' => array('154.26', 'kappland'), 'KATTHA' => array('338', 'kattha'), 'LABOR' => array('716850', 'labor'), 'LEGUA' => array('17920000', 'legua'), 'MANZANA_COSTA_RICA' => array('6988.96', 'manzana'), 'MANZANA' => array('10000', 'manzana'), 'MORGEN' => array('2500', 'morgen'), 'MORGEN_AFRICA' => array('8567', 'morgen'), 'MU' => array(array('' => '10000', '/' => '15'), 'mu'), 'NGARN' => array('400', 'ngarn'), 'NOOK' => array('80937.128', 'nook'), 'OXGANG' => array('60000', 'oxgang'), 'PERCH' => array('25.29285264', 'perch'), 'PERCHE' => array('34.19', 'perche'), 'PING' => array('3.305', 'ping'), 'PYONG' => array('3.306', 'pyong'), 'RAI' => array('1600', 'rai'), 'ROOD' => array('1011.7141', 'rood'), 'SECTION' => array('2589998.5', 'sec'), 'SHED' => array('10e-52', 'shed'), 'SITIO' => array('18000000', 'sitio'), 'SQUARE' => array('9.290304', 'sq'), 'SQUARE_ANGSTROM' => array('1.0e-20', 'A²'), 'SQUARE_ASTRONOMICAL_UNIT' => array('2.2379523e+22', 'AU²'), 'SQUARE_ATTOMETER' => array('1.0e-36', 'am²'), 'SQUARE_BICRON' => array('1.0e-24', 'µµ²'), 'SQUARE_CENTIMETER' => array('0.0001', 'cm²'), 'SQUARE_CHAIN' => array('404.68726', 'ch²'), 'SQUARE_CHAIN_ENGINEER' => array('929.03412', 'ch²'), 'SQUARE_CITY_BLOCK_US_EAST' => array('4.97027584', 'sq block'), 'SQUARE_CITY_BLOCK_US_WEST' => array('17.141056', 'sq block'), 'SQUARE_CITY_BLOCK_US_SOUTH' => array('99.88110336', 'sq block'), 'SQUARE_CUBIT' => array('0.20903184', 'sq cubit'), 'SQUARE_DECIMETER' => array('0.01', 'dm²'), 'SQUARE_DEKAMETER' => array('100', 'dam²'), 'SQUARE_EXAMETER' => array('1.0e+36', 'Em²'), 'SQUARE_FATHOM' => array('3.3445228', 'fth²'), 'SQUARE_FEMTOMETER' => array('1.0e-30', 'fm²'), 'SQUARE_FERMI' => array('1.0e-30', 'f²'), 'SQUARE_FOOT' => array('0.09290304', 'ft²'), 'SQUARE_FOOT_SURVEY' => array('0.092903412', 'ft²'), 'SQUARE_FURLONG' => array('40468.726', 'fur²'), 'SQUARE_GIGAMETER' => array('1.0e+18', 'Gm²'), 'SQUARE_HECTOMETER' => array('10000', 'hm²'), 'SQUARE_INCH' => array(array('' => '0.09290304', '/' => '144'), 'in²'), 'SQUARE_INCH_SURVEY' => array(array('' => '0.092903412', '/' => '144'), 'in²'), 'SQUARE_KILOMETER' => array('1000000', 'km²'), 'SQUARE_LEAGUE_NAUTIC' => array('3.0869136e+07', 'sq league'), 'SQUARE_LEAGUE' => array('2.3309986e+07', 'sq league'), 'SQUARE_LIGHT_YEAR' => array('8.9505412e+31', 'ly²'), 'SQUARE_LINK' => array('0.040468726', 'sq link'), 'SQUARE_LINK_ENGINEER' => array('0.092903412', 'sq link'), 'SQUARE_MEGAMETER' => array('1.0e+12', 'Mm²'), 'SQUARE_METER' => array('1', 'm²'), 'SQUARE_MICROINCH' => array(array('' => '1.0e-6', '*' => '6.4516e-10'), 'µin²'), 'SQUARE_MICROMETER' => array('1.0e-12', 'µm²'), 'SQUARE_MICROMICRON' => array('1.0e-24', 'µµ²'), 'SQUARE_MICRON' => array('1.0e-12', 'µ²'), 'SQUARE_MIL' => array('6.4516e-10', 'sq mil'), 'SQUARE_MILE' => array(array('' => '0.09290304', '*' => '27878400'), 'mi²'), 'SQUARE_MILE_NAUTIC' => array('3429904', 'mi²'), 'SQUARE_MILE_SURVEY' => array('2589998.5', 'mi²'), 'SQUARE_MILLIMETER' => array('0.000001', 'mm²'), 'SQUARE_MILLIMICRON' => array('1.0e-18', 'mµ²'), 'SQUARE_MYRIAMETER' => array('1.0e+8', 'mym²'), 'SQUARE_NANOMETER' => array('1.0e-18', 'nm²'), 'SQUARE_PARIS_FOOT' => array('0.1055', 'sq paris foot'), 'SQUARE_PARSEC' => array('9.5214087e+32', 'pc²'), 'SQUARE_PERCH' => array('25.292954', 'sq perch'), 'SQUARE_PERCHE' => array('51.072', 'sq perche'), 'SQUARE_PETAMETER' => array('1.0e+30', 'Pm²'), 'SQUARE_PICOMETER' => array('1.0e-24', 'pm²'), 'SQUARE_ROD' => array(array('' => '0.092903412', '*' => '272.25'), 'rd²'), 'SQUARE_TENTHMETER' => array('1.0e-20', 'sq tenth-meter'), 'SQUARE_TERAMETER' => array('1.0e+24', 'Tm²'), 'SQUARE_THOU' => array('6.4516e-10', 'sq thou'), 'SQUARE_VARA' => array('0.70258205', 'sq vara'), 'SQUARE_VARA_TEXAS' => array('0.71684731', 'sq vara'), 'SQUARE_YARD' => array('0.83612736', 'yd²'), 'SQUARE_YARD_SURVEY' => array('0.836130708', 'yd²'), 'SQUARE_YOCTOMETER' => array('1.0e-48', 'ym²'), 'SQUARE_YOTTAMETER' => array('1.0e+48', 'Ym²'), 'STANG' => array('2709', 'stang'), 'STREMMA' => array('1000', 'stremma'), 'TAREA' => array('628.8', 'tarea'), 'TATAMI' => array('1.62', 'tatami'), 'TONDE_LAND' => array('5516', 'tonde land'), 'TOWNSHIP' => array('93239945.3196288', 'twp'), 'TSUBO' => array('3.3058', 'tsubo'), 'TUNNLAND' => array('4936.4', 'tunnland'), 'YARD' => array('0.83612736', 'yd'), 'VIRGATE' => array('120000', 'virgate'), 'STANDARD' => 'SQUARE_METER')

inherited_from	\Zend_Measure_Abstract::_units

Unit types for this measurement

$_units

Default

array()

Plain value in standard unit

$_value : string

Default

Constants

ACRE

ACRE = 'ACRE'

ACRE_COMMERCIAL

ACRE_COMMERCIAL = 'ACRE_COMMERCIAL'

ACRE_IRELAND

ACRE_IRELAND = 'ACRE_IRELAND'

ACRE_SURVEY

ACRE_SURVEY = 'ACRE_SURVEY'

ARE

ARE = 'ARE'

ARPENT

ARPENT = 'ARPENT'

BARN

BARN = 'BARN'

BOVATE

BOVATE = 'BOVATE'

BUNDER

BUNDER = 'BUNDER'

CABALLERIA

CABALLERIA = 'CABALLERIA'

CABALLERIA_AMERICA

CABALLERIA_AMERICA = 'CABALLERIA_AMERICA'

CABALLERIA_CUBA

CABALLERIA_CUBA = 'CABALLERIA_CUBA'

CARREAU

CARREAU = 'CARREAU'

CARUCATE

CARUCATE = 'CARUCATE'

CAWNEY

CAWNEY = 'CAWNEY'

CENTIARE

CENTIARE = 'CENTIARE'

CONG

CONG = 'CONG'

COVER

COVER = 'COVER'

CUERDA

CUERDA = 'CUERDA'

DEKARE

DEKARE = 'DEKARE'

DESSIATINA

DESSIATINA = 'DESSIATINA'

DHUR

DHUR = 'DHUR'

DUNHAM

DUNHAM = 'DUNHAM'

DUNUM

DUNUM = 'DUNUM'

FALL

FALL = 'FALL'

FALL_SCOTS

FALL_SCOTS = 'FALL_SCOTS'

FANEGA

FANEGA = 'FANEGA'

FARTHINGDALE

FARTHINGDALE = 'FARTHINGDALE'

HACIENDA

HACIENDA = 'HACIENDA'

HECTARE

HECTARE = 'HECTARE'

HIDE

HIDE = 'HIDE'

HOMESTEAD

HOMESTEAD = 'HOMESTEAD'

HUNDRED

HUNDRED = 'HUNDRED'

JERIB

JERIB = 'JERIB'

JITRO

JITRO = 'JITRO'

JO

JO = 'JO'

JOCH

JOCH = 'JOCH'

JUTRO

JUTRO = 'JUTRO'

KAPPLAND

KAPPLAND = 'KAPPLAND'

KATTHA

KATTHA = 'KATTHA'

LABOR

LABOR = 'LABOR'

LEGUA

LEGUA = 'LEGUA'

MANZANA

MANZANA = 'MANZANA'

MANZANA_COSTA_RICA

MANZANA_COSTA_RICA = 'MANZANA_COSTA_RICA'

MORGEN

MORGEN = 'MORGEN'

MORGEN_AFRICA

MORGEN_AFRICA = 'MORGEN_AFRICA'

MU

MU = 'MU'

NGARN

NGARN = 'NGARN'

NOOK

NOOK = 'NOOK'

OXGANG

OXGANG = 'OXGANG'

PERCH

PERCH = 'PERCH'

PERCHE

PERCHE = 'PERCHE'

PING

PING = 'PING'

PYONG

PYONG = 'PYONG'

RAI

RAI = 'RAI'

ROOD

ROOD = 'ROOD'

SECTION

SECTION = 'SECTION'

SHED

SHED = 'SHED'

SITIO

SITIO = 'SITIO'

SQUARE

SQUARE = 'SQUARE'

SQUARE_ANGSTROM

SQUARE_ANGSTROM = 'SQUARE_ANGSTROM'

SQUARE_ASTRONOMICAL_UNIT

SQUARE_ASTRONOMICAL_UNIT = 'SQUARE_ASTRONOMICAL_UNIT'

SQUARE_ATTOMETER

SQUARE_ATTOMETER = 'SQUARE_ATTOMETER'

SQUARE_BICRON

SQUARE_BICRON = 'SQUARE_BICRON'

SQUARE_CENTIMETER

SQUARE_CENTIMETER = 'SQUARE_CENTIMETER'

SQUARE_CHAIN

SQUARE_CHAIN = 'SQUARE_CHAIN'

SQUARE_CHAIN_ENGINEER

SQUARE_CHAIN_ENGINEER = 'SQUARE_CHAIN_ENGINEER'

SQUARE_CITY_BLOCK_US_EAST

SQUARE_CITY_BLOCK_US_EAST = 'SQUARE_CITY_BLOCK_US_EAST'

SQUARE_CITY_BLOCK_US_SOUTH

SQUARE_CITY_BLOCK_US_SOUTH = 'SQUARE_CITY_BLOCK_US_SOUTH'

SQUARE_CITY_BLOCK_US_WEST

SQUARE_CITY_BLOCK_US_WEST = 'SQUARE_CITY_BLOCK_US_WEST'

SQUARE_CUBIT

SQUARE_CUBIT = 'SQUARE_CUBIT'

SQUARE_DECIMETER

SQUARE_DECIMETER = 'SQUARE_DECIMETER'

SQUARE_DEKAMETER

SQUARE_DEKAMETER = 'SQUARE_DEKAMETER'

SQUARE_EXAMETER

SQUARE_EXAMETER = 'SQUARE_EXAMETER'

SQUARE_FATHOM

SQUARE_FATHOM = 'SQUARE_FATHOM'

SQUARE_FEMTOMETER

SQUARE_FEMTOMETER = 'SQUARE_FEMTOMETER'

SQUARE_FERMI

SQUARE_FERMI = 'SQUARE_FERMI'

SQUARE_FOOT

SQUARE_FOOT = 'SQUARE_FOOT'

SQUARE_FOOT_SURVEY

SQUARE_FOOT_SURVEY = 'SQUARE_FOOT_SURVEY'

SQUARE_FURLONG

SQUARE_FURLONG = 'SQUARE_FURLONG'

SQUARE_GIGAMETER

SQUARE_GIGAMETER = 'SQUARE_GIGAMETER'

SQUARE_HECTOMETER

SQUARE_HECTOMETER = 'SQUARE_HECTOMETER'

SQUARE_INCH

SQUARE_INCH = 'SQUARE_INCH'

SQUARE_INCH_SURVEY

SQUARE_INCH_SURVEY = 'SQUARE_INCH_SURVEY'

SQUARE_KILOMETER

SQUARE_KILOMETER = 'SQUARE_KILOMETER'

SQUARE_LEAGUE

SQUARE_LEAGUE = 'SQUARE_LEAGUE'

SQUARE_LEAGUE_NAUTIC

SQUARE_LEAGUE_NAUTIC = 'SQUARE_LEAGUE_NAUTIC'

SQUARE_LIGHT_YEAR

SQUARE_LIGHT_YEAR = 'SQUARE_LIGHT_YEAR'

SQUARE_LINK

SQUARE_LINK = 'SQUARE_LINK'

SQUARE_LINK_ENGINEER

SQUARE_LINK_ENGINEER = 'SQUARE_LINK_ENGINEER'

SQUARE_MEGAMETER

SQUARE_MEGAMETER = 'SQUARE_MEGAMETER'

SQUARE_METER

SQUARE_METER = 'SQUARE_METER'

SQUARE_MICROINCH

SQUARE_MICROINCH = 'SQUARE_MICROINCH'

SQUARE_MICROMETER

SQUARE_MICROMETER = 'SQUARE_MICROMETER'

SQUARE_MICROMICRON

SQUARE_MICROMICRON = 'SQUARE_MICROMICRON'

SQUARE_MICRON

SQUARE_MICRON = 'SQUARE_MICRON'

SQUARE_MIL

SQUARE_MIL = 'SQUARE_MIL'

SQUARE_MILE

SQUARE_MILE = 'SQUARE_MILE'

SQUARE_MILE_NAUTIC

SQUARE_MILE_NAUTIC = 'SQUARE_MILE_NAUTIC'

SQUARE_MILE_SURVEY

SQUARE_MILE_SURVEY = 'SQUARE_MILE_SURVEY'

SQUARE_MILLIMETER

SQUARE_MILLIMETER = 'SQUARE_MILLIMETER'

SQUARE_MILLIMICRON

SQUARE_MILLIMICRON = 'SQUARE_MILLIMICRON'

SQUARE_MYRIAMETER

SQUARE_MYRIAMETER = 'SQUARE_MYRIAMETER'

SQUARE_NANOMETER

SQUARE_NANOMETER = 'SQUARE_NANOMETER'

SQUARE_PARIS_FOOT

SQUARE_PARIS_FOOT = 'SQUARE_PARIS_FOOT'

SQUARE_PARSEC

SQUARE_PARSEC = 'SQUARE_PARSEC'

SQUARE_PERCH

SQUARE_PERCH = 'SQUARE_PERCH'

SQUARE_PERCHE

SQUARE_PERCHE = 'SQUARE_PERCHE'

SQUARE_PETAMETER

SQUARE_PETAMETER = 'SQUARE_PETAMETER'

SQUARE_PICOMETER

SQUARE_PICOMETER = 'SQUARE_PICOMETER'

SQUARE_ROD

SQUARE_ROD = 'SQUARE_ROD'

SQUARE_TENTHMETER

SQUARE_TENTHMETER = 'SQUARE_TENTHMETER'

SQUARE_TERAMETER

SQUARE_TERAMETER = 'SQUARE_TERAMETER'

SQUARE_THOU

SQUARE_THOU = 'SQUARE_THOU'

SQUARE_VARA

SQUARE_VARA = 'SQUARE_VARA'

SQUARE_VARA_TEXAS

SQUARE_VARA_TEXAS = 'SQUARE_VARA_TEXAS'

SQUARE_YARD

SQUARE_YARD = 'SQUARE_YARD'

SQUARE_YARD_SURVEY

SQUARE_YARD_SURVEY = 'SQUARE_YARD_SURVEY'

SQUARE_YOCTOMETER

SQUARE_YOCTOMETER = 'SQUARE_YOCTOMETER'

SQUARE_YOTTAMETER

SQUARE_YOTTAMETER = 'SQUARE_YOTTAMETER'

STANDARD

STANDARD = 'SQUARE_METER'

STANG

STANG = 'STANG'

STREMMA

STREMMA = 'STREMMA'

TAREA

TAREA = 'TAREA'

TATAMI

TATAMI = 'TATAMI'

TONDE_LAND

TONDE_LAND = 'TONDE_LAND'

TOWNSHIP

TOWNSHIP = 'TOWNSHIP'

TSUBO

TSUBO = 'TSUBO'

TUNNLAND

TUNNLAND = 'TUNNLAND'

VIRGATE

VIRGATE = 'VIRGATE'

YARD

YARD = 'YARD'