Skip to content
PHP Ecosystem
Explore

BaseSvg

API reference › HTML SVG › Base › BaseSvg

1 subclass

Base class for constructing <svg> elements.

Provides the shared implementation for SVG container rendering, including attribute handling, content management, and immutable updates.

Intended for SVG classes that need SVG container behavior with file-backed rendering and attribute processing.

See also: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg (BaseBlock for the base block-level implementation. SvgAttribute for supported SVG attributes.).

PropertyTypeDescriptionDefined by
$attributes protectedmixed[]HTML attributes array used by the implementing class. Default: [].UIAwesome\Html\Mixin\HasAttributes
$content protectedstringContent string assigned to the element. Default: ''.UIAwesome\Html\Mixin\HasContent
MethodDescriptionDefined by
__construct() finalInitializes a new tag instance.UIAwesome\Html\Core\Base\BaseTag
__toString()Returns the rendered tag string.UIAwesome\Html\Core\Base\BaseTag
accesskey()Sets the accesskey attribute.UIAwesome\Html\Attribute\Global\HasAccesskey
addAriaAttribute()Sets an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
addAttribute()Adds or updates a single HTML attribute for the element.UIAwesome\Html\Mixin\HasAttributes
addDataAttribute()Sets a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
addEvent()Sets an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
ariaAttributes()Sets multiple aria-* attributes.UIAwesome\Html\Attribute\Global\HasAria
attributes()Adds or updates multiple HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
autofocus()Sets the autofocus attribute.UIAwesome\Html\Attribute\Global\CanBeAutofocus
begin() finalStarts begin/end rendering for this instance.UIAwesome\Html\Core\Element\BaseBlock
class()Sets the class attribute.UIAwesome\Html\Attribute\Global\HasClass
clearContent()Clears encoded and raw content without changing other component state.UIAwesome\Html\Mixin\HasContent
config()Applies application-scoped config recipes to this tag.UIAwesome\Html\Core\Base\BaseTag
content()Appends encoded content.UIAwesome\Html\Mixin\HasContent
contentEditable()Sets the contenteditable attribute.UIAwesome\Html\Attribute\Global\HasContentEditable
dataAttributes()Sets multiple data-* attributes.UIAwesome\Html\Attribute\Global\HasData
dir()Sets the dir attribute.UIAwesome\Html\Attribute\Global\HasDir
draggable()Sets the draggable attribute.UIAwesome\Html\Attribute\Global\HasDraggable
end() static finalEnds the most recent begin/end rendering block for the current class.UIAwesome\Html\Core\Element\BaseBlock
events()Sets multiple on* event attributes.UIAwesome\Html\Attribute\Global\HasEvents
filePath()Sets the file path for the SVG file to be rendered.BaseSvg
fill()Sets the SVG fill attribute for the element.BaseSvg
fillOpacity()Sets SVG fill-opacity attribute for the element.BaseSvg
fillRule()Sets SVG fill-rule attribute for the element.BaseSvg
getAttribute()Returns the value of a single HTML attribute.UIAwesome\Html\Mixin\HasAttributes
getAttributes()Overrides the attribute retrieval to filter out the title attribute.BaseSvg
getContent()Retrieves the content of the SVG element, injecting a <title> element when defined.BaseSvg
height()Sets the height attribute.BaseSvg
hidden()Sets the hidden attribute.UIAwesome\Html\Attribute\Global\CanBeHidden
html()Appends trusted raw HTML content without encoding or sanitizing it.UIAwesome\Html\Mixin\HasContent
id()Sets the id attribute.UIAwesome\Html\Attribute\Global\HasId
itemId()Sets the itemid attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemProp()Sets the itemprop attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemRef()Sets the itemref attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemScope()Sets the itemscope attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemType()Sets the itemtype attribute.UIAwesome\Html\Attribute\Global\HasMicroData
lang()Sets the lang attribute.UIAwesome\Html\Attribute\Global\HasLang
opacity()Sets the SVG opacity attribute for the element.BaseSvg
preserveAspectRatio()Sets the SVG preserveAspectRatio attribute for the element.BaseSvg
removeAriaAttribute()Removes an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
removeAttribute()Removes a specific HTML attribute from the element.UIAwesome\Html\Mixin\HasAttributes
removeDataAttribute()Removes a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
removeEvent()Removes an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
render() finalRenders the tag with lifecycle hooks.UIAwesome\Html\Core\Base\BaseTag
replaceAttributes()Replaces all HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
role()Sets the role attribute.UIAwesome\Html\Attribute\Global\HasRole
spellcheck()Sets the spellcheck attribute.UIAwesome\Html\Attribute\Global\HasSpellcheck
stroke()Sets the SVG stroke attribute for the element.BaseSvg
strokeDashArray()Sets the SVG stroke-dasharray attribute for the element.BaseSvg
strokeLineCap()Sets the SVG stroke-linecap attribute for the element.BaseSvg
strokeLineJoin()Sets the SVG stroke-linejoin attribute for the element.BaseSvg
strokeMiterlimit()Sets SVG stroke-miterlimit attribute for the element.BaseSvg
strokeOpacity()Sets SVG stroke-opacity attribute for the element.BaseSvg
strokeWidth()Sets the SVG stroke-width attribute for the element.BaseSvg
style()Sets the style attribute.UIAwesome\Html\Attribute\Global\HasStyle
tabIndex()Sets the tabindex attribute.UIAwesome\Html\Attribute\Global\HasTabindex
tag() staticCreates and configures a new tag instance.UIAwesome\Html\Core\Base\BaseTag
title()Sets the title attribute.UIAwesome\Html\Attribute\Global\HasTitle
transform()Sets the SVG transform attribute for the element.BaseSvg
translate()Sets the translate attribute.UIAwesome\Html\Attribute\Global\HasTranslate
viewBox()Sets the SVG viewBox attribute for the element.BaseSvg
width()Sets the width attribute.BaseSvg
x()Sets the SVG x attribute for the element.BaseSvg
xmlns()Sets the xmlns attribute for the SVG element.BaseSvg
y()Sets the SVG y attribute for the element.BaseSvg
afterRun() protectedPost-processes rendered output.UIAwesome\Html\Core\Event\HasAfterRun
beforeRun() protectedPre-run validation for SVG rendering.BaseSvg
getTag() protected abstractReturns the tag instance representing the block element.UIAwesome\Html\Core\Element\BaseBlock
isBeginExecuted() protectedIndicates whether this instance has an open or closing operation in the current context.UIAwesome\Html\Core\Element\BaseBlock
loadDefault() protectedReturns class-level default definitions.UIAwesome\Html\Core\Base\BaseTag
run() protectedExecutes the rendering routine for the SVG element.BaseSvg
runBegin() protectedReturns the opening tag for begin/end rendering.UIAwesome\Html\Core\Element\BaseBlock
public function filePath(string $value): static

