nystudio107\imageoptimize\imagetransforms\CraftImageTransform

Complexity

Total Complexity

7

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	displayName()	0	3	1
A	init()	0	5	1
A	getSettingsHtml()	0	9	1
A	rules()	0	7	1
A	getTransformUrl()	0	7	1
A	getWebPUrl()	0	5	1
A	fields()	0	3	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) 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\imagetransforms;

use nystudio107\imageoptimize\ImageOptimize;

use Craft;
use craft\elements\Asset;
use craft\models\AssetTransform;

/**

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.6.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 CraftImageTransform extends ImageTransform
{
    // Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

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

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var bool
     */
    public $generateTransformsBeforePageLoad;

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function init()
    {
        $settings = ImageOptimize::$plugin->getSettings();
        // Get our $generateTransformsBeforePageLoad setting
        $this->generateTransformsBeforePageLoad = $settings->generateTransformsBeforePageLoad ?? true;
    }

    /**

Missing short description in doc comment

Parameter $asset should have a doc-comment as per coding-style.

Parameter $transform should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function getTransformUrl(Asset $asset, $transform)
    {
        // Generate the URLs to the optimized images
        $assets = Craft::$app->getAssets();
        $url = $assets->getAssetUrl($asset, $transform, $this->generateTransformsBeforePageLoad);

        return $url;
    }

    /**

Missing short description in doc comment

Parameter $url should have a doc-comment as per coding-style.

Parameter $asset should have a doc-comment as per coding-style.

Parameter $transform should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function getWebPUrl(string $url, Asset $asset, $transform): string
    {
        $url = $this->appendExtension($url, '.webp');

        return $url;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

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

        return Craft::$app->getView()->renderTemplate('craft-image-transform/settings/image-transforms/craft.twig', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            'imageTransform' => $this,
            'imageProcessors' => $imageProcessors,
            'variantCreators' => $variantCreators,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * No savable fields for this component
     *
     * @return array
     */
    public function fields()
    {
        return [];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules()
    {
        $rules = parent::rules();
        $rules = array_merge($rules, [

The opening parenthesis of a multi-line function call should be the last content on the line.

        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        return $rules;
    }
}