nystudio107\imageoptimize\models\PictureTag

Complexity

Total Complexity

14

Size/Duplication

Total Lines	195
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	render()	0	32	4
A	addSourceFrom()	0	5	1
A	imgAttrs()	0	5	1
A	pictureAttrs()	0	5	1
A	populateSourceAttrs()	0	19	2
A	placeholder()	0	5	1
A	sourceAttrs()	0	8	2
A	loadingStrategy()	0	5	1
A	__construct()	0	16	1

<?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 PictureTag 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'
     */
    public string $placeholder = 'box';

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var array array of tag attributes for the <source> tags
     */
    public array $sourceAttrs = [];

    /**

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

     * @param $config

Missing parameter comment

     */
    public function __construct($config = [])
    {
        parent::__construct($config);
        // 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?

            'loading' => '',
        ];
        // Populate the $sourceAttrs
        $this->populateSourceAttrs($this->optimizedImage, []);

It seems like $this->optimizedImage can also be of type null; however, parameter $optimizedImage of nystudio107\imageoptimize\models\PictureTag::populateSourceAttrs() does only seem to accept nystudio107\imageoptimize\models\OptimizedImage, maybe add an additional type check?

        // Populate the $pictureAttrs
        $this->pictureAttrs = [];
    }

    /**
     * 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): PictureTag
    {
        $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): PictureTag
    {
        $this->placeholder = $value;

        return $this;
    }

    /**
     * Merge the passed array of tag attributes into $pictureAttrs
     *
     * @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 pictureAttrs(array $value): PictureTag
    {
        $this->pictureAttrs = array_merge($this->pictureAttrs, $value);

        return $this;
    }

    /**
     * Merge the passed array of tag attributes into $sourceAttrs
     *
     * @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 sourceAttrs(array $value): PictureTag
    {
        foreach ($this->sourceAttrs as &$attrs) {
            $attrs = array_merge($attrs, $value);
        }
        unset($attrs);

        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): PictureTag
    {
        $this->imgAttrs = array_merge($this->imgAttrs, $value);

        return $this;
    }

    /**
     * Add art direction sources to the $sourceAttrs
     *
     * @param OptimizedImage $optimizedImage

Missing parameter comment

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

     * @param array $sourceAttrs

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

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

     * @return PictureTag

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

     */
    public function addSourceFrom(OptimizedImage $optimizedImage, array $sourceAttrs = []): PictureTag
    {
        $this->populateSourceAttrs($optimizedImage, $sourceAttrs);

        return $this;
    }

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

        return Template::raw($tag);
    }

    /**
     * Populate the $sourceAttrs from the passed in $optimizedImage and $sizes
     *
     * @param OptimizedImage $optimizedImage

Missing parameter comment

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

     * @param array $sourceAttrs attributes to add to the $sourceAttrs array

Expected 10 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

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

     * @return void

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

     */
    protected function populateSourceAttrs(OptimizedImage $optimizedImage, array $sourceAttrs): void
    {
        if (!empty($optimizedImage->optimizedWebPImageUrls)) {
            $this->sourceAttrs[] = array_merge([

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

                'media' => '',
                'srcset' => $optimizedImage->getSrcsetFromArray($optimizedImage->optimizedWebPImageUrls),
                'type' => 'image/webp',
                'sizes' => '100vw',
                'width' => $optimizedImage->placeholderWidth,
                'height' => $optimizedImage->placeholderHeight,
            ], $sourceAttrs);

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

        }
        $this->sourceAttrs[] = array_merge([

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

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

It seems like $optimizedImage->optimizedImageUrls can also be of type null; however, parameter $array of nystudio107\imageoptimize\models\OptimizedImage::getSrcsetFromArray() does only seem to accept array, maybe add an additional type check?

            'sizes' => '100vw',
            'width' => $optimizedImage->placeholderWidth,
            'height' => $optimizedImage->placeholderHeight,
        ], $sourceAttrs);

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

    }
}