Files
php-doc-ru/reference/array/functions/compact.xml
2024-08-26 13:16:00 +03:00

173 lines
6.0 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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>
ищет в текущей <link linkend="features.gc.refcounting-basics">таблице символов</link> переменную с таким же именем и добавляет
её в выводимый массив так, что имя переменной становится ключом,
а значение переменной становится значением этого ключа.
Короче, она выполняет операцию, противоположную функции <function>extract</function>.
</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>
Так как <link linkend="language.variables.variable">переменные
переменных</link> не могут быть использованы с
<link linkend="language.variables.superglobals">суперглобальными
массивами</link> внутри функций, суперглобальные массивы не могут
быть переданы в <function>compact</function>.
</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
-->