Skip to content

lireincore/yii2-imgcache

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Image effect, thumb and cache extension for Yii2

Latest Stable Version Total Downloads License

About

The lireincore/imgcache integration for Yii2 framework.

Install

Add the "lireincore/yii2-imgcache": "^0.6" package to your require section in the composer.json file

or

$ php composer.phar require lireincore/yii2-imgcache

Usage

To use this extension, you need to create the imgcache.php file in your config folder and add this code:

<?php

return [
    'srcdir' => '@app/files/images',
    'destdir' => '@webroot/thumbs',
    'webdir' => '@webroot',
    'baseurl' => '@web',
    //....
    'presets' => [
        'origin' => [
            'effects' => [
                //add the effects you need
                //....
            ],
        ],
    ],
];

See lireincore/imgcache README.md for more information about the available effects and other config options.

Also add the following code in your Yii2 application configuration:

$config = [
    //....
    'container' => [
        //....
        'singletons'  => [
            //....
            LireinCore\Yii2ImgCache\ImgCache::class => [
                ['class' => LireinCore\Yii2ImgCache\ImgCache::class],
                [
                    require(__DIR__ . '/imgcache.php'),
                ]
            ],
        ]
    ],
];

Use in your code:

use LireinCore\Yii2ImgCache\ImgCache;

$imgCache = Yii::$container->get(ImgCache::class);

// get thumb url for image '{srcdir}/blog/image.jpg' (preset 'origin')
$url = $imgcache->url('blog/image.jpg', 'origin');


// get thumb url for image '{srcdir}/blog/image.jpg' (preset 'origin')
$url = \Yii::$app->imgcache->url('blog/image.jpg', 'origin');

See lireincore/imgcache README.md for more information about the available functions.

License

This project is licensed under the MIT License - see the License File file for details