archived-doc-ru/reference/array/functions/compact.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d58ee8eaaa7f716c51f66f5f1058ab3c42376d98 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.compact" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>compact</refname>
  <refpurpose>Создаёт массив из названий и значений переменных</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>compact</methodname>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>var_name</parameter></methodparam>
   <methodparam rep="repeat"><type class="union"><type>array</type><type>string</type></type><parameter>var_names</parameter></methodparam>
  </methodsynopsis>
  <para>
  Функия создаёт массив из названий и значений переменных.
  </para>
  <para>
   Функция <function>compact</function> выполняет операцию, противоположную функции <function>extract</function>:
   рассматривает каждую строку в аргументах как название переменной,
   ищет в текущей <link linkend="features.gc.refcounting-basics">таблице символов</link> переменную
   с таким названием и добавляет переменную в выходной массив так, что название переменной становится ключом,
   а содержимое переменной — значением этого ключа.
  </para>
  <note>
   <para>
    До PHP 7.3 функция без предупреждения пропускала строку, если в текущей области видимости
    не установили переменную с таким названием.
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>var_name</parameter></term>
     <term><parameter>var_names</parameter></term>
     <listitem>
      <para>
       Функция <function>compact</function> принимает неограниченное количество аргументов.
       Каждый аргумент разрешается передавать как строку, которая содержит название переменной,
       или как массив названий переменных. Функция умеет обрабатывать массивы с вложенными массивами
       названий переменных; функция <function>compact</function> обрабатывает такие массивы
       рекурсивно.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает массив с переменными.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция <function>compact</function> выдаёт ошибку уровня <constant>E_WARNING</constant>,
   если строка ссылается на переменную, которую не установили.
  </para>
 </refsect1>

 <refsect1 role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Функция теперь генерирует ошибку уровня <constant>E_WARNING</constant>,
       если строка ссылается на переменную, которую не установили.
      </entry>
     </row>
     <row>
      <entry>7.3.0</entry>
      <entry>
       Функция <function>compact</function> теперь выдаёт ошибку уровня <constant>E_NOTICE</constant>,
       если строка ссылается на переменную, которую не установили. Раньше такие строки функция без предупреждения пропускала.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1><!-- }}} -->

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример создания массива из переменных функцией <function>compact</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$city  = "San Francisco";
$state = "CA";
$event = "SIGGRAPH";

$location_vars = array("city", "state");

$result = compact("event", $location_vars);
print_r($result);
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
Array
(
    [event] => SIGGRAPH
    [city] => San Francisco
    [state] => CA
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Замечания по работе функции compact</title>
   <para>
    Суперглобальные массивы нельзя передавать в функцию <function>compact</function>,
    поскольку <link linkend="language.variables.variable">переменные переменных</link>
    нельзя использовать <link linkend="language.variables.superglobals">с суперглобальными массивами</link>
    внутри функций.
   </para>
  </note>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>extract</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:"~/.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
-->