PHP Classes

Yii2 MultiFS: File system providers to access configurable paths

Recommend this page to a friend!
  Info   Documentation   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 19 All time: 11,370 This week: 488Up
Version License PHP version Categories
yii2-multifs 1.0MIT/X Consortium ...5PHP 5, Files and Folders, Libraries
Description 

Author

This package implements file system providers to access configurable paths.

It provides classes that implement PHP file system iterator interfaces that can access directories and files with paths based on configuration values from the YII framework.

The package also provides a file uploading handling that can use the file system classes to implement the processing of files uploaded to a site using these classes.

Innovation Award
PHP Programming Innovation award nominee
January 2023
Number 3
PHP is a flexible language in many aspects. One of these aspects is that it allows applications to provide classes that emulate several operations developers can execute when accessing files and directories.

For instance, PHP provides file system iterator classes that allow applications to traverse the files and directories contained in a given directory.

This package implements file system classes that file system iterator classes can access to traverse directories so that the full path is defined dynamically from application configuration values loaded using the Yii2 framework configuration access classes.

It also provides file upload handling support that uses these file system access classes to store the uploaded file contents in directories with paths that depend on the current application configuration.

This way, this application provides flexibility to application developers, so they do not have to hardcode the full application paths of the directories where important application files are stored.

Manuel Lemos
Picture of Insolita
  Performance   Level  
Innovation award
Innovation award
Nominee: 18x

 

Documentation

Multifs Manager

- Provide Multifs Manager based on (League\Flysystem\MountManager) for work with set of filesystems (League\Flysystem\Filesystem); - Provide flexible Uploader service with support different strategies for resolve file naming, file path structure, and file saving - Provide sample Upload,View and Delete Actions with output compatible with trntv\filekit\widget\Upload

Status

Installation

The preferred way to install this extension is through composer.

Either run

composer require --prefer-dist insolita/yii2-multifs "~1.0.0"

or add

"insolita/yii2-multifs": "~0.0.1"

to the require section of your composer.json file.

Usage

Once the extension is installed, simply use it in your code by :

Define in bootstrap neccessary filesystems

 $avatars = (new \insolita\multifs\builders\LocalFsBuilder('@app/web/uploads/avatars'))->build();
 $covers = (new \insolita\multifs\builders\LocalFsBuilder('@app/web/uploads/covers'))->build();
 $attach = (new \insolita\multifs\builders\LocalFsBuilder('@app/web/uploads/attach'))->build();
 $data = (new \insolita\multifs\builders\LocalFsBuilder('@data'))->build();

(Ensure that aliases already defined)

Register in container:

 \insolita\multifs\contracts\IMultifsManager::class                                              => [
                \insolita\multifs\MultiFsManager::class,
                [
                    [
                        'avatars'  => $avatars,
                        'covers'   => $covers,
                        'attach'   => $attach,
                        'internal' => $data,
                    ],
                ],
            ],
            \insolita\multifs\contracts\IUploader::class=>[
                \insolita\multifs\Uploader::class,
                [
                    \yii\di\Instance::of(\insolita\multifs\contracts\IMultifsManager::class),
                    'attach'
                ]
            ],

also you can add components aliases


'components'=>[
   'multifs'=>\insolita\multifs\contracts\IMultifsManager::class,
   'uploader'=>\insolita\multifs\contracts\IUploader::class,
]

On fly usage


      echo Yii::$app->multifs->listPrefixes();
      Yii::$app->multifs->mountFilesystem('special', new Filesystem(new Adapter(...)));
      Yii::$app->multifs->write('special://some/file/path/name.txt','Hello Test');
      $fs = Yii::$app->multifs->getFilesystem('internal');
      Vardumper::dump($fs->listConents('',true));

Uploader


     $file = \yii\web\UploadedFile::getInstanceByName('file');
     $path = Yii::$app->uploader->setFsPrefix('avatars')
               ->setFileNameStrategy(new insolita\multifs\strategy\filename\AsIsStrategy())
               ->setFilePathStrategy(new insolita\multifs\strategy\filename\NameHashStrategy())
               ->setFileSaveStrategy(new insolita\multifs\strategy\filename\ExceptionSaveExistsStrategy())
               ->save($file);

    \Yii::$app->response->sendStreamAsFile(Yii::$app->multifs->readStream($path),
                                            pathinfo($path, PATHINFO_BASENAME),
                                            [
                                               'mimeType' => $file->getType(),
                                               'inline'=>true
                                            ]);

Other documentation will be later; see tests


  Files folder image Files (61)  
File Role Description
Files folder imagesrc (2 files, 6 directories)
Files folder imagetests (4 files, 2 directories)
Accessible without login Plain text file .scrutinizer.yml Data Auxiliary data
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file CHANGELOG.md Data Auxiliary data
Accessible without login Plain text file codeception.yml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:19
This week:0
All time:11,370
This week:488Up