MediaWiki\Rest\Handler\MediaFileHandler Class Reference

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

Inherits MediaWiki\Rest\SimpleHandler.

Collaboration diagram for MediaWiki\Rest\Handler\MediaFileHandler:

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
	applyCacheControl (ResponseInterface $response)
	Apply cache control to enforce privacy.
	applyConditionalResponseHeaders (ResponseInterface $response)
	Apply verifier headers to the response, per RFC 7231 §7.2.
	checkPreconditions ()
	Check the conditional request headers and generate a response if appropriate.
	checkSession ()
	Check the session (and session provider)
	getAuthority ()
	Get the current acting authority.
	getBodyValidator ( $contentType)
	Fetch the BodyValidator.
	getConfig ()
	Get the configuration array for the current route.
	getOpenApiSpec (string $method)
	Returns an OpenAPI Operation Object specification structure as an associative array.
	getPath ()
	Returns the path this handler is bound to, including path variables.
	getRequest ()
	Get the current request.
	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects.
	getSession ()
	Get the Session.
	getSupportedPathParams ()
	Get a list of parameter placeholders present in the route's path as returned by getPath().
	getValidatedBody ()
	Fetch the validated body.
	getValidatedParams ()
	Fetch the validated parameters.
	init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
	Initialise with dependencies from the Router.
	initContext (Router $router, array $routeConfig)
	Injects information about the handler's context in the Router.
	needsReadAccess ()
	Indicates whether this route requires read rights.
	parseBodyData (RequestInterface $request)
	Returns the parsed body of the request.
	requireSafeAgainstCsrf ()
	Indicates whether this route can be accessed only by session providers safe vs csrf.
	validate (Validator $restValidator)
	Validate the request parameters/attributes and body.

Protected Member Functions
	getETag ()
	getLastModified ()
	hasRepresentation ()
Protected Member Functions inherited from MediaWiki\Rest\Handler
	detectExtraneousBodyFields (Validator $restValidator)
	Subclasses may override this to disable or modify checks for extraneous body fields.
	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.
	getRequestSpec ()
	Returns an OpenAPI Request Body Object specification structure as an associative array.
	getResponseBodySchema ()
	Returns an OpenAPI Schema Object specification structure as an associative array.
	getResponseSpec ()
	Returns an OpenAPI Responses Object specification structure as an associative array.
	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.

Additional Inherited Members
Public Attributes inherited from MediaWiki\Rest\Handler
const	KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES
const	PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION
const	PARAM_SOURCE = Validator::PARAM_SOURCE

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.

Member Function Documentation

getETag()

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

protected

Returns

string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 152 of file MediaFileHandler.php.

getLastModified()

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

protected

Returns

string|null

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

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

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

For "query" and "body" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter.

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 MediaFileHandler.php.

hasRepresentation()

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

protected

Returns

bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 177 of file MediaFileHandler.php.

References 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 134 of file MediaFileHandler.php.

run()

MediaWiki\Rest\Handler\MediaFileHandler::run

(

$title

)

Parameters

string

$title

Returns

Response

Exceptions

LocalizedHttpException

Definition at line 80 of file MediaFileHandler.php.

References getAuthority(), and getFile().

---

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

• includes/Rest/Handler/MediaFileHandler.php