Inheritance diagram for MediaWiki\Rest\Handler\LanguageLinksHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\LanguageLinksHandler:

[legend]

Public Member Functions
	__construct (ILoadBalancer $loadBalancer, LanguageNameUtils $languageNameUtils, TitleFormatter $titleFormatter, TitleParser $titleParser, 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
	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.

	getAuthority ()
	Get the current acting authority.

	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, Authority $authority, 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.

	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.

Private Member Functions
	fetchLinks ( $pageId)

	getPage ()

Private Attributes
LanguageNameUtils	$languageNameUtils

ILoadBalancer	$loadBalancer

ExistingPageRecord false null	$page = false

PageLookup	$pageLookup

TitleFormatter	$titleFormatter

TitleParser	$titleParser

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 26 of file LanguageLinksHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ILoadBalancer	$loadBalancer
LanguageNameUtils	$languageNameUtils
TitleFormatter	$titleFormatter
TitleParser	$titleParser
PageLookup	$pageLookup

Definition at line 55 of file LanguageLinksHandler.php.

References MediaWiki\Rest\Handler\LanguageLinksHandler\$languageNameUtils, MediaWiki\Rest\Handler\LanguageLinksHandler\$loadBalancer, MediaWiki\Rest\Handler\LanguageLinksHandler\$pageLookup, 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 108 of file LanguageLinksHandler.php.

References $res, and DB_REPLICA.

◆ getETag()

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

protected

Returns: string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 151 of file LanguageLinksHandler.php.

◆ getLastModified()

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

protected

Returns: string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 164 of file LanguageLinksHandler.php.

◆ getPage()

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

private

Returns: ExistingPageRecord|null

Definition at line 72 of file LanguageLinksHandler.php.

References MediaWiki\Rest\Handler\getValidatedParams().

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

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 138 of file LanguageLinksHandler.php.

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 176 of file LanguageLinksHandler.php.

◆ 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 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 134 of file LanguageLinksHandler.php.

◆ run()

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

Parameters

string $title

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 86 of file LanguageLinksHandler.php.

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

Member Data Documentation

◆ $languageNameUtils

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

private

Definition at line 32 of file LanguageLinksHandler.php.

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

◆ $loadBalancer

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

private

Definition at line 29 of file LanguageLinksHandler.php.

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

◆ $page

ExistingPageRecord false null MediaWiki\Rest\Handler\LanguageLinksHandler::$page = false

private

Definition at line 46 of file LanguageLinksHandler.php.

◆ $pageLookup

PageLookup MediaWiki\Rest\Handler\LanguageLinksHandler::$pageLookup

private

Definition at line 41 of file LanguageLinksHandler.php.

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

◆ $titleFormatter

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

private

Definition at line 35 of file LanguageLinksHandler.php.

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

◆ $titleParser

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

private

Definition at line 38 of file LanguageLinksHandler.php.

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

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

◆ getPage()

◆ getParamSettings()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ run()

Member Data Documentation

◆ $languageNameUtils

◆ $loadBalancer

◆ $page

◆ $pageLookup

◆ $titleFormatter

◆ $titleParser