Ip Class Reference

Public Member Functions
	setOptions ($options=[])
	Sets the options for this validator.
	isValid ($value)
	Returns true if and only if $value is a valid IP address.
Public Member Functions inherited from AbstractValidator
	__construct ($options=null)
	Abstract constructor for all validators A validator should accept following parameters:
	getOption ($option)
	Returns an option.
	getOptions ()
	Returns all available options.
	setOptions ($options=[])
	Sets one or multiple options.
	getMessages ()
	Returns array of validation failure messages.
	__invoke ($value)
	Invoke as command.
	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.
	setValueObscured ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	isValueObscured ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setTranslatorTextDomain ($textDomain= 'default')
	Set translation text domain.
	getTranslatorTextDomain ()
	Return the translation text domain.
	setTranslatorEnabled ($flag=true)
	Indicate whether or not translation should be enabled.
	isTranslatorEnabled ()
	Is translation enabled?
Public Member Functions inherited from TranslatorAwareInterface
	setTranslator (TranslatorInterface $translator=null, $textDomain=null)
	Sets translator to use in helper.

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.
	validateIPvFuture ($value)
	Validates an IPvFuture address.
Protected Member Functions inherited from AbstractValidator
	createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	error ($messageKey, $value=null)
	getValue ()
	Returns the validation value.
	setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
	translateMessage ($messageKey, $message)
	Translate a validation message.

Protected Attributes
	$messageTemplates
	$options
Protected Attributes inherited from AbstractValidator
	$value
	$abstractOptions

Additional Inherited Members
Static Public Member Functions inherited from AbstractValidator
static	setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=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	setDefaultTranslatorTextDomain ($textDomain= 'default')
	Set default translation text domain for all validate objects.
static	getDefaultTranslatorTextDomain ()
	Get default translation text domain for all validate objects.
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Static Protected Attributes inherited from AbstractValidator
static	$defaultTranslator
static	$defaultTranslatorTextDomain = 'default'
static	$messageLength = -1

Member Function Documentation

isValid

(

$value

)

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

Parameters

mixed

$value

Returns

bool

Implements ValidatorInterface.

setOptions

(

$options = []

)

Sets the options for this validator.

Parameters

array | Traversable

$options

Exceptions

Exception\InvalidArgumentException

If there is any kind of IP allowed or $options is not an array or Traversable.

Returns

AbstractValidator

validateIPv4 (   $value )

protected

Validates an IPv4 address.

Parameters

string

$value

Returns

bool

validateIPv6 (   $value )

protected

Validates an IPv6 address.

Parameters

string

$value

Value to check against

Returns

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

validateIPvFuture (   $value )

protected

Validates an IPvFuture address.

IPvFuture is loosely defined in the Section 3.2.2 of RFC 3986

Parameters

string

$value

Value to check against

Returns

bool True when $value is a valid IPvFuture address False otherwise

Member Data Documentation

$messageTemplates

protected

Initial value:

= [
        self::INVALID        => 'Invalid type given. String expected'

$options

protected

Initial value:

= [
        'allowipv4'      => true

const INVALID = 'ipInvalid'

const NOT_IP_ADDRESS = 'notIpAddress'