MediaWiki  1.28.1
FormAction.php
Go to the documentation of this file.
1 <?php
28 abstract class FormAction extends Action {
29 
34  protected function getFormFields() {
35  // Default to an empty form with just a submit button
36  return [];
37  }
38 
43  protected function preText() {
44  return '';
45  }
46 
50  protected function postText() {
51  return '';
52  }
53 
58  protected function alterForm( HTMLForm $form ) {
59  }
60 
65  protected function getForm() {
66  $this->fields = $this->getFormFields();
67 
68  // Give hooks a chance to alter the form, adding extra fields or text etc
69  Hooks::run( 'ActionModifyFormFields', [ $this->getName(), &$this->fields, $this->page ] );
70 
71  $form = new HTMLForm( $this->fields, $this->getContext(), $this->getName() );
72  $form->setSubmitCallback( [ $this, 'onSubmit' ] );
73 
74  $title = $this->getTitle();
75  $form->setAction( $title->getLocalURL( [ 'action' => $this->getName() ] ) );
76  // Retain query parameters (uselang etc)
77  $params = array_diff_key(
78  $this->getRequest()->getQueryValues(),
79  [ 'action' => null, 'title' => null ]
80  );
81  if ( $params ) {
82  $form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
83  }
84 
85  $form->addPreText( $this->preText() );
86  $form->addPostText( $this->postText() );
87  $this->alterForm( $form );
88 
89  // Give hooks a chance to alter the form, adding extra fields or text etc
90  Hooks::run( 'ActionBeforeFormDisplay', [ $this->getName(), &$form, $this->page ] );
91 
92  return $form;
93  }
94 
103  abstract public function onSubmit( $data );
104 
110  abstract public function onSuccess();
111 
119  public function show() {
120  $this->setHeaders();
121 
122  // This will throw exceptions if there's a problem
123  $this->checkCanExecute( $this->getUser() );
124 
125  $form = $this->getForm();
126  if ( $form->show() ) {
127  $this->onSuccess();
128  }
129  }
130 
131  public function doesWrites() {
132  return true;
133  }
134 }
getForm()
Get the HTMLForm to control behavior.
Definition: FormAction.php:65
getTitle()
Shortcut to get the Title object from the page.
Definition: Action.php:246
getUser()
Shortcut to get the User being used for this instance.
Definition: Action.php:217
Actions are things which can be done to pages (edit, delete, rollback, etc).
Definition: Action.php:37
An action which shows a form and does something based on the input from the form. ...
Definition: FormAction.php:28
getName()
Return the name of the action this object responds to.
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
Definition: FormAction.php:58
show()
The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneat...
Definition: FormAction.php:119
$params
setHeaders()
Set output headers for noindexing etc.
Definition: Action.php:355
Object handling generic submission, CSRF protection, layout and other logic for UI forms...
Definition: HTMLForm.php:128
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
getContext()
Get the IContextSource in use here.
Definition: Action.php:178
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
onSubmit($data)
Process the form on POST submission.
checkCanExecute(User $user)
Checks if the given user (identified by an object) can perform this action.
Definition: Action.php:308
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
wfArrayToCgi($array1, $array2=null, $prefix= '')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
preText()
Add pre- or post-text to the form.
Definition: FormAction.php:43
onSuccess()
Do something exciting on successful processing of the form.
getRequest()
Get the WebRequest being used for this instance.
Definition: Action.php:197
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk page
Definition: hooks.txt:2491
getFormFields()
Get an HTMLForm descriptor array.
Definition: FormAction.php:34