mmieluch/laravel-vfs-provider

A Laravel service provider for Flysystem's wrapper around PHP-VFS.

laravel-vfs-provider

, _(*1)

A service provider intended to use with Laravel 5.x for The League Flysystem's wrapper around PHP-VFS library., _(*2)

Installation

1. Update your project dependencies:, _(*3)

   composer require mmieluch/laravel-vfs-provider
   

2. Register new service provider in config/app.php:, _(*4)

   return [
   
     'providers' => [
   
         ...
   
         /*
          * 3rd Party Service Providers
          */
         Mmieluch\LaravelVfsProvider\LaravelVfsServiceProvider::class,
   
     ],
   
   ];
   

3. Update your config/filesystems.php file:, _(*5)

   return [
   
     ...
   
     'disks' => [
   
       // This is just an example name, you can call your disk
       // however you want :)
       'virtual' => [
           'driver' => 'vfs',
       ],
   
     ],
   
   ];
   

Now you can start using your new driver, just as you'd use a local driver:, _(*6)

// Get a handler for storage...
$storage = app('storage');
// Or, if your VFS disk is not a default one, you need to
// choose it from the pool of available disks.
$storage = app('storage')->disk('virtual');

// And you're ready to use your new virtual filesystem!
$storage->makeDirectory('foo');
$storage->put('foo/bar.txt', 'baz');

$storage->has('foo/bar.txt'); // Returns: true

echo $storage->get('/foo/bar.txt'); // Outputs: baz

// You'd like to use a facade? Why, go ahead!
Storage::put('test.txt', 'All about that bass');
// Again, if your virtual drive is not set as your default:
Storage::disk('virtual')->put('test.txt', 'No treble');

For full set of instructions on how to use the Laravel filesystem service visit Laravel's official documentation, _(*7)

TODO

• set up path prefix (configuration root), like in other drivers;
• add tests.

Bugs? Suggestions?

Feel free to file an issue or submit a PR., _(*8)

License

This package is open-sourced software licensed under the MIT license., _(*9)