reference/ftp/functions/ftp-fput.xml
4d1c34c9b7a30cfc3a59641122c707a2812cfed7
...
...
@@ -9,11 +9,11 @@
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
11
<type>bool</type><methodname>ftp_fput</methodname>
12
-
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
13
-
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
14
-
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
15
-
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
16
-
<methodparam choice="opt"><type>int</type><parameter>startpos</parameter><initializer>0</initializer></methodparam>
12
+
<methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>remote_filename</parameter></methodparam>
14
+
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
15
+
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>FTP_BINARY</constant></initializer></methodparam>
16
+
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
<function>ftp_fput</function> uploads the data from a file pointer
...
...
@@ -25,15 +25,13 @@
25
25
<para>
26
26
<variablelist>
27
27
<varlistentry>
28
-
<term><parameter>ftp_stream</parameter></term>
28
+
<term><parameter>ftp</parameter></term>
29
29
<listitem>
30
-
<para>
31
-
The link identifier of the FTP connection.
32
-
</para>
30
+
&ftp.parameter.ftp;
33
31
</listitem>
34
32
</varlistentry>
35
33
<varlistentry>
36
-
<term><parameter>remote_file</parameter></term>
34
+
<term><parameter>remote_filename</parameter></term>
37
35
<listitem>
38
36
<para>
39
37
The remote file path.
...
...
@@ -41,7 +39,7 @@
41
39
</listitem>
42
40
</varlistentry>
43
41
<varlistentry>
44
-
<term><parameter>handle</parameter></term>
42
+
<term><parameter>stream</parameter></term>
45
43
<listitem>
46
44
<para>
47
45
An open file pointer on the local file. Reading stops at end of file.
...
...
@@ -58,7 +56,7 @@
58
56
</listitem>
59
57
</varlistentry>
60
58
<varlistentry>
61
-
<term><parameter>startpos</parameter></term>
59
+
<term><parameter>offset</parameter></term>
62
60
<listitem>
63
61
<para>The position in the remote file to start uploading to.</para>
64
62
</listitem>
...
...
@@ -72,6 +70,31 @@
72
70
&return.success;
73
71
</para>
74
72
</refsect1>
73
+

74
+
<refsect1 role="changelog">
75
+
&reftitle.changelog;
76
+
<informaltable>
77
+
<tgroup cols="2">
78
+
<thead>
79
+
<row>
80
+
<entry>&Version;</entry>
81
+
<entry>&Description;</entry>
82
+
</row>
83
+
</thead>
84
+
<tbody>
85
+
&ftp.changelog.ftp-param;
86
+
<row>
87
+
<entry>7.3.0</entry>
88
+
<entry>
89
+
The <parameter>mode</parameter> parameter is now optional. Formerly it
90
+
has been mandatory.
91
+
</entry>
92
+
</row>
93
+
</tbody>
94
+
</tgroup>
95
+
</informaltable>
96
+
</refsect1>
97
+

75
98
<refsect1 role="examples">
76
99
&reftitle.examples;
77
100
<para>
...
...
@@ -86,20 +109,20 @@ $file = 'somefile.txt';
86
109
$fp = fopen($file, 'r');
87
110

88
111
// set up basic connection
89
-
$conn_id = ftp_connect($ftp_server);
112
+
$ftp = ftp_connect($ftp_server);
90
113

91
114
// login with username and password
92
-
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
115
+
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);
93
116

94
117
// try to upload $file
95
-
if (ftp_fput($conn_id, $file, $fp, FTP_ASCII)) {
118
+
if (ftp_fput($ftp, $file, $fp, FTP_ASCII)) {
96
119
echo "Successfully uploaded $file\n";
97
120
} else {
98
121
echo "There was a problem while uploading $file\n";
99
122
}
100
123

101
124
// close the connection and the file handler
102
-
ftp_close($conn_id);
125
+
ftp_close($ftp);
103
126
fclose($fp);
104
127

105
128
?>
...
...
@@ -108,29 +131,6 @@ fclose($fp);
108
131
</example>
109
132
</para>
110
133
</refsect1>
111
-
<refsect1 role="changelog">
112
-
&reftitle.changelog;
113
-
<para>
114
-
<informaltable>
115
-
<tgroup cols="2">
116
-
<thead>
117
-
<row>
118
-
<entry>&Version;</entry>
119
-
<entry>&Description;</entry>
120
-
</row>
121
-
</thead>
122
-
<tbody>
123
-
<row>
124
-
<entry>4.3.0</entry>
125
-
<entry>
126
-
<parameter>startpos</parameter> was added.
127
-
</entry>
128
-
</row>
129
-
</tbody>
130
-
</tgroup>
131
-
</informaltable>
132
-
</para>
133
-
</refsect1>
134
134
<refsect1 role="seealso">
135
135
&reftitle.seealso;
136
136
<para>
...
...
@@ -142,7 +142,6 @@ fclose($fp);
142
142
</para>
143
143
</refsect1>
144
144
</refentry>
145
-

146
145
<!-- Keep this comment at the end of the file
147
146
Local variables:
148
147
mode: sgml
149
148