nystudio107 / craft-imageoptimize

src/jobs/ResaveOptimizedImages.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\jobs;

use Craft;
use craft\base\ElementInterface;

The type craft\base\ElementInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\base\Field;
use craft\console\Application as ConsoleApplication;
use craft\db\Paginator;
use craft\elements\Asset;
use craft\elements\db\ElementQuery;
use craft\helpers\App;
use craft\queue\BaseJob;
use nystudio107\imageoptimize\fields\OptimizedImages as OptimizedImagesField;
use nystudio107\imageoptimize\ImageOptimize;
use yii\base\Exception;

/**

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

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 ResaveOptimizedImages extends BaseJob
{
    // Constants
    // =========================================================================

    /**

Missing short description in doc comment

     * @const The number of assets to return in a single paginated query
     */
    protected const ASSET_QUERY_PAGE_SIZE = 100;

    // Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var ?array The element criteria that determines which elements should be resaved
     */
    public ?array $criteria = null;

    /**

Missing short description in doc comment

     * @var int|null The id of the field to resave images for, or null for all images
     */
    public ?int $fieldId = null;

    /**

Missing short description in doc comment

     * @var bool Whether image variants should be forced to recreated, even if they already exist on disk

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

     * @since 1.6.18
     */
    public bool $force = false;

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

    /**

Missing short description in doc comment

Parameter $queue should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function execute($queue): void
    {
        // Let's save ourselves some trouble and just clear all the caches for this element class
        Craft::$app->getElements()->invalidateCachesForElementType(Asset::class);

        // Now find the affected element IDs
        /** @var ElementQuery $query */

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

        $query = Asset::find();
        if (!empty($this->criteria)) {
            Craft::configure($query, $this->criteria);
        }
        if (Craft::$app instanceof ConsoleApplication) {
            echo $this->description . PHP_EOL;
        }
        // Use craft\db\Paginator to paginate the results so we don't exceed any memory limits
        // See batch() and each() discussion here: https://github.com/yiisoft/yii2/issues/8420
        // and here: https://github.com/craftcms/cms/issues/7338
        $paginator = new Paginator($query, [

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

            'pageSize' => self::ASSET_QUERY_PAGE_SIZE,
        ]);

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

        $currentElement = 0;
        $totalElements = $paginator->getTotalResults();
        // Iterate through the paginated results
        while ($currentElement < $totalElements) {
            $elements = $paginator->getPageResults();
            if (Craft::$app instanceof ConsoleApplication) {
                echo 'Query ' . $paginator->getCurrentPage() . '/' . $paginator->getTotalPages()
                    . ' - assets: ' . $paginator->getTotalResults()
                    . PHP_EOL;
            }
            /** @var ElementInterface $element */

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

            foreach ($elements as $element) {
                $currentElement++;
                // Find each OptimizedImages field and process it
                $layout = $element->getFieldLayout();
                if ($layout !== null) {
                    $fields = $layout->getCustomFields();
                    /** @var Field $field */

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

                    foreach ($fields as $field) {
                        if ($field instanceof OptimizedImagesField && $element instanceof Asset) {
                            if ($this->fieldId === null || (int)$field->id === (int)$this->fieldId) {
                                if (Craft::$app instanceof ConsoleApplication) {
                                    echo $currentElement . '/' . $totalElements
                                        . ' - processing asset: ' . $element->title
                                        . ' from field: ' . $field->name . PHP_EOL;
                                }
                                try {
                                    ImageOptimize::$plugin->optimizedImages->updateOptimizedImageFieldData($field, $element, $this->force);
                                } catch (Exception $e) {
                                    Craft::error($e->getMessage(), __METHOD__);
                                    if (Craft::$app instanceof ConsoleApplication) {
                                        echo '[error]: '
                                            . $e->getMessage()
                                            . ' while processing '
                                            . $currentElement . '/' . $totalElements
                                            . ' - processing asset: ' . $element->title
                                            . ' from field: ' . $field->name . PHP_EOL;
                                    }
                                }
                            }
                        }
                    }
                }
                $this->setProgress($queue, $currentElement / $totalElements);
            }
            $paginator->currentPage++;
        }
    }

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function defaultDescription(): ?string
    {
        return Craft::t('app', 'Resaving {class} elements', [

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

            'class' => App::humanizeClass(Asset::class),
        ]);

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

    }
}