Measure/Abstract.php

Show:

inherited

Classes
- \Zend_Measure_Abstract

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 [email protected] 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: Abstract.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Measure_Abstract
jump to top

Package: Zend\Measure\Zend\Measure\Abstract

Abstract class for all measurements

Children: \Zend_Measure_Lightness; \Zend_Measure_Pressure; \Zend_Measure_Power; \Zend_Measure_Length; \Zend_Measure_Area; \Zend_Measure_Speed; \Zend_Measure_Energy; \Zend_Measure_Density; \Zend_Measure_Time; \Zend_Measure_Angle; \Zend_Measure_Binary; \Zend_Measure_Frequency; \Zend_Measure_Weight; \Zend_Measure_Volume; \Zend_Measure_Capacitance; \Zend_Measure_Illumination; \Zend_Measure_Acceleration; \Zend_Measure_Temperature; \Zend_Measure_Flow_Mass; \Zend_Measure_Flow_Mole; \Zend_Measure_Flow_Volume; \Zend_Measure_Cooking_Weight; \Zend_Measure_Cooking_Volume; \Zend_Measure_Current; \Zend_Measure_Force; \Zend_Measure_Torque; \Zend_Measure_Viscosity_Dynamic; \Zend_Measure_Viscosity_Kinematic; \Zend_Measure_Number
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $_locale = null

Locale identifier

Default valuenullDetails

Type: string

string $_type =

Original type for this unit

Details

Type: string

$_units = array()

Unit types for this measurement

Default valuearray()Details

Type: n/a

string $_value =

Plain value in standard unit

Details

Type: string

Methods

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

Zend_Measure_Abstract is an abstract class for the different measurement types

Parameters

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

Throws

Exception	Description
\Zend_Measure_Exception

__toString() : string

Returns a string representation

Returns

Type	Description
string

add(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract

Adds an unit to another one

Parameters

Name	Type	Description
$object	\Zend_Measure_Abstract	object of same unit type

Returns

Type	Description
\Zend_Measure_Abstract

compare(\Zend_Measure_Abstract $object) : boolean

Compares two units

Parameters

Name	Type	Description
$object	\Zend_Measure_Abstract	object of same unit type

Returns

Type	Description
boolean

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

Alias function for setType returning the converted unit

Parameters

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

Returns

Type	Description
string

equals(\Zend_Measure_Abstract $object) : boolean

Compare if the value and type is equal

Parameters

Name	Type	Description
$object	\Zend_Measure_Abstract	object to compare

Returns

Type	Description
boolean

getConversionList() : array

Returns the conversion list

Returns

Type	Description
array

getLocale() : string

Returns the actual set locale

Returns

Type	Description
string

getType() : \type

Returns the original type

Returns

Type	Description
\type

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

Returns the internal value

Parameters

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

Returns

Type	Description
integer \| string

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

Sets a new locale for the value representation

Parameters

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

Returns

Type	Description
\Zend_Measure_Abstract

setType(string $type) : \Zend_Measure_Abstract

Set a new type, and convert the value

Parameters

Name	Type	Description
$type	string	New type to set

Returns

Type	Description
\Zend_Measure_Abstract

Throws

Exception	Description
\Zend_Measure_Exception

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

Set a new value

Parameters

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

Returns

Type	Description
\Zend_Measure_Abstract

Throws

Exception	Description
\Zend_Measure_Exception

sub(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract

Substracts an unit from another one

Parameters

Name	Type	Description
$object	\Zend_Measure_Abstract	object of same unit type

Returns

Type	Description
\Zend_Measure_Abstract

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

Returns a string representation

Parameters

Name	Type	Description
$round	integer	(Optional) Runds the value to an given exception
$locale	string \| \Zend_Locale	(Optional) Locale to set for the number

Returns

Type	Description
string

Measure/Abstract.php

\Zend_Measure_Abstractjump to top

Properties

Methods

\Zend_Measure_Abstract
jump to top