Image::cover() - Code Metrics - Inspection of "Build Command : Allow to render a subset" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2172)

by Arnaud

created 2025-06-03 23:47 UTC

Image::cover() A

↳ Parent: Image

Complexity

Conditions	2
Paths	4

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.1481

Importance

Changes

Metric	Value
cc	2
eloc	6
c	0
b	0
f	0
nc	4
nop	5
dl	0
loc	11
ccs	4
cts	6
cp	0.6667
crap	2.1481
rs	10

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * 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.');
    }

    /**
     * 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, string $position, int $quality): string
    {
        try {
            // creates image object from source
            $image = self::manager()->read($asset['content']);
            // crops the image
            $image->cover(width: $width, height: $height, position: $position);
            // 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()));
        }
    }

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

Cecilapp / Cecil

Pull Request — master (#2172)

Image::cover() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like