gregwar / image-bundle
Image handling bundle
Installs: 1 335 988
Dependents: 10
Suggesters: 0
Security: 0
Stars: 195
Watchers: 14
Forks: 50
Open Issues: 34
Type:symfony-bundle
Requires
- php: >=5.3.3
- ext-gd: *
- gregwar/image: 2.*
- symfony/asset: *
- symfony/framework-bundle: ^2.3 || ^3.0 || ^4.0 || ^5.0 || ^6.0
- twig/twig: ^2.0 || ^3.0
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-21 01:39:22 UTC
README
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 class and provides simple but powerful Twig extension. You can for instance use it this way:
<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.
The available methods are the same as the Gregwar's Image.
You can also use the logical file names for bundle resources :
<img src="{{ image('@AcmeDemoBundle/Resources/images/linux.jpg').resize(100,100).negate }}" />
If you use web_image()
helper, the image file path will be prefixed by the web/
absolute
directory of your application:
<!-- The image some/image.jpg will be prefixed by web directory prefix --> <img src="{{ web_image('some/image.jpg').resize('10%') }}" />
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 ... $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
License
This bundle is under MIT license