Site Config

Images

Although images can be managed by your users in the Administration Dashboard, Site Creators need to define some configuration for how images appear in the templates you create.

Images can be customised by campaign, language and country.

There are two concepts to understand:

Named images

Named images are hero images that can be edited by your users. The name is identifies the image for the whole campaign which means that if you wish to set an alternative hero image for the "thank you for your donation" page, you need to create two named images.

Image ratios

Essentially a pre-defined image ratio for cropping allowing you to use different images sizes in different designs on the same site and your users to be able to crop the images to that ratio.

setNamedImages

setNamedImages defines an editable hero image and sets a default image for that named image.

$config->setNamedImages([
    'hero-background' => '/images/hero/empowering-families.jpg',
    'hero-background-thank-you' => '/images/hero/empowering-families.jpg',
]);

setImageRatios

setImageRatios defines image ratios that your templates support. These ratios are presented to your users when they are uploading an image allowing them to crop the image to the necessary ratio.

$config->setImageRatios([
    '1.8' => 'Standard Hero',
    '1' => 'Background'
]);