2017 © Pedro PelĂĄez
 

library gaufrette

PHP library that provides a filesystem abstraction layer

image

knplabs/gaufrette

PHP library that provides a filesystem abstraction layer

  • Tuesday, May 29, 2018
  • by Knplabs
  • Repository
  • 79 Watchers
  • 1997 Stars
  • 6,831,185 Installations
  • PHP
  • 138 Dependents
  • 19 Suggesters
  • 333 Forks
  • 80 Open issues
  • 33 Versions
  • 6 % Grown

The README.md

Gaufrette

Stand With Ukraine, (*1)

Gaufrette provides a filesystem abstraction layer., (*2)

Build Status Quality Score Packagist Version Total Downloads Software License Join the chat at Gitter, (*3)

Why use Gaufrette?

Imagine you have to manage a lot of media in a PHP project. Let's see how to take this situation to your advantage using Gaufrette., (*4)

The filesystem abstraction layer permits you to develop your application without the need to know where all those media will be stored and how., (*5)

Another advantage of this is the possibility to update the location of the files 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., (*6)

Documentation

Read the official Gaufrette documentation., (*7)

Metapackages for adapters

Every maintained adapter now has 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., (*8)

Symfony integration

Symfony integration is available through KnpLabs/KnpGaufretteBundle., (*9)

Maintainers

Here is the list of the 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:, (*10)

Adapter Referent
AsyncAws S3 @Nyholm
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., (*11)

Development

Requires : * docker-ce * docker-compose, (*12)

1) Create .env file :, (*13)

$ make docker.dev

and configure it as you want., (*14)

2) Build the PHP docker image :, (*15)

$ make docker.build

3) Install dependencies :, (*16)

$ make docker.all-deps

4) Run tests :, (*17)

$ make docker.tests

You can also use a different php version, simply set the PHP_VERSION env var to any of these values when calling a make target : - 7.1 - 7.2 (default) - 7.3 (The docker setup for PHP 7.3 is available. However, the ssh2 extension is not installed as it is not available for PHP 7.3 yet), (*18)

See the docker-compose.yml file for more details., (*19)

You'll need to clear the previously installed dependencies when switching from one version to an other. To do so, run :, (*20)

$ make clear-deps
$ PHP_VERSION=<the_version_you_want_to_use> make build install-deps

5) Apply Coding Standards, (*21)

You should check for CS violations by using, (*22)

$ make php-cs-compare

and fix them with, (*23)

$ make php-cs-fix

Note

This project does not have any stable release yet but we do not want to break BC now., (*24)

The Versions

24/05 2017

dev-feature/better-documentation

dev-feature/better-documentation http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.2

 

The Development Requires

file filesystem media abstraction

31/03 2017
24/02 2014
27/06 2013

v0.1.5

0.1.5.0 http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.2

 

The Development Requires

file filesystem media abstraction

01/03 2013

dev-develop

dev-develop http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.2

 

The Development Requires

file filesystem media abstraction

19/02 2013

dev-feature/file-metadata-refactoring

dev-feature/file-metadata-refactoring http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.2

 

The Development Requires

file filesystem media abstraction

25/01 2013

v0.1.4

0.1.4.0 http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.2

 

The Development Requires

file filesystem media abstraction

15/10 2012

v0.1.3

0.1.3.0 http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

file filesystem media abstraction

20/09 2012

v0.1.2

0.1.2.0 http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

file filesystem media abstraction

18/09 2012

v0.1.1

0.1.1.0 http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

file filesystem media abstraction

15/04 2012

v0.1

0.1.0.0 http://knplabs.com

PHP5 library that provides a filesystem abstraction layer

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

file filesystem media abstraction