svn: /pear/peardoc/trunk/en/package/networking/ net-checkip2/is.xml net-checkip2.xml

till                                     Tue, 06 Oct 2009 18:17:47 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=289258

Log:
added is*() documentation

Changed paths:
    A + pear/peardoc/trunk/en/package/networking/net-checkip2/is.xml
        (from pear/peardoc/trunk/en/package/networking/net-checkip2/class.xml:r289254)
    U   pear/peardoc/trunk/en/package/networking/net-checkip2.xml

Copied: pear/peardoc/trunk/en/package/networking/net-checkip2/is.xml (from rev 289254, pear/peardoc/trunk/en/package/networking/net-checkip2/class.xml)
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-checkip2/is.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/networking/net-checkip2/is.xml	2009-10-06 18:17:47 UTC (rev 289258)
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter xmlns="http://docbook.org/ns/docbook" version="lillet"
+ xml:id="package.networking.net-checkip2.is"
+ xmlns:phd="http://www.php.net/ns/phd"
+>
+
+ <info>
+  <title>Net_CheckIP2::is*()</title>
+ </info>
+
+ <para>
+  Along with <function>isValid()</function>, <classname>Net_CheckIP2</classname>
+  offers a couple methods to determine the IP's whereabouts. Currently implemented
+  are methods to check if an IP is from a reserved IP space or the zeroconf pool.
+ </para>
+
+ <phd:toc phd:element="package.networking.net-checkip2.is" />
+
+ <section
+  xml:id="package.networking.net-checkip2.is.reserved"
+  phd:chunk="false"
+ >
+
+  <info><title>isReserved()</title></info>
+
+  <para>
+   Checks if the IP address is reserved (according to RFC1918).
+  </para>
+
+  <example>
+   <info><title>isReserved()</title></info>
+   <programlisting role="php"><![CDATA[
+require_once 'Net/CheckIP.php';
+$ip = '127.0.0.1';
+var_dump(Net_CheckIP::isReserved($ip));
+   ]]></programlisting>
+  </example>
+ </section>
+
+ <section
+  xml:id="package.networking.net-checkip2.is.zeroconf"
+  phd:chunk="false"
+ >
+
+  <info><title>isZeroconf()</title></info>
+
+  <para>
+   Zeroconf - automatically created usable IPs without manual intervention or
+   management/configuration servers. This includes IPs from 169.254.0.0 to
+   169.254.255.255. (RFC3330)
+  </para>
+
+  <example>
+   <info><title>isZeroConf()</title></info>
+   <programlisting role="php"><![CDATA[
+require_once 'Net/CheckIP.php';
+$ip = '127.0.0.1';
+var_dump(Net_CheckIP::isZeroconf($ip));
+   ]]></programlisting>
+  </example>
+ </section>
+
+</chapter>
\ No newline at end of file

Modified: pear/peardoc/trunk/en/package/networking/net-checkip2.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-checkip2.xml	2009-10-06 17:10:34 UTC (rev 289257)
+++ pear/peardoc/trunk/en/package/networking/net-checkip2.xml	2009-10-06 18:17:47 UTC (rev 289258)
@@ -1,18 +1,21 @@
 <?xml version="1.0" encoding="utf-8"?>
-<book xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.networking.net-checkip2">
+<book xmlns="http://docbook.org/ns/docbook" version="lillet"
+ xml:id="package.networking.net-checkip2">
+
  <info>
   <title>Net_CheckIP2</title>
   <abstract>
    <para>
-    A package to check the correct syntax of an IPv4 address, determine whether the
-    IP is from a private/reserved and its class (A, B and C are currently supported).
+    A package to check the correct syntax of an IPv4 address, to determine whether
+    the IP is from a private/reserved or the zeroconf pool, and the IP's class
+    network (A, B and C are currently supported).
    </para>
   </abstract>
  </info>

- <chapter>
-  &package.networking.net-checkip2.convert;
-  &package.networking.net-checkip2.check-ip;
-  &package.networking.net-checkip2.class;
- </chapter>
+ &package.networking.net-checkip2.convert;
+ &package.networking.net-checkip2.check-ip;
+ &package.networking.net-checkip2.class;
+ &package.networking.net-checkip2.is;
+
 </book>