Zend_Filter_Boolean Class Reference

Inheritance diagram for Zend_Filter_Boolean:

Public Member Functions
	__construct ($options=null)
	getType ()
	setType ($type=null)
	getLocale ()
	setLocale ($locale=null)
	getCasting ()
	setCasting ($casting=true)
	filter ($value)

Data Fields
const	BOOLEAN = 1
const	INTEGER = 2
const	FLOAT = 4
const	STRING = 8
const	ZERO = 16
const	EMPTY_ARRAY = 32
const	NULL = 64
const	PHP = 127
const	FALSE_STRING = 128
const	YES = 256
const	ALL = 511

Protected Member Functions
	_getLocalizedQuestion ($value, $yes, $locale)

Protected Attributes
	$_constants
	$_type = self::PHP
	$_locale = array('auto')
	$_casting = true

Detailed Description

Definition at line 33 of file Boolean.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

string | array | Zend_Config

$options

OPTIONAL

Definition at line 87 of file Boolean.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (!is_array($options)) {
            $options = func_get_args();
            $temp    = array();
            if (!empty($options)) {
                $temp['type'] = array_shift($options);
            }

            if (!empty($options)) {
                $temp['casting'] = array_shift($options);
            }

            if (!empty($options)) {
                $temp['locale'] = array_shift($options);
            }

            $options = $temp;
        }

        if (array_key_exists('type', $options)) {
            $this->setType($options['type']);
        }

        if (array_key_exists('casting', $options)) {
            $this->setCasting($options['casting']);
        }

        if (array_key_exists('locale', $options)) {
            $this->setLocale($options['locale']);
        }
    }

Member Function Documentation

_getLocalizedQuestion()

_getLocalizedQuestion (   $value,   $yes,   $locale  )

protected

Determine the value of a localized string, and compare it to a given value

Parameters

string	$value
boolean	$yes
array	$locale

Returns

boolean

Definition at line 356 of file Boolean.php.

    {
        if ($yes == true) {
            $question = 'yes';
            $return   = true;
        } else {
            $question = 'no';
            $return   = false;
        }
        $str = Zend_Locale::getTranslation($question, 'question', $locale);
        $str = explode(':', $str);
        if (!empty($str)) {
            foreach($str as $no) {
                if (($no == $value) || (strtolower($no) == strtolower($value))) {
                    return $return;
                }
            }
        }
    }

filter()

filter

(

$value

)

Defined by Zend_Filter_Interface

Returns a boolean representation of $value

Parameters

string

$value

Returns

string

Implements Zend_Filter_Interface.

Definition at line 238 of file Boolean.php.

    {
        $type    = $this->getType();
        $casting = $this->getCasting();

        // STRING YES (Localized)
        if ($type >= self::YES) {
            $type -= self::YES;
            if (is_string($value)) {
                #require_once 'Zend/Locale.php';
                $locales = $this->getLocale();
                foreach ($locales as $locale) {
                    if ($this->_getLocalizedQuestion($value, false, $locale) === false) {
                        return false;
                    }

                    if (!$casting && ($this->_getLocalizedQuestion($value, true, $locale) === true)) {
                        return true;
                    }
                }
            }
        }

        // STRING FALSE ('false')
        if ($type >= self::FALSE_STRING) {
            $type -= self::FALSE_STRING;
            if (is_string($value) && (strtolower($value) == 'false')) {
                return false;
            }

            if ((!$casting) && is_string($value) && (strtolower($value) == 'true')) {
                return true;
            }
        }

        // NULL (null)
        if ($type >= self::NULL) {
            $type -= self::NULL;
            if ($value === null) {
                return false;
            }
        }

        // EMPTY_ARRAY (array())
        if ($type >= self::EMPTY_ARRAY) {
            $type -= self::EMPTY_ARRAY;
            if (is_array($value) && ($value == array())) {
                return false;
            }
        }

        // ZERO ('0')
        if ($type >= self::ZERO) {
            $type -= self::ZERO;
            if (is_string($value) && ($value == '0')) {
                return false;
            }

            if ((!$casting) && (is_string($value)) && ($value == '1')) {
                return true;
            }
        }

        // STRING ('')
        if ($type >= self::STRING) {
            $type -= self::STRING;
            if (is_string($value) && ($value == '')) {
                return false;
            }
        }

        // FLOAT (0.0)
        if ($type >= self::FLOAT) {
            $type -= self::FLOAT;
            if (is_float($value) && ($value == 0.0)) {
                return false;
            }

            if ((!$casting) && is_float($value) && ($value == 1.0)) {
                return true;
            }
        }

        // INTEGER (0)
        if ($type >= self::INTEGER) {
            $type -= self::INTEGER;
            if (is_int($value) && ($value == 0)) {
                return false;
            }

            if ((!$casting) && is_int($value) && ($value == 1)) {
                return true;
            }
        }

        // BOOLEAN (false)
        if ($type >= self::BOOLEAN) {
            $type -= self::BOOLEAN;
            if (is_bool($value)) {
                return $value;
            }
        }

        if ($casting) {
            return true;
        }

        return $value;
    }

