1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
<?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
*/
/**
* 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 {
protected $paramValue;
protected $deprecated;
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
* @throws InvalidArgumentException
* @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 = '';
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' );
}
$this->message = ";<span dir=\"ltr\" lang=\"en\">{$this->paramValue}</span>:"
. $prefix . parent::fetchMessage();
}
return $this->message;
}
private function subMessage( $key ) {
$msg = new Message( $key );
$msg->interface = $this->interface;
$msg->language = $this->language;
$msg->useDatabase = $this->useDatabase;
$msg->contextPage = $this->contextPage;
return $msg->fetchMessage();
}
}
|
