pajoye          Fri Oct 20 01:47:29 2006 UTC

  Added files:                 
    /phpdoc/en/reference/filter/functions       filter-has-var.xml 
                                                filter-id.xml 
                                                filter-input-array.xml 
                                                filter-input.xml 
                                                filter-list.xml 
                                                filter-var-array.xml 
                                                filter-var.xml 

  Removed files:               
    /phpdoc/en/reference/filter/functions       filter-data.xml 
                                                input-filters-list.xml 
                                                input-get-args.xml 
                                                input-get.xml 
                                                input-has-variable.xml 
                                                input-name-to-filter.xml 
  Log:
  - filter api shakeup 1/2
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filter/functions/filter-has-var.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/filter/functions/filter-has-var.xml
+++ phpdoc/en/reference/filter/functions/filter-has-var.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.filter-has-var">
 <refnamediv>
  <refname>filter_has_var</refname>
  <refpurpose>Checks if variable of specified type exists</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>filter_has_var</methodname>
   <methodparam><type>int</type><parameter>type</parameter></methodparam>
   
<methodparam><type>string</type><parameter>variable_name</parameter></methodparam>
  </methodsynopsis>

  &warn.experimental.func;

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       One of <constant>INPUT_GET</constant>, <constant>INPUT_POST</constant>,
       <constant>INPUT_COOKIE</constant>, <constant>INPUT_SERVER</constant>,
       <constant>INPUT_ENV</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>variable_name</parameter></term>
     <listitem>
      <para>
       Name of a variable to check.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filter/functions/filter-id.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/filter/functions/filter-id.xml
+++ phpdoc/en/reference/filter/functions/filter-id.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.filter-id">
 <refnamediv>
  <refname>filter_id</refname>
  <refpurpose>Returns the filter ID belonging to a named filter</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>filter_id</methodname>
   
<methodparam><type>string</type><parameter>filtername</parameter></methodparam>
  </methodsynopsis>

  &warn.experimental.func;

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filtername</parameter></term>
     <listitem>
      <para>
       Name of a filter to get.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   ID of a filter on success or &null; if filter doesn't exist.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>filter_list</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filter/functions/filter-input-array.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/filter/functions/filter-input-array.xml
+++ phpdoc/en/reference/filter/functions/filter-input-array.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.filter-input-array">
 <refnamediv>
  <refname>filter_input_array</refname>
  <refpurpose>Gets multiple variables from outside PHP and optionally filters 
them</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>filter_input_array</methodname>
   <methodparam><type>int</type><parameter>type</parameter></methodparam>
   <methodparam><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  &warn.experimental.func;
  <para>
   This function is useful for retrieving many values without
   repetitively calling <function>filter_input</function>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       One of <constant>INPUT_GET</constant>, <constant>INPUT_POST</constant>,
       <constant>INPUT_COOKIE</constant>, <constant>INPUT_SERVER</constant>,
       <constant>INPUT_ENV</constant>, <constant>INPUT_SESSION</constant>, or
       <constant>INPUT_DATA</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>definition</parameter></term>
     <listitem>
      <para>
       An array defining the arguments. A valid key is a <type>string</type>
       containing a variable name and a valid value is either a filter type,
       or an <type>array</type> optionally specifying the filter, flags and
       options. If the value is an array, valid keys are
       <literal>filter</literal> which specifies the filter type,
       <literal>flags</literal> which specifies any flags that apply to the
       filter, and <literal>options</literal> which specifies any options
       that apply to the filter. See the example below for a better
       understanding.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An array containing the values of the requested variables on success, or 
&false; 
   on failure. An array value will be &false; if the filter fails, or &null; if 
   the variable is not set. Or if the flag 
<constant>FILTER_NULL_ON_FAILURE</constant>
   is used, it returns &false; if the variable is not set and &null; if the 
filter 
   fails.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>filter_input_array</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
error_reporting(E_ALL | E_STRICT);
$data = array(
    'product_id'    => 'libgd<script>',
    'component'     => '10',
    'versions'      => '2.0.33',
    'testscalar'    => array('2', '23', '10', '12'),
    'testarray'     => '2',
);

$args = array(
    'product_id'   => FILTER_SANITIZE_ENCODED,
    'component'    => array('filter'    => FILTER_VALIDATE_INT,
                            'flags'     => FILTER_FLAG_ARRAY, 
                            'options'   => array('min_range' => 1, 'max_range' 
=> 10)
                           ),
    'versions'     => FILTER_SANITIZE_ENCODED,
    'doesnotexist' => FILTER_VALIDATE_INT,
    'testscalar'   => array(
                            'filter' => FILTER_VALIDATE_INT,
                            'flags'  => FILTER_FLAG_SCALAR,
                           ),
    'testarray'    => array(
                            'filter' => FILTER_VALIDATE_INT,
                            'flags'  => FILTER_FLAG_ARRAY,
                           )

);

