wiki.techinc.nl/includes/Rest/SimpleHandler.php
Tim Starling 377e1084e6 REST: Make getValidatedParams() always return an array
To stop phan from flagging every usage as "suspicious nullable".

Bug: T235355
Change-Id: Ibdcd9f4e9761858e68fae1262187a3e99affa6f9
2019-11-15 04:43:20 +00:00

39 lines
1 KiB
PHP

<?php
namespace MediaWiki\Rest;
/**
* A handler base class which unpacks parameters from the path template and
* passes them as formal parameters to run().
*
* run() must be declared in the subclass. It cannot be declared as abstract
* here because it has a variable parameter list.
*
* @package MediaWiki\Rest
*/
abstract class SimpleHandler extends Handler {
public function execute() {
$paramSettings = $this->getParamSettings();
$validatedParams = $this->getValidatedParams();
$unvalidatedParams = [];
$params = [];
foreach ( $this->getRequest()->getPathParams() as $name => $value ) {
$source = $paramSettings[$name][self::PARAM_SOURCE] ?? 'unknown';
if ( $source !== 'path' ) {
$unvalidatedParams[] = $name;
$params[] = $value;
} else {
$params[] = $validatedParams[$name];
}
}
if ( $unvalidatedParams ) {
throw new \LogicException(
'Path parameters were not validated: ' . implode( ', ', $unvalidatedParams )
);
}
// @phan-suppress-next-line PhanUndeclaredMethod
return $this->run( ...$params );
}
}