ApiHelpParamValueMessage.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Message\Message;
 
class ApiHelpParamValueMessage extends Message {
 
    protected $paramValue;
    protected $deprecated;
    protected $internal;
 
    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;
    }
 
    public function getParamValue() {
        return $this->paramValue;
    }
 
    public function isDeprecated() {
        return $this->deprecated;
    }
 
    public function isInternal() {
        return $this->internal;
    }
 
    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();
    }
 
}
 
class_alias( ApiHelpParamValueMessage::class, 'ApiHelpParamValueMessage' );