rayblair/filesystem

0.2.0 2020-12-16 15:32 UTC

Requires

• php: ^7.1

Requires (Dev)

• orchestra/testbench: ^4.0
• phpunit/phpunit: ^8.0

MIT

• Ray Blair

• filesystem
• rayblair

README

A collection of handy functions to extend Laravel's filesystem.

Detect and resolve filesystem from service container

Automatically define the filesystem disk, and keep the filesystem consistent through the application based on environment settings.

Default to s3, unless environment is sandbox, or environment is local and doesn't have s3.

Extend the filesystem's functionality

Extend Laravel's Storage facade with your own functionality.

MoveToDisk command

Easily move files from one disk to another.

Installation

Update composer.json with the following:

"require": {
        ...
        "rayblair/filesystem": "0.2.0"
    },
    "repositories": [
        ...
        {
            "type": "vcs",
            "url": "https://github.com/rayblair06/filesystem.git"
        },
        ...
    ],

Usage

Resolve from Service Container

Makesure to resolve all Storage uses from the service container.

use Illuminate\Contracts\Filesystem\Filesystem;

// Normal Use
Storage::get($filename);

// Our Use
app(Filesystem::class)->get($filename);

Extend the filesystem's functionality

Adding new methods to ExtendFilesystem.php will allow you use them while resolving from the service container

class ExtendFilesystem
{
    ...
    public function foo()
    {
        return 'bar';
    }
    ...
}

use Illuminate\Contracts\Filesystem\Filesystem;

// Returns the string 'bar'
app(Filesystem::class)->foo();

MoveToDisk command

Command php artisan move:to-disk {from_disk} {to_disk} will allow you to easily move files from one disk to another.

Note: This will make use of the queuing system to move files.

php artisan move:to-disk local s3

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Ray Blair
• All Contributors

License

The MIT License (MIT). Please see License File for more information.