reference/ftp/functions/ftp-nb-fput.xml
4d1c34c9b7a30cfc3a59641122c707a2812cfed7
4d1c34c9b7a30cfc3a59641122c707a2812cfed7
...
...
@@ -9,11 +9,11 @@
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
11
<type>int</type><methodname>ftp_nb_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_nb_fput</function> uploads the data from a file pointer to
...
...
@@ -30,15 +30,13 @@
30
30
<para>
31
31
<variablelist>
32
32
<varlistentry>
33
-
<term><parameter>ftp_stream</parameter></term>
33
+
<term><parameter>ftp</parameter></term>
34
34
<listitem>
35
-
<para>
36
-
The link identifier of the FTP connection.
37
-
</para>
35
+
&ftp.parameter.ftp;
38
36
</listitem>
39
37
</varlistentry>
40
38
<varlistentry>
41
-
<term><parameter>remote_file</parameter></term>
39
+
<term><parameter>remote_filename</parameter></term>
42
40
<listitem>
43
41
<para>
44
42
The remote file path.
...
...
@@ -46,7 +44,7 @@
46
44
</listitem>
47
45
</varlistentry>
48
46
<varlistentry>
49
-
<term><parameter>handle</parameter></term>
47
+
<term><parameter>stream</parameter></term>
50
48
<listitem>
51
49
<para>
52
50
An open file pointer on the local file. Reading stops at end of file.
...
...
@@ -63,7 +61,7 @@
63
61
</listitem>
64
62
</varlistentry>
65
63
<varlistentry>
66
-
<term><parameter>startpos</parameter></term>
64
+
<term><parameter>offset</parameter></term>
67
65
<listitem>
68
66
<para>The position in the remote file to start uploading to.</para>
69
67
</listitem>
...
...
@@ -78,6 +76,31 @@
78
76
or <constant>FTP_MOREDATA</constant>.
79
77
</para>
80
78
</refsect1>
79
+
80
+
<refsect1 role="changelog">
81
+
&reftitle.changelog;
82
+
<informaltable>
83
+
<tgroup cols="2">
84
+
<thead>
85
+
<row>
86
+
<entry>&Version;</entry>
87
+
<entry>&Description;</entry>
88
+
</row>
89
+
</thead>
90
+
<tbody>
91
+
&ftp.changelog.ftp-param;
92
+
<row>
93
+
<entry>7.3.0</entry>
94
+
<entry>
95
+
The <parameter>mode</parameter> parameter is now optional. Formerly it
96
+
has been mandatory.
97
+
</entry>
98
+
</row>
99
+
</tbody>
100
+
</tgroup>
101
+
</informaltable>
102
+
</refsect1>
103
+
81
104
<refsect1 role="examples">
82
105
&reftitle.examples;
83
106
<para>
...
...
@@ -91,19 +114,19 @@ $file = 'index.php';
91
114
92
115
$fp = fopen($file, 'r');
93
116
94
-
$conn_id = ftp_connect($ftp_server);
117
+
$ftp = ftp_connect($ftp_server);
95
118
96
-
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
119
+
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);
97
120
98
-
// Initate the upload
99
-
$ret = ftp_nb_fput($conn_id, $file, $fp, FTP_BINARY);
121
+
// Initiate the upload
122
+
$ret = ftp_nb_fput($ftp, $file, $fp, FTP_BINARY);
100
123
while ($ret == FTP_MOREDATA) {
101
124
102
125
// Do whatever you want
103
126
echo ".";
104
127
105
128
// Continue upload...
106
-
$ret = ftp_nb_continue($conn_id);
129
+
$ret = ftp_nb_continue($ftp);
107
130
}
108
131
if ($ret != FTP_FINISHED) {
109
132
echo "There was an error uploading the file...";
...
...
@@ -129,7 +152,6 @@ fclose($fp);
129
152
</para>
130
153
</refsect1>
131
154
</refentry>
132
-
133
155
<!-- Keep this comment at the end of the file
134
156
Local variables:
135
157
mode: sgml
136
158