MediaWiki  1.23.0
PurgeAction Class Reference

User-requested page cache purging. More...

Inheritance diagram for PurgeAction:
Collaboration diagram for PurgeAction:

Public Member Functions

 getDescription ()
 Returns the description that goes below the <h1> tag. More...
 
 getName ()
 Return the name of the action this object responds to. More...
 
 onSubmit ( $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form. More...
 
 requiresUnblock ()
 Whether this action can still be executed by a blocked user. More...
 
 show ()
 purge is slightly weird because it can be either formed or formless depending on user permissions More...
 
- Public Member Functions inherited from FormAction
 execute (array $data=null, $captureErrors=true)
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Constructor. More...
 
 execute ()
 Execute the action in a silent fashion: do not display anything or release any errors. More...
 
 getContext ()
 Get the IContextSource in use here. More...
 
 getLang ()
 Shortcut to get the user Language being used for this instance. More...
 
 getLanguage ()
 Shortcut to get the user Language being used for this instance. 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 ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 

Protected Member Functions

 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 getFormFields ()
 Just get an empty form with a single submit button. More...
 
 postText ()
 
 preText ()
 Add pre- or post-text to the form. More...
 
- Protected Member Functions inherited from FormAction
 getForm ()
 Get the HTMLForm to control behavior. More...
 
- Protected Member Functions inherited from Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getPageTitle ()
 Returns the name that goes in the <h1> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. 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
IContextSource $context
 IContextSource if specified; otherwise we'll use the Context from the Page $context. More...
 
array $fields
 The fields used to create the HTMLForm $fields. More...
 
WikiPage Article ImagePage CategoryPage Page $page
 Page on which we're performing the action $page. More...
 

Detailed Description

User-requested page cache purging.

For users with 'purge', this will directly trigger the cache purging and for users without that right, it will show a confirmation form.

Definition at line 31 of file PurgeAction.php.

Member Function Documentation

◆ alterForm()

PurgeAction::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Parameters
HTMLForm$form

Reimplemented from FormAction.

Definition at line 86 of file PurgeAction.php.

References $form.

◆ getDescription()

PurgeAction::getDescription ( )

Returns the description that goes below the <h1> tag.

Returns
string

Reimplemented from Action.

Definition at line 43 of file PurgeAction.php.

◆ getFormFields()

PurgeAction::getFormFields ( )
protected

Just get an empty form with a single submit button.

Returns
array

Reimplemented from FormAction.

Definition at line 51 of file PurgeAction.php.

References array().

◆ getName()

PurgeAction::getName ( )

Return the name of the action this object responds to.

Returns
string Lowercase name

Reimplemented from Action.

Definition at line 35 of file PurgeAction.php.

◆ onSubmit()

PurgeAction::onSubmit (   $data)

Process the form on POST submission.

If you return false from getFormFields(), this will obviously never be reached. If you don't want to do anything with the form, just return false here

Parameters
array$data
Returns
bool|array True for success, false for didn't-try, array of errors on failure

Reimplemented from FormAction.

Definition at line 55 of file PurgeAction.php.

References page.

Referenced by show().

◆ onSuccess()

PurgeAction::onSuccess ( )

Do something exciting on successful processing of the form.

This might be to show a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit, protect, etc).

Reimplemented from FormAction.

Definition at line 98 of file PurgeAction.php.

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

Referenced by show().

◆ postText()

PurgeAction::postText ( )
protected
Returns
string

Reimplemented from FormAction.

Definition at line 94 of file PurgeAction.php.

References Action\msg().

◆ preText()

PurgeAction::preText ( )
protected

Add pre- or post-text to the form.

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

Reimplemented from FormAction.

Definition at line 90 of file PurgeAction.php.

References Action\msg().

◆ requiresUnblock()

PurgeAction::requiresUnblock ( )

Whether this action can still be executed by a blocked user.

Returns
bool

Reimplemented from Action.

Definition at line 39 of file PurgeAction.php.

◆ show()

PurgeAction::show ( )

purge is slightly weird because it can be either formed or formless depending on user permissions

Reimplemented from FormAction.

Definition at line 63 of file PurgeAction.php.

References $form, array(), Action\checkCanExecute(), FormAction\getForm(), Action\getRequest(), Action\getUser(), onSubmit(), onSuccess(), Action\setHeaders(), and wfArrayToCgi().

Member Data Documentation

◆ $redirectParams

PurgeAction::$redirectParams
private

Definition at line 33 of file PurgeAction.php.


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