A lightweight, modern image resizer for MODX
PHP
Latest commit 03ebed5 May 26, 2014 @oo12 oo12 v1.0.1
Permalink
Failed to load latest commit information.
_build v1.0.1 May 26, 2014
core/components/resizer v1.0.1 May 26, 2014
.gitignore v1.0.0-rc1 Apr 20, 2014
LICENSE Initial commit Aug 25, 2013
README.md v1.0.0-pl Apr 30, 2014

README.md

Resizer v1.0.0-pl

A simple, modern image resizer for MODX. Built on Imagine, Resizer supports the Gmagick, Imagick and GD extensions and can be considerably faster than phpThumb for image sizing and cropping operations. Available from the MODX Extras Repo.

Requirements

  • PHP 5.3.2 or higher
  • One or more of the following PHP extensions: Gmagick, Imagick (with ImageMagick 6.2.9 or higher), GD 2.0.1 or higher

Both Imagick and Gmagick offer much better performance and lower memory requirements than GD, especially if you're using a relatively recent version of ImageMagick/GraphicsMagick. I think Imagick is the best overall: good performance and good support for all features. Gmagick is a bit faster but doesn’t have full support for opacity, though this only matters if you’re adding partially transparent backgrounds to PNGs or using watermarks. If your site does lots of image resizing—especially thumbnailing large jpegs—Imagick or Gmagick will be much faster.

Usage

Resizer is a PHP class and can only be called from a snippet. If you’re not developing your own snippet you’ll probably want to install a higher-level package which supports Resizer, like pThumb.

pThumb

Change the phpthumbof.use_resizer system setting to Yes to enable Resizer globally, or use [[pthumb? &useResizer=`1` ...]] for a particular instance. See the Options section below for supported options. Other than that, use it just like you always have.

Snippet Developers

Sample code:

