PHPackages icyboy/flysystem - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. icyboy/flysystem ActiveLibrary[Framework](/categories/framework) icyboy/flysystem ================ Flysystem Is A Flysystem Bridge For Laravel 5 3.5.3(7y ago)0272MITPHPPHP >=5.5.9 Since Dec 6Pushed 7y ago1 watchersCompare [ Source](https://github.com/icyxp/Laravel-Flysystem)[ Packagist](https://packagist.org/packages/icyboy/flysystem)[ RSS](/packages/icyboy-flysystem/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (1)Dependencies (19)Versions (4)Used By (0) Laravel Flysystem ================= [](#laravel-flysystem) Installation ------------ [](#installation) Either [PHP](https://php.net) 5.5+ or [HHVM](http://hhvm.com) 3.6+ are required. To get the latest version of Laravel FLysystem, simply require the project using [Composer](https://getcomposer.org): ``` $ composer require icyboy/flysystem ``` Instead, you may of course manually update your require block and run `composer update` if you so choose: ``` { "require": { "icyboy/flysystem": "^3.0" } } ``` 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"` in your `composer.json`. - The Azure adapter requires `"league/flysystem-azure": "^1.0"` in your `composer.json`. - The Copy adapter requires `"league/flysystem-copy": "^1.0"` in your `composer.json`. - The Dropbox adapter requires `"league/flysystem-dropbox": "^1.0"` in your `composer.json`. - The GridFS adapter requires `"league/flysystem-gridfs": "^1.0"` in your `composer.json`. - The Rackspace adapter requires `"league/flysystem-rackspace": "^1.0"` in your `composer.json`. - The Sftp adapter requires `"league/flysystem-sftp": "^1.0"` in your `composer.json`. - The WebDav adapter requires `"league/flysystem-webdav": "^1.0"` in your `composer.json`. - The ZipAdapter adapter requires `"league/flysystem-ziparchive": "^1.0"` in your `composer.json`. - The adapter caching support requires `"league/flysystem-cached-adapter": "^1.0"` in your `composer.json`. - The eventable filesystem support requires `"league/flysystem-eventable-filesystem": "^1.0"` in your `composer.json`. Once Laravel Flysystem is installed, you need to register the service provider. Open up `config/app.php` and add the following to the `providers` key. - `'Icyboy\Flysystem\FlysystemServiceProvider'` You can register the Flysystem facade in the `aliases` key of your `config/app.php` file if you like. - `'Flysystem' => 'Icyboy\Flysystem\Facades\Flysystem'` Configuration ------------- [](#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 [](#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 [](#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. You can of course have multiple connections per driver. ##### Flysystem Cache [](#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 ----- [](#usage) ##### FlysystemManager [](#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](https://github.com/Icyxp/Laravel-Manager) package, so you may want to go and checkout the docs for how to use the manager class over at [that repo](https://github.com/Icyxp/Laravel-Manager#usage). 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 [](#facadesflysystem) This facade will dynamically pass static method calls to the `'flysystem'` object in the ioc container which by default is the `FlysystemManager` class. ##### FlysystemServiceProvider [](#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 [](#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 Icyboy\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 Icyboy\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 Icyboy\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 Icyboy\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 , and the manager class at . ##### Further Information [](#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 -------- [](#security) If you discover a security vulnerability within this package, please send an e-mail to Graham Campbell at . All security vulnerabilities will be promptly addressed. License ------- [](#license) Laravel Flysystem is licensed under [The MIT License (MIT)](LICENSE). ### Health Score 27 — LowBetter than 49% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity60 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~376 days Total 3 Last Release 2695d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/5b20dab04484e08344c406587bd252bd8dbfaa1ed672f2555f1770c712c238b1?d=identicon)[icyboy](/maintainers/icyboy) --- Top Contributors [![icyxp](https://avatars.githubusercontent.com/u/1527903?v=4)](https://github.com/icyxp "icyxp (6 commits)") --- Tags Flysystemframeworklaravels3awsfilesGraham CampbelldropboxLaravel Flysystemicyboy ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/icyboy-flysystem/health.svg) ``` [![Health](https://phpackages.com/badges/icyboy-flysystem/health.svg)](https://phpackages.com/packages/icyboy-flysystem) ``` ### Alternatives [graham-campbell/markdown Markdown Is A CommonMark Wrapper For Laravel 1.3k7.1M64](/packages/graham-campbell-markdown)[laravel-zero/framework The Laravel Zero Framework. 3371.4M369](/packages/laravel-zero-framework)[graham-campbell/manager Manager Provides Some Manager Functionality For Laravel 39221.1M134](/packages/graham-campbell-manager)[graham-campbell/throttle Throttle Is A Rate Limiter For Laravel 7102.3M11](/packages/graham-campbell-throttle)[graham-campbell/github GitHub Is A GitHub Bridge For Laravel 6411.7M19](/packages/graham-campbell-github)[graham-campbell/digitalocean DigitalOcean Is A DigitalOcean Bridge For Laravel 509343.1k2](/packages/graham-campbell-digitalocean) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)