Sets the file path for the SVG file to be rendered.

Creates a new instance with the specified file path property value, supporting explicit assignment of SVG file paths.

Parameters

ParameterTypeDescription
$valuestringPath to the SVG file.

Returns

static: New instance with the updated filePath property. Usage example: $element->filePath(‘/path/to/icon.svg’);

public function fill(string|null $value): static

Sets the SVG fill attribute for the element.

Creates a new instance with the specified fill value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|nullFill value (for example, ‘red’, ‘url(#gradient1)’, or null to unset).

Returns

static: New instance with the updated fill attribute.

public function fillOpacity(float|int|string|null $value): static

Sets SVG fill-opacity attribute for the element.

Creates a new instance with the specified fill opacity value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullFill opacity value (for example, ‘0.5’, 0.5, or null to unset).

Returns

static: New instance with the updated fill-opacity attribute.

Throws

public function fillRule(UIAwesome\Html\Svg\Values\FillRule|string|null $value): static

Sets SVG fill-rule attribute for the element.

Creates a new instance with the specified fill rule value for the rendered element.

Parameters

ParameterTypeDescription
$valueUIAwesome\Html\Svg\Values\FillRule|string|nullFill rule value to set for the element. Accepts ‘nonzero’, ‘evenodd’, FillRule enum, or null to unset.

Returns

static: New instance with the updated fill-rule attribute.

Throws

public function getAttributes(): mixed[]

Overrides the attribute retrieval to filter out the title attribute.

This ensures title attribute is never rendered as a standard SVG attribute, without modifying the internal state of the object.

Returns

mixed[]: Filtered attributes array without title attribute. Usage example: $element->getAttributes();

public function getContent(): string

Retrieves the content of the SVG element, injecting a <title> element when defined.

Overrides the base implementation to intercept the title attribute. If present, it creates a <title> element and prepends it to the content before the remaining SVG content.

Returns

string: Combined content string with the title attribute injected. Usage example: $element->getContent();

public function height(int|string|Stringable|UnitEnum|null $value): static

Sets the height attribute.

Usage example:

$element->height(200);
$element->height('50%');
$element->height('auto');

Parameters

ParameterTypeDescription
$valueint|string|Stringable|UnitEnum|nullHeight value in pixels or CSS units, or null to remove the attribute.

Returns

static: New instance with the updated height attribute.

public function opacity(float|int|string|null $value): static

Sets the SVG opacity attribute for the element.

Creates a new instance with the specified opacity value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullOpacity value (for example, ‘0.5’, ‘0.75’, or null to unset).

Returns

static: New instance with the updated opacity attribute.

Throws

public function preserveAspectRatio(UIAwesome\Html\Svg\Values\PreserveAspectRatio|string|null $value): static

Sets the SVG preserveAspectRatio attribute for the element.

Creates a new instance with the specified preserve aspect ratio value for the rendered element.

Parameters

ParameterTypeDescription
$valueUIAwesome\Html\Svg\Values\PreserveAspectRatio|string|nullPreserve aspect ratio value (for example, ‘xMidYMid meet’, PreserveAspectRatio enum, or null to unset).

Returns

static: New instance with the updated preserveAspectRatio attribute.

Throws

public function stroke(string|null $value): static

Sets the SVG stroke attribute for the element.

Creates a new instance with the specified stroke value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|nullStroke paint value (for example, ‘black’, ‘url(#gradient1)’, or null to unset).

Returns

static: New instance with the updated stroke attribute.

public function strokeDashArray(float|int|string|null $value): static

Sets the SVG stroke-dasharray attribute for the element.

Creates a new instance with the specified dash array value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullDash array value (for example, ‘5.3’, ‘4’, ‘5.3 2’, or null to unset).

Returns

static: New instance with the updated stroke-dasharray attribute.

See also

public function strokeLineCap(string|UIAwesome\Html\Svg\Values\StrokeLineCap|null $value): static

Sets the SVG stroke-linecap attribute for the element.

Creates a new instance with the specified stroke line cap value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|UIAwesome\Html\Svg\Values\StrokeLineCap|nullStroke line cap style (for example, ‘round’, StrokeLineCap enum, or null to unset).

Returns

static: New instance with the updated stroke-linecap attribute.

Throws

public function strokeLineJoin(string|UIAwesome\Html\Svg\Values\StrokeLineJoin|null $value): static

Sets the SVG stroke-linejoin attribute for the element.

Parameters

ParameterTypeDescription
$valuestring|UIAwesome\Html\Svg\Values\StrokeLineJoin|nullStroke line join style (for example, ‘miter’, StrokeLineJoin enum, or null to unset).

Returns

static: New instance with the updated stroke-linejoin attribute.

Throws

public function strokeMiterlimit(float|int|string|null $value): static

Sets SVG stroke-miterlimit attribute for the element.

Creates a new instance with the specified stroke miter limit value for the rendered element.

The stroke-miterlimit attribute controls the limit on the ratio of the miter length to the stroke width. When the limit is exceeded, the join is converted from a miter to a bevel. The value must be a number ’>= 1’.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullStroke miter limit value (for example, ‘4’, ‘10’, or null to unset).

Returns

static: New instance with the updated stroke-miterlimit attribute.

Throws

See also

public function strokeOpacity(float|int|string|null $value): static

Sets SVG stroke-opacity attribute for the element.

Creates a new instance with the specified stroke opacity value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullStroke opacity value (for example, ‘0.8’, ‘0.6’, or null to unset).

Returns

static: New instance with the updated stroke-opacity attribute.

Throws

public function strokeWidth(int|string|null $value): static

Sets the SVG stroke-width attribute for the element.

Creates a new instance with the specified stroke width value for the rendered element.

Parameters

ParameterTypeDescription
$valueint|string|nullStroke width value (for example, ‘2’, ‘1.5em’, or null to unset).

Returns

static: New instance with the updated stroke-width attribute.

public function transform(string|null $value): static

Sets the SVG transform attribute for the element.

Creates a new instance with the specified transform value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|nullTransform value (for example, ‘rotate(45)’, ‘scale(2)’, or null to unset).

Returns

static: New instance with the updated transform attribute.

public function viewBox(string|null $value): static

Sets the SVG viewBox attribute for the element.

Creates a new instance with the specified view box value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|nullViewBox value (for example, ‘0 0 100 100’, or null to unset).

Returns

static: New instance with the updated viewBox attribute.

public function width(int|string|Stringable|UnitEnum|null $value): static

Sets the width attribute.

Usage example:

$element->width(400);
$element->width('50%');
$element->width('auto');
$element->width(null);

Parameters

ParameterTypeDescription
$valueint|string|Stringable|UnitEnum|nullWidth value in pixels or CSS units, or null to remove the attribute.

Returns

static: New instance with the updated width attribute.

public function x(float|int|string|null $value): static

Sets the SVG x attribute for the element.

Creates a new instance with the specified x-coordinate value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullX coordinate value (for example, ‘10’, ‘10.3’, ‘50%’, or null to unset).

Returns

static: New instance with the updated x attribute.

public function xmlns(string|null $value): static

Sets the xmlns attribute for the SVG element.

Creates a new instance with the specified XML namespace URI for the rendered <svg> element.

The xmlns attribute is typically used on the outermost <svg> element.

Parameters

ParameterTypeDescription
$valuestring|nullXML namespace URI.

Returns

static: New instance with the updated xmlns attribute.

See also

public function y(float|int|string|null $value): static

Sets the SVG y attribute for the element.

Creates a new instance with the specified y-coordinate value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullY coordinate value (for example, ‘20’, ‘10.3’, ‘50%’, or null to unset).

Returns

static: New instance with the updated y attribute.

protected function beforeRun(): bool

Pre-run validation for SVG rendering.

Ensures at least one source of content is provided: either the filePath property or the internal content.

Returns

bool: true when preconditions are satisfied and the parent pre-run succeeds.

Throws

protected function run(): string

Executes the rendering routine for the SVG element.

If a filePath is configured the SVG content is loaded, sanitized, and injected into the current document. When no filePath is provided the parent’s run method is used.

Returns

string: Rendered SVG string or parent’s result.