mongroove/avetec-php

A client library for generating image URLs with Avetec.

dev-main 2024-10-10 05:31 UTC

Requires

• php: ^8.2

Requires (Dev)

• phpunit/phpunit: ^11.4

BSD-2-Clause

• avetec

README

avetec-php

A php client library for generating image URLs with avetec

• Installation
• Usage
• Advanced functions

Installation

You can install the package via composer:

composer require mongroove/avetec-php

Usage

To begin creating avetec URLs programmatically, add the php files to your project. The URL builder can be reused to create URLs for any images on the domains it is provided.

use Avetec\UrlBuilder;

$urlBuilder = new UrlBuilder("example.domain.com", 'your-secret-key');
$params = array("w" => 500, "h" => 500);

echo $urlBuilder->createURL("856c4490-784f-4a8e-a918-aa66c0398a9q", 'png', $params);

// 'https://example.domain.com/856c4490-784f-4a8e-a918-aa66c0398a9q.png?h=500&w=500'

Advanced functions

Base64 Params

The parameters can be bundled and output with an encrypted base64 parameter, call setUseBase64 on the builder.

$urlBuilder->setUseBase64(true);
echo $urlBuilder->createURL("856c4490-784f-4a8e-a918-aa66c0398a9q", 'png', $params);

// https://example.domain.com/v1/856c4490-784f-4a8e-a918-aa66c0398a9q.png?bc=eyJ3Ijo1MDAs...

Add slug

To pass a slug, an additional parameter can be inserted as follows.

echo $urlBuilder->createURL("856c4490-784f-4a8e-a918-aa66c0398a9q", 'png', $params, 'special');

// 'https://example.domain.com/special/856c4490-784f-4a8e-a918-aa66c0398a9q.png'