nystudio107\imageoptimize\services\Optimize

Complexity

Total Complexity

104

Size/Duplication

Total Lines	870
Duplicated Lines	0 %

Importance

Changes	11
Bugs	4	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	humanFileSize()	0	8	1
A	renderLazySizesJs()	0	22	2
A	getActiveImageProcessors()	0	26	4
B	createImageVariants()	0	68	9
A	getActiveVariantCreators()	0	26	4
A	handleAfterDeleteTransformsEvent()	0	5	2
B	handleGetAssetThumbUrlEvent()	0	37	7
A	optimizeImage()	0	23	6
A	executeShellCommand()	0	19	4
A	createImageTransformType()	0	15	3
A	handleGenerateTransformEvent()	0	61	4
A	getAllImageTransformTypes()	0	13	1
A	saveTransformToTempFile()	0	12	2
A	executeVariantCreator()	0	53	5
A	renderLazySizesFallbackJs()	0	22	2
A	serverSupportsWebP()	0	11	4
B	executeImageProcessor()	0	39	6
B	cleanupImageVariants()	0	39	9
A	copyImageVariantToVolume()	0	40	5
A	swapPathExtension()	0	10	3
C	handleGetAssetUrlEvent()	0	57	13
B	applyFiltersToImage()	0	24	8

<?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 Craft;
use craft\base\Component;
use craft\base\Image;
use craft\console\Application as ConsoleApplication;
use craft\elements\Asset;
use craft\errors\FsException;
use craft\errors\ImageException;
use craft\events\DefineAssetThumbUrlEvent;
use craft\events\DefineAssetUrlEvent;
use craft\events\ImageTransformerOperationEvent;
use craft\events\RegisterComponentTypesEvent;
use craft\helpers\Component as ComponentHelper;
use craft\helpers\FileHelper;
use craft\helpers\Html;
use craft\helpers\Image as ImageHelper;
use craft\image\Raster;
use craft\models\ImageTransform as AssetTransform;
use craft\models\ImageTransformIndex as AssetTransformIndex;
use mikehaertl\shellcommand\Command as ShellCommand;
use nystudio107\imageoptimize\helpers\PluginTemplate as PluginTemplateHelper;
use nystudio107\imageoptimize\ImageOptimize;
use nystudio107\imageoptimize\imagetransforms\CraftImageTransform;
use nystudio107\imageoptimize\imagetransforms\ImageTransform;
use nystudio107\imageoptimize\imagetransforms\ImageTransformInterface;
use nystudio107\imageoptimize\models\Settings;
use nystudio107\imageoptimizeimgix\imagetransforms\ImgixImageTransform;
use nystudio107\imageoptimizesharp\imagetransforms\SharpImageTransform;
use nystudio107\imageoptimizethumbor\imagetransforms\ThumborImageTransform;
use Throwable;
use yii\base\Configurable;
use yii\base\InvalidConfigException;
use function function_exists;
use function is_array;
use function is_string;

/** @noinspection MissingPropertyAnnotationsInspection */

Missing short description in doc comment

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

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

