Skip to content
PHP Ecosystem
Explore

InputImage

API reference › HTML › Form › InputImage

Renders the HTML <input type="image"> element.

See also: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/image.

PropertyTypeDescriptionDefined by
$attributes protectedmixed[]HTML attributes array used by the implementing class. Default: [].UIAwesome\Html\Mixin\HasAttributes
$prefix protectedstringPrefix content string assigned to the element. Default: ''.UIAwesome\Html\Mixin\HasPrefixCollection
$prefixAttributes protectedarrayHTML attributes array for the prefix element. Default: [].UIAwesome\Html\Mixin\HasPrefixCollection
$prefixTag protectedfalse|UnitEnumTag name for the prefix element, or false to disable. Default: false.UIAwesome\Html\Mixin\HasPrefixCollection
$suffix protectedstringSuffix content string assigned to the element. Default: ''.UIAwesome\Html\Mixin\HasSuffixCollection
$suffixAttributes protectedarrayHTML attributes array for the suffix element. Default: [].UIAwesome\Html\Mixin\HasSuffixCollection
$suffixTag protectedfalse|UnitEnumTag name for the suffix element, or false to disable. Default: false.UIAwesome\Html\Mixin\HasSuffixCollection
$template protectedstringTemplate string used for constructing the HTML tag. Default: ''.UIAwesome\Html\Mixin\HasTemplate
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
alt()Sets the alt attribute.InputImage
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
class()Sets the class attribute.UIAwesome\Html\Attribute\Global\HasClass
config()Applies application-scoped config recipes to this tag.UIAwesome\Html\Core\Base\BaseTag
dataAttributes()Sets multiple data-* attributes.UIAwesome\Html\Attribute\Global\HasData
dir()Sets the dir attribute.UIAwesome\Html\Attribute\Global\HasDir
disabled()Sets the disabled attribute.UIAwesome\Html\Attribute\CanBeDisabled
events()Sets multiple on* event attributes.UIAwesome\Html\Attribute\Global\HasEvents
form()Sets the form attribute.UIAwesome\Html\Core\Element\BaseInput
formaction()Sets the formaction attribute.InputImage
formenctype()Sets the formenctype attribute.InputImage
formmethod()Sets the formmethod attribute.InputImage
formnovalidate()Sets the formnovalidate attribute.InputImage
formtarget()Sets the formtarget attribute.InputImage
getAttribute()Returns the value of a single HTML attribute.UIAwesome\Html\Mixin\HasAttributes
getAttributes()Returns the array of HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
getPrefix()Returns the prefix content string assigned to the element.UIAwesome\Html\Mixin\HasPrefixCollection
getPrefixAttribute()Returns the value of a single HTML attribute for the prefix element attributes.UIAwesome\Html\Mixin\HasPrefixCollection
getPrefixAttributes()Returns the array of HTML attributes for the prefix element.UIAwesome\Html\Mixin\HasPrefixCollection
getPrefixTag()Returns the tag name for the prefix element.UIAwesome\Html\Mixin\HasPrefixCollection
getSuffix()Returns the suffix content string assigned to the element.UIAwesome\Html\Mixin\HasSuffixCollection
getSuffixAttribute()Returns the value of a single HTML attribute for the suffix element attributes.UIAwesome\Html\Mixin\HasSuffixCollection
getSuffixAttributes()Returns the array of HTML attributes for the suffix element.UIAwesome\Html\Mixin\HasSuffixCollection
getSuffixTag()Returns the tag name for the suffix element.UIAwesome\Html\Mixin\HasSuffixCollection
getTemplate()Returns the template assigned to the element.UIAwesome\Html\Mixin\HasTemplate
height()Sets the height attribute.InputImage
hidden()Sets the hidden attribute.UIAwesome\Html\Attribute\Global\CanBeHidden
id()Sets the id attribute.UIAwesome\Html\Attribute\Global\HasId
lang()Sets the lang attribute.UIAwesome\Html\Attribute\Global\HasLang
name()Sets the name attribute.UIAwesome\Html\Attribute\HasName
prefix()Sets the prefix content string for the element.UIAwesome\Html\Mixin\HasPrefixCollection
prefixAttributes()Sets the HTML attributes for the prefix element.UIAwesome\Html\Mixin\HasPrefixCollection
prefixClass()Adds a CSS class to the prefix element attributes.UIAwesome\Html\Mixin\HasPrefixCollection
prefixRemoveAttribute()Removes a specific HTML attribute from the prefix element.UIAwesome\Html\Mixin\HasPrefixCollection
prefixSetAttribute()Sets a single HTML attribute for the prefix element.UIAwesome\Html\Mixin\HasPrefixCollection
prefixTag()Sets the tag name for the prefix element.UIAwesome\Html\Mixin\HasPrefixCollection
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
src()Sets the src attribute.InputImage
style()Sets the style attribute.UIAwesome\Html\Attribute\Global\HasStyle
suffix()Sets the suffix content string for the element.UIAwesome\Html\Mixin\HasSuffixCollection
suffixAttributes()Sets the HTML attributes for the suffix element.UIAwesome\Html\Mixin\HasSuffixCollection
suffixClass()Adds a CSS class to the suffix element attributes.UIAwesome\Html\Mixin\HasSuffixCollection
suffixRemoveAttribute()Removes a specific HTML attribute from the suffix element.UIAwesome\Html\Mixin\HasSuffixCollection
suffixSetAttribute()Sets a single HTML attribute for the suffix element.UIAwesome\Html\Mixin\HasSuffixCollection
suffixTag()Sets the tag type for the suffix element.UIAwesome\Html\Mixin\HasSuffixCollection
tabIndex()Sets the tabindex attribute.UIAwesome\Html\Attribute\Global\HasTabindex
tag() staticCreates and configures a new tag instance.UIAwesome\Html\Core\Base\BaseTag
template()Sets the template string for the element.UIAwesome\Html\Mixin\HasTemplate
title()Sets the title attribute.UIAwesome\Html\Attribute\Global\HasTitle
translate()Sets the translate attribute.UIAwesome\Html\Attribute\Global\HasTranslate
type()Sets the type attribute.UIAwesome\Html\Attribute\HasType
width()Sets the width attribute.InputImage
afterRun() protectedPost-processes rendered output.UIAwesome\Html\Core\Event\HasAfterRun
beforeRun() protectedValidates state before rendering.UIAwesome\Html\Core\Event\HasBeforeRun
buildElement() protectedBuilds element output from content and template tokens.UIAwesome\Html\Core\Element\Concern\HasElementBuilder
getTag() protectedReturns the tag enumeration for the <input> element.InputImage
loadDefault() protectedReturns the default configuration for the input element.InputImage
run() protectedRenders the <input> element with its attributes.InputImage
public function alt(string|Stringable|UnitEnum|null $value): static

