PictureTag::loadingStrategy() - Code Metrics - nystudio107/craft-imageoptimize - Measure and Improve Code Quality continuously with Scrutinizer

PictureTag::loadingStrategy() A
last analyzed 2025-02-13 20:54 UTC

↳ Parent: PictureTag
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	2
c	1
b	0
f	0
dl	0
loc	5
rs	10
cc	1
nc	1
nop	1
<?php
/**
 * Image Optimize plugin for Craft CMS
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com

 * @copyright Copyright (c) nystudio107

 */


namespace nystudio107\imageoptimize\models;

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

/**

 * @author    nystudio107

 * @package   ImageOptimize

 * @since     5.0.0-beta.1

 */

class PictureTag extends BaseImageTag
{
    /**

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

    /**

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

    /**

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

    /**

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

    /**

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

    /**

     * @inheritDoc
     */

    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),
            'src' => reset(/** @scrutinizer ignore-type */ $this->optimizedImage->optimizedImageUrls),
            'loading' => '',
        ];
        // Populate the $sourceAttrs
        $this->populateSourceAttrs($this->optimizedImage, []);
        $this->populateSourceAttrs(/** @scrutinizer ignore-type */ $this->optimizedImage, []);
        // Populate the $pictureAttrs
        $this->pictureAttrs = [];
        // 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

     * @return $this

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

        return $this;
    }

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

     * @return $this

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

        return $this;
    }

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

     * @return $this

     */
    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

     * @return $this

     */
    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

     * @return $this

     */
    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

     * @param array $sourceAttrs

     * @return PictureTag

     */
    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 = $this->filterEmptyAttributes($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

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

     * @return void

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

                'media' => '',
                'srcset' => $optimizedImage->getSrcsetFromArray($optimizedImage->optimizedWebPImageUrls),
                'type' => 'image/webp',
                'sizes' => '100vw',
                'width' => $optimizedImage->placeholderWidth,
                'height' => $optimizedImage->placeholderHeight,
            ], $sourceAttrs);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        }
        $this->sourceAttrs[] = array_merge([

            'media' => '',
            'srcset' => $optimizedImage->getSrcsetFromArray($optimizedImage->optimizedImageUrls),
            'srcset' => $optimizedImage->getSrcsetFromArray(/** @scrutinizer ignore-type */ $optimizedImage->optimizedImageUrls),
            'sizes' => '100vw',
            'width' => $optimizedImage->placeholderWidth,
            'height' => $optimizedImage->placeholderHeight,
        ], $sourceAttrs);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }
}

nystudio107 / craft-imageoptimize

PictureTag::loadingStrategy() A last analyzed 2025-02-13 20:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PictureTag::loadingStrategy() A
last analyzed 2025-02-13 20:54 UTC
