Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0.7. More...
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) | |
| msgHtml ( $msgKey) | |
| msgWiki ( $msgKey) | |
| An ugly, ugly hack. More... | |
| set ( $name, $value) | |
| Sets the value $value to $name. More... | |
| setRef ( $name, &$value) | |
| 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()
Member Function Documentation
◆ execute()
|
abstract |
Main function, used by classes that subclass QuickTemplate to show the actual HTML output.
Reimplemented in SkinFallbackTemplate, MonoBookTemplate, VectorTemplate, SkinApiTemplate, and TimelessTemplate.
Referenced by 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 $name, $value, data, and haveData().
◆ get()
| 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 deafult
- -taint onlysafefor_htmlnoent
Definition at line 80 of file QuickTemplate.php.
◆ getHTML()
| QuickTemplate::getHTML | ( | ) |
Fetch the output of a QuickTemplate and return it.
- Since
- 1.23
- Returns
- string
Definition at line 189 of file QuickTemplate.php.
◆ getSkin()
| QuickTemplate::getSkin | ( | ) |
Get the Skin object related to this object.
- Returns
- Skin
Definition at line 179 of file QuickTemplate.php.
References data.
Referenced by TimelessTemplate\execute(), VectorTemplate\execute(), MonoBookTemplate\execute(), MonoBookTemplate\getBox(), TimelessTemplate\getCategories(), BaseTemplate\getFooter(), TimelessTemplate\getLogo(), BaseTemplate\getMsg(), TimelessTemplate\getPageTools(), MonoBookTemplate\getSimpleFooter(), BaseTemplate\getTrail(), and TimelessTemplate\getUserLinks().
◆ haveData()
| QuickTemplate::haveData | ( | $str | ) |
- Access:\n private
- Parameters
-
string $str
- Returns
- bool
Definition at line 159 of file QuickTemplate.php.
References data.
Referenced by extend().
◆ haveMsg()
| QuickTemplate::haveMsg | ( | $msgKey | ) |
- Access:\n private
- Parameters
-
string $msgKey
- Returns
- bool
Definition at line 169 of file QuickTemplate.php.
References wfMessage().
◆ html()
| QuickTemplate::html | ( | $str | ) |
- Access:\n private
- Parameters
-
string $str @suppress SecurityCheck-XSS phan-taint-check cannot tell if $str is pre-escaped
Definition at line 116 of file QuickTemplate.php.
References data.
Referenced by SkinApiTemplate\execute(), and SkinFallbackTemplate\execute().
◆ msg()
| QuickTemplate::msg | ( | $msgKey | ) |
- Access:\n private
- Parameters
-
string $msgKey
Reimplemented in BaseTemplate.
Definition at line 124 of file QuickTemplate.php.
References text(), and wfMessage().
◆ msgHtml()
| QuickTemplate::msgHtml | ( | $msgKey | ) |
- Access:\n private
- Parameters
-
string $msgKey
- Warning
- You should never use this method. I18n messages should be escaped
- Deprecated:
- 1.32 Use ->msg() instead. @suppress SecurityCheck-XSS
- Returns
- -taint exec_html
Reimplemented in BaseTemplate.
Definition at line 136 of file QuickTemplate.php.
References wfDeprecated(), and wfMessage().
◆ msgWiki()
| QuickTemplate::msgWiki | ( | $msgKey | ) |
An ugly, ugly hack.
- Deprecated:
- since 1.33 Use ->msg() instead.
- Parameters
-
string $msgKey
Reimplemented in BaseTemplate.
Definition at line 146 of file QuickTemplate.php.
References $wgOut, 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.
◆ setRef()
| QuickTemplate::setRef | ( | $name, | |
| & | $value | ||
| ) |
- Deprecated:
- since 1.31 This function is a now-redundant optimisation intended for very old versions of PHP.
The use of references here makes the code more fragile and is incompatible with plans like T140664. Use set() instead.
- Parameters
-
string $name mixed &$value
Definition at line 91 of file QuickTemplate.php.
References $name, $value, data, and wfDeprecated().
◆ text()
| QuickTemplate::text | ( | $str | ) |
- Access:\n private
- Parameters
-
string $str @suppress SecurityCheck-DoubleEscaped $this->data can be either
Definition at line 107 of file QuickTemplate.php.
References data.
Referenced by MonoBookTemplate\execute(), TimelessTemplate\getSidebarChunk(), and msg().
Member Data Documentation
◆ $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:
- includes/skins/QuickTemplate.php
