MediaWiki
master
|
Public Member Functions | |||||||
getETag (string $suffix='') | |||||||
Returns an ETag uniquely identifying the HTML output.
| |||||||
getHtml () | |||||||
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.
| |||||||
getLastModified () | |||||||
Returns the time at which the HTML was rendered.
| |||||||
getParamSettings () | |||||||
Gets the request parameters of this request.
| |||||||
init (PageIdentity $page) | |||||||
Initializes the helper with the given parameters like the page we're dealing with. More... | |||||||
putHeaders (ResponseInterface $response, bool $forHtml=true) | |||||||
Set the HTTP headers based on the response generated. More... | |||||||
setVariantConversionLanguage ( $targetLanguage, $sourceLanguage=null) | |||||||
Set the language to be used for variant conversion.
| |||||||
MediaWiki\Rest\Handler\Helper\HtmlMessageOutputHelper::getETag | ( | string | $suffix = '' | ) |
Returns an ETag uniquely identifying the HTML output.
string | $suffix | A suffix to attach to the etag. |
Implements MediaWiki\Rest\Handler\Helper\HtmlOutputHelper.
Definition at line 80 of file HtmlMessageOutputHelper.php.
MediaWiki\Rest\Handler\Helper\HtmlMessageOutputHelper::getHtml | ( | ) |
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.
LocalizedHttpException | |
ClientError |
Implements MediaWiki\Rest\Handler\Helper\HtmlOutputHelper.
Definition at line 61 of file HtmlMessageOutputHelper.php.
MediaWiki\Rest\Handler\Helper\HtmlMessageOutputHelper::getLastModified | ( | ) |
Returns the time at which the HTML was rendered.
Implements MediaWiki\Rest\Handler\Helper\HtmlOutputHelper.
Definition at line 95 of file HtmlMessageOutputHelper.php.
MediaWiki\Rest\Handler\Helper\HtmlMessageOutputHelper::getParamSettings | ( | ) |
Gets the request parameters of this request.
Implements MediaWiki\Rest\Handler\Helper\HtmlOutputHelper.
Definition at line 102 of file HtmlMessageOutputHelper.php.
MediaWiki\Rest\Handler\Helper\HtmlMessageOutputHelper::init | ( | PageIdentity | $page | ) |
Initializes the helper with the given parameters like the page we're dealing with.
PageIdentity | $page |
Definition at line 45 of file HtmlMessageOutputHelper.php.
MediaWiki\Rest\Handler\Helper\HtmlMessageOutputHelper::putHeaders | ( | ResponseInterface | $response, |
bool | $forHtml = true |
||
) |
Set the HTTP headers based on the response generated.
ResponseInterface | $response | |
bool | $forHtml | Whether the response will be HTML (rather than JSON) |
Implements MediaWiki\Rest\Handler\Helper\HtmlOutputHelper.
Definition at line 116 of file HtmlMessageOutputHelper.php.
MediaWiki\Rest\Handler\Helper\HtmlMessageOutputHelper::setVariantConversionLanguage | ( | $targetLanguage, | |
$sourceLanguage = null |
|||
) |
Set the language to be used for variant conversion.
Bcp47Code | string | $targetLanguage | |
Bcp47Code | string | null | $sourceLanguage |
Implements MediaWiki\Rest\Handler\Helper\HtmlOutputHelper.
Definition at line 109 of file HtmlMessageOutputHelper.php.