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 (PermissionManager $permissionManager, 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
	getFile ()

	getResponse (File $file)

	getTitle ()

Private Attributes
File bool null	$file = null

PermissionManager	$permissionManager

RepoGroup	$repoGroup

Title bool null	$title = null

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

Handler class for media meta-data.

Definition at line 21 of file MediaFileHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\MediaFileHandler::__construct	(	PermissionManager	$permissionManager,
		RepoGroup	$repoGroup
	)

Parameters

PermissionManager	$permissionManager
RepoGroup	$repoGroup

Definition at line 47 of file MediaFileHandler.php.

References MediaWiki\Rest\Handler\MediaFileHandler\$permissionManager, 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 164 of file MediaFileHandler.php.

◆ getFile()

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

private

Returns: File|bool File or false if unable to retrieve file

Definition at line 72 of file MediaFileHandler.php.

References MediaWiki\Rest\Handler\MediaFileHandler\$file, MediaWiki\Rest\Handler\MediaFileHandler\$title, and MediaWiki\Rest\Handler\MediaFileHandler\getTitle().

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

◆ getLastModified()

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

protected

Returns: string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 177 of file MediaFileHandler.php.

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

Stable to override

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 150 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 125 of file MediaFileHandler.php.

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

◆ getTitle()

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

private

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

Definition at line 61 of file MediaFileHandler.php.

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

Referenced by MediaWiki\Rest\Handler\MediaFileHandler\getFile(), and MediaWiki\Rest\Handler\MediaFileHandler\run().

◆ hasRepresentation()

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

protected

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 189 of file MediaFileHandler.php.

References $file, 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 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 146 of file MediaFileHandler.php.

◆ run()

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

Parameters

string $title

Returns: Response

Exceptions

LocalizedHttpException

Definition at line 86 of file MediaFileHandler.php.

References MediaWiki\Rest\Handler\MediaFileHandler\getFile(), MediaWiki\Rest\Handler\MediaFileHandler\getResponse(), MediaWiki\Rest\Handler\getResponseFactory(), and MediaWiki\Rest\Handler\MediaFileHandler\getTitle().

Member Data Documentation

◆ $file

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

private

Definition at line 41 of file MediaFileHandler.php.

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

◆ $permissionManager

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

private

Definition at line 25 of file MediaFileHandler.php.

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

◆ $repoGroup

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

private

Definition at line 28 of file MediaFileHandler.php.

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

◆ $title

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

private

Definition at line 36 of file MediaFileHandler.php.

Referenced by MediaWiki\Rest\Handler\MediaFileHandler\getFile(), and MediaWiki\Rest\Handler\MediaFileHandler\getTitle().

◆ $user

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

private

Definition at line 31 of file MediaFileHandler.php.

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

◆ getParamSettings()

◆ getResponse()

◆ getTitle()

◆ hasRepresentation()

◆ needsWriteAccess()

◆ run()

Member Data Documentation

◆ $file

◆ $permissionManager

◆ $repoGroup

◆ $title

◆ $user