{"id":15029677,"url":"https://github.com/knplabs/gaufrette","last_synced_at":"2025-05-13T17:14:43.462Z","repository":{"id":41413322,"uuid":"1267753","full_name":"KnpLabs/Gaufrette","owner":"KnpLabs","description":"PHP library that provides a filesystem abstraction layer − will be a feast for your files!","archived":false,"fork":false,"pushed_at":"2024-02-27T09:53:34.000Z","size":2357,"stargazers_count":2470,"open_issues_count":86,"forks_count":357,"subscribers_count":72,"default_branch":"master","last_synced_at":"2025-05-03T03:07:58.505Z","etag":null,"topics":["filesystem","gaufrette","hacktoberfest","php"],"latest_commit_sha":null,"homepage":"http://knplabs.github.io/Gaufrette","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KnpLabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2011-01-18T17:02:25.000Z","updated_at":"2025-04-28T13:55:53.000Z","dependencies_parsed_at":"2022-08-22T20:31:08.436Z","dependency_job_id":"748481d9-0a72-45ae-974f-90f666f5b83b","html_url":"https://github.com/KnpLabs/Gaufrette","commit_stats":{"total_commits":791,"total_committers":159,"mean_commits":"4.9748427672955975","dds":0.8508217446270544,"last_synced_commit":"3cc396cae0f7c7d3f965e6b69d8fc546ffa0f94c"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KnpLabs%2FGaufrette","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KnpLabs%2FGaufrette/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KnpLabs%2FGaufrette/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KnpLabs%2FGaufrette/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KnpLabs","download_url":"https://codeload.github.com/KnpLabs/Gaufrette/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253990500,"owners_count":21995776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filesystem","gaufrette","hacktoberfest","php"],"created_at":"2024-09-24T20:11:20.375Z","updated_at":"2025-05-13T17:14:38.452Z","avatar_url":"https://github.com/KnpLabs.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Gaufrette\n=========\n\n[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua)\n\n\nGaufrette provides a filesystem abstraction layer.\n\n[![Build Status](https://github.com/KnpLabs/Gaufrette/actions/workflows/ci.yml/badge.svg)](https://github.com/KnpLabs/Gaufrette/actions)\n[![Quality Score](https://img.shields.io/scrutinizer/g/KnpLabs/Gaufrette.svg?style=flat-square)](https://scrutinizer-ci.com/g/KnpLabs/Gaufrette)\n[![Packagist Version](https://img.shields.io/packagist/v/KnpLabs/Gaufrette.svg?style=flat-square)](https://packagist.org/packages/KnpLabs/Gaufrette)\n[![Total Downloads](https://img.shields.io/packagist/dt/KnpLabs/Gaufrette.svg?style=flat-square)](https://packagist.org/packages/KnpLabs/Gaufrette)\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)\n[![Join the chat at Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/KnpLabs/Gaufrette)\n\nWhy use Gaufrette?\n------------------\n\nImagine you have to manage a lot of media in a PHP project. Let's see how to\ntake this situation to your advantage using Gaufrette.\n\nThe filesystem abstraction layer permits you to develop your application without\nthe need to know where all those media will be stored and how.\n\nAnother advantage of this is the possibility to update the location of the files\nwithout any impact on the code apart from the definition of your filesystem.\nIn example, if your project grows up very fast and if your server reaches its\nlimits, you can easily move your medias in an Amazon S3 server or any other\nsolution.\n\n### Documentation\n\nRead the official [Gaufrette documentation](http://knplabs.github.io/Gaufrette/).\n\n### Metapackages for adapters\n\nEvery maintained adapter now has a dedicated metapackage. You can [find the list on packagist](https://packagist.org/packages/gaufrette/).\n**We highly recommend you to use them as they contain their own requirements**: you don't need to worry about third-party dependencies\nto install before using Gaufrette anymore.\n\n### Symfony integration\n\nSymfony integration is available through [KnpLabs/KnpGaufretteBundle](https://github.com/KnpLabs/KnpGaufretteBundle).\n\n### Maintainers\n\nHere is the list of the dedicated maintainer(s) for every adapter not deprecated. If you don't receive any response to\nyour issue or pull request in a timely manner, ping us:\n\n| Adapter            | Referent                    |\n|--------------------|-----------------------------|\n| AsyncAws S3        | @Nyholm                     |\n| AwsS3              | @NiR-                       |\n| AzureBlobStorage   | @NiR-                       |\n| DoctrineDbal       | @pedrotroller, @NicolasNSSM |\n| Flysystem          | @nicolasmure                |\n| Ftp                | @fabschurt                  |\n| GoogleCloudStorage | @AntoineLelaisant           |\n| GridFS             | @NiR-                       |\n| InMemory           |                             |\n| Local              |                             |\n| OpenCloud          | @NiR-                       |\n| PhpseclibSftp      | @fabschurt                  |\n| Zip                |                             |\n\nFor `InMemory`, `Local`, and `Zip` adapters everyone in this list is considered as a maintainer.\n\n### Development\n\nRequires :\n  * docker-ce\n  * docker-compose\n\n1) Create `.env` file :\n```bash\n$ make docker.dev\n```\nand configure it as you want.\n\n2) Build the PHP docker image :\n```bash\n$ make docker.build\n```\n\n3) Install dependencies :\n```bash\n$ make docker.all-deps\n```\n\n4) Run tests :\n```bash\n$ make docker.tests\n```\n\nYou can also use a different php version, simply set the `PHP_VERSION` env var\nto any of these values when calling a make target :\n- `7.1`\n- `7.2` (default)\n- `7.3` (The docker setup for PHP 7.3 is available. However, the ssh2 extension\nis not installed [as it is not available for PHP 7.3 yet](https://serverpilot.io/docs/how-to-install-the-php-ssh2-extension))\n\nSee the [`docker-compose.yml`](/docker-compose.yml) file for more details.\n\nYou'll need to clear the previously installed dependencies when switching from\none version to an other. To do so, run :\n```bash\n$ make clear-deps\n$ PHP_VERSION=\u003cthe_version_you_want_to_use\u003e make build install-deps\n```\n\n5) Apply Coding Standards\n\nYou should check for CS violations by using\n```bash\n$ make php-cs-compare\n```\nand fix them with \n```bash\n$ make php-cs-fix\n```\n\n### Note\n\nThis project does not have any stable release yet but we do not want to break BC now.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknplabs%2Fgaufrette","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fknplabs%2Fgaufrette","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknplabs%2Fgaufrette/lists"}