MediaWiki  REL1_31
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 usesOOUI() {
66  return false;
67  }
68 
73  protected function getForm() {
74  $this->fields = $this->getFormFields();
75 
76  // Give hooks a chance to alter the form, adding extra fields or text etc
77  Hooks::run( 'ActionModifyFormFields', [ $this->getName(), &$this->fields, $this->page ] );
78 
79  if ( $this->usesOOUI() ) {
80  $form = HTMLForm::factory( 'ooui', $this->fields, $this->getContext(), $this->getName() );
81  } else {
82  $form = new HTMLForm( $this->fields, $this->getContext(), $this->getName() );
83  }
84  $form->setSubmitCallback( [ $this, 'onSubmit' ] );
85 
86  $title = $this->getTitle();
87  $form->setAction( $title->getLocalURL( [ 'action' => $this->getName() ] ) );
88  // Retain query parameters (uselang etc)
89  $params = array_diff_key(
90  $this->getRequest()->getQueryValues(),
91  [ 'action' => null, 'title' => null ]
92  );
93  if ( $params ) {
94  $form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
95  }
96 
97  $form->addPreText( $this->preText() );
98  $form->addPostText( $this->postText() );
99  $this->alterForm( $form );
100 
101  // Give hooks a chance to alter the form, adding extra fields or text etc
102  Hooks::run( 'ActionBeforeFormDisplay', [ $this->getName(), &$form, $this->page ] );
103 
104  return $form;
105  }
106 
115  abstract public function onSubmit( $data );
116 
122  abstract public function onSuccess();
123 
131  public function show() {
132  $this->setHeaders();
133 
134  // This will throw exceptions if there's a problem
135  $this->checkCanExecute( $this->getUser() );
136 
137  $form = $this->getForm();
138  if ( $form->show() ) {
139  $this->onSuccess();
140  }
141  }
142 
143  public function doesWrites() {
144  return true;
145  }
146 }
Action\setHeaders
setHeaders()
Set output headers for noindexing etc.
Definition: Action.php:353
Action\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: Action.php:197
FormAction\usesOOUI
usesOOUI()
Whether the form should use OOUI.
Definition: FormAction.php:65
FormAction
An action which shows a form and does something based on the input from the form.
Definition: FormAction.php:28
Action\getName
getName()
Return the name of the action this object responds to.
$params
$params
Definition: styleTest.css.php:40
FormAction\postText
postText()
Definition: FormAction.php:50
FormAction\onSubmit
onSubmit( $data)
Process the form on POST submission.
page
target page
Definition: All_system_messages.txt:1267
FormAction\preText
preText()
Add pre- or post-text to the form.
Definition: FormAction.php:43
php
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:37
Action
Actions are things which can be done to pages (edit, delete, rollback, etc).
Definition: Action.php:37
FormAction\onSuccess
onSuccess()
Do something exciting on successful processing of the form.
Action\getContext
getContext()
Get the IContextSource in use here.
Definition: Action.php:178
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:279
Action\checkCanExecute
checkCanExecute(User $user)
Checks if the given user (identified by an object) can perform this action.
Definition: Action.php:306
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
FormAction\getFormFields
getFormFields()
Get an HTMLForm descriptor array.
Definition: FormAction.php:34
FormAction\getForm
getForm()
Get the HTMLForm to control behavior.
Definition: FormAction.php:73
Action\getUser
getUser()
Shortcut to get the User being used for this instance.
Definition: Action.php:217
Action\getTitle
getTitle()
Shortcut to get the Title object from the page.
Definition: Action.php:246
FormAction\alterForm
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
Definition: FormAction.php:58
FormAction\doesWrites
doesWrites()
Indicates whether this action may perform database writes.
Definition: FormAction.php:143
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
FormAction\show
show()
The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneat...
Definition: FormAction.php:131
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130
wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition: GlobalFunctions.php:377