php-doc-en/reference/ftp/functions/ftp-rename.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
  <refentry id="function.ftp-rename">
   <refnamediv>
    <refname>ftp_rename</refname>
    <refpurpose>Renames a file on the FTP server</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_rename</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>from</parameter></methodparam>
      <methodparam><type>string</type><parameter>to</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_rename</function> renames the file or directory that is
     currently named <parameter>from</parameter> to the new name
     <parameter>to</parameter>, using the FTP stream
     <parameter>ftp_stream</parameter>.
    </para>
    <para>
     <example>
      <title><function>ftp_rename</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
$old_file = 'somefile.txt.bak';
$new_file = 'somefile.txt';

// set up basic connection
$conn_id = ftp_connect($ftp_server);

// login with username and password
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);

// try to rename $olf_file to $new_file
if (ftp_rename($conn_id, $old_file, $new_file)) {
 echo "successfully renamed $old_file to $new_file\n";
} else {
 echo "There was a problem while renaming $old_file to $new_file\n";
}

// close the connection
ftp_close($conn_id);
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     &return.success;
    </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
-->