0 follower

Final Class Yiisoft\Html\Tag\Img

All Classes | Properties | Methods
InheritanceYiisoft\Html\Tag\Img » Yiisoft\Html\Tag\Base\VoidTag » Yiisoft\Html\Tag\Base\Tag
ImplementsYiisoft\Html\NoEncodeStringableInterface

Protected Properties

Hide inherited properties

Property Type Description Defined By
$attributes array Yiisoft\Html\Tag\Base\Tag

Public Methods

Hide inherited methods

Method Description Defined By
__toString() Yiisoft\Html\Tag\Base\Tag
addAttributes() Add a set of attributes to existing tag attributes. Yiisoft\Html\Tag\Base\Tag
addClass() Add one or more CSS classes to the tag. Yiisoft\Html\Tag\Base\Tag
addStyle() Add CSS styles to the tag. Yiisoft\Html\Tag\Base\Tag
alt() Yiisoft\Html\Tag\Img
attribute() Set attribute value. Yiisoft\Html\Tag\Base\Tag
attributes() Replace attributes with a new set. Yiisoft\Html\Tag\Base\Tag
class() Replace current tag CSS classes with a new set of classes. Yiisoft\Html\Tag\Base\Tag
height() Yiisoft\Html\Tag\Img
id() Set tag ID. Yiisoft\Html\Tag\Base\Tag
loading() Yiisoft\Html\Tag\Img
removeStyle() Remove CSS styles from the tag. Yiisoft\Html\Tag\Base\Tag
render() Yiisoft\Html\Tag\Base\Tag
size() Yiisoft\Html\Tag\Img
src() Yiisoft\Html\Tag\Img
srcset() Yiisoft\Html\Tag\Img
srcsetData() Yiisoft\Html\Tag\Img
tag() Yiisoft\Html\Tag\Base\VoidTag
unionAttributes() Union attributes with a new set. Yiisoft\Html\Tag\Base\Tag
url() Yiisoft\Html\Tag\Img
width() Yiisoft\Html\Tag\Img

Protected Methods

Hide inherited methods

Method Description Defined By
after() Yiisoft\Html\Tag\Base\Tag
before() Yiisoft\Html\Tag\Base\Tag
getName() Yiisoft\Html\Tag\Img
prepareAttributes() Yiisoft\Html\Tag\Base\Tag
renderAttributes() Render the current tag attributes. Yiisoft\Html\Tag\Base\Tag
renderTag() Yiisoft\Html\Tag\Base\VoidTag

Method Details

Hide inherited methods

__toString() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::__toString()

public __toString( ): string

                final public function __toString(): string
{
    return $this->render();
}
addAttributes() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::addAttributes()

Add a set of attributes to existing tag attributes.

Same named attributes are replaced.

public addAttributes( array $attributes ): Yiisoft\Html\Tag\Img
$attributes array

Name-value set of attributes.

 

                final public function addAttributes(array $attributes): static
{
    $new = clone $this;
    $new->attributes = array_merge($new->attributes, $attributes);
    return $new;
}
addClass() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::addClass()

Add one or more CSS classes to the tag.

public addClass( \BackedEnum|string|null $class ): Yiisoft\Html\Tag\Img
$class \BackedEnum|string|null

One or many CSS classes.

 

                final public function addClass(BackedEnum|string|null ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->attributes, $class);
    return $new;
}
addStyle() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::addStyle()

Add CSS styles to the tag.

See also Yiisoft\Html\Html::addCssStyle().

public addStyle( string|string[] $style, boolean $overwrite = true ): Yiisoft\Html\Tag\Img
$style string|string[]

The new style string (e.g. 'width: 100px; height: 200px') or array (e.g. ['width' => '100px', 'height' => '200px']).
$overwrite boolean

Whether to overwrite existing CSS properties if the new style contain them too.

 

                final public function addStyle(array|string $style, bool $overwrite = true): static
{
    $new = clone $this;
    Html::addCssStyle($new->attributes, $style, $overwrite);
    return $new;
}
after() protected method

Defined in: Yiisoft\Html\Tag\Base\Tag::after()

protected after( ): string

                protected function after(): string
{
    return '';
}
alt() public method

public alt( string|null $text ): self
$text string|null 

                public function alt(?string $text): self
{
    $new = clone $this;
    $new->attributes['alt'] = $text;
    return $new;
}
attribute() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::attribute()

Set attribute value.

public attribute( string $name, mixed $value ): Yiisoft\Html\Tag\Img
$name string

Name of the attribute.
$value mixed

Value of the attribute.

 

                final public function attribute(string $name, mixed $value): static
{
    $new = clone $this;
    $new->attributes[$name] = $value;
    return $new;
}
attributes() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::attributes()

Replace attributes with a new set.

public attributes( array $attributes ): Yiisoft\Html\Tag\Img
$attributes array

