Source of: /manual/en/function.eio-rename.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.eio.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.eio-rename.php',
1 => 'eio_rename',
),
'up' =>
array (
0 => 'ref.eio.php',
1 => 'Eio Functions',
),
'prev' =>
array (
0 => 'function.eio-realpath.php',
1 => 'eio_realpath',
),
'next' =>
array (
0 => 'function.eio-rmdir.php',
1 => 'eio_rmdir',
),
'alternatives' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.eio-rename" class="refentry">
<div class="refnamediv">
<h1 class="refname">eio_rename</h1>
<p class="verinfo">(PECL eio >= 0.0.1dev)</p><p class="refpurpose"><span class="refname">eio_rename</span> — <span class="dc-title">Change the name or location of a file.</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.eio-rename-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>eio_rename</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$new_path</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$pri</code><span class="initializer"> = EIO_PRI_DEFAULT</span></span>
[, <span class="methodparam"><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code><span class="initializer"> = NULL</span></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$data</code><span class="initializer"> = NULL</span></span>
]]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>eio_rename()</strong></span> renames or moves a file to new location.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.eio-rename-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">path</code></em></span>
<dd>
<p class="para">
Source path
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">new_path</code></em></span>
<dd>
<p class="para">
Target path
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">pri</code></em></span>
<dd>
<p class="para">The request priority: <strong><code>EIO_PRI_DEFAULT</code></strong>, <strong><code>EIO_PRI_MIN</code></strong>, <strong><code>EIO_PRI_MAX</code></strong>, or <strong><code>NULL</code></strong>.
If <strong><code>NULL</code></strong> passed, <em><code class="parameter">pri</code></em> internally is set to
<strong><code>EIO_PRI_DEFAULT</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">callback</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">callback</code></em> function is called when the request is done.
It should match the following prototype: <div class="example-contents"><div class="phpcode"><code><span style="color: #000000">
void callback(mixed $data, int $result[, resource $req]);</span>
</code></div></div>
<dl>
<dt>
<span class="term"><em><code class="parameter">data</code></em></span>
<dd>
<p class="para">is custom data passed to the request.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">result</code></em></span>
<dd>
<p class="para">request-specific result value; basically, the value returned by corresponding
system call.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">req</code></em></span>
<dd>
<p class="para">is optional request resource which can be used with functions like <span class="function"><a href="function.eio-get-last-error.php" class="function">eio_get_last_error()</a></span></p></dd>
</dt>
</dl>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">data</code></em></span>
<dd>
<p class="para">
Arbitrary variable passed to <em><code class="parameter">callback</code></em>.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.eio-rename-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>eio_rename()</strong></span> returns request resource on success or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.eio-rename-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3506">
<p><strong>Example #1 <span class="function"><strong>eio_rename()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$filename </span><span style="color: #007700">= </span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">).</span><span style="color: #DD0000">"/eio-temp-file.dat"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">touch</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$new_filename </span><span style="color: #007700">= </span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">).</span><span style="color: #DD0000">"/eio-temp-file-new.dat"</span><span style="color: #007700">;<br /><br />function </span><span style="color: #0000BB">my_rename_cb</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br /> global </span><span style="color: #0000BB">$filename</span><span style="color: #007700">, </span><span style="color: #0000BB">$new_filename</span><span style="color: #007700">;<br /><br /> if (</span><span style="color: #0000BB">$result </span><span style="color: #007700">== </span><span style="color: #0000BB">0 </span><span style="color: #007700">&& !</span><span style="color: #0000BB">file_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">) && </span><span style="color: #0000BB">file_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$new_filename</span><span style="color: #007700">)) {<br /> @</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$new_filename</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"eio_rename_ok"</span><span style="color: #007700">;<br /> } else {<br /> @</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /> }<br />}<br /><br /></span><span style="color: #0000BB">eio_rename</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">, </span><span style="color: #0000BB">$new_filename</span><span style="color: #007700">, </span><span style="color: #0000BB">EIO_PRI_DEFAULT</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_rename_cb"</span><span style="color: #007700">, </span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">eio_event_loop</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
eio_rename_ok
</pre></div>
</div>
</div>
</div>
</div><?php manual_footer(); ?>
