README

generate & cache thumbnails of remote & local images

Requirements

• mininum php version 8.4
• curl extension must be enabled
• gd extension must be enabled

Limitations

At this time only JPEG & PNG formats are supported.

Install (composer) dependencies:

composer require aportela/remote-thumbnail-cache-wrapper

Code example (from remote picture):

<?php

    require "vendor/autoload.php";

    $logger = new \Psr\Log\NullLogger("");

    $cachePath = dirname(__FILE__) . DIRECTORY_SEPARATOR . "cache";

    $url = "https://raw.githubusercontent.com/aportela/remote-thumbnail-cache-wrapper/refs/heads/main/src/Test/200.jpg";
    $source = new \aportela\RemoteThumbnailCacheWrapper\Source\URLSource($url);

    //$ttl = null; // cache never expires
    //$ttl = 60; // cache expires after 60 seconds
    $ttl = new \DateInterval("PT60M"); // cache expires after 60 minutes

    // JPEG, quality: 80, resolution: 320x200, cache expires after 60 minutes
    $thumbnail = new \aportela\RemoteThumbnailCacheWrapper\JPEGThumbnail($logger, $cachePath, $source, 80, 320, 200, $ttl);
    // get thumbnail local path (from cache || create cache if not found)
    $path = $thumbnail->get();
    if ($path !== false) {
        header("Content-Type: image/jpeg");
        readfile($path);
    } else {
        header("HTTP/1.1 404 Not Found");
    }

Code example (from local filesystem picture):

<?php

    require "vendor/autoload.php";

    $logger = new \Psr\Log\NullLogger("");

    $cachePath = dirname(__FILE__) . DIRECTORY_SEPARATOR . "cache";

    $localImagePath = "/tmp/existent_image.jpg";
    $source = new \aportela\RemoteThumbnailCacheWrapper\Source\LocalFilenameResource($localImagePath);

    $ttl = null; // cache never expires
    //$ttl = 60; // cache expires after 60 seconds
    //$ttl = new \DateInterval("PT60M"); // cache expires after 60 minutes

    // PNG, quality: 90, resolution: 160x100, cache never expires
    $thumbnail = new \aportela\RemoteThumbnailCacheWrapper\PNGThumbnail($logger, $cachePath, $source, 80, 160, 100, $ttl);
    // get thumbnail local path (from cache || create cache if not found)
    $path = $thumbnail->get();
    if ($path !== false) {
        header("Content-Type: image/png");
        readfile($path);
    } else {
        header("HTTP/1.1 404 Not Found");
    }