nystudio107 / craft-imageoptimize

src/helpers/PluginTemplate.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) 2021 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\helpers;

use Craft;
use craft\helpers\Template;
use craft\web\View;
use nystudio107\minify\Minify;
use yii\base\Exception;

/**

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.7.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 PluginTemplate
{
    // Constants
    // =========================================================================

    public const MINIFY_PLUGIN_HANDLE = 'minify';

    // Static Methods
    // =========================================================================

    public static function renderStringTemplate(string $templateString, array $params = []): string

You must use "/**" style comments for a function comment

    {
        try {
            $html = Craft::$app->getView()->renderString($templateString, $params);
        } catch (\Exception $e) {
            $html = Craft::t(
                'image-optimize',
                'Error rendering template string -> {error}',
                ['error' => $e->getMessage()]
            );
            Craft::error($html, __METHOD__);
        }

        return $html;
    }

    /**
     * Render a plugin template
     *
     * @param string $templatePath

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

     * @param array $params

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param string|null $minifier

Missing parameter comment

     *
     * @return string
     */
    public static function renderPluginTemplate(
        string $templatePath,
        array  $params = [],
        string $minifier = null,
    ): string {
        $template = 'image-optimize/' . $templatePath;
        $oldMode = Craft::$app->view->getTemplateMode();
        // Look for the template on the frontend first
        try {
            $templateMode = View::TEMPLATE_MODE_CP;
            if (Craft::$app->view->doesTemplateExist($template, View::TEMPLATE_MODE_SITE)) {
                $templateMode = View::TEMPLATE_MODE_SITE;
            }
            Craft::$app->view->setTemplateMode($templateMode);
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        // Render the template with our vars passed in
        try {
            $htmlText = Craft::$app->view->renderTemplate($template, $params);
            if ($minifier) {
                // If Minify is installed, use it to minify the template
                $minify = Craft::$app->getPlugins()->getPlugin(self::MINIFY_PLUGIN_HANDLE);
                if ($minify) {
                    $htmlText = Minify::$plugin->minify->$minifier($htmlText);
                }
            }
        } catch (\Exception $e) {
            $htmlText = Craft::t(
                'image-optimize',
                'Error rendering `{template}` -> {error}',
                ['template' => $templatePath, 'error' => $e->getMessage()]
            );
            Craft::error($htmlText, __METHOD__);
        }

        // Restore the old template mode
        try {
            Craft::$app->view->setTemplateMode($oldMode);
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return Template::raw($htmlText);
    }
}