nystudio107 / craft-imageoptimize

src/services/Placeholder.php

<?php
/**
 * ImageOptimize plugin for Craft CMS
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\imageoptimize\services;

use ColorThief\ColorThief;
use Craft;
use craft\base\Component;
use craft\elements\Asset;
use craft\helpers\Image;
use craft\helpers\ImageTransforms as TransformHelper;
use craft\helpers\StringHelper;
use craft\image\Raster;
use Exception;
use nystudio107\imageoptimize\helpers\Color as ColorHelper;
use nystudio107\imageoptimize\ImageOptimize;
use nystudio107\imageoptimize\lib\Potracio;
use nystudio107\imageoptimize\models\Settings;
use Throwable;
use function function_exists;
use function strlen;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   ImageOptimize

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Placeholder extends Component
{
    // Constants
    // =========================================================================

    protected const PLACEHOLDER_WIDTH = 16;
    protected const PLACEHOLDER_QUALITY = 50;

    protected const TEMP_PLACEHOLDER_WIDTH = 300;
    protected const TEMP_PLACEHOLDER_QUALITY = 75;

    protected const MAX_SILHOUETTE_SIZE = 30 * 1024;

    // Public Properties
    // =========================================================================

    // Public Methods
    // =========================================================================

    /**
     * Return an SVG box as a placeholder image
     *
     * @param             $width

Tag value for @param tag indented incorrectly; expected 1 spaces but found 13

Missing parameter comment

     * @param             $height

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 1 spaces but found 13

     * @param ?string $color

Missing parameter comment

     *
     * @return string
     */
    public function generatePlaceholderBox($width, $height, ?string $color = null): string
    {
        $color = $color ?? '#CCC';
        $header = 'data:image/svg+xml,';
        $content = "<svg xmlns='http://www.w3.org/2000/svg' "
            . "width='$width' "
            . "height='$height' "
            . "style='background:$color' "
            . "/>";

        return $header . ImageOptimize::$plugin->optimizedImages->encodeOptimizedSVGDataUri($content);
    }

    /**
     * Generate a base64-encoded placeholder image
     *
     * @param string $tempPath

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

     * @param float $aspectRatio

Missing parameter comment

Expected 13 spaces after parameter type; 1 found

     * @param mixed|string|null $position

Missing parameter comment

     *
     * @return string
     */
    public function generatePlaceholderImage(string $tempPath, float $aspectRatio, mixed $position): string
    {
        Craft::beginProfile('generatePlaceholderImage', __METHOD__);
        Craft::info(
            'Generating placeholder image for asset',
            __METHOD__
        );
        $result = '';
        $width = self::PLACEHOLDER_WIDTH;
        $height = (int)($width / $aspectRatio);
        $placeholderPath = $this->createImageFromPath($tempPath, $width, $height, self::PLACEHOLDER_QUALITY, $position);
        if (!empty($placeholderPath)) {
            $result = base64_encode(file_get_contents($placeholderPath));
            unlink($placeholderPath);
        }
        Craft::endProfile('generatePlaceholderImage', __METHOD__);

        return $result;
    }

    /**
     * Generate a color palette from the image
     *
     * @param string $tempPath

Missing parameter comment

     *
     * @return array
     */
    public function generateColorPalette(string $tempPath): array
    {
        Craft::beginProfile('generateColorPalette', __METHOD__);
        Craft::info(
            'Generating color palette for: ' . $tempPath,
            __METHOD__
        );
        $colorPalette = [];
        if (!empty($tempPath)) {
            // Extract the color palette
            try {
                $palette = ColorThief::getPalette($tempPath, 5);
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);

                return [];
            }
            // Convert RGB to hex color
            foreach ($palette as $colors) {
                $colorPalette[] = sprintf('#%02x%02x%02x', $colors[0], $colors[1], $colors[2]);
            }
        }
        Craft::endProfile('generateColorPalette', __METHOD__);

        return $colorPalette;
    }

    /**

Missing short description in doc comment

     * @param array $colors

Missing parameter comment

     *
     * @return float|int|null
     */
    public function calculateLightness(array $colors): float|int|null
    {
        $lightness = null;
        if (!empty($colors)) {
            $lightness = 0;
            $colorWeight = count($colors);
            $colorCount = 0;
            foreach ($colors as $color) {
                $rgb = ColorHelper::HTMLToRGB($color);
                $hsl = ColorHelper::RGBToHSL($rgb);
                $lightness += $hsl['l'] * $colorWeight;
                $colorCount += $colorWeight;
                $colorWeight--;
            }

            $lightness /= $colorCount;
        }

        return $lightness === null ? $lightness : (int)$lightness;
    }

    /**
     * Generate an SVG image via Potrace
     *
     * @param string $tempPath

Missing parameter comment

     *
     * @return string
     */
    public function generatePlaceholderSvg(string $tempPath): string
    {
        Craft::beginProfile('generatePlaceholderSvg', __METHOD__);
        $result = '';

        if (!empty($tempPath)) {
            // Potracio depends on `gd` being installed
            if (function_exists('imagecreatefromjpeg')) {
                $pot = new Potracio();
                $pot->loadImageFromFile($tempPath);
                $pot->process();

                $result = $pot->getSVG(1);

                // Optimize the result if we got one
                if (!empty($result)) {
                    $result = ImageOptimize::$plugin->optimizedImages->encodeOptimizedSVGDataUri($result);
                }
            }
            /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $settings = ImageOptimize::$plugin->getSettings();

The method getSettings() does not exist on null.

            /**
             * If Potracio failed or gd isn't installed, or this is larger
             * than MAX_SILHOUETTE_SIZE bytes, just return a box
             */
            if (empty($result) || ((strlen($result) > self::MAX_SILHOUETTE_SIZE) && $settings->capSilhouetteSvgSize)) {
                $size = getimagesize($tempPath);
                if ($size !== false) {
                    [$width, $height] = $size;
                    $result = $this->generatePlaceholderBox($width, $height);
                }
            }
        }
        Craft::endProfile('generatePlaceholderSvg', __METHOD__);

        return $result;
    }

    /**
     * Create a small placeholder image file that the various placerholder
     * generators can use
     *
     * @param Asset $asset

Expected 13 spaces after parameter type; 1 found

Missing parameter comment

     * @param float $aspectRatio

Expected 13 spaces after parameter type; 1 found

Missing parameter comment

     * @param mixed|string|null $position

Missing parameter comment

     *
     * @return string
     */
    public function createTempPlaceholderImage(Asset $asset, float $aspectRatio, mixed $position): string
    {
        Craft::beginProfile('createTempPlaceholderImage', __METHOD__);
        Craft::info(
            'Creating temporary placeholder image for asset',
            __METHOD__
        );
        $width = self::TEMP_PLACEHOLDER_WIDTH;
        $height = (int)($width / $aspectRatio);
        $tempPath = $this->createImageFromAsset($asset, $width, $height, self::TEMP_PLACEHOLDER_QUALITY, $position);
        Craft::endProfile('createTempPlaceholderImage', __METHOD__);

        return $tempPath;
    }

    /**

Missing short description in doc comment

     * @param Asset $asset

Expected 13 spaces after parameter type; 1 found

Missing parameter comment

     * @param int $width

Expected 15 spaces after parameter type; 1 found

Missing parameter comment

     * @param int $height

Expected 15 spaces after parameter type; 1 found

Missing parameter comment

     * @param int $quality

Expected 15 spaces after parameter type; 1 found

Missing parameter comment

     * @param mixed|string|null $position

Missing parameter comment

     *
     * @return string
     */
    public function createImageFromAsset(Asset $asset, int $width, int $height, int $quality, mixed $position): string
    {
        $tempPath = '';
        if (Image::canManipulateAsImage($asset->getExtension())) {
            $imageSource = TransformHelper::getLocalImageSource($asset);
            // Scale and crop the placeholder image
            $tempPath = $this->createImageFromPath($imageSource, $width, $height, $quality, $position);
        }

        return $tempPath;
    }

    /**

Missing short description in doc comment

     * @param string $filePath

Expected 12 spaces after parameter type; 1 found

Missing parameter comment

     * @param int $width

Expected 15 spaces after parameter type; 1 found

Missing parameter comment

     * @param int $height

Expected 15 spaces after parameter type; 1 found

Missing parameter comment

     * @param int $quality

Expected 15 spaces after parameter type; 1 found

Missing parameter comment

     * @param mixed|string|null $position

Missing parameter comment

     *
     * @return string
     */
    public function createImageFromPath(
        string $filePath,
        int    $width,
        int    $height,
        int    $quality,
        mixed  $position,
    ): string {
        $images = Craft::$app->getImages();
        $pathParts = pathinfo($filePath);
        try {
            if (StringHelper::toLowerCase($pathParts['extension']) === 'svg') {
                $image = $images->loadImage($filePath, true, $width);
            } else {
                $image = $images->loadImage($filePath);
            }
        } catch (Throwable $e) {
            Craft::error(
                'Error creating temporary image: ' . $e->getMessage(),
                __METHOD__
            );

            return '';
        }

        if ($image instanceof Raster) {
            $image->setQuality($quality);
        }

        // Resize the image
        $image->scaleAndCrop($width, $height, true, $position);

        // Strip any EXIF data from the image before trying to save it
        if ($image instanceof Raster) {
            $imagineImage = $image->getImagineImage();
            if ($imagineImage) {

$imagineImage is of type Imagine\Image\AbstractImage, thus it always evaluated to true.

                $imagineImage->strip();
            }
        }


        // Save the image out to a temp file, then return its contents
        $tempFilename = uniqid(pathinfo($pathParts['filename'], PATHINFO_FILENAME), true) . '.' . 'jpg';

It seems like pathinfo($pathParts['filename'], nystudio107\imageoptimize\services\PATHINFO_FILENAME) can also be of type array; however, parameter $prefix of uniqid() does only seem to accept string, maybe add an additional type check?

        $tempPath = Craft::$app->getPath()->getTempPath() . DIRECTORY_SEPARATOR . $tempFilename;
        clearstatcache(true, $tempPath);
        try {
            $image->saveAs($tempPath);
        } catch (Throwable $e) {
            Craft::error(
                'Error saving temporary image: ' . $e->getMessage(),
                __METHOD__
            );
        }

        return $tempPath;
    }
}