Image::cover() - Code Metrics - Inspection of "Update CHANGELOG" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b82d07...dcca69 )

unknown

created 2025-08-15 03:02 UTC

Image::cover() A

↳ Parent: Image

Complexity

Conditions	3
Paths	9

Size

Total Lines	26
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	3
eloc	15
c	1
b	1
f	0
nc	9
nop	4
dl	0
loc	26
ccs	0
cts	17
cp	0
crap	12
rs	9.7666

<?php

/**
 * This file is part of Cecil.
 *
 * (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cecil\Assets;

use Cecil\Exception\RuntimeException;
use Intervention\Image\Drivers\Gd\Driver as GdDriver;
use Intervention\Image\Drivers\Imagick\Driver as ImagickDriver;
use Intervention\Image\Encoders\AutoEncoder;
use Intervention\Image\ImageManager;

/**
 * Image class.
 *
 * Provides methods to manipulate images, such as resizing, cropping, converting,
 * and generating data URLs.
 */
class Image
{
    /**
     * Create new manager instance with available driver.
     */
    private static function manager(): ImageManager
    {
        $driver = null;

        // ImageMagick is available? (for a future quality option)
        if (\extension_loaded('imagick') && class_exists('Imagick')) {
            $driver = ImagickDriver::class;
        }
        // Use GD, because it's the faster driver
        if (\extension_loaded('gd') && \function_exists('gd_info')) {
            $driver = GdDriver::class;
        }

        if ($driver) {
            return ImageManager::withDriver(
                $driver,
                [
                    'autoOrientation' => true,
                    'decodeAnimation' => true,
                    'blendingColor' => 'ffffff',
                    'strip' => true, // remove metadata
                ]
            );
        }

        throw new RuntimeException('PHP GD (or Imagick) extension is required.');
    }

