Object-Oriented User Interface
No Matches
OOUI\InputWidget Class Reference

Base class for input widgets. More...

+ Inheritance diagram for OOUI\InputWidget:
+ Collaboration diagram for OOUI\InputWidget:

Public Member Functions

 __construct (array $config=[])
 getValue ()
 Get the value of the input.
 setDir ( $dir)
 Set the directionality of the input.
 setValue ( $value)
 Set the value of the input.
 setDisabled ( $disabled)
 setInputId ( $id)
 Set the 'id' attribute of the <input> element.
 getConfig (&$config)
- Public Member Functions inherited from OOUI\Widget
 isDisabled ()
 Check if the widget is disabled.
 getInputId ()
 Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.
 setLabelledBy ( $id)
 Set the element with the given ID as a label for this widget.
- Public Member Functions inherited from OOUI\Element
 getTagName ()
 Get the HTML tag name.
 toggle ( $show=null)
 Toggle visibility of an element.
 getData ()
 Get element data.
 setData ( $data)
 Set element data.
 supports ( $methods)
 Check if element supports one or more methods.
 registerConfigCallback (callable $func)
 Register an additional function to call when building the config.
 toString ()
 Render element into HTML.
- Public Member Functions inherited from OOUI\Tag
 __construct ( $tag='div')
 Create element.
 hasClass ( $class)
 Check for CSS class.
 addClasses (array $classes)
 Add CSS classes.
 removeClasses (array $classes)
 Remove CSS classes.
 toggleClasses (array $classes, $toggle=null)
 Toggle CSS classes.
 getTag ()
 getAttribute ( $key)
 Get HTML attribute value.
 setAttributes (array $attributes)
 Add HTML attributes.
 removeAttributes (array $keys)
 Remove HTML attributes.
 removeContent (... $content)
 Remove any items that match by reference.
 appendContent (... $content)
 Add content to the end.
 prependContent (... $content)
 Add content to the beginning.
 clearContent ()
 Remove all content.
 getElementGroup ()
 Get group element is in.
 setElementGroup ( $group)
 Set group element is in.
 setInfusable ( $infusable)
 Enable widget for client-side infusion.
 isInfusable ()
 Get client-side infusability.
 ensureInfusableId ()
 Ensure that this given Tag is infusable and has a unique id attribute.
 __toString ()
 Magic method implementation.

Protected Member Functions

 getInputElement ( $config)
 Get input element.
 cleanUpValue ( $value)
 Clean up incoming value.
- Protected Member Functions inherited from OOUI\Element
 getJavaScriptClassName ()
 The class name of the JavaScript version of this widget.
 getGeneratedAttributes ()

Protected Attributes

Tag $input
 Input element.
string $value = ''
 Input value.
- Protected Attributes inherited from OOUI\Widget
bool $disabled = false
- 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.
array $attributes = []
array $classes = []
array $content = []
GroupElement null $elementGroup = null
bool $infusable = false
 Infusion support.

Additional Inherited Members

- Static Public Member Functions inherited from OOUI\Element
static warnDeprecation ( $message='')
 Emits a deprecation warning with provided message.
static getDir (Tag $element)
 Get the direction of the user interface for a given element.
static setDefaultDir ( $dir)
 Set the default direction of the user interface.
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.
- Static Public Member Functions inherited from OOUI\Tag
static generateElementId ()
 Generate a unique ID for element.
static resetElementId ()
 Reset the unique ID, for consistent test output.
static isSafeUrl ( $url)
 Check whether user-supplied URL is safe, that is, whether outputting it will not result in XSS vulnerability.
- Static Public Attributes inherited from OOUI\Element
static string $tagName = 'div'
 HTML tag name.
static string $defaultDir = 'ltr'
 Default text direction, used for some layout calculations.

Detailed Description

Base class for input widgets.


Constructor & Destructor Documentation

◆ __construct()

OOUI\InputWidget::__construct ( array $config = [])
array$configConfiguration options
  • string $config['name'] HTML input name (default: '')
  • string $config['value'] Input value (default: '')
  • string $config['dir'] The directionality of the input (ltr/rtl)
  • string $config['inputId'] The value of the input’s HTML id attribute.

Reimplemented from OOUI\Widget.

Reimplemented in OOUI\ButtonInputWidget, OOUI\CheckboxInputWidget, OOUI\CheckboxMultiselectInputWidget, OOUI\ComboBoxInputWidget, OOUI\DropdownInputWidget, OOUI\MultilineTextInputWidget, OOUI\NumberInputWidget, OOUI\RadioInputWidget, OOUI\RadioSelectInputWidget, OOUI\SearchInputWidget, OOUI\SelectFileInputWidget, and OOUI\TextInputWidget.

Member Function Documentation

◆ cleanUpValue()

OOUI\InputWidget::cleanUpValue ( $value)

Clean up incoming value.

Ensures value is a string, and converts null to empty string.

mixed$valueOriginal value
string Cleaned up value

Reimplemented in OOUI\CheckboxMultiselectInputWidget.

◆ getConfig()

◆ getInputElement()

OOUI\InputWidget::getInputElement ( $config)

◆ getValue()

OOUI\InputWidget::getValue ( )

Get the value of the input.

string Input value

◆ setDir()

OOUI\InputWidget::setDir ( $dir)

Set the directionality of the input.

string$dirText directionality: 'ltr', 'rtl' or 'auto'

◆ setDisabled()

OOUI\InputWidget::setDisabled ( $disabled)


Reimplemented from OOUI\Widget.

Reimplemented in OOUI\CheckboxMultiselectInputWidget, and OOUI\RadioSelectInputWidget.

◆ setInputId()

OOUI\InputWidget::setInputId ( $id)

Set the 'id' attribute of the <input> element.

string$idThe ID of the input element

◆ setValue()

OOUI\InputWidget::setValue ( $value)

Set the value of the input.

mixed$valueNew value should usually be a string

Reimplemented from OOUI\Tag.

Reimplemented in OOUI\ButtonInputWidget, OOUI\CheckboxMultiselectInputWidget, OOUI\DropdownInputWidget, and OOUI\RadioSelectInputWidget.

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