aed646001c
Add doc-typehints to class properties found by the PropertyDocumentation sniff to improve the documentation. Once the sniff is enabled it avoids that new code is missing type declarations. This is focused on documentation and does not change code. Change-Id: I1f306a3925d6768209a06e70082598b2f70cd319
42 lines
1.3 KiB
PHP
42 lines
1.3 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\HTMLForm;
|
|
|
|
/**
|
|
* Allows custom data specific to HTMLFormField to be set for OOUI 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' and 'disable-if' data.
|
|
* @phan-file-suppress PhanUndeclaredMethod
|
|
*
|
|
* @stable to extend
|
|
*/
|
|
trait HTMLFormElement {
|
|
|
|
/** @var array|null */
|
|
protected $condState = null;
|
|
/** @var array|null */
|
|
protected $modules = null;
|
|
|
|
public function initializeHTMLFormElement( array $config = [] ) {
|
|
// Properties
|
|
$this->condState = $config['condState'] ?? [];
|
|
$this->modules = $config['modules'] ?? [];
|
|
|
|
// Initialization
|
|
if ( $this->modules ) {
|
|
// JS code must be able to read this before infusing (before OOUI 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->condState ) {
|
|
$config['condState'] = $this->condState;
|
|
}
|
|
} );
|
|
}
|
|
}
|
|
|
|
/** @deprecated class alias since 1.42 */
|
|
class_alias( HTMLFormElement::class, 'HTMLFormElement' );
|