Class Zend_Measure_Illumination

Description
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Measure/Illumination.php (line 38)

Zend_Measure_Abstract
   |
   --Zend_Measure_Illumination
Class Constant Summary
 FOOTCANDLE = 'FOOTCANDLE'
 KILOLUX = 'KILOLUX'
 LUMEN_PER_SQUARE_CENTIMETER = 'LUMEN_PER_SQUARE_CENTIMETER'
 LUMEN_PER_SQUARE_FOOT = 'LUMEN_PER_SQUARE_FOOT'
 LUMEN_PER_SQUARE_INCH = 'LUMEN_PER_SQUARE_INCH'
 LUMEN_PER_SQUARE_METER = 'LUMEN_PER_SQUARE_METER'
 LUX = 'LUX'
 METERCANDLE = 'METERCANDLE'
 MILLIPHOT = 'MILLIPHOT'
 NOX = 'NOX'
 PHOT = 'PHOT'
 STANDARD = 'LUX'
Method Summary
 boolean equals (Zend_Measure_Illumination $object)
 void setType (string $type)
 void setValue (integer|string $value, [string $type = null], [string|Zend_Locale $locale = null])
 Zend_Measure_Illumination __construct (integer|string $value, [string $type = null], [string|Zend_Locale $locale = null])
 string toString ()
 string __toString ()
Methods
equals (line 96)

Compare if the value and type is equal

  • access: public
boolean equals (Zend_Measure_Illumination $object)

Redefinition of:
Zend_Measure_Abstract::equals()
Compare if the value and type is equal
getConversionList (line 193)

Returns the conversion list

  • access: public
array getConversionList ()

Redefinition of:
Zend_Measure_Abstract::getConversionList()
Returns the conversion list
setType (line 149)

Set a new type, and convert the value

  • access: public
  • throws: Zend_Measure_Exception
void setType (string $type)
  • string $type: New type to set

Redefinition of:
Zend_Measure_Abstract::setType()
Sets the original type
setValue (line 114)

Set a new value

  • access: public
  • throws: Zend_Measure_Exception
void setValue (integer|string $value, [string $type = null], [string|Zend_Locale $locale = null])
  • integer|string $value: Value as string, integer, real or float
  • string $type: OPTIONAL A Zend_Measure_Illumination Type
  • string|Zend_Locale $locale: OPTIONAL Locale for parsing numbers

Redefinition of:
Zend_Measure_Abstract::setValue()
Sets the internal value
Constructor __construct (line 84)

Zend_Measure_Illumination provides an locale aware class for conversion and formatting of Illumination values

Zend_Measure $input can be a locale based input string or a value. $locale can be used to define that the input is made in a different language than the actual one.

  • access: public
  • throws: Zend_Measure_Exception
Zend_Measure_Illumination __construct (integer|string $value, [string $type = null], [string|Zend_Locale $locale = null])
  • integer|string $value: Value as string, integer, real or float
  • string $type: OPTIONAL A Zend_Measure_Illumination Type
  • string|Zend_Locale $locale: OPTIONAL Locale for parsing numbers
toString (line 171)

Returns a string representation

  • access: public
string toString ()

Redefinition of:
Zend_Measure_Abstract::toString()
Returns a string representation
__toString (line 182)

Returns a string representation

  • access: public
string __toString ()

Redefinition of:
Zend_Measure_Abstract::__toString()
Returns a string representation

Inherited Methods

Inherited From Zend_Measure_Abstract

 Zend_Measure_Abstract::equals()
 Zend_Measure_Abstract::getConversionList()
 Zend_Measure_Abstract::getType()
 Zend_Measure_Abstract::getValue()
 Zend_Measure_Abstract::serialize()
 Zend_Measure_Abstract::setType()
 Zend_Measure_Abstract::setValue()
 Zend_Measure_Abstract::toString()
 Zend_Measure_Abstract::__toString()
Class Constants
FOOTCANDLE = 'FOOTCANDLE' (line 43)
KILOLUX = 'KILOLUX' (line 44)
LUMEN_PER_SQUARE_CENTIMETER = 'LUMEN_PER_SQUARE_CENTIMETER' (line 45)
LUMEN_PER_SQUARE_FOOT = 'LUMEN_PER_SQUARE_FOOT' (line 46)
LUMEN_PER_SQUARE_INCH = 'LUMEN_PER_SQUARE_INCH' (line 47)
LUMEN_PER_SQUARE_METER = 'LUMEN_PER_SQUARE_METER' (line 48)
LUX = 'LUX' (line 49)
METERCANDLE = 'METERCANDLE' (line 50)
MILLIPHOT = 'MILLIPHOT' (line 51)
NOX = 'NOX' (line 52)
PHOT = 'PHOT' (line 53)
STANDARD = 'LUX' (line 41)

Documentation generated on Thu, 18 Jan 2007 09:55:26 -0800 by phpDocumentor 1.3.1