ContentRenderer.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Content\Renderer;
 
use MediaWiki\Content\Content;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\Page\PageReference;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Revision\RevisionRecord;
use Wikimedia\UUID\GlobalIdGenerator;
 
class ContentRenderer {
    private IContentHandlerFactory $contentHandlerFactory;
    private GlobalIdGenerator $globalIdGenerator;
 
    public function __construct(
        IContentHandlerFactory $contentHandlerFactory,
        GlobalIdGenerator $globalIdGenerator
    ) {
        $this->contentHandlerFactory = $contentHandlerFactory;
        $this->globalIdGenerator = $globalIdGenerator;
    }
 
    public function getParserOutput(
        Content $content,
        PageReference $page,
        ?RevisionRecord $revision = null,
        ?ParserOptions $parserOptions = null,
        $hints = []
    ): ParserOutput {
        $revId = $revision?->getId();
        $revTimestamp = $revision?->getTimestamp();
 
        if ( is_bool( $hints ) ) {
            // For backward compatibility.
            $hints = [ 'generate-html' => $hints ];
        }
        $cacheTime = wfTimestampNow();
        $contentHandler = $this->contentHandlerFactory->getContentHandler( $content->getModel() );
        $cpoParams = new ContentParseParams(
            $page,
            $revId,
            $parserOptions,
            $hints['generate-html'] ?? true,
            $hints['previous-output'] ?? null
        );
 
        $parserOutput = $contentHandler->getParserOutput( $content, $cpoParams );
        // Set the cache parameters, if not previously set.
        //
        // It is expected that this will be where most are set for the first
        // time, but a ContentHandler can (for example) use a content-based
        // hash for the render id by setting it inside
        // ContentHandler::getParserOutput(); any such custom render id
        // will not be overwritten here.  Similarly, a ContentHandler can
        // continue to use the semi-documented feature of ::setCacheTime(-1)
        // to indicate "not cacheable", and that will not be overwritten
        // either.
        if ( !$parserOutput->hasCacheTime() ) {
            $parserOutput->setCacheTime( $cacheTime );
        }
        if ( $parserOutput->getRenderId() === null ) {
            $parserOutput->setRenderId( $this->globalIdGenerator->newUUIDv1() );
        }
        // Revision ID and Revision Timestamp are set here so that we don't
        // have to load the revision row on view.
        if ( $parserOutput->getCacheRevisionId() === null && $revId !== null ) {
            $parserOutput->setCacheRevisionId( $revId );
        }
        if ( $parserOutput->getRevisionTimestamp() === null && $revTimestamp !== null ) {
            $parserOutput->setRevisionTimestamp( $revTimestamp );
        }
        return $parserOutput;
    }
}