filter-var-array.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 85264ba268a398c4b90c1948839d54ce688dd5cd Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.filter-var-array">
 <refnamediv>
  <refname>filter_var_array</refname>
  <refpurpose>Принимает несколько переменных и, при необходимости, фильтрует их</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type><type>null</type></type><methodname>filter_var_array</methodname>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>int</type></type><parameter>options</parameter><initializer><constant>FILTER_DEFAULT</constant></initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>add_empty</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Фильтр значений ассоциативного массива (&array;) с использованием
   фильтров проверки (<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>),
   очистки (<constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>)
   или пользовательских фильтров.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>array</parameter></term>
    <listitem>
     <simpara>
      Ассоциативный массив (&array;), содержащий данные для фильтрации.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <simpara>
      Либо ассоциативный массив (<type>array</type>) опций, либо фильтр,
      применяемый к каждой записи, который может быть либо фильтром проверки с использованием одной из констант
      <constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>,
      либо фильтром очистки с использованием одной из констант
      <constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>.
     </simpara>
     <simpara>
      Массив опций – это ассоциативный массив, в котором ключ соответствует ключу
      во входном массиве,
      а связанное с ним значение – это либо фильтр, который нужно применить к этой записи,
      либо ассоциативный массив, описывающий, как и какой фильтр должен быть применён к этой записи.
     </simpara>
     <simpara>
      Ассоциативный массив, описывающий применение фильтра, должен содержать ключ <literal>'filter'</literal>,
      ассоциированным значением которого является применяемый фильтр,
      который может быть одной из констант <constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>,
      <constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>,
      <constant>FILTER_UNSAFE_RAW</constant> или <constant>FILTER_CALLBACK</constant>.
      Дополнительно может содержать ключ <literal>'flags'</literal>, задающий любые флаги,
      которые применяются к фильтру, и ключ <literal>'options'</literal>,
      задающий любые опции, которые применяются к фильтру.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>add_empty</parameter></term>
    <listitem>
     <para>
      Добавить отсутствующие ключи в виде &null; в возвращаемое значение.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   В случае успешного выполнения функция возвращает массив (&array;),
   который содержит значения запрошенных переменных.
  </simpara>
  <simpara>
   Функция возвращает значение &false; в случае возникновения ошибки.
  </simpara>
  <simpara>
   Недостающие записи входного массива добавляются в возвращаемый массив (&array;)
   со значением &null;, если значение параметра <parameter>add_empty</parameter>
   равно &true;, и полностью пропускаются, если оно равно &false;.
  </simpara>
  <simpara>
   Элемент возвращаемого массива (&array;) будет &false;,
   если фильтр не сработал, если только не используется флаг
   <constant>FILTER_NULL_ON_FAILURE</constant>, в этом случае он будет &null;.
   С флагом <constant>FILTER_FORCE_ARRAY</constant> это значение неудачи,
   как и любой другой результат, оборачивается в массив из одного элемента.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример использования <function>filter_var_array</function></title>
   <simpara>
    Записи фильтруются как скалярные значения, если не указали флаг
    <constant>FILTER_REQUIRE_ARRAY</constant> или
    <constant>FILTER_FORCE_ARRAY</constant>.
    Поэтому флаг <constant>FILTER_REQUIRE_SCALAR</constant> у записи
    <literal>testscalar</literal> ниже лишь задаёт это поведение явно.
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php

$data = [
    'product_id' => 'libgd<script>',
    'component'  => '10',
    'versions'   => '2.0.33',
    'testscalar' => ['2', '23', '10', '12'],
    'testarray'  => '2',
];

$filters = [
    'product_id'   => FILTER_SANITIZE_ENCODED,
    'component'    => [
        'filter'   => FILTER_VALIDATE_INT,
        'flags'    => FILTER_FORCE_ARRAY,
        'options'  => [
            'min_range' => 1,
            'max_range' => 10,
        ],
    ],
    'versions'     => [
        'filter' => FILTER_SANITIZE_ENCODED
    ],
    'testscalar'   => [
        'filter' => FILTER_VALIDATE_INT,
        'flags'  => FILTER_REQUIRE_SCALAR,
    ],
    'testarray'    => [
        'filter' => FILTER_VALIDATE_INT,
        'flags'  => FILTER_FORCE_ARRAY,
    ],
    'doesnotexist' => FILTER_VALIDATE_INT,
];

var_dump(filter_var_array($data, $filters));

?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
array(6) {
  ["product_id"]=>
  string(17) "libgd%3Cscript%3E"
  ["component"]=>
  array(1) {
    [0]=>
    int(10)
  }
  ["versions"]=>
  string(6) "2.0.33"
  ["testscalar"]=>
  bool(false)
  ["testarray"]=>
  array(1) {
    [0]=>
    int(2)
  }
  ["doesnotexist"]=>
  NULL
}
]]>
   </screen>
  </example>
  <example>
   <title>Применение одного фильтра ко всем значениям</title>
   <simpara>
    Когда в параметре <parameter>options</parameter> передали целое число
    (&integer;), один и тот же фильтр применяется к каждой записи массива.
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php
$data = [
    'name'  => '<b>John</b>',
    'email' => 'john@example<script>.com',
    'bio'   => 'Developer & writer',
];

var_dump(filter_var_array($data, FILTER_SANITIZE_SPECIAL_CHARS));
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
array(3) {
  ["name"]=>
  string(27) "&#60;b&#62;John&#60;/b&#62;"
  ["email"]=>
  string(32) "john@example&#60;script&#62;.com"
  ["bio"]=>
  string(22) "Developer &#38; writer"
}
]]>
   </screen>
  </example>
  <example>
   <title>Применение фильтра <constant>FILTER_CALLBACK</constant></title>
   <programlisting role="php">
<![CDATA[
<?php
$data = [
    'name'  => '  John Doe  ',
    'city'  => '  New York  ',
];

$options = [
    'name' => [
        'filter'  => FILTER_CALLBACK,
        'options' => 'trim',
    ],
    'city' => [
        'filter'  => FILTER_CALLBACK,
        'options' => function ($value) {
            return strtoupper(trim($value));
        },
    ],
];

var_dump(filter_var_array($data, $options));
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
array(2) {
  ["name"]=>
  string(8) "John Doe"
  ["city"]=>
  string(8) "NEW YORK"
}
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>filter_input_array</function></member>
   <member><function>filter_var</function></member>
   <member><function>filter_input</function></member>
   <member>
    Фильтры проверки:
    <constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>
   </member>
   <member>
    Фильтры очистки:
    <constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>
   </member>
  </simplelist>
 </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:"~/.phpdoc/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
-->