-
-
Notifications
You must be signed in to change notification settings - Fork 33
Add SVG utility #61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add SVG utility #61
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <?php namespace Winter\Storm\Support\Facades; | ||
|
|
||
| use Winter\Storm\Support\Facade; | ||
|
|
||
| /** | ||
| * @method static string extract(string $path, bool $minify = true) | ||
| * | ||
| * @see \Winter\Storm\Support\Svg | ||
| */ | ||
| class Svg extends Facade | ||
| { | ||
| /** | ||
| * Get the registered name of the component. | ||
| * | ||
| * @return string | ||
| */ | ||
| protected static function getFacadeAccessor() | ||
| { | ||
| return 'svg'; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| <?php namespace Winter\Storm\Support; | ||
|
|
||
| use Winter\Storm\Exception\ApplicationException; | ||
| use enshrined\svgSanitize\Sanitizer; | ||
|
|
||
| /** | ||
| * A simple wrapper for SVG extraction. | ||
| * | ||
| * Under the hood, this uses the "svg-sanitizer" library by Daryll Doyle (https://github.com/darylldoyle/svg-sanitizer) | ||
| * to sanitize and/or extract the SVG for usage within Winter. | ||
| * | ||
| * @author Winter CMS | ||
| */ | ||
| class Svg | ||
| { | ||
| /** | ||
| * Extracts and sanitizes SVG code from a given file. | ||
| * | ||
| * @param string $path The path to the SVG file. | ||
| * @param boolean $minify Whether to minify the extracted SVG code. | ||
| * @return string | ||
| * @throws ApplicationException If no file, or a malformed SVG, is found at the given path. | ||
| */ | ||
| public static function extract($path, $minify = true) | ||
| { | ||
| if (!is_file($path)) { | ||
| throw new ApplicationException(sprintf('No SVG file found at path "%s"', $path)); | ||
| } | ||
|
|
||
| $sanitized = static::sanitize(file_get_contents($path), $minify); | ||
|
|
||
| if (!$sanitized) { | ||
| throw new ApplicationException(sprintf('Malformed SVG encountered at path "%s"', $path)); | ||
| } | ||
|
|
||
| return $sanitized; | ||
| } | ||
|
|
||
| /** | ||
| * Sanitizes SVG code. | ||
| * | ||
| * See https://github.com/darylldoyle/svg-sanitizer for usage of the underlying sanitization library. | ||
| * | ||
| * @param string $svg SVG code. | ||
| * @param boolean $minify Whether to minify the given SVG code. | ||
| * @return string | ||
| */ | ||
| protected static function sanitize($svg, $minify = true) | ||
| { | ||
| $sanitizer = new Sanitizer(); | ||
| $sanitizer->removeRemoteReferences(true); | ||
| $sanitizer->removeXMLTag(true); | ||
|
|
||
| if ($minify) { | ||
| $sanitizer->minify(true); | ||
| } | ||
|
|
||
| return trim($sanitizer->sanitize($svg)); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?php | ||
|
|
||
| use Winter\Storm\Support\Svg; | ||
|
|
||
| class SvgTest extends TestCase | ||
| { | ||
| public function testCleanSvg() | ||
| { | ||
| $svg = Svg::extract(dirname(__DIR__) . '/fixtures/svg/winter.svg'); | ||
| $fixture = trim(file_get_contents(dirname(__DIR__) . '/fixtures/svg/extracted/winter.svg')); | ||
|
|
||
| $this->assertEquals($fixture, $svg); | ||
| } | ||
|
|
||
| public function testDirtySvg() | ||
| { | ||
| $svg = Svg::extract(dirname(__DIR__) . '/fixtures/svg/winter-dirty.svg'); | ||
| $fixture = trim(file_get_contents(dirname(__DIR__) . '/fixtures/svg/extracted/winter-dirty.svg')); | ||
|
|
||
| $this->assertEquals($fixture, $svg); | ||
| } | ||
| } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.