Handler class for media meta-data. More...

Inheritance diagram for MediaWiki\Rest\Handler\MediaFileHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\MediaFileHandler:

[legend]

Public Member Functions
	__construct (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
	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
	getFile ()

	getPage ()

	getResponse (File $file)

Private Attributes
File false null	$file = false

ExistingPageRecord false null	$page = false

PageLookup	$pageLookup

RepoGroup	$repoGroup

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 media meta-data.

Definition at line 19 of file MediaFileHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\MediaFileHandler::__construct	(	RepoGroup	$repoGroup,
		PageLookup	$pageLookup
	)

Parameters

RepoGroup	$repoGroup
PageLookup	$pageLookup

Definition at line 42 of file MediaFileHandler.php.

References MediaWiki\Rest\Handler\MediaFileHandler\$pageLookup, and MediaWiki\Rest\Handler\MediaFileHandler\$repoGroup.

Member Function Documentation

◆ getETag()

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

protected

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 151 of file MediaFileHandler.php.

◆ getFile()

MediaWiki\Rest\Handler\MediaFileHandler::getFile ( )

private

Returns: File|null

Definition at line 65 of file MediaFileHandler.php.

References getAuthority().

◆ getLastModified()

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

protected

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 164 of file MediaFileHandler.php.

◆ getPage()

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

private

Returns: ExistingPageRecord|null

Definition at line 53 of file MediaFileHandler.php.

References MediaWiki\Rest\Handler\getValidatedParams(), and NS_FILE.

◆ getParamSettings()

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

◆ getResponse()

MediaWiki\Rest\Handler\MediaFileHandler::getResponse ( File $file )

private

Parameters

File $file the file to load media links for

Returns: array response data

Definition at line 112 of file MediaFileHandler.php.

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 176 of file MediaFileHandler.php.

References $file, File\exists(), and getFile().

◆ needsWriteAccess()

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

◆ run()

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

Parameters

string $title

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 79 of file MediaFileHandler.php.

References $title, getAuthority(), and getFile().

Member Data Documentation

◆ $file

File false null MediaWiki\Rest\Handler\MediaFileHandler::$file = false

private

Definition at line 36 of file MediaFileHandler.php.

◆ $page

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

private

Definition at line 31 of file MediaFileHandler.php.

◆ $pageLookup

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

private

Definition at line 26 of file MediaFileHandler.php.

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

◆ $repoGroup

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

private

Definition at line 23 of file MediaFileHandler.php.

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

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

includes/Rest/Handler/MediaFileHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getETag()

◆ getFile()

◆ getLastModified()

◆ getPage()

◆ getParamSettings()

◆ getResponse()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ run()

Member Data Documentation

◆ $file

◆ $page

◆ $pageLookup

◆ $repoGroup