BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
FormSpecialPage Class Reference
Inheritance diagram for FormSpecialPage:
Collaboration diagram for FormSpecialPage:

Public Member Functions

 onSubmit (array $data)
 
 onSuccess ()
 
 execute ($par)
 
 requiresWrite ()
 
 requiresUnblock ()
 
- Public Member Functions inherited from SpecialPage
 __construct ($name= '', $restriction= '', $listed=true, $function=false, $file= '', $includable=false)
 
 getName ()
 
 getRestriction ()
 
 isListed ()
 
 setListed ($listed)
 
 listed ($x=null)
 
 isIncludable ()
 
 maxIncludeCacheTime ()
 
 including ($x=null)
 
 getLocalName ()
 
 isExpensive ()
 
 isCached ()
 
 isRestricted ()
 
 userCanExecute (User $user)
 
 displayRestrictionError ()
 
 checkPermissions ()
 
 checkReadOnly ()
 
 requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
 
 prefixSearchSubpages ($search, $limit, $offset)
 
 setHeaders ()
 
 run ($subPage)
 
 execute ($subPage)
 
 outputHeader ($summaryMessageKey= '')
 
 getDescription ()
 
 getTitle ($subpage=false)
 
 getPageTitle ($subpage=false)
 
 setContext ($context)
 
 getContext ()
 
 getRequest ()
 
 getOutput ()
 
 getUser ()
 
 getSkin ()
 
 getLanguage ()
 
 getConfig ()
 
 getFullTitle ()
 
 msg ($key)
 
 addHelpLink ($to, $overrideBaseUrl=false)
 
 getFinalGroupName ()
 
 doesWrites ()
 
 getLinkRenderer ()
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 

Protected Member Functions

 getFormFields ()
 
 preText ()
 
 postText ()
 
 alterForm (HTMLForm $form)
 
 getMessagePrefix ()
 
 getDisplayFormat ()
 
 getForm ()
 
 setParameter ($par)
 
 checkExecutePermissions (User $user)
 
- Protected Member Functions inherited from SpecialPage
 getCacheTTL ()
 
 getLoginSecurityLevel ()
 
 checkLoginSecurityLevel ($level=null)
 
 getSubpagesForPrefixSearch ()
 
 prefixSearchString ($search, $limit, $offset)
 
 beforeExecute ($subPage)
 
 afterExecute ($subPage)
 
 getRobotPolicy ()
 
 addFeedLinks ($params)
 
 getGroupName ()
 
 useTransactionalTimeLimit ()
 

Protected Attributes

 $par = null
 
- Protected Attributes inherited from SpecialPage
 $mName
 
 $mRestriction
 
 $mIncluding
 
 $mIncludable
 
 $mContext
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getTitleFor ($name, $subpage=false, $fragment= '')
 
static getTitleValueFor ($name, $subpage=false, $fragment= '')
 
static getSafeTitleFor ($name, $subpage=false)
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ($search, $limit, array $subpages, $offset)
 

Detailed Description

Special page which uses an HTMLForm to handle processing. This is mostly a clone of FormAction. More special pages should be built this way; maybe this could be a new structure for SpecialPages.

Member Function Documentation

FormSpecialPage::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially

Parameters
HTMLForm$form
FormSpecialPage::checkExecutePermissions ( User  $user)
protected

Called from execute() to check if the given user can perform this action. Failures here must throw subclasses of ErrorPageError.

Parameters
User$user
Exceptions
UserBlockedError
FormSpecialPage::execute (   $par)

Basic SpecialPage workflow: get a form, send it to the user; get some data back,

Parameters
string$parSubpage string if one was specified
FormSpecialPage::getDisplayFormat ( )
protected

Get display format for the form. See HTMLForm documentation for available values.

Since
1.25
Returns
string
FormSpecialPage::getForm ( )
protected

Get the HTMLForm to control behavior

Returns
HTMLForm|null
FormSpecialPage::getFormFields ( )
abstractprotected

Get an HTMLForm descriptor array

Returns
array
FormSpecialPage::getMessagePrefix ( )
protected

Get message prefix for HTMLForm

Since
1.21
Returns
string
FormSpecialPage::onSubmit ( array  $data)
abstract

Process the form on POST submission.

Parameters
array$data
HTMLForm$form
Returns
bool|string|array|Status As documented for HTMLForm::trySubmit.
FormSpecialPage::onSuccess ( )

Do something exciting on successful processing of the form, most likely to show a confirmation message

Since
1.22 Default is to do nothing
FormSpecialPage::postText ( )
protected

Add post-text to the form

Returns
string HTML which will be sent to $form->addPostText()
FormSpecialPage::preText ( )
protected

Add pre-text to the form

Returns
string HTML which will be sent to $form->addPreText()
FormSpecialPage::requiresUnblock ( )

Whether this action cannot be executed by a blocked user

Returns
bool
FormSpecialPage::requiresWrite ( )

Whether this action requires the wiki not to be locked

Returns
bool
FormSpecialPage::setParameter (   $par)
protected

Maybe do something interesting with the subpage parameter

Parameters
string$par

The documentation for this class was generated from the following file: