Object-Oriented User Interface
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. More...
 setDir ( $dir)
 Set the directionality of the input. More...
 setValue ( $value)
 Set the value of the input. More...
 setDisabled ( $disabled)
 setInputId ( $id)
 Set the 'id' attribute of the <input> element. More...
 getConfig (&$config)
- Public Member Functions inherited from OOUI\Widget
 isDisabled ()
 Check if the widget is disabled. More...
 getInputId ()
 Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value. 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...

Protected Member Functions

 getInputElement ( $config)
 Get input element. More...
 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

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 resetElementId ()
 Reset the unique ID, for consistent test output. More...
static isSafeUrl ( $url)
 Check whether user-supplied URL is safe, that is, whether outputting it will not result in XSS vulnerability. More...
- 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...

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\TextInputWidget, OOUI\SelectFileInputWidget, OOUI\SearchInputWidget, OOUI\RadioSelectInputWidget, OOUI\RadioInputWidget, OOUI\NumberInputWidget, OOUI\MultilineTextInputWidget, OOUI\DropdownInputWidget, OOUI\ComboBoxInputWidget, OOUI\CheckboxMultiselectInputWidget, OOUI\CheckboxInputWidget, and OOUI\ButtonInputWidget.

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.

◆ 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'

◆ 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\RadioSelectInputWidget, OOUI\DropdownInputWidget, OOUI\CheckboxMultiselectInputWidget, and OOUI\ButtonInputWidget.

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