wiki.techinc.nl/includes/htmlform/HTMLFormElement.php
Bartosz Dziewoński 6a366c3300 HTMLForm: Refactor loading of modules required to infuse fields
Rather than have a master list in autoinfuse.js (duplicated in
hide-if.js), we put this information in each field class and put it
in the generated HTML as a separate 'data-' attribute. This also
allows new fields defined by extensions to be correctly autoinfused.

Change-Id: I3da75706209cbc16b19cc3f02b355e58ca75fec9
2016-08-22 17:35:35 +00:00

65 lines
1.9 KiB
PHP

<?php
/**
* Allows custom data specific to HTMLFormField to be set for OOjs UI forms. A matching JS widget
* (defined in htmlform.Element.js) picks up the extra config when constructed using OO.ui.infuse().
*
* Currently only supports passing 'hide-if' data.
*/
trait HTMLFormElement {
protected $hideIf = null;
protected $modules = null;
public function initializeHTMLFormElement( array $config = [] ) {
// Properties
$this->hideIf = isset( $config['hideIf'] ) ? $config['hideIf'] : null;
$this->modules = isset( $config['modules'] ) ? $config['modules'] : [];
// Initialization
if ( $this->hideIf ) {
$this->addClasses( [ 'mw-htmlform-hide-if' ] );
}
if ( $this->modules ) {
// JS code must be able to read this before infusing (before OOjs UI is even loaded),
// so we put this in a separate attribute (not with the rest of the config).
// And it's not needed anymore after infusing, so we don't put it in JS config at all.
$this->setAttributes( [ 'data-mw-modules' => implode( ',', $this->modules ) ] );
}
$this->registerConfigCallback( function( &$config ) {
if ( $this->hideIf !== null ) {
$config['hideIf'] = $this->hideIf;
}
} );
}
}
class HTMLFormFieldLayout extends OOUI\FieldLayout {
use HTMLFormElement;
public function __construct( $fieldWidget, array $config = [] ) {
// Parent constructor
parent::__construct( $fieldWidget, $config );
// Traits
$this->initializeHTMLFormElement( $config );
}
protected function getJavaScriptClassName() {
return 'mw.htmlform.FieldLayout';
}
}
class HTMLFormActionFieldLayout extends OOUI\ActionFieldLayout {
use HTMLFormElement;
public function __construct( $fieldWidget, $buttonWidget = false, array $config = [] ) {
// Parent constructor
parent::__construct( $fieldWidget, $buttonWidget, $config );
// Traits
$this->initializeHTMLFormElement( $config );
}
protected function getJavaScriptClassName() {
return 'mw.htmlform.ActionFieldLayout';
}
}