OOUI
Object-Oriented User Interface
Loading...
Searching...
No Matches
OOUI\DropdownInputWidget Class Reference

Dropdown input widget, wrapping a <select> element. More...

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

Public Member Functions

 __construct (array $config=[])
 
 setValue ( $value)
 @inheritDoc
 
 setOptions ( $options)
 Set the options available for this input.
 
 getConfig (&$config)
 @inheritDoc
 
- Public Member Functions inherited from OOUI\InputWidget
 getValue ()
 Get the value of the input.
 
 setDir ( $dir)
 Set the directionality of the input.
 
 setDisabled ( $disabled)
 @inheritDoc
 
 setInputId ( $id)
 Set the 'id' attribute of the <input> element.
 
- 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)
 @inheritDoc
 
- Protected Member Functions inherited from OOUI\InputWidget
 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[] $options = []
 HTML <option> tags for this widget.
 
- Protected Attributes inherited from OOUI\InputWidget
Tag $input
 Input element.
 
string $value = ''
 Input value.
 
- Protected Attributes inherited from OOUI\Widget
bool $disabled = false
 Disabled.
 
- 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 = []
 Attributes.
 
array $classes = []
 Classes.
 
array $content = []
 Content.
 
GroupElement null $elementGroup = null
 Group.
 
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

Dropdown input widget, wrapping a <select> element.

Intended to be used within a OO.ui.FormLayout.

Constructor & Destructor Documentation

◆ __construct()

OOUI\DropdownInputWidget::__construct ( array  $config = [])
Parameters
array$configConfiguration options
  • array[] $config['options'] Array of menu options in the format described in DropdownInputWidget::setOptions().

Reimplemented from OOUI\InputWidget.

Member Function Documentation

◆ getConfig()

OOUI\DropdownInputWidget::getConfig ( $config)

@inheritDoc

Reimplemented from OOUI\InputWidget.

◆ getInputElement()

OOUI\DropdownInputWidget::getInputElement (   $config)
protected

@inheritDoc

Reimplemented from OOUI\InputWidget.

◆ setOptions()

OOUI\DropdownInputWidget::setOptions (   $options)

Set the options available for this input.

Each element of the $options array should be an array with one of the following structures:

  1. For normal menu items (label and disabled are optional; if no label is provided, the 'data' value will be also used as the label):
    [ 'data' => 'optionvalue', 'label' => 'Option Label', 'disabled' => true ]
  2. For option groups ('disabled' is optional):
    [ 'optgroup' => 'Group Label', 'disabled' => true ]

An optgroup will contain all subsequent options up until the next optgroup or the end of the array.

Parameters
array[]$optionsArray of options in format described above.
Returns
$this

◆ setValue()

OOUI\DropdownInputWidget::setValue (   $value)

@inheritDoc

Reimplemented from OOUI\InputWidget.


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