Zend_Validate_Ip Class Reference

Public Member Functions
	__construct ($options=array())
	Sets validator options.
	getOptions ()
	Returns all set options.
	setOptions ($options)
	Sets the options for this validator.
	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 = 'ipInvalid'
const	NOT_IP_ADDRESS = 'notIpAddress'

Protected Member Functions
	_validateIPv4 ($value)
	Validates an IPv4 address.
	_validateIPv6 ($value)
	Validates an IPv6 address.
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.

Protected Attributes
	$_messageTemplates
	$_options
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.
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options = array()

)

Sets validator options.

Parameters

array

$options

OPTIONAL Options to set, see the manual for all available options

Returns

void

Member Function Documentation

_validateIPv4 (   $value )

protected

Validates an IPv4 address.

Parameters

string

$value

_validateIPv6 (   $value )

protected

Validates an IPv6 address.

Parameters

string

$value

Value to check against

Returns

boolean True when $value is a valid ipv6 address False otherwise

getOptions

(

)

Returns all set options.

Returns

array

isValid

(

$value

)

Defined by Zend_Validate_Interface.

Returns true if and only if $value is a valid IP address

Parameters

mixed

$value

Returns

boolean

Implements Zend_Validate_Interface.

setOptions

(

$options

)

Sets the options for this validator.

Parameters

array

$options

Returns

Zend_Validate_Ip

Member Data Documentation

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID        => "Invalid type given. String expected",
        self::NOT_IP_ADDRESS => "'%value%' does not appear to be a valid IP address",
    )

$_options

protected

Initial value:

= array(
        'allowipv6' => true,
        'allowipv4' => true
    )

const INVALID = 'ipInvalid'

const NOT_IP_ADDRESS = 'notIpAddress'