runtuer / php-ftp
PHP 的灵活 FTP 和 SSL-FTP 客户端。此库提供使用原生的 PHP API 和 fsockopen。
dev-master
2018-12-26 13:08 UTC
Requires
- php: >=7.0.0
This package is auto-updated.
Last update: 2024-09-30 01:18:51 UTC
README
PHP 的灵活 FTP 和 SSL-FTP 类。此库提供易于使用的辅助函数来管理远程文件。
一个不需要 php ftp 扩展的 FTP 包。
安装
-
使用 composer: require
runtuer/php-ftp
-
或使用 GIT 克隆命令:
git clone git@github.com:runtuer/php-ftp.git
-
或下载库,配置您的自动加载器或包含
php-ftp/src/Ftpclient
目录的 3 个文件。
入门指南
连接到 FTP 服务器
$ftp = new \Ftpclient(); $ftp->connect($host); $ftp->login($login, $password);
或
通过 SSL 连接到 FTP 服务器(端口 990 或其他端口)
$ftp = new \Ftpclient(); $ftp->connect($host, true, 990); $ftp->login($login, $password); ### Usage Upload all files and all directories is easy : ```php // upload with the BINARY mode $ftp->putAll($source_directory, $target_directory); // Is equal to $ftp->putAll($source_directory, $target_directory, FTP_BINARY); // or upload with the ASCII mode $ftp->putAll($source_directory, $target_directory, FTP_ASCII);
注意:
$ftp = new \Ftp\Ftpclient();
// size of the current directory $size = $ftp->dirSize(); // size of a given directory $size = $ftp->dirSize('/path/of/directory');
统计目录中的项目数量
// count in the current directory $total = $ftp->count(); // count in a given directory $total = $ftp->count('/path/of/directory'); // count only the "files" in the current directory $total_file = $ftp->count('.', 'file'); // count only the "files" in a given directory $total_file = $ftp->count('/path/of/directory', 'file'); // count only the "directories" in a given directory $total_dir = $ftp->count('/path/of/directory', 'directory'); // count only the "symbolic links" in a given directory $total_link = $ftp->count('/path/of/directory', 'link');
所有文件和目录的详细列表
// scan the current directory and returns the details of each item $items = $ftp->scanDir(); // scan the current directory (recursive) and returns the details of each item var_dump($ftp->scanDir('.', true));
结果
'directory#www' =>
array (size=10)
'permissions' => string 'drwx---r-x' (length=10)
'number' => string '3' (length=1)
'owner' => string '32385' (length=5)
'group' => string 'users' (length=5)
'size' => string '5' (length=1)
'month' => string 'Nov' (length=3)
'day' => string '24' (length=2)
'time' => string '17:25' (length=5)
'name' => string 'www' (length=3)
'type' => string 'directory' (length=9)
'link#www/index.html' =>
array (size=11)
'permissions' => string 'lrwxrwxrwx' (length=10)
'number' => string '1' (length=1)
'owner' => string '0' (length=1)
'group' => string 'users' (length=5)
'size' => string '38' (length=2)
'month' => string 'Nov' (length=3)
'day' => string '16' (length=2)
'time' => string '14:57' (length=5)
'name' => string 'index.html' (length=10)
'type' => string 'link' (length=4)
'target' => string '/var/www/shared/index.html' (length=26)
'file#www/README' =>
array (size=10)
'permissions' => string '-rw----r--' (length=10)
'number' => string '1' (length=1)
'owner' => string '32385' (length=5)
'group' => string 'users' (length=5)
'size' => string '0' (length=1)
'month' => string 'Nov' (length=3)
'day' => string '24' (length=2)
'time' => string '17:25' (length=5)
'name' => string 'README' (length=6)
'type' => string 'file' (length=4)
支持所有 FTP PHP 函数,并对一些函数进行了改进
// Requests execution of a command on the FTP server $ftp->exec($command); // Turns passive mode on or off $ftp->pasv(true); // Set permissions on a file via FTP $ftp->chmod(0777, 'file.php'); // Removes a directory $ftp->rmdir('path/of/directory/to/remove'); // Removes a directory (recursive) $ftp->rmdir('path/of/directory/to/remove', true); // Creates a directory $ftp->mkdir('path/of/directory/to/create'); // Creates a directory (recursive), // creates automaticaly the sub directory if not exist $ftp->mkdir('path/of/directory/to/create', true); // and more ...
获取远程 FTP 服务器的帮助信息
var_dump($ftp->help());
结果
array (size=6)
0 => string '214-The following SITE commands are recognized' (length=46)
1 => string ' ALIAS' (length=6)
2 => string ' CHMOD' (length=6)
3 => string ' IDLE' (length=5)
4 => string ' UTIME' (length=6)
5 => string '214 Pure-FTPd - http://pureftpd.org/' (length=36)
注意:结果取决于 FTP 服务器。
扩展
创建您的自定义 Ftpclient
。
// MyFtpclient.php /** * My custom FTP Client * @inheritDoc */ class MyFtpclient extends \Ftpclient { public function removeByTime($path, $timestamp) { // your code here } public function search($regex) { // your code here } }
// example.php $ftp = new MyFtpclient(); $ftp->connect($host); $ftp->login($login, $password); // remove the old files $ftp->removeByTime('/www/mysite.com/demo', time() - 86400)); // search PNG files $ftp->search('/(.*)\.png$/i');
API 文档
查看 源代码
测试
使用 "atoum" 单元测试框架进行测试。
许可证
MIT c) 2019, Nicolas Tallefourtane。
作者
Runtuer