Image Thumbnailer
for Zend Framework 2

, _(*1)

Service that provides API to manipulate images., _(*2)

Powered by PHPThumb
Demo webino-image-thumb.demo.webino.org

Features

Resize, crop, pad, rotate, show and save images
Create image reflection
Crop whitespace
Sharpen images
Watermark

Setup

Following steps are necessary to get this module working, considering a zf2-skeleton or very similar application:, _(*3)

Run: php composer.phar require webino/webino-image-thumb:dev-develop
Add WebinoImageThumb to the enabled modules list

Requirements

PHP >= 5.6
GD 2.0+

QuickStart

For example add following code into the controller action, assume example image:, _(*4)

// We encourage to use Dependency Injection instead of Service Locator
$thumbnailer = $this->getServiceLocator()->get('WebinoImageThumb');
$imagePath   = 'public/images/example.jpg';
$thumb       = $thumbnailer->create($imagePath, $options = [], $plugins = []);

$thumb->resize(100, 100);

$thumb->show();
// or/and
$thumb->save('public/images/resized.jpg');

NOTE: If you don't know how to inject the WebinoImageThumb into action controller, check out test/resources, _(*5)

Use reflection plugin:, _(*6)

$reflection = $thumbnailer->createReflection(40, 40, 80, true, '#a4a4a4');
$thumb      = $thumbnailer->create($imagePath, [], [$reflection]);

Use whitespace cropper plugin:, _(*7)

$cropper = $thumbnailer->createWhitespaceCropper();
$thumb   = $thumbnailer->create($imagePath, [], [$cropper]);

Use sharpen plugin:, _(*8)

$sharpen = $thumbnailer->createSharpen();
$thumb   = $thumbnailer->create($imagePath, [], [$sharpen]);

Use watermark plugin:, _(*9)

$watermarkPath  = 'public/images/my_watermark.png';
$watermarkThumb = $thumbnailer->create($watermarkPath);
$watermark      = $thumbnailer->createWatermark($watermarkThumb);
$thumb          = $thumbnailer->create($imagePath, [], [$watermark]);

Options

The options array allows you to customize the behavior of the library a bit. Some of these options are implementation-specific, and are noted as such. So, let's first go over what options are available to us:, _(*10)

Option Name	Description	Default Value	Valid Values
resizeUp	Whether or not to scale an image up to the desired dimensions	false	true / false
jpegQuality	What quality to save jpeg files with (how much compression to use, 100 being none)	100	1-100
correctPermissions	Whether or not the library should attempt to correct file permissions. This will only work if you set up your PHP to allow chmod operations	false	true / false
preserveAlpha	Whether or not to preserve alpha transparency in PNG files	true	true / false
alphaMaskColor	What rgb color should be used for the alpha mask	`[255, 255, 255]`	`[0-255, 0-255, 0-255]`
preserveTransparency	Whether or not to preserve transparency in GIF files	true	true / false
transparencyMaskColor	What rgb color should be used for the transparency mask	`[255, 255, 255]`	`[0-255, 0-255, 0-255]`
interlace	When the interlace option equals true or false call imageinterlace	`null`	`true / false`

Functions

adaptiveResize($width, $height)
adaptiveResizePercent($width, $height, $percent = 50)
adaptiveResizeQuadrant($width, $height, $quadrant = 'T|B|C|L|R')
crop($startX, $startY, $cropWidth, $cropHeight)
cropFromCenter($cropWidth, $cropHeight = null)
pad($width, $height, $color = [255, 255, 255])
resize($maxWidth, $maxHeight)
resizePercent($percent)
rotateImage($direction = 'CW|CCW')
rotateImageNDegrees($degrees)
save($fileName, $format = 'GIF|JPG|PNG')
show($rawData = false)

Getters / Setters

getCurrentDimensions()
getFileName()
getFormat()
getIsRemoteImage()
getMaxHeight()
getMaxWidth()
getNewDimensions()
getOldImage()
getOptions()
getPercent()
getWorkingImage()
setCurrentDimensions($currentDimensions)
setFileName($fileName)
setFormat($format)
setMaxHeight($maxHeight)
setMaxWidth($maxWidth)
setNewDimensions($newDimensions)
setOldImage($oldImage)
setOptions($options)
setPercent($percent)
setWorkingImage($workingImage)

Reflection plugin

createReflection($percent, $reflection, $white, $border, $borderColor), _(*11)
- $percent - What percentage of the image to create the reflection from.
- $reflection - What percentage of the image height should the reflection height be.
- $white - How transparent (using white as the background) the reflection should be, as a percent.
- $border - Whether a border should be drawn around the original image.
- $borderColor - The hex value of the color you would like your border to be.

Whitespace Cropper plugin

createWhitespaceCropper($border, $color), _(*12)
- $margin - What pixels of a margin should be around the original image.
- $color - The hex value of the color you would like to crop.

Watermark plugin

createWatermark(PHPThumb $watermarkThumb, $position = [0, 0], $scale = .5), _(*13)
- $watermarkThumb - Watermark image from watermark file.
- $position - Position of watermark, center by default:
  - [0, 0] - center
  - [-1, -1] - left bottom
  - [-1, 1] - left top
  - [1, 1] - right top
  - [1, -1] - right bottom
- $scale - Scale of the watermark relative to the image.