MediaWiki master
MediaWiki\Deferred\RefreshSecondaryDataUpdate Class Reference

Update object handling the cleanup of secondary data after a page was edited. More...

Inherits MediaWiki\Deferred\DataUpdate, MediaWiki\Deferred\TransactionRoundAwareUpdate, and MediaWiki\Deferred\EnqueueableDataUpdate.

Collaboration diagram for MediaWiki\Deferred\RefreshSecondaryDataUpdate:

Public Member Functions

 __construct (ILBFactory $lbFactory, UserIdentity $user, WikiPage $page, RevisionRecord $revisionRecord, DerivedPageDataUpdater $updater, array $options)
 
 doUpdate ()
 Perform the actual work.
 
 getAsJobSpecification ()
 
 getTransactionRoundRequirement ()
 
- Public Member Functions inherited from MediaWiki\Deferred\DataUpdate
 __construct ()
 
 getCauseAction ()
 
 getCauseAgent ()
 
 setCause ( $action, $user)
 
 setTransactionTicket ( $ticket)
 

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Deferred\DataUpdate
string $causeAction = 'unknown'
 Short update cause action description.
 
string $causeAgent = 'unknown'
 Short update cause user description.
 
mixed $ticket
 Result from LBFactory::getEmptyTransactionTicket()
 

Detailed Description

Update object handling the cleanup of secondary data after a page was edited.

This makes it possible for DeferredUpdates to have retry logic using a single refreshLinks job if any of the bundled updates fail.

Since
1.34

Definition at line 43 of file RefreshSecondaryDataUpdate.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Deferred\RefreshSecondaryDataUpdate::__construct ( ILBFactory $lbFactory,
UserIdentity $user,
WikiPage $page,
RevisionRecord $revisionRecord,
DerivedPageDataUpdater $updater,
array $options )
Parameters
ILBFactory$lbFactory
UserIdentity$user
WikiPage$pagePage we are updating
RevisionRecord$revisionRecord
DerivedPageDataUpdater$updater
array$optionsOptions map; supports "recursive" (bool) and "freshness" (string|false, TS_MW)

Definition at line 70 of file RefreshSecondaryDataUpdate.php.

Member Function Documentation

◆ doUpdate()

MediaWiki\Deferred\RefreshSecondaryDataUpdate::doUpdate ( )

Perform the actual work.

Implements MediaWiki\Deferred\DeferrableUpdate.

Definition at line 93 of file RefreshSecondaryDataUpdate.php.

References MediaWiki\Deferred\DeferredUpdates\attemptUpdate().

◆ getAsJobSpecification()

MediaWiki\Deferred\RefreshSecondaryDataUpdate::getAsJobSpecification ( )

◆ getTransactionRoundRequirement()

MediaWiki\Deferred\RefreshSecondaryDataUpdate::getTransactionRoundRequirement ( )
Returns
int One of the class TRX_ROUND_* constants

Implements MediaWiki\Deferred\TransactionRoundAwareUpdate.

Definition at line 89 of file RefreshSecondaryDataUpdate.php.


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