Image::convert() - Code Metrics - Inspection of "refactor: asset image functions" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Pull Request — master (#2001)

by Arnaud
created 2024-07-03 12:50 UTC
Image::convert() A

↳ Parent: Image
Complexity

Conditions	3
Paths	6
Size

Total Lines	13
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	4
CRAP Score	3
Importance

Changes
Metric	Value
cc	3
eloc	9
nc	6
nop	3
dl	0
loc	13
ccs	4
cts	4
cp	1
crap	3
rs	9.9666
c	0
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\ImageManagerStatic as ImageManager;

class Image
{
    /**
     * Resize an image Asset.
     *
     * @throws RuntimeException
     */
    public static function resize(Asset $asset, int $width, int $quality): string
    {
        try {
            // is image Asset?
            if ($asset['type'] !== 'image') {
                throw new RuntimeException(sprintf('Not an image.'));
            }
            // is GD is installed
            if (!\extension_loaded('gd')) {
                throw new RuntimeException('GD extension is required.');
            }
            // creates image object from source
            $image = ImageManager::make($asset['content_source']);
            // resizes to $width with constraint the aspect-ratio and unwanted upsizing
            $image->resize($width, null, function (\Intervention\Image\Constraint $constraint) {
                $constraint->aspectRatio();
                $constraint->upsize();
            });
            // interlaces (PNG) or progressives (JPEG) image
            $image->interlace();
            // save image in extension format and given quality
            $imageAsString = (string) $image->encode($asset['ext'], $quality);
            // destroy image object
            $image->destroy();

            return $imageAsString;
        } catch (\Exception $e) {
            throw new RuntimeException(sprintf('Not able to resize "%s": %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 {
            if ($asset['type'] !== 'image') {
                throw new RuntimeException(sprintf('Not an image.'));
            }
            $image = ImageManager::make($asset['content']);
            $imageAsString = (string) $image->encode($format, $quality);
            $image->destroy();

            return $imageAsString;
        } catch (\Exception $e) {
            throw new RuntimeException(sprintf('Not able to resize "%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 {
            if ($asset['type'] != 'image' || self::isSVG($asset)) {
                throw new RuntimeException(sprintf('Not an image.'));
            }
            $image = ImageManager::make($asset['content']);
            $imageAsDataUrl = (string) $image->encode('data-url', $quality);
            $image->destroy();

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

    /**
     * Returns the dominant hexadecimal color of an image asset.
     *
     * @throws RuntimeException
     */
    public static function getDominantColor(Asset $asset): string
    {
        try {
            if ($asset['type'] != 'image' || self::isSVG($asset)) {
                throw new RuntimeException(sprintf('Not an image.'));
            }

            $assetColor = clone $asset;
            $assetColor = $assetColor->resize(100);
            $image = ImageManager::make($assetColor['content']);
            $color = $image->limitColors(1)->pickColor(0, 0, 'hex');
            $image->destroy();

            return $color;
        } 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 {
            if ($asset['type'] !== 'image') {
                throw new RuntimeException(sprintf('Not an image.'));
            }
            $assetLqip = clone $asset;
            $assetLqip = $assetLqip->resize(100);
            $image = ImageManager::make($assetLqip['content']);
            $imageAsString = (string) $image->blur(50)->encode('data-url');
            $image->destroy();

            return $imageAsString;
        } 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';
    }

    /**
     * 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'])) {
        if (false === $xml = simplexml_load_string(/** @scrutinizer ignore-type */ $asset['content_source'])) {
            return false;
        }

        return $xml->attributes();
    }
}

Cecilapp / Cecil

Pull Request — master (#2001)

Image::convert() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
