Zend_Validate_Abstract Class Reference

Inheritance diagram for Zend_Validate_Abstract:

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

Static Public Member Functions
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)

Protected Member Functions
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)

Protected Attributes
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Static Protected Attributes
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 33 of file Abstract.php.

Member Function Documentation

__get()

__get

(

$property

)

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

Parameters

string

$property

Returns

mixed

Exceptions

Zend_Validate_Exception

See also

Zend_Validate_Exception

Definition at line 183 of file Abstract.php.

    {
        if ($property == 'value') {
            return $this->_value;
        }
        if (array_key_exists($property, $this->_messageVariables)) {
            return $this->{$this->_messageVariables[$property]};
        }
        #require_once 'Zend/Validate/Exception.php';
        throw new Zend_Validate_Exception("No property exists by the name '$property'");
    }

_createMessage()

_createMessage (   $messageKey,   $value  )

protected

Constructs and returns a validation failure message with the given message key and value.

Returns null if and only if $messageKey does not correspond to an existing template.

If a translator is available and a translation exists for $messageKey, the translation will be used.

Parameters

string	$messageKey
string	$value

Returns

string

Definition at line 210 of file Abstract.php.

    {
        if (!isset($this->_messageTemplates[$messageKey])) {
            return null;
        }

        $message = $this->_messageTemplates[$messageKey];

        if (null !== ($translator = $this->getTranslator())) {
            if ($translator->isTranslated($messageKey)) {
                $message = $translator->translate($messageKey);
            } else {
                $message = $translator->translate($message);
            }
        }

        if (is_object($value)) {
            if (!in_array('__toString', get_class_methods($value))) {
                $value = get_class($value) . ' object';
            } else {
                $value = $value->__toString();
            }
        } elseif (is_array($value)) {
            $value = $this->_implodeRecursive($value);
        } else {
            $value = implode((array) $value);
        }

        if ($this->getObscureValue()) {
            $value = str_repeat('*', strlen($value));
        }

        $message = str_replace('%value%', $value, $message);
        foreach ($this->_messageVariables as $ident => $property) {
            $message = str_replace(
                "%$ident%",
                implode(' ', (array) $this->$property),
                $message
            );
        }

        $length = self::getMessageLength();
        if (($length > -1) && (strlen($message) > $length)) {
            $message = substr($message, 0, (self::getMessageLength() - 3)) . '...';
        }

        return $message;
    }

_error()

_error (   $messageKey,   $value = null  )

protected

Parameters

string	$messageKey
string	$value	OPTIONAL

Returns

void

Definition at line 284 of file Abstract.php.

    {
        if ($messageKey === null) {
            $keys = array_keys($this->_messageTemplates);
            $messageKey = current($keys);
        }
        if ($value === null) {
            $value = $this->_value;
        }
        $this->_errors[]              = $messageKey;
        $this->_messages[$messageKey] = $this->_createMessage($messageKey, $value);
    }

_implodeRecursive()

_implodeRecursive ( array  $pieces )

protected

Joins elements of a multidimensional array

Parameters

array

$pieces

Returns

string

Definition at line 265 of file Abstract.php.

    {
        $values = array();
        foreach ($pieces as $item) {
            if (is_array($item)) {
                $values[] = $this->_implodeRecursive($item);
            } else {
                $values[] = $item;
            }
        }

        return implode(', ', $values);
    }

_setValue()

_setValue (   $value )

protected

Sets the value to be validated and clears the messages and errors arrays

Parameters

mixed

$value

Returns

void

Definition at line 303 of file Abstract.php.

    {
        $this->_value    = $value;
        $this->_messages = array();
        $this->_errors   = array();
    }

getDefaultTranslator()

static getDefaultTranslator ( )

static

Get default translation object for all validate objects

Returns

Zend_Translate_Adapter|null

Definition at line 415 of file Abstract.php.

    {
        if (null === self::$_defaultTranslator) {
            #require_once 'Zend/Registry.php';
            if (Zend_Registry::isRegistered('Zend_Translate')) {
                $translator = Zend_Registry::get('Zend_Translate');
                if ($translator instanceof Zend_Translate_Adapter) {
                    return $translator;
                } elseif ($translator instanceof Zend_Translate) {
                    return $translator->getAdapter();
                }
            }
        }

        return self::$_defaultTranslator;
    }

getErrors()

getErrors

(

)

Returns array of validation failure message codes

Returns

array

Deprecated:

Since 1.5.0

Definition at line 316 of file Abstract.php.

    {
        return $this->_errors;
    }

getMessageLength()

static getMessageLength ( )

static

Returns the maximum allowed message length

Returns

integer

Definition at line 469 of file Abstract.php.

    {
        return self::$_messageLength;
    }

getMessages()

getMessages

(

)

Returns array of validation failure messages

Returns

array

Implements Zend_Validate_Interface.

Definition at line 108 of file Abstract.php.

    {
        return $this->_messages;
    }

getMessageTemplates()

getMessageTemplates

(

)

Returns the message templates from the validator

Returns

array

Definition at line 128 of file Abstract.php.

    {
        return $this->_messageTemplates;
    }

getMessageVariables()

getMessageVariables

(

)

Returns an array of the names of variables that are used in constructing validation failure messages

Returns

array

