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

Inheritance diagram for MediaWiki\Revision\RenderedRevision:

Collaboration diagram for MediaWiki\Revision\RenderedRevision:

Public Member Functions
	__construct (RevisionRecord $revision, ParserOptions $options, ContentRenderer $contentRenderer, callable $combineOutput, $audience=RevisionRecord::FOR_PUBLIC, Authority $performer=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...

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.

Definition at line 45 of file RenderedRevision.php.

Constructor & Destructor Documentation

MediaWiki\Revision\RenderedRevision::__construct	(	RevisionRecord	$revision,
		ParserOptions	$options,
		ContentRenderer	$contentRenderer,
		callable	$combineOutput,
			$audience = `RevisionRecord::FOR_PUBLIC`,
		Authority	$performer = `null`
	)

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

Parameters

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
ContentRenderer	$contentRenderer
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.
Authority \| null	$performer	Required if $audience is FOR_THIS_USER.

Definition at line 109 of file RenderedRevision.php.

MediaWiki\Revision\RenderedRevision::getOptions ( )

Definition at line 159 of file RenderedRevision.php.

MediaWiki\Revision\RenderedRevision::getRevision ( )

Definition at line 152 of file RenderedRevision.php.

MediaWiki\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.

Definition at line 193 of file RenderedRevision.php.

MediaWiki\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.

Exceptions

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