An abstract filesystem that allows to swap underlying file system without rewriting application code. Based on Flysystem.
The package requires PHP 7.4 and is meant to be used with Yii 3.
composer require yiisoft/yii-filesystem
After installation, the Yiisoft\Yii\Filesystem\FilesystemInterface
will be automatically registered
in the main application container. This interface provides a local filesystem with root, as defined in the @root
alias
of the aliases
parameter.
The service could be obtained via DI container autowiring:
public function view(\Yiisoft\Yii\Filesystem\FilesystemInterface $filesystem)
{
$someFileContent = $filesystem->read('/runtime/somefile.txt');
//...
}
Also you can use aliases
$someFileContent = $filesystem->write('@views/site/testfile.txt', 'Test content');
Additional filesystems could be configured in config/params.php
as described below:
'file.storage' => [
'runtimeStorage' => [
'adapter' => [
'class' => \League\Flysystem\Local\LocalFilesystemAdapter::class,
'__construct()' => [
dirname(__DIR__) . '/runtime',
\League\Flysystem\UnixVisibility\PortableVisibilityConverter::fromArray([
'file' => [
'public' => 0644,
'private' => 0600,
],
'dir' => [
'public' => 0755,
'private' => 0700,
],
]),
LOCK_EX,
\League\Flysystem\Local\LocalFilesystemAdapter::DISALLOW_LINKS
]
],
'aliases' => [
'@cache' => '@root/cache',
]
],
'documentStorage' => [
'adapter' => [
'class' => \League\Flysystem\Local\LocalFilesystemAdapter::class,
'__construct()' => [
dirname(__DIR__) . '/docs',
\League\Flysystem\UnixVisibility\PortableVisibilityConverter::fromArray([
'file' => [
'public' => 0644,
'private' => 0600,
],
'dir' => [
'public' => 0755,
'private' => 0700,
],
]),
LOCK_EX,
\League\Flysystem\Local\LocalFilesystemAdapter::DISALLOW_LINKS
]
],
'aliases' => [
'@invoices' => '@root/export/invoices',
'@orders' => '@root/export/orders',
],
],
],
Aliases runtimeStorage
and documentStorage
will be automatically registered in the main application container.
So, you can get it from the container:
public function index(ContainerInterface $container)
{
$documentStorage = $container->get('documentStorage');
}
If you prefer to use autowiring, you can create own interface for your filesystem.
interface ImageStorageInterface extends \Yiisoft\Yii\Filesystem\FilesystemInterface
{
}
And then register it in the params
:
'file.storage' => [
ImageStorageInterface::class => [
'adapter' => [
'class' => \League\Flysystem\Local\LocalFilesystemAdapter::class,
'__construct()' => [
dirname(__DIR__) . '/storage/images',
\League\Flysystem\UnixVisibility\PortableVisibilityConverter::fromArray([
'file' => [
'public' => 0644,
'private' => 0600,
],
'dir' => [
'public' => 0755,
'private' => 0700,
],
]),
LOCK_EX,
\League\Flysystem\Local\LocalFilesystemAdapter::DISALLOW_LINKS
]
],
],
]
Now you can use it like this:
//controller action
public function addImage(ImageStorageInterface $imageStorage)
{
//get image stream...
$imageStorage->writeStream('/path/to/image/myimage.jpeg', $myImageStream);
}
You can find documentation on FilesystemInterface
methods in the Flysystem Docs.
The package is tested with PHPUnit. To run tests:
./vendor/bin/phpunit
The package tests are checked with Infection mutation framework. To run it:
./vendor/bin/infection
The code is statically analyzed with Psalm. To run static analysis:
./vendor/bin/psalm
The Yii filesystem is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.