[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/specialpage/ -> FormSpecialPage.php (summary)

Special page which uses an HTMLForm to handle processing. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 193 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 11 functions

  preText()
  postText()
  alterForm()
  getMessagePrefix()
  getForm()
  onSuccess()
  execute()
  setParameter()
  checkExecutePermissions()
  requiresWrite()
  requiresUnblock()

Functions
Functions that are not part of a class:

preText()   X-Ref
Add pre-text to the form

return: string HTML which will be sent to $form->addPreText()

postText()   X-Ref
Add post-text to the form

return: string HTML which will be sent to $form->addPostText()

alterForm( HTMLForm $form )   X-Ref
Play with the HTMLForm if you need to more substantially

param: HTMLForm $form

getMessagePrefix()   X-Ref
Get message prefix for HTMLForm

return: string

getForm()   X-Ref
Get the HTMLForm to control behavior

return: HTMLForm|null

onSuccess()   X-Ref
Do something exciting on successful processing of the form, most likely to show a
confirmation message


execute( $par )   X-Ref
Basic SpecialPage workflow: get a form, send it to the user; get some data back,

param: string $par Subpage string if one was specified

setParameter( $par )   X-Ref
Maybe do something interesting with the subpage parameter

param: string $par

checkExecutePermissions( User $user )   X-Ref
Called from execute() to check if the given user can perform this action.
Failures here must throw subclasses of ErrorPageError.

param: User $user
return: bool True

requiresWrite()   X-Ref
Whether this action requires the wiki not to be locked

return: bool

requiresUnblock()   X-Ref
Whether this action cannot be executed by a blocked user

return: bool



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1