OOUI
Object-Oriented User Interface
|
DOM element abstraction. More...
Public Member Functions | |
__construct (array $config=[]) | |
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... | |
getConfig (&$config) | |
Add the necessary properties to the given $config array to allow reconstruction of this widget via its constructor. More... | |
toString () | |
Render element into HTML. More... | |
![]() | |
__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... | |
setValue ( $value) | |
Set value of input element ('value' attribute for most, element content for textarea). 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 Member Functions | |
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 | 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 | |
static string | $tagName = 'div' |
HTML tag name. More... | |
static string | $defaultDir = 'ltr' |
Default text direction, used for some layout calculations. More... | |
Protected Member Functions | |
getJavaScriptClassName () | |
The class name of the JavaScript version of this widget. More... | |
getGeneratedAttributes () | |
Protected Attributes | |
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 = [] |
![]() | |
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... | |
DOM element abstraction.
@abstract
OOUI\Element::__construct | ( | array | $config = [] | ) |
array | $config | Configuration options
|
Reimplemented in OOUI\ToggleWidget, OOUI\ToggleSwitchWidget, OOUI\TextInputWidget, OOUI\TabSelectWidget, OOUI\TabOptionWidget, OOUI\SelectWidget, OOUI\SelectFileInputWidget, OOUI\SearchInputWidget, OOUI\RadioSelectInputWidget, OOUI\RadioInputWidget, OOUI\ProgressBarWidget, OOUI\OptionWidget, OOUI\NumberInputWidget, OOUI\MultilineTextInputWidget, OOUI\MessageWidget, OOUI\LabelWidget, OOUI\InputWidget, OOUI\IndicatorWidget, OOUI\IconWidget, OOUI\DropdownInputWidget, OOUI\ComboBoxInputWidget, OOUI\CheckboxMultiselectInputWidget, OOUI\CheckboxInputWidget, OOUI\ButtonWidget, OOUI\ButtonInputWidget, OOUI\ButtonGroupWidget, OOUI\Widget, OOUI\StackLayout, OOUI\PanelLayout, OOUI\MenuLayout, OOUI\IndexLayout, OOUI\HorizontalLayout, OOUI\FormLayout, OOUI\FieldsetLayout, OOUI\Layout, and OOUI\HiddenInputWidget.
|
static |
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.
Intended as a convenience to be used when refactoring legacy systems using HTML to use OOUI.
array | $attrs | HTML attributes, e.g. ‘[ 'disabled’ => '', 'accesskey' => 'k' ] @return array OOUI PHP element config, e.g. [ 'disabled' => true, 'accessKey' => 'k' ]` |
OOUI\Element::getConfig | ( | & | $config | ) |
Add the necessary properties to the given $config
array to allow reconstruction of this widget via its constructor.
array | &$config | An array which will be mutated to add the necessary configuration properties. Unless you are implementing a subclass, you should always pass a new empty array [] . |
array_merge
in the implementation. Reimplemented in OOUI\ToggleWidget, OOUI\ToggleSwitchWidget, OOUI\TextInputWidget, OOUI\TabSelectWidget, OOUI\TabOptionWidget, OOUI\SelectFileInputWidget, OOUI\RadioSelectInputWidget, OOUI\RadioInputWidget, OOUI\ProgressBarWidget, OOUI\OptionWidget, OOUI\NumberInputWidget, OOUI\MultilineTextInputWidget, OOUI\MessageWidget, OOUI\LabelWidget, OOUI\InputWidget, OOUI\HiddenInputWidget, OOUI\DropdownInputWidget, OOUI\ComboBoxInputWidget, OOUI\CheckboxMultiselectInputWidget, OOUI\CheckboxInputWidget, OOUI\ButtonWidget, OOUI\ButtonInputWidget, OOUI\Widget, OOUI\TabPanelLayout, OOUI\StackLayout, OOUI\PanelLayout, OOUI\MenuLayout, OOUI\IndexLayout, OOUI\FormLayout, OOUI\FieldsetLayout, OOUI\FieldLayout, and OOUI\ActionFieldLayout.
OOUI\Element::getData | ( | ) |
Get element data.
|
static |
|
protected |
Reimplemented from OOUI\Tag.
|
protected |
The class name of the JavaScript version of this widget.
OOUI\Element::getTagName | ( | ) |
Get the HTML tag name.
Override this method to base the result on instance information.
OOUI\Element::registerConfigCallback | ( | callable | $func | ) |
Register an additional function to call when building the config.
See ::getConfig().
callable | $func | The function. Parameters and return value are the same as ::getConfig(). |
OOUI\Element::setData | ( | $data | ) |
|
static |
Set the default direction of the user interface.
string | $dir | Text direction, either 'ltr' or 'rtl' |
OOUI\Element::supports | ( | $methods | ) |
Check if element supports one or more methods.
string | string[] | $methods | Method or list of methods to check |
OOUI\Element::toggle | ( | $show = null | ) |
Toggle visibility of an element.
bool | null | $show | Make element visible, omit to toggle visibility |
OOUI\Element::toString | ( | ) |
|
static |
Emits a deprecation warning with provided message.
string | $message | Message about the deprecation |
|
static |
Default text direction, used for some layout calculations.
Use setDefaultDir() to change.
Currently only per-document directionality is supported.
|
static |
HTML tag name.
This may be ignored if getTagName() is overridden.