Page MenuHomeWickedGov Phorge
Files F4112729

PageRecordChangedEvent.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

PageRecordChangedEvent.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\Page\Event;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\User\UserIdentity;
use Wikimedia\Assert\Assert;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
* Base class for domain events representing changes to page state.
*
* Page state events include life cycle changes to the page (e.g. create, move,
* delete) as well as changing a page's latest revision. They do not include
* changes to the page's revision history (except for changes to the latest
* revision).
*
* A sequence of PageRecordChanged events for the same page represent a
* complete history of changes to pages' PageRecord. However, some subtypes
* may represent changes that do not affect the PageRecord. Also, state
* changes may overlap, so the PageRecord returned by getPageRecordBefore()
* doesn't always match the return value of getPageRecordAfter() of the previous
* event for the same page ID. The return values of getPageRecordAfter() however
* form a complete history.
*
* @since 1.45
*/
abstract class PageRecordChangedEvent extends PageEvent {
public const TYPE = 'PageRecordChanged';
private ?ExistingPageRecord $pageRecordBefore;
private ?ExistingPageRecord $pageRecordAfter;
/**
* @param string $cause See the self::CAUSE_XXX constants.
* @param ?ExistingPageRecord $pageRecordBefore The page record before the
* change, or null if the page didn't exist before.
* @param ?ExistingPageRecord $pageRecordAfter The page record after the
* change, or null if the page no longer exists after.
* @param UserIdentity $performer The user performing the update.
* @param array<string> $tags Applicable tags, see ChangeTags.
* @param array<string,bool> $flags See the self::FLAG_XXX constants.
* @param string|ConvertibleTimestamp|false $timestamp
*/
public function __construct(
string $cause,
?ExistingPageRecord $pageRecordBefore,
?ExistingPageRecord $pageRecordAfter,
UserIdentity $performer,
array $tags = [],
array $flags = [],
$timestamp = false
) {
parent::__construct(
$cause,
$pageRecordAfter ? $pageRecordAfter->getId()
: $pageRecordBefore->getId(),
$performer,
$tags,
$flags,
$timestamp
);
$this->declareEventType( self::TYPE );
Assert::parameter(
$pageRecordBefore || $pageRecordAfter,
'$pageRecordBefore and $pageRecordAfter',
'must not both be null'
);
$this->pageRecordBefore = $pageRecordBefore;
$this->pageRecordAfter = $pageRecordAfter;
}
/**
* Returns a PageRecord representing the state of the page before the change,
* or null if the page did not exist before.
*/
public function getPageRecordBefore(): ?ExistingPageRecord {
return $this->pageRecordBefore;
}
/**
* Returns a PageRecord representing the state of the page after the change,
* or null if the page no longer exists after.
*
* Note that the PageRecord returned by this method may be the same as the
* one returned by getPageRecordBefore(). This may be the case for
* reconciliation events, but also for events that represent changes that
* are not reflected in the PageRecord.
*/
public function getPageRecordAfter(): ?ExistingPageRecord {
return $this->pageRecordAfter;
}
}
// @deprecated temporary alias, remove before 1.45 release
class_alias( PageRecordChangedEvent::class, 'MediaWiki\Page\Event\PageStateEvent' );

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 23:00 (1 d, 6 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b4/5b/09e6a922f8162d171bc00abaa0d6
Default Alt Text
PageRecordChangedEvent.php (3 KB)

Event Timeline