ringierimu/image-service-php

Ringier SA Image Service PHP integration helper

2.0.0 2024-02-09 15:54 UTC

Requires

• php: >= 7.3

Requires (Dev)

• phpunit/phpunit: ^9.5
• ringierimu/ringier-code-style: ^0.6

proprietary

• Matthew Nessworthy

README

Usage examples

Instantiate an instance of the resize helper using the image service base url and security key you were provided

$imageResize = new ImageResize(
    'https://image-service.ringier.tech/',
    'your-security-key',
);

Resize an image

PROJECT referes to the integration project VENTURE some projects share configuration but with branding differences (i.e., same brand, different countries) RESIZE_KEY the specific key relating to the resizing rules that will be applied to the SOURCE_IMAGE_PATH SOURCE_IMAGE_PATH the full S3 path includinf the filename of the source image that should be resized

$url = $imageResize->buildUrl(
    'PROJECT',
    'VENTURE',
    'RESIZE_KEY',
    'SOURCE_IMAGE_PATH',
);

Template image

PROJECT referes to the integration project VENTURE some projects share configuration but with branding differences (i.e., same brand, different countries) RESIZE_KEY the specific key relating to the resizing rules that will be applied to the SOURCE_IMAGE_PATH SEO_FILENAME an SEO friendly filename and image type, e.g., iphone-10-pro-max-128gb-space-grey-silver.jpg TEMPLATE_NAME the template key that should be used (this will determin what replacements are available) REPLACEMENT_KEY predefined replacements keys matching the template in use REPLACEMENT_VALUE values to be used in the template replacing said key IMAGE_KEY similar to predefined replacements keys, this refers to images to replace in the template IMAGE_PATH the full S3 path including the filename of the source image be used in the template

$url = $imageResize->buildTemplateUrl(
    'PROJECT',
    'VENTURE',
    'RESIZE_KEY',
    'SEO_FILENAME',
    [
        'template' => 'TEMPLATE_NAME',
        'replacements' => [
            'REPLACEMENT_KEY' => 'REPLACEMENT_VALUE',
            // ...
        ],
        'images' => [
            'IMAGE_KEY' => [
                'file' => 's3://IMAGE_PATH',
            ],
            // ...
        ],
    ] 
);