cvs: phpdoc /en/functions array.xml
| From: | Egon Schmid | Date: | Mon, 08 Jan 2001 21:20:32 +0000 |
| Subject: | cvs: phpdoc /en/functions array.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969333494@lists.php.net to get a copy of this message | ||
eschmid Mon Jan 8 13:20:32 2001 EDT
Modified files:
/phpdoc/en/functions array.xml
Log:
Added a note for the changed return type.
Index: phpdoc/en/functions/array.xml
diff -u phpdoc/en/functions/array.xml:1.48 phpdoc/en/functions/array.xml:1.49
--- phpdoc/en/functions/array.xml:1.48 Sun Jan 7 18:28:28 2001
+++ phpdoc/en/functions/array.xml Mon Jan 8 13:20:31 2001
@@ -1614,7 +1614,7 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>extract</function></funcdef>
+ <funcdef>int <function>extract</function></funcdef>
<paramdef>array <parameter>var_array</parameter></paramdef>
<paramdef>int
<parameter><optional>extract_type</optional></parameter>
@@ -1633,6 +1633,12 @@
<parameter>extract_type</parameter> and
<parameter>prefix</parameter> parameters.
</para>
+ <note>
+ <para>
+ Since version 4.0.5 this function returns the number of
+ variables extracted.
+ </para>
+ </note>
<para>
<function>Extract</function> checks for colissions with existing
variables. The way collisions are treated is determined by
@@ -1642,34 +1648,35 @@
<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 new variable 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 variables with <parameter>prefix</parameter>.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>