About PageImage Manipulator

This module provide basic Imagemanipulations for PageImages or Imagefiles! FOR PW > 2.5.11+ and PW 3+, ONLY USE PageImageManipulator 2 !

Category Photo/Video/Audio
Modules that perform some function related to media such as photos and audio/video.
Release StateStable
Should be safe for use in production environments. *
Authorhorst
Module Version0.2.4
Class NamePageImageManipulator
Compatibility2.3, 2.4, 2.5, 2.6, 2.7, 3.0
Date AddedAugust 17, 2013
Last UpdatedNovember 27, 2016
Recommended ByNew recommendations may take up to 1 day to appear.

Details

How does it work?

pw_pim_codeexample01.jpg

You can enter the ImageManipulator by calling the method pimLoad(). After that you can chain together how many actions in what ever order you like. If your manipulation is finished, you call pimSave() to write the memory Image into a diskfile. pimSave() returns the PageImage-Object of the new written file so we are able to further use any known PW-image property or method. This way it integrates best into the ProcessWire flow.

The three examples above put out the same visual result: a grayscale image with a width of 240px. Only the filenames will slightly differ.

You have to define a name-prefix that you pass with the pimLoad() method. If the file with that prefix already exists, all operations are skipped and only the desired PageImage-Object gets returned by pimSave(). If you want to force recreation of the file, you can pass as second param a boolean true: pimLoad('myPrefix', true).

You may also want to get rid of all variations at once? Than you can call $pageimage->pimLoad('myPrefix')->removePimVariations()!

A complete list of all methods and actions are available here.

You may also visit the post with tips & examples.

Instructions

This module's files should be placed in /site/modules/PageImageManipulator/
How to install or uninstall modules

README

PageImage Manipulator beta for ProcessWire 2.3+ and Pageimage Manipulator 2 for PW 2.5.11+

This module provide basic Imagemanipulations for PageImages and Imagefiles

The Page Image Manipulator is a module that let you in a first place do ImageManipulations with your PageImages. - And in a second place there is the possibility to let it work on any imagefile that exists in your servers filesystem, regardless if it is a 'known PW-image'.

The Page Image Manipulator is a Toolbox for Users and Moduledevelopers. It is written to be as close to the Core ImageSizer as possible. Besides the GD-filterfunctions it contains resize, crop, rotate, flip, sharpen and 3 watermark methods.

How does it work?

You can enter the ImageManipulator by calling the method pimLoad(). After that you can chain together how many actions in what ever order you like. If your manipulation is finished, you call pimSave() to write the memory Image into a diskfile. pimSave() returns the PageImage-Object of the new written file so we are able to further use any known PW-image property or method. This way it integrates best into the ProcessWire flow.

You have to define a name-prefix that you pass with the pimLoad() method. If the file with that prefix already exists, all operations are skipped and only the desired PageImage-Object gets returned by pimSave(). If you want to force recreation of the file, you can pass as second param a boolean true: pimLoad('myPrefix', true).

You may also want to get rid of all variations at once? Than you can call $pageimage->pimLoad('myPrefix')->removePimVariations()!

A complete list of all methods and actions can be found here: http://processwire.com/talk/topic/4264-release-page-image-manipulator/

Version history

0.2.9 / 0.2.4

  • corrected version numbers

0.2.8

0.2.7

  • Pim2 fixed a bug with naming scheme of Pageimage Variationnames, a missing dot that prevented PW from detecting the variations
  • Pim2 now uses wireChmod on save.

0.2.0 / 0.2.6

0.1.5

0.1.4

0.1.3

  • fixed a bug with ignoring outputFormat when send as $options with method pimLoad found by @titanium
  • added support for php versions with buggy GD-lib for sharpening and unsharpMask
  • added support for the coming module PageimageNamingScheme into pimVariations()

0.1.2

  • added support for sharpening-value 'none'

0.1.1

  • added a hook that add pim_* variations to pageimage-variation-collection

0.1.0

  • added method getPimVariations()

0.0.9

  • fixed issue with pimSave, added a check if DIB was loaded, and if not do it.

0.0.8

  • added enhanced support for Thumbnails module, including permanent storage for CropRectangleCoords and params
  • fixed / rewritten all bg-color stuff to support rgba alpha channel
  • fixed a E-Notice with IPTC prepare
  • changed the params of method resize, width, height to be the same like in new ImageSizer, ($sharpen can have value 'none') Sorry for breaking compatibility!

0.0.5

  • added method canvas
  • added method unsharpMask

0.0.4

  • added method watermarkText

0.0.3

  • added support for positioning the watermark in method watermarkLogo

Comments

  • Pauline

    Pauline 2 years ago 20

    Many thanks! Using & loving it a lot!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.