Inheritance diagram for MediaWiki\Rest\Handler\LanguageLinksHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\LanguageLinksHandler:

[legend]

Public Member Functions
	__construct (ILoadBalancer $loadBalancer, LanguageNameUtils $languageNameUtils, PermissionManager $permissionManager, TitleFormatter $titleFormatter, TitleParser $titleParser)

	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
	fetchLinks ( $pageId)

	getTitle ()

Private Attributes
LanguageNameUtils	$languageNameUtils

ILoadBalancer	$loadBalancer

PermissionManager	$permissionManager

Title bool null	$title = null

TitleFormatter	$titleFormatter

TitleParser	$titleParser

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.

Detailed Description

Definition at line 28 of file LanguageLinksHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\LanguageLinksHandler::__construct	(	ILoadBalancer	$loadBalancer,
		LanguageNameUtils	$languageNameUtils,
		PermissionManager	$permissionManager,
		TitleFormatter	$titleFormatter,
		TitleParser	$titleParser
	)

Parameters

ILoadBalancer	$loadBalancer
LanguageNameUtils	$languageNameUtils
PermissionManager	$permissionManager
TitleFormatter	$titleFormatter
TitleParser	$titleParser

Definition at line 60 of file LanguageLinksHandler.php.

References MediaWiki\Rest\Handler\LanguageLinksHandler\$languageNameUtils, MediaWiki\Rest\Handler\LanguageLinksHandler\$loadBalancer, MediaWiki\Rest\Handler\LanguageLinksHandler\$permissionManager, MediaWiki\Rest\Handler\LanguageLinksHandler\$titleFormatter, and MediaWiki\Rest\Handler\LanguageLinksHandler\$titleParser.

Member Function Documentation

◆ fetchLinks()

MediaWiki\Rest\Handler\LanguageLinksHandler::fetchLinks ( $pageId )

private

Definition at line 114 of file LanguageLinksHandler.php.

References $res, and DB_REPLICA.

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

◆ getETag()

MediaWiki\Rest\Handler\LanguageLinksHandler::getETag ( )

protected

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 158 of file LanguageLinksHandler.php.

◆ getLastModified()

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

protected

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 172 of file LanguageLinksHandler.php.

◆ getParamSettings()

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

◆ getTitle()

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

private

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

Definition at line 80 of file LanguageLinksHandler.php.

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

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

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 184 of file LanguageLinksHandler.php.

References $title, and getTitle().

◆ needsWriteAccess()

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

◆ run()

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

Parameters

string $title

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 92 of file LanguageLinksHandler.php.

References MediaWiki\Rest\Handler\LanguageLinksHandler\$title, MediaWiki\Rest\Handler\LanguageLinksHandler\fetchLinks(), MediaWiki\Rest\Handler\getResponseFactory(), and MediaWiki\Rest\Handler\LanguageLinksHandler\getTitle().

Member Data Documentation

◆ $languageNameUtils

LanguageNameUtils MediaWiki\Rest\Handler\LanguageLinksHandler::$languageNameUtils

private

Definition at line 34 of file LanguageLinksHandler.php.

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

◆ $loadBalancer

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

private

Definition at line 31 of file LanguageLinksHandler.php.

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

◆ $permissionManager

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

private

Definition at line 37 of file LanguageLinksHandler.php.

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

◆ $title

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

private

Definition at line 51 of file LanguageLinksHandler.php.

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

◆ $titleFormatter

TitleFormatter MediaWiki\Rest\Handler\LanguageLinksHandler::$titleFormatter

private

Definition at line 40 of file LanguageLinksHandler.php.

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

◆ $titleParser

TitleParser MediaWiki\Rest\Handler\LanguageLinksHandler::$titleParser

private

Definition at line 43 of file LanguageLinksHandler.php.

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

◆ $user

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

private

Definition at line 46 of file LanguageLinksHandler.php.

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

includes/Rest/Handler/LanguageLinksHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fetchLinks()

◆ getETag()

◆ getLastModified()

◆ getParamSettings()

◆ getTitle()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ run()

Member Data Documentation

◆ $languageNameUtils

◆ $loadBalancer

◆ $permissionManager

◆ $title

◆ $titleFormatter

◆ $titleParser

◆ $user