nystudio107 / craft-imageoptimize

src/imagetransforms/CraftImageTransform.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) 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 Craft;
use craft\elements\Asset;
use craft\models\ImageTransform as CraftImageTransformModel;
use nystudio107\imageoptimize\ImageOptimize;
use nystudio107\imageoptimize\models\Settings;

/**

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

     * @var bool
     */
    public bool $generateTransformsBeforePageLoad;

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

    /**

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 Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        /** @var Settings $settings */

Missing short description in doc comment

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

        $settings = ImageOptimize::$plugin->getSettings();

The method getSettings() does not exist on null.

        // 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, CraftImageTransformModel|string|array|null $transform): ?string
    {
        // Generate the URLs to the optimized images
        $oldValue = Craft::$app->getConfig()->getGeneral()->generateTransformsBeforePageLoad;

        if ($this->generateTransformsBeforePageLoad) {
            Craft::$app->getConfig()->getGeneral()->generateTransformsBeforePageLoad = true;
        }
        $url = $asset->getUrl($transform);
        Craft::$app->getConfig()->getGeneral()->generateTransformsBeforePageLoad = $oldValue;

        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, CraftImageTransformModel|string|array|null $transform): ?string
    {
        return $this->appendExtension($url, '.webp');
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getSettingsHtml(): ?string
    {
        $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(): array
    {
        return [];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        $rules = parent::rules();
        return 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.

    }
}