MediaWiki\Rest\Handler Class Reference

Inheritance diagram for MediaWiki\Rest\Handler:

Collaboration diagram for MediaWiki\Rest\Handler:

Public Member Functions
	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...
	execute ()
	Execute the handler. More...
	getBodyValidator ( $contentType)
	Fetch the BodyValidator. More...
	getConfig ()
	Get the configuration array for the current route. More...
	getParamSettings ()
	Fetch ParamValidator settings for parameters. More...
	getRequest ()
	Get the current request. More...
	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects. More...
	getValidatedBody ()
	Fetch the validated body. More...
	getValidatedParams ()
	Fetch the validated parameters. More...
	init (Router $router, RequestInterface $request, array $config, ResponseFactory $responseFactory, HookContainer $hookContainer)
	Initialise with dependencies from the Router. More...
	needsReadAccess ()
	Indicates whether this route requires read rights. More...
	needsWriteAccess ()
	Indicates whether this route requires write access. More...
	validate (Validator $restValidator)
	Validate the request parameters/attributes and body. More...

Public Attributes
const	PARAM_SOURCE = 'rest-param-source'
	(string) ParamValidator constant to specify the source of the parameter. More...

Protected Member Functions
	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object. More...
	getETag ()
	The subclass should override this to provide an ETag for the current request. More...
	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata. More...
	getHookRunner ()
	Get a HookRunner for running core hooks. More...
	getLastModified ()
	The subclass should override this to provide the maximum last modified timestamp for the current request. More...
	getRouter ()
	Get the Router. More...
	hasRepresentation ()
	The subclass should override this to indicate whether the resource exists. More...
	postInitSetup ()
	The handler can override this to do any necessary setup after init() is called to inject the dependencies. More...

Private Attributes
ConditionalHeaderUtil	$conditionalHeaderUtil
array	$config
HookContainer	$hookContainer
HookRunner	$hookRunner
RequestInterface	$request
ResponseFactory	$responseFactory
Router	$router
mixed	$validatedBody
array null	$validatedParams

Detailed Description

Definition at line 11 of file Handler.php.

Member Function Documentation

applyConditionalResponseHeaders()

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

This is called after execute() returns, and may be overridden.

Parameters

ResponseInterface

$response

Definition at line 167 of file Handler.php.

References MediaWiki\Rest\Handler\getConditionalHeaderUtil().

checkPreconditions()

MediaWiki\Rest\Handler::checkPreconditions

(

)

Check the conditional request headers and generate a response if appropriate.

This is called by the Router before execute() and may be overridden.

Returns

ResponseInterface|null

Definition at line 149 of file Handler.php.

References $response, MediaWiki\Rest\Handler\getConditionalHeaderUtil(), MediaWiki\Rest\Handler\getRequest(), and MediaWiki\Rest\Handler\getResponseFactory().

execute()

MediaWiki\Rest\Handler::execute ( )

abstract

Execute the handler.

This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().

To automatically construct an error response, execute() should throw a RestException. Such exceptions will not be logged like a normal exception.

If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown.

Returns

mixed

Reimplemented in MediaWiki\Rest\Handler\SearchHandler, MediaWiki\Rest\Handler\ActionModuleBasedHandler, MediaWiki\Rest\Handler\CompareHandler, and MediaWiki\Rest\SimpleHandler.

getBodyValidator()

MediaWiki\Rest\Handler::getBodyValidator

(

$contentType

)

Fetch the BodyValidator.

Parameters

string

$contentType

Content type of the request.

Returns

BodyValidator

Reimplemented in MediaWiki\Rest\Handler\UpdateHandler, and MediaWiki\Rest\Handler\CreationHandler.

Definition at line 189 of file Handler.php.

Referenced by MediaWiki\Rest\Validator\Validator\validateBody().

getConditionalHeaderUtil()

MediaWiki\Rest\Handler::getConditionalHeaderUtil ( )

protected

Get a ConditionalHeaderUtil object.

On the first call to this method, the object will be initialized with validator values by calling getETag(), getLastModified() and hasRepresentation().

Returns

ConditionalHeaderUtil

Definition at line 132 of file Handler.php.

References MediaWiki\Rest\Handler\$conditionalHeaderUtil, MediaWiki\Rest\Handler\getETag(), MediaWiki\Rest\Handler\getLastModified(), MediaWiki\Rest\Handler\hasRepresentation(), and MediaWiki\Rest\ConditionalHeaderUtil\setValidators().

Referenced by MediaWiki\Rest\Handler\applyConditionalResponseHeaders(), and MediaWiki\Rest\Handler\checkPreconditions().

