DataUpdate Class Reference

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

Inherits DeferrableUpdate.

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

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.

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 30 of file DataUpdate.php.

Constructor & Destructor Documentation

__construct()

DataUpdate::__construct

(

)

Stability: stable

to call

Definition at line 41 of file DataUpdate.php.

Member Function Documentation

getCauseAction()

DataUpdate::getCauseAction

(

)

Returns

string

Definition at line 65 of file DataUpdate.php.

Referenced by RefreshSecondaryDataUpdate\getAsJobSpecification(), and MediaWiki\Deferred\LinksUpdate\LinksUpdate\queueRecursiveJobs().

getCauseAgent()

DataUpdate::getCauseAgent

(

)

Returns

string

Definition at line 72 of file DataUpdate.php.

Referenced by RefreshSecondaryDataUpdate\getAsJobSpecification(), and MediaWiki\Deferred\LinksUpdate\LinksUpdate\queueRecursiveJobs().

setCause()

DataUpdate::setCause	(		$action,
			$user )

Parameters

string	$action	Action type
string	$user	User name

Definition at line 57 of file DataUpdate.php.

setTransactionTicket()

DataUpdate::setTransactionTicket

(

$ticket

)

Parameters

mixed

$ticket

Result of getEmptyTransactionTicket()

Since

1.28

Reimplemented in MediaWiki\Deferred\LinksUpdate\LinksUpdate.

Definition at line 49 of file DataUpdate.php.

Member Data Documentation

$causeAction

string DataUpdate::$causeAction = 'unknown'

protected

Short update cause action description.

Definition at line 34 of file DataUpdate.php.

$causeAgent

string DataUpdate::$causeAgent = 'unknown'

protected

Short update cause user description.

Definition at line 36 of file DataUpdate.php.

$ticket

mixed DataUpdate::$ticket

protected

Result from LBFactory::getEmptyTransactionTicket()

Definition at line 32 of file DataUpdate.php.

Referenced by MediaWiki\Deferred\LinksUpdate\LinksUpdate\setTransactionTicket().

---

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

• includes/deferred/DataUpdate.php