RenderedRevision represents the rendered representation of a revision. More...

Inheritance diagram for Revision\RenderedRevision:

Collaboration diagram for Revision\RenderedRevision:

[legend]

Public Member Functions
	__construct (Title $title, RevisionRecord $revision, ParserOptions $options, callable $combineOutput, $audience=RevisionRecord::FOR_PUBLIC, User $forUser=null)

	getOptions ()

	getRevision ()

	getRevisionParserOutput (array $hints=[])

	getSlotParserOutput ( $role, array $hints=[])

	isContentDeleted ()

	setRevisionParserOutput (ParserOutput $output)
	Sets a ParserOutput to be returned by getRevisionParserOutput(). More...

	setSaveParseLogger (LoggerInterface $saveParseLogger)

	updateRevision (RevisionRecord $rev)
	Updates the RevisionRecord after the revision has been saved. More...

Private Member Functions
	getSlotParserOutputUncached (Content $content, $withHtml)

	outputVariesOnRevisionMetaData (ParserOutput $out, $actualPageId, $actualRevId, $actualRevTimestamp)

	pruneRevisionSensitiveOutput ( $actualPageId, $actualRevId, $actualRevTimestamp)
	Prune any output that depends on the revision ID. More...

	setRevisionInternal (RevisionRecord $revision)

Private Attributes
int	$audience = RevisionRecord::FOR_PUBLIC
	Audience to check when accessing content. More...

callable	$combineOutput
	Callback for combining slot output into revision output. More...

User null	$forUser = null
	The user to use for audience checks during content access. More...

ParserOptions	$options

RevisionRecord	$revision

ParserOutput null	$revisionOutput = null
	The combined ParserOutput for the revision, initialized lazily by getRevisionParserOutput(). More...

LoggerInterface	$saveParseLogger
	For profiling ParserOutput re-use. More...

ParserOutput[]	$slotsOutput = []
	The ParserOutput for each slot, initialized lazily by getSlotParserOutput(). More...

Title	$title

Detailed Description

RenderedRevision represents the rendered representation of a revision.

It acts as a lazy provider of ParserOutput objects for the revision's individual slots, as well as a combined ParserOutput of all slots.

Since: 1.32

Definition at line 44 of file RenderedRevision.php.

Constructor & Destructor Documentation

◆ __construct()

Revision\RenderedRevision::__construct	(	Title	$title,
		RevisionRecord	$revision,
		ParserOptions	$options,
		callable	$combineOutput,
			$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$forUser = `null`
	)

Note: Application logic should not instantiate RenderedRevision instances directly, but should use a RevisionRenderer instead.

Parameters

Title	$title
RevisionRecord	$revision	The revision to render. The content for rendering will be taken from this RevisionRecord. However, if the RevisionRecord is not complete according isReadyForInsertion(), but a revision ID is known, the parser may load the revision from the database if it needs revision meta data to handle magic words like {{REVISIONUSER}}.
ParserOptions	$options
callable	$combineOutput	Callback for combining slot output into revision output. Signature: function ( RenderedRevision $this ): ParserOutput.
int	$audience	Use RevisionRecord::FOR_PUBLIC, FOR_THIS_USER, or RAW.
User \| null	$forUser	Required if $audience is FOR_THIS_USER.

Definition at line 108 of file RenderedRevision.php.

References Revision\RenderedRevision\$audience, Revision\RenderedRevision\$combineOutput, Revision\RenderedRevision\$forUser, Revision\RenderedRevision\$options, Revision\RenderedRevision\$title, Revision\RevisionRecord\FOR_THIS_USER, and Revision\RenderedRevision\setRevisionInternal().

Member Function Documentation

◆ getOptions()

Revision\RenderedRevision::getOptions ( )

Returns: ParserOptions

Definition at line 158 of file RenderedRevision.php.

References Revision\RenderedRevision\$options.

Referenced by Revision\RevisionRenderer\combineSlotOutput().

◆ getRevision()

Revision\RenderedRevision::getRevision ( )

Returns: RevisionRecord

Definition at line 151 of file RenderedRevision.php.

References Revision\RenderedRevision\$revision.

Referenced by Revision\RevisionRenderer\combineSlotOutput().

◆ getRevisionParserOutput()

