choowx/rasterize-svg

A PHP library for converting SVG to JPEG, PNG, and WEBP

v0.1.2 2024-07-22 08:57 UTC

Requires

• php: ^8.1
• spatie/temporary-directory: ^2.1
• symfony/process: ^6.2|^7.0

Requires (Dev)

• laravel/pint: ^1.0
• pestphp/pest: ^2.15
• sapientpro/image-comparator: ^1.0

MIT

• Choo Wen Xuan

• php
• convert
• png
• svg
• jpeg
• jpg
• rasterize
• Webp
• choowx
• rasterize-svg

README

Installation

You can install the package via composer:

composer require choowx/rasterize-svg

This package relies on the sharp js package being available on your system. In most cases you can accomplish this by issue this command in your project.

npm install sharp

Usage

use Choowx\RasterizeSvg\Svg;

$svgString = '<svg width="100" height="100" viewBox="0 0 100 100"...';

$jpegBinaryString = Svg::make($svgString)->toJpeg();
$jpegBinaryString = Svg::make($svgString)->toJpg(); // Alias of toJpeg()
$pngBinaryString = Svg::make($svgString)->toPng();
$webpBinaryString = Svg::make($svgString)->toWebp();

If you want to straight away save the rasterized image on disk:

use Choowx\RasterizeSvg\Svg;

$svgString = '<svg width="100" height="100" viewBox="0 0 100 100"...';

Svg::make($svgString)->saveAsJpeg('path/to/rasterized.jpeg');
Svg::make($svgString)->saveAsJpg('path/to/rasterized.jpg'); // Alias of saveAsJpeg()
Svg::make($svgString)->saveAsPng('path/to/rasterized.png');
Svg::make($svgString)->saveAsWebp('path/to/rasterized.webp');

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Choo Wen Xuan
• All Contributors

License

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