League\Flysystem

Flysystem is a filesystem abstraction which allows you to easily swap out a local filesystem for a remote one.

Goals

• Have a generic API for handling common tasks across multiple file storage engines.
• Have consistent output which you can rely on.
• Integrate well with other packages/frameworks.
• Be cacheable.
• Emulate directories in systems that don't support them, like AwsS3.
• Support third party plugins.
• Make it easy to test your filesystem interactions.
• Support streams for big file handling.

Installation

Through Composer, obviously:

composer require league/flysystem

You can also use Flysystem without using Composer by registering an autoloader function:

spl_autoload_register(function($class) {
    $prefix = 'League\\Flysystem\\';

    if (substr($class, 0, 17) !== $prefix) {
        return;
    }

    $class = substr($class, strlen($prefix));
    $location = __DIR__ . 'path/to/flysystem/src/' . str_replace('\\', '/', $class) . '.php';

    if (is_file($location)) {
        require_once($location);
    }
});

Documentation

Check out the documentation

Community Integrations

Want to get started quickly? Check out some of these integrations:

• Backup manager: https://github.com/heybigname/backup-manager
• CakePHP integration: https://github.com/WyriHaximus/FlyPie
• Cilex integration: https://github.com/WyriHaximus/cli-fly
• Drupal: https://www.drupal.org/project/flysystem
• elFinder: https://github.com/barryvdh/elfinder-flysystem-driver
• Laravel integration: https://github.com/GrahamCampbell/Laravel-Flysystem
• Silex integration: https://github.com/WyriHaximus/SliFly
• Symfony integration: https://github.com/1up-lab/OneupFlysystemBundle
• Yii 2 integration: https://github.com/creocoder/yii2-flysystem
• Zend Framework integration: https://github.com/bushbaby/BsbFlysystem
• PSR-11 containers: https://github.com/wshafer/psr11-flysystem

Adapters

Core

• Ftp
• Local
• NullAdapter

Officially Supported

• Amazon Web Services - S3 V2: https://github.com/thephpleague/flysystem-aws-s3-v2
• Amazon Web Services - S3 V3: https://github.com/thephpleague/flysystem-aws-s3-v3
• Azure Blob Storage: https://github.com/thephpleague/flysystem-azure
• Memory: https://github.com/thephpleague/flysystem-memory
• PHPCR: https://github.com/thephpleague/flysystem-phpcr
• Rackspace Cloud Files: https://github.com/thephpleague/flysystem-rackspace
• Sftp (through phpseclib): https://github.com/thephpleague/flysystem-sftp
• WebDAV (through SabreDAV): https://github.com/thephpleague/flysystem-webdav
• Zip (through ZipArchive): https://github.com/thephpleague/flysystem-ziparchive

Community Supported

• AliYun OSS Storage: https://github.com/xxtime/flysystem-aliyun-oss
• Amazon Cloud Drive - https://github.com/nikkiii/flysystem-acd
• Backblaze: https://github.com/mhetreramesh/flysystem-backblaze
• ClamAV Scanner Adapter: https://github.com/mgriego/flysystem-clamav
• Citrix ShareFile: https://github.com/kapersoft/flysystem-sharefile
• Dropbox (with PHP 5.6 support): https://github.com/srmklive/flysystem-dropbox-v2
• Dropbox: https://github.com/spatie/flysystem-dropbox
• Fallback: https://github.com/Litipk/flysystem-fallback-adapter
• Gaufrette: https://github.com/jenkoian/flysystem-gaufrette
• Google Cloud Storage: https://github.com/Superbalist/flysystem-google-storage
• Google Drive: https://github.com/nao-pon/flysystem-google-drive
• OneDrive: https://github.com/jacekbarecki/flysystem-onedrive
• OpenStack Swift: https://github.com/nimbusoftltd/flysystem-openstack-swift
• Redis (through Predis): https://github.com/danhunsaker/flysystem-redis
• Selectel Cloud Storage: https://github.com/ArgentCrusade/flysystem-selectel
• SinaAppEngine Storage: https://github.com/litp/flysystem-sae-storage

Caching (https://github.com/thephpleague/flysystem-cached-adapter)

• Adapter (using another Flysystem adapter)
• Memcached
• Memory (array caching)
• Redis (through Predis)
• Stash

Security

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

Enjoy

Oh and if you've come down this far, you might as well follow me on twitter.