1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Rest\Handler\Helper;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\ResponseInterface;
use Wikimedia\Bcp47Code\Bcp47Code;
use Wikimedia\Parsoid\Core\ClientError;
/**
* @since 1.40
* @unstable
*/
interface HtmlOutputHelper {
/**
* Fetch the HTML for rendering of a given page. If the rendering is
* available in parsoid parser cache, return that. Otherwise, perform
* a parse and return the result while caching it in the parser cache.
*
* NOTE: Caching can be explicitly disabled or a force parse action
* can be issued. Stashing and rate limiting on stashing also applies
* here if specified.
*
* @return ParserOutput a tuple with html and content-type
* @throws LocalizedHttpException
* @throws ClientError
*/
public function getHtml(): ParserOutput;
/**
* Returns an ETag uniquely identifying the HTML output.
*
* @see Handler::getETag()
*
* @param string $suffix A suffix to attach to the etag.
* Must consist of characters that are legal in ETags.
*
* @return string|null We return null when there is no etag.
*/
public function getETag( string $suffix = '' ): ?string;
/**
* Returns the time at which the HTML was rendered.
*
* @see Handler::getLastModified()
*
* @return string|null
*/
public function getLastModified(): ?string;
/**
* Gets the request parameters of this request.
*
* @see Handler::getParamSettings()
*
* @return array
*/
public static function getParamSettings(): array;
/**
* Set the language to be used for variant conversion.
*
* If $targetLanguage is a string, it may be a list of language ranges as
* specified by RFC 9110 for use in the Accept-Language header.
* Implementations must be able to process this format, and may use the
* information provided to choose a supported target language that is
* desirable to the client.
*
* @param Bcp47Code|string $targetLanguage
* @param Bcp47Code|string|null $sourceLanguage
*/
public function setVariantConversionLanguage(
$targetLanguage,
$sourceLanguage = null
): void;
/**
* Set the HTTP headers based on the response generated
*
* @param ResponseInterface $response
* @param bool $forHtml Whether the response will be HTML (rather than JSON)
*
* @return void
*/
public function putHeaders( ResponseInterface $response, bool $forHtml = true ): void;
}
|
