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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
 <reference id="ref.ftp">
  <title>FTP functions</title>
  <titleabbrev>FTP</titleabbrev>

  <partintro>
   <para>
    The functions in this extension implement client access to file
    servers speaking the File Transfer Protocol FTP as defined in 
    <ulink url="&spec.ftp;">&spec.ftp;</ulink>.
   </para>

  <section id="ftp.requirements">
   <title>Requirements</title>
   <para>
    The FTP-extension has no special requirements. It's completely contained
    in PHP.
   </para>
  </section>

  <section id="ftp.installation">
   <title>Installation</title>
   <para>
    In order to use FTP functions with your PHP configuration, you should
    add the <link linkend="install.configure.enable-ftp">
    <option role="configure">--enable-ftp</option></link> option when
    installing PHP 4, and <link linkend="install.configure.with-ftp">
    <option role="configure">--with-ftp</option></link> when using PHP 3.
   </para>
  </section>

  <section id="ftp.configuration">
   <title>Configuration</title>
   &no.config;
  </section>

  <section id="ftp.resources">
   <title>Resource types</title>
   <para>
    This extension uses one resource-type, which is the link-identifier
    of the ftp-connection.
   </para>
  </section>

  <section id="ftp.constants">
   <title>Constants</title>
   <para>
    The following constants are defined when using the FTP module:
    <constant>FTP_ASCII</constant> and <constant>FTP_BINARY</constant>.
   </para>
  </section>
  
  <section id="ftp.examples">
   <title>Example</title>
   <para>
    <example>
     <title>FTP example</title>
     <programlisting role="php">
<![CDATA[
<?php
// 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); 

// check connection
if ((!$conn_id) || (!$login_result)) { 
        echo "FTP connection has failed!";
        echo "Attempted to connect to $ftp_server for user $ftp_user_name"; 
        die; 
    } else {
        echo "Connected to $ftp_server, for user $ftp_user_name";
    }

// upload the file
$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_BINARY); 

// check upload status
if (!$upload) { 
        echo "FTP upload has failed!";
    } else {
        echo "Uploaded $source_file to $ftp_server as $destination_file";
    }

// close the FTP stream 
ftp_close($conn_id); 
?>
]]>
      </programlisting>
     </example>
    </para>
   </section>
  </partintro>

&reference.ftp.functions;

 </reference>
<!-- 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=xml
vi: ts=1 sw=1
-->