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

Inheritance diagram for MediaWiki\Rest\Handler\MediaLinksHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\MediaLinksHandler:

[legend]

Public Member Functions
	__construct (PermissionManager $permissionManager, ILoadBalancer $loadBalancer, RepoGroup $repoGroup)

	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
	applyConditionalResponseHeaders (ResponseInterface $response)
	Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified().

	checkPreconditions ()
	Check the conditional request headers and generate a response if appropriate.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

	getConfig ()
	Get the configuration array for the current route.

	getRequest ()
	Get the current request.

	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects.

	getValidatedBody ()
	Fetch the validated body.

	getValidatedParams ()
	Fetch the validated parameters.

	init (Router $router, RequestInterface $request, array $config, ResponseFactory $responseFactory, HookContainer $hookContainer)
	Initialise with dependencies from the Router.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	validate (Validator $restValidator)
	Validate the request parameters/attributes and body.

Protected Member Functions
	getETag ()

	getLastModified ()

	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.

	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.

	urlEncodeTitle ( $title)
	URL-encode titles in a "pretty" way.

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

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.

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
	)

Parameters

PermissionManager	$permissionManager
ILoadBalancer	$loadBalancer
RepoGroup	$repoGroup

Definition at line 49 of file MediaLinksHandler.php.

References MediaWiki\Rest\Handler\MediaLinksHandler\$loadBalancer, MediaWiki\Rest\Handler\MediaLinksHandler\$permissionManager, and MediaWiki\Rest\Handler\MediaLinksHandler\$repoGroup.

Member Function Documentation

◆ getDbResults()

MediaWiki\Rest\Handler\MediaLinksHandler::getDbResults ( int $pageId )

private

Parameters

int $pageId the 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

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 177 of file MediaLinksHandler.php.

◆ getLastModified()

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

protected

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 191 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.

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()

MediaWiki\Rest\Handler\MediaLinksHandler::getTitle ( )

private

Returns: Title|bool Title or false if unable to retrieve title

Definition at line 65 of file MediaLinksHandler.php.

References MediaWiki\Rest\Handler\MediaLinksHandler\$title, and MediaWiki\Rest\Handler\getValidatedParams().

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 203 of file MediaLinksHandler.php.

References $title, and getTitle().

◆ 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 $results database 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()

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

Parameters

string $title

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 77 of file MediaLinksHandler.php.

References MediaWiki\Rest\Handler\MediaLinksHandler\$title, MediaWiki\Rest\Handler\MediaLinksHandler\getDbResults(), MediaWiki\Rest\Handler\getResponseFactory(), and MediaWiki\Rest\Handler\MediaLinksHandler\processDbResults().

Member Data Documentation

◆ $loadBalancer

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

private

Definition at line 31 of file MediaLinksHandler.php.

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

◆ $permissionManager

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

private

Definition at line 28 of file MediaLinksHandler.php.

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

◆ $repoGroup

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

private

Definition at line 34 of file MediaLinksHandler.php.

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

◆ $title

Title bool null MediaWiki\Rest\Handler\MediaLinksHandler::$title = null

private

Definition at line 42 of file MediaLinksHandler.php.

Referenced by MediaWiki\Rest\Handler\MediaLinksHandler\getTitle(), MediaWiki\Rest\Handler\MediaLinksHandler\processDbResults(), and MediaWiki\Rest\Handler\MediaLinksHandler\run().

◆ $user

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

private

Definition at line 37 of file MediaLinksHandler.php.

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

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

includes/Rest/Handler/MediaLinksHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDbResults()

◆ getETag()

◆ getLastModified()

◆ getParamSettings()

◆ getTitle()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ processDbResults()

◆ run()

Member Data Documentation

◆ $loadBalancer

◆ $permissionManager

◆ $repoGroup

◆ $title

◆ $user

◆ MAX_NUM_LINKS