nystudio107\imageoptimize\utilities\ImageOptimizeUtility

Complexity

Total Complexity

5

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	iconPath()	0	3	1
A	displayName()	0	3	1
A	id()	0	3	1
A	badgeCount()	0	3	1
A	contentHtml()	0	9	1

<?php
/**
 * ImageOptimize 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) 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 nystudio107\imageoptimize\ImageOptimize;
use nystudio107\imageoptimize\assetbundles\imageoptimizeutility\ImageOptimizeUtilityAsset;

use Craft;
use craft\base\Utility;

/**
 * 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', 'ImageOptimizeUtility');
    }

    /**

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()
    {
        return Craft::getAlias("@nystudio107/imageoptimize/assetbundles/imageoptimizeutility/dist/img/ImageOptimizeUtility-icon.svg");

The expression return Craft::getAlias('@nystudio107/imageoptimize/assetbundles/imageoptimizeutility/dist/img/ImageOptimizeUtility-icon.svg') also could return the type boolean which is incompatible with the return type mandated by craft\base\UtilityInterface::iconPath() of null|string.

    }

    /**

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
    {
        Craft::$app->getView()->registerAssetBundle(ImageOptimizeUtilityAsset::class);

        $someVar = 'Have a nice day!';
        return Craft::$app->getView()->renderTemplate(
            'image-optimize/_components/utilities/ImageOptimizeUtility_content',
            [
                'someVar' => $someVar
            ]
        );
    }
}