Name-value set of attributes.

 

                final public function attributes(array $attributes): static
{
    $new = clone $this;
    $new->attributes = $attributes;
    return $new;
}
before() protected method

Defined in: Yiisoft\Html\Tag\Base\Tag::before()

protected before( ): string

                protected function before(): string
{
    return '';
}
class() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::class()

Replace current tag CSS classes with a new set of classes.

public class( \BackedEnum|string|null $class ): Yiisoft\Html\Tag\Img
$class \BackedEnum|string|null

One or many CSS classes.

 

                final public function class(BackedEnum|string|null ...$class): static
{
    $new = clone $this;
    unset($new->attributes['class']);
    Html::addCssClass($new->attributes, $class);
    return $new;
}
getName() protected method

protected getName( ): string

                protected function getName(): string
{
    return 'img';
}
height() public method

public height( integer|string|null $height ): self
$height integer|string|null 

                public function height(int|string|null $height): self
{
    $new = clone $this;
    $new->attributes['height'] = $height;
    return $new;
}
id() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::id()

Set tag ID.

public id( string|null $id ): Yiisoft\Html\Tag\Img
$id string|null

Tag ID.

 

                final public function id(?string $id): static
{
    $new = clone $this;
    $new->attributes['id'] = $id;
    return $new;
}
loading() public method

public loading( string|null $loading ): self
$loading string|null 

                public function loading(?string $loading): self
{
    $new = clone $this;
    $new->attributes['loading'] = $loading;
    return $new;
}
prepareAttributes() protected method

Defined in: Yiisoft\Html\Tag\Base\Tag::prepareAttributes()

protected prepareAttributes( ): void

                protected function prepareAttributes(): void {}
removeStyle() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::removeStyle()

Remove CSS styles from the tag.

See also Yiisoft\Html\Html::removeCssStyle().

public removeStyle( string|string[] $properties ): Yiisoft\Html\Tag\Img
$properties string|string[]

The CSS properties to be removed. You may use a string if you are removing a single property.

 

                final public function removeStyle(string|array $properties): static
{
    $new = clone $this;
    Html::removeCssStyle($new->attributes, $properties);
    return $new;
}
render() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::render()

public render( ): string

                final public function render(): string
{
    return $this->before() . $this->renderTag() . $this->after();
}
renderAttributes() protected method

Defined in: Yiisoft\Html\Tag\Base\Tag::renderAttributes()

Render the current tag attributes.

See also Yiisoft\Html\Html::renderTagAttributes().

protected renderAttributes( ): string

                final protected function renderAttributes(): string
{
    $this->prepareAttributes();
    return Html::renderTagAttributes($this->attributes);
}
renderTag() protected method

Defined in: Yiisoft\Html\Tag\Base\VoidTag::renderTag()

protected renderTag( ): string

                final protected function renderTag(): string
{
    return '<' . $this->getName() . $this->renderAttributes() . '>';
}
size() public method

public size( integer|string|null $width, integer|string|null $height ): self
$width integer|string|null
$height integer|string|null 

                public function size(int|string|null $width, int|string|null $height): self
{
    $new = clone $this;
    $new->attributes['width'] = $width;
    $new->attributes['height'] = $height;
    return $new;
}
src() public method

public src( string|null $url ): self
$url string|null 

                public function src(?string $url): self
{
    $new = clone $this;
    $new->attributes['src'] = $url;
    return $new;
}
srcset() public method

public srcset( string|null $items ): self
$items string|null 

                public function srcset(?string ...$items): self
{
    $items = array_filter($items, static fn($item) => $item !== null);
    $new = clone $this;
    $new->attributes['srcset'] = $items ? implode(',', $items) : null;
    return $new;
}
srcsetData() public method

public srcsetData( array<string, string> $data ): self
$data array<string, string> 

                public function srcsetData(array $data): self
{
    $new = clone $this;
    $items = [];
    foreach ($data as $descriptor => $url) {
        $items[] = $url . ' ' . $descriptor;
    }
    $new->attributes['srcset'] = $items ? implode(',', $items) : null;
    return $new;
}
tag() public static method

Defined in: Yiisoft\Html\Tag\Base\VoidTag::tag()

public static tag( ): Yiisoft\Html\Tag\Img

                final public static function tag(): static
{
    return new static();
}
unionAttributes() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::unionAttributes()

Union attributes with a new set.

public unionAttributes( array $attributes ): Yiisoft\Html\Tag\Img
$attributes array

Name-value set of attributes.

 

                final public function unionAttributes(array $attributes): static
{
    $new = clone $this;
    $new->attributes += $attributes;
    return $new;
}
url() public method

public url( string|null $url ): self
$url string|null 

                public function url(?string $url): self
{
    return $this->src($url);
}
width() public method

public width( integer|string|null $width ): self
$width integer|string|null 

                public function width(int|string|null $width): self
{
    $new = clone $this;
    $new->attributes['width'] = $width;
    return $new;
}