MediaWiki  master
MediaWiki\Rest\Handler\RevisionHandler Class Reference

Handler class for Core REST API endpoints that perform operations on revisions. More...

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

Public Member Functions

 __construct (RevisionLookup $revisionLookup, PermissionManager $permissionManager)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 run ( $id)
 
- 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...
 
 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, 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 ()
 Returns an ETag representing the requested revision. More...
 
 getLastModified ()
 Returns the requested revision's timestamp. More...
 
 hasRepresentation ()
 
- 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

 getRevision ()
 

Private Attributes

PermissionManager $permissionManager
 
RevisionRecord bool null $revision = null
 
RevisionLookup $revisionLookup
 
User $user
 

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

Handler class for Core REST API endpoints that perform operations on revisions.

Definition at line 19 of file RevisionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\RevisionHandler::__construct ( RevisionLookup  $revisionLookup,
PermissionManager  $permissionManager 
)
Parameters
RevisionLookup$revisionLookup
PermissionManager$permissionManager

Definition at line 38 of file RevisionHandler.php.

References MediaWiki\Rest\Handler\RevisionHandler\$permissionManager, MediaWiki\Rest\Handler\RevisionHandler\$revisionLookup, and RequestContext\getMain().

Member Function Documentation

◆ getETag()

MediaWiki\Rest\Handler\RevisionHandler::getETag ( )
protected

Returns an ETag representing the requested revision.

If access to the revision is restricted, do not return an etag.

Returns
string|null
Exceptions
LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 135 of file RevisionHandler.php.

References MediaWiki\Rest\Handler\RevisionHandler\getRevision().

◆ getLastModified()

MediaWiki\Rest\Handler\RevisionHandler::getLastModified ( )
protected

Returns the requested revision's timestamp.

If access to the revision is restricted, do not return a timestamp.

Returns
string|null
Exceptions
LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 153 of file RevisionHandler.php.

References MediaWiki\Rest\Handler\RevisionHandler\getRevision().

◆ getParamSettings()

MediaWiki\Rest\Handler\RevisionHandler::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.

Stable to override

Returns
array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 118 of file RevisionHandler.php.

◆ getRevision()

◆ hasRepresentation()

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 165 of file RevisionHandler.php.

References MediaWiki\Rest\Handler\RevisionHandler\getRevision(), and true.

◆ needsWriteAccess()

MediaWiki\Rest\Handler\RevisionHandler::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 master database access, since only read queries are needed and each master DB is a single point of failure.

Stable to override

Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 114 of file RevisionHandler.php.

◆ run()

MediaWiki\Rest\Handler\RevisionHandler::run (   $id)

Member Data Documentation

◆ $permissionManager

PermissionManager MediaWiki\Rest\Handler\RevisionHandler::$permissionManager
private

◆ $revision

RevisionRecord bool null MediaWiki\Rest\Handler\RevisionHandler::$revision = null
private

◆ $revisionLookup

RevisionLookup MediaWiki\Rest\Handler\RevisionHandler::$revisionLookup
private

◆ $user

User MediaWiki\Rest\Handler\RevisionHandler::$user
private

Definition at line 27 of file RevisionHandler.php.


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