100 return strtolower( $this->
getName() );
119 $onSubmit = [ $this,
'onSubmit' ];
121 if ( $this->reauthPostData ) {
126 $oldRequest, $this->reauthPostData + $oldRequest->getQueryValues(),
true
131 $onSubmit =
static function () {
136 $form = HTMLForm::factory(
142 $form->setSubmitCallback( $onSubmit );
150 if ( !$headerMsg->isDisabled() ) {
151 $form->addHeaderText( $headerMsg->parseAsBlock() );
156 $form->addPreText( $this->
preText() );
157 $form->addPostText( $this->
postText() );
159 if ( $form->getMethod() ==
'post' ) {
161 $params = array_diff_key(
162 $this->
getRequest()->getQueryValues(), [
'title' =>
null ] );
163 $form->addHiddenField(
'redirectparams',
wfArrayToCgi( $params ) );
209 if ( $form->show() ) {
233 if ( $block && $block->isSitewide() ) {
271 $this->reauthPostData = $data;
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
An IContextSource implementation which will inherit context from another source but allow individual ...
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
Special page which uses an HTMLForm to handle processing.
string null $par
The sub-page of the special page.
array null $reauthPostData
POST data preserved across re-authentication.
getMessagePrefix()
Get message prefix for HTMLForm.
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
getForm()
Get the HTMLForm to control behavior.
preText()
Add pre-text to the form.
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
postText()
Add post-text to the form.
getDisplayFormat()
Get display format for the form.
preHtml()
Add pre-HTML to the form.
onSubmit(array $data)
Process the form on POST submission.
setReauthPostData(array $data)
Preserve POST data across reauthentication.
checkExecutePermissions(User $user)
Called from execute() to check if the given user can perform this action.
requiresUnblock()
Whether this action cannot be executed by a blocked user.
postHtml()
Add post-HTML to the form.
getFormFields()
Get an HTMLForm descriptor array.
setParameter( $par)
Maybe do something interesting with the subpage parameter.
requiresWrite()
Whether this action requires the wiki not to be locked.
execute( $par)
Basic SpecialPage workflow: get a form, send it to the user; get some data back,.
Parent class for all special pages.
getName()
Get the name of this Special Page.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
checkLoginSecurityLevel( $level=null)
Verifies that the user meets the security level, possibly reauthenticating them in the process.
getUser()
Shortcut to get the User executing this instance.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
getContext()
Gets the context this SpecialPage is executed in.
msg( $key,... $params)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
getLanguage()
Shortcut to get user's language.
getLoginSecurityLevel()
Tells if the special page does something security-sensitive and needs extra defense against a stolen ...
Show an error when the user tries to do something whilst blocked.
getBlock( $freshness=self::READ_NORMAL, $disableIpBlockExemptChecking=false)
Get the block affecting the user, or null if the user is not blocked.