archived-doc-pt-br/reference/array/functions/compact.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: d58ee8eaaa7f716c51f66f5f1058ab3c42376d98 Maintainer: lhsazevedo Status: ready --><!-- CREDITS: narigone,lucasr,felipe,lhsazevedo,fernandowobeto,leonardolara -->
<refentry xml:id="function.compact" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>compact</refname>
  <refpurpose>Cria um array contendo variáveis e seus valores</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>
   Cria um array contendo variáveis e seus valores.
  </para>
  <para>
   Para cada um dos parâmetros passados, <function>compact</function> procura
   uma variável com o nome especificado na
   <link linkend="features.gc.refcounting-basics">tabela de símbolos</link> atual
   e a adiciona no array de saída de forma que o nome da variável se torne a chave
   e o conteúdo da variável se torne o valor para essa chave.
   Em resumo, ela faz o oposto de <function>extract</function>.
  </para>
  <note>
   <para>
    Antes do PHP 7.3, quaisquer strings que não estejam definidas seriam silenciosamente ignoradas.
   </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> recebe um número variável de parâmetros.
       Cada parâmetro pode ser ou uma string contendo o nome da variável, ou
       um array de nomes de variáveis. O array pode conter outros arrays de
       nomes de variáveis; <function>compact</function> o manipula
       recursivamente.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna a saída do array com todas as variáveis adicionadas a ele.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <function>compact</function> emite um erro nível <constant>E_WARNING</constant> se uma determinada string
   se refere a uma variável não definida.
  </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>
       Se uma determinada string fizer referência a uma variável não definida, um erro de nível <constant>E_WARNING</constant> será emitido.
      </entry>
     </row>
     <row>
      <entry>7.3.0</entry>
      <entry>
       <function>compact</function> agora emite um erro nível <constant>E_NOTICE</constant> se uma determinada string
       se refere a uma variável não definida. Anteriomente, strings como essa seriam ignoradas silenciosamente.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1><!-- }}} -->

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemplo de <function>compact</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$cidade = "Sao Paulo";
$estado = "SP";
$evento = "SIGGRAPH";

$vars_localidade = array("cidade", "estado");

$result = compact("evento", $vars_localidade);
print_r($result);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
Array
(
    [evento] => SIGGRAPH
    [cidade] => Sao Paulo
    [estado] => SP
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Armadilha</title>
   <para>
    Devido a <link linkend="language.variables.variable">variáveis
    variável</link> não poderem ser usadas com <link
    linkend="language.variables.superglobals">arrays superglobais</link> do PHP
    dentro de funções, os arrays superglobais não podem ser passados
    na <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
-->