yannickl88/image

Library for reading, transforming and writing image files.

2.1.1 2022-08-17 20:44 UTC

Requires

• php: >=7.2
• ext-gd: *

Requires (Dev)

• phpunit/phpunit: ^8.4
• symfony/filesystem: ^4.3
• vimeo/psalm: ^3.11

MIT

• Yannick de Lange

README

Library for reading, transforming and writing image files.

This libary was born out of the need to have a consistent API for interacting with images. The goal is to have simple methods for common image tasks like cropping and resizing.

Usage

Supported file extensions for reading:

• PNG
• JPG
• JPEG
• GIF

Supported file extension for writing:

• PNG
• WEBP (if mod gd has been enabled with WebP support)

Example usages:

$image = \Yannickl88\Image\Image::fromFile('/some/image.png');

// Resize to 50 x 50
$thumbnail = $image->resize(50, 50);
$thumbnail->save('/some/thumbnail.png');

// Fit the image to a width and height of 50, 50 while maintaining it's aspect ratio.
$thumbnail = $image->fit(50, 50);
$thumbnail->save('/some/thumbnail.png');

// Crop at 50, 50 with a square of 100 x 100
$thumbnail = $image->crop([50, 50, 100, 100]);
$thumbnail->save('/some/thumbnail.png');

// Resize and crop at the same time
$thumbnail = $image->sampleTo([50, 50, 100, 100], [0, 0, 50, 50]);
$thumbnail->save('/some/thumbnail.png');

// Set the quality, where 0 being low and 1 high (value between 0 and 1)
$compressed = $image->quality(0.25);
$compressed->save('/some/preview.png');

// Get image width
var_dump($image->width()); // int

// Get image height
var_dump($image->height()); // int

// Get image bounding box
var_dump($image->rect()); // array(0, 0, width, height)

// Get a color at a given coordinate
var_dump($image->color(0, 0)); // array(red, green, blue, alpha)

// Get the image orientation
var_dump($image->orientation()); // ImageInterface::ORIENTATION_LANDSCAPE

// Get the raw data and output it
header('Content-type: image/png');
header('Content-Disposition: filename="image.png"');
echo $image->data('.png');

Migration

See Migration Guide.

Installation

• $ composer require yannickl88/image
• This library follows semantic versioning strictly.