andrei Mon Jan 22 09:44:34 2001 EDT
Modified files:
/phpdoc/en/functions array.xml
Log:
Add docs about new functionality of extract().
Index: phpdoc/en/functions/array.xml
diff -u phpdoc/en/functions/array.xml:1.49 phpdoc/en/functions/array.xml:1.50
--- phpdoc/en/functions/array.xml:1.49 Mon Jan 8 13:20:31 2001
+++ phpdoc/en/functions/array.xml Mon Jan 22 09:44:34 2001
@@ -1640,46 +1640,57 @@
</para>
</note>
<para>
- <function>Extract</function> checks for colissions with existing
- variables. The way collisions are treated is determined by
- <parameter>extract_type</parameter>. It can be one of the
+ <function>extract</function> checks each key to see whether if constitutes
+ a valid variable name and also for collisions with existing variables in
+ the symbol table. The way invalid/numeric keys and collisions are treated
+ is determined by <parameter>extract_type</parameter>. It can be one of the
following values:
<variablelist>
<varlistentry>
<term>EXTR_OVERWRITE</term>
<listitem>
- <simpara>
- If there is a collision, overwrite the existing variable.
- </simpara>
+ <simpara>
+ If there is a collision, overwrite the existing variable.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>EXTR_SKIP</term>
<listitem>
- <simpara>
- If there is a collision, don't overwrite the existing
- variable.
- </simpara>
+ <simpara>
+ If there is a collision, don't overwrite the existing
+ variable.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>EXTR_PREFIX_SAME</term>
<listitem>
- <simpara>
- If there is a collision, prefix the new variable with
- <parameter>prefix</parameter>.
- </simpara>
+ <simpara>If there is a collision, prefix the variable name with
+ <parameter>prefix</parameter>.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>EXTR_PREFIX_ALL</term>
<listitem>
- <simpara>
- Prefix all variables with <parameter>prefix</parameter>.
- </simpara>
+ <simpara>
+ Prefix all variable names with <parameter>prefix</parameter>. Since PHP
+ 4.0.5 this includes numeric ones as well.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
+ <varlistentry>
+ <term>EXTR_PREFIX_INVALID</term>
+ <listitem>
+ <simpara>
+ Only prefix invalid/numeric variable names with
+ <parameter>prefix</parameter>. This flag has been added in PHP 4.0.5.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
<para>
If <parameter>extract_type</parameter> is not specified, it is
@@ -1687,13 +1698,13 @@
</para>
<para>
Note that <parameter>prefix</parameter> is only required if
- <parameter>extract_type</parameter> is EXTR_PREFIX_SAME or
- EXTR_PREFIX_ALL.
+ <parameter>extract_type</parameter> is EXTR_PREFIX_SAME, EXTR_PREFIX_ALL,
+ or EXTR_PREFIX_INVALID. If the prefixed result is not a valid variable
+ name, it is not imported into the symbol table.
</para>
<para>
- <function>Extract</function> checks each key to see if it
- constitues a valid variable name, and if it does only then does
- it proceed to import it.
+ <function>extract</function> returns the number of variables successfully
+ imported into the symbol table.
</para>
<para>
A possible use for extract is to import into symbol table
