MediaWiki  master
MediaWiki\Rest\Handler\RevisionSourceHandler Class Reference

A handler that returns page source and metadata for the following routes: More...

Inheritance diagram for MediaWiki\Rest\Handler\RevisionSourceHandler:
Collaboration diagram for MediaWiki\Rest\Handler\RevisionSourceHandler:

Public Member Functions

 __construct (Config $config, RevisionLookup $revisionLookup, TitleFormatter $titleFormatter, PageLookup $pageLookup)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 run ()
 
- Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
 execute ()
 Execute the handler. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyConditionalResponseHeaders (ResponseInterface $response)
 Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified(). More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 getAuthority ()
 Get the current acting authority. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Protected Member Functions

 getETag ()
 
 getLastModified ()
 
 hasRepresentation ()
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called. More...
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getRouter ()
 Get the Router. More...
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint. More...
 
 postInitSetup ()
 The handler can override this to do any necessary setup after init() is called to inject the dependencies. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

Private Member Functions

 constructHtmlUrl (RevisionRecord $rev)
 
 getOutputMode ()
 

Private Attributes

RevisionContentHelper $contentHelper
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Rest\Handler
const PARAM_SOURCE = 'rest-param-source'
 (string) ParamValidator constant to specify the source of the parameter. More...
 

Detailed Description

A handler that returns page source and metadata for the following routes:

  • /revision/{revision}
  • /revision/{revision}/bare

Definition at line 20 of file RevisionSourceHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\RevisionSourceHandler::__construct ( Config  $config,
RevisionLookup  $revisionLookup,
TitleFormatter  $titleFormatter,
PageLookup  $pageLookup 
)
Parameters
Config$config
RevisionLookup$revisionLookup
TitleFormatter$titleFormatter
PageLookup$pageLookup

Definition at line 31 of file RevisionSourceHandler.php.

References MediaWiki\Rest\Handler\$config.

Member Function Documentation

◆ constructHtmlUrl()

MediaWiki\Rest\Handler\RevisionSourceHandler::constructHtmlUrl ( RevisionRecord  $rev)
private
Parameters
RevisionRecord$rev
Returns
string

Definition at line 53 of file RevisionSourceHandler.php.

References MediaWiki\Revision\RevisionRecord\getId(), and MediaWiki\Rest\Handler\getRouter().

Referenced by MediaWiki\Rest\Handler\RevisionSourceHandler\run().

◆ getETag()

MediaWiki\Rest\Handler\RevisionSourceHandler::getETag ( )
protected
Returns
string

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 94 of file RevisionSourceHandler.php.

◆ getLastModified()

MediaWiki\Rest\Handler\RevisionSourceHandler::getLastModified ( )
protected
Returns
string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 101 of file RevisionSourceHandler.php.

◆ getOutputMode()

MediaWiki\Rest\Handler\RevisionSourceHandler::getOutputMode ( )
private

◆ getParamSettings()

MediaWiki\Rest\Handler\RevisionSourceHandler::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 113 of file RevisionSourceHandler.php.

◆ hasRepresentation()

MediaWiki\Rest\Handler\RevisionSourceHandler::hasRepresentation ( )
protected
Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 120 of file RevisionSourceHandler.php.

◆ needsWriteAccess()

MediaWiki\Rest\Handler\RevisionSourceHandler::needsWriteAccess ( )

Indicates whether this route requires write access.

The handler should override this if the route does not need to write to the database.

This should return true for routes that may require synchronous database writes. Modules that do not need such writes should also not rely on primary database access, since only read queries are needed and each primary DB is a single point of failure.

Stability: stable
to override
Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 109 of file RevisionSourceHandler.php.

◆ postValidationSetup()

MediaWiki\Rest\Handler\RevisionSourceHandler::postValidationSetup ( )
protected

The handler can override this to do any necessary setup after validate() has been called.

This gives the handler an opportunity to do initialization based on parameters before pre-execution calls like getLastModified() or getETag().

Stability: stable
to override
Since
1.36

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 45 of file RevisionSourceHandler.php.

References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\getValidatedParams().

◆ run()

Member Data Documentation

◆ $contentHelper

RevisionContentHelper MediaWiki\Rest\Handler\RevisionSourceHandler::$contentHelper
private

Definition at line 23 of file RevisionSourceHandler.php.


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