File: BodyValidator.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (31 lines) | stat: -rw-r--r-- 804 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<?php

namespace MediaWiki\Rest\Validator;

use MediaWiki\Rest\HttpException;
use MediaWiki\Rest\RequestInterface;

/**
 * Interface for validating a request body
 *
 * @deprecated since 1.43, because Handler::getBodyValidator() is deprecated.
 * No longer stable to implement.
 *
 * @see \MediaWiki\Rest\Handler::getBodyValidator()
 */
interface BodyValidator {

	/**
	 * 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().
	 *
	 * @param RequestInterface $request
	 * @return mixed|null
	 * @throws HttpException on validation failure
	 */
	public function validateBody( RequestInterface $request );

}