Revision\RenderedRevision::getRevisionParserOutput ( array $hints = [] )

Parameters

array

$hints

Hints given as an associative array. Known keys:

'generate-html' => bool: Whether the caller is interested in output HTML (as opposed to just meta-data). Default is to generate HTML. -param array{generate-html?:bool} $hints

Returns: ParserOutput

Definition at line 192 of file RenderedRevision.php.

References $output, and Revision\RenderedRevision\$revisionOutput.

◆ getSlotParserOutput()

Revision\RenderedRevision::getSlotParserOutput	(		$role,
		array	$hints = `[]`
	)

Parameters

string	$role
array	$hints	Hints given as an associative array. Known keys: 'generate-html' => bool: Whether the caller is interested in output HTML (as opposed to just meta-data). Default is to generate HTML. -param array{generate-html?:bool} $hints

Exceptions

SuppressedDataException if the content is not accessible for the audience specified in the constructor.

Returns: ParserOutput

Implements Revision\SlotRenderingProvider.

Definition at line 222 of file RenderedRevision.php.

References $content, $output, and Revision\RenderedRevision\getSlotParserOutputUncached().

Referenced by Revision\RevisionRenderer\combineSlotOutput().

◆ getSlotParserOutputUncached()

Revision\RenderedRevision::getSlotParserOutputUncached	(	Content	$content,
			$withHtml
	)

private

Note: This method exist to make duplicate parses easier to see during profiling

Parameters

Content	$content
bool	$withHtml

Returns: ParserOutput

Definition at line 262 of file RenderedRevision.php.

References $content, and Revision\RenderedRevision\$options.

Referenced by Revision\RenderedRevision\getSlotParserOutput().

◆ isContentDeleted()

Revision\RenderedRevision::isContentDeleted ( )

Returns: bool Whether the revision's content has been hidden from unprivileged users.

Definition at line 144 of file RenderedRevision.php.

References Revision\RevisionRecord\DELETED_TEXT.

◆ outputVariesOnRevisionMetaData()

Revision\RenderedRevision::outputVariesOnRevisionMetaData	(	ParserOutput	$out,
			$actualPageId,
			$actualRevId,
			$actualRevTimestamp
	)

private

Parameters

ParserOutput	$out
int \| bool	$actualPageId	The actual page id, to check the used speculative page ID against; false, to not purge on vary-page-id; true, to purge on vary-page-id unconditionally.
int \| bool	$actualRevId	The actual rev id, to check the used speculative rev ID against,; false, to not purge on vary-revision-id; true, to purge on vary-revision-id unconditionally.
string \| bool	$actualRevTimestamp	The actual rev timestamp, to check against the parser output revision timestamp; false, to not purge on vary-revision-timestamp; true, to purge on vary-revision-timestamp unconditionally.

Returns: bool

Definition at line 411 of file RenderedRevision.php.

References MediaWiki\$context, Revision\RenderedRevision\$saveParseLogger, ParserOutput\getFlag(), ParserOutput\getRevisionTimestampUsed(), ParserOutput\getRevisionUsedSha1Base36(), ParserOutput\getSpeculativePageIdUsed(), and ParserOutput\getSpeculativeRevIdUsed().

Referenced by Revision\RenderedRevision\pruneRevisionSensitiveOutput().

◆ pruneRevisionSensitiveOutput()

Revision\RenderedRevision::pruneRevisionSensitiveOutput	(	$actualPageId,
		$actualRevId,
		$actualRevTimestamp
	)

private

Prune any output that depends on the revision ID.

Parameters

int \| bool	$actualPageId	The actual page id, to check the used speculative page ID against; false, to not purge on vary-page-id; true, to purge on vary-page-id unconditionally.
int \| bool	$actualRevId	The actual rev id, to check the used speculative rev ID against,; false, to not purge on vary-revision-id; true, to purge on vary-revision-id unconditionally.
string \| bool	$actualRevTimestamp	The actual rev timestamp, to check against the parser output revision timestamp; false, to not purge on vary-revision-timestamp; true, to purge on vary-revision-timestamp unconditionally.

Definition at line 316 of file RenderedRevision.php.

References $output, and Revision\RenderedRevision\outputVariesOnRevisionMetaData().

Referenced by Revision\RenderedRevision\updateRevision().