Zend_Filter_Null Class Reference

Inheritance diagram for Zend_Filter_Null:

Public Member Functions
	__construct ($options=null)
	getType ()
	setType ($type=null)
	filter ($value)

Data Fields
const	BOOLEAN = 1
const	INTEGER = 2
const	EMPTY_ARRAY = 4
const	STRING = 8
const	ZERO = 16
const	ALL = 31

Protected Attributes
	$_constants
	$_type = self::ALL

Detailed Description

Definition at line 33 of file Null.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

string | array | Zend_Config

$options

OPTIONAL

Definition at line 63 of file Null.php.

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

        if (!empty($options)) {
            $this->setType($options);
        }
    }

Member Function Documentation

filter()

filter

(

$value

)

Defined by Zend_Filter_Interface

Returns null representation of $value, if value is empty and matches types that should be considered null.

Parameters

string

$value

Returns

string

Implements Zend_Filter_Interface.

Definition at line 137 of file Null.php.

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

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

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

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

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

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

        return $value;
    }

getType()

getType

(

)

Returns the set null types

Returns

array

Definition at line 88 of file Null.php.

    {
        return $this->_type;
    }

setType()

setType

(

$type = null

)

Set the null types

Parameters

integer | array

$type

Exceptions

Zend_Filter_Exception

Returns

Zend_Filter_Null

Definition at line 100 of file Null.php.

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

            $type = $detected;
        } else if (is_string($type)) {
            if (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

$_constants

$_constants

protected

Initial value:

= array(
        self::BOOLEAN     => 'boolean',
        self::INTEGER     => 'integer',
        self::EMPTY_ARRAY => 'array',
        self::STRING      => 'string',
        self::ZERO        => 'zero',
        self::ALL         => 'all'
    )

Definition at line 42 of file Null.php.

$_type

$_type = self::ALL

protected

Definition at line 56 of file Null.php.

ALL

const ALL = 31

Definition at line 40 of file Null.php.

BOOLEAN

const BOOLEAN = 1

Definition at line 35 of file Null.php.

EMPTY_ARRAY

const EMPTY_ARRAY = 4

Definition at line 37 of file Null.php.

INTEGER

const INTEGER = 2

Definition at line 36 of file Null.php.

STRING

const STRING = 8

Definition at line 38 of file Null.php.

ZERO

const ZERO = 16

Definition at line 39 of file Null.php.

---

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

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