A flysystem adapter to use Gaufrette without changing the API
PHP
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Flysystem Adapter for Gaufrette

Build Status Coverage Status Quality Score Software License

Installation

composer require jenko/flysystem-gaufrette

Usage

Basic usage:

use Jenko\Flysystem\GaufretteAdapter;
use Gaufrette\Adapter\Local;

$adapter = new GaufretteAdapter(
    new Local(__DIR__ . '/path/to/files');
); 

$filesystem = new Filesystem($adapter);

Advanced usage:

use Jenko\Flysystem\GaufretteAdapter;
use Gaufrette\Adapter\Local;
use Gaufrette\Adapter\Flysystem;

// Hadouken!
$adapter = new GaufretteAdapter(
    new Flysystem(
        new GaufretteAdapter(
            new Flysystem(
                new GaufretteAdapter(
                    new Flysystem(
                        new GaufretteAdapter(
                            new Local(
                                __DIR__ . '/path/to/files'
                            )
                        )
                    )
                )
            )
        )
    )
);

$filesystem = new Filesystem($adapter);

Wait, what?

Gaufrette added a Flysystem adapter so it made sense to reciprocate the love and have an adapter going in the other direction. Although it does feel a little yo dawg it is useful. For example if you have a codebase which is quite coupled to the flysystem API (legacy app, obv you wouldn't have done this) but wish to make a switch to Gaufrette, this will allow you to do so without having to go through your codebase changing all calls to the old API. For more information on actual usage, see this blog post: http://jenko.me/legacy/2017/03/07/from-gaufrette-to-flysystem-and-back-again/

It also allows you to construct fun, bi-directional, hadouken-esque nesting as seen in the advanced usage example above.

Unsupported methods

Flysystem has a few methods which Gaufrette doesn't quite support, these are listed below:

  • update
  • updateStream
  • copy
  • createDir
  • getVisibility
  • setVisibility

The following methods are only supported for Gaufrette adapters implementing MetadataSupporter:

  • getMetadata

The following methods are only supported for Gaufrette adapters implementing SizeCalculator:

  • getSize

The following methods are only supported for Gaufrette adapters implementing MimeTypeProvider:

  • getMimetype