Need help with Laravel-Flysystem?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Global Rank
#1,545
Topics of expertise
errors
statusp...
Laravel
error-h...
Compose...
excepti...
PHP
phphub
Location
United Kingdom
491 Stars 82 Forks MIT License 532 Commits 1 Opened issues

Description

A Flysystem bridge for Laravel

Services available

!
?

Need anything else?

Contributors list

# 1,545
PHP
Laravel
Compose...
framewo...
451 commits
# 99,959
PHP
Sublime...
ui-them...
vuejs2
2 commits
# 731,278
PHP
1 commit
# 711,305
CSS
Laravel
JavaScr...
1 commit
# 137,506
adonisj...
Nuxt.js
netlify
nuxtjs
1 commit
# 504,935
HTML
Node.js
CSV
JavaScr...
1 commit
# 374,592
PHP
Laravel
lumen
elastic...
1 commit
# 539,570
JavaScr...
CSS
laravel...
Laravel
1 commit
# 265,983
PHP
Laravel
bot-det...
user-ag...
1 commit
# 688,847
PHP
1 commit

Laravel Flysystem

Laravel Flysystem was created by, and is maintained by Graham Campbell, and is a Flysystem bridge for Laravel. It utilises my Laravel Manager package. Feel free to check out the change log, releases, security policy, license, code of conduct, and contribution guidelines.

Banner

Build Status StyleCI Status Software License Packagist Downloads Latest Version

Installation

Laravel Flysystem requires PHP 7.2-8.1. This particular version supports Laravel 6-8.

| Flysystem | L5.1 | L5.2 | L5.3 | L5.4 | L5.5 | L5.6 | L5.7 | L5.8 | L6 | L7 | L8 | |-----------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------| | 3.7 | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :x: | :x: | :x: | :x: | :x: | :x: | :x: | | 4.1 | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :x: | :x: | :x: | :x: | :x: | :x: | | 5.3 | :x: | :x: | :x: | :x: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :x: | :x: | :x: | | 6.3 | :x: | :x: | :x: | :x: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: | :x: | | 7.1 | :x: | :x: | :x: | :x: | :x: | :x: | :x: | :x: | :whitecheckmark: | :whitecheckmark: | :whitecheckmark: |

To get the latest version, simply require the project using Composer:

$ composer require "graham-campbell/flysystem:^7.1"

There are also some additional dependencies you will need to install for some of the features:

  • The AwsS3 adapter requires
    league/flysystem-aws-s3-v3
    (
    ^1.0
    ).
  • The Azure adapter requires
    league/flysystem-azure-blob-storage
    (
    ^0.1.6
    ).
  • The Dropbox adapter requires
    spatie/flysystem-dropbox
    (
    ^1.0
    ).
  • The GoogleCloudStorage adapter requires
    superbalist/flysystem-google-storage
    (
    ^7.2
    ).
  • The GridFS adapter requires
    league/flysystem-gridfs
    (
    ^1.0
    ) and
    alcaeus/mongo-php-adapter
    (
    ^1.1
    ).
  • The Sftp adapter requires
    league/flysystem-sftp
    (
    ^1.0
    ).
  • The WebDav adapter requires
    league/flysystem-webdav
    (
    ^1.0
    ).
  • The ZipAdapter adapter requires
    league/flysystem-ziparchive
    (
    ^1.0
    ).
  • The adapter caching support requires
    league/flysystem-cached-adapter
    (
    ^1.0
    ).
  • The eventable filesystem support requires
    league/flysystem-eventable-filesystem
    (
    ^1.0
    ).

Once installed, if you are not using automatic package discovery, then you need to register the

GrahamCampbell\Flysystem\FlysystemServiceProvider
service provider in your
config/app.php
.

You can also optionally alias our facade:

        'Flysystem' => GrahamCampbell\Flysystem\Facades\Flysystem::class,

Configuration

Laravel Flysystem requires connection configuration.

