Added release notes for 'ContentHandler::runLegacyHooks' removal
[mediawiki.git] / includes / skins / QuickTemplate.php
blob6686ae69c5bb4cbba87e9093e98627a65c91bbba
1 <?php
2 /**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
18 * @file
20 use MediaWiki\MediaWikiServices;
22 /**
23 * Generic wrapper for template functions, with interface
24 * compatible with what we use of PHPTAL 0.7.
25 * @ingroup Skins
27 abstract class QuickTemplate {
29 /** @var Config $config */
30 protected $config;
32 /**
33 * @param Config $config
35 function __construct( Config $config = null ) {
36 $this->data = [];
37 $this->translator = new MediaWikiI18N();
38 if ( $config === null ) {
39 wfDebug( __METHOD__ . ' was called with no Config instance passed to it' );
40 $config = MediaWikiServices::getInstance()->getMainConfig();
42 $this->config = $config;
45 /**
46 * Sets the value $value to $name
47 * @param string $name
48 * @param mixed $value
50 public function set( $name, $value ) {
51 $this->data[$name] = $value;
54 /**
55 * extends the value of data with name $name with the value $value
56 * @since 1.25
57 * @param string $name
58 * @param mixed $value
60 public function extend( $name, $value ) {
61 if ( $this->haveData( $name ) ) {
62 $this->data[$name] = $this->data[$name] . $value;
63 } else {
64 $this->data[$name] = $value;
68 /**
69 * Gets the template data requested
70 * @since 1.22
71 * @param string $name Key for the data
72 * @param mixed $default Optional default (or null)
73 * @return mixed The value of the data requested or the deafult
75 public function get( $name, $default = null ) {
76 if ( isset( $this->data[$name] ) ) {
77 return $this->data[$name];
78 } else {
79 return $default;
83 /**
84 * @param string $name
85 * @param mixed $value
87 public function setRef( $name, &$value ) {
88 $this->data[$name] =& $value;
91 /**
92 * @param MediaWikiI18N $t
94 public function setTranslator( &$t ) {
95 $this->translator = &$t;
98 /**
99 * Main function, used by classes that subclass QuickTemplate
100 * to show the actual HTML output
102 abstract public function execute();
105 * @private
106 * @param string $str
108 function text( $str ) {
109 echo htmlspecialchars( $this->data[$str] );
113 * @private
114 * @param string $str
116 function html( $str ) {
117 echo $this->data[$str];
121 * @private
122 * @param string $str
124 function msg( $str ) {
125 echo htmlspecialchars( $this->translator->translate( $str ) );
129 * @private
130 * @param string $str
132 function msgHtml( $str ) {
133 echo $this->translator->translate( $str );
137 * An ugly, ugly hack.
138 * @private
139 * @param string $str
141 function msgWiki( $str ) {
142 global $wgOut;
144 $text = $this->translator->translate( $str );
145 echo $wgOut->parse( $text );
149 * @private
150 * @param string $str
151 * @return bool
153 function haveData( $str ) {
154 return isset( $this->data[$str] );
158 * @private
160 * @param string $str
161 * @return bool
163 function haveMsg( $str ) {
164 $msg = $this->translator->translate( $str );
165 return ( $msg != '-' ) && ( $msg != '' ); # ????
169 * Get the Skin object related to this object
171 * @return Skin
173 public function getSkin() {
174 return $this->data['skin'];
178 * Fetch the output of a QuickTemplate and return it
180 * @since 1.23
181 * @return string
183 public function getHTML() {
184 ob_start();
185 $this->execute();
186 $html = ob_get_contents();
187 ob_end_clean();
188 return $html;