Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Image Thumbnailer for Zend Framework.
branch: master

This branch is 33 commits behind webino:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src
.gitignore
LICENSE.txt
Module.php
README.md
autoload_classmap.php
autoload_function.php
autoload_register.php
composer.json

README.md

Image Thumbnailer for Zend Framework

Service that provide API to manipulate images.

Powered by PHPThumb

Features

  • Resize, crop, pad, rotate, show and save images.
  • Create image reflection.

Setup

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

  1. Run: php composer.phar require webino/webino-image-thumb:1.*
  2. Add WebinoImageThumb to the enabled modules list.

Requirements

  • GD 2.0+

QuickStart

  • For example add following code to controller action, assume example image:

    $thumbnailer = $this->getServiceLocator()->get('WebinoImageThumb');
    $thumb       = $thumbnailer->create('public/images/example.jpg', $options = array());
    
    $thumb->resize(100, 100);
    
    $thumb->show();
    // or/and
    $thumb->save('public/images/resized.jpg');
    
  • Use reflection plugin:

    $thumb->createReflection(40, 40, 80, true, '#a4a4a4');
    

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:

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 array(255,255,255) array([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 array(255,255,255) array([0-255], [0-255], [0-255])

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 = array(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()
  • getErrorMessage()
  • getFileName()
  • getFormat()
  • getHasError()
  • getImportedFunctions()
  • getMaxHeight()
  • getMaxWidth()
  • getNewDimensions()
  • getNewImage()
  • getOldImage()
  • getOptions()
  • getPercent()
  • getWorkingImage()
  • setCurrentDimensions($currentDimensions)
  • setErrorMessage($errorMessage)
  • setFileName($fileName)
  • setFormat($format)
  • setHasError($hasError)
  • setMaxHeight($maxHeight)
  • setMaxWidth($maxWidth)
  • setNewDimensions($newDimensions)
  • setNewImage($newImage)
  • setOldImage($oldImage)
  • setOptions($options)
  • setPercent($percent)
  • setWorkingImage($workingImage)

Reflection plugin

  • createReflection($percent, $reflection, $white, $border = true, $borderColor = '#a4a4a4')

    • $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.

Addendum

Most of the documentation is taken from the PHPThumb wiki.

Please, if you are interested in this Zend Framework module report any issues and don't hesitate to contribute.

Report a bug | Fork me

Something went wrong with that request. Please try again.