Zend_Validate_Ip Class Reference

Inheritance diagram for Zend_Validate_Ip:

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

Data Fields
const	INVALID = 'ipInvalid'
const	NOT_IP_ADDRESS = 'notIpAddress'

Protected Member Functions
	_validateIPv4 ($value)
	_validateIPv6 ($value)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)

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)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 33 of file Ip.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Sets validator options

Parameters

array

$options

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

Definition at line 61 of file Ip.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (!is_array($options)) {
            $options = func_get_args();
            $temp['allowipv6'] = array_shift($options);
            if (!empty($options)) {
                $temp['allowipv4'] = array_shift($options);
            }

            $options = $temp;
        }

        $options += $this->_options;
        $this->setOptions($options);
    }

Member Function Documentation

_validateIPv4()

_validateIPv4 (   $value )

protected

Validates an IPv4 address

Parameters

string

$value

Returns

bool

Definition at line 146 of file Ip.php.

                                             {
        $ip2long = ip2long($value);
        if($ip2long === false) {
            return false;
        }

        return $value == long2ip($ip2long);
    }

_validateIPv6()

_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

Definition at line 162 of file Ip.php.

                                             {
        if (strlen($value) < 3) {
            return $value == '::';
        }

        if (strpos($value, '.')) {
            $lastcolon = strrpos($value, ':');
            if (!($lastcolon && $this->_validateIPv4(substr($value, $lastcolon + 1)))) {
                return false;
            }

            $value = substr($value, 0, $lastcolon) . ':0:0';
        }

        if (strpos($value, '::') === false) {
            return preg_match('/\A(?:[a-f0-9]{1,4}:){7}[a-f0-9]{1,4}\z/i', $value);
        }

        $colonCount = substr_count($value, ':');
        if ($colonCount < 8) {
            return preg_match('/\A(?::|(?:[a-f0-9]{1,4}:)+):(?:(?:[a-f0-9]{1,4}:)*[a-f0-9]{1,4})?\z/i', $value);
        }

        // special case with ending or starting double colon
        if ($colonCount == 8) {
            return preg_match('/\A(?:::)?(?:[a-f0-9]{1,4}:){6}[a-f0-9]{1,4}(?:::)?\z/i', $value);
        }

        return false;
    }

getOptions()

getOptions

(

)

Returns all set options

Returns

array

Definition at line 84 of file Ip.php.

    {
        return $this->_options;
    }

isValid()

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.

Definition at line 122 of file Ip.php.

    {
        if (!is_string($value)) {
            $this->_error(self::INVALID);
            return false;
        }

        $this->_setValue($value);
        if (($this->_options['allowipv4'] && !$this->_options['allowipv6'] && !$this->_validateIPv4($value)) ||
            (!$this->_options['allowipv4'] && $this->_options['allowipv6'] && !$this->_validateIPv6($value)) ||
            ($this->_options['allowipv4'] && $this->_options['allowipv6'] && !$this->_validateIPv4($value) && !$this->_validateIPv6($value))) {
            $this->_error(self::NOT_IP_ADDRESS);
            return false;
        }

        return true;
    }

setOptions()

setOptions

(

$options

)

Sets the options for this validator

Parameters

array

$options

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_Ip

Definition at line 96 of file Ip.php.

    {
        if (array_key_exists('allowipv6', $options)) {
            $this->_options['allowipv6'] = (boolean) $options['allowipv6'];
        }

        if (array_key_exists('allowipv4', $options)) {
            $this->_options['allowipv4'] = (boolean) $options['allowipv4'];
        }

        if (!$this->_options['allowipv4'] && !$this->_options['allowipv6']) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Nothing to validate. Check your options');
        }

        return $this;
    }

Field Documentation

$_messageTemplates

$_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",
    )

Definition at line 41 of file Ip.php.

$_options

$_options

protected

Initial value:

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

Definition at line 51 of file Ip.php.

INVALID

const INVALID = 'ipInvalid'

Definition at line 35 of file Ip.php.

NOT_IP_ADDRESS

const NOT_IP_ADDRESS = 'notIpAddress'

Definition at line 36 of file Ip.php.

---

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

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