Custom Data Loader

You can write custom data loaders that retrieve image data from any imaginable backend. The data loader needs to implement the LoaderInterface:

        1
2
3
4
5
6
        namespace Liip\ImagineBundle\Binary\Loader;

interface LoaderInterface
{
    public function find($path);
}
    

The LoaderInterface defines the method find, which is called with the path to the image and needs to return an instance of BinaryInterface.

Warning

Be aware that $path can be coming from the image controller. You need to sanitize this parameter in your loader to avoid exposing files outside of your image collections.

Register it: automatically

By default, your loader will be automatically registered as it implements the LoaderInterface.

You will be able to reference and use your custom loader in your configuration by using its Fully Qualified Class Name.

Register it: manually

If you want to give it a different name you need to configure a service with your custom loader and tag it with liip_imagine.binary.loader.

To register App\Service\MyCustomDataLoader with the name my_custom_data_loader, you would use the following configuration:

        1
2
3
4
5
6
7
8
9
10
        # app/config/services.yml

services:
    imagine.data.loader.my_custom:
        class: App\Service\MyCustomDataLoader
        arguments:
            - "@liip_imagine"
            - "%liip_imagine.formats%"
        tags:
            - { name: "liip_imagine.binary.loader", loader: my_custom_data_loader }
    

You can set your custom data loader by adding it to the configuration as the new default loader:

        1
2
3
4
        # app/config/config.yml

liip_imagine:
    data_loader: my_custom_data_loader
    

Alternatively, you can set the custom data loader for a specific filter set:

        1
2
3
4
5
6
7
8
        # app/config/config.yml

liip_imagine:
    filter_sets:
        my_special_style:
            data_loader: my_custom_data_loader
            filters:
                # your filters
    

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version