$myinputs = filter_input_array(INPUT_DATA, $args, $data);

var_dump($myinputs);
echo "\n";
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(6) {
  ["product_id"]=>
  array(1) {
    [0]=>
    string(17) "libgd%3Cscript%3E"
  }
  ["component"]=>
  array(1) {
    [0]=>
    int(10)
  }
  ["versions"]=>
  array(1) {
    [0]=>
    string(6) "2.0.33"
  }
  ["doesnotexist"]=>
  NULL
  ["testscalar"]=>
  bool(false)
  ["testarray"]=>
  array(1) {
    [0]=>
    int(2)
  }
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>filter_input</function></member>
    <member><function>filter_var_array</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filter/functions/filter-input.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/filter/functions/filter-input.xml
+++ phpdoc/en/reference/filter/functions/filter-input.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.filter-input">
 <refnamediv>
  <refname>filter_input</refname>
  <refpurpose>Gets variable from outside PHP and optionally filters 
it</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>filter_input</methodname>
   <methodparam><type>int</type><parameter>type</parameter></methodparam>
   
<methodparam><type>string</type><parameter>variable_name</parameter></methodparam>
   <methodparam 
choice="opt"><type>int</type><parameter>filter</parameter></methodparam>
   <methodparam 
choice="opt"><type>mixed</type><parameter>options</parameter></methodparam>
  </methodsynopsis>

  &warn.experimental.func;

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       One of <constant>INPUT_GET</constant>, <constant>INPUT_POST</constant>,
       <constant>INPUT_COOKIE</constant>, <constant>INPUT_SERVER</constant>,
       <constant>INPUT_ENV</constant>, <constant>INPUT_SESSION</constant> (not
       implemented yet) and INPUT_REQUEST.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>variable_name</parameter></term>
     <listitem>
      <para>
       Name of a variable to get.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>filter</parameter></term>
     <listitem>
      <para>
       Filter to apply. Defaults to <constant>FILTER_DEFAULT</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Associative array of options or bitwise disjunction of flags. If filter
       accepts options, flags can be provided in "flags" field of array.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Value of the requested variable on success, &false; if the filter fails,
   or &null; if the <parameter>variable_name</parameter> variable is not set.
   If the flag <constant>FILTER_NULL_ON_FAILURE</constant> is used, it
   returns &false; if the variable is not set and &null; if the filter fails.
   </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>filter_input</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$search_html = filter_input(INPUT_GET, 'search', FILTER_SANITIZE_SPECIAL_CHARS);
$search_url = filter_input(INPUT_GET, 'search', FILTER_SANITIZE_ENCODED);
echo "You have searched for $search_html.\n";
echo "<a href='?search=$search_url'>Search again.</a>";
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
You have searched for Me &#38; son.
<a href='?search=Me%20%26%20son'>Search again.</a>
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>filter_var</function></member>
    <member><function>filter_input_array</function></member>
    <member><function>filter_var_array</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filter/functions/filter-list.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/filter/functions/filter-list.xml
+++ phpdoc/en/reference/filter/functions/filter-list.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.filter-list">
 <refnamediv>
  <refname>filter_list</refname>
  <refpurpose>Returns a list of all supported filters</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>filter_list</methodname>
   <void/>
  </methodsynopsis>

  &warn.experimental.func;

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of names of all supported filters, empty array if there
   are no such filters. Indexes of this array are not filter IDs, they can be
   obtained with <function>filter_id</function> from a name instead.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>filter_list</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
print_r(filter_list());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [0] => int
    [1] => boolean
    [2] => float
    [3] => validate_regexp
    [4] => validate_url
    [5] => validate_email
    [6] => validate_ip
    [7] => string
    [8] => stripped
    [9] => encoded
    [10] => special_chars
    [11] => unsafe_raw
    [12] => email
    [13] => url
    [14] => number_int
    [15] => number_float
    [16] => magic_quotes
    [17] => callback
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filter/functions/filter-var-array.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/filter/functions/filter-var-array.xml
+++ phpdoc/en/reference/filter/functions/filter-var-array.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.filter-var-array">
 <refnamediv>
  <refname>filter_var_array</refname>
  <refpurpose>Gets multiple variables from outside PHP and optionally filters 
them</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>filter_var_array</methodname>
   <methodparam><type>int</type><parameter>type</parameter></methodparam>
   <methodparam><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  &warn.experimental.func;
  <para>
   This function is useful for retrieving many values without
   repetitively calling <function>filter_var</function>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       One of <constant>INPUT_GET</constant>, <constant>INPUT_POST</constant>,
       <constant>INPUT_COOKIE</constant>, <constant>INPUT_SERVER</constant>,
       <constant>INPUT_ENV</constant>, <constant>INPUT_SESSION</constant>, or
       <constant>INPUT_DATA</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>definition</parameter></term>
     <listitem>
      <para>
       An array defining the arguments. A valid key is a <type>string</type>
       containing a variable name and a valid value is either a filter type,
       or an <type>array</type> optionally specifying the filter, flags and
       options. If the value is an array, valid keys are
       <literal>filter</literal> which specifies the filter type,
       <literal>flags</literal> which specifies any flags that apply to the
       filter, and <literal>options</literal> which specifies any options
       that apply to the filter. See the example below for a better
       understanding.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An array containing the values of the requested variables on success, or 
&false; 
   on failure. An array value will be &false; if the filter fails, or &null; if 
   the variable is not set.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>filter_var_array</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
error_reporting(E_ALL | E_STRICT);
$data = array(
    'product_id'    => 'libgd<script>',
    'component'     => '10',
    'versions'      => '2.0.33',
    'testscalar'    => array('2', '23', '10', '12'),
    'testarray'     => '2',
);

$args = array(
    'product_id'   => FILTER_SANITIZE_ENCODED,
    'component'    => array('filter'    => FILTER_VALIDATE_INT,
                            'flags'     => FILTER_FLAG_ARRAY, 
                            'options'   => array('min_range' => 1, 'max_range' 
=> 10)
                           ),
    'versions'     => FILTER_SANITIZE_ENCODED,
    'doesnotexist' => FILTER_VALIDATE_INT,
    'testscalar'   => array(
                            'filter' => FILTER_VALIDATE_INT,
                            'flags'  => FILTER_FLAG_SCALAR,
                           ),
    'testarray'    => array(
                            'filter' => FILTER_VALIDATE_INT,
                            'flags'  => FILTER_FLAG_ARRAY,
                           )

);

$myinputs = input_var_array($data, $args);

var_dump($myinputs);
echo "\n";
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(6) {
  ["product_id"]=>
  array(1) {
    [0]=>
    string(17) "libgd%3Cscript%3E"
  }
  ["component"]=>
  array(1) {
    [0]=>
    int(10)
  }
  ["versions"]=>
  array(1) {
    [0]=>
    string(6) "2.0.33"
  }
  ["doesnotexist"]=>
  NULL
  ["testscalar"]=>
  bool(false)
  ["testarray"]=>
  array(1) {
    [0]=>
    int(2)
  }
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>filter_input_array</function></member>
    <member><function>filter_var</function></member>
    <member><function>filter_input</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filter/functions/filter-var.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/filter/functions/filter-var.xml
+++ phpdoc/en/reference/filter/functions/filter-var.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.filter-var">
 <refnamediv>
  <refname>filter_var</refname>
  <refpurpose>Filters a variable with a specified filter</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>filter_data</methodname>
   <methodparam><type>mixed</type><parameter>variable</parameter></methodparam>
   <methodparam><type>int</type><parameter>filter</parameter></methodparam>
   <methodparam 
choice="opt"><type>mixed</type><parameter>options</parameter></methodparam>
  </methodsynopsis>

  &warn.experimental.func;

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>variable</parameter></term>
     <listitem>
      <para>
       Value to filter, arrays are filtered recursively.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>filter</parameter></term>
     <listitem>
      <para>
       ID of a filter to use.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Associative array of options or bitwise disjunction of flags. If filter
       accepts options, flags can be provided in "flags" field of array. For
       the "callback" filter, <type>callback</type> type should be passed.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the filtered data, or &false; if the filter fails.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>filter_var</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(filter_data('[EMAIL PROTECTED]', FILTER_VALIDATE_EMAIL));
var_dump(filter_data('example.com', FILTER_VALIDATE_URL, 
FILTER_FLAG_SCHEME_REQUIRED));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(15) "[EMAIL PROTECTED]"
bool(false)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>filter_var_array</function></member>
    <member><function>filter_input</function></member>
    <member><function>filter_input_array</function></member>
    <member>&seealso.callback;</member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

Reply via email to