https://github.com/gregwar/imagebundle

Image manipulation bundle for Symfony 2
https://github.com/gregwar/imagebundle

Last synced: about 1 year ago
JSON representation

Image manipulation bundle for Symfony 2

• Host: GitHub
• URL: https://github.com/gregwar/imagebundle
• Owner: Gregwar
• License: mit
• Created: 2011-08-02T19:36:45.000Z (almost 15 years ago)
• Default Branch: master
• Last Pushed: 2023-04-26T11:20:37.000Z (about 3 years ago)
• Last Synced: 2025-04-30T07:11:53.842Z (about 1 year ago)
• Language: PHP
• Homepage:
• Size: 95.7 KB
• Stars: 196
• Watchers: 13
• Forks: 50
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Gregwar's ImageBundle

=====================

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YUXRLWHQSWS6L)

`GregwarImageBundle` provides easy Image manipulation and API for Symfony and Twig

If you use older version than Symfony 4, please use the `2.*` version, else you can

use `3.*`.

Installation

============

### Step 1: Download the GregwarImageBundle

Run the following composer command:

```

    composer req gregwar/image-bundle

```

### Step 2: Configure the bundle and set up the directories

Adds the following configuration to your `app/config/config.yml`:

    gregwar_image: ~

If you want to customize the cache directory name, you can specify it:

    gregwar_image:

        cache_dir:  my_cache_dir

Creates the cache directory and change the permissions so the web server can write

in it:

    mkdir web/cache

    chmod 777 web/cache

You can also enable the exception thrown if the given file does not exist:

    gregwar_image:

        throw_exception: true

If you don't throw an exception, you can set the `fallback_image`, to set the

image that should be rendered in this case:

    gregwar_image:

        fallback_image: /path/to/your/fallback.jpg

If you have to change directories hierarchy or Web's name (e.g. web => public_html), 

you can set the `web_dir` to your new Web path:

    

    gregwar_image:

        web_dir: %kernel.root_dir%/../../public_html

With Symfony Flex

-----------------

With Symfony Flex architecture, you can create the ``config/packages/gregwar_image.yaml``

file with the following contents:

    

    gregwar_image:

        web_dir: %kernel.root_dir%/../public

Usage

=====

Basics

------

This bundle is based on the [Gregwar's Image](http://github.com/Gregwar/Image) class and

provides simple but powerful Twig extension. You can for instance use it this way:

```html



```

And that's all ! The helper will automatically create the cached file on-the-fly if it

doesn't exists yet.

The available methods are the same as the [Gregwar's Image](http://github.com/Gregwar/Image).

You can also use the logical file names for bundle resources :

```html



```

If you use `web_image()` helper, the image file path will be prefixed by the `web/` absolute

directory of your application:

```html



```

Using Image API

---------------

The image instance provides also a simple API, you can call some methods to get informations

about the handled image:

    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:

```php

get('image.handling')->open('linux.jpg')

    ->grayscale()

    ->rotate(12)

    ->save('out.jpg')

```

Requirements

============

`GregwarImageBundle` needs [GD](http://php.net/gd)

and [exif](http://php.net/exif) extension for PHP to be installed on the web server

License

=======

This bundle is under MIT license