nystudio107\imageoptimize\models\BaseTag

Complexity

Total Complexity

4

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	render()	0	3	1
A	__toString()	0	3	1
A	filterEmptyAttributes()	0	4	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\base\Model;
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

abstract class BaseTag extends Model implements TagInterface
{
    use TagTrait;

    /**
     * Attributes that are allowed to be an empty string
     */
    protected const ALLOWED_EMPTY_ATTRS = ['alt'];

    /**

Missing short description in doc comment

     * @return string
     */
    public function __toString(): string
    {
        return $this->render();
    }

    /**
     * Render the tag
     *
     * @return Markup
     */
    public function render(): Markup
    {
        return Template::raw('');
    }

    /**
     * Filter out attributes with empty values in them, so they don't get rendered
     *
     * @param array $attrs

Missing parameter comment

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

     * @return array

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

     */
    public function filterEmptyAttributes(array $attrs): array
    {
        // Keep certain attributes even if they are empty
        return array_filter($attrs, static fn($value, $key) => in_array($key, self::ALLOWED_EMPTY_ATTRS, true) || !empty($value), ARRAY_FILTER_USE_BOTH);
    }
}