14532758805

Committed 18 Apr 2025 09:06AM UTC coverage: 83.633%. First build

Build # 14532758805

Build Type

Pull #2148

github

Committed by

web-flow

Commit Message

Merge 004f11f49 into bc7c717e4

Pull Request Pull Request #2148: refactor: configuration and cache

Run Details

315 of 376 new or added lines in 26 files covered. (83.78%)

3025 of 3617 relevant lines covered (83.63%)

0.84 hits per line

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

81.08

/src/Assets/Image.php

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (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.
 */

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;

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.');
    }

    /**
     * Resize an image Asset.
     *
     * @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()));
        }
    }

    /**
     * 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	declare(strict_types=1);
4
5	/*
6	* This file is part of Cecil.
7	*
8	* Copyright (c) Arnaud Ligny <arnaud@ligny.fr>
9	*
10	* For the full copyright and license information, please view the LICENSE
11	* file that was distributed with this source code.
12	*/
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	class Image
23	{
24	/**
25	* Create new manager instance with available driver.
26	*/
27	private static function manager(): ImageManager
28	{
29	$driver = null;	1✔
30
31	// ImageMagick is available? (for a future quality option)
32	if (\extension_loaded('imagick') && class_exists('Imagick')) {	1✔
33	$driver = ImagickDriver::class;	1✔
34	}
35	// Use GD, because it's the faster driver
36	if (\extension_loaded('gd') && \function_exists('gd_info')) {	1✔
37	$driver = GdDriver::class;	1✔
38	}
39
40	if ($driver) {	1✔
41	return ImageManager::withDriver(	1✔
42	$driver,	1✔
43	[	1✔
44	'autoOrientation' => true,	1✔
45	'decodeAnimation' => true,	1✔
46	'blendingColor' => 'ffffff',	1✔
47	'strip' => true, // remove metadata	1✔
48	]	1✔
49	);	1✔
50	}
51
52	throw new RuntimeException('PHP GD (or Imagick) extension is required.');	×
53	}
54
55	/**
56	* Resize an image Asset.
57	*
58	* @throws RuntimeException
59	*/
60	public static function resize(Asset $asset, int $width, int $quality): string
61	{
62	try {
63	// creates image object from source
64	$image = self::manager()->read($asset['content']);	1✔
65	// resizes to $width with constraint the aspect-ratio and unwanted upsizing
66	$image->scaleDown(width: $width);	1✔
67	// return image data
68	return (string) $image->encodeByMediaType($asset['subtype'], /** @scrutinizer ignore-type / progressive: true, /* @scrutinizer ignore-type */ interlaced: false, quality: $quality);	1✔
69	} catch (\Exception $e) {	×
70	throw new RuntimeException(\sprintf('Asset "%s" can\'t be resized: %s', $asset['path'], $e->getMessage()));	×
71	}
72	}
73
74	/**
75	* Converts an image Asset to the target format.
76	*
77	* @throws RuntimeException
78	*/
79	public static function convert(Asset $asset, string $format, int $quality): string
80	{
81	try {
82	$image = self::manager()->read($asset['content']);	1✔
83
84	if (!\function_exists("image$format")) {	1✔
85	throw new RuntimeException(\sprintf('Function "image%s" is not available.', $format));	×
86	}
87
88	return (string) $image->encodeByExtension($format, /** @scrutinizer ignore-type / progressive: true, /* @scrutinizer ignore-type */ interlaced: false, quality: $quality);	1✔
89	} catch (\Exception $e) {	×
NEW 90	throw new RuntimeException(\sprintf('Not able to convert "%s" to %s: %s', $asset['path'], $format, $e->getMessage()));	×
91	}
92	}
93
94	/**
95	* Returns the Data URL (encoded in Base64).
96	*
97	* @throws RuntimeException
98	*/
99	public static function getDataUrl(Asset $asset, int $quality): string
100	{
101	try {
102	$image = self::manager()->read($asset['content']);	1✔
103
104	return (string) $image->encode(new AutoEncoder(quality: $quality))->toDataUri();	1✔
105	} catch (\Exception $e) {	×
106	throw new RuntimeException(\sprintf('Can\'t get Data URL of "%s": %s', $asset['path'], $e->getMessage()));	×
107	}
108	}
109
110	/**
111	* Returns the dominant RGB color of an image asset.
112	*
113	* @throws RuntimeException
114	*/
115	public static function getDominantColor(Asset $asset): string
116	{
117	try {
118	$image = self::manager()->read(self::resize($asset, 100, 50));	1✔
119
120	return $image->reduceColors(1)->pickColor(0, 0)->toString();	1✔
121	} catch (\Exception $e) {	×
122	throw new RuntimeException(\sprintf('Can\'t get dominant color of "%s": %s', $asset['path'], $e->getMessage()));	×
123	}
124	}
125
126	/**
127	* Returns a Low Quality Image Placeholder (LQIP) as data URL.
128	*
129	* @throws RuntimeException
130	*/
131	public static function getLqip(Asset $asset): string
132	{
133	try {
134	$image = self::manager()->read(self::resize($asset, 100, 50));	1✔
135
136	return (string) $image->blur(50)->encode()->toDataUri();	1✔
137	} catch (\Exception $e) {	×
138	throw new RuntimeException(\sprintf('can\'t create LQIP of "%s": %s', $asset['path'], $e->getMessage()));	×
139	}
140	}
141
142	/**
143	* Build the `srcset` attribute for responsive images.
144	* e.g.: `srcset="/img-480.jpg 480w, /img-800.jpg 800w"`.
145	*
146	* @throws RuntimeException
147	*/
148	public static function buildSrcset(Asset $asset, array $widths): string
149	{
150	if (!self::isImage($asset)) {	1✔
151	throw new RuntimeException(\sprintf('can\'t build "srcset" of "%s": it\'s not an image file.', $asset['path']));	1✔
152	}
153
154	$srcset = '';	1✔
155	$widthMax = 0;	1✔
156	sort($widths, SORT_NUMERIC);	1✔
157	$widths = array_reverse($widths);	1✔
158	foreach ($widths as $width) {	1✔
159	if ($asset['width'] < $width) {	1✔
160	continue;	1✔
161	}
162	$img = $asset->resize($width);	1✔
163	$srcset .= \sprintf('%s %sw, ', (string) $img, $width);	1✔
164	$widthMax = $width;	1✔
165	}
166	// adds source image
167	if (!empty($srcset) && ($asset['width'] < max($widths) && $asset['width'] != $widthMax)) {	1✔
168	$srcset .= \sprintf('%s %sw', (string) $asset, $asset['width']);	1✔
169	}
170
171	return rtrim($srcset, ', ');	1✔
172	}
173
174	/**
175	* Returns the value of the "sizes" attribute corresponding to the configured class.
176	*/
177	public static function getSizes(string $class, array $sizes = []): string
178	{
179	$result = '';	1✔
180	$classArray = explode(' ', $class);	1✔
181	foreach ($classArray as $class) {	1✔
182	if (\array_key_exists($class, $sizes)) {	1✔
183	$result = $sizes[$class] . ', ';	1✔
184	}
185	}
186	if (!empty($result)) {	1✔
187	return trim($result, ', ');	1✔
188	}
189
190	return $sizes['default'] ?? '100vw';	1✔
191	}
192
193	/**
194	* Checks if an asset is an animated GIF.
195	*/
196	public static function isAnimatedGif(Asset $asset): bool
197	{
198	// an animated GIF contains multiple "frames", with each frame having a header made up of:
199	// 1. a static 4-byte sequence (\x00\x21\xF9\x04)
200	// 2. 4 variable bytes
201	// 3. a static 2-byte sequence (\x00\x2C)
202	$count = preg_match_all('#\x00\x21\xF9\x04.{4}\x00[\x2C\x21]#s', (string) $asset['content']);	1✔
203
204	return $count > 1;	1✔
205	}
206
207	/**
208	* Returns true if asset is a SVG.
209	*/
210	public static function isSVG(Asset $asset): bool
211	{
212	return \in_array($asset['subtype'], ['image/svg', 'image/svg+xml']) \|\| $asset['ext'] == 'svg';	1✔
213	}
214
215	/**
216	* Returns true if asset is an ICO.
217	*/
218	public static function isIco(Asset $asset): bool
219	{
220	return \in_array($asset['subtype'], ['image/x-icon', 'image/vnd.microsoft.icon']) \|\| $asset['ext'] == 'ico';	1✔
221	}
222
223	/**
224	* Asset is a valid image?
225	*/
226	public static function isImage(Asset $asset): bool
227	{
228	if ($asset['type'] !== 'image' \|\| self::isSVG($asset) \|\| self::isIco($asset)) {	1✔
229	return false;	1✔
230	}
231
232	return true;	1✔
233	}
234
235	/**
236	* Returns SVG attributes.
237	*
238	* @return \SimpleXMLElement\|false
239	*/
240	public static function getSvgAttributes(Asset $asset)
241	{
242	if (!self::isSVG($asset)) {	1✔
243	return false;	×
244	}
245
246	if (false === $xml = simplexml_load_string($asset['content'] ?? '')) {	1✔
247	return false;	×
248	}
249
250	return $xml->attributes();	1✔
251	}
252	}

Cecilapp / Cecil / 14532758805

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