1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ftp-set-option" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftp_set_option</refname>
<refpurpose>Set miscellaneous runtime FTP options</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ftp_set_option</methodname>
<methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type class="union"><type>int</type><type>bool</type></type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
This function controls various runtime options for the specified FTP connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ftp</parameter></term>
<listitem>
&ftp.parameter.ftp;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
Currently, the following options are supported:
<table>
<title>Supported runtime FTP options</title>
<tgroup cols="2">
<tbody>
<row>
<entry><constant>FTP_TIMEOUT_SEC</constant></entry>
<entry>
Changes the timeout in seconds used for all network related
functions. <parameter>value</parameter> must be an integer that
is greater than 0. The default timeout is 90 seconds.
</entry>
</row>
<row>
<entry><constant>FTP_AUTOSEEK</constant></entry>
<entry>
When enabled, GET or PUT requests with a
<parameter>resumepos</parameter> or <parameter>startpos</parameter>
parameter will first seek to the requested position within the file.
This is enabled by default.
</entry>
</row>
<row>
<entry><constant>FTP_USEPASVADDRESS</constant></entry>
<entry>
When disabled, PHP will ignore the IP address returned by the FTP server in response to the PASV command and instead use the IP address that was supplied in the ftp_connect().
<parameter>value</parameter> must be a boolean.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
This parameter depends on which <parameter>option</parameter> is chosen
to be altered.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<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>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&ftp.changelog.ftp-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ftp_set_option</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Set the network timeout to 10 seconds
ftp_set_option($ftp, FTP_TIMEOUT_SEC, 10);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ftp_get_option</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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:"~/.phpdoc/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=sgml
vi: ts=1 sw=1
-->
|
