MediaWiki  master
OOUIHTMLForm.php
Go to the documentation of this file.
1 <?php
2 
27 class OOUIHTMLForm extends HTMLForm {
28  private $oouiErrors;
29  private $oouiWarnings;
30 
31  public function __construct( $descriptor, $context = null, $messagePrefix = '' ) {
32  parent::__construct( $descriptor, $context, $messagePrefix );
33  $this->getOutput()->enableOOUI();
34  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.ooui.styles' );
35  }
36 
41  protected $displayFormat = 'ooui';
42 
43  public static function loadInputFromParameters( $fieldname, $descriptor,
44  HTMLForm $parent = null
45  ) {
46  $field = parent::loadInputFromParameters( $fieldname, $descriptor, $parent );
47  $field->setShowEmptyLabel( false );
48  return $field;
49  }
50 
51  public function getButtons() {
52  $buttons = '';
53 
54  // IE<8 has bugs with <button>, so we'll need to avoid them.
55  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
56 
57  if ( $this->mShowSubmit ) {
58  $attribs = [ 'infusable' => true ];
59 
60  if ( isset( $this->mSubmitID ) ) {
61  $attribs['id'] = $this->mSubmitID;
62  }
63 
64  if ( isset( $this->mSubmitName ) ) {
65  $attribs['name'] = $this->mSubmitName;
66  }
67 
68  if ( isset( $this->mSubmitTooltip ) ) {
69  $attribs += [
70  'title' => Linker::titleAttrib( $this->mSubmitTooltip ),
71  'accessKey' => Linker::accesskey( $this->mSubmitTooltip ),
72  ];
73  }
74 
75  $attribs['classes'] = [ 'mw-htmlform-submit' ];
76  $attribs['type'] = 'submit';
77  $attribs['label'] = $this->getSubmitText();
78  $attribs['value'] = $this->getSubmitText();
79  $attribs['flags'] = $this->mSubmitFlags;
80  $attribs['useInputTag'] = $isBadIE;
81 
82  $buttons .= new OOUI\ButtonInputWidget( $attribs );
83  }
84 
85  if ( $this->mShowReset ) {
86  $buttons .= new OOUI\ButtonInputWidget( [
87  'type' => 'reset',
88  'label' => $this->msg( 'htmlform-reset' )->text(),
89  'useInputTag' => $isBadIE,
90  ] );
91  }
92 
93  if ( $this->mShowCancel ) {
94  $target = $this->mCancelTarget ?: Title::newMainPage();
95  if ( $target instanceof Title ) {
96  $target = $target->getLocalURL();
97  }
98  $buttons .= new OOUI\ButtonWidget( [
99  'label' => $this->msg( 'cancel' )->text(),
100  'href' => $target,
101  ] );
102  }
103 
104  foreach ( $this->mButtons as $button ) {
105  $attrs = [];
106 
107  if ( $button['attribs'] ) {
108  $attrs += $button['attribs'];
109  }
110 
111  if ( isset( $button['id'] ) ) {
112  $attrs['id'] = $button['id'];
113  }
114 
115  if ( $isBadIE ) {
116  $label = $button['value'];
117  } elseif ( isset( $button['label-message'] ) ) {
118  $label = new OOUI\HtmlSnippet( $this->getMessage( $button['label-message'] )->parse() );
119  } elseif ( isset( $button['label'] ) ) {
120  $label = $button['label'];
121  } elseif ( isset( $button['label-raw'] ) ) {
122  $label = new OOUI\HtmlSnippet( $button['label-raw'] );
123  } else {
124  $label = $button['value'];
125  }
126 
127  $attrs['classes'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
128 
129  $buttons .= new OOUI\ButtonInputWidget( [
130  'type' => 'submit',
131  'name' => $button['name'],
132  'value' => $button['value'],
133  'label' => $label,
134  'flags' => $button['flags'],
135  'framed' => $button['framed'],
136  'useInputTag' => $isBadIE,
137  ] + $attrs );
138  }
139 
140  if ( !$buttons ) {
141  return '';
142  }
143 
144  return Html::rawElement( 'div',
145  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
146  }
147 
152  protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
153  // to get a user visible effect, wrap the fieldset into a framed panel layout
154  $layout = new OOUI\PanelLayout( [
155  'expanded' => false,
156  'padded' => true,
157  'framed' => true,
158  ] );
159 
160  $layout->appendContent(
161  new OOUI\FieldsetLayout( [
162  'label' => $legend,
163  'items' => [
164  new OOUI\Widget( [
165  'content' => new OOUI\HtmlSnippet( $section )
166  ] ),
167  ],
168  ] + $attributes )
169  );
170  return $layout;
171  }
172 
180  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
181  if ( !$fieldsHtml ) {
182  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
183  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
184  return '';
185  }
186 
187  $html = implode( '', $fieldsHtml );
188 
189  if ( $sectionName ) {
190  $html = Html::rawElement(
191  'div',
192  [ 'id' => Sanitizer::escapeIdForAttribute( $sectionName ) ],
193  $html
194  );
195  }
196  return $html;
197  }
198 
204  public function getErrorsOrWarnings( $elements, $elementsType ) {
205  if ( $elements === '' ) {
206  return '';
207  }
208 
209  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
210  throw new DomainException( $elementsType . ' is not a valid type.' );
211  }
212  $errors = [];
213  if ( $elements instanceof Status ) {
214  if ( !$elements->isGood() ) {
215  $errors = $elements->getErrorsByType( $elementsType );
216  foreach ( $errors as &$error ) {
217  // Input: [ 'message' => 'foo', 'errors' => [ 'a', 'b', 'c' ] ]
218  // Output: [ 'foo', 'a', 'b', 'c' ]
219  $error = array_merge( [ $error['message'] ], $error['params'] );
220  }
221  }
222  } elseif ( $elementsType === 'error' ) {
223  if ( is_array( $elements ) ) {
224  $errors = $elements;
225  } elseif ( is_string( $elements ) ) {
226  $errors = [ $elements ];
227  }
228  }
229 
230  foreach ( $errors as &$error ) {
231  $error = $this->getMessage( $error )->parse();
232  $error = new OOUI\HtmlSnippet( $error );
233  }
234 
235  // Used in formatFormHeader()
236  if ( $elementsType === 'error' ) {
237  $this->oouiErrors = $errors;
238  } else {
239  $this->oouiWarnings = $errors;
240  }
241  return '';
242  }
243 
244  public function getHeaderText( $section = null ) {
245  if ( $section === null ) {
246  // We handle $this->mHeader elsewhere, in getBody()
247  return '';
248  } else {
249  return parent::getHeaderText( $section );
250  }
251  }
252 
253  protected function formatFormHeader() {
254  if ( !( $this->mHeader || $this->oouiErrors || $this->oouiWarnings ) ) {
255  return '';
256  }
257  $classes = [ 'mw-htmlform-ooui-header' ];
258  if ( $this->oouiErrors ) {
259  $classes[] = 'mw-htmlform-ooui-header-errors';
260  }
261  if ( $this->oouiWarnings ) {
262  $classes[] = 'mw-htmlform-ooui-header-warnings';
263  }
264  // if there's no header, don't create an (empty) LabelWidget, simply use a placeholder
265  if ( $this->mHeader ) {
266  $element = new OOUI\LabelWidget( [ 'label' => new OOUI\HtmlSnippet( $this->mHeader ) ] );
267  } else {
268  $element = new OOUI\Widget( [] );
269  }
270  return new OOUI\FieldLayout(
271  $element,
272  [
273  'align' => 'top',
274  'errors' => $this->oouiErrors,
275  'notices' => $this->oouiWarnings,
276  'classes' => $classes,
277  ]
278  );
279  }
280 
281  public function getBody() {
282  $html = parent::getBody();
283  $html = $this->formatFormHeader() . $html;
284  return $html;
285  }
286 
287  public function wrapForm( $html ) {
288  if ( is_string( $this->mWrapperLegend ) ) {
289  $phpClass = $this->mCollapsible ? CollapsibleFieldsetLayout::class : OOUI\FieldsetLayout::class;
290  $content = new $phpClass( [
291  'label' => $this->mWrapperLegend,
292  'collapsed' => $this->mCollapsed,
293  'items' => [
294  new OOUI\Widget( [
295  'content' => new OOUI\HtmlSnippet( $html )
296  ] ),
297  ],
298  ] + OOUI\Element::configFromHtmlAttributes( $this->mWrapperAttributes ) );
299  } else {
300  $content = new OOUI\HtmlSnippet( $html );
301  }
302 
303  $classes = [ 'mw-htmlform', 'mw-htmlform-ooui' ];
304  $form = new OOUI\FormLayout( $this->getFormAttributes() + [
305  'classes' => $classes,
306  'content' => $content,
307  ] );
308 
309  // Include a wrapper for style, if requested.
310  $form = new OOUI\PanelLayout( [
311  'classes' => [ 'mw-htmlform-ooui-wrapper' ],
312  'expanded' => false,
313  'padded' => $this->mWrapperLegend !== false,
314  'framed' => $this->mWrapperLegend !== false,
315  'content' => $form,
316  ] );
317 
318  return $form;
319  }
320 }
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
true
return true
Definition: router.php:92
HTMLForm\$mSubmitID
$mSubmitID
Definition: HTMLForm.php:205
OOUIHTMLForm\formatSection
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields' HTML, merging it and wrapping.
Definition: OOUIHTMLForm.php:180
ContextSource\getRequest
getRequest()
Definition: ContextSource.php:71
Title\newMainPage
static newMainPage(MessageLocalizer $localizer=null)
Create a new Title for the Main Page.
Definition: Title.php:657
OOUIHTMLForm\getButtons
getButtons()
Get the submit and (potentially) reset buttons.
Definition: OOUIHTMLForm.php:51
OOUIHTMLForm\__construct
__construct( $descriptor, $context=null, $messagePrefix='')
Build a new HTMLForm from an array of field attributes.
Definition: OOUIHTMLForm.php:31
HTMLForm\$mSubmitName
$mSubmitName
Definition: HTMLForm.php:206
OOUIHTMLForm\getErrorsOrWarnings
getErrorsOrWarnings( $elements, $elementsType)
Definition: OOUIHTMLForm.php:204
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:42
OOUIHTMLForm
Compact stacked vertical format for forms, implemented using OOUI widgets.
Definition: OOUIHTMLForm.php:27
HTMLForm\$mSubmitFlags
string[] $mSubmitFlags
Definition: HTMLForm.php:188
ContextSource\getOutput
getOutput()
Definition: ContextSource.php:112
OOUIHTMLForm\wrapForm
wrapForm( $html)
Wrap the form innards in an actual "<form>" element.
Definition: OOUIHTMLForm.php:287
OOUIHTMLForm\formatFormHeader
formatFormHeader()
Definition: OOUIHTMLForm.php:253
OOUIHTMLForm\loadInputFromParameters
static loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent=null)
Initialise a new Object for the field.
Definition: OOUIHTMLForm.php:43
ContextSource\msg
msg( $key,... $params)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
HTMLForm\getFormAttributes
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1103
$content
$content
Definition: router.php:78
OOUIHTMLForm\$displayFormat
string $displayFormat
Symbolic display format name.
Definition: OOUIHTMLForm.php:41
Linker\titleAttrib
static titleAttrib( $name, $options=null, array $msgParams=[])
Given the id of an interface element, constructs the appropriate title attribute from the system mess...
Definition: Linker.php:2049
OOUIHTMLForm\$oouiErrors
$oouiErrors
Definition: OOUIHTMLForm.php:28
Title
Represents a title within MediaWiki.
Definition: Title.php:42
HTMLForm\getSubmitText
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1400
HTMLForm\getMessage
getMessage( $value)
Turns a *-message parameter (which could be a MessageSpecifier, or a message name,...
Definition: HTMLForm.php:1930
OOUIHTMLForm\$oouiWarnings
$oouiWarnings
Definition: OOUIHTMLForm.php:29
OOUIHTMLForm\getBody
getBody()
Get the whole body of the form.
Definition: OOUIHTMLForm.php:281
Linker\accesskey
static accesskey( $name)
Given the id of an interface element, constructs the appropriate accesskey attribute from the system ...
Definition: Linker.php:2097
OOUIHTMLForm\getHeaderText
getHeaderText( $section=null)
Get header text.
Definition: OOUIHTMLForm.php:244
OOUIHTMLForm\wrapFieldSetSection
wrapFieldSetSection( $legend, $section, $attributes, $isRoot)
Wraps the given $section into an user-visible fieldset.Legend text for the fieldset The section conte...
Definition: OOUIHTMLForm.php:152
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms in a reusabl...
Definition: HTMLForm.php:131