MediaWiki master
MediaWiki\Html\TemplateParser Class Reference

Public Member Functions

 __construct ( $templateDir=null, ?BagOStuff $cache=null)
 
 enableRecursivePartials ( $enable)
 Enable/disable the use of recursive partials.
 
 processTemplate ( $templateName, $args, array $scopes=[])
 Returns HTML for a given template by calling the template function with the given args.
 

Protected Member Functions

 compile ( $templateName)
 Compile the Mustache template into PHP code using LightnCandy.
 
 getTemplate ( $templateName)
 Returns a given template function if found, otherwise throws an exception.
 
 getTemplateFilename ( $templateName)
 Constructs the location of the source Mustache template.
 

Protected Attributes

int $compileFlags
 Compilation flags passed to LightnCandy.
 
callable[] $renderers
 Array of cached rendering functions.
 
string $templateDir
 The path to the Mustache templates.
 

Detailed Description

Definition at line 35 of file TemplateParser.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Html\TemplateParser::__construct (   $templateDir = null,
?BagOStuff  $cache = null 
)
Parameters
string | null$templateDir
BagOStuff | null$cacheRead-write cache

Definition at line 64 of file TemplateParser.php.

References MediaWiki\Html\TemplateParser\$templateDir, CACHE_ANYTHING, and ObjectCache\getLocalServerInstance().

Member Function Documentation

◆ compile()

MediaWiki\Html\TemplateParser::compile (   $templateName)
protected

Compile the Mustache template into PHP code using LightnCandy.

The compilation step generates both PHP code and metadata, which is also returned in the result. An example result looks as follows:

[
'phpCode' => '...',
'files' => [
'/path/to/template.mustache',
'/path/to/partial1.mustache',
'/path/to/partial2.mustache',
'filesHash' => '...'
]

The files entry is a list of the files read during the compilation of the template. Each entry is the fully-qualified filename, i.e. it includes path information.

The filesHash entry can be used to determine whether the template has changed since it was last compiled without compiling the template again. Currently, the filesHash entry is generated with FileContentsHasher::getFileContentsHash.

Parameters
string$templateNameThe name of the template
Returns
array An associative array containing the PHP code and metadata about its compilation
Exceptions

\Exception Thrown by LightnCandy if it could not compile the Mustache code

Exceptions
RuntimeExceptionIf LightnCandy could not compile the Mustache code but did not throw an exception. This exception is indicative of a bug in LightnCandy

Definition at line 216 of file TemplateParser.php.

References FileContentsHasher\getFileContentsHash(), and MediaWiki\Html\TemplateParser\getTemplateFilename().

Referenced by MediaWiki\Html\TemplateParser\getTemplate().

◆ enableRecursivePartials()

MediaWiki\Html\TemplateParser::enableRecursivePartials (   $enable)

Enable/disable the use of recursive partials.

Parameters
bool$enable

Definition at line 77 of file TemplateParser.php.

◆ getTemplate()

MediaWiki\Html\TemplateParser::getTemplate (   $templateName)
protected

Returns a given template function if found, otherwise throws an exception.

Parameters
string$templateNameThe name of the template (without file suffix)
Returns
callable
Exceptions
RuntimeExceptionWhen the template file cannot be found
RuntimeExceptionWhen the compiled template isn't callable. This is indicative of a bug in LightnCandy

Definition at line 110 of file TemplateParser.php.

References MediaWiki\Html\TemplateParser\$compileFlags, MediaWiki\Html\TemplateParser\compile(), FileContentsHasher\getFileContentsHash(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\MediaWikiServices\hasInstance(), and MediaWiki\MainConfigNames\SecretKey.

Referenced by MediaWiki\Html\TemplateParser\processTemplate().

◆ getTemplateFilename()

MediaWiki\Html\TemplateParser::getTemplateFilename (   $templateName)
protected

Constructs the location of the source Mustache template.

Parameters
string$templateNameThe name of the template
Returns
string
Exceptions
UnexpectedValueExceptionIf $templateName attempts upwards directory traversal

Definition at line 91 of file TemplateParser.php.

Referenced by MediaWiki\Html\TemplateParser\compile().

◆ processTemplate()

MediaWiki\Html\TemplateParser::processTemplate (   $templateName,
  $args,
array  $scopes = [] 
)

Returns HTML for a given template by calling the template function with the given args.

echo $templateParser->processTemplate(
'ExampleTemplate',
[
'username' => $user->getName(),
'message' => 'Hello!'
]
);
$templateParser
Parameters
string$templateNameThe name of the template
mixed$args
array$scopes
Returns
string

Definition at line 295 of file TemplateParser.php.

References MediaWiki\Html\TemplateParser\getTemplate().

Member Data Documentation

◆ $compileFlags

int MediaWiki\Html\TemplateParser::$compileFlags
protected

Compilation flags passed to LightnCandy.

Definition at line 58 of file TemplateParser.php.

Referenced by MediaWiki\Html\TemplateParser\getTemplate().

◆ $renderers

callable [] MediaWiki\Html\TemplateParser::$renderers
protected

Array of cached rendering functions.

Definition at line 53 of file TemplateParser.php.

◆ $templateDir

string MediaWiki\Html\TemplateParser::$templateDir
protected

The path to the Mustache templates.

Definition at line 48 of file TemplateParser.php.

Referenced by MediaWiki\Html\TemplateParser\__construct().


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