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
|
<?php
namespace MediaWiki\HTMLForm\Field;
use MediaWiki\MediaWikiServices;
use MediaWiki\Widget\NamespacesMultiselectWidget;
/**
* Implements a tag multiselect input field for namespaces.
*
* The result is the array of namespaces
*
* TODO: This widget duplicates a lot from HTMLTitlesMultiselectField,
* which itself duplicates HTMLUsersMultiselectField. These classes
* should be refactored.
*
* @stable to extend
* @note This widget is not likely to remain functional in non-OOUI forms.
*/
class HTMLNamespacesMultiselectField extends HTMLSelectNamespace {
public function loadDataFromRequest( $request ) {
$value = $request->getText( $this->mName, $this->getDefault() ?? '' );
$namespaces = explode( "\n", $value );
// Remove empty lines
$namespaces = array_values( array_filter( $namespaces, static function ( $namespace ) {
return trim( $namespace ) !== '';
} ) );
// This function is expected to return a string
return implode( "\n", $namespaces );
}
public function validate( $value, $alldata ) {
if ( !$this->mParams['exists'] || $value === '' ) {
return true;
}
if ( $value === null ) {
return false;
}
// $value is a string, because HTMLForm fields store their values as strings
$namespaces = explode( "\n", $value );
if ( isset( $this->mParams['max'] ) && ( count( $namespaces ) > $this->mParams['max'] ) ) {
return $this->msg( 'htmlform-multiselect-toomany', $this->mParams['max'] );
}
foreach ( $namespaces as $namespace ) {
if (
$namespace < 0 ||
!MediaWikiServices::getInstance()->getNamespaceInfo()->exists( (int)$namespace )
) {
return $this->msg( 'htmlform-select-badoption' );
}
$result = parent::validate( $namespace, $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['input'] ) ) {
$params['input'] = $this->mParams['input'];
}
if ( isset( $this->mParams['allowEditTags'] ) ) {
$params['allowEditTags'] = $this->mParams['allowEditTags'];
}
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' ];
$widget = new NamespacesMultiselectWidget( $params );
$widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
return $widget;
}
protected function shouldInfuseOOUI() {
return true;
}
protected function getOOUIModules() {
return [ 'mediawiki.widgets.NamespacesMultiselectWidget' ];
}
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( HTMLNamespacesMultiselectField::class, 'HTMLNamespacesMultiselectField' );
|