A button that is an input widget. More...

Inheritance diagram for OOUI\ButtonInputWidget:

Collaboration diagram for OOUI\ButtonInputWidget:

Public Member Functions
	__construct (array $config=[])

	setLabel ( $label)
	Set label value. More...

	setValue ( $value)
	Set the value of the input. More...

	getInputId ()

	getConfig (&$config)
	@inheritDoc

Public Member Functions inherited from OOUI\InputWidget
	getValue ()
	Get the value of the input. More...

	setDir ( $dir)
	Set the directionality of the input. More...

	setDisabled ( $disabled)
	@inheritDoc

	setInputId ( $id)
	Set the 'id' attribute of the `<input>` element. More...

Public Member Functions inherited from OOUI\Widget
	isDisabled ()
	Check if the widget is disabled. More...

	setLabelledBy ( $id)
	Set the element with the given ID as a label for this widget. More...

Public Member Functions inherited from OOUI\Element
	getTagName ()
	Get the HTML tag name. More...

	toggle ( $show=null)
	Toggle visibility of an element. More...

	getData ()
	Get element data. More...

	setData ( $data)
	Set element data. More...

	supports ( $methods)
	Check if element supports one or more methods. More...

	registerConfigCallback (callable $func)
	Register an additional function to call when building the config. More...

	toString ()
	Render element into HTML. More...

Public Member Functions inherited from OOUI\Tag
	__construct ( $tag='div')
	Create element. More...

	hasClass ( $class)
	Check for CSS class. More...

	addClasses (array $classes)
	Add CSS classes. More...

	removeClasses (array $classes)
	Remove CSS classes. More...

	toggleClasses (array $classes, $toggle=null)
	Toggle CSS classes. More...

	getTag ()

	getAttribute ( $key)
	Get HTML attribute value. More...

	setAttributes (array $attributes)
	Add HTML attributes. More...

	removeAttributes (array $keys)
	Remove HTML attributes. More...

	removeContent (... $content)
	Remove any items that match by reference. More...

	appendContent (... $content)
	Add content to the end. More...

	prependContent (... $content)
	Add content to the beginning. More...

	clearContent ()
	Remove all content. More...

	getElementGroup ()
	Get group element is in. More...

	setElementGroup ( $group)
	Set group element is in. More...

	setInfusable ( $infusable)
	Enable widget for client-side infusion. More...

	isInfusable ()
	Get client-side infusability. More...

	ensureInfusableId ()
	Ensure that this given Tag is infusable and has a unique `id` attribute. More...

	__toString ()
	Magic method implementation. More...

Static Public Attributes
static string	$tagName = 'span'

Static Public Attributes inherited from OOUI\Element
static string	$tagName = 'div'
	HTML tag name. More...

static string	$defaultDir = 'ltr'
	Default text direction, used for some layout calculations. More...

Protected Member Functions
	getInputElement ( $config)
	@inheritDoc

Protected Member Functions inherited from OOUI\InputWidget
	cleanUpValue ( $value)
	Clean up incoming value. More...

Protected Member Functions inherited from OOUI\Element
	getJavaScriptClassName ()
	The class name of the JavaScript version of this widget. More...

	getGeneratedAttributes ()

Protected Attributes
bool	$useInputTag
	Whether to use `<input>` rather than `<button>`.

Protected Attributes inherited from OOUI\InputWidget
Tag	$input
	Input element.

string	$value = ''
	Input value.

Protected Attributes inherited from OOUI\Widget
bool	$disabled = false
	Disabled. More...

Protected Attributes inherited from OOUI\Element
mixed	$data = null
	Element data.

bool	$visible = true

array	$ownClasses = []
	Strings of the CSS classes explicitly configured for this element (as opposed to $classes, which contains all classes for this element).

callable[]	$configCallbacks = []

Protected Attributes inherited from OOUI\Tag
string	$tag = ''
	Tag name for this instance. More...

array	$attributes = []
	Attributes. More...

array	$classes = []
	Classes. More...

array	$content = []
	Content. More...

GroupElement null	$elementGroup = null
	Group. More...

bool	$infusable = false
	Infusion support. More...

Additional Inherited Members
Static Public Member Functions inherited from OOUI\Element
static	warnDeprecation ( $message='')
	Emits a deprecation warning with provided message. More...

static	getDir (Tag $element)
	Get the direction of the user interface for a given element. More...

static	setDefaultDir ( $dir)
	Set the default direction of the user interface. More...

static	configFromHtmlAttributes (array $attrs)
	A helper method to massage an array of HTML attributes into a format that is more likely to work with an OOUI PHP element, camel-casing attribute names and setting values of boolean ones to true. More...

Static Public Member Functions inherited from OOUI\Tag
static	generateElementId ()
	Generate a unique ID for element. More...

static	isSafeUrl ( $url)
	Check whether user-supplied URL is safe, that is, whether outputting it will not result in XSS vulnerability. More...

Detailed Description

A button that is an input widget.

Intended to be used within a FormLayout.

Constructor & Destructor Documentation

◆ __construct()

OOUI\ButtonInputWidget::__construct ( array $config = [] )

Parameters

array

$config

Configuration options

string $config['type'] HTML tag type attribute, may be 'button', 'submit' or 'reset' (default: 'button')
bool $config['useInputTag'] Whether to use <input> rather than <button>. Only useful if you need IE 6 support in a form with multiple buttons. If you use this option, icons and indicators will not be displayed, it won't be possible to have a non-plaintext label, and it won't be possible to set a value (which will internally become identical to the label). (default: false)

Reimplemented from OOUI\InputWidget.

Member Function Documentation

◆ getInputId()

OOUI\ButtonInputWidget::getInputId ( )

Returns: null

Reimplemented from OOUI\Widget.

◆ setLabel()

OOUI\ButtonInputWidget::setLabel ( $label )

Set label value.

Overridden to support setting the 'value' of <input> elements.

Parameters

string | null $label Label text

Returns: $this

◆ setValue()

OOUI\ButtonInputWidget::setValue ( $value )

Set the value of the input.

Overridden to disable for <input> elements, which have value identical to the label.

Parameters

mixed $value New value should be a string

Returns: $this

Reimplemented from OOUI\InputWidget.

The documentation for this class was generated from the following file:

php/widgets/ButtonInputWidget.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getInputId()

◆ setLabel()

◆ setValue()