salopot/image-generator

Image provider for Faker: solid color, gradient, gallery, LoremPixel, PicsumPhotos, Unsplash, LoremFlickr, PlaceKitten, PlaceImg

1.1.0 2021-02-23 20:07 UTC

Requires

• php: >=7.1
• fakerphp/faker: ^1.9.1
• intervention/image: ^2.4

Requires (Dev)

• phpunit/phpunit: ^8.0||^9.5

MIT

• Alexander Kireev

• image
• faker
• laravel
• local
• Unsplash
• gradient
• placekitten
• lorempixel
• PicsumPhotos
• LoremFlickr
• PlaceImg

README

Image provider for fzaninotto/Faker package with support multiple image sources and basic image manipulations

Local (fast & no need internet connection):

• SolidColor - generate image filled single color
• Gallery - use local directory with images as source
• Gradient - generate gradient image

Remote:

• LoremPixel - lorempixel.com used in the original faker (very unstable now)
• PicsumPhotos - picsum.photos
• Unsplash - unsplash.com
• LoremFlickr - loremflickr.com
• PlaceKitten - placekitten.com
• PlaceImg - placeimg.com Warning: selector param use image resizing

Description

• Support multiple local & remote sources (also you can write own)
• Support basic image manipulations
• Support several result formats (data-url, file, content)
• Support multiple extensions

Requirements

• PHP >=7.1
• GD Library (>=2.0)
• Imagick PHP extension (>=6.5.7)

Installation

composer require --dev salopot/image-generator

Configuration

$generator = \Faker\Factory::create();
$imageProvider = new \Salopot\ImageGenerator\ImageProvider($generator);
// Configure some or all image sources
$imageProvider->addImageSource(new \Salopot\ImageGenerator\ImageSources\Local\SolidColorSource($imageProvider));
$imageProvider->addImageSource(new \Salopot\ImageGenerator\ImageSources\Local\GallerySource($imageProvider, '/dir/with/images'));
$imageProvider->addImageSource(new \Salopot\ImageGenerator\ImageSources\Local\SolidColorSource($imageProvider));
$imageProvider->addImageSource(new \Salopot\ImageGenerator\ImageSources\Remote\LoremPixelSource($imageProvider));
$imageProvider->addImageSource(new \Salopot\ImageGenerator\ImageSources\Remote\PicsumPhotosSource($imageProvider));
$imageProvider->addImageSource(new \Salopot\ImageGenerator\ImageSources\Remote\UnsplashSource($imageProvider));
$imageProvider->addImageSource(new \Salopot\ImageGenerator\ImageSources\Remote\PlaceKittenSource($imageProvider));
$imageProvider->addImageSource(new \Salopot\ImageGenerator\ImageSources\Remote\PlaceImgSource($imageProvider));
$generator->addProvider($imageProvider);

Usage

Basic example

$url = $generator->imageGenerator(640, 480)->getDataUrl();

Group random images for get the same with different changes

$item1MainImage = $generator->imageGenerator(640, 480, 'item-1')->getDataUrl();
$item1ThumbnailImage = $generator->imageGenerator(50, 50, 'item-1')->getDataUrl();

$item2MainImage = $generator->imageGenerator(640, 480, 'item-2')->getDataUrl();
$item2ThumbnailImage = $generator->imageGenerator(50, 50, 'item-2')->getDataUrl();

Choose one of the available sources.

$oneSourceUrl = $generator->imageGenerator(640, 480, null, 'SolidColor')
    ->grayscale()->getDataUrl();
$anotherSourceUrl = $generator->imageGenerator(640, 480, null, 'Unsplash')
    ->negative()->getDataUrl();

Support same image manipulations from any source:

$filePath = $generator->imageGenerator(640, 480)
    ->setExtension('png')
    ->grayscale()
    ->opacity(95)
    ->contrast(30)
    ->gamma(1.6)
    ->brightness(15)
    ->blur(80)
    ->negative()
    ->insertImage('/path/to/logo.png','left', 'bottom')
    ->text('Hello world', 35, 'left', 'top', 30, -90)
    ->insertImage('/path/to/logo.png', 'right', 'top')
->getFilePath('/path/to/dir');

Support several output formats:

$dataUrl = $generator->imageGenerator(640, 480)->getDataUrl();
$filePath = $generator->imageGenerator(640, 480)->getFilePath('/path/to/dir');
$content = $generator->imageGenerator(640, 480)->getContent();

###Laravel The easiest to register faker with new configuration in Laravel: add next lines to the method app/Providers/AppServiceProvider.php::register

use Faker\Factory as FakerFactory;
use Faker\Generator as FakerGenerator;
use Salopot\ImageGenerator\ImageSources\Local;
use Salopot\ImageGenerator\ImageSources\Remote;

***

$this->app->singleton(FakerGenerator::class, function ($app) {
    $generator =  FakerFactory::create($app['config']->get('app.faker_locale', 'en_US'));
    
    // Additional faker providers
    $imageProvider = new \Salopot\ImageGenerator\ImageProvider($generator);
    $imageProvider->addImageSource(new Local\SolidColorSource($imageProvider));
    $imageProvider->addImageSource(new Local\GallerySource($imageProvider, '/dir/with/images'));
    $imageProvider->addImageSource(new Local\SolidColorSource($imageProvider));
    $imageProvider->addImageSource(new Remote\LoremPixelSource($imageProvider));
    $imageProvider->addImageSource(new Remote\PicsumPhotosSource($imageProvider));
    $imageProvider->addImageSource(new Remote\UnsplashSource($imageProvider));
    $imageProvider->addImageSource(new Remote\PlaceKittenSource($imageProvider));
    $imageProvider->addImageSource(new Remote\PlaceImgSource($imageProvider));
    $generator->addProvider($imageProvider);

   return $generator;
});

After that you can use faker (with ImageGenerator) in all standard laravel ways via DI: factories, resolve(\Faker\Generator::class), constructor injection