Auto-generated transform: How to retrieve the optimized URLs via PHP?

[mandrasch]

Hi, we're using the following config in craft v5:

// config/imager-x-generate.php
return [
    'volumes' => [
        'uploads' => [
            'standardImageTransformsWebp'
        ],
    ]

// config/imager-x-transforms.php
return [
    'standardImageTransformsWebp' => [
        'defaults' => [
            'format' => 'webp',
            'webpQuality' => 80
        ],
        'transforms' => [
            ['width' => 480],
            ['width' => 960],
            ['width' => 1920]
        ]
    ]
];

We now want to retrieve just the image urls for the optimized images.

According to https://imager-x.spacecat.ninja/usage/php.html, something like this can be used:

  $imagerx = Craft::$app->plugins->getPlugin('imager-x');
                    $thumbSrcset = '';
                    
                    if ($imagerx && $imagerx instanceof \spacecatninja\imagerx\ImagerX) {
                        $heroImage = $entry->image->one();
                        $transforms = $imagerx->imager->transformImage($heroImage, 'listThumbnail');
                        $thumbSrcset = $imagerx->imager->srcset($transforms);
                    }

I just wanted to make sure and ask:

Does $imagerx->imager->transformImage use the already generated transform (after upload)?

I would love to avoid the case that the image is optimized/processed each time I use this function in a API project. I just want to return the URLs for 480, 960, 1920 in my REST API project (Craft CMS).

Image optimization should only happen when editors upload the image into the CMS, not on api calls.

Thanks very much in advance!
Cheers, Matthias

[aelvan]

If the image has been transformed (and the Imager cache hasn't been deleted later), the code will not result in additional transforms. The check for if the transform exists is inside the transformImage method, so it'll work exactly the same via both PHP and Twig.

Hope that answers your question?

[mandrasch]

Hi @aelvan,

thanks very much for quick reply!

Yes, nice - that answers it! 🎉

Came up with this code now

$transformHandle =  'standardImageTransformsWebp';
$transformConfig = Craft::$app->getConfig()->getConfigFromFile('imager-x-transforms');
$transforms = $transformConfig[$transformHandle]['transforms'] ?? null;
 // Retrieve the transformed URLs for each specified width
            foreach ($transforms as $transform) {
                try {
                    $transformedImage = $imagerx->imager->transformImage($image, $transform);

                    $width = $transform['width'] ?? '';
                    if ($transformedImage && $width) {
                        $optimizedImageUrls[(string)$width] = $transformedImage->getUrl();
                    }
                } catch (ImagerException $e) {
                    Craft::error('Error transforming image: ' . $e->getMessage(), __METHOD__);
                }
            }

[aelvan]

Great. Maybe I'm missing something, but can't you just do:

$transformedImages = $imagerx->imager->transformImage($image, 'standardImageTransformsWebp');
$optimizedImageUrls = [];

foreach($transformedImages as $transformedImage) {
    $optimizedImageUrls[(string)$transformedImage->width] = $transformedImage->getUrl();
}

...or even replace the last four lines with an array_map. :)

[mandrasch]

Thanks @aelvan, even better! 🙂