18438267546

Committed 12 Oct 2025 03:01AM UTC coverage: 81.901%. Remained the same

Build # 18438267546

Build Type

push

github

Committed by

ArnaudLigny

Commit Message

refactor: better error/warning messages

Coverage Stats

5 of 40 new or added lines in 15 files covered. (12.5%)

3163 of 3862 relevant lines covered (81.9%)

0.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

70.34

/src/Asset/Image.php

<?php

/**
 * This file is part of Cecil.
 *
 * (c) Arnaud Ligny <arnaud@ligny.fr>
 *
 * 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\Asset;

use Cecil\Asset;
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 Asset class.
 *
 * Provides methods to manipulate images, such as resizing, cropping, converting,
 * and generating data URLs.
 *
 * This class uses the Intervention Image library to handle image processing.
 * It supports both GD and Imagick drivers, depending on the available PHP extensions.
 */
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('Unable to 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('Unable 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('Unable to 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('Unable to 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('Unable to create LQIP of "%s": %s', $asset['path'], $e->getMessage()));
        }
    }

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

Cecilapp / Cecil / 18438267546

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous