wedevelopnl/silverstripe-svg-image

Silverstripe module to add support for SVG images.

2.0.1 2024-03-25 08:30 UTC

Requires

• php: ^8.1
• enshrined/svg-sanitize: ^0.16
• meyfa/php-svg: ^0.14.5
• silverstripe/framework: ^5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.20
• silverstripe/mimevalidator: ^3.0
• syntro/silverstripe-phpstan: ^5.0

Suggests

• silverstripe/mimevalidator: Adds mimetype validation to file uploads.

BSD-3-Clause

• WeDevelop

• silverstripe

README

Silverstripe doesn't support SVG to be used out of the box. This module adds a new file type which supports SVG images in a very basic way. Please note that the absence of SVG support isn't a fluke but the result of some extended discussion.

This module provides some sanitation of SVG files on upload but be aware of the potential risk.

Image manipulation

The Silverstripe core supports a extensive set of image manipulation tools. At the moment image manipulation isn't supported on SVG images. When an manipulation method is called on an SVG image the source image is simply returned.

Requirements

• See composer.json requirements

Installation

• composer require wedevelopnl/silverstripe-svg-image
• Run a dev/build

License

See License

Maintainers

• WeDevelop [e-mail]

Development and contribution

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. See read our contributing document for more information.

Getting started

We advise to use Docker/Docker compose for development.
We also included a Makefile to simplify some commands

Our development container contains some built-in tools like PHPCSFixer.