Zend_Validate_NotEmpty Class Reference

Inheritance diagram for Zend_Validate_NotEmpty:

Public Member Functions
	__construct ($options=null)
	getType ()
	setType ($type=null)
	isValid ($value)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()

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	SPACE = 128
const	OBJECT = 256
const	OBJECT_STRING = 512
const	OBJECT_COUNT = 1024
const	ALL = 2047
const	INVALID = 'notEmptyInvalid'
const	IS_EMPTY = 'isEmpty'

Protected Attributes
	$_constants
	$_messageTemplates
	$_type = 493
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 33 of file NotEmpty.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

string | array | Zend_Config

$options

OPTIONAL

Definition at line 88 of file NotEmpty.php.

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

            $options = $temp;
        }

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

Member Function Documentation

getType()

getType

(

)

Returns the set types

Returns

array

Definition at line 112 of file NotEmpty.php.

    {
        return $this->_type;
    }

isValid()

isValid

(

$value

)

Defined by Zend_Validate_Interface

Returns true if and only if $value is not an empty value.

Parameters

string

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 158 of file NotEmpty.php.

    {
        if ($value !== null && !is_string($value) && !is_int($value) && !is_float($value) &&
            !is_bool($value) && !is_array($value) && !is_object($value)) {
            $this->_error(self::INVALID);
            return false;
        }

        $type    = $this->getType();
        $this->_setValue($value);
        $object  = false;

        // OBJECT_COUNT (countable object)
        if ($type >= self::OBJECT_COUNT) {
            $type -= self::OBJECT_COUNT;
            $object = true;

            if (is_object($value) && ($value instanceof Countable) && (count($value) == 0)) {
                $this->_error(self::IS_EMPTY);
                return false;
            }
        }

        // OBJECT_STRING (object's toString)
        if ($type >= self::OBJECT_STRING) {
            $type -= self::OBJECT_STRING;
            $object = true;

            if ((is_object($value) && (!method_exists($value, '__toString'))) ||
                (is_object($value) && (method_exists($value, '__toString')) && (((string) $value) == ""))) {
                $this->_error(self::IS_EMPTY);
                return false;
            }
        }

        // OBJECT (object)
        if ($type >= self::OBJECT) {
            $type -= self::OBJECT;
            // fall trough, objects are always not empty
        } else if ($object === false) {
            // object not allowed but object given -> return false
            if (is_object($value)) {
                $this->_error(self::IS_EMPTY);
                return false;
            }
        }

        // SPACE ('   ')
        if ($type >= self::SPACE) {
            $type -= self::SPACE;
            if (is_string($value) && (preg_match('/^\s+$/s', $value))) {
                $this->_error(self::IS_EMPTY);
                return false;
            }
        }

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

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

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

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

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

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

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

        return true;
    }

setType()

setType

(

$type = null

)

Set the types

Parameters

integer | array

$type

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_NotEmpty

Definition at line 124 of file NotEmpty.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) && in_array($type, $this->_constants)) {
            $type = array_search($type, $this->_constants);
        }

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

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

Field Documentation

$_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::SPACE         => 'space',
        self::OBJECT        => 'object',
        self::OBJECT_STRING => 'objectstring',
        self::OBJECT_COUNT  => 'objectcount',
        self::ALL           => 'all',
    )

Definition at line 52 of file NotEmpty.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::IS_EMPTY => "Value is required and can't be empty",
        self::INVALID  => "Invalid type given. String, integer, float, boolean or array expected",
    )

Definition at line 71 of file NotEmpty.php.

$_type

$_type = 493

protected

Definition at line 81 of file NotEmpty.php.

ALL

const ALL = 2047

Definition at line 47 of file NotEmpty.php.

BOOLEAN

const BOOLEAN = 1

Definition at line 35 of file NotEmpty.php.

EMPTY_ARRAY

const EMPTY_ARRAY = 32

Definition at line 40 of file NotEmpty.php.

FLOAT

const FLOAT = 4

Definition at line 37 of file NotEmpty.php.

INTEGER

const INTEGER = 2

Definition at line 36 of file NotEmpty.php.

INVALID

const INVALID = 'notEmptyInvalid'

Definition at line 49 of file NotEmpty.php.

IS_EMPTY

const IS_EMPTY = 'isEmpty'

Definition at line 50 of file NotEmpty.php.

NULL

const NULL = 64

Definition at line 41 of file NotEmpty.php.

OBJECT

const OBJECT = 256

Definition at line 44 of file NotEmpty.php.

OBJECT_COUNT

const OBJECT_COUNT = 1024

Definition at line 46 of file NotEmpty.php.

OBJECT_STRING

const OBJECT_STRING = 512

Definition at line 45 of file NotEmpty.php.

PHP

const PHP = 127

Definition at line 42 of file NotEmpty.php.

SPACE

const SPACE = 128

Definition at line 43 of file NotEmpty.php.

STRING

const STRING = 8

Definition at line 38 of file NotEmpty.php.

ZERO

const ZERO = 16

Definition at line 39 of file NotEmpty.php.

---

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

• vendor/magento/zendframework1/library/Zend/Validate/NotEmpty.php