MediaWiki  master
QuickTemplate Class Reference

Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0.7. More...

Inheritance diagram for QuickTemplate:

Public Member Functions

 __construct (Config $config=null)
 
 execute ()
 Main function, used by classes that subclass QuickTemplate to show the actual HTML output. More...
 
 extend ( $name, $value)
 extends the value of data with name $name with the value $value More...
 
 get ( $name, $default=null)
 Gets the template data requested. More...
 
 getHTML ()
 Fetch the output of a QuickTemplate and return it. More...
 
 getSkin ()
 Get the Skin object related to this object. More...
 
 haveData ( $str)
 
 haveMsg ( $msgKey)
 
 html ( $str)
 
 msg ( $msgKey)
 
 msgWiki ( $msgKey)
 An ugly, ugly hack. More...
 
 set ( $name, $value)
 Sets the value $value to $name. More...
 
 text ( $str)
 

Public Attributes

array $data
 

Protected Attributes

 $config
 

Detailed Description

Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0.7.

Definition at line 27 of file QuickTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

QuickTemplate::__construct ( Config  $config = null)
Parameters
Config | null$config

Definition at line 40 of file QuickTemplate.php.

References $config, and wfDebug().

Member Function Documentation

◆ execute()

QuickTemplate::execute ( )
abstract

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

Referenced by get(), and getHTML().

◆ extend()

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 64 of file QuickTemplate.php.

References haveData().

◆ get()

QuickTemplate::get (   $name,
  $default = null 
)

Gets the template data requested.

Since
1.22
Parameters
string$nameKey for the data
mixed | null$defaultOptional default (or null)
Returns
mixed The value of the data requested or the deafult
-taint onlysafefor_htmlnoent

Definition at line 80 of file QuickTemplate.php.

References execute().

◆ getHTML()

QuickTemplate::getHTML ( )

Fetch the output of a QuickTemplate and return it.

Since
1.23
Returns
string

Definition at line 164 of file QuickTemplate.php.

References execute().

◆ getSkin()

QuickTemplate::getSkin ( )

Get the Skin object related to this object.

Returns
Skin

Definition at line 154 of file QuickTemplate.php.

Referenced by BaseTemplate\getFooter(), BaseTemplate\getMsg(), and BaseTemplate\getTrail().

◆ haveData()

QuickTemplate::haveData (   $str)
Access:
private
Parameters
string$str
Returns
bool

Definition at line 134 of file QuickTemplate.php.

Referenced by extend().

◆ haveMsg()

QuickTemplate::haveMsg (   $msgKey)
Access:
private
Parameters
string$msgKey
Returns
bool

Definition at line 144 of file QuickTemplate.php.

References wfMessage().

◆ html()

QuickTemplate::html (   $str)
Access:
private
Parameters
string$strSecurityCheck-XSS phan-taint-check cannot tell if $str is pre-escaped

Definition at line 104 of file QuickTemplate.php.

Referenced by SkinApiTemplate\execute(), and SkinFallbackTemplate\execute().

◆ msg()

QuickTemplate::msg (   $msgKey)
Access:
private
Parameters
string$msgKey

Definition at line 112 of file QuickTemplate.php.

References text(), and wfMessage().

◆ msgWiki()

QuickTemplate::msgWiki (   $msgKey)

An ugly, ugly hack.

Deprecated:
since 1.33 Use ->msg() instead.
Parameters
string$msgKey

Definition at line 121 of file QuickTemplate.php.

References $wgOut, wfDeprecated(), and wfMessage().

◆ set()

QuickTemplate::set (   $name,
  $value 
)

Sets the value $value to $name.

Parameters
string$name
mixed$value

Definition at line 54 of file QuickTemplate.php.

◆ text()

QuickTemplate::text (   $str)
Access:
private
Parameters
string$strSecurityCheck-DoubleEscaped $this->data can be either

Definition at line 95 of file QuickTemplate.php.

Referenced by msg().

Member Data Documentation

◆ $config

QuickTemplate::$config
protected

Definition at line 35 of file QuickTemplate.php.

Referenced by __construct().

◆ $data

array QuickTemplate::$data

Definition at line 32 of file QuickTemplate.php.


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