<!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>Renames a file or directory</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="streamwrapper.mkdir.html">streamWrapper::mkdir</a></div>
<div class="next" style="text-align: right; float: right;"><a href="streamwrapper.rmdir.html">streamWrapper::rmdir</a></div>
<div class="up"><a href="class.streamwrapper.html">streamWrapper</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="streamwrapper.rename" class="refentry">
<div class="refnamediv">
<h1 class="refname">streamWrapper::rename</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">streamWrapper::rename</span> — <span class="dc-title">Renames a file or directory</span></p>
</div>
<div class="refsect1 description" id="refsect1-streamwrapper.rename-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>streamWrapper::rename</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path_from</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$path_to</code></span>
)</div>
<p class="para rdfs-comment">
This method is called in response to <span class="function"><a href="function.rename.html" class="function">rename()</a></span>.
</p>
<p class="para">
Should attempt to rename <em><code class="parameter">path_from</code></em> to
<em><code class="parameter">path_to</code></em>
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
In order for the appropriate error message to be returned this method
should <em class="emphasis">not</em> be defined if the wrapper does not support
renaming files.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-streamwrapper.rename-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">path_from</code></em></span>
<dd>
<p class="para">
The URL to the current file.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">path_to</code></em></span>
<dd>
<p class="para">
The URL which the <em><code class="parameter">path_from</code></em> should be renamed to.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-streamwrapper.rename-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-streamwrapper.rename-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Emits
<strong><code>E_WARNING</code></strong> if call to this method fails
(i.e. not implemented).</p>
</div>
<div class="refsect1 notes" id="refsect1-streamwrapper.rename-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">The
<var class="varname"><var class="varname">streamWrapper::$context</var></var>
property is updated if a valid context is passed to the caller function.</p></p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-streamwrapper.rename-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.rename.html" class="function" rel="rdfs-seeAlso">rename()</a> - Renames a file or directory</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="streamwrapper.mkdir.html">streamWrapper::mkdir</a></div>
<div class="next" style="text-align: right; float: right;"><a href="streamwrapper.rmdir.html">streamWrapper::rmdir</a></div>
<div class="up"><a href="class.streamwrapper.html">streamWrapper</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
