nystudio107\imageoptimize\models\ImgTag

Complexity

Total Complexity

8

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	19	3
A	placeholder()	0	5	1
A	imgAttrs()	0	5	1
A	loadingStrategy()	0	5	1
A	render()	0	13	2

<?php
/**
 * Image Optimize 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) 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\models;

use craft\helpers\Html;
use craft\helpers\Template;
use Twig\Markup;

/**

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     5.0.0-beta.1

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 ImgTag extends BaseImageTag
{
    /**

Missing short description in doc comment

     * @var string The loading scheme to use: 'eager', 'lazy', 'lazySizes', 'lazySizesFallback'
     */
    public string $loadingStrategy = 'eager';

    /**

Missing short description in doc comment

     * @var string The type of placeholder image to use: 'box', 'color', 'image', 'silhouette', or 'none'
     */
    public string $placeholder = 'box';

    /**

Missing short description in doc comment

     * @var array array of tag attributes for the <img> tag
     */
    public array $imgAttrs = [];

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
        // Populate the $imageAttrs
        $this->imgAttrs = [
            'class' => '',
            'style' => '',
            'width' => $this->optimizedImage->placeholderWidth,
            'height' => $this->optimizedImage->placeholderHeight,
            'src' => reset($this->optimizedImage->optimizedImageUrls),

It seems like $this->optimizedImage->optimizedImageUrls can also be of type null; however, parameter $array of reset() does only seem to accept array|object, maybe add an additional type check?

            'srcset' => $this->optimizedImage->getSrcsetFromArray($this->optimizedImage->optimizedImageUrls),

The method getSrcsetFromArray() does not exist on null.

            'sizes' => '100vw',
            'loading' => '',
        ];
        // If the original image is an SVG or gif, don't add the placeholder box CSS so that transparency works as intended
        $path = parse_url($this->imgAttrs['src'], PHP_URL_PATH);
        $extension = pathinfo($path, PATHINFO_EXTENSION);
        if ($extension === 'svg' || $extension === 'gif') {
            $this->placeholder = 'none';
        }
    }

    /**
     * Set the $loading property
     *
     * @param string $value

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function loadingStrategy(string $value): ImgTag
    {
        $this->loadingStrategy = $value;

        return $this;
    }

    /**
     * Set the $placeholder property
     *
     * @param string $value

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function placeholder(string $value): ImgTag
    {
        $this->placeholder = $value;

        return $this;
    }

    /**
     * Merge the passed array of tag attributes into $imgAttrs
     *
     * @param array $value

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function imgAttrs(array $value): ImgTag
    {
        $this->imgAttrs = array_merge($this->imgAttrs, $value);

        return $this;
    }

    /**
     * Generate a complete <img> tag for the $optimizedImage OptimizedImage model
     *
     * @return Markup
     */
    public function render(): Markup
    {
        $attrs = $this->imgAttrs;
        // Handle lazy loading
        if ($this->loadingStrategy !== 'eager') {
            $attrs = $this->swapLazyLoadAttrs($this->loadingStrategy, $this->placeholder, $attrs);
        }
        // Remove any empty attributes
        $attrs = $this->filterEmptyAttributes($attrs);
        // Render the tag
        $tag = Html::tag('img', '', $attrs);

        return Template::raw($tag);
    }
}