MediaWiki  master
PurgeAction Class Reference

User-requested page cache purging. More...

Inheritance diagram for PurgeAction:
Collaboration diagram for PurgeAction:

Public Member Functions

 doesWrites ()
 
 getDescription ()
 
 getName ()
 
 onSubmit ($data)
 
 onSuccess ()
 
 requiresUnblock ()
 
 show ()
 
- Public Member Functions inherited from FormAction
 doesWrites ()
 
 onSubmit ($data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form. More...
 
 show ()
 The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneath (history etc); to do some processing on submission of that form (delete, protect, etc) and to do something exciting on 'success', be that display something new or redirect to somewhere. More...
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Only public since 1.21. More...
 
 addHelpLink ($to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 doesWrites ()
 Indicates whether this action may perform database writes. More...
 
 getContext ()
 Get the IContextSource in use here. More...
 
 getLanguage ()
 Shortcut to get the user Language being used for this instance. More...
 
 getName ()
 Return the name of the action this object responds to. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission required to perform this action. More...
 
 getSkin ()
 Shortcut to get the Skin being used for this instance. More...
 
 getTitle ()
 Shortcut to get the Title object from the page. More...
 
 getUser ()
 Shortcut to get the User being used for this instance. More...
 
 msg ($key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 requiresUnblock ()
 Whether this action can still be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 
 show ()
 The main action entry point. More...
 

Protected Member Functions

 alterForm (HTMLForm $form)
 
 getFormFields ()
 
 postText ()
 
 usesOOUI ()
 
- Protected Member Functions inherited from FormAction
 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 postText ()
 
 preText ()
 Add pre- or post-text to the form. More...
 
 usesOOUI ()
 Whether the form should use OOUI. More...
 
- Protected Member Functions inherited from Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getDescription ()
 Returns the description that goes below the \<h1\> tag. More...
 
 getPageTitle ()
 Returns the name that goes in the \<h1\> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Private Attributes

 $redirectParams
 

Additional Inherited Members

- Static Public Member Functions inherited from Action
static exists ($name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory ($action, Page $page, IContextSource $context=null)
 Get an appropriate Action subclass for the given action. More...
 
static getActionName (IContextSource $context)
 Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter. More...
 
- Protected Attributes inherited from Action
 $context
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 
 $fields
 The fields used to create the HTMLForm. More...
 
 $page
 Page on which we're performing the action. More...
 

Detailed Description

User-requested page cache purging.

Definition at line 28 of file PurgeAction.php.

Member Function Documentation

PurgeAction::alterForm ( HTMLForm  $form)
protected

Definition at line 93 of file PurgeAction.php.

References HTMLForm\setSubmitTextMsg(), and HTMLForm\setWrapperLegendMsg().

PurgeAction::doesWrites ( )

Definition at line 106 of file PurgeAction.php.

PurgeAction::getDescription ( )

Definition at line 40 of file PurgeAction.php.

PurgeAction::getFormFields ( )
protected

Definition at line 82 of file PurgeAction.php.

References Action\msg().

PurgeAction::getName ( )

Definition at line 32 of file PurgeAction.php.

PurgeAction::onSubmit (   $data)

Definition at line 44 of file PurgeAction.php.

References page.

Referenced by show().

PurgeAction::onSuccess ( )

Definition at line 102 of file PurgeAction.php.

References Action\getOutput(), and Action\getTitle().

Referenced by show().

PurgeAction::postText ( )
protected

Definition at line 98 of file PurgeAction.php.

References Action\msg().

PurgeAction::requiresUnblock ( )

Definition at line 36 of file PurgeAction.php.

PurgeAction::usesOOUI ( )
protected

Definition at line 78 of file PurgeAction.php.

Member Data Documentation

PurgeAction::$redirectParams
private

Definition at line 30 of file PurgeAction.php.


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