1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
|
<?php
namespace MediaWiki\HTMLForm\Field;
use MediaWiki\Widget\TitlesMultiselectWidget;
/**
* Implements a tag multiselect input field for titles.
*
* Besides the parameters recognized by HTMLTitleTextField, additional recognized
* parameters are:
* default - (optional) Array of titles to use as preset data
* placeholder - (optional) Custom placeholder message for input
*
* The result is the array of titles
*
* This widget is a duplication of HTMLUsersMultiselectField, except for:
* - The configuration variable changed to 'titles' (from 'users')
* - OOUI modules were adjusted for the TitlesMultiselectWidget
* - The PHP version instantiates a MediaWiki\Widget\TitlesMultiselectWidget
*
* @stable to extend
* @note This widget is not likely to remain functional in non-OOUI forms.
*/
class HTMLTitlesMultiselectField extends HTMLTitleTextField {
/**
* @stable to call
* @inheritDoc
*/
public function __construct( $params ) {
$params += [
// This overrides the default from HTMLTitleTextField
'required' => false,
];
parent::__construct( $params );
}
public function loadDataFromRequest( $request ) {
$value = $request->getText( $this->mName, $this->getDefault() ?? '' );
$titlesArray = explode( "\n", $value );
// Remove empty lines
$titlesArray = array_values( array_filter( $titlesArray, static function ( $title ) {
return trim( $title ) !== '';
} ) );
// This function is expected to return a string
return implode( "\n", $titlesArray );
}
public function validate( $value, $alldata ) {
if ( !$this->mParams['exists'] ) {
return true;
}
if ( $value === null ) {
return false;
}
// $value is a string, because HTMLForm fields store their values as strings
$titlesArray = explode( "\n", $value );
if ( isset( $this->mParams['max'] ) && ( count( $titlesArray ) > $this->mParams['max'] ) ) {
return $this->msg( 'htmlform-multiselect-toomany', $this->mParams['max'] );
}
foreach ( $titlesArray as $title ) {
$result = parent::validate( $title, $alldata );
if ( $result !== true ) {
return $result;
}
}
return true;
}
public function getInputHTML( $value ) {
$this->mParent->getOutput()->enableOOUI();
return $this->getInputOOUI( $value );
}
public function getInputOOUI( $value ) {
$this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.TagMultiselectWidget.styles' );
$params = [
'id' => $this->mID,
'name' => $this->mName,
'dir' => $this->mDir,
];
if ( isset( $this->mParams['disabled'] ) ) {
$params['disabled'] = $this->mParams['disabled'];
}
if ( isset( $this->mParams['default'] ) ) {
$params['default'] = $this->mParams['default'];
}
$params['placeholder'] = $this->mParams['placeholder'] ??
$this->msg( 'mw-widgets-titlesmultiselect-placeholder' )->plain();
if ( isset( $this->mParams['max'] ) ) {
$params['tagLimit'] = $this->mParams['max'];
}
if ( isset( $this->mParams['showMissing'] ) ) {
$params['showMissing'] = $this->mParams['showMissing'];
}
if ( isset( $this->mParams['excludeDynamicNamespaces'] ) ) {
$params['excludeDynamicNamespaces'] = $this->mParams['excludeDynamicNamespaces'];
}
if ( isset( $this->mParams['allowEditTags'] ) ) {
$params['allowEditTags'] = $this->mParams['allowEditTags'];
}
if ( isset( $this->mParams['input'] ) ) {
$params['input'] = $this->mParams['input'];
}
if ( $value !== null ) {
// $value is a string, but the widget expects an array
$params['default'] = $value === '' ? [] : explode( "\n", $value );
}
// Make the field auto-infusable when it's used inside a legacy HTMLForm rather than OOUIHTMLForm
$params['infusable'] = true;
$params['classes'] = [ 'mw-htmlform-autoinfuse' ];
return $this->getInputWidget( $params );
}
/**
* @inheritDoc
*/
protected function getInputWidget( $params ) {
$widget = new TitlesMultiselectWidget( $params );
$widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
return $widget;
}
protected function shouldInfuseOOUI() {
return true;
}
protected function getOOUIModules() {
return [ 'mediawiki.widgets.TitlesMultiselectWidget' ];
}
public function getInputCodex( $value, $hasErrors ) {
// HTMLTextAreaField defaults to 'rows' => 25, which is too big for this field
// Use 10 instead (but allow $this->mParams to override that value)
$textAreaField = new HTMLTextAreaField( $this->mParams + [ 'rows' => 10 ] );
return $textAreaField->getInputCodex( $value, $hasErrors );
}
}
/** @deprecated class alias since 1.42 */
class_alias( HTMLTitlesMultiselectField::class, 'HTMLTitlesMultiselectField' );
|