Measure/Abstract.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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Measure  
Version
$Id$  

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_locale = null
Locale identifier
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_type
Original type for this unit
Details
Type
string
>VPropertyprotected$_units = array()
Unit types for this measurement
Default valuearray()Details
Type
n/a
>VPropertyprotectedstring $_value
Plain value in standard unit
Details
Type
string

Methods

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

Zend_Measure_Abstract is an abstract class for the different measurement types

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

Returns a string representation

Returns
TypeDescription
string
methodpublicadd(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract

Adds an unit to another one

Parameters
NameTypeDescription
$object\Zend_Measure_Abstract

object of same unit type

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

Compares two units

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

Alias function for setType returning the converted unit

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

Compare if the value and type is equal

Parameters
NameTypeDescription
$object\Zend_Measure_Abstract

object to compare

Returns
TypeDescription
boolean
methodpublicgetConversionList() : array

Returns the conversion list

Returns
TypeDescription
array
methodpublicgetLocale() : string

Returns the actual set locale

Returns
TypeDescription
string
methodpublicgetType() : \type

Returns the original type

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

Returns the internal value

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

Sets a new locale for the value representation

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

Set a new type, and convert the value

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

Set a new value

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

Substracts an unit from another one

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

Returns a string representation

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.2.0 .