188d2cbbb0
Callers should not catch an unchecked exception, so it doesn't belong in a function signature. Unchecked exceptions indicate a coding error, which by definition the code will not be able to handle correctly. If any of these exceptions were supposed to be in response to an edge case, user input, or initial conditions, then they should be changed to a runtime error. If the exception class cannot be changed, then the annotation should include a comment explaining its purpose and prognosis. Bug: T240672 Change-Id: I2e640b9737cb68090a8e1cb70067d1b74037d647
138 lines
3.6 KiB
PHP
138 lines
3.6 KiB
PHP
<?php
|
|
/**
|
|
* Copyright © 2014 Wikimedia Foundation and contributors
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use MediaWiki\Message\Message;
|
|
|
|
/**
|
|
* Message subclass that prepends wikitext for API help.
|
|
*
|
|
* This exists so the apihelp-*-paramvalue-*-* messages don't all have to
|
|
* include markup wikitext while still keeping the
|
|
* 'APIGetParamDescriptionMessages' hook simple.
|
|
*
|
|
* @newable
|
|
* @since 1.25
|
|
* @ingroup API
|
|
*/
|
|
class ApiHelpParamValueMessage extends Message {
|
|
|
|
/** @var string */
|
|
protected $paramValue;
|
|
/** @var bool */
|
|
protected $deprecated;
|
|
/** @var bool */
|
|
protected $internal;
|
|
|
|
/**
|
|
* @see Message::__construct
|
|
* @stable to call
|
|
*
|
|
* @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
|
|
* @param bool $internal Whether the value is internal
|
|
* @since 1.30 Added the `$deprecated` parameter
|
|
* @since 1.35 Added the `$internal` parameter
|
|
*/
|
|
public function __construct(
|
|
$paramValue,
|
|
$text,
|
|
$params = [],
|
|
$deprecated = false,
|
|
$internal = false
|
|
) {
|
|
parent::__construct( $text, $params );
|
|
$this->paramValue = $paramValue;
|
|
$this->deprecated = (bool)$deprecated;
|
|
$this->internal = (bool)$internal;
|
|
}
|
|
|
|
/**
|
|
* Fetch the parameter value
|
|
* @return string
|
|
*/
|
|
public function getParamValue() {
|
|
return $this->paramValue;
|
|
}
|
|
|
|
/**
|
|
* Fetch the 'deprecated' flag
|
|
* @since 1.30
|
|
* @return bool
|
|
*/
|
|
public function isDeprecated() {
|
|
return $this->deprecated;
|
|
}
|
|
|
|
/**
|
|
* Fetch the 'internal' flag
|
|
* @since 1.35
|
|
* @return bool
|
|
*/
|
|
public function isInternal() {
|
|
return $this->internal;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function fetchMessage() {
|
|
if ( $this->message === null ) {
|
|
$prefix = ";<span dir=\"ltr\" lang=\"en\">{$this->paramValue}</span>:";
|
|
if ( $this->isDeprecated() ) {
|
|
$prefix .= '<span class="apihelp-deprecated">' .
|
|
$this->subMessage( 'api-help-param-deprecated' ) .
|
|
'</span>' .
|
|
$this->subMessage( 'word-separator' );
|
|
}
|
|
if ( $this->isInternal() ) {
|
|
$prefix .= '<span class="apihelp-internal">' .
|
|
$this->subMessage( 'api-help-param-internal' ) .
|
|
'</span>' .
|
|
$this->subMessage( 'word-separator' );
|
|
}
|
|
|
|
if ( $this->getLanguage()->getCode() === 'qqx' ) {
|
|
# Insert a list of alternative message keys for &uselang=qqx.
|
|
$keylist = implode( ' / ', $this->keysToTry );
|
|
if ( $this->overriddenKey !== null ) {
|
|
$keylist .= ' = ' . $this->overriddenKey;
|
|
}
|
|
$this->message = $prefix . "($keylist$*)";
|
|
} else {
|
|
$this->message = $prefix . parent::fetchMessage();
|
|
}
|
|
}
|
|
return $this->message;
|
|
}
|
|
|
|
private function subMessage( $key ) {
|
|
$msg = new Message( $key );
|
|
$msg->isInterface = $this->isInterface;
|
|
$msg->language = $this->language;
|
|
$msg->useDatabase = $this->useDatabase;
|
|
$msg->contextPage = $this->contextPage;
|
|
return $msg->plain();
|
|
}
|
|
|
|
}
|