English | 简体中文 | 繁體中文
查询

ssh2_sftp_rename()函数—用法及示例

「 重命名远程SFTP服务器上的文件或目录 」


函数名称:ssh2_sftp_rename()

适用版本:PHP 5 >= 5.2.0, PECL ssh2 >= 0.9.0

函数说明:ssh2_sftp_rename()函数用于重命名远程SFTP服务器上的文件或目录。

语法:bool ssh2_sftp_rename(resource $sftp, string $from, string $to)

参数:

  • $sftp:一个已连接的SFTP资源句柄,使用ssh2_sftp()函数获取。
  • $from:要重命名的文件或目录的原始路径。
  • $to:重命名后的文件或目录的新路径。

返回值:

  • 如果重命名成功,则返回true,否则返回false。

示例:

// 连接到SSH服务器
$connection = ssh2_connect('example.com', 22);
if (!$connection) {
    die('无法连接到SSH服务器');
}

// 进行身份验证
if (!ssh2_auth_password($connection, 'username', 'password')) {
    die('身份验证失败');
}

// 获取SFTP资源句柄
$sftp = ssh2_sftp($connection);

// 重命名远程文件
$from = 'remote/path/file.txt';
$to = 'remote/path/newfile.txt';

if (ssh2_sftp_rename($sftp, $from, $to)) {
    echo '文件重命名成功';
} else {
    echo '文件重命名失败';
}

// 重命名远程目录
$from = 'remote/path/dir';
$to = 'remote/path/newdir';

if (ssh2_sftp_rename($sftp, $from, $to)) {
    echo '目录重命名成功';
} else {
    echo '目录重命名失败';
}

以上示例中,我们首先通过ssh2_connect()函数连接到SSH服务器,然后使用ssh2_auth_password()函数进行身份验证。接下来,我们使用ssh2_sftp()函数获取SFTP资源句柄。然后,我们使用ssh2_sftp_rename()函数分别重命名了远程文件和目录。最后,根据返回值判断重命名操作是否成功,并输出相应的结果。

补充纠错
上一个函数: ssh2_sftp_rmdir()函数
下一个函数: ssh2_sftp_realpath()函数
热门PHP函数
分享链接