Image Resizing

• Introduction
• Configuration
• Usage
• Available Parameters
• Available Modes
• Available Sources

Introduction

The Image Resizing service can be used for resizing any image resources accessible to the application.

It works by accepting a variety of image sources and normalizing the pipeline for storing the desired resizing configuration and then deferring the actual resizing of the images until requested by the browser. When the resizer route is hit, the configuration is retrieved from the cache and used to generate the desired image and then redirect to the generated images static path to minimize the load on the server.

Future loads of the image are automatically pointed to the static URL of the resized image without even hitting the resizer route.

Configuration

The functionality of this class is controlled by these config items:

• cms.storage.resized.disk: The disk to store resized images on
• cms.storage.resized.folder: The folder on the disk to store resized images in
• cms.storage.resized.path: The public path to the resized images as returned by the storage disk's URL method, used to identify already resized images

NOTE: The image resizing service requires a cache driver that persists cache data between requests in order to function, array is not a supported cache driver if you wish to use this service.

Usage

The Image Resizer can be access through a number of different methods:

• image backend list columns
• getThumb() on Winter\Storm\Database\Attach\File models
• the | resize filter
• Passing a supported $image source to System\Classes\ImageResizer::filterGetUrl()
• Instantiating an instance of the System\Classes\ImageResizer class and using that as desired

Available Parameters

The basic parameters provided to the ImageResizer are (int) $width, (int) $height, and (array) $options.

If $width or $height is falsey or 'auto', that value is calculated using original image ratio (automatic proportional scaling).

The following elements are supported in the options array are supported:

Available Modes

The mode option allows you to specify how the image should be resized. The available modes are as follows:

Available Sources

The available sources that images can be resized from are as follows:

• Plugins
• Themes
• Media Library
• Uploads Directory
• Models that extend the \Winter\Storm\Database\Attach\File model

Available sources can be extended by listening to the system.resizer.getAvailableSources event