nystudio107 / craft-minify

src/services/MinifyService.php

<?php
/**
 * Minify plugin for Craft CMS
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) nystudio107

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

 * @license   MIT License https://opensource.org/licenses/MIT
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

namespace nystudio107\minify\services;

use Craft;
use craft\base\Component;
use JSMin\JSMin;
use Minify_CSSmin;
use Minify_HTML;
use nystudio107\minify\Minify;

/**
 * Minify service
 *
 * @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   Minify

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 MinifyService extends Component
{
    private bool $shouldMinify = true;

Private member variable "shouldMinify" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        if (Minify::$plugin->getSettings()->disableTemplateMinifying) {
            $this->shouldMinify = false;
        }

        if (Craft::$app->getConfig()->getGeneral()->devMode
            && Minify::$plugin->getSettings()->disableDevModeMinifying) {

Closing parenthesis of a multi-line IF statement must be on a new line

            $this->shouldMinify = false;
        }
    }

    /**
     * Minify all the things
     *
     * @param string $htmlText

Missing parameter comment

     *
     * @return string
     */
    public function minify(string $htmlText = ""): string
    {
        if ($this->shouldMinify) {
            $options = [
                'cssMinifier' => '\Minify_CSSmin::minify',
                'jsMinifier' => '\JSMin\JSMin::minify',
            ];
            $htmlText = Minify_HTML::minify($htmlText, $options);
        }

        return $htmlText;
    }

    /**
     * Minify the passed in HTML
     *
     * @param string $htmlText

Missing parameter comment

     *
     * @return string
     */
    public function htmlMin(string $htmlText = ""): string
    {
        if ($this->shouldMinify) {
            $htmlText = Minify_HTML::minify($htmlText);
        }

        return $htmlText;
    }

    /**
     * Minify the passed in CSS
     *
     * @param string $cssText

Missing parameter comment

     *
     * @return string
     */
    public function cssMin(string $cssText = ""): string
    {
        if ($this->shouldMinify) {
            $cssText = Minify_CSSmin::minify($cssText);
        }

        return $cssText;
    }

    /**
     * Minify the passed in JS
     *
     * @param string $jsText

Missing parameter comment

     *
     * @return string
     */
    public function jsMin(string $jsText = ""): string
    {
        if ($this->shouldMinify) {
            $jsText = JSMin::minify($jsText);
        }

        return $jsText;
    }
}