MediaWiki  master
RefreshSecondaryDataUpdate Class Reference

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

Inheritance diagram for RefreshSecondaryDataUpdate:
Collaboration diagram for RefreshSecondaryDataUpdate:

Public Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from DataUpdate
static runUpdates (array $updates)
 Convenience method, calls doUpdate() on every DataUpdate in the array. More...
- Protected Attributes inherited from DataUpdate
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

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.


Definition at line 37 of file RefreshSecondaryDataUpdate.php.

Constructor & Destructor Documentation

◆ __construct()

RefreshSecondaryDataUpdate::__construct ( ILBFactory  $lbFactory,
UserIdentity  $user,
WikiPage  $page,
RevisionRecord  $revisionRecord,
DerivedPageDataUpdater  $updater,
array  $options 
WikiPage$pagePage we are updating
array$optionsOptions map; supports "recursive"

Definition at line 62 of file RefreshSecondaryDataUpdate.php.

Member Function Documentation

◆ doUpdate()

RefreshSecondaryDataUpdate::doUpdate ( )

Perform the actual work.

Implements DeferrableUpdate.

Definition at line 84 of file RefreshSecondaryDataUpdate.php.

References DeferredUpdates\attemptUpdate(), and MWExceptionHandler\rollbackPrimaryChangesAndLog().

◆ getAsJobSpecification()

RefreshSecondaryDataUpdate::getAsJobSpecification ( )
array (domain => DB domain ID, job => IJobSpecification)

Implements EnqueueableDataUpdate.

Definition at line 115 of file RefreshSecondaryDataUpdate.php.

◆ getTransactionRoundRequirement()

RefreshSecondaryDataUpdate::getTransactionRoundRequirement ( )
int One of the class TRX_ROUND_* constants

Implements TransactionRoundAwareUpdate.

Definition at line 80 of file RefreshSecondaryDataUpdate.php.

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