nystudio107 / craft-imageoptimize

src/console/controllers/OptimizeController.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) 2018 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\console\controllers;

use Craft;
use craft\base\Field;
use craft\helpers\App;
use craft\queue\QueueInterface;
use nystudio107\imageoptimize\ImageOptimize;
use yii\base\InvalidConfigException;
use yii\console\Controller;
use yii\queue\redis\Queue as RedisQueue;

/**
 * Optimize Command
 *
 * @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.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 OptimizeController extends Controller
{
    // Public Properties
    // =========================================================================

    /**

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;

    /**

Missing short description in doc comment

     * @var string|null Only re-save image variants associated with this field handle

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

     * @since 1.6.18
     */
    public ?string $field = null;

    /**

Missing short description in doc comment

     * @var bool Should the image generation simply be queued, rather than run immediately?
     */
    public bool $queue = false;

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

    /**

Missing short description in doc comment

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

     * @inheritDoc
     */

Missing @return tag in function comment

    public function options($actionID): array
    {
        $options = parent::options($actionID);
        return array_merge($options, [

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

            'force',
            'field',
            'queue',
        ]);

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

    }

    /**
     * Create all the OptimizedImages Field variants by creating all the responsive image variant transforms
     *
     * @param ?string $volumeHandle

Missing parameter comment

     *
     * @throws InvalidConfigException
     */

Missing @return tag in function comment

    public function actionCreate(?string $volumeHandle = null): void
    {
        echo 'Creating optimized image variants' . PHP_EOL;
        if ($this->force) {
            echo 'Forcing optimized image variants creation via --force' . PHP_EOL;
        }

        $fieldId = null;
        if ($this->field !== null) {
            /** @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

            $field = Craft::$app->getFields()->getFieldByHandle($this->field);
            $fieldId = $field?->id;
        }
        if ($volumeHandle === null) {
            // Re-save all the optimized image variants in all volumes
            ImageOptimize::$plugin->optimizedImages->resaveAllVolumesAssets($fieldId, $this->force);
        } else {
            // Re-save all the optimized image variants in a specific volume
            $volumes = Craft::$app->getVolumes();
            $volume = $volumes->getVolumeByHandle($volumeHandle);
            if ($volume) {
                ImageOptimize::$plugin->optimizedImages->resaveVolumeAssets($volume, $fieldId, $this->force);
            } else {
                echo 'Unknown Asset Volume handle: ' . $volumeHandle . PHP_EOL;
            }
        }
        if (!$this->queue) {
            $this->runCraftQueue();
        }
    }

    /**
     * Create a single OptimizedImage for the passed in Asset ID
     *
     * @param ?int $id

Missing parameter comment

     */

Missing @return tag in function comment

    public function actionCreateAsset(?int $id = null): void
    {
        echo 'Creating optimized image variants' . PHP_EOL;

        if ($id === null) {
            echo 'No Asset ID specified' . PHP_EOL;
        } else {
            // Re-save a single Asset ID
            ImageOptimize::$plugin->optimizedImages->resaveAsset($id, $this->force);
        }
        if (!$this->queue) {
            $this->runCraftQueue();
        }
    }

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    private function runCraftQueue(): void

Private method name "OptimizeController::runCraftQueue" must be prefixed with an underscore

    {
        // This might take a while
        App::maxPowerCaptain();
        $queue = Craft::$app->getQueue();
        if ($queue instanceof QueueInterface) {
            $queue->run();
        } elseif ($queue instanceof RedisQueue) {
            $queue->run(false);
        }
    }
}