README

Note: This package extends and continues the development of the abandoned official Intervention/imagecache package. We released this fork to provide support for Intervention Image v3 and ensure continued compatibility with modern Laravel applications.

Intervention Image Cache extends the Intervention Image Class package to be capable of image caching functionality.

The library uses the Illuminate/Cache package and can be easily integrated into the Laravel Framework (Laravel 8+). Based on your Laravel cache configuration you are able to choose between Filesystem, Database, Memcached or Redis for the temporary buffer store.

The principle is simple. Every method call to the Intervention Image class is captured and checked by the caching interface. If this particular sequence of operations already have taken place, the data will be loaded directly from the cache instead of a resource-intensive image operation.

Installation

You can install this package quickly and easily with Composer.

Require the package via Composer:

$ composer require tojoo/imagecache

Now you are able to require the vendor/autoload.php file to PSR-4 autoload the library.

Laravel Integration

For Laravel integration, you'll need to install the official Intervention Image Laravel package:

$ composer require intervention/image-laravel

This package provides the Laravel ServiceProvider and Facade for Intervention Image. After installation, the Image facade will be available and you can use the cache functionality as described in the usage section.

Requirements:

PHP ^8.1
Laravel ^8|^9|^10|^11|^12
Intervention Image ^3.11

Usage

To create cached images just use the static method ImageCache::cache from facades and pass the image manipulations via closure. The method will automatically detect if a cached file for your particular operations exists.

// run the operations on the image or read a file
// for the particular operations from cache
$img = ImageCache::cache(function($image) {
   return $image->make('public/foo.jpg')->resize(300, 200)->greyscale();
});

Determine a lifetime in minutes for the cache file as an optional second parameter. Pass a boolean true as optional third parameter to return an Intervention Image object instead of a image stream.

For enhanced development experience with IDE autocompletion and type checking, you can use the ImageCacheInterface contract to type-hint the callback parameter:

use Intervention\Image\Laravel\Facades\ImageCache;
use Intervention\Image\Interfaces\ImageCacheInterface;

$img = ImageCache::cache(
    function (ImageCacheInterface $image) {
        return $image->make('public/foo.jpg')
            ->resize(300, 200)
            ->greyscale()
            ->blur(5)
            ->sharpen(10)
            ->rotate(45)
            ->brightness(20);
    },
    60, // Cache for 60 minutes
    true // Return as Image object
);

Server configuration

If you have Static Resources caching enabled on Nginx please add your cache directory ({route} in config) to static resources handler exclusion:

# where "cache" is {route}
location ~* ^\/(?!cache).*\.(?:jpg|jpeg|gif|png|ico|cur|gz|svg|svgz|mp4|ogg|ogv|webm|htc|webp|woff|woff2)$ {
  expires max;
  access_log off;
  add_header Cache-Control "public";
}

License

Intervention Imagecache Class is licensed under the MIT License.

tojoo / imagecache

Maintainers

Details