Svg::__construct() - Code Metrics - Inspection of "Use WEBP images by default for previews" - aimeos/aimeos-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8e0f36...cdb6de )

by Aimeos

created 2022-01-10 12:58 UTC

Svg::__construct() A

↳ Parent: Svg

Complexity

Conditions	4
Paths	6

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	9
nc	6
nop	2
dl	0
loc	17
rs	9.9666
c	0
b	0
f	0

<?php

/**
 * @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2019-2022
 * @package MW
 * @subpackage Media
 */


namespace Aimeos\MW\Media\Image;

use enshrined\svgSanitize\Sanitizer;


/**
 * Image class for SVG files
 *
 * @package MW
 * @subpackage Media
 */
class Svg
	extends \Aimeos\MW\Media\Image\Base
	implements \Aimeos\MW\Media\Image\Iface
{
	private $svg;


	/**
	 * Initializes the new image object.
	 *
	 * @param string $content File content
	 * @param string $mimetype Mime type of the media data
	 * @throws \Aimeos\MW\Media\Exception If image couldn't be retrieved from the given file name
	 */
	public function __construct( string $content, string $mimetype )
	{
		parent::__construct( $mimetype );

		if( ( $string = @gzdecode( $content ) ) !== false ) {
			$content = $string;
		}

		$sanitizer = new Sanitizer();
		$sanitizer->removeRemoteReferences( true );

		if( ( $content = $sanitizer->sanitize( $content ) ) === false ) {
			throw new \Aimeos\MW\Media\Exception( 'Invalid SVG file: ' . print_r( $sanitizer->getXmlIssues(), true ) );
		}

		if( ( $this->svg = @simplexml_load_string( $content ) ) === false ) {
			throw new \Aimeos\MW\Media\Exception( 'Invalid SVG file' );
		}
	}


	/**
	 * Clone resources
	 */
	public function __clone()
	{
		$this->svg = clone $this->svg;
	}


	/**
	 * Returns the height of the image
	 *
	 * @return int Height in pixel
	 */
	public function getHeight() : int
	{
		return ( isset( $this->svg['height'] ) ? (int) preg_replace( '/[^0-9.]/', '', $this->svg['height'] ) : 1 );
	}


	/**
	 * Returns the width of the image
	 *
	 * @return int Width in pixel
	 */
	public function getWidth() : int
	{
		return ( isset( $this->svg['width'] ) ? (int) preg_replace( '/[^0-9.]/', '', $this->svg['width'] ) : 1 );
	}


	/**
	 * Stores the media data at the given file name.
	 *
	 * @param string|null $filename File name to save the data into or null to return the data
	 * @param string|null $mimetype Mime type to save the content as or null to leave the mime type unchanged
	 * @return string|null File content if file name is null or null if data is saved to the given file name
	 * @throws \Aimeos\MW\Media\Exception If image couldn't be saved to the given file name
	 */
	public function save( string $filename = null, string $mimetype = null ) : ?string
	{
		if( ( $content = $this->svg->asXml() ) === false ) {
			throw new \Aimeos\MW\Media\Exception( 'Could not create SVG file' );
		}

		if( $filename === null ) {
			return $content;
		}

		if( file_put_contents( $filename, $content ) === false ) {
			throw new \Aimeos\MW\Media\Exception( 'Could not save SVG file' );
		}

		return null;
	}


	/**
	 * Scales the image to the given width and height.
	 *
	 * @param int|null $width New width of the image or null for automatic calculation
	 * @param int|null $height New height of the image or null for automatic calculation
	 * @param int $fit "0" keeps image ratio, "1" adds padding while "2" crops image to enforce image size
	 * @return \Aimeos\MW\Media\Image\Iface Self object for method chaining
	 */
	public function scale( int $width = null, int $height = null, int $fit = 0 ) : Iface
	{
		if( $width == null && $height == null ) {

			return $this;
		}

		$w = $this->getWidth();
		$h = $this->getHeight();
		$newMedia = clone $this;

		if( $fit === 2 ) {
			$newMedia->svg['viewBox'] = $this->box( $w, $h, $width / $height, $height / $width );
		} else {
			$newMedia->svg['viewBox'] = $this->box( $w, $h, $w / $h, $h / $w );
		}

		$newMedia->svg['width'] = $width;
		$newMedia->svg['height'] = $height;

		return $newMedia;
	}


	/**
	 * Returns the supported image mime types
	 *
	 * @param array|string $mimetypes Mime type or list of mime types to check against
	 * @return array List of supported mime types
	 */
	public static function supports( $mimetypes = [] ) : array
	{
		return empty( $mimetypes ) ? ['image/svg+xml'] : array_intersect( ['image/svg+xml'], (array) $mimetypes );
	}


	/**
	 * Returns the fitted width and height.
	 *
	 * @param int $srcWidth Width of the image
	 * @param int $srcHeight Height of the image
	 * @param int|null $destWidth New width of the image
	 * @param int|null $destHeight New height of the image
	 * @return array Array containing the new width at position 0 and the new height as position 1
	 */
	protected function box( int $srcWidth, int $srcHeight, float $wRatio, float $hRatio ) : string
	{
		$newWidth = $srcWidth;
		$newHeight = $srcHeight;

		if( $wRatio > $hRatio ) {
			$newHeight = (int) round( $srcHeight / $wRatio );
		} else {
			$newWidth = (int) round( $srcWidth / $hRatio );
		}

		$x = round( ( $srcWidth - $newWidth ) / 2 );
		$y = round( ( $srcHeight - $newHeight ) / 2 );

		return $x . ' ' . $y . ' ' . $newWidth . ' ' . $newHeight;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2019-2022
6			* @package MW
7			* @subpackage Media
8			*/
9
10
11			namespace Aimeos\MW\Media\Image;
12
13			use enshrined\svgSanitize\Sanitizer;
14
15
16			/**
17			* Image class for SVG files
18			*
19			* @package MW
20			* @subpackage Media
21			*/
22			class Svg
23			extends \Aimeos\MW\Media\Image\Base
24			implements \Aimeos\MW\Media\Image\Iface
25			{
26			private $svg;
27
28
29			/**
30			* Initializes the new image object.
31			*
32			* @param string $content File content
33			* @param string $mimetype Mime type of the media data
34			* @throws \Aimeos\MW\Media\Exception If image couldn't be retrieved from the given file name
35			*/
36			public function __construct( string $content, string $mimetype )
37			{
38			parent::__construct( $mimetype );
39
40			if( ( $string = @gzdecode( $content ) ) !== false ) {
41			$content = $string;
42			}
43
44			$sanitizer = new Sanitizer();
45			$sanitizer->removeRemoteReferences( true );
46
47			if( ( $content = $sanitizer->sanitize( $content ) ) === false ) {
48			throw new \Aimeos\MW\Media\Exception( 'Invalid SVG file: ' . print_r( $sanitizer->getXmlIssues(), true ) );
49			}
50
51			if( ( $this->svg = @simplexml_load_string( $content ) ) === false ) {
52			throw new \Aimeos\MW\Media\Exception( 'Invalid SVG file' );
53			}
54			}
55
56
57			/**
58			* Clone resources
59			*/
60			public function __clone()
61			{
62			$this->svg = clone $this->svg;
63			}
64
65
66			/**
67			* Returns the height of the image
68			*
69			* @return int Height in pixel
70			*/
71			public function getHeight() : int
72			{
73			return ( isset( $this->svg['height'] ) ? (int) preg_replace( '/[^0-9.]/', '', $this->svg['height'] ) : 1 );
74			}
75
76
77			/**
78			* Returns the width of the image
79			*
80			* @return int Width in pixel
81			*/
82			public function getWidth() : int
83			{
84			return ( isset( $this->svg['width'] ) ? (int) preg_replace( '/[^0-9.]/', '', $this->svg['width'] ) : 1 );
85			}
86
87
88			/**
89			* Stores the media data at the given file name.
90			*
91			* @param string\|null $filename File name to save the data into or null to return the data
92			* @param string\|null $mimetype Mime type to save the content as or null to leave the mime type unchanged
93			* @return string\|null File content if file name is null or null if data is saved to the given file name
94			* @throws \Aimeos\MW\Media\Exception If image couldn't be saved to the given file name
95			*/
96			public function save( string $filename = null, string $mimetype = null ) : ?string
97			{
98			if( ( $content = $this->svg->asXml() ) === false ) {
99			throw new \Aimeos\MW\Media\Exception( 'Could not create SVG file' );
100			}
101
102			if( $filename === null ) {
103			return $content;
104			}
105
106			if( file_put_contents( $filename, $content ) === false ) {
107			throw new \Aimeos\MW\Media\Exception( 'Could not save SVG file' );
108			}
109
110			return null;
111			}
112
113
114			/**
115			* Scales the image to the given width and height.
116			*
117			* @param int\|null $width New width of the image or null for automatic calculation
118			* @param int\|null $height New height of the image or null for automatic calculation
119			* @param int $fit "0" keeps image ratio, "1" adds padding while "2" crops image to enforce image size
120			* @return \Aimeos\MW\Media\Image\Iface Self object for method chaining
121			*/
122			public function scale( int $width = null, int $height = null, int $fit = 0 ) : Iface
123			{
124			if( $width == null && $height == null ) {
			0 ignored issues – show Bug Best Practice introduced 2019-05-13 15:30 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$height` of type `integer\|null` against `null`; this is ambiguous if the integer can be zero. Consider using a strict comparison `===` instead. Loading history... Bug Best Practice introduced 2019-05-13 15:30 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$width` of type `integer\|null` against `null`; this is ambiguous if the integer can be zero. Consider using a strict comparison `===` instead. Loading history...
125			return $this;
126			}
127
128			$w = $this->getWidth();
129			$h = $this->getHeight();
130			$newMedia = clone $this;
131
132			if( $fit === 2 ) {
133			$newMedia->svg['viewBox'] = $this->box( $w, $h, $width / $height, $height / $width );
134			} else {
135			$newMedia->svg['viewBox'] = $this->box( $w, $h, $w / $h, $h / $w );
136			}
137
138			$newMedia->svg['width'] = $width;
139			$newMedia->svg['height'] = $height;
140
141			return $newMedia;
142			}
143
144
145			/**
146			* Returns the supported image mime types
147			*
148			* @param array\|string $mimetypes Mime type or list of mime types to check against
149			* @return array List of supported mime types
150			*/
151			public static function supports( $mimetypes = [] ) : array
152			{
153			return empty( $mimetypes ) ? ['image/svg+xml'] : array_intersect( ['image/svg+xml'], (array) $mimetypes );
154			}
155
156
157			/**
158			* Returns the fitted width and height.
159			*
160			* @param int $srcWidth Width of the image
161			* @param int $srcHeight Height of the image
162			* @param int\|null $destWidth New width of the image
163			* @param int\|null $destHeight New height of the image
164			* @return array Array containing the new width at position 0 and the new height as position 1
165			*/
166			protected function box( int $srcWidth, int $srcHeight, float $wRatio, float $hRatio ) : string
167			{
168			$newWidth = $srcWidth;
169			$newHeight = $srcHeight;
170
171			if( $wRatio > $hRatio ) {
172			$newHeight = (int) round( $srcHeight / $wRatio );
173			} else {
174			$newWidth = (int) round( $srcWidth / $hRatio );
175			}
176
177			$x = round( ( $srcWidth - $newWidth ) / 2 );
178			$y = round( ( $srcHeight - $newHeight ) / 2 );
179
180			return $x . ' ' . $y . ' ' . $newWidth . ' ' . $newHeight;
181			}
182			}
183

aimeos / aimeos-core

Push — master ( 8e0f36...cdb6de )

Svg::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like