MediaWiki master
MediaWiki\Rest\Handler\MediaLinksHandler Class Reference

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

Inherits MediaWiki\Rest\SimpleHandler.

Collaboration diagram for MediaWiki\Rest\Handler\MediaLinksHandler:

Public Member Functions

 __construct (IConnectionProvider $dbProvider, RepoGroup $repoGroup, PageLookup $pageLookup)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters.
 
 needsWriteAccess ()
 Indicates whether this route requires write access.
 
 run ( $title)
 
- Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
 execute ()
 Execute the handler.
 
- 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.
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate.
 
 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.
 
 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

 getETag ()
 
 getLastModified ()
 
 getMaxNumLinks ()
 For testing.
 
 hasRepresentation ()
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object.
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata.
 
 getHookRunner ()
 Get a HookRunner for running core hooks.
 
 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.
 
 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

- Public Attributes inherited from MediaWiki\Rest\Handler
const PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION
 
const PARAM_SOURCE = Validator::PARAM_SOURCE
 

Detailed Description

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

Definition at line 19 of file MediaLinksHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\MediaLinksHandler::__construct ( IConnectionProvider  $dbProvider,
RepoGroup  $repoGroup,
PageLookup  $pageLookup 
)
Parameters
IConnectionProvider$dbProvider
RepoGroup$repoGroup
PageLookup$pageLookup

Definition at line 44 of file MediaLinksHandler.php.

Member Function Documentation

◆ getETag()

MediaWiki\Rest\Handler\MediaLinksHandler::getETag ( )
protected
Returns
string|null
Exceptions
LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 171 of file MediaLinksHandler.php.

◆ getLastModified()

MediaWiki\Rest\Handler\MediaLinksHandler::getLastModified ( )
protected
Returns
string|null
Exceptions
LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 185 of file MediaLinksHandler.php.

◆ getMaxNumLinks()

MediaWiki\Rest\Handler\MediaLinksHandler::getMaxNumLinks ( )
protected

For testing.

Stability: unstable

Definition at line 202 of file MediaLinksHandler.php.

◆ getParamSettings()

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

◆ hasRepresentation()

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 193 of file MediaLinksHandler.php.

◆ needsWriteAccess()

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

◆ run()

MediaWiki\Rest\Handler\MediaLinksHandler::run (   $title)
Parameters
string$title
Returns
Response
Exceptions
LocalizedHttpException

Definition at line 71 of file MediaLinksHandler.php.

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


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