kphoen/gaufrette-extras

PHP5 library that provides extra components for Gaufrette

Installs: 1 471

Dependents: 1

Stars: 8

Watchers: 2

Language: PHP

1.0.0 2014-04-20 03:28 UTC

README

Gaufrette Exras is a PHP library providing extra features to the awesome Gaufrette.

Installation

The recommended way to install this library is through composer.

Just create a composer.json file for your project:

{
    "require": {
        "kphoen/gaufrette-extras": "~1.0"
    }
}

And run these two commands to install it:

$ wget http://getcomposer.org/composer.phar
$ php composer.phar install

Now you can add the autoloader, and you will have access to the library:

require 'vendor/autoload.php';

Features

URL resolvers

Resolvers provide a quick and easy way to resolve filesystem entries to a URL.

$resolver = new PrefixResolver('http://www.my-website.com/uploads');
$adapter = new ResolvableAdapter(new LocalAdapter('/tmp'), $resolver);
$filesystem = new ResolvableFilesystem($adapter);

$filesystem->write('myFile.txt', 'Hello I am the new content');

var_dump($filesystem->resolve('myFile.txt')); // 'http://www.my-website.com/uploads/myFile.txt'

Tests

To run unit tests, you'll need cURL and a set of dependencies you can install using Composer:

php composer.phar install

Once installed, just launch the following command:

./vendor/bin/phpunit

License

This library is released under the MIT license. See the bundled LICENSE file for details.