Source of: /manual/en/function.ftp-nb-fput.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ftp.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ftp-nb-fput.php',
1 => 'ftp_nb_fput',
),
'up' =>
array (
0 => 'ref.ftp.php',
1 => 'FTP Functions',
),
'prev' =>
array (
0 => 'function.ftp-nb-fget.php',
1 => 'ftp_nb_fget',
),
'next' =>
array (
0 => 'function.ftp-nb-get.php',
1 => 'ftp_nb_get',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ftp-nb-fput" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_nb_fput</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_nb_fput</span> — <span class="dc-title">Stores a file from an open file to the FTP server (non-blocking)</span></p>
</div>
<a name="function.ftp-nb-fput.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>ftp_nb_fput</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$ftp_stream</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$remote_file</tt></span>
, <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$handle</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$startpos</tt><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
<b>ftp_nb_fput()</b> uploads the data from a file pointer to
a remote file on the FTP server.
</p>
<p class="para">
The difference between this function and the <a href="function.ftp-fput.php" class="function">ftp_fput()</a>
is that this function uploads the file asynchronously, so your program can
perform other operations while the file is being uploaded.
</p>
</div>
<a name="function.ftp-nb-fput.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">ftp_stream</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">remote_file</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The remote file path.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">handle</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
An open file pointer on the local file. Reading stops at end of file.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">mode</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The transfer mode. Must be either <b><tt class="constant">FTP_ASCII</tt></b> or
<b><tt class="constant">FTP_BINARY</tt></b>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">startpos</tt></i>
</span>
</dt><dd class="listitem">
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ftp-nb-fput.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">FTP_FAILED</tt></b> or <b><tt class="constant">FTP_FINISHED</tt></b>
or <b><tt class="constant">FTP_MOREDATA</tt></b>.
</p>
</div>
<a name="function.ftp-nb-fput.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>ftp_nb_fput()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$file </span><span style="color: #007700">= </span><span style="color: #DD0000">'index.php'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$conn_id </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$ftp_server</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$login_result </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_login</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_name</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_pass</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Initate the upload<br /></span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_fput</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">== </span><span style="color: #0000BB">FTP_MOREDATA</span><span style="color: #007700">) {<br /><br /> </span><span style="color: #FF8000">// Do whatever you want<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">"."</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000">// Continue upload...<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_continue</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">);<br />}<br />if (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">!= </span><span style="color: #0000BB">FTP_FINISHED</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"There was an error uploading the file..."</span><span style="color: #007700">;<br /> exit(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.ftp-nb-fput.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.ftp-nb-put.php" class="function" rel="rdfs-seeAlso">ftp_nb_put()</a> - Stores a file on the FTP server (non-blocking)</li>
<li class="member"><a href="function.ftp-nb-continue.php" class="function" rel="rdfs-seeAlso">ftp_nb_continue()</a> - Continues retrieving/sending a file (non-blocking)</li>
<li class="member"><a href="function.ftp-put.php" class="function" rel="rdfs-seeAlso">ftp_put()</a> - Uploads a file to the FTP server</li>
<li class="member"><a href="function.ftp-fput.php" class="function" rel="rdfs-seeAlso">ftp_fput()</a> - Uploads from an open file to the FTP server</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
