just/thumbnailbundle

A Symfony bundle that creates Thumbnails on the fly using the GD library

3.0.8 2024-12-20 11:18 UTC

Requires

• php: >=5.4 || ^7.0 || ^8.0
• ext-fileinfo: *
• ext-gd: *
• mauricesvay/php-facedetection: ~0.1
• symfony/cache: ~2.4 || ~3.4 || ~4.0 || ~5.0 || ^5.0 || ^6.0
• symfony/framework-bundle: ^2.3 || ^3.4.26 || ^4.1.12 || ^5.0 || ^6.0

Requires (Dev)

• phpunit/phpunit: 5.6.3

Suggests

• ext-apc: To cache generated Thumbnails using APC

MIT

• Julian Stricker

• Symfony2
• bundle
• thumbnail

README

Overview

This is a bundle for the Symfony2, Symfony3 and Symfony4 framework that creates Thumbnails on first demand. The thumbnails then are stored using the Symfony cache system. It creates a thumbnail of a image in the given size and stores it in cache for the next calls, until the image changes. The bundle has a new face-detection feature to avoid cut off of faces.

License

This bundle is released under the MIT license

Installation

Step1: Using Composer

Add the following line to your composer.json require block:

// composer.json
{
    // ...
    require: {
        // ...
        "just/thumbnailbundle": "~2.0"
    }
}

Then, you can install the new dependencies by running Composer's update command from the directory where your composer.json file is located:

$ php composer.phar update

Step 2: Register the Bundle

Modify your AppKernel with the following line:

<?php
// in AppKernel::registerBundles()
$bundles = array(
    // ...
    new Just\ThumbnailBundle\JustThumbnailBundle(),
    // ...
);

Step 3: Configure the bundle

# app/config/config.yml

just_thumbnail:
    imagesrootdir: "/path/to/the/images/root/dir/on/server/"
    placeholder: "/path/to/a/placeholder/image.jpg"
    expiretime: 86400

All parameters are optional. The default imagesrootdir is the Symfony web-directory. The placeholder-Image will be showen if the original image is not readable or not found. If the placeholder parameter is not set then the Controller will return a "404 Not found" message. "expiretime" is maximum age of a thumbnail in cache in seconds. After this time the thumbnail will be regenerated. Default value is 86400 (one day).

The thumbnail is stored in cache by a key that is generated using the image-name, the maxx-parameter, the maxy-parameter, the mode-parameter and the creationtime. If one of those parameters changes than the thumbnail will be regenerated.

If not already done, you have to define a cache service

# app/config/config.yml
services:
  cache:
    class: Doctrine\Common\Cache\ApcuCache

Note:

The JustThumbnailBundle needs to have gd.jpeg_ignore_warning set to "1". Set gd.jpeg_ignore_warning to "1" in your php.ini, and restart your webserver.

Step 4: Import JustThumbnailBundle routing file

In YAML:

# app/config/routing.yml
just_thumbnail_bundle:
    resource: "@JustThumbnailBundle/Resources/config/routing.yml"

Or if you prefer XML:

<!-- app/config/routing.xml -->
<import resource="@JustThumbnailBundle/Resources/config/routing.yml"/>

Usage:

The thumbnail will be generated just in time when the url is called:

/thumbnails/{mode}/{maxx}x{maxy}/{img}
/thumbnails/{mode}/{maxx}x/{img}
/thumbnails/{mode}/x{maxy}/{img}

Parameter "mode"

This parameter can be set to "normal", "crop", "stretch" and "max".

• normal: Sets the image to the maximum height or width, without changing the width/height proportion;
• crop: The image will be cropped exactly to the given height and width without changing the width/height proportion;
• stretch: Sets the image to the maximum height or width, the width/height proportion changes.
• max: Sets the image to the maximum height or width, without changing the width/height proportion;

Parameter maxx and maxy

"maxx" is the maximum width and "maxy" the maximun height of the generated thumbnail.

Placeholder

You can overwrite the placeholder-file-config by adding a "placeholder"-Parameter to the url. Example: www.yourdomain.tld/thumbnails/stretch/800x225/path/to/image?placeholder=new_placeholder_image.jpg

Parameter "center"

This parameter can be set to "", "auto", or "[int],[int]". Default is "". This parameter can be used to define a center point of a image that should be always visible in crop mode. This is to avoid that highlights of the image are cut off. If set to "auto", the script will try to detect a face in the image. If found, the center will be set to the center of the detected face. So the face should not be cut off.

Twig Helper

You can use the twig helper to generate the URL :

{{thumbnail({'img':'path/to/image','maxx':320,'maxy':240,'mode':'stretch'})}}

will generate something like:

/thumbnails/stretch/300x240/path/to/image