includes/skins/QuickTemplate.php

   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.
   7  *
   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.
  12  *
  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
  17  *
  18  * @file
  19  */
  20 use MediaWiki\MediaWikiServices;
  21
  22 /**
  23  * Generic wrapper for template functions, with interface
  24  * compatible with what we use of PHPTAL 0.7.
  25  * @ingroup Skins
  26  */
  27 abstract class QuickTemplate {
  28
  29         /**
  30          * @var array
  31          */
  32         public $data;
  33
  34         /** @var Config $config */
  35         protected $config;
  36
  37         /**
  38          * @param Config $config
  39          */
  40         function __construct( Config $config = null ) {
  41                 $this->data = [];
  42                 if ( $config === null ) {
  43                         wfDebug( __METHOD__ . ' was called with no Config instance passed to it' );
  44                         $config = MediaWikiServices::getInstance()->getMainConfig();
  45                 }
  46                 $this->config = $config;
  47         }
  48
  49         /**
  50          * Sets the value $value to $name
  51          * @param string $name
  52          * @param mixed $value
  53          */
  54         public function set( $name, $value ) {
  55                 $this->data[$name] = $value;
  56         }
  57
  58         /**
  59          * extends the value of data with name $name with the value $value
  60          * @since 1.25
  61          * @param string $name
  62          * @param mixed $value
  63          */
  64         public function extend( $name, $value ) {
  65                 if ( $this->haveData( $name ) ) {
  66                         $this->data[$name] = $this->data[$name] . $value;
  67                 } else {
  68                         $this->data[$name] = $value;
  69                 }
  70         }
  71
  72         /**
  73          * Gets the template data requested
  74          * @since 1.22
  75          * @param string $name Key for the data
  76          * @param mixed $default Optional default (or null)
  77          * @return mixed The value of the data requested or the deafult
  78          */
  79         public function get( $name, $default = null ) {
  80                 return $this->data[$name] ?? $default;
  81         }
  82
  83         /**
  84          * @deprecated since 1.31 This function is a now-redundant optimisation intended
  85          *  for very old versions of PHP. The use of references here makes the code
  86          *  more fragile and is incompatible with plans like T140664. Use set() instead.
  87          * @param string $name
  88          * @param mixed &$value
  89          */
  90         public function setRef( $name, &$value ) {
  91                 wfDeprecated( __METHOD__, '1.31' );
  92                 $this->data[$name] =& $value;
  93         }
  94
  95         /**
  96          * Main function, used by classes that subclass QuickTemplate
  97          * to show the actual HTML output
  98          */
  99         abstract public function execute();
 100
 101         /**
 102          * @private
 103          * @param string $str
 104          */
 105         function text( $str ) {
 106                 echo htmlspecialchars( $this->data[$str] );
 107         }
 108
 109         /**
 110          * @private
 111          * @param string $str
 112          */
 113         function html( $str ) {
 114                 echo $this->data[$str];
 115         }
 116
 117         /**
 118          * @private
 119          * @param string $msgKey
 120          */
 121         function msg( $msgKey ) {
 122                 echo htmlspecialchars( wfMessage( $msgKey )->text() );
 123         }
 124
 125         /**
 126          * @private
 127          * @param string $msgKey
 128          */
 129         function msgHtml( $msgKey ) {
 130                 echo wfMessage( $msgKey )->text();
 131         }
 132
 133         /**
 134          * An ugly, ugly hack.
 135          * @private
 136          * @param string $msgKey
 137          */
 138         function msgWiki( $msgKey ) {
 139                 global $wgOut;
 140
 141                 $text = wfMessage( $msgKey )->text();
 142                 echo $wgOut->parse( $text );
 143         }
 144
 145         /**
 146          * @private
 147          * @param string $str
 148          * @return bool
 149          */
 150         function haveData( $str ) {
 151                 return isset( $this->data[$str] );
 152         }
 153
 154         /**
 155          * @private
 156          *
 157          * @param string $msgKey
 158          * @return bool
 159          */
 160         function haveMsg( $msgKey ) {
 161                 $msg = wfMessage( $msgKey );
 162                 return $msg->exists() && !$msg->isDisabled();
 163         }
 164
 165         /**
 166          * Get the Skin object related to this object
 167          *
 168          * @return Skin
 169          */
 170         public function getSkin() {
 171                 return $this->data['skin'];
 172         }
 173
 174         /**
 175          * Fetch the output of a QuickTemplate and return it
 176          *
 177          * @since 1.23
 178          * @return string
 179          */
 180         public function getHTML() {
 181                 ob_start();
 182                 $this->execute();
 183                 $html = ob_get_contents();
 184                 ob_end_clean();
 185                 return $html;
 186         }
 187 }