mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-15 02:23:58 +00:00
63 lines
2.1 KiB
PHP
63 lines
2.1 KiB
PHP
<?php
|
|
namespace MediaWiki\Extension\VisualEditor;
|
|
|
|
use Language;
|
|
use MediaWiki\Page\PageIdentity;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
|
|
interface ParsoidClient {
|
|
|
|
/**
|
|
* Request page HTML
|
|
*
|
|
* @param RevisionRecord $revision Page revision
|
|
* @param Language|null $targetLanguage Desired output language
|
|
*
|
|
* @return array An array containing the keys 'body', 'headers', and optionally 'error'
|
|
* @phan-return array{body:string,headers:array<string,string>,error?:non-empty-array}
|
|
*/
|
|
public function getPageHtml( RevisionRecord $revision, ?Language $targetLanguage ): array;
|
|
|
|
/**
|
|
* Transform HTML to wikitext via Parsoid
|
|
*
|
|
* @param PageIdentity $page The page the content belongs to
|
|
* @param Language $targetLanguage The desired output language
|
|
* @param string $html The HTML of the page to be transformed
|
|
* @param ?int $oldid What oldid revision, if any, to base the request from (default: `null`)
|
|
* @param ?string $etag The ETag to set in the HTTP request header
|
|
*
|
|
* @return array An array containing the keys 'body', 'headers', and optionally 'error'
|
|
* @phan-return array{body:string,headers:array<string,string>,error?:non-empty-array}
|
|
*/
|
|
public function transformHTML(
|
|
PageIdentity $page,
|
|
Language $targetLanguage,
|
|
string $html,
|
|
?int $oldid,
|
|
?string $etag
|
|
): array;
|
|
|
|
/**
|
|
* Transform wikitext to HTML via Parsoid.
|
|
*
|
|
* @param PageIdentity $page The page the content belongs to
|
|
* @param Language $targetLanguage The desired output language
|
|
* @param string $wikitext The wikitext fragment to parse
|
|
* @param bool $bodyOnly Whether to provide only the contents of the `<body>` tag
|
|
* @param ?int $oldid What oldid revision, if any, to base the request from (default: `null`)
|
|
* @param bool $stash Whether to stash the result in the server-side cache (default: `false`)
|
|
*
|
|
* @return array An array containing the keys 'body', 'headers', and optionally 'error'
|
|
* @phan-return array{body:string,headers:array<string,string>,error?:non-empty-array}
|
|
*/
|
|
public function transformWikitext(
|
|
PageIdentity $page,
|
|
Language $targetLanguage,
|
|
string $wikitext,
|
|
bool $bodyOnly,
|
|
?int $oldid,
|
|
bool $stash
|
|
): array;
|
|
}
|