Skip to content

โšก๏ธ ๐Ÿ–ผ A PHP package to generate Cloudflare Image Resizing URLs

License

Notifications You must be signed in to change notification settings

aneeskhan47/php-cloudflare-image-resizing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

15 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

PHP Cloudflare Image

GitHub Workflow Status (master) Total Downloads Latest Version License


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

โšก๏ธ Installation

Requires PHP 8.2+

composer require aneeskhan47/php-cloudflare-image-resizing

โ“ How it works

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.


๐Ÿš€ Usage

Generating a URL without any transformations

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.

Generating a URL with transformations

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

Available transformations

Please see the available transformations here.


๐Ÿงช Testing

๐Ÿงน 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

๐Ÿ“ Changelog

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


๐Ÿค Contributing

Please see CONTRIBUTING for details.


๐Ÿ”’ Security

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


๐Ÿ™Œ Credits


๐Ÿ“œ License

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


๐Ÿ”ง Skeleton PHP Boilerplate

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

About

โšก๏ธ ๐Ÿ–ผ A PHP package to generate Cloudflare Image Resizing URLs

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages