MediaWiki
master
|
A handle for managing updates for derived page data on edit, import, purge, etc. More...
Public Member Functions | |
__construct (ServiceOptions $options, WikiPage $wikiPage, RevisionStore $revisionStore, RevisionRenderer $revisionRenderer, SlotRoleRegistry $slotRoleRegistry, ParserCache $parserCache, ParsoidOutputAccess $parsoidOutputAccess, JobQueueGroup $jobQueueGroup, MessageCache $messageCache, Language $contLang, ILBFactory $loadbalancerFactory, IContentHandlerFactory $contentHandlerFactory, HookContainer $hookContainer, EditResultCache $editResultCache, UserNameUtils $userNameUtils, ContentTransformer $contentTransformer, PageEditStash $pageEditStash, TalkPageNotificationManager $talkPageNotificationManager, WANObjectCache $mainWANObjectCache, PermissionManager $permissionManager) | |
doParserCacheUpdate () | |
Causes parser cache entries to be updated. More... | |
doSecondaryDataUpdates (array $options=[]) | |
Do secondary data updates (e.g. More... | |
doUpdates () | |
Do standard updates after page edit, purge, or import. More... | |
getCanonicalParserOptions () | |
getCanonicalParserOutput () | |
Returns the canonical parser output.Code that does not need access to the rendered HTML should use getParserOutputForMetaData() instead.
| |
getModifiedSlotRoles () | |
Returns the role names of the slots modified by the new revision, not including removed roles. More... | |
getPage () | |
Returns the page being updated. More... | |
getParserOutputForMetaData () | |
getPreparedEdit () | |
getRawContent (string $role) | |
Returns the content of the given slot, with no audience checks. More... | |
getRawSlot ( $role) | |
Returns the slot, modified or inherited, after PST, with no audience checks applied. More... | |
getRemovedSlotRoles () | |
Returns the role names of the slots removed by the new revision. More... | |
getRenderedRevision () | |
getRevision () | |
Returns the update's target revision - that is, the revision that will be the current revision after the update. More... | |
getSecondaryDataUpdates ( $recursive=false) | |
getSlotParserOutput ( $role, $generateHtml=true) | |
getSlots () | |
Returns the slots of the target revision, after PST. More... | |
getTouchedSlotRoles () | |
Returns the role names of the slots touched by the new revision, including removed roles. More... | |
grabCurrentRevision () | |
Returns the revision that was the page's current revision when grabCurrentRevision() was first called. More... | |
isChange () | |
Whether the content of the current revision after the edit is different from the content of the current revision before the edit. More... | |
isContentDeleted () | |
Whether the content is deleted and thus not visible to the public. More... | |
isContentPrepared () | |
Whether prepareUpdate() or prepareContent() have been called on this instance. More... | |
isCountable () | |
isCreation () | |
Whether the edit creates the page. More... | |
isRedirect () | |
isReusableFor (UserIdentity $user=null, RevisionRecord $revision=null, RevisionSlotsUpdate $slotsUpdate=null, $parentId=null) | |
Checks whether this DerivedPageDataUpdater can be re-used for running updates targeting the given revision. More... | |
isUpdatePrepared () | |
Whether prepareUpdate() has been called on this instance. More... | |
pageExisted () | |
Determines whether the page being edited already existed. More... | |
prepareContent (UserIdentity $user, RevisionSlotsUpdate $slotsUpdate, $useStash=true) | |
Prepare updates based on an update which has not yet been saved. More... | |
prepareUpdate (RevisionRecord $revision, array $options=[]) | |
Prepare derived data updates targeting the given RevisionRecord. More... | |
setArticleCountMethod ( $articleCountMethod) | |
setCause (?string $causeAction, ?string $causeAgent) | |
Set the cause action and cause agent, for logging and debugging. More... | |
setForceEmptyRevision (bool $forceEmptyRevision) | |
Set whether null-edits should create a revision. More... | |
setLogger (LoggerInterface $logger) | |
setRcWatchCategoryMembership ( $rcWatchCategoryMembership) | |
wasRedirect () | |
Whether the page was a redirect before the edit. More... | |
Additional Inherited Members | |
![]() | |
const | READ_NONE = -1 |
Constants for object loading bitfield flags (higher => higher QoS) More... | |
A handle for managing updates for derived page data on edit, import, purge, etc.
DerivedPageDataUpdater instances are designed to be cached inside a WikiPage instance, and re-used by callback code over the course of an update operation. It's a stepping stone on the way to a more complete refactoring of WikiPage.
When using a DerivedPageDataUpdater, the following life cycle must be observed: grabCurrentRevision (optional), prepareContent (optional), prepareUpdate (required for doUpdates). getCanonicalParserOutput, getSlots, and getSecondaryDataUpdates require prepareContent or prepareUpdate to have been called first, to initialize the DerivedPageDataUpdater.
MCR migration note: this replaces the relevant methods in WikiPage, and covers the use cases of PreparedEdit.
Definition at line 107 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::__construct | ( | ServiceOptions | $options, |
WikiPage | $wikiPage, | ||
RevisionStore | $revisionStore, | ||
RevisionRenderer | $revisionRenderer, | ||
SlotRoleRegistry | $slotRoleRegistry, | ||
ParserCache | $parserCache, | ||
ParsoidOutputAccess | $parsoidOutputAccess, | ||
JobQueueGroup | $jobQueueGroup, | ||
MessageCache | $messageCache, | ||
Language | $contLang, | ||
ILBFactory | $loadbalancerFactory, | ||
IContentHandlerFactory | $contentHandlerFactory, | ||
HookContainer | $hookContainer, | ||
EditResultCache | $editResultCache, | ||
UserNameUtils | $userNameUtils, | ||
ContentTransformer | $contentTransformer, | ||
PageEditStash | $pageEditStash, | ||
TalkPageNotificationManager | $talkPageNotificationManager, | ||
WANObjectCache | $mainWANObjectCache, | ||
PermissionManager | $permissionManager | ||
) |
ServiceOptions | $options | |
WikiPage | $wikiPage | |
RevisionStore | $revisionStore | |
RevisionRenderer | $revisionRenderer | |
SlotRoleRegistry | $slotRoleRegistry | |
ParserCache | $parserCache | |
ParsoidOutputAccess | $parsoidOutputAccess | |
JobQueueGroup | $jobQueueGroup | |
MessageCache | $messageCache | |
Language | $contLang | |
ILBFactory | $loadbalancerFactory | |
IContentHandlerFactory | $contentHandlerFactory | |
HookContainer | $hookContainer | |
EditResultCache | $editResultCache | |
UserNameUtils | $userNameUtils | |
ContentTransformer | $contentTransformer | |
PageEditStash | $pageEditStash | |
TalkPageNotificationManager | $talkPageNotificationManager | |
WANObjectCache | $mainWANObjectCache | |
PermissionManager | $permissionManager |
Definition at line 345 of file DerivedPageDataUpdater.php.
References MediaWiki\Config\ServiceOptions\get(), and MediaWiki\MainConfigNames\ParsoidCacheConfig.
MediaWiki\Storage\DerivedPageDataUpdater::doParserCacheUpdate | ( | ) |
Causes parser cache entries to be updated.
Definition at line 1848 of file DerivedPageDataUpdater.php.
References WikiPage\getId(), and ParsoidCachePrewarmJob\newSpec().
MediaWiki\Storage\DerivedPageDataUpdater::doSecondaryDataUpdates | ( | array | $options = [] | ) |
Do secondary data updates (e.g.
updating link tables) or schedule them as deferred updates
array | $options |
|
Definition at line 1806 of file DerivedPageDataUpdater.php.
References DeferredUpdates\addUpdate(), and DeferredUpdates\attemptUpdate().
MediaWiki\Storage\DerivedPageDataUpdater::doUpdates | ( | ) |
Do standard updates after page edit, purge, or import.
Update links tables, site stats, search index, title cache, message cache, etc. Purges pages that depend on this page when appropriate. With a 10% chance, triggers pruning the recent changes table.
MCR migration note: this replaces WikiPage::doEditUpdates.
Definition at line 1594 of file DerivedPageDataUpdater.php.
References $title, DeferredUpdates\addCallableUpdate(), DeferredUpdates\addUpdate(), SiteStatsUpdate\factory(), getTitle(), MediaWiki\ResourceLoader\WikiModule\invalidateModuleCache(), User\newFromName(), CategoryMembershipChangeJob\newSpec(), NS_MEDIAWIKI, NS_USER_TALK, WikiPage\onArticleCreate(), WikiPage\onArticleEdit(), and wfDebug().
MediaWiki\Storage\DerivedPageDataUpdater::getCanonicalParserOptions | ( | ) |
Definition at line 1478 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getCanonicalParserOutput | ( | ) |
Returns the canonical parser output.Code that does not need access to the rendered HTML should use getParserOutputForMetaData() instead.
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 1471 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getModifiedSlotRoles | ( | ) |
Returns the role names of the slots modified by the new revision, not including removed roles.
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 1184 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getPage | ( | ) |
Returns the page being updated.
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 589 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getParserOutputForMetaData | ( | ) |
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 1463 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getPreparedEdit | ( | ) |
Definition at line 1427 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getRawContent | ( | string | $role | ) |
Returns the content of the given slot, with no audience checks.
PageUpdateException | If the slot is neither set for update nor inherited from the parent revision. |
string | $role | slot role name |
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 747 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getRawSlot | ( | $role | ) |
Returns the slot, modified or inherited, after PST, with no audience checks applied.
string | $role | slot role name |
PageUpdateException | If the slot is neither set for update nor inherited from the parent revision. |
Definition at line 735 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getRemovedSlotRoles | ( | ) |
Returns the role names of the slots removed by the new revision.
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 1193 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getRenderedRevision | ( | ) |
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 1058 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getRevision | ( | ) |
Returns the update's target revision - that is, the revision that will be the current revision after the update.
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 1050 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getSecondaryDataUpdates | ( | $recursive = false | ) |
bool | $recursive |
Definition at line 1487 of file DerivedPageDataUpdater.php.
References $content, $title, WikiPage\exists(), WikiPage\getTitle(), and WikiPage\loadPageData().
MediaWiki\Storage\DerivedPageDataUpdater::getSlotParserOutput | ( | $role, | |
$generateHtml = true |
|||
) |
string | $role | |
bool | $generateHtml |
Definition at line 1452 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getSlots | ( | ) |
Returns the slots of the target revision, after PST.
Definition at line 1145 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::getTouchedSlotRoles | ( | ) |
Returns the role names of the slots touched by the new revision, including removed roles.
Definition at line 1174 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::grabCurrentRevision | ( | ) |
Returns the revision that was the page's current revision when grabCurrentRevision() was first called.
During an edit, that revision will act as the logical parent of the new revision.
Some updates are performed based on the difference between the database state at the moment this method is first called, and the state after the edit.
Definition at line 657 of file DerivedPageDataUpdater.php.
References WikiPage\getRevisionRecord(), WikiPage\isCountable(), WikiPage\isRedirect(), and WikiPage\loadPageData().
MediaWiki\Storage\DerivedPageDataUpdater::isChange | ( | ) |
Whether the content of the current revision after the edit is different from the content of the current revision before the edit.
This will return false for a null-edit (no revision created), as well as for a dummy revision (a "null-revision" that has the same content as its parent).
Definition at line 1111 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::isContentDeleted | ( | ) |
Whether the content is deleted and thus not visible to the public.
Definition at line 717 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::isContentPrepared | ( | ) |
Whether prepareUpdate() or prepareContent() have been called on this instance.
Definition at line 689 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::isCountable | ( | ) |
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 779 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::isCreation | ( | ) |
Whether the edit creates the page.
Definition at line 1094 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::isRedirect | ( | ) |
Implements MediaWiki\Storage\PreparedUpdate.
Definition at line 824 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::isReusableFor | ( | UserIdentity | $user = null , |
RevisionRecord | $revision = null , |
||
RevisionSlotsUpdate | $slotsUpdate = null , |
||
$parentId = null |
|||
) |
Checks whether this DerivedPageDataUpdater can be re-used for running updates targeting the given revision.
UserIdentity | null | $user | The user creating the revision in question |
RevisionRecord | null | $revision | New revision (after save, if already saved) |
RevisionSlotsUpdate | null | $slotsUpdate | New content (before PST) |
null | int | $parentId | Parent revision of the edit (use 0 for page creation) |
Definition at line 474 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::isUpdatePrepared | ( | ) |
Whether prepareUpdate() has been called on this instance.
Definition at line 700 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::pageExisted | ( | ) |
Determines whether the page being edited already existed.
Only defined after calling grabCurrentRevision() or prepareContent() or prepareUpdate()!
LogicException | if called before grabCurrentRevision |
Definition at line 600 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::prepareContent | ( | UserIdentity | $user, |
RevisionSlotsUpdate | $slotsUpdate, | ||
$useStash = true |
|||
) |
Prepare updates based on an update which has not yet been saved.
This may be used to create derived data that is needed when creating a new revision; particularly, this makes available the slots of the new revision via the getSlots() method, after applying PST and slot inheritance.
The derived data prepared for revision creation may then later be re-used by doUpdates(), without the need to re-calculate.
UserIdentity | $user | The user to act as context for pre-save transformation (PST). |
RevisionSlotsUpdate | $slotsUpdate | The new content of the slots to be updated by this edit, before PST. |
bool | $useStash | Whether to use stashed ParserOutput |
Definition at line 867 of file DerivedPageDataUpdater.php.
References $title, MediaWiki\Title\Title\equals(), MediaWiki\Storage\RevisionSlotsUpdate\getModifiedRoles(), MediaWiki\Storage\RevisionSlotsUpdate\getModifiedSlot(), MediaWiki\User\UserIdentity\getName(), MediaWiki\Storage\RevisionSlotsUpdate\getRemovedRoles(), getTitle(), MediaWiki\Storage\RevisionSlotsUpdate\isModifiedSlot(), and ParserOptions\newFromUserAndLang().
MediaWiki\Storage\DerivedPageDataUpdater::prepareUpdate | ( | RevisionRecord | $revision, |
array | $options = [] |
||
) |
Prepare derived data updates targeting the given RevisionRecord.
Calling this method requires the given revision to be present in the database. This may be right after a new revision has been created, or when re-generating derived data e.g. in ApiPurge, RefreshLinksJob, and the refreshLinks script.
RevisionRecord | $revision | |
array | $options | Array of options, following indexes are used:
|
Definition at line 1251 of file DerivedPageDataUpdater.php.
References MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getParentId(), MediaWiki\Revision\RevisionRecord\getSlots(), and MediaWiki\Revision\RevisionRecord\getUser().
MediaWiki\Storage\DerivedPageDataUpdater::setArticleCountMethod | ( | $articleCountMethod | ) |
string | $articleCountMethod | "any" or "link". |
Definition at line 556 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::setCause | ( | ?string | $causeAction, |
?string | $causeAgent | ||
) |
Set the cause action and cause agent, for logging and debugging.
If $causeAction or $causeAgent is null, any previously set value is preserved.
?string | $causeAction |
?string | $causeAgent |
Definition at line 408 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::setForceEmptyRevision | ( | bool | $forceEmptyRevision | ) |
Set whether null-edits should create a revision.
Enabling this allows the creation of dummy revisions ("null revisions") to mark events such as renaming in the page history.
Must not be called once prepareContent() or prepareUpdate() have been called.
bool | $forceEmptyRevision |
Definition at line 544 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::setLogger | ( | LoggerInterface | $logger | ) |
Definition at line 395 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::setRcWatchCategoryMembership | ( | $rcWatchCategoryMembership | ) |
bool | $rcWatchCategoryMembership |
Definition at line 564 of file DerivedPageDataUpdater.php.
MediaWiki\Storage\DerivedPageDataUpdater::wasRedirect | ( | ) |
Whether the page was a redirect before the edit.
Definition at line 1121 of file DerivedPageDataUpdater.php.