documentation/manual/en/module_specs/Zend_Validate-Ip.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect2 id="zend.validate.set.ip">
   4     <title>Ip</title>
   5
   6     <para>
   7         <classname>Zend_Validate_Ip</classname> allows you to validate if a given value is an IP
   8         address. It supports the IPv4 and also the IPv6 standard.
   9     </para>
  10
  11     <sect3 id="zend.validate.set.ip.options">
  12         <title>Supported options for Zend_Validate_Ip</title>
  13
  14         <para>
  15             The following options are supported for <classname>Zend_Validate_Ip</classname>:
  16         </para>
  17
  18         <itemizedlist>
  19             <listitem>
  20                 <para>
  21                     <emphasis><property>allowipv4</property></emphasis>: Defines if the validator
  22                     allows IPv4 adresses. This option defaults to <constant>TRUE</constant>.
  23                 </para>
  24             </listitem>
  25
  26             <listitem>
  27                 <para>
  28                     <emphasis><property>allowipv6</property></emphasis>: Defines if the validator
  29                     allows IPv6 adresses. This option defaults to <constant>TRUE</constant>.
  30                 </para>
  31             </listitem>
  32         </itemizedlist>
  33     </sect3>
  34
  35     <sect3 id="zend.validate.set.ip.basic">
  36         <title>Basic usage</title>
  37
  38         <para>
  39             A basic example of usage is below:
  40         </para>
  41
  42         <programlisting language="php"><![CDATA[
  43 $validator = new Zend_Validate_Ip();
  44 if ($validator->isValid($ip)) {
  45     // ip appears to be valid
  46 } else {
  47     // ip is invalid; print the reasons
  48 }
  49 ]]></programlisting>
  50
  51         <note>
  52             <title>Invalid IP addresses</title>
  53
  54             <para>
  55                 Keep in mind that <classname>Zend_Validate_Ip</classname> only validates IP
  56                 addresses. Addresses like '<filename>mydomain.com</filename>' or
  57                 '<filename>192.168.50.1/index.html</filename>' are no valid
  58                 IP addresses. They are either hostnames or valid <acronym>URL</acronym>s but not IP
  59                 addresses.
  60             </para>
  61         </note>
  62
  63         <note>
  64             <title>IPv6 validation</title>
  65
  66             <para>
  67                 <classname>Zend_Validate_Ip</classname> validates IPv6 addresses with regex. The
  68                 reason is that the filters and methods from <acronym>PHP</acronym> itself don't
  69                 follow the <acronym>RFC</acronym>. Many other available classes also don't follow
  70                 it.
  71             </para>
  72         </note>
  73     </sect3>
  74
  75     <sect3 id="zend.validate.set.ip.singletype">
  76         <title>Validate IPv4 or IPV6 alone</title>
  77
  78         <para>
  79             Sometimes it's useful to validate only one of the supported formats. For example when
  80             your network only supports IPv4. In this case it would be useless to allow IPv6 within
  81             this validator.
  82         </para>
  83
  84         <para>
  85             To limit <classname>Zend_Validate_Ip</classname> to one protocol you can set the options
  86             <property>allowipv4</property> or <property>allowipv6</property> to
  87             <constant>FALSE</constant>. You can do this either by giving the option to the
  88             constructor or by using <methodname>setOptions()</methodname> afterwards.
  89         </para>
  90
  91         <programlisting language="php"><![CDATA[
  92 $validator = new Zend_Validate_Ip(array('allowipv6' => false);
  93 if ($validator->isValid($ip)) {
  94     // ip appears to be valid ipv4 address
  95 } else {
  96     // ip is no ipv4 address
  97 }
  98 ]]></programlisting>
  99
 100         <note>
 101             <title>Default behaviour</title>
 102
 103             <para>
 104                 The default behaviour which <classname>Zend_Validate_Ip</classname> follows is to
 105                 allow both standards.
 106             </para>
 107         </note>
 108     </sect3>
 109 </sect2>
 110 <!--
 111 vim:se ts=4 sw=4 et:
 112 -->