reference/filesystem/functions/rename.xml
ea62fb83196997032641b50fe44420305466195e
ea62fb83196997032641b50fe44420305466195e
...
...
@@ -10,16 +10,16 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>rename</methodname>
13
-
<methodparam><type>string</type><parameter>oldname</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>newname</parameter></methodparam>
15
-
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>from</parameter></methodparam>
14
+
<methodparam><type>string</type><parameter>to</parameter></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
-
Attempts to rename <parameter>oldname</parameter> to
19
-
<parameter>newname</parameter>, moving it between directories if necessary.
20
-
If renaming a file and <parameter>newname</parameter> exists,
18
+
Attempts to rename <parameter>from</parameter> to
19
+
<parameter>to</parameter>, moving it between directories if necessary.
20
+
If renaming a file and <parameter>to</parameter> exists,
21
21
it will be overwritten. If renaming a directory and
22
-
<parameter>newname</parameter> exists,
22
+
<parameter>to</parameter> exists,
23
23
this function will emit a warning.
24
24
</para>
25
25
</refsect1>
...
...
@@ -29,28 +29,28 @@
29
29
<para>
30
30
<variablelist>
31
31
<varlistentry>
32
-
<term><parameter>oldname</parameter></term>
32
+
<term><parameter>from</parameter></term>
33
33
<listitem>
34
34
<para>
35
35
The old name.
36
36
</para>
37
37
<note>
38
38
<para>
39
-
The wrapper used in <parameter>oldname</parameter>
39
+
The wrapper used in <parameter>from</parameter>
40
40
<emphasis>must</emphasis> match the wrapper used in
41
-
<parameter>newname</parameter>.
41
+
<parameter>to</parameter>.
42
42
</para>
43
43
</note>
44
44
</listitem>
45
45
</varlistentry>
46
46
<varlistentry>
47
-
<term><parameter>newname</parameter></term>
47
+
<term><parameter>to</parameter></term>
48
48
<listitem>
49
49
<para>
50
50
The new name.
51
51
<note>
52
52
<simpara>
53
-
On Windows, if <parameter>newname</parameter> already exists, it must be writable.
53
+
On Windows, if <parameter>to</parameter> already exists, it must be writable.
54
54
Otherwise <function>rename</function> fails and issues <constant>E_WARNING</constant>.
55
55
</simpara>
56
56
</note>
57
57