mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
6e83b49413
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183271 c90b9560-bf6c-de11-be94-00142212c4b1
83 lines
2.4 KiB
XML
83 lines
2.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.11 $ -->
|
|
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
|
|
<refentry id="function.rename">
|
|
<refnamediv>
|
|
<refname>rename</refname>
|
|
<refpurpose>Renames a file or directory</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<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>.
|
|
</para>
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
<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>
|
|
<note>
|
|
<para>
|
|
Prior to PHP 4.3.3, <function>rename</function> could not rename files
|
|
across partitions on *nix based systems.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<simpara>
|
|
As of PHP 5.0.0 <function>rename</function> can also be
|
|
used with <emphasis>some</emphasis> URL wrappers. Refer to <xref linkend="wrappers"/>
|
|
for a listing of which wrappers support <function>rename</function>.
|
|
</simpara>
|
|
</note>
|
|
<note>
|
|
<simpara>
|
|
The wrapper used in <parameter>oldname</parameter> <emphasis>MUST</emphasis>
|
|
match the wrapper used in <parameter>newname</parameter>.
|
|
</simpara>
|
|
</note>
|
|
¬e.context-support;
|
|
<para>
|
|
See also <function>copy</function>,
|
|
<function>unlink</function>, and
|
|
<function>move_uploaded_file</function>.
|
|
</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:"../../../../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
|
|
-->
|