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,
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 ) {
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 getBody()
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 ( is_null( $section ) ) {
246  // We handle $this->mHeader elsewhere, in getBody()
247  return '';
248  } else {
249  return parent::getHeaderText( $section );
250  }
251  }
252 
253  public function getBody() {
254  $html = parent::getBody();
255  if ( $this->mHeader || $this->oouiErrors || $this->oouiWarnings ) {
256  $classes = [ 'mw-htmlform-ooui-header' ];
257  if ( $this->oouiErrors ) {
258  $classes[] = 'mw-htmlform-ooui-header-errors';
259  }
260  if ( $this->oouiWarnings ) {
261  $classes[] = 'mw-htmlform-ooui-header-warnings';
262  }
263  // if there's no header, don't create an (empty) LabelWidget, simply use a placeholder
264  if ( $this->mHeader ) {
265  $element = new OOUI\LabelWidget( [ 'label' => new OOUI\HtmlSnippet( $this->mHeader ) ] );
266  } else {
267  $element = new OOUI\Widget( [] );
268  }
269  $html = new OOUI\FieldLayout(
270  $element,
271  [
272  'align' => 'top',
273  'errors' => $this->oouiErrors,
274  'notices' => $this->oouiWarnings,
275  'classes' => $classes,
276  ]
277  ) . $html;
278  }
279  return $html;
280  }
281 
282  public function wrapForm( $html ) {
283  if ( is_string( $this->mWrapperLegend ) ) {
284  $classes = $this->mCollapsible ? [ 'mw-collapsible' ] : [];
285  if ( $this->mCollapsed ) {
286  $classes[] = 'mw-collapsed';
287  }
288  $content = new OOUI\FieldsetLayout( [
289  'label' => $this->mWrapperLegend,
290  'classes' => $classes,
291  'group' => new OOUI\StackLayout( [
292  'expanded' => false,
293  'classes' => [ 'mw-collapsible-content' ],
294  ] ),
295  'items' => [
296  new OOUI\Widget( [
297  'content' => new OOUI\HtmlSnippet( $html )
298  ] ),
299  ],
300  ] + OOUI\Element::configFromHtmlAttributes( $this->mWrapperAttributes ) );
301  } else {
302  $content = new OOUI\HtmlSnippet( $html );
303  }
304 
305  $classes = [ 'mw-htmlform', 'mw-htmlform-ooui' ];
306  $form = new OOUI\FormLayout( $this->getFormAttributes() + [
307  'classes' => $classes,
308  'content' => $content,
309  ] );
310 
311  // Include a wrapper for style, if requested.
312  $form = new OOUI\PanelLayout( [
313  'classes' => [ 'mw-htmlform-ooui-wrapper' ],
314  'expanded' => false,
315  'padded' => $this->mWrapperLegend !== false,
316  'framed' => $this->mWrapperLegend !== false,
317  'content' => $form,
318  ] );
319 
320  return $form;
321  }
322 }
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1982
getHeaderText( $section=null)
static newMainPage(MessageLocalizer $localizer=null)
Create a new Title for the Main Page.
Definition: Title.php:653
getErrorsOrWarnings( $elements, $elementsType)
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
static accesskey( $name)
Given the id of an interface element, constructs the appropriate accesskey attribute from the system ...
Definition: Linker.php:2069
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
string $displayFormat
Symbolic display format name.
IContextSource $context
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1982
static loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent=null)
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields&#39; HTML, merging it and wrapping.
getMessage( $value)
Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.
Definition: HTMLForm.php:1910
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:2021
static escapeIdForAttribute( $id, $mode=self::ID_PRIMARY)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid HTM...
Definition: Sanitizer.php:1295
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1078
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1982
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1380
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
wrapForm( $html)
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3051
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$parent
Definition: pageupdater.txt:71
Compact stacked vertical format for forms, implemented using OOUI widgets.
__construct( $descriptor, $context=null, $messagePrefix='')
$content
Definition: pageupdater.txt:72
wrapFieldSetSection( $legend, $section, $attributes, $isRoot)