maximal/php-avif-thumbnailer

PHP (over Imagine) helper for creating and caching AVIF thumbnails in real time

Maintainers

Details

github.com/maximal/php-avif-thumbnailer

Source

Issues

Installs: 77

Dependents: 1

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 0

v1.0.0 2022-11-24 13:05 UTC

Requires

MIT 72468338abe3b8ad15e93778ca1b548ea57df795

imagethumbnailimaginehelperavif

This package is auto-updated.

Last update: 2024-10-24 17:12:46 UTC

README

AvifThumbnailer is a thumbnail helper which allows you to generate and cache image thumbnails in your PHP application on the fly.

Installation

Install this library with Composer:

composer require "maximal/php-avif-thumbnailer"

or add

"maximal/php-avif-thumbnailer": "^1.0"

to the require section of your app’s composer.json file.

Checking the environment

You will need FFMPEG with AVIF (AV1) coder installed in your system.

For instance in Ubuntu/Debian it is included in ffmpeg package:

sudo apt install ffmpeg

Check the command:

ffmpeg -version

You should get an output with the version number. Every version after 4.3 should be fine.

If you have installed ffmpeg to a different command or path, configure the static property AvifThumbnailer::$ffmpegCommand before using the helper (see the example below).

More info about AVIF: https://avif.io/blog/

Generating thumbnails

Use this thumbnailer in your PHP application:

use Maximal\Thumbnailers\AvifThumbnailer;

echo AvifThumbnailer::picture('/path/to/img/image.png', $width, $height);

More options (outbound instead of default inset; alt and class attribute added):

use Maximal\Thumbnailers\AvifThumbnailer;

echo AvifThumbnailer::picture(
	'/path/to/img/image.png',
	$width,
	$height,
	false,
	['alt' => 'Alt attribute', 'class' => 'img-responsive']
);

Custom ffmpeg command:

use Maximal\Thumbnailers\AvifThumbnailer;

AvifThumbnailer::$ffmpegCommand = '/usr/local/bin/ffmpeg';
echo AvifThumbnailer::picture('/path/to/img/image.jpg', $width, $height);

The helper’s picture() method uses modern <picture> HTML tag as follows:

<picture data-cache="hit|new|fail">
	<source srcset="/assets/thumbnails/...image.png.avif" type="image/avif" />
	<img src="/assets/thumbnails/...image.png" other-attributes="" />
</picture>

Here you have image/avif source for browsers which support AVIF images and traditional (PNG, JPEG, TIFF, GIF) image fallback.

Author