Measure/Cooking/Weight.php

Show:

inherited

Classes
- \Zend_Measure_Cooking_Weight

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: Weight.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Measure_Cooking_Weight
jump to top

Package: Zend\Measure\Zend\Measure\Cooking\Weight

Class for handling cooking weight 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

 
                STANDARD
                = 'GRAM'

 
                HALF_STICK
                = 'HALF_STICK'

 
                STICK
                = 'STICK'

 
                CUP
                = 'CUP'

 
                GRAM
                = 'GRAM'

 
                OUNCE
                = 'OUNCE'

 
                POUND
                = 'POUND'

 
                TEASPOON
                = 'TEASPOON'

 
                TEASPOON_US
                = 'TEASPOON_US'

 
                TABLESPOON
                = 'TABLESPOON'

 
                TABLESPOON_US
                = 'TABLESPOON_US'

Properties

string $_locale = null

inherited

Locale identifier

Inherited from: \Zend_Measure_Abstract::$$_locale

Default valuenullDetails

Type: string
Inherited_from: \Zend_Measure_Abstract::$$_locale

string $_type

inherited

Original type for this unit

Inherited from: \Zend_Measure_Abstract::$$_type

Details

Type: string
Inherited_from: \Zend_Measure_Abstract::$$_type

array $_units = array('HALF_STICK' => array(array('' => '453.59237', '/' => '8'), 'half stk'), 'STICK' => array(array('' => '453.59237', '/' => '4'), 'stk'), 'CUP' => array(array('' => '453.59237', '/' => '2'), 'c'), 'GRAM' => array('1', 'g'), 'OUNCE' => array(array('' => '453.59237', '/' => '16'), 'oz'), 'POUND' => array('453.59237', 'lb'), 'TEASPOON' => array(array('' => '1.2503332', '' => '453.59237', '/' => '128'), 'tsp'), 'TEASPOON_US' => array(array('' => '453.59237', '/' => '96'), 'tsp'), 'TABLESPOON' => array(array('' => '1.2503332', '' => '453.59237', '/' => '32'), 'tbsp'), 'TABLESPOON_US' => array(array('' => '453.59237', '/' => '32'), 'tbsp'), 'STANDARD' => 'GRAM')

Calculations for all cooking weight units

Default value

array('HALF_STICK' => array(array('' => '453.59237', '/' => '8'), 'half stk'), 'STICK' => array(array('' => '453.59237', '/' => '4'), 'stk'), 'CUP' => array(array('' => '453.59237', '/' => '2'), 'c'), 'GRAM' => array('1', 'g'), 'OUNCE' => array(array('' => '453.59237', '/' => '16'), 'oz'), 'POUND' => array('453.59237', 'lb'), 'TEASPOON' => array(array('' => '1.2503332', '' => '453.59237', '/' => '128'), 'tsp'), 'TEASPOON_US' => array(array('' => '453.59237', '/' => '96'), 'tsp'), 'TABLESPOON' => array(array('' => '1.2503332', '' => '453.59237', '/' => '32'), 'tbsp'), 'TABLESPOON_US' => array(array('' => '453.59237', '/' => '32'), 'tbsp'), 'STANDARD' => 'GRAM')

Details

Type: array

string $_value

inherited

Plain value in standard unit

Inherited from: \Zend_Measure_Abstract::$$_value

Details

Type: string
Inherited_from: \Zend_Measure_Abstract::$$_value

Methods

__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

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

inherited

Returns a string representation

Inherited from: \Zend_Measure_Abstract::__toString()

Returns

Type	Description
string

add(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract

inherited

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

compare(\Zend_Measure_Abstract $object) : boolean

inherited

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

convertTo(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

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

inherited

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

getConversionList() : array

inherited

Returns the conversion list

Inherited from: \Zend_Measure_Abstract::getConversionList()

Returns

Type	Description
array

getLocale() : string

inherited

Returns the actual set locale

Inherited from: \Zend_Measure_Abstract::getLocale()

Returns

Type	Description
string

getType() : \type

inherited

Returns the original type

Inherited from: \Zend_Measure_Abstract::getType()

Returns

Type	Description
\type

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

inherited

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
integer \| string

setLocale(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

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

inherited

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

setValue(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

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

inherited

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

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

inherited

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

Measure/Cooking/Weight.php

\Zend_Measure_Cooking_Weightjump to top

Constants

Properties

Methods

\Zend_Measure_Cooking_Weight
jump to top