/**

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 Optimize extends Component
{
    // Constants
    // =========================================================================
    /**

Missing short description in doc comment

     * @event RegisterComponentTypesEvent The event that is triggered when registering
     *        Image Transform types
     *
     * Image Transform types must implement [[ImageTransformInterface]]. [[ImageTransform]]
     * provides a base implementation.
     *
     * ```php
     * use nystudio107\imageoptimize\services\Optimize;
     * use craft\events\RegisterComponentTypesEvent;
     * use yii\base\Event;
     *
     * Event::on(Optimize::class,
     *     Optimize::EVENT_REGISTER_IMAGE_TRANSFORM_TYPES,
     *     function(RegisterComponentTypesEvent $event) {
     *         $event->types[] = MyImageTransform::class;
     *     }
     * );
     * ```
     * @var string

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

     */
    public const EVENT_REGISTER_IMAGE_TRANSFORM_TYPES = 'registerImageTransformTypes';

    /**

Missing short description in doc comment

     * @var array<class-string<Configurable>>
     */
    public const DEFAULT_IMAGE_TRANSFORM_TYPES = [
        CraftImageTransform::class,
        ImgixImageTransform::class,
        SharpImageTransform::class,
        ThumborImageTransform::class,
    ];

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

    /**
     * Returns all available field type classes.
     *
     * @return string[] The available field type classes
     */
    public function getAllImageTransformTypes(): array
    {
        $imageTransformTypes = array_unique(array_merge(

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

            ImageOptimize::$plugin->getSettings()->defaultImageTransformTypes ?? [],

The method getSettings() does not exist on null.

            self::DEFAULT_IMAGE_TRANSFORM_TYPES
        ), SORT_REGULAR);

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

        $event = new RegisterComponentTypesEvent([

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

            'types' => $imageTransformTypes,
        ]);

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

        $this->trigger(self::EVENT_REGISTER_IMAGE_TRANSFORM_TYPES, $event);

        return $event->types;
    }

    /**
     * Creates an Image Transform with a given config.
     *
     * @param string|array $config The Image Transform’s class name, or its config,
     *                      with a `type` value and optionally a `settings` value

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

     *
     * @return ?ImageTransformInterface The Image Transform
     */
    public function createImageTransformType(string|array $config): ?ImageTransformInterface
    {
        if (is_string($config)) {

The condition is_string($config) is always false.

            $config = ['type' => $config];
        }

        try {
            /** @var ImageTransform $imageTransform */

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

            $imageTransform = ComponentHelper::createComponent($config, ImageTransformInterface::class);
        } catch (Throwable $e) {
            $imageTransform = null;
            Craft::error($e->getMessage(), __METHOD__);
        }

        return $imageTransform;
    }

    /**
     * Handle responding to EVENT_GET_ASSET_URL events
     *
     * @param DefineAssetUrlEvent $event

Missing parameter comment

     *
     * @return ?string
     */
    public function handleGetAssetUrlEvent(DefineAssetUrlEvent $event): ?string
    {
        Craft::beginProfile('handleGetAssetUrlEvent', __METHOD__);
        $url = null;
        if (!ImageOptimize::$plugin->transformMethod instanceof CraftImageTransform) {
            $asset = $event->asset;

The property craft\events\DefineAssetUrlEvent::$asset has been deprecated: in 4.3.0. [[$sender]] should be used instead.

            $transform = $event->transform;
            // If the transform is empty in some regard, normalize it to null
            if (empty($transform)) {
                $transform = null;
            }
            // If there's no transform requested, return `null` so other plugins have a crack at it
            if ($transform === null) {
                return null;
            }
            // If we're passed in null, make a dummy AssetTransform model for Thumbor
            // For backwards compatibility
            if (ImageOptimize::$plugin->transformMethod instanceof ThumborImageTransform) {
                $transform = new AssetTransform([

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

                    'width' => $asset->width,
                    'interlace' => 'line',
                ]);

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

            }
            // If we're passed an array, make an AssetTransform model out of it
            if (is_array($transform)) {
                $transform = new AssetTransform($transform);
            }
            // If we're passing in a string, look up the asset transform in the db
            if (is_string($transform)) {
                $imageTransforms = Craft::$app->getImageTransforms();
                $transform = $imageTransforms->getTransformByHandle($transform);
            }
            $finalFormat = empty($transform['format']) ? $asset->getExtension() : $transform['format'];
            // Normalize the extension to lowercase, for some transform methods that require this
            $finalFormat = strtolower($finalFormat);
            // Special-case for 'jpeg'
            if ($finalFormat === 'jpeg') {
                $finalFormat = 'jpg';
            }
            // If the final format is an SVG, don't attempt to transform it
            if ($finalFormat === 'svg') {
                return null;
            }
            // Normalize the extension to lowercase, for some transform methods that require this
            if (!empty($transform) && !empty($finalFormat)) {
                $format = $transform['format'] ?? null;
                $transform['format'] = $format === null ? null : strtolower($finalFormat);
            }
            // Generate an image transform url
            $url = ImageOptimize::$plugin->transformMethod->getTransformUrl(
                $asset,
                $transform
            );
        }
        Craft::endProfile('handleGetAssetUrlEvent', __METHOD__);

        return $url;
    }

    /**
     * Handle responding to EVENT_GET_ASSET_THUMB_URL events
     *
     * @param DefineAssetThumbUrlEvent $event

Missing parameter comment

     *
     * @return ?string
     */
    public function handleGetAssetThumbUrlEvent(DefineAssetThumbUrlEvent $event): ?string
    {
        Craft::beginProfile('handleGetAssetThumbUrlEvent', __METHOD__);
        $url = $event->url;
        if (!ImageOptimize::$plugin->transformMethod instanceof CraftImageTransform) {
            $asset = $event->asset;
            if (ImageHelper::canManipulateAsImage($asset->getExtension())) {
                $transform = new AssetTransform([

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

                    'width' => $event->width,
                    'height' => $event->height,
                    'interlace' => 'line',
                ]);

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

                /** @var ImageTransform $transformMethod */

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

                $transformMethod = ImageOptimize::$plugin->transformMethod;
                $finalFormat = empty($transform['format']) ? $asset->getExtension() : $transform['format'];
                // Normalize the extension to lowercase, for some transform methods that require this
                $finalFormat = strtolower($finalFormat);
                // Special-case for 'jpeg'
                if ($finalFormat === 'jpeg') {
                    $finalFormat = 'jpg';
                }
                // If the final format is an SVG, don't attempt to transform it
                if ($finalFormat === 'svg') {
                    return null;
                }
                // Generate an image transform url
                if ($transformMethod->hasProperty('generateTransformsBeforePageLoad')) {
                    // This is a dynamic property that some image transforms have
                    /** @phpstan-ignore-next-line */

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

                    $transformMethod->generateTransformsBeforePageLoad = true;

The property generateTransformsBeforePageLoad does not exist on nystudio107\imageoptimize\imagetransforms\ImageTransform. Since you implemented __set, consider adding a @property annotation.

                }
                $url = $transformMethod->getTransformUrl($asset, $transform);

Are you sure the assignment to $url is correct as $transformMethod->getTransformUrl($asset, $transform) targeting nystudio107\imageoptimize\imagetransforms\ImageTransform::getTransformUrl() seems to always return null.

            }
        }
        Craft::endProfile('handleGetAssetThumbUrlEvent', __METHOD__);

        return $url;
    }

    /**
     * Returns whether `.webp` is a format supported by the server
     *
     * @return bool
     */
    public function serverSupportsWebP(): bool
    {
        $result = false;
        $variantCreators = ImageOptimize::$plugin->optimize->getActiveVariantCreators();
        foreach ($variantCreators as $variantCreator) {
            if ($variantCreator['creator'] === 'cwebp' && $variantCreator['installed']) {
                $result = true;
            }
        }

        return $result;
    }

    /**
     * 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 string

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

     */
    public function renderLazySizesFallbackJs(array $scriptAttrs = [], array $variables = []): string
    {
        $minifier = 'minify';
        $vars = array_merge([

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

            'scriptSrc' => 'https://cdnjs.cloudflare.com/ajax/libs/lazysizes/5.3.0/lazysizes.min.js',
        ],

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 8.

            $variables
        );
        $content = PluginTemplateHelper::renderPluginTemplate(
            'frontend/lazysizes-fallback.twig.js',
            $vars,
            $minifier
        );
        if ($scriptAttrs !== null) {

The condition $scriptAttrs !== null is always true.

            $attrs = array_merge([

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

            ],

This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 12.

                $scriptAttrs
            );
            $content = Html::tag('script', $content, $attrs);
        }

        return $content;
    }

    /**
     * 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 string

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

     */
    public function renderLazySizesJs(array $scriptAttrs = [], array $variables = []): string
    {
        $minifier = 'minify';
        $vars = array_merge([

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

            'scriptSrc' => 'https://cdnjs.cloudflare.com/ajax/libs/lazysizes/5.3.0/lazysizes.min.js',
        ],

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 8.

            $variables
        );
        $content = PluginTemplateHelper::renderPluginTemplate(
            'frontend/lazysizes.twig.js',
            $vars,
            $minifier
        );
        if ($scriptAttrs !== null) {

The condition $scriptAttrs !== null is always true.

            $attrs = array_merge([

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

            ],

This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 12.

                $scriptAttrs
            );
            $content = Html::tag('script', $content, $attrs);
        }

        return $content;
    }

    /**
     * Handle responding to EVENT_TRANSFORM_IMAGE events
     *
     * @param ImageTransformerOperationEvent $event

Missing parameter comment

     *
     * @return ?string
     * @throws InvalidConfigException
     */
    public function handleGenerateTransformEvent(ImageTransformerOperationEvent $event): ?string
    {
        Craft::beginProfile('handleGenerateTransformEvent', __METHOD__);
        $tempPath = null;
        // Only do this for local Craft transforms
        $asset = $event->asset;

        if (ImageOptimize::$plugin->transformMethod instanceof CraftImageTransform) {
            // Apply any filters to the image
            $imageTransformIndex = $event->imageTransformIndex;
            $image = $event->image;

            if ($imageTransformIndex->getTransform() !== null) {
                $this->applyFiltersToImage($imageTransformIndex->getTransform(), $asset, $image);

It seems like $image can also be of type null; however, parameter $image of nystudio107\imageoptimize\services\Optimize::applyFiltersToImage() does only seem to accept craft\base\Image, maybe add an additional type check?

            }
            // Save the transformed image to a temp file
            $tempPath = $this->saveTransformToTempFile(
                $imageTransformIndex,
                $image

It seems like $image can also be of type null; however, parameter $image of nystudio107\imageoptimize\services\Optimize::saveTransformToTempFile() does only seem to accept craft\base\Image, maybe add an additional type check?

            );
            $originalFileSize = @filesize($tempPath);
            // Optimize the image
            $this->optimizeImage(
                $imageTransformIndex,
                $tempPath
            );
            clearstatcache(true, $tempPath);
            // Log the results of the image optimization
            $optimizedFileSize = @filesize($tempPath);
            $message =

Multi-line assignments must have the equal sign on the second line

                pathinfo($imageTransformIndex->filename, PATHINFO_FILENAME)

Are you sure pathinfo($imageTransformIndex->filename, nystudio107\imageoptimize\services\PATHINFO_FILENAME) of type array|string can be used in concatenation?

It seems like $imageTransformIndex->filename can also be of type null; however, parameter $path of pathinfo() does only seem to accept string, maybe add an additional type check?

                . '.'
                . $imageTransformIndex->detectedFormat
                . ' -> '
                . Craft::t('image-optimize', 'Original')
                . ': '
                . $this->humanFileSize($originalFileSize, 1)
                . ', '
                . Craft::t('image-optimize', 'Optimized')
                . ': '
                . $this->humanFileSize($optimizedFileSize, 1)
                . ' -> '
                . Craft::t('image-optimize', 'Savings')
                . ': '
                . number_format(abs(100 - (($optimizedFileSize * 100) / $originalFileSize)), 1)
                . '%';
            Craft::info($message, __METHOD__);
            if (Craft::$app instanceof ConsoleApplication) {
                echo $message . PHP_EOL;
            }
            // Create any image variants
            $this->createImageVariants(
                $imageTransformIndex,
                $asset,
                $tempPath,
                $event->path
            );
        }
        Craft::endProfile('handleGenerateTransformEvent', __METHOD__);

        return $tempPath;
    }

    /**
     * Handle cleaning up any variant creator images
     *
     * @param ImageTransformerOperationEvent $event

Missing parameter comment

     */

