MediaWiki\Rest\Validator\BodyValidator Interface Reference

Interface for validating a request body. More...

Inherited by MediaWiki\Rest\Validator\JsonBodyValidator, MediaWiki\Rest\Validator\NullBodyValidator, and MediaWiki\Rest\Validator\UnsupportedContentTypeBodyValidator.

Public Member Functions
	validateBody (RequestInterface $request)
	Validate the body of a request.

Detailed Description

Interface for validating a request body.

Stability: stable

to implement

See also

\MediaWiki\Rest\Handler::getBodyValidator()

Definition at line 14 of file BodyValidator.php.

Member Function Documentation

validateBody()

MediaWiki\Rest\Validator\BodyValidator::validateBody

(

RequestInterface

$request

)

Validate the body of a request.

This may return a data structure representing the parsed body. When used in the context of Handler::validateParams(), the returned value will be available to the handler via Handler::getValidatedBody().

Parameters

RequestInterface

$request

Returns

mixed|null

Exceptions

HttpException

on validation failure

Implemented in MediaWiki\Rest\Validator\JsonBodyValidator, MediaWiki\Rest\Validator\NullBodyValidator, and MediaWiki\Rest\Validator\UnsupportedContentTypeBodyValidator.

---

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

• includes/Rest/Validator/BodyValidator.php