makeitbetter/yiiimages

Images manager module for Yii2.

yiiimages

, _(*1)

Yiiimages is an images manager for Yii framework 2.0. It stores the files in a separate directory. In models images are saved as paths to files relative to this directory. When images is published their thumbnails are created in an accessible via HTTP location., _(*2)

Installation

Add package:, _(*3)

#!sh
$ composer require makeitbetter/yiiimages

Configure the application by adding (yii2 guide):, _(*4)

#!php
$config['modules']['yiiimages'] = [
    'class' => 'makeitbetter\yiiimages\Module',
    'options' => [],
];
$config['bootstrap'][] = 'yiiimages';

Available options:, _(*5)

• sourceFolder - Path to folder where the images will be stored. Default: @app/media.
• targetFolder - Path relative to web root where the thumbnails will be putted. Default: thumbnails
• paddingColor - Hexadecimal RGB color to fill thumbnails padding. Default: white, ffffff.
• getThumbnailPathMethod - Function to create thumbnail items path. It should takes Thumbnail object and returns string. By default class's self method will be applied.
• maxUploadNumber - Max number of images available to be uploaded at one time.

Next options define parameters for create thumbnails in the manager page (see more in the description of Class Thumbnail ):, _(*6)

• width - Default: 150.
• height - Default: 150.
• crop - Default: true.
• stretch - Default: false.

Configure your translation component (yii2 guide), _(*7)

#!php
$config['components']['i18n'] = [
    'translations' => [
        ...
        'modules*' => [
            'class' => 'yii\i18n\PhpMessageSource',
        ],
    ],
];

All module’s phrases translations have a key - modules/yiiimages. So as default you should put you translations to @app/messages/xx-XX/modules/yiiimages.php, _(*8)

Finally, distribute permissions: browseImages, addImages, deleteImages. (yii2 guide), _(*9)

Usage

In you forms:

#!php
use makeitbetter\yiiimages\widgets\ImageInput;
use yii\widgets\ActiveForm;

$form = ActiveForm::begin();

echo $form->field($model, 'property_name')->widget(ImageInput::className(), $options);

ActiveForm::end();

Or without an ActiveForm object:, _(*10)

#!php
echo ImageInput::widget(['model' => $model, 'attribute' => 'property_name']);

Displaying images:

#!php
use makeitbetter\thumbnail\Thumbnail;

echo Thumbnail::of($model->propery_name, 150, 150)->img()

See more about using a Thumbnail helper in the description of class., _(*11)