Final Class Yiisoft\Html\Tag\Audio
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attributes | array | Yiisoft\ |
Public Methods
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| after() | Yiisoft\ |
|
| before() | Yiisoft\ |
|
| generateContent() | Yiisoft\ |
|
| getName() | Yiisoft\ |
|
| prepareAttributes() | Yiisoft\ |
|
| prepend() | Yiisoft\ |
|
| renderAttributes() | Render the current tag attributes. | Yiisoft\ |
| renderTag() | Yiisoft\ |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| CROSSORIGIN_ANONYMOUS | 'anonymous' | Yiisoft\ |
|
| CROSSORIGIN_CREDENTIALS | 'use-credentials' | Yiisoft\ |
|
| PRELOAD_AUTO | 'auto' | Yiisoft\ |
|
| PRELOAD_METADATA | 'metadata' | Yiisoft\ |
|
| PRELOAD_NONE | 'none' | Yiisoft\ |
Method Details
Defined in:
Yiisoft\
| public mixed __construct ( ) |
final public function __construct() {}
Defined in:
Yiisoft\
| public string __toString ( ) |
final public function __toString(): string
{
return $this->render();
}
Defined in:
Yiisoft\
Add a set of attributes to existing tag attributes.
Same named attributes are replaced.
| public static addAttributes ( array $attributes ) | ||
| $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;
}
Defined in:
Yiisoft\
Add one or more CSS classes to the tag.
| public static addClass ( \ | ||
| $class | \ |
One or many CSS classes. |
final public function addClass(BackedEnum|string|null ...$class): static
{
$new = clone $this;
Html::addCssClass($new->attributes, $class);
return $new;
}
| public static addSource ( Yiisoft\ | ||
| $source | Yiisoft\ |
|
public function addSource(Source $source): static
{
$new = clone $this;
$new->sources[] = $source;
return $new;
}
Defined in:
Yiisoft\
Add CSS styles to the tag.
See also Yiisoft\
| public static addStyle ( string|string[] $style, boolean $overwrite = true ) | ||
| $style | string|string[] |
The new style string (e.g. |
| $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;
}
Defined in:
Yiisoft\
| public static addTrack ( Yiisoft\ | ||
| $track | Yiisoft\ |
|
final public function addTrack(Track $track): static
{
$new = clone $this;
$new->tracks[] = $track;
return $new;
}
Defined in:
Yiisoft\
| protected string after ( ) |
protected function after(): string
{
return '';
}
Defined in:
Yiisoft\
Set attribute value.
| public static attribute ( string $name, mixed $value ) | ||
| $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;
}
Defined in:
Yiisoft\
Replace attributes with a new set.
| public static attributes ( array $attributes ) | ||
| $attributes | array |
Name-value set of attributes. |
final public function attributes(array $attributes): static
{
$new = clone $this;
$new->attributes = $attributes;
return $new;
}
Defined in:
Yiisoft\
| public static autoplay ( boolean $autoplay = true ) | ||
| $autoplay | boolean | |
final public function autoplay(bool $autoplay = true): static
{
return $this->attribute('autoplay', $autoplay);
}
Defined in:
Yiisoft\
| protected string before ( ) |
protected function before(): string
{
return '';
}
Defined in:
Yiisoft\
Replace current tag CSS classes with a new set of classes.
| public static class ( \ | ||
| $class | \ |
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;
}
Defined in:
Yiisoft\
| public string close ( ) | ||
| return | string |
Closing tag. |
|---|---|---|
final public function close(): string
{
return '</' . $this->getName() . '>';
}
Defined in:
Yiisoft\
| public static controls ( boolean $controls = true ) | ||
| $controls | boolean | |
final public function controls(bool $controls = true): static
{
return $this->attribute('controls', $controls);
}
Defined in:
Yiisoft\
| public static crossOrigin ( ?string $value ) | ||
| $value | ?string | |
final public function crossOrigin(?string $value): static
{
return $this->attribute('crossorigin', $value);
}
Defined in:
Yiisoft\
Content for browser that doesn't support media tags.
| public static fallback ( string|\ | ||
| $fallback | string|\ |
|
final public function fallback(string|Stringable|null $fallback): static
{
$new = clone $this;
$new->fallback = $fallback === null ? null : (string) $fallback;
return $new;
}
| protected string generateContent ( ) |
final protected function generateContent(): string
{
$items = $this->sources;
$hasDefaultTrack = false;
foreach ($this->tracks as $track) {
$isDefault = $track->isDefault();
if ($hasDefaultTrack && $isDefault) {
$items[] = $track->default(false);
} else {
$items[] = $track;
if (!$hasDefaultTrack) {
$hasDefaultTrack = $isDefault;
}
}
}
if ($this->fallback) {
$items[] = $this->fallback;
}
return $items ? "\n" . implode("\n" , $items) . "\n" : '';
}
Defined in:
Yiisoft\
Set tag ID.
| public static id ( string|null $id ) | ||
| $id | string|null |
Non-empty tag ID. |
final public function id(?string $id): static
{
/** @psalm-suppress TypeDoesNotContainType */
if ($id === '') {
throw new LogicException('The tag id cannot be an empty string.');
}
$new = clone $this;
$new->attributes['id'] = $id;
return $new;
}
Defined in:
Yiisoft\
| public static loop ( boolean $loop = true ) | ||
| $loop | boolean | |
final public function loop(bool $loop = true): static
{
return $this->attribute('loop', $loop);
}
Defined in:
Yiisoft\
| public static muted ( boolean $muted = true ) | ||
| $muted | boolean | |
final public function muted(bool $muted = true): static
{
return $this->attribute('muted', $muted);
}
Defined in:
Yiisoft\
| public string open ( ) | ||
| return | string |
Opening tag. |
|---|---|---|
final public function open(): string
{
return '<' . $this->getName() . $this->renderAttributes() . '>' . $this->prepend();
}
Defined in:
Yiisoft\
| public static preload ( ?string $preload ) | ||
| $preload | ?string | |
final public function preload(?string $preload): static
{
return $this->attribute('preload', $preload);
}
Defined in:
Yiisoft\
| protected void prepareAttributes ( ) |
protected function prepareAttributes(): void {}
Defined in:
Yiisoft\
| protected string prepend ( ) |
protected function prepend(): string
{
return '';
}
Defined in:
Yiisoft\
Remove CSS styles from the tag.
See also Yiisoft\
| public static removeStyle ( string|string[] $properties ) | ||
| $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;
}
Defined in:
Yiisoft\
| public string render ( ) |
final public function render(): string
{
return $this->before() . $this->renderTag() . $this->after();
}
Defined in:
Yiisoft\
Render the current tag attributes.
See also Yiisoft\
| protected string renderAttributes ( ) |
final protected function renderAttributes(): string
{
$this->prepareAttributes();
return Html::renderTagAttributes($this->attributes);
}
Defined in:
Yiisoft\
| protected string renderTag ( ) |
final protected function renderTag(): string
{
return $this->open() . $this->generateContent() . $this->close();
}
Defined in:
Yiisoft\
| public static sources ( Yiisoft\ | ||
| $sources | Yiisoft\ |
|
public function sources(Source ...$sources): static
{
$new = clone $this;
$new->sources = $sources;
return $new;
}
Defined in:
Yiisoft\
| public static src ( ?string $src ) | ||
| $src | ?string | |
final public function src(?string $src): static
{
return $this->attribute('src', $src);
}
Defined in:
Yiisoft\
| public static static tag ( ) |
final public static function tag(): static
{
return new static();
}
Defined in:
Yiisoft\
| public static tracks ( Yiisoft\ | ||
| $tracks | Yiisoft\ |
|
final public function tracks(Track ...$tracks): static
{
$new = clone $this;
$new->tracks = $tracks;
return $new;
}
Defined in:
Yiisoft\
Union attributes with a new set.
| public static unionAttributes ( array $attributes ) | ||
| $attributes | array |
Name-value set of attributes. |
final public function unionAttributes(array $attributes): static
{
$new = clone $this;
$new->attributes += $attributes;
return $new;
}
User Contributed Notes
Leave a comment
Join the conversation to share a note.