https://github.com/stechstudio/laravel-vfs-adapter

Virtual Filesystem Storage Adapter for Laravel
https://github.com/stechstudio/laravel-vfs-adapter

Last synced: 10 days ago
JSON representation

Virtual Filesystem Storage Adapter for Laravel

• Host: GitHub
• URL: https://github.com/stechstudio/laravel-vfs-adapter
• Owner: stechstudio
• License: mit
• Created: 2017-03-01T03:24:07.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-09-23T13:50:50.000Z (about 4 years ago)
• Last Synced: 2024-10-19T02:04:42.671Z (19 days ago)
• Language: PHP
• Size: 3.1 MB
• Stars: 10
• Watchers: 4
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Storage Virtual File System Adapter

Sometimes, when we are testing, it would be very nice to just easily swap out the various `Storage:disk()` calls with a

virtual files system like `mikey179/vfsStream`.

## Installation

```

composer require stechstudio/laravel-vfs-adapter

```

Then register the provider in your `App\Providers\AppServiceProvider` like so:

```php

public function register()

{

    if ($this->app->environment() === 'testing') {

        if (class_exists(VfsFilesystemServiceProvider::class)) {

            $this->app->register(VfsFilesystemServiceProvider::class);

        }

    }

}

```

This assumes you stick with the default `APP_ENV=testing` settings that Laravel comes with out of the box. Of course,

you may also register the provider in the more traditional manner if you want the virtual file system adapter available

in other environments, of it you just don't like the way we do it.

## Configuration

All configuration can be done in a combination of your `.env`, `phpunit.xml`, and `config/filesystems.php`.

Suppose you had a `config/filesystems.php` that looked something like this:

```php

return [

    ....

    'disks' => [

        'data' => [

            'driver' => 'local',

            'root'   => env('STORAGE_DATA_DIR'),

        ],

        'archive' => [

            'driver'   => 's3'

            'key'      => env('S3_KEY'),

            'secret'   => env('S3_SECRET'),

            'region'   => env('S3_REGION'),

            'bucket'   => env('S3_DEVELOP_BUCKET')

        ]

    ],

];

```

Simply make a few modifications:

```php

return [

    ....

    'disks' => [

        'data' => [

            'driver' => env('STORAGE_DATA_DRIVER', 'local'),

            'root'   => env('STORAGE_DATA_DIR'),

            'dir_name' => 'data'

        ],

        'archive' => [

            'driver'   => env('S3_ARCHIVE_DRIVER', 's3')

            'key'      => env('S3_KEY'),

            'secret'   => env('S3_SECRET'),

            'region'   => env('S3_REGION'),

            'bucket'   => env('S3_DEVELOP_BUCKET'),

            'dir_name' => 'archive'

        ]

    ],

];

```

The `dir_name` determines the root directory of the vfsStream for that particular `Storage::disk()`, I like to name it

something relative to the actual `disk` name. Setting up the driver with `env()` allows us to default to our standard drivers

or allow us to override that in `phpunit.xml` to switch over to the virtual filesystem driver.

Now, in your `phpunit.xml` add:

```xml

```

That is all there is to it, those drives will now use the virtual filesystem adapter.