rasterize-svg

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 22 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

[![Latest Version on Packagist](https://img.shields.io/packagist/v/choowx/rasterize-svg.svg?style=flat-square)](https://packagist.org/packages/choowx/rasterize-svg)
[![Tests](https://img.shields.io/github/actions/workflow/status/choowx/rasterize-svg/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/choowx/rasterize-svg/actions/workflows/run-tests.yml)
[![Total Downloads](https://img.shields.io/packagist/dt/choowx/rasterize-svg.svg?style=flat-square)](https://packagist.org/packages/choowx/rasterize-svg)

## Installation

You can install the package via composer:

```bash
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.

```bash
npm install sharp
```

## Usage

```php
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:

```php
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

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](https://github.com/choowx/rasterize-svg/blob/main/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Choo Wen Xuan](https://github.com/choowx)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

rasterize-svg

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README