wearesho-team/yii2-filesystem

Yii2 integration for league/flysystem

5.1.0 2024-12-16 14:51 UTC

Requires

• php: >=8.1
• horat1us/yii2-environment-config: ^1.1
• league/flysystem: ^3.29
• league/flysystem-aws-s3-v3: ^3.23
• yiisoft/yii2: ^2.0.40

Requires (Dev)

• horat1us/yii2-asset-free: ^1.0
• mockery/mockery: ^1.5
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.7

MIT

• Alexander Letnikow

README

Integration of league/flysystem for Yii2.

It is configured by environment variables by default. Available integration out-of-box:

• Local - should be used for development
• S3 - should be used in production

Configuring

By-default configuring available using environment variables. To choose which integration to use you need to configure FILESYSTEM_ADAPTER variable. Available values: local, s3. (or another, if you use custom bootstrap configuration)

Configuring S3 adapter

Configuring Local adapter

Usage

Bootstrap

To start use this package out-of-box you need to append Bootstrap into your Yii2 application.

<?php

// common/config/main.php or another configuration file

use Wearesho\Yii\Filesystem;

return [
    'components' => [
        // ...
    ],
    'bootstrap' => [
        'class' => Filesystem\Bootstrap::class,
        'container' => true, // if you need to configure global DI container (\Yii::$container)
        'id' => 'fs', // \Yii::$app component to be configured. Filesystem will be available using \Yii::$app->fs
    ],
];

Note: for advanced usage you may customize Bootstrap adapters and config properties

TODO

• Tests

License

MIT