imagelinks More...

Inherits MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Collaboration diagram for MediaWiki\Deferred\LinksUpdate\ImageLinksTable:

[legend]

Public Member Functions
	__construct (ServiceOptions $options)

	setParserOutput (ParserOutput $parserOutput)
	Subclasses should implement this to extract the data they need from the ParserOutput.

Public Member Functions inherited from MediaWiki\Deferred\LinksUpdate\TitleLinksTable
	getPageReferenceIterator ( $setType)
	Get a link set as an iterator over PageReferenceValue objects.

	getTitleArray ( $setType)
	Get a link set as an array of Title objects.

Public Member Functions inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
	beforeLock ()
	Subclasses can override this to do any necessary setup before the lock is acquired.

	injectBaseDependencies (LBFactory $lbFactory, LinkTargetLookup $linkTargetLookup, PageIdentity $sourcePage, $batchSize)
	This is called by the factory to inject dependencies for the base class.

	setMoveDetails (PageReference $movedPage)
	Notify the object that the operation is a page move, and set the original title.

	setRevision (RevisionRecord $revision)
	Set the revision associated with the edit.

	setStrictTestMode ( $mode=true)
	Omit conflict resolution options from the insert query so that testing can confirm that the incremental update logic was correct.

	setTransactionTicket ( $ticket)
	Set the empty transaction ticket.

	update ()
	Execute an edit/delete update.

Public Attributes
const	CONSTRUCTOR_OPTIONS

const	VIRTUAL_DOMAIN = 'virtual-imagelinks'

Public Attributes inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
const	CHANGED = 3
	Link type: Changed (inserted or removed) links.

const	DELETED = 2
	Link type: Deleted (removed) links.

const	INSERTED = 1
	Link type: Inserted (added) links.

const	NEW = 5
	Link type: new links (from the ParserOutput)

const	OLD = 4
	Link type: existing/old links.

Protected Member Functions

deduplicateLinkIds ( $linkIds)

Given an iterator over link IDs, remove links which go to the same title, leaving only one link per title.

Parameters

iterable<mixed> $linkIds

Returns: iterable<mixed>

deleteLink ( $linkId)

Delete a link identified by ID.The subclass is expected to queue the deletion by calling deleteRow().

Parameters

mixed $linkId

finishUpdate ()

Subclasses can override this to do any updates associated with their link data, for example dispatching HTML update jobs.

getExistingFields ()

Get the fields to be used in fetchExistingRows().Note that fetchExistingRows() is just a helper for subclasses. The value returned here is effectively private to the subclass.

Returns: array

getExistingLinkIDs ()

Get an array (or iterator) of link IDs for the existing state.The subclass should load the data from the database. There is fetchExistingRows() to make this easier but the subclass is responsible for caching.See the LinksTable doc comment for an explanation of link IDs.

Returns: iterable<mixed>

getFromField ()

Get the name of the field which links to page_id.

Returns: string

getNewLinkIDs ()

Get an array (or iterator) of link IDs for the new state.See the LinksTable doc comment for an explanation of link IDs.

Returns: iterable<mixed>

getTableName ()

Get the table name.

Returns: string

insertLink ( $linkId)

Insert a link identified by ID.The subclass is expected to queue the insertion by calling insertRow().

Parameters

mixed $linkId

isExisting ( $linkId)

Determine whether a link (from the new set) is in the existing set.

Parameters

mixed $linkId

Returns: bool

isInNewSet ( $linkId)

Determine whether a link (from the existing set) is in the new set.

Parameters

mixed $linkId

Returns: bool

linksTargetNormalizationStage ()

Normalization stage of the links table (see T222224)

makePageReferenceValue ( $linkId)

Convert a link ID to a PageReferenceValue.

Parameters

mixed $linkId

Returns: PageReferenceValue

makeTitle ( $linkId)

Convert a link ID to a Title.

Stability: stable: to override

Parameters

mixed $linkId

Returns: Title

needForcedLinkRefresh ()

Subclasses can override this to return true in order to force reinsertion of all the links due to some property of the link changing for reasons not represented by the link ID.

Returns: bool

virtualDomain ()

What virtual domain should be used to read/write from the table.

Returns: string|bool

Protected Member Functions inherited from MediaWiki\Deferred\LinksUpdate\TitleLinksTable

