Corrected information order in func descriptions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@61636 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Leszek Krupinski 2001-11-06 14:46:55 +00:00
parent 45208d092a
commit ebc5b9420e

View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.21 $ -->
<!-- $Revision: 1.22 $ -->
<reference id="ref.ftp">
<title>FTP functions</title>
<titleabbrev>FTP</titleabbrev>
@ -101,10 +101,10 @@ ftp_quit($conn_id);
<paramdef>string <parameter>password</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<para>
Logs in the given FTP stream.</para>
<para>
Returns &true; on success, &false; on error.</para>
</refsect1>
</refentry>
@ -139,10 +139,10 @@ ftp_quit($conn_id);
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<para>
Changes to the parent directory.</para>
<para>
Returns &true; on success, &false; on error.</para>
</refsect1>
</refentry>
@ -160,10 +160,10 @@ ftp_quit($conn_id);
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<para>
Changes to the specified <parameter>directory</parameter>.</para>
<para>
Returns &true; on success, &false; on error.</para>
</refsect1>
</refentry>
@ -181,10 +181,10 @@ ftp_quit($conn_id);
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the newly created directory name on success, &false; on error.</para>
<para>
Creates the specified <parameter>directory</parameter>.</para>
<para>
Returns the newly created directory name on success, &false; on error.</para>
</refsect1>
</refentry>
@ -202,10 +202,10 @@ ftp_quit($conn_id);
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<para>
Removes the specified <parameter>directory</parameter>.</para>
<para>
Returns &true; on success, &false; on error.</para>
</refsect1>
</refentry>
@ -287,14 +287,14 @@ ftp_quit($conn_id);
<paramdef>int <parameter>pasv</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<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>
@ -314,8 +314,6 @@ ftp_quit($conn_id);
<paramdef>int <parameter>mode</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<para>
<function>ftp_get</function> retrieves <parameter>remote_file</parameter>
from the FTP server, and saves it to <parameter>local_file</parameter>
@ -323,6 +321,8 @@ ftp_quit($conn_id);
be either <constant>FTP_ASCII</constant> or
<constant>FTP_BINARY</constant>.
</para>
<para>
Returns &true; on success, &false; on error.</para>
</refsect1>
</refentry>
@ -343,13 +343,13 @@ ftp_quit($conn_id);
<paramdef>int <parameter>mode</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<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 FTP_ASCII or FTP_BINARY.</para>
<para>
Returns &true; on success, &false; on error.</para>
</refsect1>
</refentry>
@ -369,14 +369,14 @@ ftp_quit($conn_id);
<paramdef>int <parameter>mode</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<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>
@ -404,8 +404,6 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<paramdef>int <parameter>mode</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<para>
<function>ftp_fput</function> uploads the data from the file pointer
<parameter>fp</parameter> until end of file. The results are stored
@ -413,6 +411,8 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<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>
@ -430,12 +430,12 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<paramdef>string <parameter>remote_file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the file size on success, or -1 on error.</para>
<para>
<function>ftp_size</function> returns the size of a file. 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>
@ -453,14 +453,14 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<paramdef>string <parameter>remote_file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns a UNIX timestamp on success, or -1 on error.</para>
<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.
@ -484,14 +484,14 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<paramdef>string <parameter>to</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.
</para>
<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.
</refsect1>
</refentry>
@ -509,12 +509,12 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<paramdef>string <parameter>path</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<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>
@ -532,14 +532,14 @@ $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII);
<paramdef>string <parameter>cmd</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns &true; on success, &false; on error.</para>
<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>