Missing @return tag in function comment

    public function handleAfterDeleteTransformsEvent(ImageTransformerOperationEvent $event): void
    {
        // Only do this for local Craft transforms
        if (ImageOptimize::$plugin->transformMethod instanceof CraftImageTransform) {
            $this->cleanupImageVariants($event->asset, $event->imageTransformIndex, $event->path);
        }
    }

    /**
     * Save out the image to a temp file
     *
     * @param AssetTransformIndex $index

Missing parameter comment

     * @param Image $image

Missing parameter comment

Expected 15 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function saveTransformToTempFile(AssetTransformIndex $index, Image $image): string
    {
        $tempFilename = uniqid(pathinfo($index->filename, PATHINFO_FILENAME), true) . '.' . $index->detectedFormat;

It seems like pathinfo($index->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?

It seems like $index->filename can also be of type null; however, parameter $path of pathinfo() does only seem to accept string, maybe add an additional type check?

        $tempPath = Craft::$app->getPath()->getTempPath() . DIRECTORY_SEPARATOR . $tempFilename;
        try {
            $image->saveAs($tempPath);
        } catch (ImageException $e) {
            Craft::error('Transformed image save failed: ' . $e->getMessage(), __METHOD__);
        }
        Craft::info('Transformed image saved to: ' . $tempPath, __METHOD__);

        return $tempPath;
    }

    /**
     * Run any image post-processing/optimization on the image file
     *
     * @param AssetTransformIndex $index

Missing parameter comment

     * @param string $tempPath

Missing parameter comment

Expected 14 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function optimizeImage(AssetTransformIndex $index, string $tempPath): void
    {
        Craft::beginProfile('optimizeImage', __METHOD__);
        /** @var Settings $settings */

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

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