getDeduplicatedLinkIds ( $setType)

Get link IDs for a given set type, filtering out duplicate links to the same title.

Protected Member Functions inherited from MediaWiki\Deferred\LinksUpdate\LinksTable

deleteRow ( $conds)

Queue a deletion operation.

doWrites ()

Do the common DB operations.

fetchExistingRows ()

Do a select query to fetch the existing rows.

getBatchSize ()

Get the maximum number of rows to update in a batch.

getDB ()

getFromConds ()

Get field=>value associative array for the from field(s)

getInsertOptions ()

Get the options for the insert queries.

getLBFactory ()

getLinkIDs ( $setType)

Get an array or iterator of link IDs of a given type.

getMovedPage ()

Assuming the page was moved, get the original page title before the move.

getRevision ()

Get the RevisionRecord of the new revision, if the LinksUpdate caller injected one.

getSourcePage ()

Get the source page, i.e.

getSourcePageId ()

Get the page_id of the source page.

getTransactionTicket ()

Get the empty transaction ticket, or null if there is none.

insertRow ( $row)

Queue a row for insertion.

isCrossNamespaceMove ()

Determine whether the page was moved to a different namespace.

isMove ()

Determine whether the page was moved.

startUpdate ()

Subclasses can override this to do any necessary setup before individual write operations begin.

Additional Inherited Members
Protected Attributes inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
array	$deletedLinks = []
	Link IDs for deleted links.

array	$insertedLinks = []
	Link IDs for inserted links.

LinkTargetLookup	$linkTargetLookup

array	$rowsToDelete = []
	Rows to delete.

array	$rowsToInsert = []
	Rows to insert.

bool	$strictTestMode

Detailed Description

imagelinks

Link ID format: string image name

Since: 1.38

Definition at line 20 of file ImageLinksTable.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::__construct ( ServiceOptions $options )

Definition at line 39 of file ImageLinksTable.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\Config\ServiceOptions\get(), and MediaWiki\MainConfigNames\ImageLinksSchemaMigrationStage.

Member Function Documentation

◆ deduplicateLinkIds()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::deduplicateLinkIds ( $linkIds )

protected

Given an iterator over link IDs, remove links which go to the same title, leaving only one link per title.

Parameters

iterable<mixed> $linkIds

Returns: iterable<mixed>

Reimplemented from MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Definition at line 165 of file ImageLinksTable.php.

◆ deleteLink()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::deleteLink ( $linkId )

protected

Delete a link identified by ID.The subclass is expected to queue the deletion by calling deleteRow().

Parameters

mixed $linkId

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 141 of file ImageLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\LinksTable\deleteRow(), MediaWiki\Deferred\LinksUpdate\ImageLinksTable\linksTargetNormalizationStage(), and SCHEMA_COMPAT_WRITE_OLD.

◆ finishUpdate()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::finishUpdate ( )

protected

Subclasses can override this to do any updates associated with their link data, for example dispatching HTML update jobs.

Stability: stable: to override

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 172 of file ImageLinksTable.php.

◆ getExistingFields()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::getExistingFields ( )

protected

Get the fields to be used in fetchExistingRows().Note that fetchExistingRows() is just a helper for subclasses. The value returned here is effectively private to the subclass.

Returns: array

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 67 of file ImageLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\ImageLinksTable\linksTargetNormalizationStage(), and SCHEMA_COMPAT_WRITE_OLD.

◆ getExistingLinkIDs()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::getExistingLinkIDs ( )

protected

Get an array (or iterator) of link IDs for the existing state.The subclass should load the data from the database. There is fetchExistingRows() to make this easier but the subclass is responsible for caching.See the LinksTable doc comment for an explanation of link IDs.

Returns: iterable<mixed>

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 102 of file ImageLinksTable.php.

◆ getFromField()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::getFromField ( )

protected

Get the name of the field which links to page_id.

Returns: string

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 62 of file ImageLinksTable.php.

◆ getNewLinkIDs()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::getNewLinkIDs ( )

protected

Get an array (or iterator) of link IDs for the new state.See the LinksTable doc comment for an explanation of link IDs.

Returns: iterable<mixed>

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 76 of file ImageLinksTable.php.

◆ getTableName()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::getTableName ( )

protected

Get the table name.

