sunftec/yii2-image-thumbnail

Create image thumbnail Yii2 component

Yii2 image thumbnail

Create image thumbnails use Imagine. Thumbnail created and cached automatically. It allows you to create placeholder with service http://placehold.it/ or holder.js.

Features:

• Easy to use
• Use Imagine
• Automaticly thumbnails caching
• Cache sorting to subdirectories
• Use placehold.it & holder.js

Installation

Composer

The preferred way to install this extension is through Composer.

Either run php composer.phar require sadovojav/yii2-image-thumbnail "dev-master"

or add "sadovojav/yii2-image-thumbnail": "dev-master" to the require section of your composer.json

Config

Attach the component in your config file:

'bootstrap' => [
    'thumbnail',
],

'components'=>[
    'thumbnail' => [
        'class' => 'sadovojav\image\Thumbnail',
    ],
],

Parameters

• string basePath = @runtime - Base path
• string cachePath = @runtime/thumbnails - Cache path alias
• integer cacheExpire = 604800 - Cache expire time
• array options - other options (placeholder)

'options' => [
    'placeholder' => [
        'type' => sadovojav\image\Thumbnail::PLACEHOLDER_TYPE_URL,
        'backgroundColor' => '#f5f5f5',
        'textColor' => '#cdcdcd',
        'text' => 'Ooops!'
    ],
    'quality => 92
]

Placeholder type

• 1. sadovojav\image\Thumbnail::PLACEHOLDER_TYPE_JS - holder.js
• 2. sadovojav\image\Thumbnail::PLACEHOLDER_TYPE_URL - get placeholder by url

Using

Get cache image

echo Yii::$app->thumbnail->img($file, $params, $options);

This method returns Html::img()

Parameters

• string $file required - Image file path
• array $params - Image manipulation methods. See Methods
• array $options - options for Html::img()

Get cache image url

echo Yii::$app->thumbnail->url($file, $params);

This method returns cache image url

Parameters

• string $file required - Image file path
• array $params - Image manipulation methods. See Methods

Method

Resize

'resize' => [
    'width' => 320,
    'height' => 200
]

Parameters

• integer width required - New width
• integer height required - New height

Crop

'crop' => [
    'width' => 250,
    'height' => 200,
]

Parameters

• integer width required - New width
• integer height required - New height
• integer x = 0 - X start crop position
• integer y = 0 - Y start crop position

Thumbnail

'thumbnail' => [
    'width' => 450,
    'height' => 250,
]

Parameters

• integer width required - New width
• integer height required - New height
• string mode = THUMBNAIL_OUTBOUND - Thumbnail mode THUMBNAIL_OUTBOUND or THUMBNAIL_INSET

Placeholder

'placeholder' => [
    'width' => 450,
    'height' => 250,
]

This method return image placeholder if image file doesn't exist.

Parameters

• integer width required - Placeholder image width
• integer height required - Placeholder image height
• string backgroundColor = #f5f5f5 - Background color
• string textColor = #cdcdcd - Text color
• string text = Ooops! - Text