getCasting()

getCasting

(

)

Returns the casting option

Returns

boolean

Definition at line 210 of file Boolean.php.

    {
        return $this->_casting;
    }

getLocale()

getLocale

(

)

Returns the set locale

Returns

array

Definition at line 170 of file Boolean.php.

    {
        return $this->_locale;
    }

getType()

getType

(

)

Returns the set null types

Returns

int

Definition at line 127 of file Boolean.php.

    {
        return $this->_type;
    }

setCasting()

setCasting

(

$casting = true

)

Set the working mode

Parameters

boolean

$locale

When true this filter works like cast When false it recognises only true and false and all other values are returned as is

Exceptions

Zend_Filter_Exception

Returns

Zend_Filter_Boolean

Definition at line 224 of file Boolean.php.

    {
        $this->_casting = (boolean) $casting;
        return $this;
    }

setLocale()

setLocale

(

$locale = null

)

Set the locales which are accepted

Parameters

string | array | Zend_Locale

$locale

Exceptions

Zend_Filter_Exception

Returns

Zend_Filter_Boolean

Definition at line 182 of file Boolean.php.

    {
        if (is_string($locale)) {
            $locale = array($locale);
        } elseif ($locale instanceof Zend_Locale) {
            $locale = array($locale->toString());
        } elseif (!is_array($locale)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Locale has to be string, array or an instance of Zend_Locale');
        }

        #require_once 'Zend/Locale.php';
        foreach ($locale as $single) {
            if (!Zend_Locale::isLocale($single)) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception("Unknown locale '$single'");
            }
        }

        $this->_locale = $locale;
        return $this;
    }

setType()

setType

(

$type = null

)

Set the null types

Parameters

integer | array

$type

Exceptions

Zend_Filter_Exception

Returns

Zend_Filter_Boolean

Definition at line 139 of file Boolean.php.

    {
        if (is_array($type)) {
            $detected = 0;
            foreach($type as $value) {
                if (is_int($value)) {
                    $detected += $value;
                } elseif (in_array($value, $this->_constants)) {
                    $detected += array_search($value, $this->_constants);
                }
            }

            $type = $detected;
        } elseif (is_string($type) && in_array($type, $this->_constants)) {
            $type = array_search($type, $this->_constants);
        }

        if (!is_int($type) || ($type < 0) || ($type > self::ALL)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Unknown type');
        }

        $this->_type = $type;
        return $this;
    }

Field Documentation

$_casting

$_casting = true

protected

Definition at line 80 of file Boolean.php.

$_constants

$_constants

protected

Initial value:

= array(
        self::BOOLEAN      => 'boolean',
        self::INTEGER      => 'integer',
        self::FLOAT        => 'float',
        self::STRING       => 'string',
        self::ZERO         => 'zero',
        self::EMPTY_ARRAY  => 'array',
        self::NULL         => 'null',
        self::PHP          => 'php',
        self::FALSE_STRING => 'false',
        self::YES          => 'yes',
        self::ALL          => 'all',
    )

Definition at line 47 of file Boolean.php.

$_locale

$_locale = array('auto')

protected

Definition at line 73 of file Boolean.php.

$_type

$_type = self::PHP

protected

Definition at line 66 of file Boolean.php.

ALL

const ALL = 511

Definition at line 45 of file Boolean.php.

BOOLEAN

const BOOLEAN = 1

Definition at line 35 of file Boolean.php.

EMPTY_ARRAY

const EMPTY_ARRAY = 32

Definition at line 40 of file Boolean.php.

FALSE_STRING

const FALSE_STRING = 128

Definition at line 43 of file Boolean.php.

FLOAT

const FLOAT = 4

Definition at line 37 of file Boolean.php.

INTEGER

const INTEGER = 2

Definition at line 36 of file Boolean.php.

NULL

const NULL = 64

Definition at line 41 of file Boolean.php.

PHP

const PHP = 127

Definition at line 42 of file Boolean.php.

STRING

const STRING = 8

Definition at line 38 of file Boolean.php.

YES

const YES = 256

Definition at line 44 of file Boolean.php.

ZERO

const ZERO = 16

Definition at line 39 of file Boolean.php.

---

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

• vendor/magento/zendframework1/library/Zend/Filter/Boolean.php