README

Image on Demand Service is a TYPO3 extension that provides on-demand image processing services for your TYPO3 website. It allows you to dynamically manipulate and generate images based on specific requests.

Features

On-the-fly image processing.
Dynamic resizing and formatting of images.

Installation

The extension can be easily installed using Composer and is available on Packagist.

Install the extension using Composer:

composer require wineworlds/image-on-demand-service

Activate the extension in the TYPO3 backend.

Usage

The Image on Demand Service extension automatically processes requested images that match a specific URL pattern. It uses the ImageOnDemandMiddleware class to handle image requests. When an image request URL matches the specified pattern, the middleware processes the request and serves the manipulated image.

URL Pattern (1.1.0)

The URL pattern for image requests is: /image-service/{width}/{height}/{filename}?id={fileReferenceId}&type={format}&crop={cropVariant}&text={dummyImageText}&bgColor={dummyImageBgColor}&textColor={dummyImageTextColor}

The filename is not taken into account in caching.

Parameter	Description	Default Value	Required
`/width/`	The width of the generated image.	-	Yes
`/height/`	The height of the generated image.	-	Yes
`&id=18`	The unique ID of the `fileReference`.	-	No
`&type=webp`	The format of the image (e.g., JPEG, PNG, WebP, etc.).	-	No
`&crop=desktop`	The selected image crop variant.	`'default'`	No
`&text=No Image`	The text displayed on the dummy image if no ID is provided or no image is found.	`'Dummy Image'`	No
`&bgColor=ff0000`	The background color of the dummy image.	`'000000'`	No
`&textColor=0000ff`	The text color of the text displayed on the dummy image.	`'ffffff'`	No

URL Pattern (1.0.3)

The URL pattern for image requests is: /image-service/{fileId}/{width}/{height}/{format}/{filename}

fileReferenceId: The unique ID of the file reference to process.
width: The desired width of the processed image. TYPO3 Docs Image width
height: The desired height of the processed image. TYPO3 Docs Image height
format: The desired format (file extension) of the processed image. TYPO3 Docs GFX file extension
filename: The name of the image file (for SEO-friendly URLs).

For example: /image-service/123/300c/200c/jpeg/my-seo-friendly-image.jpeg will request an image with the ID 123, resized to a width of 300c pixels and a height of 200c pixels, saved in JPEG format, and with the filename "my-seo-friendly-image.jpeg".

If the requested image is not found or an error occurs during processing, a placeholder "Image Not Found" image will be returned.

Contributors

Kubilay Melnikov - Developer

License

This TYPO3 extension is licensed under the MIT License.

wineworlds / image-on-demand-service

Maintainers

Details