README

This plugin provides an on-demand and memory-efficient solution for handling image resizing in WinterCMS. It returns a stable URL immediately, and renders missing resized assets on first request (with a hard concurrency cap) to avoid server exhaustion.

Under the hood, the image pipeline uses League\Glide (v3) for storage-backed images (Flysystem disks), with a fallback to Intervention Image for remote URLs and PDFs.

Features

1. Installation and Configuration (.env)

The plugin uses a dedicated configuration file (config.php) which pulls its values from your main .env file. You should place these variables in your environment file to easily manage your setup across different deployments (staging, production).

.env Variables

Runtime

No queue worker is required. Missing resized assets are rendered synchronously on first request, with a strict concurrency limit.

2. Twig Filter: qresize - Detailed Parameters

The qresize filter is the primary tool for using the plugin in your templates. It instantly returns a URL, deferring the actual work to the background.

Twig Syntax

{{ image.path | qresize(width, height, options) }}

Parameters

Options Array Keys (opts)

3. PHP Block Functionality: mresize_path()

This function is registered to allow developers to pre-register resize requests for a directory directly from custom PHP code (e.g., in a component's onStart() method or a CMS page's code block). The resized assets will still be rendered on first request.

Function Call Syntax

mresize_path($path, $w, $h, $opts = [], $recursive = false);

Function Parameters

Backward compatibility: older calls that passed $disk as a 6th argument still work, but the preferred way is using $opts['disk'].

Example Usage in a Component:

function onStart()
{
    // When the component initializes, it queues all images in 'media/user-uploads' 
    // to be resized to 1024px wide.
    $jobsQueued = mresize_path(
        'user-uploads/latest-image.jpg', // Path resolves to the 'user-uploads' directory
        1024,
        null, 
        ['quality' => 85, 'format' => 'webp', 'disk' => 'media'],
        true // Recursive
    );
}

4. Command Line Interface (CLI) - All Parameters

A. mresize:warmup (Batch Processing)

Recursively generates resized images for a directory.

Example Usage:

php -d memory_limit=1024M artisan mresize:warmup "media/gallery" --width=400,800 --format=jpg,webp --recursive --force

B. mresize:clear (Cache Cleanup)

Removes resized images based on filter criteria.

C. mresize:prune (Orphan Removal)

Removes cached resized images where the original source file no longer exists.

Example Usage:

# Delete all orphan files on the default disk
php artisan mresize:prune

Backward compatibility: the PHP function name queuedresize_path() is still registered as an alias.