zlog/ftp

一个简单的Laravel ftp服务提供者,源自anchu/ftp

2.0 2023-12-07 08:03 UTC

This package is auto-updated.

Last update: 2024-09-07 11:29:42 UTC


README

一个简单的Laravel 5/6/7/10 ftp服务提供者。

将包添加到你的 composer.json 并运行 composer update

{
    "require": {
        "zlog/ftp": "~2.0"
    }
}

如果你使用的是Laravel 5.5+,则可以跳过下一步,因为Laravel可以自动发现包。

config/app.php 中添加服务提供者

'Zlog\Ftp\FtpServiceProvider',

配置

运行 php artisan vendor:publish --tag=config 并修改配置文件(config/ftp.php)以配置你的FTP连接。

你可以使用以下语法添加动态FTP连接

Config::set('ftp.connections.key', array(
           'host'   => '',
           'username' => '',
           'password'   => '',
           'passive'   => false,
           'secure'   => false,
));

访问连接

你可以通过 FTP::connection 方法访问默认FTP连接

FTP::connection()->getDirListing(...);

当使用多个连接时,你可以通过传递连接名来访问每个特定的FTP连接

FTP::connection('foo')->getDirListing(...);

有时你可能需要重新连接到给定的FTP

FTP::reconnect('foo');

如果你需要从给定的FTP断开连接,请使用断开连接方法

FTP::disconnect('foo');

基本使用示例

// With custom connection
$listing = FTP::connection('my-ftp-connection')->getDirListing();

// with default connection
$listing = FTP::connection()->getDirListing();
$status = FTP::connection()->makeDir('directory-name');

支持的方法

getDirListing($directory, $parameters )

返回给定目录中的文件列表

  • $directory: 要列出目录。默认值: .
  • $parameters: 可选参数,用于前缀目录。例如: -la。默认: null

getDirListingDetailed($directory)

返回一个包含以下键的关联数组:权限、编号、用户、组、大小、月份、日和时间

  • $directory: 要列出目录。默认值: .

makeDir($directory)

在FTP服务器上创建指定的目录。

  • $directory: 要创建的目录名称。

changeDir($directory)

更改FTP服务器上的当前目录。

  • $directory: 目标目录。

uploadFile($fileFrom, $fileTo, $mode)

将本地文件上传到FTP服务器。

  • $fileFrom: 本地文件路径。
  • $fileTo: 远程文件路径。
  • $mode: 传输模式。必须是 FTP_ASCIIFTP_BINARY。如果没有指定模式,将自动执行模式解析。

downloadFile($fileFrom, $fileTo, $mode)

从FTP服务器下载文件

  • $fileFrom: 远程文件路径。
  • $fileTo: 本地文件路径(如果文件已存在,则将被覆盖)或一个用于存储数据的打开文件指针。
  • .
  • $mode: 传输模式。必须是 FTP_ASCIIFTP_BINARY。如果没有指定模式,将自动执行模式解析。

readFile($fileFrom)

downloadFile() 方法相同,但它将远程文件下载到PHP输出缓冲区并返回它。

  • $fileFrom: 远程文件路径。

moveUp()

更改到父目录。

permission($mode, $filename)

设置文件的权限。

  • $mode: 新权限,以八进制值表示。
  • $filename: 远程文件。

delete($path)

从FTP服务器删除指定路径的文件。

  • $path: 要删除的文件。

currentDir()

返回当前目录名

rename($oldName, $newName)

在FTP服务器上重命名文件或目录。

  • $oldName: 旧文件/目录名称。
  • $newName: 新名称。

removeDir($directory, $recursive)

删除目录

  • $directory: 要删除的目录。这必须是绝对或相对路径到一个空目录。
  • $recursive: 递归删除文件夹。默认值: false。

truncateDir($directory)

截断目录

  • $directory: 要截断的目录。这必须是绝对或相对路径到一个目录。

size($remoteFile)

返回给定文件的字节大小。注意:并非所有服务器都支持此功能。

  • $remoteFile:远程文件。

time($remoteFile)

返回给定文件的最后修改时间。注意:并非所有服务器都支持此功能。

  • $remoteFile:远程文件。