From cb09b6c255842eb2ea2b4faeb3c0d71903e1f53f Mon Sep 17 00:00:00 2001
From: Pierre Joye <pajoye@php.net>
Date: Fri, 20 Oct 2006 01:48:13 +0000
Subject: [PATCH] - filter api shakeup 2/2

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@222048 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/filter/configure.xml |  4 +-
 reference/filter/constants.xml | 76 ++++++++++++++++++++++------------
 reference/filter/ini.xml       |  4 +-
 3 files changed, 53 insertions(+), 31 deletions(-)

diff --git a/reference/filter/configure.xml b/reference/filter/configure.xml
index f9174e4823..f2f67e901f 100644
--- a/reference/filter/configure.xml
+++ b/reference/filter/configure.xml
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <section id="filter.installation">
  &reftitle.install;
  <para>
   A short installation note: just type
   <screen>
-$ pear install filter
+$ pecl install filter
   </screen>
   in your console.
  </para>
diff --git a/reference/filter/constants.xml b/reference/filter/constants.xml
index 68e996045e..970b45dc26 100644
--- a/reference/filter/constants.xml
+++ b/reference/filter/constants.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
 <section id="filter.constants">
  &reftitle.constants;
@@ -68,17 +68,19 @@
    <listitem>
     <simpara>
      <link linkend="reserved.variables.session">SESSION</link> variables.
+    (not implemented yet)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
-    <constant>INPUT_DATA</constant>
+    <constant>INPUT_REQUEST</constant>
      (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
-     User-defined set of variables.
+     <link linkend="reserved.variables.request">REQUEST</link> variables.
+    (not implemented yet)
     </simpara>
    </listitem>
   </varlistentry>
@@ -93,6 +95,50 @@
     </simpara>
    </listitem>
   </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>FILTER_REQUIRE_SCALAR</constant>
+     (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+      Flag used to require scalar as input
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>FILTER_REQUIRE_ARRAY</constant>
+     (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+      Require an array as input. 
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>FILTER_FORCE_ARRAY</constant>
+     (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+     Always returns an array.
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>FILTER_NULL_ON_FAILURE</constant>
+     (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+     Use NULL instead of FALSE on failure. 
+    </simpara>
+   </listitem>
+  </varlistentry>
   <varlistentry>
    <term>
     <constant>FILTER_VALIDATE_INT</constant>
@@ -302,30 +348,6 @@
     </simpara>
    </listitem>
   </varlistentry>
-  <varlistentry>
-   <term>
-    <constant>FILTER_FLAG_SCALAR</constant>
-     (<type>integer</type>)
-   </term>
-   <listitem>
-    <simpara>
-     Allow scalar types (non-<type>array</type>) only in filter.
-     Currently used by <function>input_get_args</function>.
-    </simpara>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <constant>FILTER_FLAG_ARRAY</constant>
-     (<type>integer</type>)
-   </term>
-   <listitem>
-    <simpara>
-     Only allow <type>array</type> type in filter.
-     Currently used by <function>input_get_args</function>.
-    </simpara>
-   </listitem>
-  </varlistentry>
   <varlistentry>
    <term>
     <constant>FILTER_FLAG_ALLOW_OCTAL</constant>
diff --git a/reference/filter/ini.xml b/reference/filter/ini.xml
index 4762c55c3e..1a69cdf8d8 100644
--- a/reference/filter/ini.xml
+++ b/reference/filter/ini.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <section id="filter.configuration">
  &reftitle.runtime;
  &extension.runtime;
@@ -46,7 +46,7 @@
    <listitem>
     <para>
      Filter all $_GET, $_POST, $_COOKIE and $_REQUEST data by this filter.
-     Original data can be accessed through <function>input_get</function>.
+     Original data can be accessed through <function>filter_input</function>.
     </para>
    </listitem>
   </varlistentry>