MediaWiki  master
MediaWiki\Rest\Handler\PageHistoryHandler Class Reference

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

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

Public Member Functions

 __construct (RevisionStore $revisionStore, NameTableStoreFactory $nameTableStoreFactory, GroupPermissionsLookup $groupPermissionsLookup, ILoadBalancer $loadBalancer, PageLookup $pageLookup, TitleFormatter $titleFormatter)
 RevisionStore $revisionStore. More...
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 run ( $title)
 At most one of older_than and newer_than may be specified. More...
 
- Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
 execute ()
 Execute the handler. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyCacheControl (ResponseInterface $response)
 Apply cache control to enforce privacy. More...
 
 applyConditionalResponseHeaders (ResponseInterface $response)
 Apply verifier headers to the response, per RFC 7231 ยง7.2. More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 checkSession ()
 Check the session (and session provider) More...
 
 getAuthority ()
 Get the current acting authority. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getPath ()
 Returns the path this handler is bound to, including path variables. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getSession ()
 Get the Session. 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, Session $session)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 requireSafeAgainstCsrf ()
 Indicates whether this route can be accessed only by session providers safe vs csrf. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Protected Member Functions

 getETag ()
 Returns an ETag representing a page's latest revision. More...
 
 getLastModified ()
 Returns the time of the last change to the page. 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...
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Rest\Handler
trait PageRedirectHandlerTrait
 Important: this trait should be used for implementations of the Handler class. More...
 
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 29 of file PageHistoryHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\PageHistoryHandler::__construct ( RevisionStore  $revisionStore,
NameTableStoreFactory  $nameTableStoreFactory,
GroupPermissionsLookup  $groupPermissionsLookup,
ILoadBalancer  $loadBalancer,
PageLookup  $pageLookup,
TitleFormatter  $titleFormatter 
)

RevisionStore $revisionStore.

Parameters
RevisionStore$revisionStore
NameTableStoreFactory$nameTableStoreFactory
GroupPermissionsLookup$groupPermissionsLookup
ILoadBalancer$loadBalancer
PageLookup$pageLookup
TitleFormatter$titleFormatter

Definition at line 66 of file PageHistoryHandler.php.

References MediaWiki\Storage\NameTableStoreFactory\getChangeTagDef().

Member Function Documentation

◆ getETag()

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

Returns an ETag representing a page's latest revision.

Returns
string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 456 of file PageHistoryHandler.php.

◆ getLastModified()

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

Returns the time of the last change to the page.

Returns
string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 470 of file PageHistoryHandler.php.

◆ getParamSettings()

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

References Wikimedia\ParamValidator\ParamValidator\PARAM_REQUIRED, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.

◆ hasRepresentation()

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 483 of file PageHistoryHandler.php.

◆ needsWriteAccess()

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

◆ run()

MediaWiki\Rest\Handler\PageHistoryHandler::run (   $title)

At most one of older_than and newer_than may be specified.

Keep in mind that revision ids are not monotonically increasing, so a revision may be older than another but have a higher revision id.

Parameters
string$title
Returns
Response
Exceptions
LocalizedHttpException

Definition at line 103 of file PageHistoryHandler.php.

References $res, $title, MediaWiki\Rest\Handler\getAuthority(), MediaWiki\Rest\Handler\getResponseFactory(), MediaWiki\Rest\Handler\getValidatedParams(), and ChangeTags\REVERT_TAGS.


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