API Documentation

Measure/Cooking/Weight.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Measure  
version
$Id: Weight.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Measure_Cooking_Weight

Class for handling cooking weight conversions

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

Constants

Constant  STANDARD = 'GRAM'
Constant  HALF_STICK = 'HALF_STICK'
Constant  STICK = 'STICK'
Constant  CUP = 'CUP'
Constant  GRAM = 'GRAM'
Constant  OUNCE = 'OUNCE'
Constant  POUND = 'POUND'
Constant  TEASPOON = 'TEASPOON'
Constant  TEASPOON_US = 'TEASPOON_US'
Constant  TABLESPOON = 'TABLESPOON'
Constant  TABLESPOON_US = 'TABLESPOON_US'

Properties

Propertyprotectedarray  $_units= 'array'

Calculations for all cooking weight units

Default valuearrayDetails
Type
array

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

Inherited from: \Zend_Measure_Abstract::__construct()
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
methodpublic__toString( ) : string

Returns a string representation

Inherited from: \Zend_Measure_Abstract::__toString()
Returns
Type Description
string
methodpublicadd( \Zend_Measure_Abstract $object ) : \Zend_Measure_Abstract

Adds an unit to another one

Inherited from: \Zend_Measure_Abstract::add()
Parameters
Name Type Description
$object \Zend_Measure_Abstract object of same unit type
Returns
Type Description
\Zend_Measure_Abstract
methodpubliccompare( \Zend_Measure_Abstract $object ) : boolean

Compares two units

Inherited from: \Zend_Measure_Abstract::compare()
Parameters
Name Type Description
$object \Zend_Measure_Abstract object of same unit type
Returns
Type Description
boolean
methodpublicconvertTo( string $type, integer $round = 2, string|\Zend_Locale $locale = null ) : string

Alias function for setType returning the converted unit

Inherited from: \Zend_Measure_Abstract::convertTo()
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
methodpublicequals( \Zend_Measure_Abstract $object ) : boolean

Compare if the value and type is equal

Inherited from: \Zend_Measure_Abstract::equals()
Parameters
Name Type Description
$object \Zend_Measure_Abstract object to compare
Returns
Type Description
boolean
methodpublicgetConversionList( ) : array

Returns the conversion list

Inherited from: \Zend_Measure_Abstract::getConversionList()
Returns
Type Description
array
methodpublicgetLocale( ) : string

Returns the actual set locale

Inherited from: \Zend_Measure_Abstract::getLocale()
Returns
Type Description
string
methodpublicgetType( ) : \type

Returns the original type

Inherited from: \Zend_Measure_Abstract::getType()
Returns
Type Description
\type
methodpublicgetValue( integer $round, string|\Zend_Locale $locale = null ) : integer|string

Returns the internal value

Inherited from: \Zend_Measure_Abstract::getValue()
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
integerstring
methodpublicsetLocale( string|\Zend_Locale $locale = null, boolean $check = false ) : \Zend_Measure_Abstract

Sets a new locale for the value representation

Inherited from: \Zend_Measure_Abstract::setLocale()
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
methodpublicsetType( string $type ) : \Zend_Measure_Abstract

Set a new type, and convert the value

Inherited from: \Zend_Measure_Abstract::setType()
Parameters
Name Type Description
$type string New type to set
Returns
Type Description
\Zend_Measure_Abstract
Throws
Exception Description
\Zend_Measure_Exception
methodpublicsetValue( integer|string $value, string $type = null, string|\Zend_Locale $locale = null ) : \Zend_Measure_Abstract

Set a new value

Inherited from: \Zend_Measure_Abstract::setValue()
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
methodpublicsub( \Zend_Measure_Abstract $object ) : \Zend_Measure_Abstract

Substracts an unit from another one

Inherited from: \Zend_Measure_Abstract::sub()
Parameters
Name Type Description
$object \Zend_Measure_Abstract object of same unit type
Returns
Type Description
\Zend_Measure_Abstract
methodpublictoString( integer $round, string|\Zend_Locale $locale = null ) : string

Returns a string representation

Inherited from: \Zend_Measure_Abstract::toString()
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
Documentation was generated by DocBlox 0.13.3.