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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<?php
/**
* 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\Config\Config;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\MediaWikiServices;
/**
* PHP-based skin template that holds data.
*
* Modern usage with returned output:
*
* class MyTemplate extends QuickTemplate {
* public function execute() {
* $html = 'Hello, ' . Html::element( 'strong', [], $this->get( 'name' ) );
* echo $html;
* }
* }
* $tpl = new MyTemplate();
* $tpl->set( 'name', 'World' );
* $output = $tpl->getHTML();
*
* Classic usage with native HTML echo:
*
* class MyTemplate extends QuickTemplate {
* public function execute() { ?>
*
* Hello, <strong><?php $this->text( 'name' ); ?></strong>
*
* <?php
* }
* }
* $tpl = new MyTemplate();
* $tpl->set( 'name', 'World' );
*
* $tpl->execute(); // echo output
*
*
* QuickTemplate was originally developed as drop-in replacement for PHPTAL 0.7 (<http://phptal.org/>).
*
* @stable to extend
* @ingroup Skins
*/
abstract class QuickTemplate {
use ProtectedHookAccessorTrait;
/**
* @var array
*/
public $data;
/** @var Config */
protected $config;
/** @var array */
private $deprecated = [];
/**
* @param Config|null $config
*/
public function __construct( ?Config $config = null ) {
$this->data = [];
if ( $config === null ) {
wfDebug( __METHOD__ . ' was called with no Config instance passed to it' );
$config = MediaWikiServices::getInstance()->getMainConfig();
}
$this->config = $config;
}
/**
* Sets a template key as deprecated.
*
* @internal only for usage inside Skin and SkinTemplate class.
* @param string $name
* @param string $version When it was deprecated e.g. 1.38
*/
public function deprecate( string $name, string $version ) {
$this->deprecated[$name] = $version;
}
/**
* Sets the value $value to $name
* @param string $name
* @param mixed $value
*/
public function set( $name, $value ) {
$this->data[$name] = $value;
}
/**
* extends the value of data with name $name with the value $value
* @since 1.25
* @param string $name
* @param mixed $value
*/
public function extend( $name, $value ) {
if ( $this->haveData( $name ) ) {
$this->data[$name] .= $value;
} else {
$this->data[$name] = $value;
}
}
/**
* Checks if the template key is deprecated
*
* @param string $name
*/
private function checkDeprecationStatus( string $name ) {
$deprecated = $this->deprecated[ $name ] ?? false;
if ( $deprecated ) {
wfDeprecated(
'QuickTemplate::(get/html/text/haveData) with parameter `' . $name . '`',
$deprecated
);
}
}
/**
* Gets the template data requested
* @since 1.22
* @param string $name Key for the data
* @param mixed|null $default Optional default (or null)
* @return mixed The value of the data requested or the default
* @return-taint onlysafefor_htmlnoent
*/
public function get( $name, $default = null ) {
$this->checkDeprecationStatus( $name );
return $this->data[$name] ?? $default;
}
/**
* Main function, used by classes that subclass QuickTemplate
* to show the actual HTML output
*/
abstract public function execute();
/**
* @param string $str
* @suppress SecurityCheck-DoubleEscaped $this->data can be either
*/
protected function text( $str ) {
$this->checkDeprecationStatus( $str );
echo htmlspecialchars( $this->data[$str] );
}
/**
* @param string $str
* @suppress SecurityCheck-XSS phan-taint-check cannot tell if $str is pre-escaped
*/
public function html( $str ) {
$this->checkDeprecationStatus( $str );
echo $this->data[$str];
}
/**
* @param string $msgKey
*/
public function msg( $msgKey ) {
echo htmlspecialchars( wfMessage( $msgKey )->text() );
}
/**
* @param string $str
* @return bool
*/
private function haveData( $str ) {
$this->checkDeprecationStatus( $str );
return isset( $this->data[$str] );
}
/**
* @param string $msgKey
* @return bool
*/
protected function haveMsg( $msgKey ) {
$msg = wfMessage( $msgKey );
return $msg->exists() && !$msg->isDisabled();
}
/**
* Get the Skin object related to this object
*
* @return Skin
*/
public function getSkin() {
return $this->data['skin'];
}
/**
* Fetch the output of a QuickTemplate and return it
*
* @since 1.23
* @return string
*/
public function getHTML() {
ob_start();
$this->execute();
$html = ob_get_contents();
ob_end_clean();
return $html;
}
}
|
