aneeskhan47 / php-cloudflare-image-resizing Goto Github PK

A PHP package to generate Cloudflare Image Resizing URLs. based on Cloudflare Image Resizing.

Requires PHP 8.2+

composer require aneeskhan47/php-cloudflare-image-resizing

Cloudflare Image Resizing is a feature that allows you to resize, crop, and convert images by simply changing the URL of the image. This is done by adding a set of image transformation parameters to the URL of the image, which Cloudflare will then use to generate a new image on the fly.

So just by adding /cdn-cgi/image/ to the beginning of the URL, you can utilize Cloudflare's image resizing feature.

You can convert and resize images by requesting them via a specially-formatted URL. This way you do not need to write any code, only change HTML markup of your website to use the new URLs.

For more information, please see the Cloudflare Image Resizing documentation.

This package provides a fluent API to generate Cloudflare Image Resizing URLs.

use AneesKhan47\CloudflareImageResizing\CFImageResizing;

$url = 'https://example.com/uploads/2023/image.jpg';

$image = CFImageResizing::make($url)->build();

// output: 
// https://example.com/cdn-cgi/image/format=auto/uploads/2023/image.jpg

// note: format=auto is added by default to the URL as it is required 
// by Cloudflare to have atleast one transformation applied.

use AneesKhan47\CloudflareImageResizing\CFImageResizing;

$url = 'https://example.com/uploads/2023/image.jpg';

$image = CFImageResizing::make($url)
                        ->width(300)
                        ->height(300)
                        ->webp()
                        ->quality(80)
                        ->build();

// output: 
// https://example.com/cdn-cgi/image/width=300,height=300,format=webp,quality=80/uploads/2023/image.jpg

Please see the available transformations here.

🧹 Keep a modern codebase with Pint:

composer lint

✅ Run refactors using Rector

composer refacto

⚗️ Run static analysis using PHPStan:

composer test:types

✅ Run unit tests using PEST

composer test:unit

🚀 Run the entire test suite:

composer test

Please see CHANGELOG for more information on what has changed recently.

Please see CONTRIBUTING for details.

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

• Anees Khan
• All Contributors

The MIT License (MIT). Please see License File for more information.

This package was generated using the Skeleton PHP by Nuno Maduro.