1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 328311 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.rename">
<refnamediv>
<refname>rename</refname>
<refpurpose>Renames a file or directory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>rename</methodname>
<methodparam><type>string</type><parameter>oldname</parameter></methodparam>
<methodparam><type>string</type><parameter>newname</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to rename <parameter>oldname</parameter> to
<parameter>newname</parameter>, moving it between directories if necessary.
If <parameter>newname</parameter> exists, it will be overwritten.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>oldname</parameter></term>
<listitem>
<para>
</para>
<note>
<para>
The old name. The wrapper used in <parameter>oldname</parameter>
<emphasis>must</emphasis> match the wrapper used in
<parameter>newname</parameter>.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newname</parameter></term>
<listitem>
<para>
The new name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
¬e.context-support;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.3.1</entry>
<entry>
<function>rename</function> can now rename files across drives in
Windows.
</entry>
</row>
<row>
<entry>5.0.0</entry>
<entry>
<function>rename</function> can now also be used with
<emphasis>some</emphasis> URL wrappers. Refer to <xref
linkend="wrappers"/> for a listing of which wrappers
support <function>rename</function>.
</entry>
</row>
<row>
<entry>4.3.3</entry>
<entry>
<function>rename</function> may now be able to rename files across
partitions on *nix based systems, provided the appropriate permissions
are held. Warnings may be generated if the destination filesystem
doesn't permit <literal>chown()</literal> or
<literal>chmod()</literal> system calls to be made on files —
for example, if the destination filesystem is a FAT filesystem.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example with <function>rename</function></title>
<programlisting role="php">
<![CDATA[
<?php
rename("/tmp/tmp_file.txt", "/home/user/login/docs/my_file.txt");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>copy</function></member>
<member><function>unlink</function></member>
<member><function>move_uploaded_file</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
-->
|
