nystudio107 / craft-imageoptimize

src/utilities/ImageOptimizeUtility.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) 2020 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\utilities;

use Craft;

use craft\base\Utility;
use nystudio107\imageoptimize\ImageOptimize;

/**
 * ImageOptimize Utility
 *
 * @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.0.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 ImageOptimizeUtility extends Utility
{
    // Static
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function displayName(): string
    {
        return Craft::t('image-optimize', 'ImageOptimize Info');
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function id(): string
    {
        return 'imageoptimize-image-optimize-utility';
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function iconPath(): ?string
    {
        return Craft::getAlias("@nystudio107/imageoptimize/icon-mask.svg");

The expression return Craft::getAlias('@nystudio107/imageoptimize/icon-mask.svg') could return the type false which is incompatible with the type-hinted return null|string. Consider adding an additional type-check to rule them out.

    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function badgeCount(): int
    {
        return 0;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function contentHtml(): string
    {
        $imageProcessors = ImageOptimize::$plugin->optimize->getActiveImageProcessors();
        $variantCreators = ImageOptimize::$plugin->optimize->getActiveVariantCreators();

        return Craft::$app->getView()->renderTemplate(
            'image-optimize/_components/utilities/ImageOptimizeUtility_content',
            [
                'imageProcessors' => $imageProcessors,
                'variantCreators' => $variantCreators,
            ]
        );
    }
}