<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>FTP context option listing</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="context.http.html">HTTP context options</a></div>
<div class="next" style="text-align: right; float: right;"><a href="context.ssl.html">SSL context options</a></div>
<div class="up"><a href="context.html">Context options and parameters</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="context.ftp" class="refentry">
<div class="refnamediv">
<h1 class="refname">FTP context options</h1>
<p class="refpurpose"><span class="refname">FTP context options</span> — <span class="dc-title">FTP context option listing</span></p>
</div>
<div class="refsect1 description" id="refsect1-context.ftp-description">
<h3 class="title">Description</h3>
<p class="para">
Context options for <em>ftp://</em> and <em>ftps://</em>
transports.
</p>
</div>
<div class="refsect1 options" id="refsect1-context.ftp-options">
<h3 class="title">Options</h3>
<p class="para">
<dl>
<dt id="context.ftp.overwrite">
<span class="term">
<em><code class="parameter">overwrite</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Allow overwriting of already existing files on remote server.
Applies to write mode (uploading) only.
</p>
<p class="para">
Defaults to <strong><code>FALSE</code></strong>.
</p>
</dd>
</dt>
<dt id="context.ftp.resume-pos">
<span class="term">
<em><code class="parameter">resume_pos</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
File offset at which to begin transfer. Applies to read mode (downloading) only.
</p>
<p class="para">
Defaults to <em>0</em> (Beginning of File).
</p>
</dd>
</dt>
<dt id="context.ftp.proxy">
<span class="term">
<em><code class="parameter">proxy</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
Proxy FTP request via http proxy server. Applies to file read
operations only. Ex: <em>tcp://squid.example.com:8000</em>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-context.ftp-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.1.0</td>
<td>
Added <em><code class="parameter">proxy</code></em>.
</td>
</tr>
<tr>
<td>5.0.0</td>
<td>
Added <em><code class="parameter">overwrite</code></em> and <em><code class="parameter">resume_pos</code></em>.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 notes" id="refsect1-context.ftp-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<strong>Underlying socket stream context options</strong><br />
<span class="simpara">
Additional context options may be supported by the
<a href="transports.inet.html" class="link">underlying transport</a>
For <em>ftp://</em> streams, refer to context
options for the <em>tcp://</em> transport. For
<em>ftps://</em> streams, refer to context options
for the <em>ssl://</em> transport.
</span>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-context.ftp-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="wrappers.ftp.html" class="xref">ftp://</a></li>
<li class="member"><a href="context.socket.html" class="xref">Socket context options</a></li>
<li class="member"><a href="context.ssl.html" class="xref">SSL context options</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="context.http.html">HTTP context options</a></div>
<div class="next" style="text-align: right; float: right;"><a href="context.ssl.html">SSL context options</a></div>
<div class="up"><a href="context.html">Context options and parameters</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
