MediaWiki  master
LinksDeletionUpdate Class Reference

Update object handling the cleanup of links tables after a page was deleted. More...

Inheritance diagram for LinksDeletionUpdate:
Collaboration diagram for LinksDeletionUpdate:

Public Member Functions

 __construct (WikiPage $page, $pageId=null, $timestamp=null)
 
 getAsJobSpecification ()
 
- Public Member Functions inherited from LinksUpdate
 __construct (Title $title, ParserOutput $parserOutput, $recursive=true)
 
 doUpdate ()
 Update link tables with outgoing links from an updated article. More...
 
 getAddedExternalLinks ()
 Fetch external links added by this LinksUpdate. More...
 
 getAddedLinks ()
 Fetch page links added by this LinksUpdate. More...
 
 getAddedProperties ()
 Fetch page properties added by this LinksUpdate. More...
 
 getAsJobSpecification ()
 
 getImages ()
 Return the list of images used as generated by the parser. More...
 
 getParserOutput ()
 Returns parser output. More...
 
 getPropertyInsertions ( $existing=[])
 Get an array of page property insertions. More...
 
 getRemovedExternalLinks ()
 Fetch external links removed by this LinksUpdate. More...
 
 getRemovedLinks ()
 Fetch page links removed by this LinksUpdate. More...
 
 getRemovedProperties ()
 Fetch page properties removed by this LinksUpdate. More...
 
 getRevision ()
 
 getTitle ()
 Return the title object of the page being updated. More...
 
 getTriggeringUser ()
 
 setRevision (Revision $revision)
 Set the revision corresponding to this LinksUpdate. More...
 
 setTriggeringUser (User $user)
 Set the User who triggered this LinksUpdate. More...
 
- Public Member Functions inherited from DataUpdate
 __construct ()
 
 getCauseAction ()
 
 getCauseAgent ()
 
 setCause ( $action, $user)
 
 setTransactionTicket ( $ticket)
 

Protected Member Functions

 doIncrementalUpdate ()
 
- Protected Member Functions inherited from LinksUpdate
 doIncrementalUpdate ()
 
 getDB ()
 
 queueRecursiveJobs ()
 Queue recursive jobs for this page. More...
 

Protected Attributes

WikiPage $page
 
string $timestamp
 
- 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from LinksUpdate
static acquirePageLock (IDatabase $dbw, $pageId, $why='atomicity')
 Acquire a lock for performing link table updates for a page on a DB. More...
 
static queueRecursiveJobsForTable (Title $title, $table, $action='unknown', $userName='unknown')
 Queue a RefreshLinks job for any table. More...
 
- Static Public Member Functions inherited from DataUpdate
static runUpdates (array $updates)
 Convenience method, calls doUpdate() on every DataUpdate in the array. More...
 
- Public Attributes inherited from LinksUpdate
array $mCategories
 Map of category names to sort keys. More...
 
array $mExternals
 URLs of external links, array key only. More...
 
int $mId
 Page ID of the article linked from. More...
 
array $mImages
 DB keys of the images used, in the array key only. More...
 
array $mInterlangs
 Map of language codes to titles. More...
 
array $mInterwikis
 2-D map of (prefix => DBK => 1) More...
 
array $mLinks
 Map of title strings to IDs for the links in the document. More...
 
ParserOutput $mParserOutput
 
array $mProperties
 Map of arbitrary name to value. More...
 
bool $mRecursive
 Whether to queue jobs for recursive updates. More...
 
array $mTemplates
 Map of title strings to IDs for the template references, including broken ones. More...
 
Title $mTitle
 Title object of the article linked from. More...
 

Detailed Description

Update object handling the cleanup of links tables after a page was deleted.

Definition at line 28 of file LinksDeletionUpdate.php.

Constructor & Destructor Documentation

◆ __construct()

LinksDeletionUpdate::__construct ( WikiPage  $page,
  $pageId = null,
  $timestamp = null 
)
Parameters
WikiPage$pagePage we are updating
int | null$pageIdID of the page we are updating [optional]
string | null$timestampTS_MW timestamp of deletion
Exceptions
MWException

Definition at line 40 of file LinksDeletionUpdate.php.

References $page, WikiPage\exists(), false, WikiPage\getId(), WikiPage\getTitle(), page, and wfTimestampNow().

Member Function Documentation

◆ doIncrementalUpdate()

LinksDeletionUpdate::doIncrementalUpdate ( )
protected

◆ getAsJobSpecification()

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

Implements EnqueueableDataUpdate.

Definition at line 121 of file LinksDeletionUpdate.php.

References LinksUpdate\getDB().

Member Data Documentation

◆ $page

WikiPage LinksDeletionUpdate::$page
protected

Definition at line 30 of file LinksDeletionUpdate.php.

Referenced by __construct().

◆ $timestamp

string LinksDeletionUpdate::$timestamp
protected

Definition at line 32 of file LinksDeletionUpdate.php.


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