Skip to content

Commit

Permalink
📝 Update documentation about automatic service registering
Browse files Browse the repository at this point in the history
  • Loading branch information
homersimpsons committed Jan 6, 2024
1 parent df307d7 commit ba7ed52
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 4 deletions.
12 changes: 11 additions & 1 deletion Resources/doc/data-loaders-custom.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,17 @@ path to the image and needs to return an instance of ``BinaryInterface``.
to sanitize this parameter in your loader to avoid exposing files outside
of your image collections.

You need to `configure a service`_ with your custom loader and tag it with
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
Expand Down
14 changes: 12 additions & 2 deletions Resources/doc/filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,17 @@ The ``LoaderInterface`` has the method ``load``, which is provided an instance
of ``ImageInterface`` and an array of options. It must return an
``ImageInterface``.

You need to `configure a service`_ and tag it ``liip_imagine.filter.loader``.
Register it: automatically
^^^^^^^^^^^^^^^^^^^^^^^^^^

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

You will be able to reference and use your custom filter when defining filter sets 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`_ and tag it ``liip_imagine.filter.loader``.

To register a filter ``App\Service\MyCustomFilter`` as
``my_custom_filter``, use the following configuration:
Expand Down Expand Up @@ -124,7 +134,7 @@ to the image, by passing configuration as third parameter to ``applyFilter``:
public function filter(int $width, int $height) {
$filter = '...'; // Name of the `filter_set` in `config/packages/liip_imagine.yaml`
$path = '...'; // Path of the image, relative to `/public/`
if (!$this->cacheManager->isStored($path, $filter)) {
$binary = $this->dataManager->find($filter, $path);
Expand Down
12 changes: 11 additions & 1 deletion Resources/doc/post-processors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,17 @@ for your custom post-processor.
}
}
You need to `configure a service`_ with your custom post-processor and tag it
Register it: automatically
^^^^^^^^^^^^^^^^^^^^^^^^^^

By default, your post-processor will be automatically registered as it implements the ``PostProcessorInterface``.

You will be able to reference and use your custom post-processor 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 post-processor and tag it
with ``liip_imagine.filter.post_processor``.

To register ``App\Service\MyCustomPostProcessor`` with the name
Expand Down

0 comments on commit ba7ed52

Please sign in to comment.