MediaWiki  master
MediaWiki\Rest\Handler\MediaFileHandler Class Reference

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

Inheritance diagram for MediaWiki\Rest\Handler\MediaFileHandler:
Collaboration diagram for MediaWiki\Rest\Handler\MediaFileHandler:

Public Member Functions

 __construct (RepoGroup $repoGroup, PageLookup $pageLookup)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 run ( $title)
 
- Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
 execute ()
 Execute the handler. More...
 
- 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(). More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 checkSession ()
 Check the session (and session provider) More...
 
 getAuthority ()
 Get the current acting authority. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getSession ()
 Get the Session. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 requireSafeAgainstCsrf ()
 Indicates whether this route can be accessed only by session providers safe vs csrf. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Protected Member Functions

 getETag ()
 
 getLastModified ()
 
 hasRepresentation ()
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getRouter ()
 Get the Router. More...
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint. More...
 
 postInitSetup ()
 The handler can override this to do any necessary setup after init() is called to inject the dependencies. More...
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

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

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

◆ getFile()

MediaWiki\Rest\Handler\MediaFileHandler::getFile ( )
private
Returns
File|null

Definition at line 65 of file MediaFileHandler.php.

References MediaWiki\Rest\Handler\getAuthority().

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

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

◆ getResponse()

MediaWiki\Rest\Handler\MediaFileHandler::getResponse ( File  $file)
private
Parameters
File$filethe file to load media links for
Returns
array response data

Definition at line 113 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, 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 $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

◆ $repoGroup

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

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