mirror of
https://github.com/php/doc-zh.git
synced 2026-03-24 07:02:15 +01:00
239 lines
8.1 KiB
XML
Executable File
239 lines
8.1 KiB
XML
Executable File
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
<!-- EN-Revision: f53ab502a11a52e82baca372c37d64e3f298b17c Maintainer: HonestQiao Status: ready -->
|
||
<!-- CREDITS: Luffy, mowangjuanzi -->
|
||
<refentry xml:id="function.extract" xmlns="http://docbook.org/ns/docbook">
|
||
<refnamediv>
|
||
<refname>extract</refname>
|
||
<refpurpose>从数组中将变量导入到当前的符号表</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>
|
||
本函数用来将变量从数组中导入到当前的<link linkend="features.gc.refcounting-basics">符号表</link>中。
|
||
</para>
|
||
<para>
|
||
检查每个键名看是否可以作为一个合法的变量名，同时也检查和符号表中已有的变量名的冲突。
|
||
</para>
|
||
<warning>
|
||
<para>
|
||
不要对不可信的数据使用 <function>extract</function>，类似用户输入
|
||
（例如 <varname>$_GET</varname>、<varname>$_FILES</varname>）。
|
||
</para>
|
||
</warning>
|
||
</refsect1>
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>array</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
一个关联数组。此函数会将键名当作变量名，值作为变量的值。
|
||
对每个键／值对都会在当前的符号表中建立变量，并受到
|
||
<parameter>flags</parameter> 和 <parameter>prefix</parameter> 参数的影响。
|
||
</para>
|
||
<para>
|
||
必须使用关联数组，数字索引的数组将不会产生结果，除非用了
|
||
<constant>EXTR_PREFIX_ALL</constant> 或者 <constant>EXTR_PREFIX_INVALID</constant>。
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>flags</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
对待非法／数字和冲突的键名的方法将根据取出标记
|
||
<parameter>flags</parameter> 参数决定。可以是以下值之一：
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><constant>EXTR_OVERWRITE</constant></term>
|
||
<listitem>
|
||
<simpara>
|
||
如果有冲突，覆盖已有的变量。
|
||
</simpara>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><constant>EXTR_SKIP</constant></term>
|
||
<listitem>
|
||
<simpara>
|
||
如果有冲突，不覆盖已有的变量。
|
||
</simpara>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><constant>EXTR_PREFIX_SAME</constant></term>
|
||
<listitem>
|
||
<simpara>如果有冲突，在变量名前加上前缀 <parameter>prefix</parameter>。
|
||
</simpara>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><constant>EXTR_PREFIX_ALL</constant></term>
|
||
<listitem>
|
||
<simpara>
|
||
给所有变量名加上前缀
|
||
<parameter>prefix</parameter>。
|
||
</simpara>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><constant>EXTR_PREFIX_INVALID</constant></term>
|
||
<listitem>
|
||
<simpara>
|
||
仅在非法／数字的变量名前加上前缀 <parameter>prefix</parameter>。
|
||
</simpara>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><constant>EXTR_IF_EXISTS</constant></term>
|
||
<listitem>
|
||
<simpara>
|
||
仅在当前符号表中已有同名变量时，覆盖它们的值。其它的都不处理。
|
||
举个例子，以下情况非常有用：定义一些有效变量，然后从 <varname>$_REQUEST</varname> 中仅导入这些已定义的变量。
|
||
</simpara>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><constant>EXTR_PREFIX_IF_EXISTS</constant></term>
|
||
<listitem>
|
||
<simpara>
|
||
仅在当前符号表中已有同名变量时，建立附加了前缀的变量名，其它的都不处理。
|
||
</simpara>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><constant>EXTR_REFS</constant></term>
|
||
<listitem>
|
||
<simpara>
|
||
将变量作为引用提取。这有力地表明了导入的变量仍然引用了
|
||
<parameter>array</parameter> 参数的值。可以单独使用这个标志或者在
|
||
<parameter>flags</parameter> 中用 OR 与其它任何标志结合使用。
|
||
</simpara>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
<para>
|
||
如果没有指定 <parameter>flags</parameter>，则被假定为 <constant>EXTR_OVERWRITE</constant>。
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>prefix</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
注意 <parameter>prefix</parameter> 仅在
|
||
<parameter>flags</parameter> 的值是
|
||
<constant>EXTR_PREFIX_SAME</constant>，<constant>EXTR_PREFIX_ALL</constant>，<constant>EXTR_PREFIX_INVALID</constant>
|
||
或 <constant>EXTR_PREFIX_IF_EXISTS</constant>
|
||
时需要。
|
||
如果附加了前缀后的结果不是合法的变量名，将不会导入到符号表中。前缀和数组键名之间会自动加上一个下划线。
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
返回成功导入到符号表中的变量数目。
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title><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>
|
||
<varname>$size</varname> 没有被覆盖，因为指定了
|
||
<constant>EXTR_PREFIX_SAME</constant>，这使得 <varname>$wddx_size</varname>
|
||
被建立。如果指定了 <constant>EXTR_SKIP</constant>，则 <varname>$wddx_size</varname>
|
||
也不会被建立。<constant>EXTR_OVERWRITE</constant> 将使 <varname>$size</varname>
|
||
的值为“medium”，<constant>EXTR_PREFIX_ALL</constant> 将建立新变量
|
||
<varname>$wddx_color</varname>，<varname>$wddx_size</varname> 和
|
||
<varname>$wddx_shape</varname>。
|
||
</para>
|
||
</example>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="notes">
|
||
&reftitle.notes;
|
||
<warning>
|
||
<para>
|
||
不要对不能信任的数据使用
|
||
<function>extract</function>，例如用户的输入（<varname>$_GET</varname>、<varname>$_FILES</varname>...）。
|
||
|
||
如果这样做，要确保使用不会覆盖的
|
||
<parameter>flags</parameter> 值，例如
|
||
<constant>EXTR_SKIP</constant>，并且要留意应该按照
|
||
<link linkend="ini.variables-order">variables_order</link>
|
||
在 <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
|
||
-->
|