0 follower

Final Class Yiisoft\Html\Tag\Source

All Classes | Properties | Methods

Inheritance	Yiisoft\Html\Tag\Source » Yiisoft\Html\Tag\Base\VoidTag » Yiisoft\Html\Tag\Base\Tag
Implements	Yiisoft\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
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\Source
id()	Set tag ID.	Yiisoft\Html\Tag\Base\Tag
media()		Yiisoft\Html\Tag\Source
removeStyle()	Remove CSS styles from the tag.	Yiisoft\Html\Tag\Base\Tag
render()		Yiisoft\Html\Tag\Base\Tag
sizes()		Yiisoft\Html\Tag\Source
src()		Yiisoft\Html\Tag\Source
srcset()		Yiisoft\Html\Tag\Source
tag()		Yiisoft\Html\Tag\Base\VoidTag
type()		Yiisoft\Html\Tag\Source
unionAttributes()	Union attributes with a new set.	Yiisoft\Html\Tag\Base\Tag
width()		Yiisoft\Html\Tag\Source

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\Source
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

Source code

                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\Source
$attributes	array	Name-value set of attributes.

Source code

                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\Source
$class	\BackedEnum\|string\|null	One or many CSS classes.

Source code

                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.

public addStyle( string\|string[] $style, boolean $overwrite = true ): Yiisoft\Html\Tag\Source
$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.

Source code

                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

Source code

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

attribute() public method

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

Set attribute value.

public attribute( string $name, mixed $value ): Yiisoft\Html\Tag\Source
$name	string	Name of the attribute.
$value	mixed	Value of the attribute.

Source code

                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\Source
$attributes	array	Name-value set of attributes.

Source code

                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

Source code

                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\Source
$class	\BackedEnum\|string\|null	One or many CSS classes.

Source code

                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

Source code

                protected function getName(): string
{
    return 'source';
}

height() public method

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

Source code

                public function height(int|string|null $height): self
{
    return $this->attribute('height', $height);
}

id() public method

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

Set tag ID.

public id( string\|null $id ): Yiisoft\Html\Tag\Source
$id	string\|null	Tag ID.

Source code

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

media() public method

public media( string\|null $media ): self
$media	string\|null

Source code

                public function media(?string $media): self
{
    return $this->attribute('media', $media);
}

prepareAttributes() protected method

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

protected prepareAttributes( ): void

Source code

                protected function prepareAttributes(): void {}

removeStyle() public method

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

Remove CSS styles from the tag.

public removeStyle( string\|string[] $properties ): Yiisoft\Html\Tag\Source
$properties	string\|string[]	The CSS properties to be removed. You may use a string if you are removing a single property.

Source code

                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

Source code

                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.

protected renderAttributes( ): string

Source code

                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

Source code

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

sizes() public method

public sizes( string\|null $sizes ): self
$sizes	string\|null

Source code

                public function sizes(?string ...$sizes): self
{
    $items = array_diff($sizes, [null]);
    return $this->attribute('sizes', $items ? implode(',', $items) : null);
}

src() public method

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

Source code

                public function src(?string $src): self
{
    return $this->attribute('src', $src);
}

srcset() public method

public srcset( string\|null $srcsets ): self
$srcsets	string\|null

Source code

                public function srcset(?string ...$srcsets): self
{
    $items = array_diff($srcsets, [null]);
    return $this->attribute('srcset', $items ? implode(',', $items) : null);
}

tag() public static method

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

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

Source code

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

type() public method

public type( string\|null $type ): self
$type	string\|null

Source code

                public function type(?string $type): self
{
    return $this->attribute('type', $type);
}

unionAttributes() public method

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

Union attributes with a new set.

public unionAttributes( array $attributes ): Yiisoft\Html\Tag\Source
$attributes	array	Name-value set of attributes.

Source code

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

width() public method

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

Source code

                public function width(int|string|null $width): self
{
    return $this->attribute('width', $width);
}