mkurzeja/image-bundle

Image handling bundle

Gregwar's ImageBundle

GregwarImageBundle provides easy Image manipulation and API for Symfony2 and Twig, _(*1)

Installation

Step 1: Download the GregwarImageBundle

Using the vendors script, _(*2)

Add the following lines to your deps file:, _(*3)

    [GregwarImageBundle]
        git=http://github.com/Gregwar/ImageBundle.git
        target=/bundles/Gregwar/ImageBundle

Now, run the vendors script to download the bundle:, _(*4)

``` bash $ php bin/vendors install, <sub>(*5)</sub>

***Using submodules***

If you prefer instead to use git submodules, then run the following:

``` bash
$ git submodule add git://github.com/Gregwar/ImageBundle.git vendor/bundles/Gregwar/ImageBundle
$ git submodule update --init

Using Composer, <sub>(*6)</sub>

Add the following to the "require" section of your composer.json file:, <sub>(*7)</sub>

    "gregwar/image-bundle": "dev-master"

You can also choose a version number, (tag, commit ...), <sub>(*8)</sub>

And update your dependencies, <sub>(*9)</sub>

    php composer.phar update

Step 2: Configure the Autoloader

If you use composer, you can skip this step., <sub>(*10)</sub>

Add it to your autoload.pp :, <sub>(*11)</sub>

<?php
...
'Gregwar' => __DIR__.'/../vendor/bundles',

Step 3: Enable the bundle

Registers the bundle in your app/AppKernel.php:, <sub>(*12)</sub>

<?php
...
public function registerBundles()
{
    $bundles = array(
        ...
        new Gregwar\ImageBundle\GregwarImageBundle(),
        ...
    );
...

Step 4: Configure the bundle and set up the directories

Adds the following configuration to your app/config/config.yml:, <sub>(*13)</sub>

gregwar_image: ~

If you want to customize the cache directory name, you can specify it:, <sub>(*14)</sub>

gregwar_image:
    cache_dir:  my_cache_dir

Creates the cache directory and change the permissions so the web server can write in it:, <sub>(*15)</sub>

mkdir web/cache
chmod 777 web/cache

You can also disable the exception thrown if the given file does not exist:, <sub>(*16)</sub>

gregwar_image:
    throw_exception: false

Usage

Basics

This bundle is based on the Gregwar's Image class and provides simple but powerful Twig extension. You can for instance use it this way:, <sub>(*17)</sub>

<img src="{{ image('linux.jpg').resize(100,100).negate }}" />

And that's all ! The helper will automatically create the cached file on-the-fly if it doesn't exists yet., <sub>(*18)</sub>

The available methods are the same as the Gregwar's Image., <sub>(*19)</sub>

You can also use the logical file names for bundle resources :, <sub>(*20)</sub>

<img src="{{ image('@AcmeDemoBundle/Resources/images/linux.jpg').resize(100,100).negate }}" />

Using Image API

The image instance provides also a simple API, you can call some methods to get informations about the handled image:, <sub>(*21)</sub>

Image width: {{ image('linux.jpg').width }}px

Manipulating Image in Controllers

The Image Handler is accessible via a service called image.handling. So you can do in your controllers:, <sub>(*22)</sub>

<?php
...
$this->get('image.handling')->open('linux.jpg')
    ->grayscale()
    ->rotate(12)
    ->save('out.jpg')

Requirements

GregwarImageBundle needs GD and exif extension for PHP to be installed on the web server, <sub>(*23)</sub>

License

This bundle is under MIT license, <sub>(*24)</sub>