alex-bond/yii2-thumbler Library for auto-creating thumbs of images

imagethumbzebra

Gitter Chat

Image Resizer with automatic cache for Yii 2

This extension allows to resize images and automatically cache them.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist alex-bond/yii2-thumbler

or add

"alex-bond/yii2-thumbler": "*"

to the require section of your composer.json.

Usage

To use this extension, you need add the following code in your application configuration:

return [
    //....
    'components' => [
        'thumbler'=> [
            'class' => 'alexBond\thumbler\Thumbler',
            'sourcePath' => '/path/to/source/files',
            'thumbsPath' => '/path/to/resize/cache',
        ],
    ],
];

After this just call resize() method like this:

$path = \Yii::$app->thumbler->resize('image.png',500,500);

As result of this call extension will return path to resized image relative to $thumbsPath.

Methods

resize($image, $width, $height, $method = Thumbler::METHOD_NOT_BOXED, $backgroundColor = 'ffffff', $callExceptionOnError = true)

ParameterDescriptionPossible Values
$imagePath to image based relative to $sourcePathString
$widthWidth of needed image in pixelsint
$heightHeight of needed image in pixelsint
$methodResize algorithm Thumbler::METHOD_BOXED; Thumbler::METHOD_NOT_BOXED; Thumbler::METHOD_CROP_TOP_LEFT; Thumbler::METHOD_CROP_TOP_CENTER; Thumbler::METHOD_CROP_TOP_RIGHT; Thumbler::METHOD_CROP_MIDDLE_LEFT; Thumbler::METHOD_CROP_CENTER; Thumbler::METHOD_CROP_MIDDLE_RIGHT; Thumbler::METHOD_CROP_BOTTOM_LEFT; Thumbler::METHOD_CROP_BOTTOM_CENTER; Thumbler::METHOD_CROP_BOTTOM_RIGHT;
$backgroundColorBackground color for `Thumbler::METHOD_BOXED` algorithmString (HEX color)
$callExceptionOnErrorWhen `true` extension will caught exception on error. If `false` extension will just add error in internal array which can be called by `getLastError()`boolean

getLastError()

Returns last error description.

clearImageCache($image)

Clears all cache for selected image file.

clearAllCache()

Clears all cache.

Statistics

Downloads
GitHub Stars
GitHub Forks

Releases

Comments



1.2.0 is the latest of 5 releases



BSD-3-Clause license
Stats
10 github stars & 4 github forks
0 downloads in the last day
9 downloads in the last 30 days
1917 total downloads