- Fixed prototypes and removed superfluous quotes in examples.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@66649 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Markus Fischer 2002-01-02 01:07:03 +00:00
parent c9d8e4f46b
commit 9f43ca071d

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.30 $ -->
<!-- $Revision: 1.31 $ -->
<reference id="ref.ftp">
<title>FTP functions</title>
<titleabbrev>FTP</titleabbrev>
@ -29,10 +29,10 @@
<![CDATA[
<?php
// set up basic connection
$conn_id = ftp_connect("$ftp_server");
$conn_id = ftp_connect($ftp_server);
// login with username and password
$login_result = ftp_login($conn_id, "$ftp_user_name", "$ftp_user_pass");
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
// check connection
if ((!$conn_id) || (!$login_result)) {
@ -44,7 +44,7 @@ if ((!$conn_id) || (!$login_result)) {
}
// upload the file
$upload = ftp_put($conn_id, "$destination_file", "$source_file", FTP_BINARY);
$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_BINARY);
// check upload status
if (!$upload) {
@ -71,7 +71,7 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_connect</function></funcdef>
<funcdef>resource <function>ftp_connect</function></funcdef>
<paramdef>string <parameter>host</parameter></paramdef>
<paramdef>int <parameter><optional>port</optional>
</parameter></paramdef>
@ -99,8 +99,8 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_login</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_login</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>username</parameter></paramdef>
<paramdef>string <parameter>password</parameter></paramdef>
</funcprototype>
@ -124,7 +124,7 @@ ftp_quit($conn_id);
<funcsynopsis>
<funcprototype>
<funcdef>string <function>ftp_pwd</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@ -142,8 +142,8 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_cdup</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_cdup</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@ -164,8 +164,8 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_chdir</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_chdir</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -187,7 +187,7 @@ ftp_quit($conn_id);
<funcsynopsis>
<funcprototype>
<funcdef>string <function>ftp_mkdir</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -195,7 +195,8 @@ ftp_quit($conn_id);
Creates the specified <parameter>directory</parameter>.
</para>
<para>
Returns the newly created directory name on success, &false; on error.</para>
Returns the newly created directory name on success, &false; on error.
</para>
</refsect1>
</refentry>
@ -208,8 +209,8 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_rmdir</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_rmdir</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -231,12 +232,13 @@ ftp_quit($conn_id);
<funcsynopsis>
<funcprototype>
<funcdef>array <function>ftp_nlist</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns an array of filenames on success, &false; on error.
Returns an array of filenames from the specified directory
on success, &false; on error.
</para>
</refsect1>
</refentry>
@ -253,7 +255,7 @@ ftp_quit($conn_id);
<funcsynopsis>
<funcprototype>
<funcdef>array <function>ftp_rawlist</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -279,7 +281,7 @@ ftp_quit($conn_id);
<funcsynopsis>
<funcprototype>
<funcdef>string <function>ftp_systype</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@ -297,9 +299,9 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_pasv</function></funcdef>
<funcdef>bool <function>ftp_pasv</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>int <parameter>pasv</parameter></paramdef>
<paramdef>bool <parameter>pasv</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@ -324,8 +326,8 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_get</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_get</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>local_file</parameter></paramdef>
<paramdef>string <parameter>remote_file</parameter></paramdef>
<paramdef>int <parameter>mode</parameter></paramdef>
@ -357,9 +359,9 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_fget</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>int <parameter>fp</parameter></paramdef>
<funcdef>bool <function>ftp_fget</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>resource <parameter>fp</parameter></paramdef>
<paramdef>string <parameter>remote_file</parameter></paramdef>
<paramdef>int <parameter>mode</parameter></paramdef>
</funcprototype>
@ -386,8 +388,8 @@ ftp_quit($conn_id);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_put</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_put</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>remote_file</parameter></paramdef>
<paramdef>string <parameter>local_file</parameter></paramdef>
<paramdef>int <parameter>mode</parameter></paramdef>
@ -407,7 +409,7 @@ ftp_quit($conn_id);
<title><function>ftp_put</function> example</title>
<programlisting role="php">
<![CDATA[
$upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_ASCII);
]]>
</programlisting>
</example>
@ -424,10 +426,10 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_fput</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_fput</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>remote_file</parameter></paramdef>
<paramdef>int <parameter>fp</parameter></paramdef>
<paramdef>resource <parameter>fp</parameter></paramdef>
<paramdef>int <parameter>mode</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -454,7 +456,7 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_size</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>remote_file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -478,7 +480,7 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_mdtm</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>remote_file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -508,7 +510,7 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ftp_rename</function></funcdef>
<funcdef>bool <function>ftp_rename</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>from</parameter></paramdef>
<paramdef>string <parameter>to</parameter></paramdef>
@ -517,7 +519,8 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<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>.
<parameter>to</parameter>, on the FTP stream
<parameter>ftp_stream</parameter>.
</para>
<para>
Returns &true; on success, &false; on error.
@ -534,8 +537,8 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_delete</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_delete</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>path</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -558,8 +561,8 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_site</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>bool <function>ftp_site</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>string <parameter>cmd</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -585,8 +588,8 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_quit</function></funcdef>
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
<funcdef>boid <function>ftp_quit</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@ -599,15 +602,15 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<refnamediv>
<refname>ftp_exec</refname>
<refpurpose>
Request execution of a program on the ftp server */
Request execution of a program on the ftp server.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ftp_exec</function></funcdef>
<paramdef>int <parameter>stream</parameter></paramdef>
<funcdef>bool <function>ftp_exec</function></funcdef>
<paramdef>resource <parameter>stream</parameter></paramdef>
<paramdef>string <parameter>command</parameter></paramdef>
</funcprototype>
</funcsynopsis>