Home Info Files

Zend Framework 2 Documentation (Manual)

File: /_sources/modules/zend.validator.ip.txt

.. _zend.validator.ip:

Ip Validator
============

``Zend\Validator\Ip`` allows you to validate if a given value is an IP address. It supports the IPv4, IPv6 and
IPvFeature definitions.

.. _zend.validator.ip.options:

Supported options for Zend\\Validator\\Ip
-----------------------------------------

The following options are supported for ``Zend\Validator\Ip``:

- **allowipv4**: Defines if the validator allows IPv4 addresses. This option defaults to ``TRUE``.

- **allowipv6**: Defines if the validator allows IPv6 addresses. This option defaults to ``TRUE``.

- **allowipvfuture**: Defines if the validator allows IPvFuture addresses. This option defaults to ``false``.

- **allowliteral**: Defines if the validator allows IPv6 or IPvFuture with URI literal style (the IP surrounded by
  brackets). This option defaults to ``true``.

.. _zend.validator.ip.basic:

Basic usage
-----------

A basic example of usage is below:

.. code-block:: php
   :linenos:

   $validator = new Zend\Validator\Ip();
   if ($validator->isValid($ip)) {
       // ip appears to be valid
   } else {
       // ip is invalid; print the reasons
   }

.. note::

   **Invalid IP addresses**

   Keep in mind that ``Zend\Validator\Ip`` only validates IP addresses. Addresses like '``mydomain.com``' or
   '``192.168.50.1/index.html``' are no valid IP addresses. They are either hostnames or valid *URL*\ s but not IP
   addresses.

.. note::

   **IPv6/IPvFuture validation**

   ``Zend\Validator\Ip`` validates IPv6/IPvFuture addresses with regex. The reason is that the filters and methods
   from *PHP* itself don't follow the *RFC*. Many other available classes also don't follow it.

.. _zend.validator.ip.singletype:

Validate IPv4 or IPV6 alone
---------------------------

Sometimes it's useful to validate only one of the supported formats. For example when your network only supports
IPv4. In this case it would be useless to allow IPv6 within this validator.

To limit ``Zend\Validator\Ip`` to one protocol you can set the options ``allowipv4`` or ``allowipv6`` to ``FALSE``.
You can do this either by giving the option to the constructor or by using ``setOptions()`` afterwards.

.. code-block:: php
   :linenos:

   $validator = new Zend\Validator\Ip(array('allowipv6' => false));
   if ($validator->isValid($ip)) {
       // ip appears to be valid ipv4 address
   } else {
       // ip is no ipv4 address
   }

.. note::

   **Default behaviour**

   The default behaviour which ``Zend\Validator\Ip`` follows is to allow both standards.