OOUI
Object-Oriented User Interface
OOUI\FieldLayout Class Reference

Layout made of a field and optional label. More...

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

Public Member Functions

 __construct ( $fieldWidget, array $config=[])
 
 getField ()
 Get the field. More...
 
 isFieldInline ()
 Return true if the given field widget can be used with ‘'inline’alignment (see setAlignment()). More...
 
 getConfig (&$config)
 Add the necessary properties to the given $config array to allow reconstruction of this widget via its constructor. More...
 
- Public Member Functions inherited from OOUI\Layout
 __construct (array $config=[])
 
- Public Member Functions inherited from OOUI\Element
 getTagName ()
 Get the HTML tag name. 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...
 
 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,... $params)
 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...
 

Public Attributes

 $header
 
 $body
 
 $messages
 

Protected Member Functions

 setAlignment ( $value)
 Set the field alignment mode. More...
 
 formatTitleWithAccessKey ( $title)
 Include information about the widget's accessKey in our title. More...
 
- Protected Member Functions inherited from OOUI\Element
 getJavaScriptClassName ()
 The class name of the JavaScript version of this widget. More...
 
 getGeneratedAttributes ()
 Return an augmented attributes array, including synthetic attributes which are created from other properties (like the classes array) but which shouldn't be retained in the user-visible attributes. More...
 

Protected Attributes

string $align
 Alignment.
 
Widget $fieldWidget
 Field widget to be laid out.
 
array $errors
 Error messages.
 
array $warnings
 Warning messages.
 
array $successMessages
 Success messages.
 
array $notices
 Notice messages.
 
ButtonWidget string $help
 
 $field
 
- Protected Attributes inherited from OOUI\Element
mixed $data = null
 Element data.
 
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...
 
boolean $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 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

Layout made of a field and optional label.

Available label alignment modes include:

  • left: Label is before the field and aligned away from it, best for when the user will be scanning for a specific label in a form with many fields
  • right: Label is before the field and aligned toward it, best for forms the user is very familiar with and will tab through field checking quickly to verify which field they are in
  • top: Label is before the field and above it, best for when the user will need to fill out all fields from top to bottom in a form with few fields
  • inline: Label is after the field and aligned toward it, best for small boolean fields like checkboxes or radio buttons

Constructor & Destructor Documentation

◆ __construct()

OOUI\FieldLayout::__construct (   $fieldWidget,
array  $config = [] 
)
Parameters
Widget$fieldWidgetField widget
array$configConfiguration options
  • string $config['align'] Alignment mode, either 'left', 'right', 'top' or 'inline' (default: 'left')
  • string[]|HtmlSnippet[] $config['errors'] Error messages about the widget.
  • string[]|HtmlSnippet[] $config['warnings'] Warning messages about the widget.
  • string[]|HtmlSnippet[] $config['notices'] Notices about the widget.
  • string|HtmlSnippet $config['help'] Explanatory text shown as a '?' icon, or inline.
  • bool $config['helpInline'] Whether or not the help should be inline, or shown when the "help" icon is clicked. (default: false)
Exceptions
ExceptionAn exception is thrown if no widget is specified

Member Function Documentation

◆ formatTitleWithAccessKey()

OOUI\FieldLayout::formatTitleWithAccessKey (   $title)
protected

Include information about the widget's accessKey in our title.

TitledElement calls this method. (This is a bit of a hack.)

Parameters
string$titleTooltip label for 'title' attribute
Returns
string

◆ getConfig()

OOUI\FieldLayout::getConfig ( $config)

Add the necessary properties to the given $config array to allow reconstruction of this widget via its constructor.

Parameters
array&$configAn 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 [].
Returns
array A configuration array which can be passed to this object's constructor to recreate it. This is a return value to allow the safe use of copy-by-value functions like array_merge in the implementation.

Reimplemented from OOUI\Element.

Reimplemented in OOUI\ActionFieldLayout.

◆ getField()

OOUI\FieldLayout::getField ( )

Get the field.

Returns
Widget Field widget

◆ isFieldInline()

OOUI\FieldLayout::isFieldInline ( )

Return true if the given field widget can be used with ‘'inline’alignment (see setAlignment()).

Returnfalse` if it can't or if this can't be determined.

Returns
bool

◆ setAlignment()

OOUI\FieldLayout::setAlignment (   $value)
protected

Set the field alignment mode.

Parameters
string$valueAlignment mode, either 'left', 'right', 'top' or 'inline'
Returns
$this

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