Configuration
The default configuration for the bundle looks like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
# app/config/config.yml
liip_imagine:
resolvers:
default:
web_path:
web_root: ~ # %kernel.project_dir%/public (%kernel.project_dir%/web for Symfony < 4.0.0)
cache_prefix: ~ # media/cache
loaders:
default:
filesystem:
data_root: ~ # %kernel.project_dir%/public (%kernel.project_dir%/web for Symfony < 4.0.0)
driver: gd
cache: default
data_loader: default
default_image: null
twig:
mode: legacy
default_filter_set_settings:
quality: 100
jpeg_quality: ~
png_compression_level: ~
png_compression_filter: ~
animated: false
format: ~
cache: ~
data_loader: ~
default_image: null
filters: []
post_processors: []
controller:
filter_action: liip_imagine.controller::filterAction
filter_runtime_action: liip_imagine.controller::filterRuntimeAction
redirect_response_code: 302
webp:
generate: false
quality: 100
cache: ~
data_loader: ~
post_processors: []
filter_sets:
# Prototype
name:
quality: 100
jpeg_quality: ~
png_compression_level: ~
png_compression_filter: ~
animated: false
format: ~
cache: ~
data_loader: ~
default_image: null
filters:
# Prototype
name: []
post_processors:
# Prototype
name: []
There are several configuration options available:
cache
- default cache resolver. Default value:web_path
(which means the standard web_path resolver is used)data_loader
- name of a custom data loader. Default value:filesystem
(which means the standard filesystem loader is used).twig.mode
- Twig filter integration.none
disables the twig filters,lazy
enables Twig using the Twig runtime for lazy loading. The default value islegacy
and enables the old Twig integration that is loaded on each request. Version 3 will droplegacy
and default tolazy
. The twig filter automatically picks up theframework.assets.version
configuration. You can overwrite the version with thetwig.assets_version
option. See Asset Versioning for more information.controller
-
filter_action
- name of the controller action to use in the route loader. Default value:liip_imagine.controller:filterAction
filter_runtime_action
- name of the controller action to use in the route loader for runtimeconfig images. Default value:liip_imagine.controller:filterRuntimeAction
redirect_response_code
- The HTTP redirect response code to return from the imagine controller, one of201
,301
,302
,303
,307
, or308
. Default value:302
See Avoid unnecessary redirects if you want to change this configuration.
webp
-
generate
- enabling the generation a copy of the image in the WebP format.quality
- override the quality from filter option.cache
- default cache resolver. Default value:web_path
(which means the standard web_path resolver is used)data_loader
- name of a custom data loader. Default value:filesystem
(which means the standard filesystem loader is used).post_processors
- sets post-processors to be applied on filtered image (see Post-Processors section in the filters chapter for details).
driver
- one of the drivers:gd
,imagick
,gmagick
,vips
. Default value:gd
* If you want to use vips, you need to additionally requirerokka/imagine-vips
default_filter_set_settings
- specify the default values that will be inherit for any set defined infilter_sets
. These values will be overridden if they are specified in the each set. In case offilters
andpost_processors
, the specified values will be merged with the default ones.filter_sets
- specify the filter sets that you want to define and use.
Each filter set that you specify has the following options:
filters
- determine the type of filter to be used (refer to Filters section for more information) and options that should be passed to the specific filter type.post_processors
- sets post-processors to be applied on filtered image (see Post-Processors section in the filters chapter for details).jpeg_quality
- override the quality for jpeg images (this overrides thequality
option above)png_compression_level
- set the compression level for png images (0-9) (this overrides thequality
option above)png_compression_filter
- set the compression filter for png images (see thefilters
parameter forimagepng
function in PHP manual for more details)cache
- override the default cache setting.data_loader
- override the default data loader.route
- optional list of route requirements, defaults and options using in the route loader. Add array with keysrequirements
,defaults
oroptions
. Default value: empty array.format
- hardcodes the output format (which means that the requested format is ignored).animated
- support for resizing animated gif (currently not supported by Imagine (PR pending))
This work, including the code samples, is licensed under a
Creative Commons BY-SA 3.0
license.