cvs: peardoc /en/package/html/html-quickform/html-quickform-file moveuploadedfile.xml
| From: | Alexey Borzov | Date: | Sun, 18 Jun 2006 11:27:19 +0000 |
| Subject: | cvs: peardoc /en/package/html/html-quickform/html-quickform-file moveuploadedfile.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-8047@lists.php.net to get a copy of this message | ||
avb Sun Jun 18 11:27:19 2006 UTC
Modified files:
/peardoc/en/package/html/html-quickform/html-quickform-file
moveuploadedfile.xml
Log:
Document the return value of moveUploadedFile() (bug #7832)
http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml
diff -u peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml:1.1
peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml:1.2
--- peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml:1.1 Sun Oct 26
15:57:38 2003
+++ peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml Sun Jun 18
11:27:19 2006
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="package.html.html-quickform.html-quickform-file.moveuploadedfile">
<refnamediv>
<refname>HTML_QuickForm_file::moveUploadedFile()</refname>
@@ -10,7 +10,7 @@
require_once 'HTML/QuickForm/file.php';
</funcsynopsisinfo>
<funcprototype>
- <funcdef>void
<function>HTML_QuickForm_file::moveUploadedFile</function></funcdef>
+ <funcdef>bool
<function>HTML_QuickForm_file::moveUploadedFile</function></funcdef>
<paramdef>string <parameter>$dest</parameter></paramdef>
<paramdef>string <parameter> <optional>$fileName =
''</optional></parameter></paramdef>
</funcprototype>
@@ -42,20 +42,26 @@
<variablelist>
<varlistentry>
<term>
-
-
- &type.string;
- <parameter>$fileName</parameter>
+ &type.string;
+ <parameter>$fileName</parameter>
</term>
<listitem>
<para>
- New file name
+ New file name (if not given, original file name will be used).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
+
+ <refsect1
id="package.html.html-quickform.html-quickform-file.moveuploadedfile.returns">
+ &title.returns;
+ <para>
+ <emphasis>returns</emphasis> true if file has been moved successfully, false
otherwise.
+ </para>
+ </refsect1>
+
<refsect1
id="package.html.html-quickform.html-quickform-file.moveuploadedfile.throws">
&title.throws;
<para>