MediaWiki\Skin\QuickTemplate Class Reference

PHP-based skin template that holds data. More...

Inherited by MediaWiki\Skin\BaseTemplate.

Collaboration diagram for MediaWiki\Skin\QuickTemplate:

Public Member Functions
	__construct (?Config $config=null)
	deprecate (string $name, string $version)
	Sets a template key as deprecated.
	execute ()
	Main function, used by classes that subclass QuickTemplate to show the actual HTML output.
	extend ( $name, $value)
	extends the value of data with name $name with the value $value
	get ( $name, $default=null)
	Gets the template data requested.
	getHTML ()
	Fetch the output of a QuickTemplate and return it.
	getSkin ()
	Get the Skin object related to this object.
	html ( $str)
	msg ( $msgKey)
	set ( $name, $value)
	Sets the value $value to $name.

Public Attributes
array	$data

Protected Member Functions
	haveMsg ( $msgKey)
	text ( $str)

Protected Attributes
Config	$config

Detailed Description

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/).

Stability: stable

to extend

Definition at line 49 of file QuickTemplate.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Skin\QuickTemplate::__construct

(

?Config

$config = null

)

Parameters

Config | null

$config

Definition at line 66 of file QuickTemplate.php.

References MediaWiki\Skin\QuickTemplate\$config, MediaWiki\MediaWikiServices\getInstance(), and wfDebug().

Member Function Documentation

deprecate()

MediaWiki\Skin\QuickTemplate::deprecate	(	string	$name,
		string	$version )

Sets a template key as deprecated.

Access: internal

only for usage inside Skin and SkinTemplate class.

Parameters

string	$name
string	$version	When it was deprecated e.g. 1.38

Definition at line 82 of file QuickTemplate.php.

execute()

MediaWiki\Skin\QuickTemplate::execute ( )

abstract

Main function, used by classes that subclass QuickTemplate to show the actual HTML output.

Referenced by MediaWiki\Skin\QuickTemplate\getHTML().

extend()

MediaWiki\Skin\QuickTemplate::extend	(		$name,
			$value )

extends the value of data with name $name with the value $value

Since

1.25

Parameters

string	$name
mixed	$value

Definition at line 101 of file QuickTemplate.php.

get()

MediaWiki\Skin\QuickTemplate::get	(		$name,
			$default = null )

Gets the template data requested.

Since

1.22

Parameters

string	$name	Key for the data
mixed | null	$default	Optional default (or null)

Returns

mixed The value of the data requested or the default

Definition at line 130 of file QuickTemplate.php.

getHTML()

MediaWiki\Skin\QuickTemplate::getHTML

(

)

Fetch the output of a QuickTemplate and return it.

Since

1.23

Returns

string

Definition at line 198 of file QuickTemplate.php.

References MediaWiki\Skin\QuickTemplate\execute().

getSkin()

MediaWiki\Skin\QuickTemplate::getSkin

(

)

Get the Skin object related to this object.

Returns

SkinTemplate

Definition at line 188 of file QuickTemplate.php.

Referenced by MediaWiki\Skin\BaseTemplate\getFooter(), MediaWiki\Skin\BaseTemplate\getMsg(), MediaWiki\Skin\BaseTemplate\getPersonalTools(), MediaWiki\Skin\BaseTemplate\getSidebar(), MediaWiki\Skin\BaseTemplate\makeLink(), MediaWiki\Skin\BaseTemplate\makeListItem(), MediaWiki\Skin\BaseTemplate\makeSearchButton(), and MediaWiki\Skin\BaseTemplate\makeSearchInput().

haveMsg()

MediaWiki\Skin\QuickTemplate::haveMsg ( $msgKey )

protected

Parameters

string

$msgKey

Returns

bool

Definition at line 179 of file QuickTemplate.php.

References wfMessage().

html()

MediaWiki\Skin\QuickTemplate::html

(

$str

)

Parameters

string

$str

Definition at line 154 of file QuickTemplate.php.

msg()

MediaWiki\Skin\QuickTemplate::msg

(

$msgKey

)

Parameters

string

$msgKey

Reimplemented in MediaWiki\Skin\BaseTemplate.

Definition at line 162 of file QuickTemplate.php.

References MediaWiki\Skin\QuickTemplate\text(), and wfMessage().

set()

MediaWiki\Skin\QuickTemplate::set	(		$name,
			$value )

Sets the value $value to $name.

Parameters

string	$name
mixed	$value

Definition at line 91 of file QuickTemplate.php.

text()

MediaWiki\Skin\QuickTemplate::text ( $str )

protected

Parameters

string

$str

Definition at line 145 of file QuickTemplate.php.

Referenced by MediaWiki\Skin\QuickTemplate\msg().

Member Data Documentation

$config

Config MediaWiki\Skin\QuickTemplate::$config

protected

Definition at line 58 of file QuickTemplate.php.

Referenced by MediaWiki\Skin\QuickTemplate\__construct().

$data

array MediaWiki\Skin\QuickTemplate::$data

Definition at line 55 of file QuickTemplate.php.

---

The documentation for this class was generated from the following file:

• includes/Skin/QuickTemplate.php