Gaufrette Bundle
Provides a Gaufrette integration for your Symfony projects.
About Gaufrette
Gaufrette is a PHP library providing a filesystem abstraction layer.
This abstraction layer allows you to develop applications without needing to know where all their media files will be stored or how.
Documentation is available the official page of Gaufrette.
Installation
Prerequisites
As this bundle is an integration for Symfony of the Gaufrette library, it requires you to first install Gaufrette in your project.
Note that, you need to install separately the adapters you want to use. You can find more details about these packages here,
and the full list adapters on packagist.
With composer
composer require knplabs/knp-gaufrette-bundle
Register the bundle
You must register the bundle in your kernel:
return [
// ...
Knp\Bundle\GaufretteBundle\KnpGaufretteBundle::class => ['all' => true],
];
Configuration
The Gaufrette bundle allows you to declare your filesystems as services without having to reach into the famous "Service Container".
Indeed, you can do it with the configuration!
The configuration of the Gaufrette bundle is divided into two parts: the adapters and the filesystems.
Configuring the Adapters
# config/packages/knp_gaufrette.yaml
knp_gaufrette:
adapters:
foo:
local:
directory: /path/to/my/filesystem
The defined adapters are then used to create the filesystems.
You can use on of these adapters:
Configuring the Filesystems
# config/packages/knp_gaufrette.yaml
knp_gaufrette:
adapters:
# ...
filesystems:
bar:
adapter: foo
alias: foo_filesystem
Each defined filesystem must have an adapter with its value set to an adapter's key.
The filesystem defined above will result in a service with id gaufrette.bar_filesystem.
The alias parameter allows us to define an alias for it (foo_filesystem in this case).
The filesystem map
You can access all declared filesystems through the map service.
In the previous exemple, we declared a bar filesystem:
$container->get('knp_gaufrette.filesystem_map')->get('bar');
Returns the bar instance of Gaufrette\Filesystem.
Use cases
Check out basic examples of the library.
Maintainers