To get started, you'll need to publish all vendor assets:

$ php artisan vendor:publish

This will create a

config/flysystem.php
file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

There are three config options:

Default Connection Name

This option (

'default'
) is where you may specify which of the connections below you wish to use as your default connection for all work. Of course, you may use many connections at once using the manager class. The default value for this setting is
'local'
.
Flysystem Connections

This option (

'connections'
) is where each of the connections are setup for your application. Examples of configuring each supported driver are included in the config file, which you should have "published". You can of course have multiple connections per driver.
Flysystem Cache

This option (

'cache'
) is where each of the cache configurations setup for your application. There are currently two drivers: illuminate and adapter. Examples of configuration are included. You can of course have multiple connections per driver as shown.

Usage

FlysystemManager

This is the class of most interest. It is bound to the ioc container as

'flysystem'
and can be accessed using the
Facades\Flysystem
facade. This class implements the
ManagerInterface
by extending
AbstractManager
. The interface and abstract class are both part of my Laravel Manager package, so you may want to go and checkout the docs for how to use the manager class over at that repo. Note that the connection class returned will always be an instance of a class that implements
\League\Flysystem\FilesystemInterface
which will be
\League\Flysystem\Filesystem
by default.
Facades\Flysystem

This facade will dynamically pass static method calls to the

'flysystem'
object in the ioc container which by default is the
FlysystemManager
class.
FlysystemServiceProvider

This class contains no public methods of interest. This class should be added to the providers array in

config/app.php
. This class will setup ioc bindings.
Real Examples

Here you can see an example of just how simple this package is to use. Out of the box, the default adapter is

local
, and it will just work straight away:
use GrahamCampbell\Flysystem\Facades\Flysystem;
// you can alias this in config/app.php if you like

Flysystem::put('hi.txt', 'foo'); // we're done here - how easy was that, it just works!

Flysystem::read('hi.txt'); // this will return foo

The flysystem manager will behave like it is a

\League\Flysystem\Filesystem
class. If you want to call specific connections, you can do with the
connection
method:
use GrahamCampbell\Flysystem\Facades\Flysystem;

// note the foo connection does not ship with this package, it's hypothetical Flysystem::connection('foo')->put('test.txt', 'bar');

// now we can read that file Flysystem::connection('foo')->read('test.txt'); // this will return bar

With that in mind, note that:

use GrahamCampbell\Flysystem\Facades\Flysystem;

// writing this: Flysystem::connection('local')->read('test.txt');

// is identical to writing this: Flysystem::read('test.txt');

// and is also identical to writing this: Flysystem::connection()->read('test.txt');

// this is because the local connection is configured to be the default Flysystem::getDefaultConnection(); // this will return local

// we can change the default connection Flysystem::setDefaultConnection('foo'); // the default is now foo

If you prefer to use dependency injection over facades like me, then you can easily inject the manager like so:

use GrahamCampbell\Flysystem\FlysystemManager;
use Illuminate\Support\Facades\App; // you probably have this aliased already

class Foo { protected $flysystem;

public function __construct(FlysystemManager $flysystem)
{
    $this->flysystem = $flysystem;
}

public function bar()
{
    $this->flysystem->read('test.txt');
}

}

App::make('Foo')->bar();

For more information on how to use the

\League\Flysystem\Filesystem
class we are calling behind the scenes here, check out the docs at https://flysystem.thephpleague.com/docs/usage/filesystem-api/, and the manager class at https://github.com/GrahamCampbell/Laravel-Manager#usage.
Further Information

There are other classes in this package that are not documented here. This is because they are not intended for public use and are used internally by this package.

Security

If you discover a security vulnerability within this package, please send an email to [email protected] All security vulnerabilities will be promptly addressed. You may view our full security policy here.

License

Laravel Flysystem is licensed under The MIT License (MIT).

For Enterprise

Available as part of the Tidelift Subscription

The maintainers of

graham-campbell/flysystem
and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.