nystudio107 / craft-imageoptimize

src/helpers/Image.php

<?php
/**

Missing short description in doc comment

 * @link      https://craftcms.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) Pixel & Tonic, Inc.

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

 * @license   https://craftcms.github.io/license/

@license tag must contain a URL and a license name

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

namespace nystudio107\imageoptimize\helpers;

use Craft;
use craft\errors\ImageException;
use craft\helpers\FileHelper;
use Imagine\Gd\Imagine as GdImagine;
use Imagine\Imagick\Imagine as ImagickImagine;
use Throwable;
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.6.4

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 Image
{
    // Public Static Methods
    // =========================================================================

    /**
     * This is a hacked version of `Raster::loadImage()` because the $_isAnimatedGif
     * property is private and there is no `getIsAnimatedGif()` getter
     *
     * @param string $path

Missing parameter comment

     *
     * @return bool
     *
     * @throws ImageException
     * @throws InvalidConfigException
     */
    public static function getIsAnimatedGif(string $path): bool
    {
        $generalConfig = Craft::$app->getConfig()->getGeneral();

        $extension = strtolower($generalConfig->imageDriver);

        // If it's explicitly set, take their word for it.
        if ($extension === 'gd') {
            $instance = new GdImagine();
        } elseif ($extension === 'imagick') {
            $instance = new ImagickImagine();
        } elseif (Craft::$app->getImages()->getIsGd()) {
            $instance = new GdImagine();
        } else {
            $instance = new ImagickImagine();
        }

        $imageService = Craft::$app->getImages();
        if ($imageService->getIsGd()) {
            return false;
        }

        if (!is_file($path)) {
            Craft::error('Tried to load an image at ' . $path . ', but the file does not exist.', __METHOD__);
            throw new ImageException(Craft::t('app', 'No file exists at the given path.'));
        }

        if (!$imageService->checkMemoryForImage($path)) {
            throw new ImageException(Craft::t(

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

                'app',
                'Not enough memory available to perform this image operation.'
            ));

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

        }

        // Make sure the image says it's an image
        $mimeType = FileHelper::getMimeType($path, null, false);

        if ($mimeType !== null && !str_starts_with($mimeType, 'image/') && !str_starts_with($mimeType, 'application/pdf')) {
            throw new ImageException(Craft::t(

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

                'app',
                'The file “{name}” does not appear to be an image.',
                ['name' => pathinfo($path, PATHINFO_BASENAME)]
            ));

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

        }

        try {
            $image = $instance->open($path);
        } catch (Throwable $e) {
            throw new ImageException(Craft::t(

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

                'app',
                'The file “{path}” does not appear to be an image.',
                ['path' => $path]
            ), 0, $e);

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

        }

        $extension = pathinfo($path, PATHINFO_EXTENSION);

        return $extension === 'gif' && $image->layers()->count() > 1;
    }
}