e662614f95
Implicitly marking parameter $... as nullable is deprecated in php8.4, the explicit nullable type must be used instead Created with autofix from Ide15839e98a6229c22584d1c1c88c690982e1d7a Break one long line in SpecialPage.php Bug: T376276 Change-Id: I807257b2ba1ab2744ab74d9572c9c3d3ac2a968e
91 lines
2.1 KiB
PHP
91 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace Wikimedia\ParamValidator;
|
|
|
|
use Throwable;
|
|
use UnexpectedValueException;
|
|
use Wikimedia\Message\DataMessageValue;
|
|
|
|
/**
|
|
* Error reporting for ParamValidator
|
|
*
|
|
* @newable
|
|
* @since 1.34
|
|
* @unstable
|
|
*/
|
|
class ValidationException extends UnexpectedValueException {
|
|
|
|
/** @var DataMessageValue */
|
|
protected $failureMessage;
|
|
|
|
/** @var string */
|
|
protected $paramName;
|
|
|
|
/** @var mixed */
|
|
protected $paramValue;
|
|
|
|
/** @var array */
|
|
protected $settings;
|
|
|
|
/**
|
|
* @stable to call
|
|
* @param DataMessageValue $failureMessage
|
|
* @param string $name Parameter name being validated
|
|
* @param mixed $value Value of the parameter
|
|
* @param array $settings Settings array being used for validation
|
|
* @param Throwable|null $previous Previous throwable causing this failure
|
|
*/
|
|
public function __construct(
|
|
DataMessageValue $failureMessage, $name, $value, $settings, ?Throwable $previous = null
|
|
) {
|
|
$this->failureMessage = $failureMessage;
|
|
$this->paramName = $name;
|
|
$this->paramValue = $value;
|
|
$this->settings = $settings;
|
|
|
|
// Parent class needs some static English message.
|
|
$msg = "Validation of `$name` failed: " . $failureMessage->getCode();
|
|
$data = $failureMessage->getData();
|
|
if ( $data ) {
|
|
$msg .= ' ' . json_encode( $data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE );
|
|
}
|
|
parent::__construct( $msg, 0, $previous );
|
|
}
|
|
|
|
/**
|
|
* Fetch the validation failure message
|
|
*
|
|
* Users are encouraged to use this with an appropriate message formatter rather
|
|
* than relying on the limited English text returned by getMessage().
|
|
*
|
|
* @return DataMessageValue
|
|
*/
|
|
public function getFailureMessage() {
|
|
return $this->failureMessage;
|
|
}
|
|
|
|
/**
|
|
* Fetch the parameter name that failed validation
|
|
* @return string
|
|
*/
|
|
public function getParamName() {
|
|
return $this->paramName;
|
|
}
|
|
|
|
/**
|
|
* Fetch the parameter value that failed validation
|
|
* @return mixed
|
|
*/
|
|
public function getParamValue() {
|
|
return $this->paramValue;
|
|
}
|
|
|
|
/**
|
|
* Fetch the settings array that failed validation
|
|
* @return array
|
|
*/
|
|
public function getSettings() {
|
|
return $this->settings;
|
|
}
|
|
|
|
}
|