Returns: string

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 57 of file ImageLinksTable.php.

◆ insertLink()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::insertLink ( $linkId )

protected

Insert a link identified by ID.The subclass is expected to queue the insertion by calling insertRow().

Parameters

mixed $linkId

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 124 of file ImageLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\LinksTable\getDB(), MediaWiki\Deferred\LinksUpdate\LinksTable\getSourcePage(), MediaWiki\Deferred\LinksUpdate\LinksTable\insertRow(), MediaWiki\Deferred\LinksUpdate\ImageLinksTable\linksTargetNormalizationStage(), MediaWiki\Deferred\LinksUpdate\ImageLinksTable\makeTitle(), SCHEMA_COMPAT_WRITE_NEW, and SCHEMA_COMPAT_WRITE_OLD.

◆ isExisting()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::isExisting ( $linkId )

protected

Determine whether a link (from the new set) is in the existing set.

Parameters

mixed $linkId

Returns: bool

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 109 of file ImageLinksTable.php.

◆ isInNewSet()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::isInNewSet ( $linkId )

protected

Determine whether a link (from the existing set) is in the new set.

Parameters

mixed $linkId

Returns: bool

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 114 of file ImageLinksTable.php.

◆ linksTargetNormalizationStage()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::linksTargetNormalizationStage ( )

protected

Normalization stage of the links table (see T222224)

Reimplemented from MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Definition at line 194 of file ImageLinksTable.php.

Referenced by MediaWiki\Deferred\LinksUpdate\ImageLinksTable\deleteLink(), MediaWiki\Deferred\LinksUpdate\ImageLinksTable\getExistingFields(), and MediaWiki\Deferred\LinksUpdate\ImageLinksTable\insertLink().

◆ makePageReferenceValue()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::makePageReferenceValue ( $linkId )

protected

Convert a link ID to a PageReferenceValue.

Parameters

mixed $linkId

Returns: PageReferenceValue

Reimplemented from MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Definition at line 155 of file ImageLinksTable.php.

◆ makeTitle()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::makeTitle ( $linkId )

protected

Convert a link ID to a Title.

Stability: stable: to override

Parameters

mixed $linkId

Returns: Title

Reimplemented from MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Definition at line 160 of file ImageLinksTable.php.

Referenced by MediaWiki\Deferred\LinksUpdate\ImageLinksTable\insertLink().

◆ needForcedLinkRefresh()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::needForcedLinkRefresh ( )

protected

Subclasses can override this to return true in order to force reinsertion of all the links due to some property of the link changing for reasons not represented by the link ID.

Returns: bool

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 119 of file ImageLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\LinksTable\isCrossNamespaceMove().

◆ setParserOutput()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::setParserOutput ( ParserOutput $parserOutput )

Subclasses should implement this to extract the data they need from the ParserOutput.

To support a future refactor of LinksDeletionUpdate, if this method is not called, the subclass should assume that the new state is empty.

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 45 of file ImageLinksTable.php.

References MediaWiki\Parser\ParserOutput\getLinkList().

◆ virtualDomain()

MediaWiki\Deferred\LinksUpdate\ImageLinksTable::virtualDomain ( )

protected

What virtual domain should be used to read/write from the table.

Returns: string|bool

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 199 of file ImageLinksTable.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Deferred\LinksUpdate\ImageLinksTable::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::ImageLinksSchemaMigrationStage
    ]

Definition at line 23 of file ImageLinksTable.php.

◆ VIRTUAL_DOMAIN

const MediaWiki\Deferred\LinksUpdate\ImageLinksTable::VIRTUAL_DOMAIN = 'virtual-imagelinks'

Definition at line 21 of file ImageLinksTable.php.

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

includes/Deferred/LinksUpdate/ImageLinksTable.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deduplicateLinkIds()

◆ deleteLink()

◆ finishUpdate()

◆ getExistingFields()

◆ getExistingLinkIDs()

◆ getFromField()

◆ getNewLinkIDs()

◆ getTableName()

◆ insertLink()

◆ isExisting()

◆ isInNewSet()

◆ linksTargetNormalizationStage()

◆ makePageReferenceValue()

◆ makeTitle()

◆ needForcedLinkRefresh()

◆ setParserOutput()

◆ virtualDomain()

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

◆ VIRTUAL_DOMAIN