Php/docs/function.eio-rename

• PHP Manual
• Eio Functions
• Change the name or location of a file

eio_rename

(PECL eio >= 0.0.1dev)

eio_rename — Change the name or location of a file

Description

eio_rename ( string $path , string $new_path [, int $pri = EIO_PRI_DEFAULT [, callable $callback = NULL [, mixed $data = NULL ]]] ) : resource

eio_rename() renames or moves a file to new location.

Parameters

path

Source path

new_path

Target path

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.

callback

callback function is called when the request is done. It should match the following prototype:

void callback(mixed $data, int $result[, resource $req]);

data

is custom data passed to the request.

result

request-specific result value; basically, the value returned by corresponding system call.

req

is optional request resource which can be used with functions like eio_get_last_error()

data

Arbitrary variable passed to callback.

Return Values

eio_rename() returns request resource on success or FALSE on error.

Examples

Example #1 eio_rename() 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