Filesystem

Testing Is Documentation

tests/Filesystem/ManagerTest.phpFilesystem - 图1

文件管理统一由文件组件完成，通常我们使用代理 \Leevel\Filesystem\Proxy\Filesystem 类进行静态调用。

内置支持的 filesystem 驱动类型包括 local、zip、ftp、sftp，未来可能增加其他驱动。

TIP

文件系统底层基于 league/flysystem 开发，相关文档可以参考 https://flysystem.thephpleague.com/docs/Filesystem - 图2。

使用方式

使用容器 flysystems 服务

  1. \App::make('filesystems')->put(string $path, string $contents, array $config = []): bool;

依赖注入

  1. class Demo
  2. {
  3.     private \Leevel\Filesystem\Manager $filesystem;
  5.     public function __construct(\Leevel\Filesystem\Manager $filesystem)
  6.     {
  7.         $this->filesystem = $filesystem;
  8.     }
  9. }

使用静态代理

  1. \Leevel\Filesystem\Proxy\Filesystem::put(string $path, string $contents, array $config = []): bool;

filesystem 配置

系统的 filesystem 配置位于应用下面的 option/filesystem.php 文件。

可以定义多个文件系统连接，并且支持切换，每一个连接支持驱动设置。

  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the your app package.
  7.  *
  8.  * The PHP Application For Code Poem For You.
  9.  * (c) 2018-2099 http://yourdomian.com All rights reserved.
  10.  *
  11.  * For the full copyright and license information, please view the LICENSE
  12.  * file that was distributed with this source code.
  13.  */
  15. return [
  16.     /*
  17.      * ---------------------------------------------------------------
  18.      * 文件驱动
  19.      * ---------------------------------------------------------------
  20.      *
  21.      * 采用什么方式发送邮件数据
  22.      */
  23.     'default' => Leevel::env('FILESYSTEM_DRIVER', 'local'),
  25.     /*
  26.      * ---------------------------------------------------------------
  27.      * 文件驱动连接参数
  28.      * ---------------------------------------------------------------
  29.      *
  30.      * 这里为所有的 filesystem 驱动的连接参数，每一种不同的驱动拥有不同的配置
  31.      * 虽然有不同的驱动，但是在使用上却有着一致性
  32.      */
  33.     'connect' => [
  34.         'local' => [
  35.             // driver
  36.             'driver' => 'local',
  38.             // path
  39.             'path' => Leevel::storagePath(),
  40.         ],
  42.         'zip' => [
  43.             // driver
  44.             'driver' => 'zip',
  46.             // path
  47.             'path' => Leevel::storagePath('filesystem.zip'),
  48.         ],
  50.         'ftp' => [
  51.             // driver
  52.             'driver' => 'ftp',
  54.             // 主机
  55.             'host' => Leevel::env('FILESYSTEM_FTP_HOST', 'ftp.example.com'),
  57.             // 端口
  58.             'port' => (int) Leevel::env('FILESYSTEM_FTP_PORT', 21),
  60.             // 用户名
  61.             'username' => Leevel::env('FILESYSTEM_FTP_USERNAME', 'your-username'),
  63.             // 密码
  64.             'password' => Leevel::env('FILESYSTEM_FTP_PASSWORD', 'your-password'),
  66.             // 根目录
  67.             'root' => '',
  69.             // 被动、主动
  70.             'passive' => true,
  72.             // 加密传输
  73.             'ssl' => false,
  75.             // 超时设置
  76.             'timeout' => 20,
  77.         ],
  79.         'sftp' => [
  80.             // driver
  81.             'driver' => 'sftp',
  83.             // 主机
  84.             'host' => Leevel::env('FILESYSTEM_SFTP_HOST', 'sftp.example.com'),
  86.             // 端口
  87.             'port' => (int) Leevel::env('FILESYSTEM_SFTP_PORT', 22),
  89.             // 用户名
  90.             'username' => Leevel::env('FILESYSTEM_SFTP_USERNAME', 'your-username'),
  92.             // 密码
  93.             'password' => Leevel::env('FILESYSTEM_SFTP_PASSWORD', 'your-password'),
  95.             // 根目录
  96.             'root' => '',
  98.             // 私钥路径
  99.             'privateKey' => '',
  101.             // 超时设置
  102.             'timeout' => 20,
  103.         ],
  104.     ],
  105. ];

filesystem 参数根据不同的连接会有所区别。

Uses

  1. <?php
  3. use League\Flysystem\Filesystem as LeagueFilesystem;
  4. use Leevel\Di\Container;
  5. use Leevel\Di\IContainer;
  6. use Leevel\Filesystem\Manager;
  7. use Leevel\Option\Option;

文件系统基本使用方法

  1. public function testBaseUse(): void
  2. {
  3.     $manager = $this->createManager();
  4.     $path = __DIR__.'/forManager';
  5.     $this->assertInstanceof(LeagueFilesystem::class, $manager->getFilesystem());
  7.     $manager->put('hellomanager.txt', 'manager');
  8.     $file = $path.'/hellomanager.txt';
  10.     $this->assertTrue(is_file($file));
  11.     $this->assertSame('manager', file_get_contents($file));
  13.     unlink($file);
  14.     rmdir($path);
  15. }