MediaWiki  master
MediaWiki\Rest\Handler\MediaLinksHandler Class Reference

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

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

Public Member Functions

 __construct (PermissionManager $permissionManager, ILoadBalancer $loadBalancer, RepoGroup $repoGroup)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 run ( $title)
 
- 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 ()
 
 getLastModified ()
 
 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

 getDbResults (int $pageId)
 
 getTitle ()
 
 processDbResults ( $results)
 

Private Attributes

ILoadBalancer $loadBalancer
 
PermissionManager $permissionManager
 
RepoGroup $repoGroup
 
Title bool null $title = null
 
User $user
 
const MAX_NUM_LINKS = 100
 int The maximum number of media links to return More...
 

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 21 of file MediaLinksHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\MediaLinksHandler::__construct ( PermissionManager  $permissionManager,
ILoadBalancer  $loadBalancer,
RepoGroup  $repoGroup 
)

Member Function Documentation

◆ getDbResults()

MediaWiki\Rest\Handler\MediaLinksHandler::getDbResults ( int  $pageId)
private
Parameters
int$pageIdthe id of the page to load media links for
Returns
array the results

Definition at line 111 of file MediaLinksHandler.php.

References $dbr, and DB_REPLICA.

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

◆ getETag()

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

◆ getLastModified()

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

◆ 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.

Stable to override

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 163 of file MediaLinksHandler.php.

◆ getTitle()

◆ hasRepresentation()

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

◆ 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 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 159 of file MediaLinksHandler.php.

◆ processDbResults()

MediaWiki\Rest\Handler\MediaLinksHandler::processDbResults (   $results)
private
Parameters
array$resultsdatabase results, or an empty array if none
Returns
array response data

Definition at line 129 of file MediaLinksHandler.php.

References $file, MediaWiki\Rest\Handler\MediaLinksHandler\$title, and MediaWiki\Rest\Handler\MediaLinksHandler\$user.

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

◆ run()

Member Data Documentation

◆ $loadBalancer

ILoadBalancer MediaWiki\Rest\Handler\MediaLinksHandler::$loadBalancer
private

◆ $permissionManager

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

◆ $repoGroup

RepoGroup MediaWiki\Rest\Handler\MediaLinksHandler::$repoGroup
private

◆ $title

◆ $user

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

◆ MAX_NUM_LINKS

const MediaWiki\Rest\Handler\MediaLinksHandler::MAX_NUM_LINKS = 100
private

int The maximum number of media links to return

Definition at line 25 of file MediaLinksHandler.php.


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