X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FRest%2FHandler.php;h=efe2b7e9e25be78c5bc40aa37b270b72840ad734;hb=64e7e7d760fc3e043f7e01a89cc3697869aaa93b;hp=c05d8e774a0c4d408031bf6a993afdb304fc2e2a;hpb=cc8fabf92459b9df4943c511fe0f4fa5136e9c43;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/Rest/Handler.php b/includes/Rest/Handler.php
index c05d8e774a..efe2b7e9e2 100644
--- a/includes/Rest/Handler.php
+++ b/includes/Rest/Handler.php
@@ -2,7 +2,18 @@
 
 namespace MediaWiki\Rest;
 
+use MediaWiki\Rest\Validator\BodyValidator;
+use MediaWiki\Rest\Validator\NullBodyValidator;
+use MediaWiki\Rest\Validator\Validator;
+
 abstract class Handler {
+
+	/**
+	 * (string) ParamValidator constant to specify the source of the parameter.
+	 * Value must be 'path', 'query', or 'post'.
+	 */
+	const PARAM_SOURCE = 'rest-param-source';
+
 	/** @var Router */
 	private $router;
 
@@ -15,6 +26,12 @@ abstract class Handler {
 	/** @var ResponseFactory */
 	private $responseFactory;
 
+	/** @var array|null */
+	private $validatedParams;
+
+	/** @var mixed */
+	private $validatedBody;
+
 	/**
 	 * Initialise with dependencies from the Router. This is called after construction.
 	 * @internal
@@ -68,6 +85,62 @@ abstract class Handler {
 		return $this->responseFactory;
 	}
 
+	/**
+	 * 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.
+	 *
+	 * @param Validator $restValidator
+	 * @throws HttpException On validation failure.
+	 */
+	public function validate( Validator $restValidator ) {
+		$validatedParams = $restValidator->validateParams( $this->getParamSettings() );
+		$validatedBody = $restValidator->validateBody( $this->request, $this );
+		$this->validatedParams = $validatedParams;
+		$this->validatedBody = $validatedBody;
+	}
+
+	/**
+	 * Fetch ParamValidator settings for parameters
+	 *
+	 * Every setting must include self::PARAM_SOURCE to specify which part of
+	 * the request is to contain the parameter.
+	 *
+	 * @return array[] Associative array mapping parameter names to
+	 *  ParamValidator settings arrays
+	 */
+	public function getParamSettings() {
+		return [];
+	}
+
+	/**
+	 * Fetch the BodyValidator
+	 * @param string $contentType Content type of the request.
+	 * @return BodyValidator
+	 */
+	public function getBodyValidator( $contentType ) {
+		return new NullBodyValidator();
+	}
+
+	/**
+	 * Fetch the validated parameters
+	 *
+	 * @return array|null Array mapping parameter names to validated values,
+	 *  or null if validateParams() was not called yet or validation failed.
+	 */
+	public function getValidatedParams() {
+		return $this->validatedParams;
+	}
+
+	/**
+	 * Fetch the validated body
+	 * @return mixed Value returned by the body validator, or null if validateParams() was
+	 *  not called yet, validation failed, there was no body, or the body was form data.
+	 */
+	public function getValidatedBody() {
+		return $this->validatedBody;
+	}
+
 	/**
 	 * The subclass should override this to provide the maximum last modified
 	 * timestamp for the current request. This is called before execute() in