Missing short description in doc comment

        $settings = ImageOptimize::$plugin->getSettings();
        // Get the active processors for the transform format
        $activeImageProcessors = $settings->activeImageProcessors;
        $fileFormat = $index->detectedFormat ?? $index->format;
        $fileFormat = strtolower($fileFormat);

It seems like $fileFormat can also be of type null; however, parameter $string of strtolower() does only seem to accept string, maybe add an additional type check?

        // Special-case for 'jpeg'
        if ($fileFormat === 'jpeg') {
            $fileFormat = 'jpg';
        }
        if (!empty($activeImageProcessors[$fileFormat])) {
            // Iterate through all the processors for this format
            $imageProcessors = $settings->imageProcessors;
            foreach ($activeImageProcessors[$fileFormat] as $processor) {
                if (!empty($processor) && !empty($imageProcessors[$processor])) {
                    $this->executeImageProcessor($imageProcessors[$processor], $tempPath);
                }
            }
        }
        Craft::endProfile('optimizeImage', __METHOD__);
    }

    /**
     * Translate bytes into something human-readable
     *
     * @param     $bytes

Missing parameter comment

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

     * @param int $decimals

Missing parameter comment

     *
     * @return string
     */
    public function humanFileSize($bytes, int $decimals = 1): string
    {
        $oldSize = Craft::$app->formatter->sizeFormatBase;
        Craft::$app->formatter->sizeFormatBase = 1000;
        $result = Craft::$app->formatter->asShortSize($bytes, $decimals);
        Craft::$app->formatter->sizeFormatBase = $oldSize;

        return $result;
    }

    /**
     * Create any image variants for the image file
     *
     * @param AssetTransformIndex $index

Missing parameter comment

     * @param Asset $asset

Expected 15 spaces after parameter type; 1 found

Missing parameter comment

     * @param string $tempPath

Missing parameter comment

Expected 14 spaces after parameter type; 1 found

     * @param string $uri

Missing parameter comment

Expected 14 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function createImageVariants(AssetTransformIndex $index, Asset $asset, string $tempPath, string $uri): void
    {
        Craft::beginProfile('createImageVariants', __METHOD__);
        /** @var Settings $settings */

