Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knplabs/gaufrette
PHP library that provides a filesystem abstraction layer − will be a feast for your files!
https://github.com/knplabs/gaufrette
filesystem gaufrette hacktoberfest php
Last synced: about 1 month ago
JSON representation
PHP library that provides a filesystem abstraction layer − will be a feast for your files!
- Host: GitHub
- URL: https://github.com/knplabs/gaufrette
- Owner: KnpLabs
- License: mit
- Created: 2011-01-18T17:02:25.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T09:53:34.000Z (9 months ago)
- Last Synced: 2024-05-01T23:06:35.559Z (7 months ago)
- Topics: filesystem, gaufrette, hacktoberfest, php
- Language: PHP
- Homepage: http://knplabs.github.io/Gaufrette
- Size: 2.25 MB
- Stars: 2,467
- Watchers: 75
- Forks: 354
- Open Issues: 87
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Gaufrette
=========
[](https://stand-with-ukraine.pp.ua)
Gaufrette provides a filesystem abstraction layer.
[](https://github.com/KnpLabs/Gaufrette/actions)
[](https://scrutinizer-ci.com/g/KnpLabs/Gaufrette)
[](https://packagist.org/packages/KnpLabs/Gaufrette)
[](https://packagist.org/packages/KnpLabs/Gaufrette)
[](LICENSE)
[](https://gitter.im/KnpLabs/Gaufrette)
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.
The filesystem abstraction layer permits you to develop your application without
the need to know where all those media will be stored and how.
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.
### Documentation
Read the official [Gaufrette documentation](http://knplabs.github.io/Gaufrette/).
### Metapackages for adapters
Every maintained adapter now has a dedicated metapackage. You can [find the list on packagist](https://packagist.org/packages/gaufrette/).
**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](https://github.com/KnpLabs/KnpGaufretteBundle).
### 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:
| 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.
### Development
Requires :
* docker-ce
* docker-compose
1) Create `.env` file :
```bash
$ make docker.dev
```
and configure it as you want.
2) Build the PHP docker image :
```bash
$ make docker.build
```
3) Install dependencies :
```bash
$ make docker.all-deps
```
4) Run tests :
```bash
$ 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](https://serverpilot.io/docs/how-to-install-the-php-ssh2-extension))
See the [`docker-compose.yml`](/docker-compose.yml) file for more details.
You'll need to clear the previously installed dependencies when switching from
one version to an other. To do so, run :
```bash
$ make clear-deps
$ PHP_VERSION= make build install-deps
```
5) Apply Coding Standards
You should check for CS violations by using
```bash
$ make php-cs-compare
```
and fix them with
```bash
$ make php-cs-fix
```
### Note
This project does not have any stable release yet but we do not want to break BC now.