Laravel Flysystem is a Flysystem bridge for Laravel 4.1.
- Laravel Flysystem was created by, and is maintained by Graham Campbell.
- Laravel Flysystem relies on Frank de Jonge's Flysystem package.
- Laravel Flysystem uses Travis CI with Coveralls to check everything is working.
- Laravel Flysystem uses Scrutinizer CI and SensioLabsInsight to run additional checks.
- Laravel Flysystem uses Composer to load and manage dependencies.
- Laravel Flysystem provides a change log, releases, and api docs.
- Laravel Flysystem is licensed under the Apache License, available here.
- PHP 5.4.7+ or PHP 5.5+ is required.
- You will need Laravel 4.1 because this package is designed for it.
- You will need Composer installed to load the dependencies of Laravel Flysystem.
Please check the system requirements before installing Laravel Flysystem.
To get the latest version of Laravel Flysystem, simply require it in your composer.json
file.
"graham-campbell/flysystem": "*"
You'll then need to run composer install
or composer update
to download it and have the autoloader updated.
Once Laravel Flysystem is installed, you need to register the service provider. Open up app/config/app.php
and add the following to the providers
key.
'GrahamCampbell\Flysystem\FlysystemServiceProvider'
You can register the Flysystem facade in the aliases
key of your app/config/app.php
file if you like.
'Flysystem' => 'GrahamCampbell\Flysystem\Facades\Flysystem'
Laravel Flysystem requires connection configuration.
To get started, first publish the package config file:
php artisan config:publish graham-campbell/flysystem
There are two 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. You can of course have multiple connections per driver.
There is currently no usage documentation besides the API Documentation for Laravel Flysystem.
You may see an example of implementation in CMS Core.
Before submitting a pull request, you should ensure that your fork is up to date.
You may fork Laravel Flysystem:
git remote add upstream git://github.com/GrahamCampbell/Laravel-Flysystem.git
The first command is only necessary the first time. If you have issues merging, you will need to get a merge tool such as P4Merge.
You can then update the branch:
git pull --rebase upstream master
git push --force origin <branch_name>
Once it is set up, run git mergetool
. Once all conflicts are fixed, run git rebase --continue
, and git push --force origin <branch_name>
.
Please review these guidelines before submitting any pull requests.
- When submitting bug fixes, check if a maintenance branch exists for an older series, then pull against that older branch if the bug is present in it.
- Before sending a pull request for a new feature, you should first create an issue with [Proposal] in the title.
- Please follow the PSR-2 Coding Style and PHP-FIG Naming Conventions.
Apache License
Copyright 2014 Graham Campbell
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.