EIO_RENAME(3) 1 EIO_RENAME(3)
eio_rename - Change the name or location of a file.
SYNOPSIS
resource eio_rename (string $path, string $new_path, [int $pri = EIO_PRI_DEFAULT], [callable $callback = NULL], [mixed $data = NULL])
DESCRIPTION
eio_rename(3) renames or moves a file to new location.
PARAMETERS
o $path
- Source path
o $new_path
- Target path
o $pri
-The request priority: EIO_PRI_DEFAULT, EIO_PRI_MIN, EIO_PRI_MAX, or NULL. If NULL passed, $pri internally is set to
EIO_PRI_DEFAULT.
o $callback
-$callback function is called when the request is done. It should match the following prototype:
void callback(mixed $data, int $result[, resource $req]);
o $data
-is custom data passed to the request.
o $result
-request-specific result value; basically, the value returned by corresponding system call.
o $req
-is optional request resource which can be used with functions like eio_get_last_error(3)
o $data
- Arbitrary variable passed to $callback.
RETURN VALUES
eio_rename(3) returns request resource on success or FALSE on error.
EXAMPLES
Example #1
eio_rename(3) example
<?php
$filename = dirname(__FILE__)."/eio-temp-file.dat";
touch($filename);
$new_filename = dirname(__FILE__)."/eio-temp-file-new.dat";
function my_rename_cb($data, $result) {
global $filename, $new_filename;
if ($result == 0 && !file_exists($filename) && file_exists($new_filename)) {
@unlink($new_filename);
echo "eio_rename_ok";
} else {
@unlink($filename);
}
}
eio_rename($filename, $new_filename, EIO_PRI_DEFAULT, "my_rename_cb", $filename);
eio_event_loop();
?>
The above example will output something similar to:
eio_rename_ok
PHP Documentation Group EIO_RENAME(3)
