3.6 KiB
Gaufrette Bundle
Provides a Gaufrette integration for your Symfony projects.
About Gaufrette
Gaufrette is a PHP 5.3+ 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 a Symfony project.
With composer
This bundle can be installed using composer by adding the following in the require
section of your composer.json
file:
"require": {
...
"knplabs/knp-gaufrette-bundle": "~0.3"
},
Register the bundle
You must register the bundle in your kernel:
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new Knp\Bundle\GaufretteBundle\KnpGaufretteBundle()
);
// ...
}
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
# app/config/config.yml
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:
- Local Adapter
- Safe Local Adapter
- Service
- In Memory
- Azure Blob Storage
- GridFS
- MogileFS
- Ftp
- Sftp
- Phpseclib Sftp
- Apc
- Amazon S3
- AwsS3
- Open Cloud
- GoogleCloudStorage
- Cache
- Stream Wrapper
- Doctrine DBAL
- Dropbox
Configuring the Filesystems
# app/config/config.yml
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
.