mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
ccb1313e0c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351270 c90b9560-bf6c-de11-be94-00142212c4b1
125 lines
3.2 KiB
XML
125 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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 renaming a file and <parameter>newname</parameter> exists,
|
|
it will be overwritten. If renaming a directory and
|
|
<parameter>newname</parameter> exists,
|
|
this function will emit a warning.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>oldname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The old name.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
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.
|
|
<note>
|
|
<simpara>
|
|
On Windows, if <parameter>newname</parameter> already exists, it must be writable.
|
|
Otherwise <function>rename</function> fails and issues <constant>E_WARNING</constant>.
|
|
</simpara>
|
|
</note>
|
|
</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="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
|
|
-->
|