$modx->loadClass('Resizer', MODX_CORE_PATH . 'components/resizer/model/', true, true);
$resizer = new Resizer($modx);  // pass in the modX object
$resizer->debug = true;  // (optional) Enable debugging messages.
$resizer->processImage(
    '/full/path/input-image.png',  // input image file. Path can be absolute or relative to MODX_BASE_PATH
    'relative/path/output-image.jpg',  // output image file. Extension determines image format
    array('w' => 600, 'scale' => 1.5)  // or 'w=600&scale=1.5' instead of an array
);
// (optional) Write debug message array to the MODX error log
$modx->log(modX::LOG_LEVEL_ERROR, 'Resizer debug output' . substr(print_r($resizer->debugmessages, TRUE), 7, -2);

Options

Resizer only supports a subset of phpThumb options, the most useful and commonly used ones. Many of phpThumb’s options are arguably better handled now or in the near future with CSS transforms and filters anyway, so I haven’t implemented these. But if there’s one you’ve just got to have, open an issue.

Supported phpThumb Options

OptionDescriptionValue/Unit
wmax widthpixels
hmax heightpixels
wlmax width: landscape orientation. If an image is wider than it is tall, a value for wl will override one for w. This and the following 5 options are broken in phpThumb but work in Resizer.pixels
hlmax height: landscape orientationpixels
wpmax width: portrait orientationpixels
hpmax height: portrait orientationpixels
wsmax width: squarepixels
hsmax height: squarepixels
swSource crop: Width. A source crop is applied to the input image before any of the other sizing or cropping operations are performed. For this and the following three options, values 1 or greater are interpreted as pixels and values between 0 and 1 as percentages, similar to phpThumb. Default: 100%pixels (or % if < 1)
shSource crop: Height. Default: 100%pixels (or % if < 1)
sxSource crop: left side. sx and sy control the starting point for the crop box. Resizer will adjust this value if needed to keep the right side from going past the opposite edge of the image. Default: center croppixels (or % if < 1)
sySource crop: top side. Default: center croppixels (or % if < 1)
aoeAllow Output Enlargement. Turning this on will allow the output image to be interpolated up if the requested size exceeds the resolution of the input image.1 or 0 (default: 0)
bgBackground Color. Specifies a background color for input images with transparency or when extending the background with far. Colors are specified with 3- or 6-digit hex values, just like CSS. A leading # is optional. Also optional is an opacity value (0–100) at the end, separated by a /. Opacity only applies if the output format is PNG. Examples: #a00, 333333, F9AE90/75
farForce Aspect Ratio. Width and height must both be specified. Scales an image to fit inside the box specified by width and height, then adds a solid color (white by default, or bg) if necessary to make the output image exactly width x height. The value given indicates how the image will be positioned inside the box. l=left, r=right, t=top, b=bottom, c=centertl, t, tr
l, c, r
bl, b, br
qJPEG qualityinteger (default: 75)
zcZoom Crop. Sizes an image to fill the given box (both a width and a height must be specified) and crops off any extra. The value indicates the portion of the image you’d like to retain: top left, center, bottom right, etc. (You can also use 1 for center.) Overrides far. Unlike with phpThumb, all these options work with GD as well.tl, t, tr
l, c, r
bl, b, br
fltr[]=usm Unsharp mask. Amount, radius and threshold are fixed and can’t be specified.
fltr[]=wmt Text watermark. Parameters mostly follow phpThumb, except tiling isn’t supported. The font path should be absolute, or relative to MODX assets path, core path, or {core path}/model/phpthumb/fonts. Leave the font blank for the default, Fira Sans.
fltr[]=wmi Image watermark. Parameters mostly follow phpThumb, except tiling isn’t supported. The watermark image path should be absolute, or relative to MODX assets path, core path, or {core path}/model/phpthumb/images.

Output file type — Resizer doesn’t explicitly support phpThumb’s f option, but instead infers the proper image type from the output filename’s extension. Some wrappers like pThumb handle the f option in the usual way.
Supported formats: jpg (or jpeg), png, gif, wbmp, xbm.

New Options

OptionDescriptionValue/Unit
scaleConvenient when creating retina images. Any dimensions given will be multiplied by this number internally. If aoe is off—the default—and the input image doesn’t have sufficient resolution, scale will be adjusted downward so you get as much output resolution as possible without scaling the image up.number > 1
qmaxAn upper limit jpeg quality. If the requested size exceeds the input image resolution and aoe is off, Resizer can increase the jpeg quality in an attempt to compensate. Quality begins at q (input resolution = output resolution) and reaches qmax when the input resolution is 1/2 of the requested output resolution.1–100 (should be greater than q)

Settings

Resizer provides one system setting, resizer.graphics_library. Normally you’ll leave this set at 2 (auto). In that case Resizer will check the following extensions in this order and pick the first one it finds: Imagick, Gmagick, GD. Setting it to 1 will restrict it to Gmagick or GD, 0 to GD only.

An Example with Retina Images

scale and qmax are designed to help when working with high-dpi (“Retina”) images. As an example, say you have several images on a page which should each be 600px x 400px but you’d like to increase the images’ natural size to look good on a retina display. You want to use the trick of a large—2x, say—image size with a low quality setting in order to get sharper images without making them too big. However, the client is suppling the images and they may not all be a minimum of 1200px x 800px. In fact some may be quite a bit smaller. There's no point in scaling these up on the server, but reducing the jpeg quality will make them look worse than they do already. Here’s where the new options come in.

You might use these options: width:600, height:400, zc:1, scale:2, q:55, qmax:75.

scale makes it easy to adjust the natural size. If you later decide 1.6x will be better than 2x, just do a search and replace. If you have multiple images and especially if they’re different sizes, this is much easier than figuring out what size each should be on the page, then multiplying each width and height by the new scale and editing all the w and h options. scale will adjust downward if there’s not enough input resolution. So if the original image is only 1000px x 700px scale will slide down to 1.67 and the output image will be 1000px x 667px.

qmax lets the jpeg quality slide up as if the input image isn’t big enough. If it’s only a little too small then q will increase only a little. Say the client uploads two images: one 1100px x 750px and one 300px x 200px. The first one has almost all the resolution we need; it’ll come out 1100 x 733 with q set to 61. The second image is way too small: 0.06 MP (megapixels) when we need 0.96 MP. Since it’s less than 1/2 the resolution we’re looking for, its q is set to 75 (our qmax setting).