nystudio107\imageoptimize\console\controllers\OptimizeController

Complexity

Total Complexity

12

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	actionClear()	0	19	6
A	actionCreate()	0	21	3
A	actionQueueAssets()	0	14	3

<?php
/**
 * Image Optimize plugin for Craft CMS 3.x
 *
 * 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 nystudio107\imageoptimize\ImageOptimize;

use Craft;
use craft\base\Volume;
use craft\elements\Asset;
use craft\helpers\App;
use craft\helpers\FileHelper;
use craft\utilities\ClearCaches;

use yii\console\Controller;

/**
 * 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 Methods
    // =========================================================================

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

Missing parameter comment

     *
     * @throws \yii\base\InvalidConfigException
     */

Missing @return tag in function comment

    public function actionCreate($volumeHandle = null)
    {
        echo 'Creating optimized image variants'.PHP_EOL;

        if ($volumeHandle === null) {
            // Re-save all of the optimized image variants in all volumes
            ImageOptimize::$plugin->optimizedImages->resaveAllVolumesAssets();
        } else {
            // Re-save all of the optimized image variants in a specific volume
            $volumes = Craft::$app->getVolumes();
            $volume = $volumes->getVolumeByHandle($volumeHandle);
            if ($volume) {
                /** @var Volume $volume */

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

                ImageOptimize::$plugin->optimizedImages->resaveVolumeAssets($volume);
            } else {
                echo 'Unknown Asset Volume handle: '.$volumeHandle.PHP_EOL;
            }
        }
        // This might take a while
        App::maxPowerCaptain();
        Craft::$app->getQueue()->run();
    }

    /**
     * Clear the Asset transform index cache tables, to force the re-creation of transformed images
     */

Missing @return tag in function comment

    public function actionClear()
    {
        foreach (ClearCaches::cacheOptions() as $cacheOption) {
            if ($cacheOption['key'] !== 'transform-indexes') {
                continue;
            }

            $action = $cacheOption['action'];

            if (\is_string($action)) {
                try {
                    FileHelper::clearDirectory($action);
                } catch (\Throwable $e) {
                    Craft::warning("Could not clear the directory {$action}: ".$e->getMessage(), __METHOD__);
                }
            } elseif (isset($cacheOption['params'])) {
                \call_user_func_array($action, $cacheOption['params']);
            } else {
                $action();
            }
        }
    }

    /**
     * Individually queue all assets for optimizing. We run the query
     * in small batches so we never hit a memory limit.
     *
     */

Additional blank lines found at end of doc comment

Missing @return tag in function comment

    public function actionQueueAssets()
    {
        $query = Asset::find();
        $batchSize = 100;
        $assetCount = $query->count();
        $numberOfBatches = ceil($assetCount / $batchSize);
        $query->limit($batchSize);
        $queue = Craft::$app->getQueue();

The assignment to $queue is dead and can be removed.

        for ($i = 0; $i < $numberOfBatches; ++$i) {
            $query->offset = $batchSize * $i;

            foreach ($query->all() as $asset) {
                ImageOptimize::$plugin->optimizedImages->resaveAsset($asset->id);
            }
        }
    }
}