codeinwp/optimole-sdk

SDK for Optimole cloud-based image optimization service

v1.0.0 2024-04-07 10:55 UTC

Requires

• php: >=7.4
• symfony/polyfill-php80: ^1.29

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: ^9.6

MIT

• Optimole Team

README

The Optimole PHP SDK makes it easy for PHP developers to integrate Optimole cloud-based image optimization service in their PHP project.

Requirements

• PHP >= 7.4

Installation

Install the Optimole PHP SDK in your project using composer:

$ composer require codeinwp/optimole-sdk

Usage

To begin, you need to create an account on Optimole and get your API key. You can then initialize the SDK with your API key using the Optimole facade:

use Optimole\Sdk\Optimole;

Optimole::init('your-api-key');

The Optimole facade is your starting point for creating optimized images or other assets. You can control the optimization properties using the fluent interface provided by the SDK. Here's an example of how to optimize an image by changing its quality and cropping it:

use Optimole\Sdk\Optimole;

$image = Optimole::image('https://example.com/image.jpg')->quality(80)->resize('crop');

You can get the optimized image URL using the getUrl method or casting the object to a string:

echo $image->getUrl();
echo (string) $image;

Contributing

Install dependencies using composer and run the test suite:

$ composer install
$ vendor/bin/phpunit