Sets the alt attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullAlternative text for the element, or null to remove the attribute.

Returns

static: New instance with the updated alt attribute.

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

Sets the formaction attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullURL for form submission, or null to remove the attribute.

Returns

static: New instance with the updated formaction attribute.

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

Sets the formenctype attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullEncoding type for form submission, or null to remove the attribute.

Returns

static: New instance with the updated formenctype attribute.

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

Sets the formmethod attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullHTTP method for form submission, or null to remove the attribute.

Returns

static: New instance with the updated formmethod attribute.

public function formnovalidate(bool|null $value): static

Sets the formnovalidate attribute.

Parameters

ParameterTypeDescription
$valuebool|nullWhether to bypass form validation, or null to remove the attribute.

Returns

static: New instance with the updated formnovalidate attribute.

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

Sets the formtarget attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullBrowsing context for form submission response, or null to remove the attribute.

Returns

static: New instance with the updated formtarget attribute.

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

Sets the height attribute.

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 src(string|Stringable|UnitEnum|null $value): static

Sets the src attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullImage source URL or path, or null to remove the attribute.

Returns

static: New instance with the updated src attribute.

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

Sets the width attribute.

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.

protected function getTag(): UIAwesome\Html\Interop\Voids

Returns the tag enumeration for the <input> element.

Returns

Voids: Tag enumeration instance for <input>.

protected function loadDefault(): array<string, mixed>

Returns the default configuration for the input element.

Returns

array<string, mixed>: Default configuration for the input element, including the default type attribute set to image.

protected function run(): string

Renders the <input> element with its attributes.

Returns

string: Rendered HTML for the <input> element.