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|null $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] .= $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|null $default Optional default (or null)
  77          * @return mixed The value of the data requested or the deafult
  78          * @return-taint onlysafefor_htmlnoent
  79          */
  80         public function get( $name, $default = null ) {
  81                 return $this->data[$name] ?? $default;
  82         }
  83
  84         /**
  85          * @deprecated since 1.31 This function is a now-redundant optimisation intended
  86          *  for very old versions of PHP. The use of references here makes the code
  87          *  more fragile and is incompatible with plans like T140664. Use set() instead.
  88          * @param string $name
  89          * @param mixed &$value
  90          */
  91         public function setRef( $name, &$value ) {
  92                 wfDeprecated( __METHOD__, '1.31' );
  93                 $this->data[$name] =& $value;
  94         }
  95
  96         /**
  97          * Main function, used by classes that subclass QuickTemplate
  98          * to show the actual HTML output
  99          */
 100         abstract public function execute();
 101
 102         /**
 103          * @private
 104          * @param string $str
 105          * @suppress SecurityCheck-DoubleEscaped $this->data can be either
 106          */
 107         function text( $str ) {
 108                 echo htmlspecialchars( $this->data[$str] );
 109         }
 110
 111         /**
 112          * @private
 113          * @param string $str
 114          * @suppress SecurityCheck-XSS phan-taint-check cannot tell if $str is pre-escaped
 115          */
 116         function html( $str ) {
 117                 echo $this->data[$str];
 118         }
 119
 120         /**
 121          * @private
 122          * @param string $msgKey
 123          */
 124         function msg( $msgKey ) {
 125                 echo htmlspecialchars( wfMessage( $msgKey )->text() );
 126         }
 127
 128         /**
 129          * An ugly, ugly hack.
 130          * @deprecated since 1.33 Use ->msg() instead.
 131          * @param string $msgKey
 132          */
 133         function msgWiki( $msgKey ) {
 134                 wfDeprecated( __METHOD__, '1.33' );
 135                 global $wgOut;
 136
 137                 $text = wfMessage( $msgKey )->plain();
 138                 echo $wgOut->parseAsInterface( $text );
 139         }
 140
 141         /**
 142          * @private
 143          * @param string $str
 144          * @return bool
 145          */
 146         function haveData( $str ) {
 147                 return isset( $this->data[$str] );
 148         }
 149
 150         /**
 151          * @private
 152          *
 153          * @param string $msgKey
 154          * @return bool
 155          */
 156         function haveMsg( $msgKey ) {
 157                 $msg = wfMessage( $msgKey );
 158                 return $msg->exists() && !$msg->isDisabled();
 159         }
 160
 161         /**
 162          * Get the Skin object related to this object
 163          *
 164          * @return Skin
 165          */
 166         public function getSkin() {
 167                 return $this->data['skin'];
 168         }
 169
 170         /**
 171          * Fetch the output of a QuickTemplate and return it
 172          *
 173          * @since 1.23
 174          * @return string
 175          */
 176         public function getHTML() {
 177                 ob_start();
 178                 $this->execute();
 179                 $html = ob_get_contents();
 180                 ob_end_clean();
 181                 return $html;
 182         }
 183 }