Zend_Measure_Abstract Class Reference

Inheritance diagram for Zend_Measure_Abstract:

Public Member Functions
	__construct ($value, $type=null, $locale=null)
	getLocale ()
	setLocale ($locale=null, $check=false)
	getValue ($round=-1, $locale=null)
	setValue ($value, $type=null, $locale=null)
	getType ()
	setType ($type)
	equals ($object)
	toString ($round=-1, $locale=null)
	__toString ()
	getConversionList ()
	convertTo ($type, $round=2, $locale=null)
	add ($object)
	sub ($object)
	compare ($object)

Protected Attributes
	$_value
	$_type
	$_locale = null
	$_units = array()

Detailed Description

Definition at line 46 of file Abstract.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$value,
			$type = null,
			$locale = null
	)

Zend_Measure_Abstract is an abstract class for the different measurement types

Parameters

mixed	$value	Value as string, integer, real or float
int	$type	OPTIONAL a measure type f.e. Zend_Measure_Length::METER
Zend_Locale	$locale	OPTIONAL a Zend_Locale Type

Exceptions

Zend_Measure_Exception

Definition at line 82 of file Abstract.php.

    {
        if (($type !== null) and (Zend_Locale::isLocale($type, null, false))) {
            $locale = $type;
            $type = null;
        }

        $this->setLocale($locale);
        if ($type === null) {
            $type = $this->_units['STANDARD'];
        }

        if (isset($this->_units[$type]) === false) {
            #require_once 'Zend/Measure/Exception.php';
            throw new Zend_Measure_Exception("Type ($type) is unknown");
        }

        $this->setValue($value, $type, $this->_locale);
    }

Member Function Documentation

__toString()

__toString

(

)

Returns a string representation

Returns

string

Definition at line 340 of file Abstract.php.

    {
        return $this->toString();
    }

add()

add

(

$object

)

Adds an unit to another one

Parameters

Zend_Measure_Abstract

$object

object of same unit type

Returns

Zend_Measure_Abstract

Definition at line 375 of file Abstract.php.

    {
        $object->setType($this->getType());
        $value  = $this->getValue(-1) + $object->getValue(-1);

        $this->setValue($value, $this->getType(), $this->_locale);
        return $this;
    }

compare()

compare

(

$object

)

Compares two units

Parameters

Zend_Measure_Abstract

$object

object of same unit type

Returns

boolean

Definition at line 405 of file Abstract.php.

    {
        $object->setType($this->getType());
        $value  = $this->getValue(-1) - $object->getValue(-1);

        if ($value < 0) {
            return -1;
        } else if ($value > 0) {
            return 1;
        }

        return 0;
    }

convertTo()

convertTo	(		$type,
			$round = 2,
			$locale = null
	)

Alias function for setType returning the converted unit

Parameters

string	$type	Constant Type
integer	$round	(Optional) Rounds the value to a given precision
string | Zend_Locale	$locale	(Optional) Locale to set for the number

Returns

string

Definition at line 363 of file Abstract.php.

    {
        $this->setType($type);
        return $this->toString($round, $locale);
    }

equals()

equals

(

$object

)

Compare if the value and type is equal

Parameters

Zend_Measure_Abstract

$object

object to compare

Returns

boolean

Definition at line 310 of file Abstract.php.

    {
        if ((string) $object == $this->toString()) {
            return true;
        }

        return false;
    }

getConversionList()

getConversionList

(

)

Returns the conversion list

Returns

array

Definition at line 350 of file Abstract.php.

    {
        return $this->_units;
    }

getLocale()

getLocale

(

)

Returns the actual set locale

Returns

string

Definition at line 107 of file Abstract.php.

    {
        return $this->_locale;
    }

getType()

getType

(

)

Returns the original type

Returns

type

Definition at line 218 of file Abstract.php.

    {
        return $this->_type;
    }

getValue()

getValue	(		$round = -1,
			$locale = null
	)

Returns the internal value

Parameters

integer	$round	(Optional) Rounds the value to an given precision, Default is -1 which returns without rounding
string | Zend_Locale	$locale	(Optional) Locale for number representation

Returns

integer|string

Definition at line 155 of file Abstract.php.

    {
        if ($round < 0) {
            $return = $this->_value;
        } else {
            $return = Zend_Locale_Math::round($this->_value, $round);
        }

        if ($locale !== null) {
            $this->setLocale($locale, true);
            return Zend_Locale_Format::toNumber($return, array('locale' => $locale));
        }

        return $return;
    }

setLocale()

setLocale	(		$locale = null,
			$check = false
	)

Sets a new locale for the value representation

Parameters

string | Zend_Locale	$locale	(Optional) New locale to set
boolean	$check	False, check but don't set; True, set the new locale

Returns

Zend_Measure_Abstract

Definition at line 119 of file Abstract.php.

    {
        if (empty($locale)) {
            #require_once 'Zend/Registry.php';
            if (Zend_Registry::isRegistered('Zend_Locale') === true) {
                $locale = Zend_Registry::get('Zend_Locale');
            }
        }

        if ($locale === null) {
            $locale = new Zend_Locale();
        }

        if (!Zend_Locale::isLocale($locale, true, false)) {
            if (!Zend_Locale::isLocale($locale, false, false)) {
                #require_once 'Zend/Measure/Exception.php';
                throw new Zend_Measure_Exception("Language (" . (string) $locale . ") is unknown");
            }

            $locale = new Zend_Locale($locale);
        }

        if (!$check) {
            $this->_locale = (string) $locale;
        }
        return $this;
    }

