nystudio107 / craft-imageoptimize

src/models/OptimizedImage.php

<?php
/**
 * Image Optimize 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\models;

use Craft;
use craft\base\Model;
use craft\helpers\Template;
use craft\validators\ArrayValidator;
use nystudio107\imageoptimize\helpers\Color as ColorHelper;
use nystudio107\imageoptimize\helpers\UrlHelper;
use nystudio107\imageoptimize\ImageOptimize;
use function strlen;

/**

Missing short description in doc comment

 * @author    nystudio107

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

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>"

 * @package   ImageOptimize

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

 * @since     1.2.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 OptimizedImage extends Model
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var ?array An array of optimized image variant URLs
     */
    public ?array $optimizedImageUrls = [];

    /**

Missing short description in doc comment

     * @var ?array An array of optimized .webp image variant URLs
     */
    public ?array $optimizedWebPImageUrls = [];

    /**

Missing short description in doc comment

     * @var ?array An array of the widths of the optimized image variants
     */
    public ?array $variantSourceWidths = [];

    /**

Missing short description in doc comment

     * @var ?array An array of the heights of the optimized image variants
     */
    public ?array $variantHeights = [];

    /**

Missing short description in doc comment

     * @var array An array of the x,y image focal point coords, ranging from 0.0 to 1.0
     */
    public ?array $focalPoint = [];

    /**

Missing short description in doc comment

     * @var int The width of the original source image
     */
    public ?int $originalImageWidth = 0;

    /**

Missing short description in doc comment

     * @var ?int The height of the original source image
     */
    public ?int $originalImageHeight = 0;

    /**

Missing short description in doc comment

     * @var ?string The base64 encoded placeholder LQIP image
     */
    public ?string $placeholder = '';

    /**

Missing short description in doc comment

     * @var ?string The base64 encoded placeholder LQIP SVG image
     */
    public ?string $placeholderSvg = '';

    /**

Missing short description in doc comment

     * @var ?array An array the 5 most dominant colors in the image
     */
    public ?array $colorPalette = [];

    /**

Missing short description in doc comment

     * @var ?int The overall lightness of the image, from 0..100
     */
    public ?int $lightness = 0;

    /**

Missing short description in doc comment

     * @var ?int The width of the placeholder image
     */
    public ?int $placeholderWidth = 0;

    /**

Missing short description in doc comment

     * @var ?int The height of the placeholder image
     */
    public ?int $placeholderHeight = 0;

    /**

Missing short description in doc comment

     * @var ?array An array of errors logged when generating the image transforms
     */
    public ?array $stickyErrors = [];

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        return [
            ['optimizedImageUrls', ArrayValidator::class],
            ['optimizedWebPImageUrls', ArrayValidator::class],
            ['variantSourceWidths', ArrayValidator::class],
            ['variantHeights', ArrayValidator::class],
            ['focalPoint', 'safe'],
            ['originalImageWidth', 'integer'],
            ['originalImageHeight', 'integer'],
            ['placeholder', 'string'],
            ['placeholderSvg', 'string'],
            ['colorPalette', ArrayValidator::class],
            ['placeholderWidth', 'integer'],
            ['placeholderHeight', 'integer'],
            ['stickyErrors', ArrayValidator::class],
        ];
    }

    /**
     * Return the first image variant URL or the specific one passed in via
     * $width
     *
     * @param int $width

Missing parameter comment

     *
     * @return string
     */
    public function src(int $width = 0): string
    {
        if (empty($width)) {
            return Template::raw(reset($this->optimizedImageUrls));

It seems like $this->optimizedImageUrls can also be of type null; however, parameter $array of reset() does only seem to accept array|object, maybe add an additional type check?

        }

        return Template::raw($this->optimizedImageUrls[$width] ?? '');
    }

    /**
     * Getter for CraftQL
     *
     * @param int $width

Missing parameter comment

     *
     * @return string
     */
    public function getSrc(int $width = 0): string
    {
        return $this->src($width);
    }

    /**
     * Return a string of image URLs and their sizes
     *
     * @param bool $dpr Whether to generate 1x, 2x srcsets vs the normal XXXw
     *                  srcsets
     *
     * @return string
     */
    public function srcset(bool $dpr = false): string
    {
        return Template::raw($this->getSrcsetFromArray($this->optimizedImageUrls, $dpr));

It seems like $this->optimizedImageUrls can also be of type null; however, parameter $array of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetFromArray() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Getter for CraftQL
     *
     * @param bool $dpr

Missing parameter comment

     *
     * @return string
     */
    public function getSrcset(bool $dpr = false): string
    {
        return $this->srcset($dpr);
    }

    /**
     * Return a string of image URLs and their sizes that match $width
     *
     * @param int $width

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param bool $dpr Whether to generate 1x, 2x srcsets vs the normal XXXw

Expected 3 spaces after parameter name; 1 found

     *                  srcsets
     *
     * @return string
     */
    public function srcsetWidth(int $width, bool $dpr = false): string
    {
        $subset = $this->getSrcsetSubsetArray($this->optimizedImageUrls, $width, 'width');

It seems like $this->optimizedImageUrls can also be of type null; however, parameter $set of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetSubsetArray() does only seem to accept array, maybe add an additional type check?

        return Template::raw($this->getSrcsetFromArray($subset, $dpr));
    }

    /**
     * Return a string of image URLs and their sizes that are at least $width
     * or larger
     *
     * @param int $width

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param bool $dpr Whether to generate 1x, 2x srcsets vs the normal XXXw

Expected 3 spaces after parameter name; 1 found

     *                  srcsets
     *
     * @return string
     */
    public function srcsetMinWidth(int $width, bool $dpr = false): string
    {
        $subset = $this->getSrcsetSubsetArray($this->optimizedImageUrls, $width, 'minwidth');

It seems like $this->optimizedImageUrls can also be of type null; however, parameter $set of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetSubsetArray() does only seem to accept array, maybe add an additional type check?

        return Template::raw($this->getSrcsetFromArray($subset, $dpr));
    }

    /**
     * Return a string of image URLs and their sizes that are $width or smaller
     *
     * @param int $width

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param bool $dpr Whether to generate 1x, 2x srcsets vs the normal XXXw

Expected 3 spaces after parameter name; 1 found

     *                  srcsets
     *
     * @return string
     */
    public function srcsetMaxWidth(int $width, bool $dpr = false): string
    {
        $subset = $this->getSrcsetSubsetArray($this->optimizedImageUrls, $width, 'maxwidth');

It seems like $this->optimizedImageUrls can also be of type null; however, parameter $set of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetSubsetArray() does only seem to accept array, maybe add an additional type check?

        return Template::raw($this->getSrcsetFromArray($subset, $dpr));
    }

    /**
     * Return the first webp image variant URL or the specific one passed in
     * via $width
     *
     * @param int $width

Missing parameter comment

     *
     * @return string
     */
    public function srcWebp(int $width = 0): string
    {
        if (empty($width)) {
            return Template::raw(reset($this->optimizedWebPImageUrls));

It seems like $this->optimizedWebPImageUrls can also be of type null; however, parameter $array of reset() does only seem to accept array|object, maybe add an additional type check?

        }

        return Template::raw($this->optimizedWebPImageUrls[$width] ?? '');
    }

    /**
     * Getter for CraftQL
     *
     * @param int $width

Missing parameter comment

     *
     * @return string
     */
    public function getSrcWebp(int $width = 0): string
    {
        return $this->srcWebp($width);
    }

    /**
     * Return a string of webp image URLs and their sizes
     *
     * @param bool $dpr Whether to generate 1x, 2x srcsets vs the normal XXXw
     *                  srcsets
     *
     * @return string
     */
    public function srcsetWebp(bool $dpr = false): string
    {
        return Template::raw($this->getSrcsetFromArray($this->optimizedWebPImageUrls, $dpr));

It seems like $this->optimizedWebPImageUrls can also be of type null; however, parameter $array of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetFromArray() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Getter for CraftQL
     *
     * @param bool $dpr

Missing parameter comment

     *
     * @return string
     */
    public function getSrcsetWebp(bool $dpr = false): string
    {
        return $this->srcsetWebp($dpr);
    }

    /**
     * Return a string of webp image URLs and their sizes that match $width
     *
     * @param int $width

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param bool $dpr Whether to generate 1x, 2x srcsets vs the normal XXXw

Expected 3 spaces after parameter name; 1 found

     *                  srcsets
     *
     * @return string
     */
    public function srcsetWidthWebp(int $width, bool $dpr = false): string
    {
        $subset = $this->getSrcsetSubsetArray($this->optimizedWebPImageUrls, $width, 'width');

It seems like $this->optimizedWebPImageUrls can also be of type null; however, parameter $set of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetSubsetArray() does only seem to accept array, maybe add an additional type check?

        return Template::raw($this->getSrcsetFromArray($subset, $dpr));
    }

    /**
     * Return a string of webp image URLs and their sizes that are at least
     * $width or larger
     *
     * @param int $width

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param bool $dpr Whether to generate 1x, 2x srcsets vs the normal XXXw

Expected 3 spaces after parameter name; 1 found

     *                  srcsets
     *
     * @return string
     */
    public function srcsetMinWidthWebp(int $width, bool $dpr = false): string
    {
        $subset = $this->getSrcsetSubsetArray($this->optimizedWebPImageUrls, $width, 'minwidth');

It seems like $this->optimizedWebPImageUrls can also be of type null; however, parameter $set of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetSubsetArray() does only seem to accept array, maybe add an additional type check?

        return Template::raw($this->getSrcsetFromArray($subset, $dpr));
    }

    /**
     * Return a string of webp image URLs and their sizes that are $width or
     * smaller
     *
     * @param int $width

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param bool $dpr Whether to generate 1x, 2x srcsets vs the normal XXXw

Expected 3 spaces after parameter name; 1 found

     *                  srcsets
     *
     * @return string
     */
    public function srcsetMaxWidthWebp(int $width, bool $dpr = false): string
    {
        $subset = $this->getSrcsetSubsetArray($this->optimizedWebPImageUrls, $width, 'maxwidth');

It seems like $this->optimizedWebPImageUrls can also be of type null; however, parameter $set of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetSubsetArray() does only seem to accept array, maybe add an additional type check?

        return Template::raw($this->getSrcsetFromArray($subset, $dpr));
    }

    /**
     * Work around issues with `<img srcset>` returning sizes larger than are
     * available as per:
     * https://medium.com/@MRWwebDesign/responsive-images-the-sizes-attribute-and-unexpected-image-sizes-882a2eadb6db
     *
     * @return int
     */
    public function maxSrcsetWidth(): int
    {
        $result = 0;
        if (!empty($this->optimizedImageUrls)) {
            $tempArray = $this->optimizedImageUrls;
            ksort($tempArray, SORT_NUMERIC);

            $keys = array_keys($tempArray);
            $result = end($keys);
        }

        return $result;
    }

    /**
     * Getter for CraftQL
     *
     * @return int
     */
    public function getMaxSrcsetWidth(): int
    {
        return $this->maxSrcsetWidth();
    }

    /**
     * Return the colors as an array of RGB colors
     */

Missing @return tag in function comment

    public function colorPaletteRgb(): array
    {
        $colors = [];

        foreach ($this->colorPalette as $color) {
            if (!empty($color)) {
                $colors[] = ColorHelper::HTMLToRGB($color);
            }
        }

        return $colors;
    }

    /**
     * Generate a complete <link rel="preload"> tag for this OptimizedImages model
     * ref: https://web.dev/preload-responsive-images/#imagesrcset-and-imagesizes
     *
     * @param array $config

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

Missing parameter comment

     * @return LinkPreloadTag

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function linkPreloadTag(array $config = []): LinkPreloadTag
    {
        return new LinkPreloadTag(array_merge($config, ['optimizedImage' => $this]));
    }

    /**
     * Generate a complete <img> tag for this OptimizedImage model
     *
     * @param array $config

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

Missing parameter comment

     * @return ImgTag

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function imgTag(array $config = []): ImgTag
    {
        return new ImgTag(array_merge($config, ['optimizedImage' => $this]));
    }

    /**
     * Generate a complete <picture> tag for this OptimizedImage model
     *
     * @param array $config

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

Missing parameter comment

     * @return PictureTag

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function pictureTag(array $config = []): PictureTag
    {
        return new PictureTag(array_merge($config, ['optimizedImage' => $this]));
    }

    /**
     * Return a base64-encoded placeholder image
     *
     * @return string
     */
    public function placeholderImage(): string
    {
        $header = 'data:image/jpeg;base64,';
        if (!empty($this->placeholder)) {
            $content = $this->placeholder;
        } else {
            // At least return something
            return $this->defaultPlaceholderImage();
        }

        return Template::raw($header . rawurlencode($content));
    }

    /**
     * Getter for CraftQL
     *
     * @return string
     */
    public function getPlaceholderImage(): string
    {
        return $this->placeholderImage();
    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function placeholderImageSize(): string
    {
        $placeholder = $this->placeholderImage();
        $contentLength = !empty(strlen($placeholder)) ? strlen($placeholder) : 0;

        return ImageOptimize::$plugin->optimize->humanFileSize($contentLength, 1);
    }

    /**
     * Return an SVG box as a placeholder image
     *
     * @param string|null $color

Missing parameter comment

     *
     * @return string
     */
    public function placeholderBox(?string $color = null): string
    {
        $width = $this->placeholderWidth ?? 1;
        $height = $this->placeholderHeight ?? 1;
        $color = $color ?? $this->colorPalette[0] ?? '#CCC';

        return Template::raw(ImageOptimize::$plugin->placeholder->generatePlaceholderBox($width, $height, $color));
    }

    /**

Missing short description in doc comment

     * @param string|null $color

Missing parameter comment

     *
     * @return string
     */
    public function getPlaceholderBox(string $color = null): string
    {
        return $this->placeholderBox($color);
    }

    /**
     * Getter for CraftQL
     *
     * @return string
     */
    public function placeholderBoxSize(): string
    {
        $placeholder = $this->placeholderBox();
        $contentLength = !empty(strlen($placeholder)) ? strlen($placeholder) : 0;

        return ImageOptimize::$plugin->optimize->humanFileSize($contentLength, 1);
    }

    /**
     * Return a silhouette of the image as an SVG placeholder
     *
     * @return string
     */
    public function placeholderSilhouette(): string
    {
        $header = 'data:image/svg+xml,';
        if (!empty($this->placeholderSvg)) {
            $content = $this->placeholderSvg;
        } else {
            // At least return something
            return $this->defaultPlaceholderImage();
        }

        return Template::raw($header . $content);
    }

    /**
     * Getter for CraftQL
     *
     * @return string
     */
    public function getPlaceholderSilhouette(): string
    {
        return $this->placeholderSilhouette();
    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function placeholderSilhouetteSize(): string
    {
        $placeholder = $this->placeholderSilhouette();
        $contentLength = !empty(strlen($placeholder)) ? strlen($placeholder) : 0;

        return ImageOptimize::$plugin->optimize->humanFileSize($contentLength, 1);
    }

    /**
     *  Get the file size of any remote resource (using curl),
     *  either in bytes or - default - as human-readable formatted string.
     *
     * @param string $url Takes the remote object's URL.

Expected 8 spaces after parameter name; 1 found

     * @param bool $formatSize Whether to return size in bytes or

Expected 3 spaces after parameter type; 1 found

     *                              formatted.

Parameter comment not aligned correctly; expected 25 spaces but found 30

     * @param bool $useHead Whether to use HEAD requests. If false,

Expected 3 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     *                              uses GET.

Parameter comment not aligned correctly; expected 22 spaces but found 30

     *
     * @return  mixed    Returns human-readable formatted size

Tag value for @return tag indented incorrectly; expected 7 spaces but found 2

     *                              or size in bytes (default: formatted).
     * @noinspection PhpComposerExtensionStubsInspection*@author  Stephan Schmitz <eyecatchup@gmail.com>
     * @license MIT <http://eyecatchup.mit-license.org/>

Tag value for @license tag indented incorrectly; expected 6 spaces but found 1

     * @url     <https://gist.github.com/eyecatchup/f26300ffd7e50a92bc4d>

Tag value for @url tag indented incorrectly; expected 10 spaces but found 5

     *
     * @noinspection PhpComposerExtensionStubsInspection

Tags must be grouped together in a doc comment

     */
    public function getRemoteFileSize(string $url, bool $formatSize = true, bool $useHead = true): mixed
    {
        // Get an absolute URL with protocol that curl will be happy with
        $url = UrlHelper::absoluteUrlWithProtocol($url);
        $ch = curl_init($url);
        /** @noinspection CurlSslServerSpoofingInspection */

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

        curl_setopt_array($ch, [

The opening parenthesis of a multi-line function call should be the last content on the line.

            CURLOPT_RETURNTRANSFER => 1,
            CURLOPT_FOLLOWLOCATION => 1,
            CURLOPT_SSL_VERIFYPEER => 0,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        if ($useHead) {
            curl_setopt($ch, CURLOPT_NOBODY, 1);
        }
        curl_exec($ch);
        // content-length of download (in bytes), read from Content-Length: field
        $contentLength = curl_getinfo($ch, CURLINFO_CONTENT_LENGTH_DOWNLOAD);
        $error = curl_error($ch);
        if (!empty($error)) {
            Craft::error($error, __METHOD__);
        }
        curl_close($ch);
        // cannot retrieve file size, return "-1"
        if (!$contentLength) {
            return -1;
        }
        // return size in bytes
        if (!$formatSize) {
            return $contentLength;
        }

        return ImageOptimize::$plugin->optimize->humanFileSize($contentLength, 1);
    }

    /**

Missing short description in doc comment

     * @param array $array

Missing parameter comment

     * @param bool $dpr

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return string
     */
    public function getSrcsetFromArray(array $array, bool $dpr = false): string
    {
        $srcset = '';
        foreach ($array as $key => $value) {
            if ($dpr) {
                $descriptor = '1x';
                if (!empty($array[(int)$key / 2])) {
                    $descriptor = '2x';
                }
                if (!empty($array[(int)$key / 3])) {
                    $descriptor = '3x';
                }
            } else {
                $descriptor = $key . 'w';
            }
            $srcset .= $value . ' ' . $descriptor . ', ';
        }

        return rtrim($srcset, ', ');
    }

    // Protected Methods
    // =========================================================================

    protected function getSrcsetSubsetArray(array $set, int $width, string $comparison): array

You must use "/**" style comments for a function comment

    {
        $subset = [];
        $index = 0;
        if (empty($this->variantSourceWidths)) {
            return $subset;
        }
        // Sort the arrays by numeric key
        ksort($set, SORT_NUMERIC);
        // Sort the arrays by numeric key
        sort($this->variantSourceWidths, SORT_NUMERIC);
        foreach ($this->variantSourceWidths as $variantSourceWidth) {
            $match = false;
            switch ($comparison) {
                case 'width':

Line indented incorrectly; expected 12 spaces, found 16

                    if ($variantSourceWidth == $width) {

Line indented incorrectly; expected 16 spaces, found 20

                        $match = true;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    break;

                case 'minwidth':

Line indented incorrectly; expected 12 spaces, found 16

                    if ($variantSourceWidth >= $width) {

Line indented incorrectly; expected 16 spaces, found 20

                        $match = true;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    break;

                case 'maxwidth':

Line indented incorrectly; expected 12 spaces, found 16

                    if ($variantSourceWidth <= $width) {

Line indented incorrectly; expected 16 spaces, found 20

                        $match = true;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    break;
            }
            if ($match) {
                $subset += array_slice($set, $index, 1, true);
            }
            $index++;
        }

        return $subset;
    }

    /**
     * Return a default placeholder image
     *
     * @return string
     */
    protected function defaultPlaceholderImage(): string
    {
        $width = 1;
        $height = 1;
        $color = '#CCC';

        return Template::raw(ImageOptimize::$plugin->placeholder->generatePlaceholderBox($width, $height, $color));
    }
}