Zend_Validate Class Reference

Inheritance diagram for Zend_Validate:

Public Member Functions
	addValidator (Zend_Validate_Interface $validator, $breakChainOnFailure=false)
	isValid ($value)
	getMessages ()
	getErrors ()

Static Public Member Functions
static	getDefaultNamespaces ()
static	setDefaultNamespaces ($namespace)
static	addDefaultNamespaces ($namespace)
static	hasDefaultNamespaces ()
static	is ($value, $classBaseName, array $args=array(), $namespaces=array())
static	getMessageLength ()
static	setMessageLength ($length=-1)
static	getDefaultTranslator ($translator=null)
static	setDefaultTranslator ($translator=null)

Protected Attributes
	$_validators = array()
	$_messages = array()
	$_errors = array()

Static Protected Attributes
static	$_defaultNamespaces = array()

Detailed Description

Definition at line 33 of file Validate.php.

Member Function Documentation

addDefaultNamespaces()

static addDefaultNamespaces (   $namespace )

static

Adds a new default namespace

Parameters

array | string

$namespace

Returns

null

Definition at line 168 of file Validate.php.

    {
        if (!is_array($namespace)) {
            $namespace = array((string) $namespace);
        }

        self::$_defaultNamespaces = array_unique(array_merge(self::$_defaultNamespaces, $namespace));
    }

addValidator()

addValidator	(	Zend_Validate_Interface	$validator,
			$breakChainOnFailure = false
	)

Adds a validator to the end of the chain

If $breakChainOnFailure is true, then if the validator fails, the next validator in the chain, if one exists, will not be executed.

Parameters

Zend_Validate_Interface	$validator
boolean	$breakChainOnFailure

Returns

Zend_Validate Provides a fluent interface

Definition at line 74 of file Validate.php.

    {
        $this->_validators[] = array(
            'instance' => $validator,
            'breakChainOnFailure' => (boolean) $breakChainOnFailure
            );
        return $this;
    }

getDefaultNamespaces()

static getDefaultNamespaces ( )

static

Returns the set default namespaces

Returns

array

Definition at line 142 of file Validate.php.

    {
        return self::$_defaultNamespaces;
    }

getDefaultTranslator()

static getDefaultTranslator (   $translator = null )

static

Returns the default translation object

Returns

Zend_Translate_Adapter|null

Definition at line 274 of file Validate.php.

    {
        #require_once 'Zend/Validate/Abstract.php';
        return Zend_Validate_Abstract::getDefaultTranslator();
    }

getErrors()

getErrors

(

)

Defined by Zend_Validate_Interface

Returns array of validation failure message codes

Returns

array

Deprecated:

Since 1.5.0

Definition at line 132 of file Validate.php.

    {
        return $this->_errors;
    }

getMessageLength()

static getMessageLength ( )

static

Returns the maximum allowed message length

Returns

integer

Definition at line 252 of file Validate.php.

    {
        #require_once 'Zend/Validate/Abstract.php';
        return Zend_Validate_Abstract::getMessageLength();
    }

getMessages()

getMessages

(

)

Defined by Zend_Validate_Interface

Returns array of validation failure messages

Returns

array

Implements Zend_Validate_Interface.

Definition at line 119 of file Validate.php.

    {
        return $this->_messages;
    }

hasDefaultNamespaces()

static hasDefaultNamespaces ( )

static

Returns true when defaultNamespaces are set

Returns

boolean

Definition at line 182 of file Validate.php.

    {
        return (!empty(self::$_defaultNamespaces));
    }

is()

static is (   $value,   $classBaseName, array  $args = array(),   $namespaces = array()  )

static

Parameters

mixed	$value
string	$classBaseName
array	$args	OPTIONAL
mixed	$namespaces	OPTIONAL

Returns

boolean

Exceptions

Zend_Validate_Exception

Definition at line 195 of file Validate.php.

    {
        $namespaces = array_merge((array) $namespaces, self::$_defaultNamespaces, array('Zend_Validate'));
        $className  = ucfirst($classBaseName);
        try {
            if (!class_exists($className, false)) {
                #require_once 'Zend/Loader.php';
                foreach($namespaces as $namespace) {
                    $class = $namespace . '_' . $className;
                    $file  = str_replace('_', DIRECTORY_SEPARATOR, $class) . '.php';
                    if (Zend_Loader::isReadable($file)) {
                        Zend_Loader::loadClass($class);
                        $className = $class;
                        break;
                    }
                }
            }

            $class = new ReflectionClass($className);
            if ($class->implementsInterface('Zend_Validate_Interface')) {
                if ($class->hasMethod('__construct')) {
                    $keys    = array_keys($args);
                    $numeric = false;
                    foreach($keys as $key) {
                        if (is_numeric($key)) {
                            $numeric = true;
                            break;
                        }
                    }

                    if ($numeric) {
                        $object = $class->newInstanceArgs($args);
                    } else {
                        $object = $class->newInstance($args);
                    }
                } else {
                    $object = $class->newInstance();
                }

                return $object->isValid($value);
            }
        } catch (Zend_Validate_Exception $ze) {
            // if there is an exception while validating throw it
            throw $ze;
        } catch (Exception $e) {
            // fallthrough and continue for missing validation classes
        }

        #require_once 'Zend/Validate/Exception.php';
        throw new Zend_Validate_Exception("Validate class not found from basename '$classBaseName'");
    }

isValid()

isValid

(

$value

)

Returns true if and only if $value passes all validations in the chain

Validators are run in the order in which they were added to the chain (FIFO).

Parameters

mixed

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 91 of file Validate.php.

    {
        $this->_messages = array();
        $this->_errors   = array();
        $result = true;
        foreach ($this->_validators as $element) {
            $validator = $element['instance'];
            if ($validator->isValid($value)) {
                continue;
            }
            $result = false;
            $messages = $validator->getMessages();
            $this->_messages = array_merge($this->_messages, $messages);
            $this->_errors   = array_merge($this->_errors,   array_keys($messages));
            if ($element['breakChainOnFailure']) {
                break;
            }
        }
        return $result;
    }

setDefaultNamespaces()

static setDefaultNamespaces (   $namespace )

static

Sets new default namespaces

Parameters

array | string

$namespace

Returns

null

Definition at line 153 of file Validate.php.

    {
        if (!is_array($namespace)) {
            $namespace = array((string) $namespace);
        }

        self::$_defaultNamespaces = $namespace;
    }

setDefaultTranslator()

static setDefaultTranslator (   $translator = null )

static

Sets a default translation object for all validation objects

Parameters

Zend_Translate | Zend_Translate_Adapter | null

$translator

Definition at line 285 of file Validate.php.

    {
        #require_once 'Zend/Validate/Abstract.php';
        Zend_Validate_Abstract::setDefaultTranslator($translator);
    }

setMessageLength()

static setMessageLength (   $length = -1 )

static

Sets the maximum allowed message length

Parameters

integer

$length

Definition at line 263 of file Validate.php.

    {
        #require_once 'Zend/Validate/Abstract.php';
        Zend_Validate_Abstract::setMessageLength($length);
    }

Field Documentation

$_defaultNamespaces

$_defaultNamespaces = array()

staticprotected

Definition at line 54 of file Validate.php.

$_errors

$_errors = array()

protected

Definition at line 62 of file Validate.php.

$_messages

$_messages = array()

protected

Definition at line 47 of file Validate.php.

$_validators

$_validators = array()

protected

Definition at line 40 of file Validate.php.

---

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

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