setType()

setType

(

$type

)

Set a new type, and convert the value

Parameters

string

$type

New type to set

Exceptions

Zend_Measure_Exception

Returns

Zend_Measure_Abstract

Definition at line 230 of file Abstract.php.

    {
        if (empty($this->_units[$type])) {
            #require_once 'Zend/Measure/Exception.php';
            throw new Zend_Measure_Exception("Type ($type) is unknown");
        }

        if (empty($this->_type)) {
            $this->_type = $type;
        } else {
            // Convert to standard value
            $value = $this->_value;
            if (is_array($this->_units[$this->getType()][0])) {
                foreach ($this->_units[$this->getType()][0] as $key => $found) {
                    switch ($key) {
                        case "/":
                            if ($found != 0) {
                                $value = call_user_func(Zend_Locale_Math::$div, $value, $found, 25);
                            }
                            break;
                        case "+":
                            $value = call_user_func(Zend_Locale_Math::$add, $value, $found, 25);
                            break;
                        case "-":
                            $value = call_user_func(Zend_Locale_Math::$sub, $value, $found, 25);
                            break;
                        default:
                            $value = call_user_func(Zend_Locale_Math::$mul, $value, $found, 25);
                            break;
                    }
                }
            } else {
                $value = call_user_func(Zend_Locale_Math::$mul, $value, $this->_units[$this->getType()][0], 25);
            }

            // Convert to expected value
            if (is_array($this->_units[$type][0])) {
                foreach (array_reverse($this->_units[$type][0]) as $key => $found) {
                    switch ($key) {
                        case "/":
                            $value = call_user_func(Zend_Locale_Math::$mul, $value, $found, 25);
                            break;
                        case "+":
                            $value = call_user_func(Zend_Locale_Math::$sub, $value, $found, 25);
                            break;
                        case "-":
                            $value = call_user_func(Zend_Locale_Math::$add, $value, $found, 25);
                            break;
                        default:
                            if ($found != 0) {
                                $value = call_user_func(Zend_Locale_Math::$div, $value, $found, 25);
                            }
                            break;
                    }
                }
            } else {
                $value = call_user_func(Zend_Locale_Math::$div, $value, $this->_units[$type][0], 25);
            }

            $slength = strlen($value);
            $length  = 0;
            for($i = 1; $i <= $slength; ++$i) {
                if ($value[$slength - $i] != '0') {
                    $length = 26 - $i;
                    break;
                }
            }

            $this->_value = Zend_Locale_Math::round($value, $length);
            $this->_type  = $type;
        }
        return $this;
    }

setValue()

setValue	(		$value,
			$type = null,
			$locale = null
	)

Set a new value

Parameters

integer | string	$value	Value as string, integer, real or float
string	$type	OPTIONAL A measure type f.e. Zend_Measure_Length::METER
string | Zend_Locale	$locale	OPTIONAL Locale for parsing numbers

Exceptions

Zend_Measure_Exception

Returns

Zend_Measure_Abstract

Definition at line 180 of file Abstract.php.

    {
        if (($type !== null) and (Zend_Locale::isLocale($type, null, false))) {
            $locale = $type;
            $type = null;
        }

        if ($locale === null) {
            $locale = $this->_locale;
        }

        $this->setLocale($locale, true);
        if ($type === null) {
            $type = $this->_units['STANDARD'];
        }

        if (empty($this->_units[$type])) {
            #require_once 'Zend/Measure/Exception.php';
            throw new Zend_Measure_Exception("Type ($type) is unknown");
        }

        try {
            $value = Zend_Locale_Format::getNumber($value, array('locale' => $locale));
        } catch(Exception $e) {
            #require_once 'Zend/Measure/Exception.php';
            throw new Zend_Measure_Exception($e->getMessage(), $e->getCode(), $e);
        }

        $this->_value = $value;
        $this->setType($type);
        return $this;
    }

sub()

sub

(

$object

)

Substracts an unit from another one

Parameters

Zend_Measure_Abstract

$object

object of same unit type

Returns

Zend_Measure_Abstract

Definition at line 390 of file Abstract.php.

    {
        $object->setType($this->getType());
        $value  = $this->getValue(-1) - $object->getValue(-1);

        $this->setValue($value, $this->getType(), $this->_locale);
        return $this;
    }

toString()

toString	(		$round = -1,
			$locale = null
	)

Returns a string representation

Parameters

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

Returns

string

Definition at line 326 of file Abstract.php.

    {
        if ($locale === null) {
            $locale = $this->_locale;
        }

        return $this->getValue($round, $locale) . ' ' . $this->_units[$this->getType()][1];
    }

Field Documentation

$_locale

string $_locale = null

protected

Locale identifier

Definition at line 67 of file Abstract.php.

$_type

string $_type

protected

Original type for this unit

Definition at line 60 of file Abstract.php.

$_units

$_units = array()

protected

Unit types for this measurement

Definition at line 72 of file Abstract.php.

$_value

string $_value

protected

Plain value in standard unit

Definition at line 53 of file Abstract.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Measure/Abstract.php