Zend_Validate_StringLength Class Reference

Public Member Functions
	__construct ($options=array())
	Sets validator options.
	getMin ()
	Returns the min option.
	setMin ($min)
	Sets the min option.
	getMax ()
	Returns the max option.
	setMax ($max)
	Sets the max option.
	getEncoding ()
	Returns the actual encoding.
	setEncoding ($encoding=null)
	Sets a new encoding to use.
	isValid ($value)
	Defined by Zend_Validate_Interface.
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	Returns array of validation failure messages.
	getMessageVariables ()
	Returns an array of the names of variables that are used in constructing validation failure messages.
	getMessageTemplates ()
	Returns the message templates from the validator.
	setMessage ($messageString, $messageKey=null)
	Sets the validation failure message template for a particular key.
	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.
	__get ($property)
	Magic function returns the value of the requested property, if and only if it is the value or a message variable.
	getErrors ()
	Returns array of validation failure message codes.
	setObscureValue ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	getObscureValue ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator ($translator=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setDisableTranslator ($flag)
	Indicate whether or not translation should be disabled.
	translatorIsDisabled ()
	Is translation disabled?

Public Attributes
const	INVALID = 'stringLengthInvalid'
const	TOO_SHORT = 'stringLengthTooShort'
const	TOO_LONG = 'stringLengthTooLong'

Protected Attributes
	$_messageTemplates
	$_messageVariables
	$_min
	$_max
	$_encoding
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)
	Set default translation object for all validate objects.
static	getDefaultTranslator ()
	Get default translation object for all validate objects.
static	hasDefaultTranslator ()
	Is there a default translation object set?
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	_error ($messageKey, $value=null)
	_setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options = array()

)

Sets validator options.

Parameters

integer | array | Zend_Config

$options

Returns

void

Member Function Documentation

getEncoding

(

)

Returns the actual encoding.

Returns

string

getMax

(

)

Returns the max option.

Returns

integer|null

getMin

(

)

Returns the min option.

Returns

integer

isValid

(

$value

)

Defined by Zend_Validate_Interface.

Returns true if and only if the string length of $value is at least the min option and no greater than the max option (when the max option is not null).

Parameters

string

$value

Returns

boolean

Implements Zend_Validate_Interface.

setEncoding

(

$encoding = null

)

Sets a new encoding to use.

Parameters

string

$encoding

Returns

Zend_Validate_StringLength

setMax

(

$max

)

Sets the max option.

Parameters

integer | null

$max

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_StringLength Provides a fluent interface

See Also

Zend_Validate_Exception

setMin

(

$min

)

Sets the min option.

Parameters

integer

$min

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_StringLength Provides a fluent interface

See Also

Zend_Validate_Exception

Member Data Documentation

$_encoding

protected

$_max

protected

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID   => "Invalid type given. String expected",
        self::TOO_SHORT => "'%value%' is less than %min% characters long",
        self::TOO_LONG  => "'%value%' is more than %max% characters long",
    )

$_messageVariables

protected

Initial value:

= array(
        'min' => '_min',
        'max' => '_max'
    )

$_min

protected

const INVALID = 'stringLengthInvalid'

const TOO_LONG = 'stringLengthTooLong'

const TOO_SHORT = 'stringLengthTooShort'