mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 17:08:54 +00:00
7839d91186
removing the others git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78562 c90b9560-bf6c-de11-be94-00142212c4b1
783 lines
26 KiB
XML
783 lines
26 KiB
XML
<!-- D O N O T E D I T T H I S F I L E ! ! !
|
|
|
|
it is still here for historical reasons only
|
|
(as translators may need to check old revision diffs)
|
|
|
|
if you want to change things documented in this file
|
|
you should now edit the files found under en/reference
|
|
instead -->
|
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.47 $ -->
|
|
<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>
|
|
|
|
<refentry id="function.ftp-connect">
|
|
<refnamediv>
|
|
<refname>ftp_connect</refname>
|
|
<refpurpose>Opens up an FTP connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>ftp_connect</methodname>
|
|
<methodparam><type>string</type><parameter>host</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns a FTP stream on success, &false; on error.
|
|
</para>
|
|
<para>
|
|
<function>ftp_connect</function> opens up a FTP connection to the
|
|
specified <parameter>host</parameter>. The <parameter>port</parameter>
|
|
parameter specifies an alternate port to connect to. If it is
|
|
omitted or zero, then the default FTP port, 21, will be used.
|
|
</para>
|
|
<para>
|
|
The <parameter>timeout</parameter> parameter specifies the timeout for all
|
|
subsequent network operations. If omitted, the default value is 90
|
|
seconds. The timeout can be changed and queried anytime with
|
|
<function>ftp_set_option</function> and
|
|
<function>ftp_get_option</function>.
|
|
<note>
|
|
<para>
|
|
This parameter is only available in CVS.
|
|
</para>
|
|
</note>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-login">
|
|
<refnamediv>
|
|
<refname>ftp_login</refname>
|
|
<refpurpose>Logs in an FTP connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_login</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>username</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>password</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Logs in the given FTP stream.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-pwd">
|
|
<refnamediv>
|
|
<refname>ftp_pwd</refname>
|
|
<refpurpose>Returns the current directory name</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ftp_pwd</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the current directory, or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-cdup">
|
|
<refnamediv>
|
|
<refname>ftp_cdup</refname>
|
|
<refpurpose>Changes to the parent directory</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_cdup</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Changes to the parent directory.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-chdir">
|
|
<refnamediv>
|
|
<refname>ftp_chdir</refname>
|
|
<refpurpose>Changes directories on a FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_chdir</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Changes to the specified <parameter>directory</parameter>.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-mkdir">
|
|
<refnamediv>
|
|
<refname>ftp_mkdir</refname>
|
|
<refpurpose>Creates a directory</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ftp_mkdir</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Creates the specified <parameter>directory</parameter>.
|
|
</para>
|
|
<para>
|
|
Returns the newly created directory name on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-rmdir">
|
|
<refnamediv>
|
|
<refname>ftp_rmdir</refname>
|
|
<refpurpose>Removes a directory</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_rmdir</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Removes the specified <parameter>directory</parameter>.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-nlist">
|
|
<refnamediv>
|
|
<refname>ftp_nlist</refname>
|
|
<refpurpose>Returns a list of files in the given directory</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>ftp_nlist</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns an array of filenames from the specified directory
|
|
on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-rawlist">
|
|
<refnamediv>
|
|
<refname>ftp_rawlist</refname>
|
|
<refpurpose>Returns a detailed list of files in the given directory</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>ftp_rawlist</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_rawlist</function> executes the FTP LIST command,
|
|
and returns the result as an array. Each array element corresponds
|
|
to one line of text. The output is not parsed in any way. The
|
|
system type identifier returned by <function>ftp_systype</function>
|
|
can be used to determine how the results should be interpreted.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-systype">
|
|
<refnamediv>
|
|
<refname>ftp_systype</refname>
|
|
<refpurpose>Returns the system type identifier of the remote FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ftp_systype</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the remote system type, or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-pasv">
|
|
<refnamediv>
|
|
<refname>ftp_pasv</refname>
|
|
<refpurpose>Turns passive mode on or off</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_pasv</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>bool</type><parameter>pasv</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_pasv</function> turns on passive mode if the
|
|
<parameter>pasv</parameter> parameter is &true; (it turns off
|
|
passive mode if <parameter>pasv</parameter> is &false;.) In
|
|
passive mode, data connections are initiated by the client,
|
|
rather than by the server.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-get">
|
|
<refnamediv>
|
|
<refname>ftp_get</refname>
|
|
<refpurpose>Downloads a file from the FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_get</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>local_file</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_get</function> retrieves <parameter>remote_file</parameter>
|
|
from the FTP server, and saves it to <parameter>local_file</parameter>
|
|
locally. The transfer <parameter>mode</parameter> specified must
|
|
be either <constant>FTP_ASCII</constant> or
|
|
<constant>FTP_BINARY</constant>.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
<para>
|
|
See also <function>ftp_fget</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-fget">
|
|
<refnamediv>
|
|
<refname>ftp_fget</refname>
|
|
<refpurpose>Downloads a file from the FTP server and saves to an open file</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_fget</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_fget</function> retrieves <parameter>remote_file</parameter>
|
|
from the FTP server, and writes it to the given file pointer,
|
|
<parameter>fp</parameter>. The transfer <parameter>mode</parameter>
|
|
specified must be either <constant>FTP_ASCII</constant> or
|
|
<constant>FTP_BINARY</constant>.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-put">
|
|
<refnamediv>
|
|
<refname>ftp_put</refname>
|
|
<refpurpose>Uploads a file to the FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_put</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>local_file</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_put</function> stores <parameter>local_file</parameter>
|
|
on the FTP server, as <parameter>remote_file</parameter>. The transfer
|
|
<parameter>mode</parameter> specified must be either
|
|
<constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>ftp_put</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_ASCII);
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-fput">
|
|
<refnamediv>
|
|
<refname>ftp_fput</refname>
|
|
<refpurpose>Uploads from an open file to the FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_fput</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
|
|
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_fput</function> uploads the data from the file pointer
|
|
<parameter>fp</parameter> until end of file. The results are stored
|
|
in <parameter>remote_file</parameter> on the FTP server. The transfer
|
|
<parameter>mode</parameter> specified must be either
|
|
<constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-size">
|
|
<refnamediv>
|
|
<refname>ftp_size</refname>
|
|
<refpurpose>Returns the size of the given file</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>ftp_size</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_size</function> returns the size of a file in bytes. If an
|
|
error occurs, of if the file does not exist, -1 is returned. Not
|
|
all servers support this feature.
|
|
</para>
|
|
<para>
|
|
Returns the file size on success, or -1 on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-mdtm">
|
|
<refnamediv>
|
|
<refname>ftp_mdtm</refname>
|
|
<refpurpose>Returns the last modified time of the given file</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>ftp_mdtm</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_mdtm</function> checks the last-modified time for a
|
|
file, and returns it as a UNIX timestamp. If an error occurs, or
|
|
the file does not exist, -1 is returned. Note that not all servers
|
|
support this feature.
|
|
</para>
|
|
<para>
|
|
Returns a UNIX timestamp on success, or -1 on error.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
<function>ftp_mdtm</function> does not work with directories.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<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
|
|
currently named <parameter>from</parameter> to the new name
|
|
<parameter>to</parameter>, on the FTP stream
|
|
<parameter>ftp_stream</parameter>.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-delete">
|
|
<refnamediv>
|
|
<refname>ftp_delete</refname>
|
|
<refpurpose>Deletes a file on the FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_delete</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_delete</function> deletes the file specified by
|
|
<parameter>path</parameter> from the FTP server.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-site">
|
|
<refnamediv>
|
|
<refname>ftp_site</refname>
|
|
<refpurpose>Sends a SITE command to the server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_site</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>cmd</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_site</function> sends the command specified by
|
|
<parameter>cmd</parameter> to the FTP server. SITE commands
|
|
are not standardized, and vary from server to server. They are
|
|
useful for handling such things as file permissions and group
|
|
membership.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success, &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-close">
|
|
<refnamediv>
|
|
<refname>ftp_close</refname>
|
|
<refpurpose>Closes an FTP connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>ftp_close</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<note>
|
|
<para>
|
|
This function is only available in CVS.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
<function>ftp_close</function> closes <parameter>ftp_stream</parameter>
|
|
and releases the resource. You can't reuse this resource but have to
|
|
create a new one with <function>ftp_connect</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-quit">
|
|
<refnamediv>
|
|
<refname>ftp_quit</refname>
|
|
<refpurpose>Closes an FTP connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>ftp_quit</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_quit</function> is an alias for
|
|
<function>ftp_close</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id='function.ftp-exec'>
|
|
<refnamediv>
|
|
<refname>ftp_exec</refname>
|
|
<refpurpose>Request execution of a program on the FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_exec</methodname>
|
|
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>command</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sends a SITE EXEC <parameter>command</parameter> request to the FTP
|
|
server. Returns &false; if the request fails, returns the output of the
|
|
command otherwise.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id='function.ftp-set-option'>
|
|
<refnamediv>
|
|
<refname>ftp_set_option</refname>
|
|
<refpurpose>Set miscellaneous runtime FTP options</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_set_option</methodname>
|
|
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>option</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<note>
|
|
<para>
|
|
This function is only available in CVS.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
Returns &true; if the option could be set; &false; if not. A warning
|
|
message will be thrown if the <parameter>option</parameter> is not
|
|
supported or the passed <parameter>value</parameter> doesn't match the
|
|
expected value for the given <parameter>option</parameter>.
|
|
</para>
|
|
<para>
|
|
This function controls various runtime options for the specified FTP
|
|
stream. The <parameter>value</parameter> parameter depends on which
|
|
<parameter>option</parameter> parameter is chosen to be altered.
|
|
Currently, the following options are supported:
|
|
<table>
|
|
<title>Supported runtime FTP options</title>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry>FTP_TIMEOUT_SEC</entry>
|
|
<entry>Changes the timeout in seconds used for all network related
|
|
functions. Parameter <parameter>value</parameter> has be to of type
|
|
int and must be greater than 0. The default timeout is 90
|
|
seconds.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>ftp_set_option</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
// Set the network timeout down to 10 seconds
|
|
ftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10);
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id='function.ftp-get-option'>
|
|
<refnamediv>
|
|
<refname>ftp_get_option</refname>
|
|
<refpurpose>Retrieves various runtime behaviours of the current FTP stream</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>ftp_get_option</methodname>
|
|
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>option</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<note>
|
|
<para>
|
|
This function is only available in CVS.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
Returns the value on success, or &false; if the given
|
|
<parameter>option</parameter> is not supported. In the latter case, a
|
|
warning message is also thrown.
|
|
</para>
|
|
<para>
|
|
This function returns the value for the requested
|
|
<parameter>option</parameter> from the specified <parameter>stream
|
|
</parameter>. Currently, the following options are supported:
|
|
<table>
|
|
<title>Supported runtime FTP options</title>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry>FTP_TIMEOUT_SEC</entry>
|
|
<entry>Returns the current timeout used for network related
|
|
operations.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>ftp_get_option</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
// Get the timeout of the given FTP stream
|
|
$timeout = ftp_get_option($conn_id, FTP_TIMEOUT_SEC);
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
</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
|
|
-->
|