cfcfe299e2
This commit replaces some of the uses of getErrorsArray(), getWarningsArray(), getErrorsByType(), and getErrors(). In many cases the code becomes shorter and clearer. Follow-up to Ibc4ce11594cf36ce7b2495d2636ee080d3443b04. Change-Id: Id0ebeac26ae62231edb48458dbd2e13ddcbd0a9e
83 lines
2.1 KiB
PHP
83 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Rest\Handler\Helper;
|
|
|
|
use MediaWiki\Logger\LoggerFactory;
|
|
use MediaWiki\Message\Converter;
|
|
use MediaWiki\Rest\LocalizedHttpException;
|
|
use StatusValue;
|
|
use Wikimedia\Message\MessageValue;
|
|
|
|
/**
|
|
* Trait for handling Status objects in REST handlers.
|
|
*/
|
|
trait RestStatusTrait {
|
|
|
|
private ?Converter $messageValueConverter = null;
|
|
|
|
private function getMessageValueConverter(): Converter {
|
|
if ( !$this->messageValueConverter ) {
|
|
$this->messageValueConverter = new Converter();
|
|
}
|
|
return $this->messageValueConverter;
|
|
}
|
|
|
|
/**
|
|
* Extract the error messages from a Status, as MessageValue objects.
|
|
* @param StatusValue $status
|
|
* @return MessageValue[]
|
|
*/
|
|
private function convertStatusToMessageValues( StatusValue $status ): array {
|
|
$conv = $this->getMessageValueConverter();
|
|
return array_map( static function ( $msg ) use ( $conv ) {
|
|
// TODO: It should be possible to do this without going through a Message object,
|
|
// but the internal format of parameters is different in MessageValue (T358779)
|
|
return $conv->convertMessage( $msg );
|
|
}, $status->getMessages() );
|
|
}
|
|
|
|
/**
|
|
* @param StatusValue $status
|
|
* @param string|MessageValue $msg
|
|
* @param int $code
|
|
* @param array $data
|
|
*
|
|
* @return never
|
|
* @throws LocalizedHttpException
|
|
*/
|
|
private function throwExceptionForStatus(
|
|
StatusValue $status,
|
|
$msg,
|
|
int $code,
|
|
array $data = []
|
|
) {
|
|
$data += [ 'error-keys' => $this->getStatusErrorKeys( $status ) ];
|
|
|
|
if ( is_string( $msg ) ) {
|
|
$msg = MessageValue::new( $msg )
|
|
->semicolonListParams(
|
|
$this->convertStatusToMessageValues( $status )
|
|
);
|
|
}
|
|
|
|
throw new LocalizedHttpException( $msg, $code, $data );
|
|
}
|
|
|
|
private function getStatusErrorKeys( StatusValue $status ) {
|
|
$keys = [];
|
|
|
|
foreach ( $status->getMessages() as $msg ) {
|
|
$keys[] = $msg->getKey();
|
|
}
|
|
|
|
return array_unique( $keys );
|
|
}
|
|
|
|
private function logStatusError( StatusValue $status, string $message, string $channel ) {
|
|
LoggerFactory::getInstance( $channel )->error(
|
|
$message,
|
|
[ 'reason' => $this->getStatusErrorKeys( $status ) ]
|
|
);
|
|
}
|
|
|
|
}
|