Code Monkey home page Code Monkey logo

laravel-flysystem's Introduction

Laravel Flysystem

Bitdeli Badge Build Status Coverage Status Scrutinizer Quality Score SensioLabsInsight Software License Latest Version

What Is Laravel Flysystem?

Laravel Flysystem is a Flysystem bridge for Laravel 4.1.

System Requirements

  • 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.

Installation

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'

Configuration

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.

Usage

There is currently no usage documentation besides the API Documentation for Laravel Flysystem.

You may see an example of implementation in CMS Core.

Updating Your Fork

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>.

Pull Requests

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.

License

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.

laravel-flysystem's People

Contributors

grahamcampbell avatar

Watchers

James Cloos avatar chuandadexiaoyu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.