Missing short description in doc comment

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

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

        $settings = ImageOptimize::$plugin->getSettings();
        // Get the active image variant creators
        $activeImageVariantCreators = $settings->activeImageVariantCreators;
        $fileFormat = $index->detectedFormat ?? $index->format;
        $fileFormat = strtolower($fileFormat);

It seems like $fileFormat can also be of type null; however, parameter $string of strtolower() does only seem to accept string, maybe add an additional type check?

        // Special-case for 'jpeg'
        if ($fileFormat === 'jpeg') {
            $fileFormat = 'jpg';
        }
        if (!empty($activeImageVariantCreators[$fileFormat])) {
            // Iterate through all of the image variant creators for this format
            $imageVariantCreators = $settings->imageVariantCreators;
            foreach ($activeImageVariantCreators[$fileFormat] as $variantCreator) {
                if (!empty($variantCreator) && !empty($imageVariantCreators[$variantCreator])) {
                    // Create the image variant in a temporary folder
                    $generalConfig = Craft::$app->getConfig()->getGeneral();
                    $quality = $index->transform->quality ?: $generalConfig->defaultImageQuality;
                    $outputPath = $this->executeVariantCreator(
                        $imageVariantCreators[$variantCreator],
                        $tempPath,
                        $quality
                    );
                    if ($outputPath !== null) {
                        // Get info on the original and the created variant
                        $originalFileSize = @filesize($tempPath);
                        $variantFileSize = @filesize($outputPath);
                        $message =

Multi-line assignments must have the equal sign on the second line

                            pathinfo($tempPath, PATHINFO_FILENAME)