QuickTemplate.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Skin;
 
use MediaWiki\Config\Config;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\MediaWikiServices;
 
abstract class QuickTemplate {
    use ProtectedHookAccessorTrait;
 
    public $data;
 
    protected $config;
 
    private $deprecated = [];
 
    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;
    }
 
    public function deprecate( string $name, string $version ) {
        $this->deprecated[$name] = $version;
    }
 
    public function set( $name, $value ) {
        $this->data[$name] = $value;
    }
 
    public function extend( $name, $value ) {
        if ( $this->haveData( $name ) ) {
            $this->data[$name] .= $value;
        } else {
            $this->data[$name] = $value;
        }
    }
 
    private function checkDeprecationStatus( string $name ) {
        $deprecated = $this->deprecated[ $name ] ?? false;
        if ( $deprecated ) {
            wfDeprecated(
                'QuickTemplate::(get/html/text/haveData) with parameter `' . $name . '`',
                $deprecated
            );
        }
    }
 
    public function get( $name, $default = null ) {
        $this->checkDeprecationStatus( $name );
        return $this->data[$name] ?? $default;
    }
 
    abstract public function execute();
 
    protected function text( $str ) {
        $this->checkDeprecationStatus( $str );
        echo htmlspecialchars( $this->data[$str] );
    }
 
    public function html( $str ) {
        $this->checkDeprecationStatus( $str );
        echo $this->data[$str];
    }
 
    public function msg( $msgKey ) {
        echo htmlspecialchars( wfMessage( $msgKey )->text() );
    }
 
    private function haveData( $str ) {
        $this->checkDeprecationStatus( $str );
        return isset( $this->data[$str] );
    }
 
    protected function haveMsg( $msgKey ) {
        return !wfMessage( $msgKey )->isDisabled();
    }
 
    public function getSkin() {
        return $this->data['skin'];
    }
 
    public function getHTML() {
        ob_start();
        $this->execute();
        $html = ob_get_contents();
        ob_end_clean();
        return $html;
    }
}
 
class_alias( QuickTemplate::class, 'QuickTemplate' );