MediaWiki  master
MediaWiki\Revision\RevisionRenderer Class Reference

The RevisionRenderer service provides access to rendered output for revisions. More...

Collaboration diagram for MediaWiki\Revision\RevisionRenderer:

Public Member Functions

 __construct (ILoadBalancer $loadBalancer, SlotRoleRegistry $roleRegistry, $dbDomain=false)
 
 getRenderedRevision (RevisionRecord $rev, ParserOptions $options=null, Authority $forPerformer=null, array $hints=[])
 
 setLogger (LoggerInterface $saveParseLogger)
 

Private Member Functions

 combineSlotOutput (RenderedRevision $rrev, array $hints=[])
 This implements the layout for combining the output of multiple slots. More...
 
 getSpeculativePageId ( $dbIndex)
 
 getSpeculativeRevId ( $dbIndex)
 

Private Attributes

string bool $dbDomain
 
ILoadBalancer $loadBalancer
 
SlotRoleRegistry $roleRegistery
 
LoggerInterface $saveParseLogger
 

Detailed Description

The RevisionRenderer service provides access to rendered output for revisions.

It does so by acting as a factory for RenderedRevision instances, which in turn provide lazy access to ParserOutput objects.

One key responsibility of RevisionRenderer is implementing the layout used to combine the output of multiple slots.

Since
1.32

Definition at line 45 of file RevisionRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Revision\RevisionRenderer::__construct ( ILoadBalancer  $loadBalancer,
SlotRoleRegistry  $roleRegistry,
  $dbDomain = false 
)
Parameters
ILoadBalancer$loadBalancer
SlotRoleRegistry$roleRegistry
bool | string$dbDomainDB domain of the relevant wiki or false for the current one

Definition at line 64 of file RevisionRenderer.php.

References MediaWiki\Revision\RevisionRenderer\$dbDomain, and MediaWiki\Revision\RevisionRenderer\$loadBalancer.

Member Function Documentation

◆ combineSlotOutput()

MediaWiki\Revision\RevisionRenderer::combineSlotOutput ( RenderedRevision  $rrev,
array  $hints = [] 
)
private

This implements the layout for combining the output of multiple slots.

Todo:
Use placement hints from SlotRoleHandlers instead of hard-coding the layout.
Parameters
RenderedRevision$rrev
array$hintssee RenderedRevision::getRevisionParserOutput()
Returns
ParserOutput

Definition at line 209 of file RevisionRenderer.php.

References Html\element(), MediaWiki\Revision\RenderedRevision\getOptions(), MediaWiki\Revision\RenderedRevision\getRevision(), MediaWiki\Revision\RenderedRevision\getSlotParserOutput(), MediaWiki\Revision\SlotRecord\MAIN, and Html\rawElement().

Referenced by MediaWiki\Revision\RevisionRenderer\getRenderedRevision().

◆ getRenderedRevision()

MediaWiki\Revision\RevisionRenderer::getRenderedRevision ( RevisionRecord  $rev,
ParserOptions  $options = null,
Authority  $forPerformer = null,
array  $hints = [] 
)
Parameters
RevisionRecord$rev
ParserOptions | null$options
Authority | null$forPerformerUser for privileged access. Default is unprivileged (public) access, unless the 'audience' hint is set to something else RevisionRecord::RAW.
array$hintsHints given as an associative array. Known keys:
  • 'use-master' Use master when rendering for the parser cache during save. Default is to use a replica.
  • 'audience' the audience to use for content access. Default is RevisionRecord::FOR_PUBLIC if $forUser is not set, RevisionRecord::FOR_THIS_USER if $forUser is set. Can be set to RevisionRecord::RAW to disable audience checks.
  • 'known-revision-output' a combined ParserOutput for the revision, perhaps from some cache. the caller is responsible for ensuring that the ParserOutput indeed matched the $rev and $options. This mechanism is intended as a temporary stop-gap, for the time until caches have been changed to store RenderedRevision states instead of ParserOutput objects.
Returns
RenderedRevision|null The rendered revision, or null if the audience checks fails.

Definition at line 102 of file RevisionRenderer.php.

References $title, MediaWiki\Revision\RevisionRecord\audienceCan(), MediaWiki\Revision\RevisionRenderer\combineSlotOutput(), DB_PRIMARY, DB_REPLICA, MediaWiki\Revision\RevisionRecord\DELETED_TEXT, MediaWiki\Revision\RevisionRecord\FOR_PUBLIC, MediaWiki\Revision\RevisionRecord\FOR_THIS_USER, MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getPageAsLinkTarget(), MediaWiki\Revision\RevisionRenderer\getSpeculativePageId(), MediaWiki\Revision\RevisionRenderer\getSpeculativeRevId(), MediaWiki\Revision\RevisionRecord\getTimestamp(), MediaWiki\Revision\RevisionRecord\getWikiId(), ParserOptions\newCanonical(), Title\newFromLinkTarget(), and MediaWiki\Revision\RenderedRevision\setSaveParseLogger().

Referenced by RefreshLinksJob\getParserOutput().

◆ getSpeculativePageId()

MediaWiki\Revision\RevisionRenderer::getSpeculativePageId (   $dbIndex)
private

◆ getSpeculativeRevId()

MediaWiki\Revision\RevisionRenderer::getSpeculativeRevId (   $dbIndex)
private

◆ setLogger()

MediaWiki\Revision\RevisionRenderer::setLogger ( LoggerInterface  $saveParseLogger)
Parameters
LoggerInterface$saveParseLogger

Definition at line 78 of file RevisionRenderer.php.

References MediaWiki\Revision\RevisionRenderer\$saveParseLogger.

Member Data Documentation

◆ $dbDomain

string bool MediaWiki\Revision\RevisionRenderer::$dbDomain
private

◆ $loadBalancer

ILoadBalancer MediaWiki\Revision\RevisionRenderer::$loadBalancer
private

◆ $roleRegistery

SlotRoleRegistry MediaWiki\Revision\RevisionRenderer::$roleRegistery
private

Definition at line 54 of file RevisionRenderer.php.

◆ $saveParseLogger

LoggerInterface MediaWiki\Revision\RevisionRenderer::$saveParseLogger
private

Definition at line 48 of file RevisionRenderer.php.

Referenced by MediaWiki\Revision\RevisionRenderer\setLogger().


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