OOUI
Object-Oriented User Interface
|
Generic widget for buttons. More...
Public Member Functions | |
__construct (array $config=[]) | |
getHref () | |
Get hyperlink location. More... | |
getTarget () | |
Get hyperlink target. More... | |
getNoFollow () | |
Get search engine traversal hint. More... | |
getRel () | |
Get the relationship attribute of the hyperlink. More... | |
setHref ( $href) | |
Set hyperlink location. More... | |
updateHref () | |
Update the href attribute, in case of changes to href or disabled state. More... | |
setTarget ( $target) | |
Set hyperlink target. More... | |
setNoFollow ( $noFollow) | |
Set search engine traversal hint. More... | |
setRel ( $rel) | |
Set the relationship attribute of the hyperlink. More... | |
setActive ( $active=null) | |
Toggle active state. More... | |
isActive () | |
Check if button is active. More... | |
getConfig (&$config) | |
@inheritDoc | |
![]() | |
isDisabled () | |
Check if the widget is disabled. More... | |
setDisabled ( $disabled) | |
Set the disabled state of the widget. 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... | |
![]() | |
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... | |
![]() | |
__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 Attributes | |
static string | $tagName = 'span' |
![]() | |
static string | $tagName = 'div' |
HTML tag name. More... | |
static string | $defaultDir = 'ltr' |
Default text direction, used for some layout calculations. More... | |
Protected Attributes | |
bool | $active = false |
Whether button is active. | |
string | $href = null |
Hyperlink to visit when clicked. | |
string | $target = null |
Target to open hyperlink in. | |
bool | $noFollow = true |
Search engine traversal hint. More... | |
string[] | $rel = [] |
Relationship attributes, such as the noFollow field above, or noopener for the hyperlink. | |
![]() | |
bool | $disabled = false |
Disabled. More... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
getJavaScriptClassName () | |
The class name of the JavaScript version of this widget. More... | |
getGeneratedAttributes () | |
Generic widget for buttons.
OOUI\ButtonWidget::__construct | ( | array | $config = [] | ) |
array | $config | Configuration options
|
Reimplemented from OOUI\Widget.
OOUI\ButtonWidget::getHref | ( | ) |
Get hyperlink location.
OOUI\ButtonWidget::getNoFollow | ( | ) |
Get search engine traversal hint.
OOUI\ButtonWidget::getRel | ( | ) |
Get the relationship attribute of the hyperlink.
OOUI\ButtonWidget::getTarget | ( | ) |
Get hyperlink target.
OOUI\ButtonWidget::isActive | ( | ) |
Check if button is active.
OOUI\ButtonWidget::setActive | ( | $active = null | ) |
Toggle active state.
A button should be marked as active when clicking it would only refresh the page.
bool | null | $active | Make button active |
OOUI\ButtonWidget::setHref | ( | $href | ) |
Set hyperlink location.
string | null | $href | Hyperlink location, null to remove |
OOUI\ButtonWidget::setNoFollow | ( | $noFollow | ) |
Set search engine traversal hint.
bool | $noFollow | True if search engines should avoid traversing this hyperlink |
OOUI\ButtonWidget::setRel | ( | $rel | ) |
Set the relationship attribute of the hyperlink.
string | string[] | $rel | Relationship attributes for the hyperlink |
OOUI\ButtonWidget::setTarget | ( | $target | ) |
Set hyperlink target.
string | null | $target | Hyperlink target, null to remove |
OOUI\ButtonWidget::updateHref | ( | ) |
Update the href attribute, in case of changes to href or disabled state.
|
protected |
Search engine traversal hint.
True if search engines should avoid following this hyperlink.