class ApiHelpParamValueMessage extends Message {
protected $paramValue;
+ protected $deprecated;
/**
* @see Message::__construct
* @param string $paramValue Parameter value being documented
* @param string $text Message to use.
* @param array $params Parameters for the message.
+ * @param bool $deprecated Whether the value is deprecated
* @throws InvalidArgumentException
+ * @since 1.30 Added the `$deprecated` parameter
*/
- public function __construct( $paramValue, $text, $params = [] ) {
+ public function __construct( $paramValue, $text, $params = [], $deprecated = false ) {
parent::__construct( $text, $params );
$this->paramValue = $paramValue;
+ $this->deprecated = (bool)$deprecated;
}
/**
return $this->paramValue;
}
+ /**
+ * Fetch the 'deprecated' flag
+ * @since 1.30
+ * @return bool
+ */
+ public function isDeprecated() {
+ return $this->deprecated;
+ }
+
/**
* Fetch the message.
* @return string
*/
public function fetchMessage() {
if ( $this->message === null ) {
+ $dep = '';
+ if ( $this->isDeprecated() ) {
+ $msg = new Message( 'api-help-param-deprecated' );
+ $msg->interface = $this->interface;
+ $msg->language = $this->language;
+ $msg->useDatabase = $this->useDatabase;
+ $msg->title = $this->title;
+ $dep = '<span class="apihelp-deprecated">' . $msg->fetchMessage() . '</span> ';
+ }
$this->message = ";<span dir=\"ltr\" lang=\"en\">{$this->paramValue}</span>:"
- . parent::fetchMessage();
+ . $dep . parent::fetchMessage();
}
return $this->message;
}