The RevisionRenderer service provides access to rendered output for revisions. More...
Public Member Functions | |
| __construct (ILoadBalancer $loadBalancer, SlotRoleRegistry $roleRegistry, $dbDomain=false) | |
| getRenderedRevision (RevisionRecord $rev, ParserOptions $options=null, User $forUser=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. | |
| 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 be 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 $dbDomain DB 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()
|
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 $hints see RenderedRevision::getRevisionParserOutput()
- Returns
- ParserOutput
Definition at line 207 of file RevisionRenderer.php.
References MediaWiki\Revision\RenderedRevision\getOptions(), MediaWiki\Revision\RenderedRevision\getRevision(), MediaWiki\Revision\RenderedRevision\getSlotParserOutput(), and MediaWiki\Revision\SlotRecord\MAIN.
Referenced by MediaWiki\Revision\RevisionRenderer\getRenderedRevision().
◆ getRenderedRevision()
| MediaWiki\Revision\RevisionRenderer::getRenderedRevision | ( | RevisionRecord | $rev, |
| ParserOptions | $options = null, | ||
| User | $forUser = null, | ||
| array | $hints = [] ) |
- Parameters
-
RevisionRecord $rev ParserOptions | null $options User | null $forUser User for privileged access. Default is unprivileged (public) access, unless the 'audience' hint is set to something else RevisionRecord::RAW. array $hints Hints 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. -param array{use-master?:bool,audience?:int,known-revision-output?:ParserOutput} $hints
- 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_MASTER, 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(), and MediaWiki\Revision\RenderedRevision\setSaveParseLogger().
Referenced by RefreshLinksJob\getParserOutput().
◆ getSpeculativePageId()
|
private |
Definition at line 182 of file RevisionRenderer.php.
Referenced by MediaWiki\Revision\RevisionRenderer\getRenderedRevision().
◆ getSpeculativeRevId()
|
private |
Definition at line 167 of file RevisionRenderer.php.
Referenced by MediaWiki\Revision\RevisionRenderer\getRenderedRevision().
◆ 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
|
private |
Definition at line 57 of file RevisionRenderer.php.
Referenced by MediaWiki\Revision\RevisionRenderer\__construct().
◆ $loadBalancer
|
private |
Definition at line 51 of file RevisionRenderer.php.
Referenced by MediaWiki\Revision\RevisionRenderer\__construct().
◆ $roleRegistery
|
private |
Definition at line 54 of file RevisionRenderer.php.
◆ $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:
- includes/Revision/RevisionRenderer.php
