gs_fork_knplabs/gaufrette

PHP library that provides a filesystem abstraction layer

v0.5.0 2018-01-04 19:50 UTC

Requires

• php: >=5.6

Requires (Dev)

• akeneo/phpspec-skip-example-extension: ~1.2
• amazonwebservices/aws-sdk-for-php: 1.5.*
• aws/aws-sdk-php: ^2.4.12||~3
• doctrine/dbal: >=2.3
• dropbox-php/dropbox-php: *
• google/apiclient: ~1.1.3
• league/flysystem: ~1.0
• microsoft/azure-storage: ~0.15.0
• microsoft/windowsazure: ~0.4
• mikey179/vfsstream: ~1.2.0
• mongodb/mongodb: ^1.1
• phpseclib/phpseclib: ^2.0
• phpspec/phpspec: ~2.4
• phpunit/phpunit: ^5.6.8
• rackspace/php-opencloud: ^1.9.2

Suggests

• ext-curl: *
• ext-fileinfo: This extension is used to automatically detect the content-type of a file in the AwsS3, OpenCloud, AzureBlogStorage and GoogleCloudStorage adapters
• ext-mbstring: *
• gaufrette/aws-s3-adapter: to use AwsS3 adapter (supports SDK v2 and v3)
• gaufrette/azure-blob-storage-adapter: to use AzureBlobStorage adapter
• gaufrette/doctrine-dbal-adapter: to use DBAL adapter
• gaufrette/flysystem-adapter: to use Flysystem adapter
• gaufrette/ftp-adapter: to use Ftp adapter
• gaufrette/gridfs-adapter: to use GridFS adapter
• gaufrette/in-memory-adapter: to use InMemory adapter
• gaufrette/local-adapter: to use Local adapter
• gaufrette/opencloud-adapter: to use Opencloud adapter
• gaufrette/phpseclib-sftp-adapter: to use PhpseclibSftp adapter
• gaufrette/zip-adapter: to use Zip adapter
• google/apiclient: to use GoogleCloudStorage adapter
• knplabs/knp-gaufrette-bundle: to use with Symfony2

Conflicts

• microsoft/windowsazure: <0.4.3

MIT

• The contributors
• KnpLabs Team

• media
• file
• filesystem
• abstraction

README

Gaufrette provides a filesystem abstraction layer.

Why use Gaufrette?

Imagine you have to manage a lot of medias in a PHP project. Lets see how to take this situation in your advantage using Gaufrette.

The filesystem abstraction layer permits you to develop your application without the need to know where all those medias will be stored and how.

Another advantage of this is the possibility to update the files location without any impact on the code apart from the definition of your filesystem. In example, if your project grows up very fast and if your server reaches its limits, you can easily move your medias in an Amazon S3 server or any other solution.

Documentation

Read the official Gaufrette documentation.

Metapackages for adapters

Every maintained adapter now have a dedicated metapackage. You can find the list on packagist. We highly recommend you to use them as they contain their own requirements: you don't need to worry about third-party dependencies to install before using Gaufrette anymore.

Symfony integration

Symfony integration is available through KnpLabs/KnpGaufretteBundle.

Maintainers

Here is the list of dedicated maintainer(s) for every adapter not deprecated. If you don't receive any response to your issue or pull request in a timely manner, ping us:

Adapter	Referent
AwsS3	@NiR-
AzureBlobStorage	@NiR-
DoctrineDbal	@pedrotroller, @NicolasNSSM
Flysystem	@nicolasmure
Ftp	@fabschurt
GoogleCloudStorage	@AntoineLelaisant
GridFS	@NiR-
InMemory
Local
OpenCloud	@NiR-
PhpseclibSftp	@fabschurt
Zip

For InMemory, Local and Zip adapters everyone in this list is considered as a maintainer.

Launch the Test Suite

Requires:

• docker
• docker-compose

Build images:

$ docker-compose build

Launch the tests:

$ bin/tests-all

Is it green?

Note

This project does not have any stable release yet but we do not want to break BC now.