Source of: /manual/en/function.ftp-alloc.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-alloc.php',
1 => 'ftp_alloc',
),
'up' =>
array (
0 => 'ref.ftp.php',
1 => 'FTP Functions',
),
'prev' =>
array (
0 => 'ref.ftp.php',
1 => 'FTP Functions',
),
'next' =>
array (
0 => 'function.ftp-cdup.php',
1 => 'ftp_cdup',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ftp-alloc" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_alloc</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">ftp_alloc</span> — <span class="dc-title">Allocates space for a file to be uploaded</span></p>
</div>
<a name="function.ftp-alloc.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>ftp_alloc</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$ftp_stream</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$filesize</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter reference">&$result</tt></span>
] )</div>
<p class="para rdfs-comment">
Sends an <i>ALLO</i> command to the remote FTP server to
allocate space for a file to be uploaded.
</p>
<blockquote><p><b class="note">Note</b>:
Many FTP servers do not support this command. These servers may return a failure
code (<b><tt class="constant">FALSE</tt></b>) indicating the command is not supported or a success code (<b><tt class="constant">TRUE</tt></b>)
to indicate that pre-allocation is not necessary and the client should continue
as though the operation were successful. Because of this, it may be best to reserve
this function for servers which explicitly require preallocation.
<br />
</p></blockquote>
<p class="para">
</p>
</div>
<a name="function.ftp-alloc.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">filesize</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The number of bytes to allocate.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">return</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A textual representation of the servers response will be returned by
reference in <i><tt class="parameter">result</tt></i>
if a variable is provided.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ftp-alloc.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.ftp-alloc.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>ftp_alloc()</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">"/home/user/myfile"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// connect to the server<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: #DD0000">'ftp.example.com'</span><span style="color: #007700">);<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: #DD0000">'anonymous'</span><span style="color: #007700">, </span><span style="color: #DD0000">'user@example.com'</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">ftp_alloc</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">filesize</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">), </span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Space successfully allocated on server. Sending </span><span style="color: #0000BB">$file</span><span style="color: #DD0000">.\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">ftp_put</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #DD0000">'/incomming/myfile'</span><span style="color: #007700">, </span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">);<br />} else {<br /> echo </span><span style="color: #DD0000">"Unable to allocate space on server. Server said: </span><span style="color: #0000BB">$result</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">ftp_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.ftp-alloc.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-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(); ?>
