MediaWiki
master
HtmlOutputHelper.php
Go to the documentation of this file.
1
<?php
20
namespace
MediaWiki\Rest\Handler\Helper
;
21
22
use
MediaWiki\Parser\ParserOutput
;
23
use
MediaWiki\Rest\LocalizedHttpException
;
24
use
MediaWiki\Rest\ResponseInterface
;
25
use Wikimedia\Bcp47Code\Bcp47Code;
26
use Wikimedia\Parsoid\Core\ClientError;
27
32
interface
HtmlOutputHelper
{
33
47
public
function
getHtml
():
ParserOutput
;
48
59
public
function
getETag
(
string
$suffix =
''
): ?string;
60
68
public
function
getLastModified
(): ?string;
69
77
public
static
function
getParamSettings
(): array;
78
91
public
function
setVariantConversionLanguage
(
92
$targetLanguage,
93
$sourceLanguage =
null
94
): void;
95
104
public
function
putHeaders
(
ResponseInterface
$response,
bool
$forHtml =
true
): void;
105
106
}
MediaWiki\Parser\ParserOutput
ParserOutput is a rendering of a Content object or a message.
Definition
ParserOutput.php:93
MediaWiki\Rest\LocalizedHttpException
Definition
LocalizedHttpException.php:11
MediaWiki\Rest\Handler\Helper\HtmlOutputHelper
Definition
HtmlOutputHelper.php:32
MediaWiki\Rest\Handler\Helper\HtmlOutputHelper\getHtml
getHtml()
Fetch the HTML for rendering of a given page.
MediaWiki\Rest\Handler\Helper\HtmlOutputHelper\setVariantConversionLanguage
setVariantConversionLanguage( $targetLanguage, $sourceLanguage=null)
Set the language to be used for variant conversion.
MediaWiki\Rest\Handler\Helper\HtmlOutputHelper\getETag
getETag(string $suffix='')
Returns an ETag uniquely identifying the HTML output.
MediaWiki\Rest\Handler\Helper\HtmlOutputHelper\getLastModified
getLastModified()
Returns the time at which the HTML was rendered.
MediaWiki\Rest\Handler\Helper\HtmlOutputHelper\putHeaders
putHeaders(ResponseInterface $response, bool $forHtml=true)
Set the HTTP headers based on the response generated.
MediaWiki\Rest\Handler\Helper\HtmlOutputHelper\getParamSettings
static getParamSettings()
Gets the request parameters of this request.
MediaWiki\Rest\ResponseInterface
An interface similar to PSR-7's ResponseInterface, the primary difference being that it is mutable.
Definition
ResponseInterface.php:41
MediaWiki\Rest\Handler\Helper
Copyright (C) 2011-2020 Wikimedia Foundation and others.
Definition
HtmlInputTransformHelper.php:20
includes
Rest
Handler
Helper
HtmlOutputHelper.php
Generated on Mon Dec 30 2024 14:25:18 for MediaWiki by
1.10.0