MediaWiki master
MediaWiki\Deferred\DataUpdate Class Reference

Abstract base class for update jobs that do something with some secondary data extracted from article. More...

Inherits MediaWiki\Deferred\DeferrableUpdate.

Inherited by MediaWiki\Deferred\LinksUpdate\LinksUpdate, and RefreshSecondaryDataUpdate.

Collaboration diagram for MediaWiki\Deferred\DataUpdate:

Public Member Functions

 __construct ()
 
 getCauseAction ()
 
 getCauseAgent ()
 
 setCause ( $action, $user)
 
 setTransactionTicket ( $ticket)
 
- Public Member Functions inherited from MediaWiki\Deferred\DeferrableUpdate
 doUpdate ()
 Perform the actual work.
 

Protected Attributes

string $causeAction = 'unknown'
 Short update cause action description.
 
string $causeAgent = 'unknown'
 Short update cause user description.
 
mixed $ticket
 Result from LBFactory::getEmptyTransactionTicket()
 

Detailed Description

Abstract base class for update jobs that do something with some secondary data extracted from article.

Stability: stable
to extend

Definition at line 32 of file DataUpdate.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Deferred\DataUpdate::__construct ( )
Stability: stable
to call

Definition at line 43 of file DataUpdate.php.

Member Function Documentation

◆ getCauseAction()

MediaWiki\Deferred\DataUpdate::getCauseAction ( )

◆ getCauseAgent()

MediaWiki\Deferred\DataUpdate::getCauseAgent ( )

◆ setCause()

MediaWiki\Deferred\DataUpdate::setCause (   $action,
  $user 
)
Parameters
string$actionAction type
string$userUser name

Definition at line 59 of file DataUpdate.php.

◆ setTransactionTicket()

MediaWiki\Deferred\DataUpdate::setTransactionTicket (   $ticket)
Parameters
mixed$ticketResult of getEmptyTransactionTicket()
Since
1.28

Reimplemented in MediaWiki\Deferred\LinksUpdate\LinksUpdate.

Definition at line 51 of file DataUpdate.php.

References MediaWiki\Deferred\DataUpdate\$ticket.

Member Data Documentation

◆ $causeAction

string MediaWiki\Deferred\DataUpdate::$causeAction = 'unknown'
protected

Short update cause action description.

Definition at line 36 of file DataUpdate.php.

Referenced by MediaWiki\Deferred\DataUpdate\getCauseAction().

◆ $causeAgent

string MediaWiki\Deferred\DataUpdate::$causeAgent = 'unknown'
protected

Short update cause user description.

Definition at line 38 of file DataUpdate.php.

Referenced by MediaWiki\Deferred\DataUpdate\getCauseAgent().

◆ $ticket

mixed MediaWiki\Deferred\DataUpdate::$ticket
protected

Result from LBFactory::getEmptyTransactionTicket()

Definition at line 34 of file DataUpdate.php.

Referenced by MediaWiki\Deferred\DataUpdate\setTransactionTicket(), and MediaWiki\Deferred\LinksUpdate\LinksUpdate\setTransactionTicket().


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