nystudio107\imageoptimize\models\BaseImageTag

Complexity

Total Complexity

15

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Importance

Changes	3
Bugs	2	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
F	swapLazyLoadAttrs()	0	51	14
A	getLazyLoadSrc()	0	8	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;

/**

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

abstract class BaseImageTag extends BaseTag
{
    /**
     * Swap the tag attributes to work with lazy loading
     * ref: https://web.dev/native-lazy-loading/#how-do-i-handle-browsers-that-don't-yet-support-native-lazy-loading
     *
     * @param string $loading 'eager', 'lazy', 'lazySizes', 'lazySizesFallback'

Expected 5 spaces after parameter name; 1 found

     * @param string $placeHolder 'box', 'color', 'image', 'silhouette'
     * @param array $attrs

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     *
     * @return array
     */
    protected function swapLazyLoadAttrs(string $loading, string $placeHolder, array $attrs): array
    {
        // Set the class and loading attributes
        if (isset($attrs['class'])) {
            $attrs['class'] = trim($attrs['class'] . ' lazyload');
        }
        // Set the style on this element to be the placeholder image as the background-image
        if (isset($attrs['style']) && !empty($attrs['src'])) {
            if (empty($attrs['style'])) {
                $attrs['style'] = [];
            }
            // Don't add the background placeholder if it is set to 'none'
            if ($placeHolder !== 'none') {
                $attrs['style']['background-image'] = 'url(' . $this->getLazyLoadSrc($placeHolder) . ')';
                $attrs['style']['background-size'] = 'cover';
            }
        }
        // Handle attributes that lazy  and lazySizesFallback have in common
        switch ($loading) {
            case 'lazy':

Line indented incorrectly; expected 8 spaces, found 12

            case 'lazySizesFallback':

Line indented incorrectly; expected 8 spaces, found 12

                if (isset($attrs['loading'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $attrs['loading'] = 'lazy';
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;
            default:

Line indented incorrectly; expected 8 spaces, found 12

                break;
        }
        // Handle attributes that lazySizes and lazySizesFallback have in common
        switch ($loading) {
            case 'lazySizes':

Line indented incorrectly; expected 8 spaces, found 12

            case 'lazySizesFallback':

Line indented incorrectly; expected 8 spaces, found 12

                // Only swap to data- attributes if they want the LazySizes fallback
                if (!empty($attrs['sizes'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $attrs['data-sizes'] = $attrs['sizes'];
                    $attrs['sizes'] = '';
                }

Line indented incorrectly; expected 12 spaces, found 16

                if (!empty($attrs['srcset'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $attrs['data-srcset'] = $attrs['srcset'];
                    $attrs['srcset'] = '';
                }

Line indented incorrectly; expected 12 spaces, found 16

                if (!empty($attrs['src'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $attrs['data-src'] = $attrs['src'];
                    $attrs['src'] = $this->getLazyLoadSrc($placeHolder);
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;
            default:

Line indented incorrectly; expected 8 spaces, found 12

                break;
        }

        return $attrs;
    }

    /**
     * Return a lazy loading placeholder image based on the passed in $lazyload setting
     *
     * @param string $lazyLoad

Missing parameter comment

     *
     * @return string
     */
    protected function getLazyLoadSrc(string $lazyLoad): string
    {
        $lazyLoad = strtolower($lazyLoad);
        return match ($lazyLoad) {
            'image' => $this->optimizedImage->getPlaceholderImage(),

The method getPlaceholderImage() does not exist on null.

            'silhouette' => $this->optimizedImage->getPlaceholderSilhouette(),
            'color' => $this->optimizedImage->getPlaceholderBox($this->colorPalette[0] ?? null),

The property colorPalette does not exist on nystudio107\imageoptimize\models\BaseImageTag. Since you implemented __get, consider adding a @property annotation.

            default => $this->optimizedImage->getPlaceholderBox('#CCC'),
        };
    }
}