includes/content/Renderer/ContentParseParams.php

   1 <?php
   2 namespace MediaWiki\Content\Renderer;
   3
   4 use MediaWiki\Page\PageReference;
   5 use MediaWiki\Parser\ParserOptions;
   6 use MediaWiki\Parser\ParserOutput;
   7
   8 /**
   9  * @internal
  10  * An object to hold parser params.
  11  */
  12 class ContentParseParams {
  13         /** @var PageReference */
  14         private $page;
  15
  16         /** @var int|null */
  17         private $revId;
  18
  19         /** @var ParserOptions */
  20         private $parserOptions;
  21
  22         /** @var bool */
  23         private $generateHtml;
  24
  25         /** @var ?ParserOutput */
  26         private $previousOutput;
  27
  28         public function __construct(
  29                 PageReference $page,
  30                 ?int $revId = null,
  31                 ?ParserOptions $parserOptions = null,
  32                 bool $generateHtml = true,
  33                 ?ParserOutput $previousOutput = null
  34         ) {
  35                 $this->page = $page;
  36                 $this->parserOptions = $parserOptions ?? ParserOptions::newFromAnon();
  37                 $this->revId = $revId;
  38                 $this->generateHtml = $generateHtml;
  39                 $this->previousOutput = $previousOutput;
  40         }
  41
  42         /**
  43          *
  44          * @return PageReference
  45          */
  46         public function getPage(): PageReference {
  47                 return $this->page;
  48         }
  49
  50         /**
  51          *
  52          * @return int|null
  53          */
  54         public function getRevId(): ?int {
  55                 return $this->revId;
  56         }
  57
  58         /**
  59          *
  60          * @return ParserOptions
  61          */
  62         public function getParserOptions(): ParserOptions {
  63                 return $this->parserOptions;
  64         }
  65
  66         /**
  67          *
  68          * @return bool
  69          */
  70         public function getGenerateHtml(): bool {
  71                 return $this->generateHtml;
  72         }
  73
  74         /**
  75          *
  76          * @return ?ParserOutput
  77          */
  78         public function getPreviousOutput(): ?ParserOutput {
  79                 return $this->previousOutput;
  80         }
  81 }