Zend Framework API Documentation » \Zend_Validate

Constants

category	Zend
package	Zend_Validate
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License
inherited_from	\Zend_Validate_Abstract

Methods

Generates the standard validator object

__construct($adapter)

Parameters

$adapter

Exceptions

`\Zend_Validate_Exception`

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

__get(string $property) : mixed

Inherited

Parameters

$property

string

Exceptions

`\Zend_Validate_Exception`

Returns

mixed

Returns the set adapter

getAdapter() : \Zend_Validate_Barcode_BarcodeAdapter

Returns

\Zend_Validate_Barcode_BarcodeAdapter

Returns the checksum option

getChecksum() : boolean

Returns

boolean

Get default translation object for all validate objects

getDefaultTranslator() : \Zend_Translate_Adapter | null

InheritedStatic

Returns

\Zend_Translate_Adapternull

Returns array of validation failure message codes

getErrors() : array

Inherited

deprecated	Since 1.5.0

Returns

array

Returns the maximum allowed message length

getMessageLength() : integer

InheritedStatic

Returns

integer

Returns the message templates from the validator

getMessageTemplates() : array

Inherited

Returns

array

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

getMessageVariables() : array

Inherited

Returns

array

Returns array of validation failure messages

getMessages() : array

Inherited

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

inherited_from	\Zend_Validate_Interface::getMessages()

Returns

array

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

getObscureValue() : boolean

Inherited

Returns

boolean

Return translation object

getTranslator() : \Zend_Translate_Adapter | null

Inherited

Returns

\Zend_Translate_Adapternull

Is there a default translation object set?

hasDefaultTranslator() : boolean

InheritedStatic

Returns

boolean

Does this validator have its own specific translator?

hasTranslator() : boolean

Inherited

Returns

boolean

Defined by Zend_Validate_Interface

isValid(string $value) : boolean

Returns true if and only if $value contains a valid barcode

Parameters

$value

string

Returns

boolean

Sets a new barcode adapter

setAdapter(string|\Zend_Validate_Barcode $adapter, array $options = null) : \Zend_Validate_Barcode

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$adapter

string\Zend_Validate_Barcode

Barcode adapter to use

$options

array

Options for this adapter

Exceptions

`\Zend_Validate_Exception`

Returns

\Zend_Validate_Barcode

Sets the checksum option

setChecksum(boolean $checksum) : \Zend_Validate_Barcode

Parameters

$checksum

boolean

Returns

\Zend_Validate_Barcode

Set default translation object for all validate objects

setDefaultTranslator(\Zend_Translate|\Zend_Translate_Adapter|null $translator = null)

InheritedStatic

Parameters

$translator

\Zend_Translate\Zend_Translate_Adapternull

Exceptions

`\Zend_Validate_Exception`

Indicate whether or not translation should be disabled

setDisableTranslator(boolean $flag) : \Zend_Validate_Abstract

Inherited

Parameters

$flag

boolean

Returns

\Zend_Validate_Abstract

Sets the validation failure message template for a particular key

setMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract

Inherited

Parameters

$messageString

string

$messageKey

string

OPTIONAL

Exceptions

`\Zend_Validate_Exception`

Returns

\Zend_Validate_AbstractProvides a fluent interface

Sets the maximum allowed message length

setMessageLength(integer $length = -1)

InheritedStatic

Parameters

$length

integer

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.

setMessages(array $messages) : \Zend_Validate_Abstract

Inherited

Parameters

$messages

array

Returns

\Zend_Validate_Abstract

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

setObscureValue(boolean $flag) : \Zend_Validate_Abstract

Inherited

Parameters

$flag

boolean

Returns

\Zend_Validate_Abstract

Set translation object

setTranslator(\Zend_Translate|\Zend_Translate_Adapter|null $translator = null) : \Zend_Validate_Abstract

Inherited

Parameters

$translator

\Zend_Translate\Zend_Translate_Adapternull

Exceptions

`\Zend_Validate_Exception`

Returns

\Zend_Validate_Abstract

Is translation disabled?

translatorIsDisabled() : boolean

Inherited

Returns

boolean

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

_createMessage(string $messageKey, string $value) : string

Inherited

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

$messageKey

string

$value

string

Returns

string

_error()

_error(string $messageKey, string $value = null) : void

Inherited

Parameters

$messageKey

string

$value

string

OPTIONAL

Joins elements of a multidimensional array

_implodeRecursive(array $pieces) : string

Inherited

Parameters

$pieces

array

Returns

string

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

_setValue(mixed $value) : void

Inherited

Parameters

$value

mixed

Properties

Barcode adapter

$_adapter : \Zend_Validate_Barcode_BarcodeAdapter

Default

Default translation object for all validate objects

$_defaultTranslator : \Zend_Translate

Default

Static

Array of validation failure message codes

$_errors : array

Default

array()

deprecated	Since 1.5.0

Length for the set subtype

$_length : integer

Default

Limits the maximum returned length of a error message

$_messageLength : Integer

Default

-1

Static

Validation failure message template definitions

$_messageTemplates

Default

array(self::FAILED => "'%value%' failed checksum validation", self::INVALID_CHARS => "'%value%' contains invalid characters", self::INVALID_LENGTH => "'%value%' should have a length of %length% characters", self::INVALID => "Invalid type given. String expected")

inherited_from	\Zend_Validate_Abstract::_messageTemplates

Validation failure message template definitions

$_messageTemplates : array

Default

array()

Additional variables available for validation failure messages

$_messageVariables : array

Default

array('length' => '_length')

inherited_from	\Zend_Validate_Abstract::_messageVariables

Additional variables available for validation failure messages

$_messageVariables : array

Default

array()

Array of validation failure messages

$_messages : array

Default

array()

Flag indidcating whether or not value should be obfuscated in error messages

$_obscureValue : boolean

Default

false

Translation object

$_translator : \Zend_Translate

Default

Is translation disabled?

$_translatorDisabled : Boolean

Default

false

The value to be validated

$_value : mixed

Default

Constants

FAILED

FAILED = 'barcodeFailed'

INVALID

INVALID = 'barcodeInvalid'

INVALID_CHARS

INVALID_CHARS = 'barcodeInvalidChars'

INVALID_LENGTH

INVALID_LENGTH = 'barcodeInvalidLength'