ImageProcessor

A PHP library to resize / convert images

• Requirements
• Installation
  • Composer
  • Manual installation
• Usage
  • Basic usage
  • Specify image type
  • Output to string
  • Output to base64 encoded string / base64 data URI
• Reference
  • ImageProcessor
    • __construct()
    • setResourceFromPath()
    • setResourceFromFileData()
    • getWidth()
    • setWidth()
    • getHeight()
    • setHeight()
    • Object fit
      • getObjectFit()
      • setObjectFit()
    • Canvas fit
      • getCanvasFit()
      • setCanvasFit()
    • Type
      • getType()
      • setType()
    • Quality
      • getQuality()
      • setQuality()
    • Background
      • getBackground()
      • setBackground()
    • getFileData()
    • save()
  • ImageResource

• PHP 7+
• GD library

Run the following command:

composer require widgets-nl/image-processor

• Clone or download the project
• Copy ImageProcessor.php and ImageResource.php to your directory of choice.
• Make sure the two files are autoloaded / included e.g.:

require_once 'ImageProcessor.php';
require_once 'ImageResource.php';

<?php

    use WidgetsNL\ImageProcessor\ImageProcessor;
    
    $image = new ImageProcessor('sample_images/landscape.jpg');
    $image
        ->setWidth(100)
        ->setHeight(100)
        ->save('output.jpg')
    ;

<?php

    use WidgetsNL\ImageProcessor\ImageProcessor;
    
    $image = new ImageProcessor('sample_images/landscape.jpg');
    $image
        ->setType(ImageProcessor::TYPE_PNG)
        ->save('output.png')
    ;

<?php

    use WidgetsNL\ImageProcessor\ImageProcessor;
    
    $image = new ImageProcessor('sample_images/landscape.jpg');
    $image
        ->setWidth(100)
        ->setHeight(100)
    ;
    $imageData = $image->getFileData();
    
    header('Content-Type: image/jpeg');
    echo $imageData;

<?php

    use WidgetsNL\ImageProcessor\ImageProcessor;
    
    $image = new ImageProcessor('sample_images/landscape.jpg');
    $image
        ->setWidth(100)
        ->setHeight(100)
    ;
//    $imageData = $image->getFileData(ImageProcessor::DATA_ENCODING_BASE64);
    $imageDataURI = $image->getFileData(ImageProcessor::DATA_ENCODING_BASE64_DATA_URI);

?>

<img src="/sitelet?url=https%3A%2F%2Fgithub.com%2FWidgetsNL%2F%253Cspan%2520class%3D"pl-ent"><?php echo $imageDataURI; ?>">
<!-- This will output src="data:image/jpeg;base64, ... ... " -->

Class constructor

Parameters

Example:

$image = new ImageProcessor();

// Or

$image = new ImageProcessor('test.jpg');

// Or

$image = new ImageProcessor(file_get_contents('test.jpg'));

Loads image from specified path. Creates an ImageResource instance internally.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor();
$image->setResourceFromPath('test.jpg');

Loads image from raw image data. Creates an ImageResource instance internally.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor();
$image->setResourceFromFileData(file_get_contents('test.jpg'));

Returns the current width setting.

Set the width of the output image.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor('test.png');
$image
    ->setWidth(100)
    ->save('test_copy.png')
;

Returns the current height setting.

Set the height of the output image.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor('test.png');
$image
    ->setHeight(100)
    ->save('test_copy.png')
;

The object fit setting is inspired by the object-fit CSS property and works pretty much the same way.

There are 3 possible values:

Returns the current object fit setting.

Set the object fit setting to be applied to the image upon output.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor('test.jpg');
$image
    ->setWidth(100)
    ->setHeight(100)
    ->setObjectFit(ImageProcessor::OBJECT_FIT_COVER)
    ->save('test_copy.jpg')
;

The canvas fit setting determines whether or not the output image canvas must be cropped to match the image. This setting is only relevant when setting the object fit setting to ImageProcessor::OBJECT_FIT_CONTAIN

There are 2 possible values:

Returns the current canvas fit setting.

Set the canvas fit setting to be applied to the image upon output.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor('test.jpg');
$image
    ->setWidth(100)
    ->setHeight(100)
    ->setCanvasFit(ImageProcessor::CANVAS_FIT_KEEP)
    ->save('test_copy.jpg')
;

When loading an image from a file path, the output file type will automatically be of the same type by default. When no type can be determined (e.g. when loading an image from raw image data), image/jpeg will be used by default.

You may also specify an output type to be used.

Currently, there are 3 supported file types:

Returns the current type setting.

Set the type to be used on the output image.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor('test.jpg');
$image
    ->setType(ImageProcessor::TYPE_PNG)
    ->save('test.png')
;

Sets the image quality (compression level) to be used on the output image.

This setting does not apply to gif images, and has little to no effect on most png images.

The quality setting uses a 1-100 value, but has some built-in defaults:

Returns the current quality setting.

Set the quality setting to be applied to the image upon output.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor('test.jpg');
$image
    ->setQuality(ImageProcessor::QUALITY_LOW)
    ->save('test_copy.jpg')
;

Sets the background fill style/color to be used on the output image.

The background may be set to any valid hex color (e.g. #FF0000), but the short (#F00) notation is not supported. The pound/hash sign is optional.

For png or gif images, you may use the TRANSPARENT setting. Some built-in values:

Returns the current background setting.

Set the background setting to be applied to the image upon output.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor('test.png');
$image
//    ->setBackground('#FF0000')
    ->setBackground(ImageProcessor::BACKGROUND_WHITE)
    ->save('test_copy.png')
;

Returns the output image as a string of image data.

The data encoding may be specified using the encoding parameter, which can be set to one of:

Parameters

Example:

$image = new ImageProcessor('test.jpg');
$image->setWidth(100);
$rawImageData = $image->getFileData();

Saves the output image to given path.

For chainability, this method returns the ImageProcessor instance.

Parameters

Example:

$image = new ImageProcessor('test.png');
$image
    ->setWidth(100)
    ->save('test_copy.jpg')
;

This class is used internally and has no accessible public members or methods.