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
|
<?php
namespace MediaWiki\HTMLForm\Field;
use MediaWiki\Widget\TagMultiselectWidget;
/**
* Implements a tag multiselect input field for arbitrary values.
*
* Besides the parameters recognized by HTMLTextField, additional recognized
* parameters are:
* allowArbitrary - (optional) Bool to allow arbitrary inputs
* allowedValues - (optional) Array of allowed values
*
* The result is the array of tags
*
* @stable to extend
* @note This widget is not likely to remain functional in non-OOUI forms.
*/
class HTMLTagMultiselectField extends HTMLTextField {
public function loadDataFromRequest( $request ) {
$value = $request->getText( $this->mName, $this->getDefault() ?? '' );
$tagsArray = explode( "\n", $value );
// Remove empty lines
$tagsArray = array_values( array_filter( $tagsArray, static function ( $tag ) {
return trim( $tag ) !== '';
} ) );
// Remove any duplicate tags
$uniqueTags = array_unique( $tagsArray );
// This function is expected to return a string
return implode( "\n", $uniqueTags );
}
public function validate( $value, $alldata ) {
if ( $value === null ) {
return false;
}
// $value is a string, because HTMLForm fields store their values as strings
$tagsArray = explode( "\n", $value );
if ( isset( $this->mParams['max'] ) && ( count( $tagsArray ) > $this->mParams['max'] ) ) {
return $this->msg( 'htmlform-multiselect-toomany', $this->mParams['max'] );
}
foreach ( $tagsArray as $tag ) {
$result = parent::validate( $tag, $alldata );
if ( $result !== true ) {
return $result;
}
if ( empty( $this->mParams['allowArbitrary'] ) && $tag ) {
$allowedValues = $this->mParams['allowedValues'] ?? [];
if ( !in_array( $tag, $allowedValues ) ) {
return $this->msg( 'htmlform-tag-not-allowed', $tag )->escaped();
}
}
}
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 = [ 'name' => $this->mName ];
if ( isset( $this->mParams['id'] ) ) {
$params['id'] = $this->mParams['id'];
}
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-tagmultiselect-placeholder' )->plain();
if ( isset( $this->mParams['max'] ) ) {
$params['tagLimit'] = $this->mParams['max'];
}
if ( isset( $this->mParams['allowArbitrary'] ) ) {
$params['allowArbitrary'] = $this->mParams['allowArbitrary'];
}
if ( isset( $this->mParams['allowedValues'] ) ) {
$params['allowedValues'] = $this->mParams['allowedValues'];
}
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 TagMultiselectWidget( $params );
$widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
return $widget;
}
protected function shouldInfuseOOUI() {
return true;
}
protected function getOOUIModules() {
return [ 'mediawiki.widgets.TagMultiselectWidget' ];
}
}
/** @deprecated class alias since 1.42 */
class_alias( HTMLTagMultiselectField::class, 'HTMLTagMultiselectField' );
|