mirror of
https://github.com/php/doc-pt_br.git
synced 2026-03-24 07:02:09 +01:00
256 lines
8.9 KiB
XML
256 lines
8.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: f53ab502a11a52e82baca372c37d64e3f298b17c Maintainer: leonardolara Status: ready --><!-- CREDITS: adiel,felipe,lucasr,ae,leonardolara -->
|
|
<refentry xml:id="function.extract" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>extract</refname>
|
|
<refpurpose>Importa variáveis para a tabela de símbolos a partir de um array</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>extract</methodname>
|
|
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>EXTR_OVERWRITE</constant></initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>""</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Importa variáveis a partir de um array para a
|
|
<link linkend="features.gc.refcounting-basics">tabela de símbolos</link> atual.
|
|
</para>
|
|
<para>
|
|
Verifica se cada chave tem um nome válido de variável.
|
|
Também verifica por colisões com variáveis já existentes
|
|
na tabela de símbolos.
|
|
</para>
|
|
<warning>
|
|
<para>
|
|
Não use <function>extract</function> em dados inseguros, como informações externas
|
|
(ex.: <varname>$_GET</varname>, <varname>$_FILES</varname>).
|
|
</para>
|
|
</warning>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Um array associativo. Esta função trata chaves como nomes de variáveis
|
|
e valores como os valores das variáveis. Para cada par chave/valor ela cria
|
|
uma variável na tabela de símbolos atual, seguindo os parâmetros
|
|
<parameter>flags</parameter> e <parameter>prefix</parameter>.
|
|
</para>
|
|
<para>
|
|
É necesário usar um array associativo, um array numericamente indexado
|
|
não produzirá resultados até que seja usa a opção <constant>EXTR_PREFIX_ALL</constant> ou
|
|
<constant>EXTR_PREFIX_INVALID</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A forma como chaves inválidas/numéricas e colisões são tratadas é determinada
|
|
pelas opções de extração definidas no parâmetro <parameter>flags</parameter>. Pode ser um dos
|
|
seguintes valores:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><constant>EXTR_OVERWRITE</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
Se houver uma colisão, sobrescreve a variável existente.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>EXTR_SKIP</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
Se houver uma colisão, não sobrescreve a variável
|
|
existente.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>EXTR_PREFIX_SAME</constant></term>
|
|
<listitem>
|
|
<simpara>Se houver uma colisão, adiciona um prefixo ao nome da
|
|
variável definido pelo argumento <parameter>prefix</parameter>.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>EXTR_PREFIX_ALL</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
Adiciona um prefixo ao nome de todas as variáveis definido por
|
|
<parameter>prefix</parameter>.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>EXTR_PREFIX_INVALID</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
Adiciona um prefixo definido por <parameter>prefix</parameter> apenas
|
|
para variáveis como nomes inválidos ou numéricos.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>EXTR_IF_EXISTS</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
Só sobrescreve a variável se ela já existe na tabela de símbolos
|
|
corrente, caso contrário, não faz nada. Isso é útil
|
|
quando se quer definir uma lista de variáveis válidas e então
|
|
extrair só as que foram definidas em
|
|
<varname>$_REQUEST</varname>, por exemplo.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>EXTR_PREFIX_IF_EXISTS</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
Só cria nomes de variáveis usando o prefixo se na tabela de símbolos
|
|
já existe uma variável com o nome sem esse prefixo.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>EXTR_REFS</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
Extrai variáveis como referências, ou seja, os valores das variáveis
|
|
importadas ainda estarão referenciando os valores do parâmetro
|
|
<parameter>array</parameter>. Essa opção pode ser usada
|
|
sozinha ou em conjunto com as outras usando o operador 'ou' em
|
|
<parameter>flags</parameter>.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
Se <parameter>flags</parameter> não for especificado, é assumido
|
|
o valor <constant>EXTR_OVERWRITE</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>prefix</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Note que <parameter>prefix</parameter> só é necessário se
|
|
<parameter>flags</parameter> for <constant>EXTR_PREFIX_SAME</constant>,
|
|
<constant>EXTR_PREFIX_ALL</constant>, ou <constant>EXTR_PREFIX_INVALID</constant> ou
|
|
<constant>EXTR_PREFIX_IF_EXISTS</constant>. Se o nome com o prefixo
|
|
não for um nome de variável válido, ela não será importada para a tabela
|
|
de símbolos. Prefixos são automaticamente separados da chave do array pelo
|
|
caractere de sublinhado (_).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Retorna o número de variáveis importadas com sucesso para a tabela de
|
|
símbolos.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Exemplo da <function>extract</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$size = "large";
|
|
$var_array = array(
|
|
"color" => "blue",
|
|
"size" => "medium",
|
|
"shape" => "sphere"
|
|
);
|
|
|
|
extract($var_array, EXTR_PREFIX_SAME, "wddx");
|
|
|
|
echo "$color, $size, $shape, $wddx_size\n";
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
blue, large, sphere, medium
|
|
]]>
|
|
</screen>
|
|
<para>
|
|
A variável <varname>$size</varname> não foi sobrescrita porque foi especificada a opção
|
|
<constant>EXTR_PREFIX_SAME</constant>, o que resultou na criação da variável
|
|
<varname>$wddx_size</varname>. Se <constant>EXTR_SKIP</constant> fosse
|
|
utilizada, então <varname>$wddx_size</varname> não seria criada.
|
|
<constant>EXTR_OVERWRITE</constant> teria feito com que
|
|
<varname>$size</varname> tivesse o valor "medium", e
|
|
<constant>EXTR_PREFIX_ALL</constant> resultaria em novas variáveis
|
|
com os nomes <varname>$wddx_color</varname>, <varname>$wddx_size</varname> e
|
|
<varname>$wddx_shape</varname>.
|
|
</para>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<warning>
|
|
<para>
|
|
Não use <function>extract</function> em dados não confiáveis, como
|
|
entrada de usuário
|
|
(por exemplo, <varname>$_GET</varname>, <varname>$_FILES</varname>, etc.).
|
|
Se usar, certifique-se de que está usando um dos valores de
|
|
<parameter>flags</parameter> que não fazem sobrescrita como
|
|
<constant>EXTR_SKIP</constant> e tenha cuidado para que extraia
|
|
na mesma ordem que é definida em
|
|
<link linkend="ini.variables-order">variables_order</link> no
|
|
<link linkend="ini">&php.ini;</link>.
|
|
</para>
|
|
</warning>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>compact</function></member>
|
|
<member><function>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:"~/.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
|
|
-->
|