campaigningbureau/laravel-static-image-cache

store/cache external images as a static file

laravel-static-image-cache

store/cache external images as a static file, _(*1)

Replaces URIs by a proxy route., _(*2)

When this proxy route is called, the original image is cached inside the configured directory and returned., _(*3)

If the requested file was already cached, it is instead directly returned by the webserver., _(*4)

Installation

composer require campaigningbureau/laravel-static-image-cache

Supported versions

Setup

Add the service provider to the app.php provider array, _(*5)

/*
 * Package Service Providers...
 */
CampaigningBureau\LaravelStaticImageCache\Provider\LaravelStaticImageCacheProvider::class,

Usage

This Package provides two helper functions: static_image and statify_text, _(*6)

static_image

The static_image-helper can be used to generate the static file url for a given image url., _(*7)

<img src="{{ static_image('https://images.domain.com/my-image.jpg') }}" alt="An external image">

statify_text

This helper function automatically statifies images from all domains that are configured in the statify_domains config entry inside the given string., _(*8)

Usage:, _(*9)

if (function_exists('statify_text')) {
    $text = statify_text($text);
}

Clear the files

To clear all cached files manually you can use an artisan task., _(*10)

php artisan static-image-cache:clear

Configuration

• enabled: defines, if proxying and storing of the images is activated. Can be set to true, false or debug (If debug the package will synchronise the flag with the app.debug config value), _(*11)

• cache_path_prefix: The path prefix relative to public_path. This is where the images will be stored. This path will also be used as the proxy-url prefix., _(*12)

• statify_domains: Holds an array of all domains that will be statified when calling the statify_text function., _(*13)

Upgrade guide

From v1.x to v2.0

all usages of staticImage() need to be replaced by the new static_image() function., _(*14)