MediaWiki  master
DataUpdate Class Reference

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

Inheritance diagram for DataUpdate:
Collaboration diagram for DataUpdate:

Public Member Functions

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

Static Public Member Functions

static runUpdates (array $updates)
 Convenience method, calls doUpdate() on every DataUpdate in the array. More...
 

Protected Attributes

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

Detailed Description

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

Definition at line 28 of file DataUpdate.php.

Constructor & Destructor Documentation

◆ __construct()

DataUpdate::__construct ( )

Definition at line 36 of file DataUpdate.php.

Member Function Documentation

◆ getCauseAction()

DataUpdate::getCauseAction ( )
Returns
string

Definition at line 60 of file DataUpdate.php.

References $causeAction.

Referenced by HTMLCacheUpdate\doUpdate(), LinksUpdate\getAsJobSpecification(), and LinksUpdate\queueRecursiveJobs().

◆ getCauseAgent()

DataUpdate::getCauseAgent ( )
Returns
string

Definition at line 67 of file DataUpdate.php.

References $causeAgent.

Referenced by HTMLCacheUpdate\doUpdate(), LinksUpdate\getAsJobSpecification(), and LinksUpdate\queueRecursiveJobs().

◆ runUpdates()

static DataUpdate::runUpdates ( array  $updates)
static

Convenience method, calls doUpdate() on every DataUpdate in the array.

Parameters
DataUpdate[]$updates A list of DataUpdate instances
Exceptions
Exception
Deprecated:
Since 1.28 Use DeferredUpdates::execute()

Definition at line 78 of file DataUpdate.php.

References as.

◆ setCause()

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

Definition at line 52 of file DataUpdate.php.

References $user.

◆ setTransactionTicket()

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

Definition at line 44 of file DataUpdate.php.

References $ticket.

Member Data Documentation

◆ $causeAction

string DataUpdate::$causeAction = 'unknown'
protected

Short update cause action description.

Definition at line 32 of file DataUpdate.php.

Referenced by HTMLCacheUpdate\__construct(), and getCauseAction().

◆ $causeAgent

string DataUpdate::$causeAgent = 'unknown'
protected

Short update cause user description.

Definition at line 34 of file DataUpdate.php.

Referenced by HTMLCacheUpdate\__construct(), and getCauseAgent().

◆ $ticket

mixed DataUpdate::$ticket
protected

Result from LBFactory::getEmptyTransactionTicket()

Definition at line 30 of file DataUpdate.php.

Referenced by setTransactionTicket().


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