MediaWiki  1.27.1
OOUIHTMLForm.php
Go to the documentation of this file.
1 <?php
2 
27 class OOUIHTMLForm extends HTMLForm {
28  private $oouiErrors;
29 
30  public function __construct( $descriptor, $context = null, $messagePrefix = '' ) {
31  parent::__construct( $descriptor, $context, $messagePrefix );
32  $this->getOutput()->enableOOUI();
33  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.ooui.styles' );
34  }
35 
40  protected $displayFormat = 'ooui';
41 
42  public static function loadInputFromParameters( $fieldname, $descriptor,
43  HTMLForm $parent = null
44  ) {
45  $field = parent::loadInputFromParameters( $fieldname, $descriptor, $parent );
46  $field->setShowEmptyLabel( false );
47  return $field;
48  }
49 
50  function getButtons() {
51  $buttons = '';
52 
53  // IE<8 has bugs with <button>, so we'll need to avoid them.
54  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
55 
56  if ( $this->mShowSubmit ) {
57  $attribs = [ 'infusable' => true ];
58 
59  if ( isset( $this->mSubmitID ) ) {
60  $attribs['id'] = $this->mSubmitID;
61  }
62 
63  if ( isset( $this->mSubmitName ) ) {
64  $attribs['name'] = $this->mSubmitName;
65  }
66 
67  if ( isset( $this->mSubmitTooltip ) ) {
68  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
69  }
70 
71  $attribs['classes'] = [ 'mw-htmlform-submit' ];
72  $attribs['type'] = 'submit';
73  $attribs['label'] = $this->getSubmitText();
74  $attribs['value'] = $this->getSubmitText();
75  $attribs['flags'] = $this->mSubmitFlags;
76  $attribs['useInputTag'] = $isBadIE;
77 
78  $buttons .= new OOUI\ButtonInputWidget( $attribs );
79  }
80 
81  if ( $this->mShowReset ) {
82  $buttons .= new OOUI\ButtonInputWidget( [
83  'type' => 'reset',
84  'label' => $this->msg( 'htmlform-reset' )->text(),
85  'useInputTag' => $isBadIE,
86  ] );
87  }
88 
89  foreach ( $this->mButtons as $button ) {
90  $attrs = [];
91 
92  if ( $button['attribs'] ) {
93  $attrs += $button['attribs'];
94  }
95 
96  if ( isset( $button['id'] ) ) {
97  $attrs['id'] = $button['id'];
98  }
99 
100  if ( $isBadIE ) {
101  $label = $button['value'];
102  } elseif ( isset( $button['label-message'] ) ) {
103  $label = new OOUI\HtmlSnippet( $this->getMessage( $button['label-message'] )->parse() );
104  } elseif ( isset( $button['label'] ) ) {
105  $label = $button['label'];
106  } elseif ( isset( $button['label-raw'] ) ) {
107  $label = new OOUI\HtmlSnippet( $button['label-raw'] );
108  } else {
109  $label = $button['value'];
110  }
111 
112  $attrs['classes'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
113 
114  $buttons .= new OOUI\ButtonInputWidget( [
115  'type' => 'submit',
116  'name' => $button['name'],
117  'value' => $button['value'],
118  'label' => $label,
119  'flags' => $button['flags'],
120  'useInputTag' => $isBadIE,
121  ] + $attrs );
122  }
123 
124  if ( !$buttons ) {
125  return '';
126  }
127 
128  return Html::rawElement( 'div',
129  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
130  }
131 
132  protected function wrapFieldSetSection( $legend, $section, $attributes ) {
133  // to get a user visible effect, wrap the fieldset into a framed panel layout
134  $layout = new OOUI\PanelLayout( [
135  'expanded' => false,
136  'padded' => true,
137  'framed' => true,
138  'infusable' => false,
139  ] );
140 
141  $layout->appendContent(
142  new OOUI\FieldsetLayout( [
143  'label' => $legend,
144  'infusable' => false,
145  'items' => [
146  new OOUI\Widget( [
147  'content' => new OOUI\HtmlSnippet( $section )
148  ] ),
149  ],
150  ] + $attributes )
151  );
152  return $layout;
153  }
154 
162  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
163  $config = [
164  'items' => $fieldsHtml,
165  ];
166  if ( $sectionName ) {
167  $config['id'] = Sanitizer::escapeId( $sectionName );
168  }
169  if ( is_string( $this->mWrapperLegend ) ) {
170  $config['label'] = $this->mWrapperLegend;
171  }
172  return new OOUI\FieldsetLayout( $config );
173  }
174 
179  function getErrors( $err ) {
180  if ( !$err ) {
181  $errors = [];
182  } elseif ( $err instanceof Status ) {
183  if ( $err->isOK() ) {
184  $errors = [];
185  } else {
186  $errors = $err->getErrorsByType( 'error' );
187  foreach ( $errors as &$error ) {
188  // Input: array( 'message' => 'foo', 'errors' => array( 'a', 'b', 'c' ) )
189  // Output: array( 'foo', 'a', 'b', 'c' )
190  $error = array_merge( [ $error['message'] ], $error['params'] );
191  }
192  }
193  } else {
194  $errors = $err;
195  if ( !is_array( $errors ) ) {
196  $errors = [ $errors ];
197  }
198  }
199 
200  foreach ( $errors as &$error ) {
201  $error = $this->getMessage( $error )->parse();
202  $error = new OOUI\HtmlSnippet( $error );
203  }
204 
205  // Used in getBody()
206  $this->oouiErrors = $errors;
207  return '';
208  }
209 
210  function getHeaderText( $section = null ) {
211  if ( is_null( $section ) ) {
212  // We handle $this->mHeader elsewhere, in getBody()
213  return '';
214  } else {
215  return parent::getHeaderText( $section );
216  }
217  }
218 
219  function getBody() {
220  $fieldset = parent::getBody();
221  // FIXME This only works for forms with no subsections
222  if ( $fieldset instanceof OOUI\FieldsetLayout ) {
223  $classes = [ 'mw-htmlform-ooui-header' ];
224  if ( !$this->mHeader ) {
225  $classes[] = 'mw-htmlform-ooui-header-empty';
226  }
227  if ( $this->oouiErrors ) {
228  $classes[] = 'mw-htmlform-ooui-header-errors';
229  }
230  $fieldset->addItems( [
231  new OOUI\FieldLayout(
232  new OOUI\LabelWidget( [ 'label' => new OOUI\HtmlSnippet( $this->mHeader ) ] ),
233  [
234  'align' => 'top',
235  'errors' => $this->oouiErrors,
236  'classes' => $classes,
237  ]
238  )
239  ], 0 );
240  }
241  return $fieldset;
242  }
243 
244  function wrapForm( $html ) {
245  $form = new OOUI\FormLayout( $this->getFormAttributes() + [
246  'classes' => [ 'mw-htmlform-ooui' ],
247  'content' => new OOUI\HtmlSnippet( $html ),
248  ] );
249 
250  // Include a wrapper for style, if requested.
251  $form = new OOUI\PanelLayout( [
252  'classes' => [ 'mw-htmlform-ooui-wrapper' ],
253  'expanded' => false,
254  'padded' => $this->mWrapperLegend !== false,
255  'framed' => $this->mWrapperLegend !== false,
256  'content' => $form,
257  ] );
258 
259  return $form;
260  }
261 }
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:1798
the array() calling protocol came about after MediaWiki 1.4rc1.
$mWrapperLegend
Definition: HTMLForm.php:213
__construct($descriptor, $context=null, $messagePrefix= '')
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:210
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:1728
string $displayFormat
Symbolic display format name.
getHeaderText($section=null)
IContextSource $context
static tooltipAndAccesskeyAttribs($name, array $msgParams=[])
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2335
getRequest()
Get the WebRequest object.
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:1798
msg()
Get a Message object with context set Parameters are the same as wfMessage()
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields' HTML, merging it and wrapping.
wrapFieldSetSection($legend, $section, $attributes)
getFormAttributes()
Get HTML attributes for the
tag.
Definition: HTMLForm.php:991
Object handling generic submission, CSRF protection, layout and other logic for UI forms...
Definition: HTMLForm.php:123
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1263
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
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:2715
static escapeId($id, $options=[])
Given a value, escape it so that it can be used in an id attribute and return it. ...
Definition: Sanitizer.php:1131
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
static loadInputFromParameters($fieldname, $descriptor, HTMLForm $parent=null)
Compact stacked vertical format for forms, implemented using OOUI widgets.
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:1798
getOutput()
Get the OutputPage object.