nystudio107 / craft-imageoptimize

src/variables/ImageOptimizeVariable.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\variables;

use craft\elements\Asset;
use craft\helpers\Template;
use nystudio107\imageoptimize\ImageOptimize;
use nystudio107\imageoptimize\imagetransforms\ImageTransformInterface;
use nystudio107\imageoptimize\models\OptimizedImage;
use nystudio107\pluginvite\variables\ViteVariableInterface;
use nystudio107\pluginvite\variables\ViteVariableTrait;
use Twig\Markup;
use yii\base\InvalidConfigException;

/**

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.4.0

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

The tag in position 3 should be the @author tag

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ImageOptimizeVariable implements ViteVariableInterface
{
    use ViteVariableTrait;

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

    /**
     * Render the LazySizes fallback JS
     *
     * @param array $scriptAttrs

Missing parameter comment

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

     * @param array $variables

Missing parameter comment

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

     * @return Markup

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

     */
    public function renderLazySizesFallbackJs(array $scriptAttrs = [], array $variables = []): Markup
    {
        return Template::raw(ImageOptimize::$plugin->optimize->renderLazySizesFallbackJs($scriptAttrs, $variables));
    }

    /**
     * Render the LazySizes JS
     *
     * @param array $scriptAttrs

Missing parameter comment

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

     * @param array $variables

Missing parameter comment

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

     * @return Markup

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

     */
    public function renderLazySizesJs(array $scriptAttrs = [], array $variables = []): Markup
    {
        return Template::raw(ImageOptimize::$plugin->optimize->renderLazySizesJs($scriptAttrs, $variables));
    }

    /**
     * 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 Markup
     */
    public function placeholderBox($width, $height, ?string $color = null): Markup
    {
        return Template::raw(ImageOptimize::$plugin->placeholder->generatePlaceholderBox($width, $height, $color));
    }

    /**

Missing short description in doc comment

     * @param Asset $asset

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     * @param ?array $variants

Missing parameter comment

     * @param bool $generatePlaceholders

Expected 3 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return ?OptimizedImage
     * @throws InvalidConfigException
     */
    public function createOptimizedImages(
        Asset  $asset,
        ?array $variants = null,
        bool   $generatePlaceholders = false,
    ): ?OptimizedImage {
        // Override our settings for lengthy operations, since we're doing this via Twig
        ImageOptimize::$generatePlaceholders = $generatePlaceholders;

        return ImageOptimize::$plugin->optimizedImages->createOptimizedImages($asset, $variants);

It seems like $variants can also be of type null; however, parameter $variants of nystudio107\imageoptimize\services\OptimizedImages::createOptimizedImages() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Returns whether `.webp` is a format supported by the server
     *
     * @return bool
     */
    public function serverSupportsWebP(): bool
    {
        return ImageOptimize::$plugin->optimize->serverSupportsWebP();
    }

    /**
     * Creates an Image Transform with a given config.
     *
     * @param mixed $config The Image Transform’s class name, or its config,
     *                      with a `type` value and optionally a `settings` value
     *
     * @return ?ImageTransformInterface The Image Transform
     */
    public function createImageTransformType($config): ?ImageTransformInterface
    {
        return ImageOptimize::$plugin->optimize->createImageTransformType($config);
    }

    /**
     * Return whether we are running Craft 3.1 or later
     *
     * @return bool
     */
    public function craft31(): bool
    {
        return true;
    }
}