OOUI\SelectWidget Class Reference

A SelectWidget is of a generic selection of options. More...

Inheritance diagram for OOUI\SelectWidget:

Collaboration diagram for OOUI\SelectWidget:

Public Member Functions
	__construct (array $config=[])
	findSelectedItem ()
	selectItemByData ( $data=null)
	Programmatically select an option by its data.
	unselectItem ( $item)
	Unselect an option by its reference.
	selectItem ( $item=null)
	Select an option by its reference.
Public Member Functions inherited from OOUI\Widget
	isDisabled ()
	Check if the widget is disabled.
	setDisabled ( $disabled)
	Set the disabled state of the widget.
	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.
	getConfig (&$config)
	@inheritDoc
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.
	setValue ( $value)
	Set value of input element ('value' attribute for most, element content for textarea).
	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 Attributes
bool	$multiselect
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.
Protected Member Functions inherited from OOUI\Element
	getJavaScriptClassName ()
	The class name of the JavaScript version of this widget.
	getGeneratedAttributes ()

Detailed Description

A SelectWidget is of a generic selection of options.

Should be used in conjunction with OptionWidget

@method OptionWidget[] getItems()

Constructor & Destructor Documentation

__construct()

OOUI\SelectWidget::__construct

(

array

$config = []

)

Parameters

array

$config

Configuration options OptionWidget[] $config['items'] OptionWidget objects to add to the select bool $config['multiselect'] Allow for multiple selections

Reimplemented from OOUI\Widget.

Reimplemented in OOUI\TabSelectWidget.

Member Function Documentation

findSelectedItem()

OOUI\SelectWidget::findSelectedItem

(

)

Returns

OptionWidget[]|OptionWidget|null

selectItem()

OOUI\SelectWidget::selectItem

(

$item = null

)

Select an option by its reference.

Parameters

OptionWidget | null

$item

Item to select, omit to deselect all

Returns

$this

selectItemByData()

OOUI\SelectWidget::selectItemByData

(

$data = null

)

Programmatically select an option by its data.

If the data parameter is omitted, or if the item does not exist, all options will be deselected.

Parameters

mixed

$data

Value of the item to select, omit to deselect all

Returns

$this

unselectItem()

OOUI\SelectWidget::unselectItem

(

$item

)

Unselect an option by its reference.

Parameters

OptionWidget

$item

Item to unselect, omit to deselect all

Returns

$this

---

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

• php/widgets/SelectWidget.php