    /**
     * Scales down an image Asset to the given width, keeping the aspect ratio.
     *
     * @throws RuntimeException
     */
    public static function resize(Asset $asset, int $width, int $quality): string
    {
        try {
            // creates image object from source
            $image = self::manager()->read($asset['content']);
            // resizes to $width with constraint the aspect-ratio and unwanted upsizing
            $image->scaleDown(width: $width);
            // return image data
            return (string) $image->encodeByMediaType(
                $asset['subtype'],
                /** @scrutinizer ignore-type */
                progressive: true,
                /** @scrutinizer ignore-type */
                interlaced: false,
                quality: $quality
            );
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Asset "%s" can\'t be resized: %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Crops an image Asset to the given width and height, keeping the aspect ratio.
     *
     * @throws RuntimeException
     */
    public static function cover(Asset $asset, int $width, int $height, int $quality): string
    {
        try {
            // creates image object from source
            $image = self::manager()->read($asset['content']);
            // turns an animated image (i.e GIF) into a static image
            if ($image->isAnimated()) {
                $image = $image->removeAnimation('25%'); // use 25% to avoid an "empty" frame
            }
            // crops the image
            $image->cover(
                width: $width,
                height: $height,
                position: 'center'
            );
            // return image data
            return (string) $image->encodeByMediaType(
                $asset['subtype'],
                /** @scrutinizer ignore-type */
                progressive: true,
                /** @scrutinizer ignore-type */
                interlaced: false,
                quality: $quality
            );
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Asset "%s" can\'t be cropped: %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Makes an image Asset maskable, meaning it can be used as a PWA icon.
     *
     * @throws RuntimeException
     */
    public static function maskable(Asset $asset, int $quality, int $padding): string
    {
        try {
            // creates image object from source
            $source = self::manager()->read($asset['content']);
            // creates a new image with the dominant color as background
            // and the size of the original image plus the padding
            $image = self::manager()->create(
                width: (int) round($asset['width'] * (1 + $padding / 100), 0),
                height: (int) round($asset['height'] * (1 + $padding / 100), 0)
            )->fill(self::getDominantColor($asset));
            // inserts the original image in the center
            $image->place(
                $source,
                position: 'center'
            );
            // scales down the new image to the original image size
            $image->scaleDown(width: $asset['width']);
            // return image data
            return (string) $image->encodeByMediaType(
                $asset['subtype'],
                /** @scrutinizer ignore-type */
                progressive: true,
                /** @scrutinizer ignore-type */
                interlaced: false,
                quality: $quality
            );
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Can\'t make Asset "%s" maskable: %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Converts an image Asset to the target format.
     *
     * @throws RuntimeException
     */
    public static function convert(Asset $asset, string $format, int $quality): string
    {
        try {
            $image = self::manager()->read($asset['content']);

            if (!\function_exists("image$format")) {
                throw new RuntimeException(\sprintf('Function "image%s" is not available.', $format));
            }

            return (string) $image->encodeByExtension(
                $format,
                /** @scrutinizer ignore-type */
                progressive: true,
                /** @scrutinizer ignore-type */
                interlaced: false,
                quality: $quality
            );
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Not able to convert "%s" to %s: %s', $asset['path'], $format, $e->getMessage()));
        }
    }

    /**
     * Returns the Data URL (encoded in Base64).
     *
     * @throws RuntimeException
     */
    public static function getDataUrl(Asset $asset, int $quality): string
    {
        try {
            $image = self::manager()->read($asset['content']);

            return (string) $image->encode(new AutoEncoder(quality: $quality))->toDataUri();
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Can\'t get Data URL of "%s": %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Returns the dominant RGB color of an image asset.
     *
     * @throws RuntimeException
     */
    public static function getDominantColor(Asset $asset): string
    {
        try {
            $image = self::manager()->read(self::resize($asset, 100, 50));

            return $image->reduceColors(1)->pickColor(0, 0)->toString();
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Can\'t get dominant color of "%s": %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Returns a Low Quality Image Placeholder (LQIP) as data URL.
     *
     * @throws RuntimeException
     */
    public static function getLqip(Asset $asset): string
    {
        try {
            $image = self::manager()->read(self::resize($asset, 100, 50));

            return (string) $image->blur(50)->encode()->toDataUri();
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('can\'t create LQIP of "%s": %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Build the `srcset` attribute for responsive images.
     * e.g.: `srcset="/img-480.jpg 480w, /img-800.jpg 800w"`.
     *
     * @throws RuntimeException
     */
    public static function buildSrcset(Asset $asset, array $widths): string
    {
        if (!self::isImage($asset)) {
            throw new RuntimeException(\sprintf('can\'t build "srcset" of "%s": it\'s not an image file.', $asset['path']));
        }

        $srcset = '';
        $widthMax = 0;
        sort($widths, SORT_NUMERIC);
        $widths = array_reverse($widths);
        foreach ($widths as $width) {
            if ($asset['width'] < $width) {
                continue;
            }
            $img = $asset->resize($width);
            $srcset .= \sprintf('%s %sw, ', (string) $img, $width);
            $widthMax = $width;
        }
        // adds source image
        if (!empty($srcset) && ($asset['width'] < max($widths) && $asset['width'] != $widthMax)) {
            $srcset .= \sprintf('%s %sw', (string) $asset, $asset['width']);
        }

        return rtrim($srcset, ', ');
    }

    /**
     * Returns the value of the "sizes" attribute corresponding to the configured class.
     */
    public static function getSizes(string $class, array $sizes = []): string
    {
        $result = '';
        $classArray = explode(' ', $class);
        foreach ($classArray as $class) {
            if (\array_key_exists($class, $sizes)) {
                $result = $sizes[$class] . ', ';
            }
        }
        if (!empty($result)) {
            return trim($result, ', ');
        }

        return $sizes['default'] ?? '100vw';
    }

    /**
     * Checks if an asset is an animated GIF.
     */
    public static function isAnimatedGif(Asset $asset): bool
    {
        // an animated GIF contains multiple "frames", with each frame having a header made up of:
        // 1. a static 4-byte sequence (\x00\x21\xF9\x04)
        // 2. 4 variable bytes
        // 3. a static 2-byte sequence (\x00\x2C)
        $count = preg_match_all('#\x00\x21\xF9\x04.{4}\x00[\x2C\x21]#s', (string) $asset['content']);

        return $count > 1;
    }

    /**
     * Returns true if asset is a SVG.
     */
    public static function isSVG(Asset $asset): bool
    {
        return \in_array($asset['subtype'], ['image/svg', 'image/svg+xml']) || $asset['ext'] == 'svg';
    }

    /**
     * Returns true if asset is an ICO.
     */
    public static function isIco(Asset $asset): bool
    {
        return \in_array($asset['subtype'], ['image/x-icon', 'image/vnd.microsoft.icon']) || $asset['ext'] == 'ico';
    }

    /**
     * Asset is a valid image?
     */
    public static function isImage(Asset $asset): bool
    {
        if ($asset['type'] !== 'image' || self::isSVG($asset) || self::isIco($asset)) {
            return false;
        }

        return true;
    }

    /**
     * Returns SVG attributes.
     *
     * @return \SimpleXMLElement|false
     */
    public static function getSvgAttributes(Asset $asset)
    {
        if (!self::isSVG($asset)) {
            return false;
        }

        if (false === $xml = simplexml_load_string($asset['content'] ?? '')) {
            return false;
        }

        return $xml->attributes();
    }
}


1		<?php
2
3		/**
4		* This file is part of Cecil.
5		*
6		* (c) Arnaud Ligny <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		declare(strict_types=1);
13
14		namespace Cecil\Assets;
15
16		use Cecil\Exception\RuntimeException;
17		use Intervention\Image\Drivers\Gd\Driver as GdDriver;
18		use Intervention\Image\Drivers\Imagick\Driver as ImagickDriver;
19		use Intervention\Image\Encoders\AutoEncoder;
20		use Intervention\Image\ImageManager;
21
22		/**
23		* Image class.
24		*
25		* Provides methods to manipulate images, such as resizing, cropping, converting,
26		* and generating data URLs.
27		*/
28		class Image
29		{
30		/**
31		* Create new manager instance with available driver.
32		*/
33	1	private static function manager(): ImageManager
34		{
35	1	$driver = null;
36
37		// ImageMagick is available? (for a future quality option)
38	1	if (\extension_loaded('imagick') && class_exists('Imagick')) {
39		$driver = ImagickDriver::class;
40		}
41		// Use GD, because it's the faster driver
42	1	if (\extension_loaded('gd') && \function_exists('gd_info')) {
43	1	$driver = GdDriver::class;
44		}
45
46	1	if ($driver) {
47	1	return ImageManager::withDriver(
48	1	$driver,
49	1	[
50	1	'autoOrientation' => true,
51	1	'decodeAnimation' => true,
52	1	'blendingColor' => 'ffffff',
53	1	'strip' => true, // remove metadata
54	1	]
55	1	);
56		}
57
58		throw new RuntimeException('PHP GD (or Imagick) extension is required.');
59		}
60
61		/**
62		* Scales down an image Asset to the given width, keeping the aspect ratio.
63		*
64		* @throws RuntimeException
65		*/
66	1	public static function resize(Asset $asset, int $width, int $quality): string
67		{
68		try {
69		// creates image object from source
70	1	$image = self::manager()->read($asset['content']);
71		// resizes to $width with constraint the aspect-ratio and unwanted upsizing
72	1	$image->scaleDown(width: $width);
73		// return image data
74	1	return (string) $image->encodeByMediaType(
75	1	$asset['subtype'],
76		/** @scrutinizer ignore-type */
77	1	progressive: true,
78		/** @scrutinizer ignore-type */
79	1	interlaced: false,
80	1	quality: $quality
81	1	);
82		} catch (\Exception $e) {
83		throw new RuntimeException(\sprintf('Asset "%s" can\'t be resized: %s', $asset['path'], $e->getMessage()));
84		}
85		}
86
87		/**
88		* Crops an image Asset to the given width and height, keeping the aspect ratio.
89		*
90		* @throws RuntimeException
91		*/
92		public static function cover(Asset $asset, int $width, int $height, int $quality): string
93		{
94		try {
95		// creates image object from source
96		$image = self::manager()->read($asset['content']);
97		// turns an animated image (i.e GIF) into a static image
98		if ($image->isAnimated()) {
99		$image = $image->removeAnimation('25%'); // use 25% to avoid an "empty" frame
100		}
101		// crops the image
102		$image->cover(
103		width: $width,
104		height: $height,
105		position: 'center'
106		);
107		// return image data
108		return (string) $image->encodeByMediaType(
109		$asset['subtype'],
110		/** @scrutinizer ignore-type */
111		progressive: true,
112		/** @scrutinizer ignore-type */
113		interlaced: false,
114		quality: $quality
115		);
116		} catch (\Exception $e) {
117		throw new RuntimeException(\sprintf('Asset "%s" can\'t be cropped: %s', $asset['path'], $e->getMessage()));
118		}
119		}
120
121		/**
122		* Makes an image Asset maskable, meaning it can be used as a PWA icon.
123		*
124		* @throws RuntimeException
125		*/
126		public static function maskable(Asset $asset, int $quality, int $padding): string
127		{
128		try {
129		// creates image object from source
130		$source = self::manager()->read($asset['content']);
131		// creates a new image with the dominant color as background
132		// and the size of the original image plus the padding
133		$image = self::manager()->create(
134		width: (int) round($asset['width'] * (1 + $padding / 100), 0),
135		height: (int) round($asset['height'] * (1 + $padding / 100), 0)
136		)->fill(self::getDominantColor($asset));
137		// inserts the original image in the center
138		$image->place(
139		$source,
140		position: 'center'
141		);
142		// scales down the new image to the original image size
143		$image->scaleDown(width: $asset['width']);
144		// return image data
145		return (string) $image->encodeByMediaType(
146		$asset['subtype'],
147		/** @scrutinizer ignore-type */
148		progressive: true,
149		/** @scrutinizer ignore-type */
150		interlaced: false,
151		quality: $quality
152		);
153		} catch (\Exception $e) {
154		throw new RuntimeException(\sprintf('Can\'t make Asset "%s" maskable: %s', $asset['path'], $e->getMessage()));
155		}
156		}
157
158		/**
159		* Converts an image Asset to the target format.
160		*
161		* @throws RuntimeException
162		*/
163	1	public static function convert(Asset $asset, string $format, int $quality): string
164		{
165		try {
166	1	$image = self::manager()->read($asset['content']);
167
168	1	if (!\function_exists("image$format")) {
169	1	throw new RuntimeException(\sprintf('Function "image%s" is not available.', $format));
170		}
171
172		return (string) $image->encodeByExtension(
173		$format,
174		/** @scrutinizer ignore-type */
175		progressive: true,
176		/** @scrutinizer ignore-type */
177		interlaced: false,
178		quality: $quality
179		);
180	1	} catch (\Exception $e) {
181	1	throw new RuntimeException(\sprintf('Not able to convert "%s" to %s: %s', $asset['path'], $format, $e->getMessage()));
182		}
183		}
184
185		/**
186		* Returns the Data URL (encoded in Base64).
187		*
188		* @throws RuntimeException
189		*/
190	1	public static function getDataUrl(Asset $asset, int $quality): string
191		{
192		try {
193	1	$image = self::manager()->read($asset['content']);
194
195	1	return (string) $image->encode(new AutoEncoder(quality: $quality))->toDataUri();
196		} catch (\Exception $e) {
197		throw new RuntimeException(\sprintf('Can\'t get Data URL of "%s": %s', $asset['path'], $e->getMessage()));
198		}
199		}
200
201		/**
202		* Returns the dominant RGB color of an image asset.
203		*
204		* @throws RuntimeException
205		*/
206	1	public static function getDominantColor(Asset $asset): string
207		{
208		try {
209	1	$image = self::manager()->read(self::resize($asset, 100, 50));
210
211	1	return $image->reduceColors(1)->pickColor(0, 0)->toString();
212		} catch (\Exception $e) {
213		throw new RuntimeException(\sprintf('Can\'t get dominant color of "%s": %s', $asset['path'], $e->getMessage()));
214		}
215		}
216
217		/**
218		* Returns a Low Quality Image Placeholder (LQIP) as data URL.
219		*
220		* @throws RuntimeException
221		*/
222	1	public static function getLqip(Asset $asset): string
223		{
224		try {
225	1	$image = self::manager()->read(self::resize($asset, 100, 50));
226
227	1	return (string) $image->blur(50)->encode()->toDataUri();
228		} catch (\Exception $e) {
229		throw new RuntimeException(\sprintf('can\'t create LQIP of "%s": %s', $asset['path'], $e->getMessage()));
230		}
231		}
232
233		/**
234		* Build the `srcset` attribute for responsive images.
235		* e.g.: `srcset="/img-480.jpg 480w, /img-800.jpg 800w"`.
236		*
237		* @throws RuntimeException
238		*/
239	1	public static function buildSrcset(Asset $asset, array $widths): string
240		{
241	1	if (!self::isImage($asset)) {
242	1	throw new RuntimeException(\sprintf('can\'t build "srcset" of "%s": it\'s not an image file.', $asset['path']));
243		}
244
245	1	$srcset = '';
246	1	$widthMax = 0;
247	1	sort($widths, SORT_NUMERIC);
248	1	$widths = array_reverse($widths);
249	1	foreach ($widths as $width) {
250	1	if ($asset['width'] < $width) {
251	1	continue;
252		}
253	1	$img = $asset->resize($width);
254	1	$srcset .= \sprintf('%s %sw, ', (string) $img, $width);
255	1	$widthMax = $width;
256		}
257		// adds source image
258	1	if (!empty($srcset) && ($asset['width'] < max($widths) && $asset['width'] != $widthMax)) {
259	1	$srcset .= \sprintf('%s %sw', (string) $asset, $asset['width']);
260		}
261
262	1	return rtrim($srcset, ', ');
263		}
264
265		/**
266		* Returns the value of the "sizes" attribute corresponding to the configured class.
267		*/
268	1	public static function getSizes(string $class, array $sizes = []): string
269		{
270	1	$result = '';
271	1	$classArray = explode(' ', $class);
272	1	foreach ($classArray as $class) {
273	1	if (\array_key_exists($class, $sizes)) {
274	1	$result = $sizes[$class] . ', ';
275		}
276		}
277	1	if (!empty($result)) {
278	1	return trim($result, ', ');
279		}
280
281	1	return $sizes['default'] ?? '100vw';
282		}
283
284		/**
285		* Checks if an asset is an animated GIF.
286		*/
287	1	public static function isAnimatedGif(Asset $asset): bool
288		{
289		// an animated GIF contains multiple "frames", with each frame having a header made up of:
290		// 1. a static 4-byte sequence (\x00\x21\xF9\x04)
291		// 2. 4 variable bytes
292		// 3. a static 2-byte sequence (\x00\x2C)
293	1	$count = preg_match_all('#\x00\x21\xF9\x04.{4}\x00[\x2C\x21]#s', (string) $asset['content']);
294
295	1	return $count > 1;
296		}
297
298		/**
299		* Returns true if asset is a SVG.
300		*/
301	1	public static function isSVG(Asset $asset): bool
302		{
303	1	return \in_array($asset['subtype'], ['image/svg', 'image/svg+xml']) \|\| $asset['ext'] == 'svg';
304		}
305
306		/**
307		* Returns true if asset is an ICO.
308		*/
309	1	public static function isIco(Asset $asset): bool
310		{
311	1	return \in_array($asset['subtype'], ['image/x-icon', 'image/vnd.microsoft.icon']) \|\| $asset['ext'] == 'ico';
312		}
313
314		/**
315		* Asset is a valid image?
316		*/
317	1	public static function isImage(Asset $asset): bool
318		{
319	1	if ($asset['type'] !== 'image' \|\| self::isSVG($asset) \|\| self::isIco($asset)) {
320	1	return false;
321		}
322
323	1	return true;
324		}
325
326		/**
327		* Returns SVG attributes.
328		*
329		* @return \SimpleXMLElement\|false
330		*/
331	1	public static function getSvgAttributes(Asset $asset)
332		{
333	1	if (!self::isSVG($asset)) {
334		return false;
335		}
336
337	1	if (false === $xml = simplexml_load_string($asset['content'] ?? '')) {
338		return false;
339		}
340
341	1	return $xml->attributes();
342		}
343		}
344

Cecilapp / Cecil

Push — master ( b82d07...dcca69 )

Image::cover() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like