Definition at line 118 of file Abstract.php.

    {
        return array_keys($this->_messageVariables);
    }

getObscureValue()

getObscureValue

(

)

Retrieve flag indicating whether or not value should be obfuscated in messages

Returns

bool

Definition at line 339 of file Abstract.php.

    {
        return $this->_obscureValue;
    }

getTranslator()

getTranslator

(

)

Return translation object

Returns

Zend_Translate_Adapter|null

Definition at line 369 of file Abstract.php.

    {
        if ($this->translatorIsDisabled()) {
            return null;
        }

        if (null === $this->_translator) {
            return self::getDefaultTranslator();
        }

        return $this->_translator;
    }

hasDefaultTranslator()

static hasDefaultTranslator ( )

static

Is there a default translation object set?

Returns

boolean

Definition at line 437 of file Abstract.php.

    {
        return (bool)self::$_defaultTranslator;
    }

hasTranslator()

hasTranslator

(

)

Does this validator have its own specific translator?

Returns

bool

Definition at line 387 of file Abstract.php.

    {
        return (bool)$this->_translator;
    }

setDefaultTranslator()

static setDefaultTranslator (   $translator = null )

static

Set default translation object for all validate objects

Parameters

Zend_Translate | Zend_Translate_Adapter | null

$translator

Exceptions

Zend_Validate_Exception

Definition at line 398 of file Abstract.php.

    {
        if ((null === $translator) || ($translator instanceof Zend_Translate_Adapter)) {
            self::$_defaultTranslator = $translator;
        } elseif ($translator instanceof Zend_Translate) {
            self::$_defaultTranslator = $translator->getAdapter();
        } else {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Invalid translator specified');
        }
    }

setDisableTranslator()

setDisableTranslator

(

$flag

)

Indicate whether or not translation should be disabled

Parameters

bool

$flag

Returns

Zend_Validate_Abstract

Definition at line 448 of file Abstract.php.

    {
        $this->_translatorDisabled = (bool) $flag;
        return $this;
    }

setMessage()

setMessage	(		$messageString,
			$messageKey = null
	)

Sets the validation failure message template for a particular key

Parameters

string	$messageString
string	$messageKey	OPTIONAL

Returns

Zend_Validate_Abstract Provides a fluent interface

Exceptions

Zend_Validate_Exception

Definition at line 141 of file Abstract.php.

    {
        if ($messageKey === null) {
            $keys = array_keys($this->_messageTemplates);
            foreach($keys as $key) {
                $this->setMessage($messageString, $key);
            }
            return $this;
        }

        if (!isset($this->_messageTemplates[$messageKey])) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("No message template exists for key '$messageKey'");
        }

        $this->_messageTemplates[$messageKey] = $messageString;
        return $this;
    }

setMessageLength()

static setMessageLength (   $length = -1 )

static

Sets the maximum allowed message length

Parameters

integer

$length

Definition at line 479 of file Abstract.php.

    {
        self::$_messageLength = $length;
    }

setMessages()

setMessages

(

array

$messages

)

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.

Parameters

array

$messages

Returns

Zend_Validate_Abstract

Definition at line 167 of file Abstract.php.

    {
        foreach ($messages as $key => $message) {
            $this->setMessage($message, $key);
        }
        return $this;
    }

setObscureValue()

setObscureValue

(

$flag

)

Set flag indicating whether or not value should be obfuscated in messages

Parameters

bool

$flag

Returns

Zend_Validate_Abstract

Definition at line 327 of file Abstract.php.

    {
        $this->_obscureValue = (bool) $flag;
        return $this;
    }

setTranslator()

setTranslator

(

$translator = null

)

Set translation object

Parameters

Zend_Translate | Zend_Translate_Adapter | null

$translator

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_Abstract

Definition at line 351 of file Abstract.php.

    {
        if ((null === $translator) || ($translator instanceof Zend_Translate_Adapter)) {
            $this->_translator = $translator;
        } elseif ($translator instanceof Zend_Translate) {
            $this->_translator = $translator->getAdapter();
        } else {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Invalid translator specified');
        }
        return $this;
    }

translatorIsDisabled()

translatorIsDisabled

(

)

Is translation disabled?

Returns

bool

Definition at line 459 of file Abstract.php.

    {
        return $this->_translatorDisabled;
    }

Field Documentation

$_defaultTranslator

$_defaultTranslator

staticprotected

Definition at line 88 of file Abstract.php.

$_errors

$_errors = array()

protected

Definition at line 76 of file Abstract.php.

$_messageLength

$_messageLength = -1

staticprotected

Definition at line 101 of file Abstract.php.

$_messages

$_messages = array()

protected

Definition at line 61 of file Abstract.php.

$_messageTemplates

$_messageTemplates = array()

protected

Definition at line 54 of file Abstract.php.

$_messageVariables

$_messageVariables = array()

protected

Definition at line 47 of file Abstract.php.

$_obscureValue

$_obscureValue = false

protected

Definition at line 68 of file Abstract.php.

$_translator

$_translator

protected

Definition at line 82 of file Abstract.php.

$_translatorDisabled

$_translatorDisabled = false

protected

Definition at line 94 of file Abstract.php.

$_value

$_value

protected

Definition at line 40 of file Abstract.php.

---

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

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