getConfig()

MediaWiki\Rest\Handler::getConfig

(

)

Get the configuration array for the current route.

The return type declaration causes it to raise a fatal error if init() has not been called.

Returns

array

Definition at line 93 of file Handler.php.

References MediaWiki\Rest\Handler\$config.

Referenced by MediaWiki\Rest\Handler\SearchHandler\postInitSetup().

getETag()

MediaWiki\Rest\Handler::getETag ( )

protected

The subclass should override this to provide an ETag for the current request.

This is called before execute() in order to decide whether to send a 304.

This must be a complete ETag, including double quotes.

See RFC 7232 § 2.3 for semantics.

Returns

string|null

Reimplemented in MediaWiki\Rest\Handler\PageHistoryHandler, MediaWiki\Rest\Handler\PageHTMLHandler, MediaWiki\Rest\Handler\MediaLinksHandler, MediaWiki\Rest\Handler\MediaFileHandler, MediaWiki\Rest\Handler\LanguageLinksHandler, MediaWiki\Rest\Handler\RevisionHandler, and MediaWiki\Rest\Handler\PageSourceHandler.

Definition at line 263 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getConditionalHeaderUtil().

getHookContainer()

MediaWiki\Rest\Handler::getHookContainer ( )

protected

Get a HookContainer, for running extension hooks or for hook metadata.

Since

1.35

Returns

HookContainer

Definition at line 222 of file Handler.php.

References MediaWiki\Rest\Handler\$hookContainer.

getHookRunner()

MediaWiki\Rest\Handler::getHookRunner ( )

protected

Get a HookRunner for running core hooks.

Definition at line 234 of file Handler.php.

References MediaWiki\Rest\Handler\$hookRunner.

Referenced by MediaWiki\Rest\Handler\SearchHandler\buildDescriptionsFromPageIdentities(), and MediaWiki\Rest\Handler\SearchHandler\buildThumbnailsFromPageIdentities().

getLastModified()

MediaWiki\Rest\Handler::getLastModified ( )

protected

The subclass should override this to provide the maximum last modified timestamp for the current request.

This is called before execute() in order to decide whether to send a 304.

The timestamp can be in any format accepted by ConvertibleTimestamp, or null to indicate that the timestamp is unknown.

Returns

bool|string|int|float|\DateTime|null

Reimplemented in MediaWiki\Rest\Handler\PageHistoryHandler, MediaWiki\Rest\Handler\PageHistoryCountHandler, MediaWiki\Rest\Handler\PageHTMLHandler, MediaWiki\Rest\Handler\MediaLinksHandler, MediaWiki\Rest\Handler\MediaFileHandler, MediaWiki\Rest\Handler\LanguageLinksHandler, MediaWiki\Rest\Handler\RevisionHandler, and MediaWiki\Rest\Handler\PageSourceHandler.

Definition at line 248 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getConditionalHeaderUtil().

getParamSettings()

MediaWiki\Rest\Handler::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.

Returns

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

Reimplemented in MediaWiki\Rest\Handler\PageHistoryCountHandler, MediaWiki\Rest\Handler\PageHistoryHandler, MediaWiki\Rest\Handler\SearchHandler, MediaWiki\Rest\Handler\PageHTMLHandler, MediaWiki\Rest\Handler\CompareHandler, MediaWiki\Rest\Handler\MediaLinksHandler, MediaWiki\Rest\Handler\MediaFileHandler, MediaWiki\Rest\Handler\LanguageLinksHandler, MediaWiki\Rest\Handler\RevisionHandler, MediaWiki\Rest\Handler\LatestPageContentHandler, and MediaWiki\Rest\Handler\UpdateHandler.

Definition at line 180 of file Handler.php.

Referenced by MediaWiki\Rest\SimpleHandler\execute(), and MediaWiki\Rest\Handler\validate().

getRequest()

MediaWiki\Rest\Handler::getRequest

(

)

Get the current request.

The return type declaration causes it to raise a fatal error if init() has not yet been called.

Returns

RequestInterface

Definition at line 82 of file Handler.php.

References MediaWiki\Rest\Handler\$request.

Referenced by MediaWiki\Rest\Handler\checkPreconditions(), and MediaWiki\Rest\SimpleHandler\execute().

getResponseFactory()

MediaWiki\Rest\Handler::getResponseFactory

(

)

Get the ResponseFactory which can be used to generate Response objects.

This will raise a fatal error if init() has not been called.

Returns

ResponseFactory

Definition at line 104 of file Handler.php.

