Image::getLqip() - Code Metrics - Inspection of "perf: enhance assets processing" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2124)

by Arnaud

created 2025-02-25 12:11 UTC

Image::getLqip() A

↳ Parent: Image

Complexity

Conditions	2
Paths	5

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2.0932

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	7
nc	5
nop	1
dl	0
loc	10
ccs	5
cts	7
cp	0.7143
crap	2.0932
rs	10
c	1
b	0
f	0

<?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\Encoders\AutoEncoder;
use Intervention\Image\ImageManager;

class Image
{
    /**
     * Create new manager instance with desired driver.
     */
    private static function manager(): ImageManager
    {
        if (\extension_loaded('gd') && \function_exists('gd_info')) {
            return ImageManager::gd();
        }
        if (\extension_loaded('imagick') && class_exists('Imagick')) {
            return ImageManager::imagick();
        }

        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_source']);
            // 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": %s', $asset['path'], $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 {
            $assetColor = clone $asset;
            $assetColor = $assetColor->resize(100);
            $image = self::manager()->read($assetColor['content']);

            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 {
            $assetLqip = clone $asset;
            $assetLqip = $assetLqip->resize(100);
            $image = self::manager()->read($assetLqip['content']);

            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 ($asset['type'] !== 'image') {
            throw new RuntimeException(\sprintf('can\'t build "srcset" of "%s": it\'s not an image file.', $asset['path']));
        }

        $srcset = '';
        $widthMax = 0;
        foreach ($widths as $width) {
            if ($asset['width'] < $width) {
                break;
            }
            $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_source']);

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

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

Cecilapp / Cecil

Pull Request — master (#2124)

Image::getLqip() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like