MediaWiki  master
MediaWiki\Rest\Handler\CompareHandler Class Reference
Inheritance diagram for MediaWiki\Rest\Handler\CompareHandler:
Collaboration diagram for MediaWiki\Rest\Handler\CompareHandler:

Public Member Functions

 __construct (RevisionLookup $revisionLookup, PermissionManager $permissionManager, Parser $parser)
 
 execute ()
 Execute the handler. More...
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. 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...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Private Member Functions

 getJsonDiff ()
 
 getRevision ( $paramName)
 
 getRevisionOrThrow ( $paramName)
 
 getRevisionText ( $paramName)
 
 getRole ()
 
 getSectionInfo ( $paramName)
 
 isAccessible ( $rev)
 

Private Attributes

Parser $parser
 
PermissionManager $permissionManager
 
RevisionLookup $revisionLookup
 
RevisionRecord[] $revisions = []
 
string[] $textCache = []
 
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...
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getETag ()
 The subclass should override this to provide an ETag for the current request. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getLastModified ()
 The subclass should override this to provide the maximum last modified timestamp for the current request. More...
 
 getRouter ()
 Get the Router. More...
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint. More...
 
 hasRepresentation ()
 The subclass should override this to indicate whether the resource exists. 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...
 

Detailed Description

Definition at line 21 of file CompareHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\CompareHandler::__construct ( RevisionLookup  $revisionLookup,
PermissionManager  $permissionManager,
Parser  $parser 
)

Member Function Documentation

◆ execute()

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

Execute the handler.

This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().

To automatically construct an error response, execute() should throw a RestException. Such exceptions will not be logged like a normal exception.

If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown.

Stable to override

Returns
mixed

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 53 of file CompareHandler.php.

References MediaWiki\Rest\Handler\CompareHandler\getJsonDiff(), MediaWiki\Rest\Handler\getResponseFactory(), MediaWiki\Rest\Handler\CompareHandler\getRevisionOrThrow(), MediaWiki\Rest\Handler\CompareHandler\getRole(), and MediaWiki\Rest\Handler\CompareHandler\getSectionInfo().

◆ getJsonDiff()

MediaWiki\Rest\Handler\CompareHandler::getJsonDiff ( )
private

◆ getParamSettings()

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

References MediaWiki\Rest\Handler\PARAM_SOURCE.

◆ getRevision()

MediaWiki\Rest\Handler\CompareHandler::getRevision (   $paramName)
private
Parameters
string$paramName
Returns
RevisionRecord|null

Definition at line 98 of file CompareHandler.php.

References MediaWiki\Rest\Handler\getValidatedParams().

Referenced by MediaWiki\Rest\Handler\CompareHandler\getRevisionOrThrow(), and MediaWiki\Rest\Handler\CompareHandler\getRevisionText().

◆ getRevisionOrThrow()

MediaWiki\Rest\Handler\CompareHandler::getRevisionOrThrow (   $paramName)
private

◆ getRevisionText()

◆ getRole()

MediaWiki\Rest\Handler\CompareHandler::getRole ( )
private

◆ getSectionInfo()

MediaWiki\Rest\Handler\CompareHandler::getSectionInfo (   $paramName)
private
Parameters
string$paramName
Returns
array

Definition at line 189 of file CompareHandler.php.

References MediaWiki\Rest\Handler\CompareHandler\getRevisionText().

Referenced by MediaWiki\Rest\Handler\CompareHandler\execute().

◆ isAccessible()

MediaWiki\Rest\Handler\CompareHandler::isAccessible (   $rev)
private
Parameters
RevisionRecord$rev
Returns
bool

Definition at line 129 of file CompareHandler.php.

Referenced by MediaWiki\Rest\Handler\CompareHandler\getRevisionOrThrow().

Member Data Documentation

◆ $parser

Parser MediaWiki\Rest\Handler\CompareHandler::$parser
private

◆ $permissionManager

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

◆ $revisionLookup

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

◆ $revisions

RevisionRecord [] MediaWiki\Rest\Handler\CompareHandler::$revisions = []
private

Definition at line 35 of file CompareHandler.php.

◆ $textCache

string [] MediaWiki\Rest\Handler\CompareHandler::$textCache = []
private

Definition at line 38 of file CompareHandler.php.

◆ $user

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

Definition at line 32 of file CompareHandler.php.


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