Versions:

This document contains information about a future release and not the current stable version (4). Be aware that information on this page may change and API's may not be stable for production use.

Image

Image files can be stored either through the [Image](api:SilverStripe\Assets\Image) dataobject, or though DBFile fields. In either case, the same image resizing and manipulation functionality is available though the common ImageManipulation trait.

Usage

Managing images through form fields

Images can be uploaded like any other file, through FileField. Allows upload of images through limiting file extensions with setAllowedExtensions().

Inserting images into the WYSIWYG editor

Images can be inserted into [HTMLValue](api:SilverStripe\View\Parsers\HTMLValue) database fields through the built-in WYSIWYG editor. In order to retain a relationship to the underlying [Image](api:SilverStripe\Assets\Image) records, images are saved as shortcodes. The shortcode ([image id="<id>" alt="My text" ...]) will be converted into an <img> tag on your website automatically.

See HTMLEditorField.

Manipulating images in Templates

You can manipulate images directly from templates to create images that are resized and cropped to suit your needs. This doesn't affect the original image or clutter the CMS with any additional files, and any images you create in this way are cached for later use. In most cases the pixel aspect ratios of images are preserved (meaning images are not stretched).

Here are some examples, assuming the $Image object has dimensions of 200x100px:

// Scaling functions
$Image.ScaleWidth(150) // Returns a 150x75px image
$Image.ScaleMaxWidth(100) // Returns a 100x50px image (like ScaleWidth but prevents up-sampling)
$Image.ScaleHeight(150) // Returns a 300x150px image (up-sampled. Try to avoid doing this)
$Image.ScaleMaxHeight(150) // Returns a 200x100px image (like ScaleHeight but prevents up-sampling)
$Image.Fit(300,300) // Returns an image that fits within a 300x300px boundary, resulting in a 300x150px image (up-sampled)
$Image.FitMax(300,300) // Returns a 200x100px image (like Fit but prevents up-sampling)

// Warning: This method can distort images that are not the correct aspect ratio
$Image.ResizedImage(200, 300) // Forces dimensions of this image to the given values.

// Cropping functions
$Image.Fill(150,150) // Returns a 150x150px image resized and cropped to fill specified dimensions (up-sampled)
$Image.FillMax(150,150) // Returns a 100x100px image (like Fill but prevents up-sampling)
$Image.CropWidth(150) // Returns a 150x100px image (trims excess pixels off the x axis from the center)
$Image.CropHeight(50) // Returns a 200x50px image (trims excess pixels off the y axis from the center)

// Padding functions (add space around an image)
$Image.Pad(100,100) // Returns a 100x100px padded image, with white bars added at the top and bottom
$Image.Pad(100, 100, CCCCCC) // Same as above but with a grey background

// Metadata
$Image.Width // Returns width of image
$Image.Height // Returns height of image
$Image.Orientation // Returns Orientation
$Image.Title // Returns the friendly file name
$Image.Name // Returns the actual file name
$Image.FileName // Returns the actual file name including directory path from web root
$Image.Link // Returns relative URL path to image
$Image.AbsoluteLink // Returns absolute URL path to image

Image methods are chainable. Example:

<body style="background-image:url($Image.ScaleWidth(800).CropHeight(800).Link)">

Padded Image Resize

The Pad method allows you to resize an image with existing ratio and will pad any surplus space. You can specify the color of the padding using a hex code such as FFFFFF or 000000.

You can also specify a level of transparency to apply to the padding color in a fourth param. This will only effect png images.

$Image.Pad(80, 80, FFFFFF, 50) // white padding with 50% transparency
$Image.Pad(80, 80, FFFFFF, 100) // white padding with 100% transparency
$Image.Pad(80, 80, FFFFFF) // white padding with no transparency

Manipulating images in PHP

The image manipulation functions can be used in your code with the same names, example: $image->Fill(150,150).

Some of the MetaData functions need to be prefixed with 'get', example getHeight(), getOrientation() etc.

Please refer to the ImageManipulation API documentation for specific functions.

Creating custom image functions

You can also create your own functions by decorating the Image class.

class ImageExtension extends \SilverStripe\Core\Extension
{

    public function Square($width)
    {
        $variant = $this->owner->variantName(__FUNCTION__, $width);
        return $this->owner->manipulateImage($variant, function (\SilverStripe\Assets\Image_Backend $backend) use($width) {
            $clone = clone $backend;
            $resource = clone $backend->getImageResource();
            $resource->fit($width);
            $clone->setImageResource($resource);
            return $clone;
        });
    }

    public function Blur($amount = null)
    {
        $variant = $this->owner->variantName(__FUNCTION__, $amount);
        return $this->owner->manipulateImage($variant, function (\SilverStripe\Assets\Image_Backend $backend) use ($amount) {
            $clone = clone $backend;
            $resource = clone $backend->getImageResource();
            $resource->blur($amount);
            $clone->setImageResource($resource);
            return $clone;
        });
    }

}
SilverStripe\Assets\Image:
  extensions:
    - ImageExtension
SilverStripe\Filesystem\Storage\DBFile:
  extensions:
    - ImageExtension

Form Upload

For usage on a website form, see FileField.

Image Quality

Source images

Whenever SilverStripe performs a manipulation on an image, it saves the output as a new image file, and applies compression during the process. If the source image already had lossy compression applied, this leads to the image being compressed twice over which can produce a poor result. To ensure the best quality output images, it's recommended to upload high quality source images (minimal or no compression) in to your asset store, and let SilverStripe take care of applying compression.

Very high resolution images may cause GD to crash (especially on shared hosting environments where resources are limited) so a good size for website images is around 2000px on the longest edge.

Forced resampling

Since the 'master' images in your asset store may have a large file size, by default SilverStripe will always apply compression to your images to save bandwidth - even if no other manipulation (such as a crop or resize) is taking place. If you expect the images in your asset store to already have compression applied and want to serve up the original when no resampling is necessary, you can add this to your mysite/config/config.yml file:

# Configure resampling for File dataobject
File:
  force_resample: false
# DBFile can be configured independently
SilverStripe\Filesystem\Storage\DBFile:
  force_resample: false

Resampled image quality

To adjust the quality of the generated images when they are resampled, add the following to your mysite/config/config.yml file:

       SilverStripe\Core\Injector\Injector:
         SilverStripe\Assets\InterventionBackend:
           properties:
             Quality: 90

## Changing the manipulation driver to Imagick {#changing-the-manipulation-driver-to-imagick}

If you want to change the image manipulation driver to use Imagick instead of GD, you'll need to change your config so
that the `Intervention\Image\ImageManager` is instantiated with the `imagick` driver instead of GD:

```yml
SilverStripe\Core\Injector\Injector:
  Intervention\Image\ImageManager:
    constructor:
      - { driver: imagick }

API Documentation

Was this article helpful?