References MediaWiki\Rest\Handler\$responseFactory.

Referenced by MediaWiki\Rest\Handler\checkPreconditions(), MediaWiki\Rest\Handler\CompareHandler\execute(), MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute(), MediaWiki\Rest\Handler\SearchHandler\execute(), MediaWiki\Rest\Handler\PageSourceHandler\run(), MediaWiki\Rest\Handler\RevisionHandler\run(), MediaWiki\Rest\Handler\MediaLinksHandler\run(), MediaWiki\Rest\Handler\MediaFileHandler\run(), MediaWiki\Rest\Handler\LanguageLinksHandler\run(), MediaWiki\Rest\Handler\PageHistoryHandler\run(), MediaWiki\Rest\Handler\PageHTMLHandler\run(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\run().

getRouter()

MediaWiki\Rest\Handler::getRouter ( )

protected

Get the Router.

The return type declaration causes it to raise a fatal error if init() has not yet been called.

Returns

Router

Definition at line 72 of file Handler.php.

References MediaWiki\Rest\Handler\$router.

Referenced by MediaWiki\Rest\Handler\CreationHandler\mapActionModuleResponse(), and MediaWiki\Rest\Handler\PageHistoryHandler\processDbResults().

getValidatedBody()

MediaWiki\Rest\Handler::getValidatedBody

(

)

Fetch the validated body.

Returns

mixed Value returned by the body validator, or null if validate() was not called yet, validation failed, there was no body, or the body was form data.

Definition at line 212 of file Handler.php.

References MediaWiki\Rest\Handler\$validatedBody.

Referenced by MediaWiki\Rest\Handler\CreationHandler\getActionModuleParameters(), MediaWiki\Rest\Handler\UpdateHandler\getActionModuleParameters(), MediaWiki\Rest\Handler\EditHandler\getActionModuleToken(), MediaWiki\Rest\Handler\UpdateHandler\getConflictData(), and MediaWiki\Rest\Handler\CreationHandler\getTitleParameter().

getValidatedParams()

MediaWiki\Rest\Handler::getValidatedParams

(

)

Fetch the validated parameters.

This must be called after validate() is called. During execute() is fine.

Returns

array Array mapping parameter names to validated values

Exceptions

Definition at line 200 of file Handler.php.

References MediaWiki\Rest\Handler\$validatedParams.

Referenced by MediaWiki\Rest\Handler\SearchHandler\createSearchEngine(), MediaWiki\Rest\Handler\SearchHandler\doSearch(), MediaWiki\Rest\SimpleHandler\execute(), MediaWiki\Rest\Handler\UpdateHandler\getConflictData(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount(), MediaWiki\Rest\Handler\PageHTMLHandler\getETag(), MediaWiki\Rest\Handler\PageHTMLHandler\getLastModified(), MediaWiki\Rest\Handler\RevisionHandler\getRevision(), MediaWiki\Rest\Handler\CompareHandler\getRevision(), MediaWiki\Rest\Handler\MediaFileHandler\getTitle(), MediaWiki\Rest\Handler\LatestPageContentHandler\getTitle(), MediaWiki\Rest\Handler\MediaLinksHandler\getTitle(), MediaWiki\Rest\Handler\LanguageLinksHandler\getTitle(), MediaWiki\Rest\Handler\PageHistoryHandler\getTitle(), MediaWiki\Rest\Handler\PageHistoryCountHandler\getTitle(), MediaWiki\Rest\Handler\UpdateHandler\getTitleParameter(), MediaWiki\Rest\Handler\PageHistoryHandler\run(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\validateParameterCombination().

hasRepresentation()

MediaWiki\Rest\Handler::hasRepresentation ( )

protected

The subclass should override this to indicate whether the resource exists.

This is used for wildcard validators, for example "If-Match: *" fails if the resource does not exist.

Returns

bool|null

Reimplemented in MediaWiki\Rest\Handler\PageHistoryHandler, MediaWiki\Rest\Handler\MediaLinksHandler, MediaWiki\Rest\Handler\MediaFileHandler, MediaWiki\Rest\Handler\LanguageLinksHandler, and MediaWiki\Rest\Handler\RevisionHandler.

Definition at line 274 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getConditionalHeaderUtil().

init()

MediaWiki\Rest\Handler::init ( Router  $router, RequestInterface  $request, array  $config, ResponseFactory  $responseFactory, HookContainer  $hookContainer  )

final

Initialise with dependencies from the Router.

This is called after construction.

Definition at line 55 of file Handler.php.

References MediaWiki\Rest\Handler\$config, MediaWiki\Rest\Handler\$hookContainer, MediaWiki\Rest\Handler\$request, MediaWiki\Rest\Handler\$responseFactory, MediaWiki\Rest\Handler\$router, and MediaWiki\Rest\Handler\postInitSetup().

needsReadAccess()

MediaWiki\Rest\Handler::needsReadAccess

(

)

Indicates whether this route requires read rights.

The handler should override this if it does not need to read from the wiki. This is uncommon, but may be useful for login and other account management APIs.

Returns

bool

Definition at line 287 of file Handler.php.

needsWriteAccess()

MediaWiki\Rest\Handler::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.

Returns

bool

Reimplemented in MediaWiki\Rest\Handler\PageHistoryCountHandler, MediaWiki\Rest\Handler\PageHistoryHandler, MediaWiki\Rest\Handler\MediaLinksHandler, MediaWiki\Rest\Handler\MediaFileHandler, MediaWiki\Rest\Handler\LanguageLinksHandler, MediaWiki\Rest\Handler\SearchHandler, MediaWiki\Rest\Handler\RevisionHandler, MediaWiki\Rest\Handler\LatestPageContentHandler, and MediaWiki\Rest\Handler\EditHandler.

Definition at line 303 of file Handler.php.

postInitSetup()

MediaWiki\Rest\Handler::postInitSetup ( )

protected

The handler can override this to do any necessary setup after init() is called to inject the dependencies.

Reimplemented in MediaWiki\Rest\Handler\SearchHandler.

Definition at line 311 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\init().

validate()

MediaWiki\Rest\Handler::validate

(

Validator

$restValidator

)

Validate the request parameters/attributes and body.

If there is a validation failure, a response with an error message should be returned or an HttpException should be thrown.

Parameters

Validator

$restValidator

Exceptions

HttpException

On validation failure.

Definition at line 116 of file Handler.php.

References MediaWiki\Rest\Handler\$validatedBody, MediaWiki\Rest\Handler\$validatedParams, MediaWiki\Rest\Handler\getParamSettings(), MediaWiki\Rest\Validator\Validator\validateBody(), and MediaWiki\Rest\Validator\Validator\validateParams().

Member Data Documentation

$conditionalHeaderUtil

ConditionalHeaderUtil MediaWiki\Rest\Handler::$conditionalHeaderUtil

private

Definition at line 38 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getConditionalHeaderUtil().

$config

array MediaWiki\Rest\Handler::$config

private

Definition at line 26 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\SearchHandler\__construct(), MediaWiki\Rest\Handler\getConfig(), and MediaWiki\Rest\Handler\init().

$hookContainer

HookContainer MediaWiki\Rest\Handler::$hookContainer

private

Definition at line 41 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getHookContainer(), and MediaWiki\Rest\Handler\init().

$hookRunner

HookRunner MediaWiki\Rest\Handler::$hookRunner

private

Definition at line 44 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getHookRunner().

$request

RequestInterface MediaWiki\Rest\Handler::$request

private

Definition at line 23 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute(), MediaWiki\Rest\Handler\getRequest(), and MediaWiki\Rest\Handler\init().

$responseFactory

ResponseFactory MediaWiki\Rest\Handler::$responseFactory

private

Definition at line 29 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getResponseFactory(), and MediaWiki\Rest\Handler\init().

$router

Router MediaWiki\Rest\Handler::$router

private

Definition at line 20 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getRouter(), and MediaWiki\Rest\Handler\init().

$validatedBody

mixed MediaWiki\Rest\Handler::$validatedBody

private

Definition at line 35 of file Handler.php.

Referenced by MediaWiki\Rest\Handler\getValidatedBody(), and MediaWiki\Rest\Handler\validate().

$validatedParams

array null MediaWiki\Rest\Handler::$validatedParams

private

Definition at line 32 of file Handler.php.

Referenced by MediaWiki\Rest\SimpleHandler\execute(), MediaWiki\Rest\Handler\getValidatedParams(), and MediaWiki\Rest\Handler\validate().

PARAM_SOURCE

const MediaWiki\Rest\Handler::PARAM_SOURCE = 'rest-param-source'

(string) ParamValidator constant to specify the source of the parameter.

Value must be 'path', 'query', or 'post'.

Definition at line 17 of file Handler.php.

Referenced by MediaWiki\Rest\SimpleHandler\execute(), MediaWiki\Rest\Handler\CompareHandler\getParamSettings(), and MediaWiki\Rest\Validator\Validator\validateParams().

---

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

• includes/Rest/Handler.php