Download the PHP package socloz/gaufrette without Composer
On this page you can find all versions of the php package socloz/gaufrette. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download socloz/gaufrette
More information about socloz/gaufrette
Files in socloz/gaufrette
Package gaufrette
Short Description PHP5 library that provides a filesystem abstraction layer
License MIT
Homepage http://knplabs.com
Informations about the package gaufrette
Gaufrette
Gaufrette is a PHP5 library that provides a filesystem abstraction layer.
This project is under intensive development but we do not want to break BC.
Why use Gaufrette?
Imagine you have to manage a lot of medias in a PHP project. Lets see how to take this situation in your advantage using Gaufrette.
The filesystem abstraction layer permits you to develop your application without the need to know were all those medias will be stored and how.
Another advantage of this is the possibility to update the files location 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.
Try it!
Setup your filesystem
Following an example with the local filesystem adapter. To setup other adapters, look up the testcases.
Use the filesystem
Use file objects
Gaufrette also provide a File class that is a representation of files in a filesystem
Cache a slow filesystem
If you have to deal with a slow filesystem, it is out of question to use it directly. So, you need a cache! Happily, Gaufrette offers a cache system ready for use. It consist of an adapter itself composed of two adapters:
* The *source* adapter that should be cached
* The *cache* adapter that is used to cache
Here is an example of how to cache an ftp filesystem:
The third parameter of the cache adapter is the time to live of the cache.
Using Amazon S3
You will need to specify a CA certificate to be able to talk to Amazon servers
in https. You can use the one which is shipped with the SDK by defining before
creating the \AmazonS3
object:
Using OpenCloud
To use the OpenCloud adapter you will need to create a connection using the OpenCloud SDK. You can then fetch the ObjectStore which is required for the OpenCloud adapter.
OpenCloud
Rackspace
Rackspace uses a difference connection class
Using FTP adapters
Some FTP servers need valid configuration so Gaufrette can working with them as expected.
Pure Ftpd
To handle hidden files we need to configure it by:
Proftpd
To handle hidden files we need to change ListOptions
in proftpd configuration (at debian system /etc/proftpd/proftpd.conf
probably) to:
Using Gaufrette in a Symfony2 project
As you can see, Gaufrette provides an elegant way to declare your filesystems.
In your Symfony2 project, add to deps
:
and to app/autoload.php
, at the end:
And then, you can simply add them as services of your dependency injection container. As an example, here is services declaration to use Amazon S3:
Don't forget to set the constant to tell the AWS SDK to use its CA cert (somewhere
that will be executed before creating the \AmazonS3
object):
Streaming Files
Sometimes, you don't have the choice, you must get a streamable file URL (i.e to transform an image). Let's take a look at the following example:
Running the Tests
The tests use phpspec2 and PHPUnit.
Setup the vendor libraries
As some filesystem adapters use vendor libraries, you should install the vendors:
$ cd gaufrette
$ php composer.phar install --dev
$ sh bin/configure_test_env.sh
It will avoid skip a lot of tests.
Launch the Test Suite
In the Gaufrette root directory:
To check if classes specification pass: $ php bin/phpspec run
To check basic functionality of the adapters (adapters should be configured you will see many skipped tests): $ phpunit
Is it green?