MediaWiki master
MediaWiki\Rest\Handler\TransformHandler Class Reference

Handler for transforming content given in the request. More...

Inherits MediaWiki\Rest\Handler\ParsoidHandler.

Collaboration diagram for MediaWiki\Rest\Handler\TransformHandler:

Public Member Functions

 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate.
 
 execute ()
 Transform content given in the request from or to wikitext.
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters.Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.Can be used for validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().
Stability: stable
to override
Returns
array[] Associative array mapping parameter names to ParamValidator settings arrays

 
- Public Member Functions inherited from MediaWiki\Rest\Handler\ParsoidHandler
 __construct (RevisionLookup $revisionLookup, SiteConfig $siteConfig, PageConfigFactory $pageConfigFactory, DataAccess $dataAccess)
 
 wtLint (PageConfig $pageConfig, array $attribs, ?string $wikitext=null)
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyCacheControl (ResponseInterface $response)
 Apply cache control to enforce privacy.
 
 applyConditionalResponseHeaders (ResponseInterface $response)
 Apply verifier headers to the response, per RFC 7231 ยง7.2.
 
 checkSession ()
 Check the session (and session provider)
 
 getAuthority ()
 Get the current acting authority.
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator.
 
 getConfig ()
 Get the configuration array for the current route.
 
 getOpenApiSpec (string $method)
 Returns an OpenAPI Operation Object specification structure as an associative array.
 
 getPath ()
 Returns the path this handler is bound to, including path variables.
 
 getRequest ()
 Get the current request.
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects.
 
 getSession ()
 Get the Session.
 
 getValidatedBody ()
 Fetch the validated body.
 
 getValidatedParams ()
 Fetch the validated parameters.
 
 init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
 Initialise with dependencies from the Router.
 
 needsReadAccess ()
 Indicates whether this route requires read rights.
 
 needsWriteAccess ()
 Indicates whether this route requires write access.
 
 parseBodyData (RequestInterface $request)
 Returns the parsed body of the request.
 
 requireSafeAgainstCsrf ()
 Indicates whether this route can be accessed only by session providers safe vs csrf.
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body.
 

Protected Member Functions

getRequestAttributes ()
 Rough equivalent of req.local from Parsoid-JS.
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler\ParsoidHandler
 acceptable (array &$attribs)
 This method checks if we support the requested content formats As a side-effect, it updates $attribs to set outputContentVersion that Parsoid should generate based on request headers.
 
 assertDomainIsCorrect ( $domain)
 Verify that the {domain} path parameter matches the actual domain.
 
 getHtmlInputTransformHelper (array $attribs, string $html, PageIdentity $page)
 
 getPageContentEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
 Get the path for the page content endpoint.
 
 getParsedBody ()
 Get the parsed body by content-type.
 
 getRevisionContentEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
 Get the path for the page content endpoint.
 
 getTransformEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
 Get the path for the transform endpoint.
 
 html2wt ( $page, array $attribs, string $html)
 
 languageConversion (PageConfig $pageConfig, array $attribs, array $revision)
 Do variant conversion on a document.
 
 newParsoid ()
 
 parseHTML (string $html, bool $validateXMLNames=false)
 
 pb2pb (array $attribs)
 Pagebundle -> pagebundle helper.
 
 tryToCreatePageConfig (array $attribs, ?string $wikitextOverride=null, bool $html2WtMode=false)
 Try to create a PageConfig object.
 
 tryToCreatePageIdentity (array $attribs)
 Try to create a PageIdentity object.
 
 updateRedLinks (PageConfig $pageConfig, array $attribs, array $revision)
 Update red links on a document.
 
 wt2html (PageConfig $pageConfig, array $attribs, ?string $wikitext=null)
 Wikitext -> HTML helper.
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 detectExtraneousBodyFields (Validator $restValidator)
 Subclasses may override this to disable or modify checks for extraneous body fields.
 
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object.
 
 getETag ()
 The subclass should override this to provide an ETag for the current state of the requested resource.
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata.
 
 getHookRunner ()
 Get a HookRunner for running core hooks.
 
 getLastModified ()
 The subclass should override this to provide the maximum last modified timestamp of the requested resource.
 
 getRequestSpec ()
 Returns an OpenAPI Request Body Object specification structure as an associative array.
 
 getResponseBodySchema ()
 Returns an OpenAPI Schema Object specification structure as an associative array.
 
 getResponseSpec ()
 Returns an OpenAPI Responses Object specification structure as an associative array.
 
 getRouter ()
 Get the Router.
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint.
 
 hasRepresentation ()
 The subclass should override this to indicate whether the resource exists.
 
 postInitSetup ()
 The handler can override this to do any necessary setup after init() is called to inject the dependencies.
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called.
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\Rest\Handler\ParsoidHandler
static factory ()
 
- Public Attributes inherited from MediaWiki\Rest\Handler
const KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES
 
const PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION
 
const PARAM_SOURCE = Validator::PARAM_SOURCE
 
- Protected Attributes inherited from MediaWiki\Rest\Handler\ParsoidHandler
DataAccess $dataAccess
 
ExtensionRegistry $extensionRegistry
 
StatsdDataFactoryInterface $metrics
 A statistics aggregator.
 
PageConfigFactory $pageConfigFactory
 
SiteConfig $siteConfig
 

Detailed Description

Handler for transforming content given in the request.

  • /v1/transform/{from}/to/{format}
  • /v1/transform/{from}/to/{format}/{title}
  • /v1/transform/{from}/to/{format}/{title}/{revision}
See also
https://www.mediawiki.org/wiki/Parsoid/API#POST

Definition at line 38 of file TransformHandler.php.

Member Function Documentation

◆ checkPreconditions()

MediaWiki\Rest\Handler\TransformHandler::checkPreconditions ( )

Check the conditional request headers and generate a response if appropriate.

This is called by the Router before execute() and may be overridden.

Stability: stable
to override
Returns
ResponseInterface|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 57 of file TransformHandler.php.

◆ execute()

MediaWiki\Rest\Handler\TransformHandler::execute ( )

Transform content given in the request from or to wikitext.

Returns
Response
Exceptions
HttpException

Reimplemented from MediaWiki\Rest\Handler\ParsoidHandler.

Definition at line 86 of file TransformHandler.php.

References MediaWiki\Rest\Handler\getConfig().

◆ getParamSettings()

MediaWiki\Rest\Handler\TransformHandler::getParamSettings ( )

Fetch ParamValidator settings for parameters.Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.Can be used for validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().

Stability: stable
to override
Returns
array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 41 of file TransformHandler.php.

◆ getRequestAttributes()

& MediaWiki\Rest\Handler\TransformHandler::getRequestAttributes ( )
protected

Rough equivalent of req.local from Parsoid-JS.

FIXME most of these should be replaced with more native ways of handling the request.

Returns
array

Reimplemented from MediaWiki\Rest\Handler\ParsoidHandler.

Definition at line 64 of file TransformHandler.php.


The documentation for this class was generated from the following file: