reference/ftp/functions/ftp-get-option.xml
4d1c34c9b7a30cfc3a59641122c707a2812cfed7
...
...
@@ -1,15 +1,15 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xml:id='function.ftp-get-option' xmlns="http://docbook.org/ns/docbook">
3
+
<refentry xml:id="function.ftp-get-option" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>ftp_get_option</refname>
6
-
<refpurpose>Retrieves various runtime behaviours of the current FTP stream</refpurpose>
6
+
<refpurpose>Retrieves various runtime behaviours of the current FTP connection</refpurpose>
7
7
</refnamediv>
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>mixed</type><methodname>ftp_get_option</methodname>
12
-
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
11
+
<type class="union"><type>int</type><type>bool</type></type><methodname>ftp_get_option</methodname>
12
+
<methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
13
13
<methodparam><type>int</type><parameter>option</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
...
...
@@ -22,11 +22,9 @@
22
22
<para>
23
23
<variablelist>
24
24
<varlistentry>
25
-
<term><parameter>ftp_stream</parameter></term>
25
+
<term><parameter>ftp</parameter></term>
26
26
<listitem>
27
-
<para>
28
-
The link identifier of the FTP connection.
29
-
</para>
27
+
&ftp.parameter.ftp;
30
28
</listitem>
31
29
</varlistentry>
32
30
<varlistentry>
...
...
@@ -67,6 +65,24 @@
67
65
warning message is also thrown.
68
66
</para>
69
67
</refsect1>
68
+

69
+
<refsect1 role="changelog">
70
+
&reftitle.changelog;
71
+
<informaltable>
72
+
<tgroup cols="2">
73
+
<thead>
74
+
<row>
75
+
<entry>&Version;</entry>
76
+
<entry>&Description;</entry>
77
+
</row>
78
+
</thead>
79
+
<tbody>
80
+
&ftp.changelog.ftp-param;
81
+
</tbody>
82
+
</tgroup>
83
+
</informaltable>
84
+
</refsect1>
85
+
70
86
<refsect1 role="examples">
71
87
&reftitle.examples;
72
88
<para>
...
...
@@ -75,8 +91,8 @@
75
91
<programlisting role="php">
76
92
<![CDATA[
77
93
<?php
78
-
// Get the timeout of the given FTP stream
79
-
$timeout = ftp_get_option($conn_id, FTP_TIMEOUT_SEC);
94
+
// Get the timeout of the given FTP connection
95
+
$timeout = ftp_get_option($ftp, FTP_TIMEOUT_SEC);
80
96
?>
81
97
]]>
82
98
</programlisting>
...
...
@@ -92,7 +108,6 @@ $timeout = ftp_get_option($conn_id, FTP_TIMEOUT_SEC);
92
108
</para>
93
109
</refsect1>
94
110
</refentry>
95
-

96
111
<!-- Keep this comment at the end of the file
97
112
Local variables:
98
113
mode: sgml
99
114