PHP Класс Contao\Template

The class supports loading template files, adding variables to them and then printing them to the screen. It functions as abstract parent class for the two core classes "BackendTemplate" and "FrontendTemplate". Usage: $template = new BackendTemplate(); $template->name = 'Leo Feyer'; $template->output();
Наследование: extends Controller, use trait TemplateInheritance
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$arrData array Template data
$strBuffer string Output buffer
$strContentType string Content type
$validJavaScriptTypes array Valid JavaScipt types

Открытые методы

Метод Описание
__call ( string $strKey, array $arrParams ) : mixed Execute a callable and return the result
__construct ( string $strTemplate = '', string $strContentType = 'text/html' ) Create a new template object
__get ( string $strKey ) : mixed Return an object property
__isset ( string $strKey ) : boolean Check whether a property is set
__set ( string $strKey, mixed $varValue ) Set an object property
dumpTemplateVars ( ) Print all template variables to the screen using var_dump
flushAllData ( ) Flush the output buffers
generateFeedTag ( string $href, string $format, string $title ) : string Generate the markup for an RSS feed tag
generateInlineScript ( string $script ) : string Generate the markup for an inline JavaScript
generateInlineStyle ( string $script ) : string Generate the markup for inline CSS code
generateScriptTag ( string $src, boolean $async = false ) : string Generate the markup for a JavaScript tag
generateStyleTag ( string $href, string $media = null ) : string Generate the markup for a style sheet tag
getData ( ) : array Return the template data as array
getFormat ( ) : string Return the output format
getName ( ) : string Return the template name
getResponse ( ) : Response Return a response object
minifyHtml ( string $strHtml ) : string Minify the HTML markup preserving pre, script, style and textarea tags
output ( ) Parse the template file and print it to the screen
parse ( ) : string Parse the template file and return it as string
route ( string $strName, array $arrParams = [] ) : string Return a route relative to the base URL
setData ( array $arrData ) Set the template data from an array
setFormat ( string $strFormat ) Set the output format
setName ( string $strTemplate ) Set the template name
showTemplateVars ( ) Print all template variables to the screen using print_r

Защищенные методы

Метод Описание
compile ( ) Compile the template
getDebugBar ( ) : string Return the debug bar string

Описание методов

__call() публичный Метод

Execute a callable and return the result
public __call ( string $strKey, array $arrParams ) : mixed
$strKey string The name of the key
$arrParams array The parameters array
Результат mixed The callable return value

__construct() публичный Метод

Create a new template object
public __construct ( string $strTemplate = '', string $strContentType = 'text/html' )
$strTemplate string The template name
$strContentType string The content type (defaults to "text/html")

__get() публичный Метод

Return an object property
public __get ( string $strKey ) : mixed
$strKey string The property name
Результат mixed The property value

__isset() публичный Метод

Check whether a property is set
public __isset ( string $strKey ) : boolean
$strKey string The property name
Результат boolean True if the property is set

__set() публичный Метод

Set an object property
public __set ( string $strKey, mixed $varValue )
$strKey string The property name
$varValue mixed The property value

compile() защищенный Метод

Compile the template
protected compile ( )

dumpTemplateVars() публичный Метод

Print all template variables to the screen using var_dump
public dumpTemplateVars ( )

flushAllData() публичный Метод

Flush the output buffers
Устаревший: Deprecated since Contao 4.0, to be removed in Contao 5.0.
public flushAllData ( )

generateFeedTag() публичный статический Метод

Generate the markup for an RSS feed tag
public static generateFeedTag ( string $href, string $format, string $title ) : string
$href string The script path
$format string The feed format
$title string The feed title
Результат string The markup string

generateInlineScript() публичный статический Метод

Generate the markup for an inline JavaScript
public static generateInlineScript ( string $script ) : string
$script string The JavaScript code
Результат string The markup string

generateInlineStyle() публичный статический Метод

Generate the markup for inline CSS code
public static generateInlineStyle ( string $script ) : string
$script string The CSS code
Результат string The markup string

generateScriptTag() публичный статический Метод

Generate the markup for a JavaScript tag
public static generateScriptTag ( string $src, boolean $async = false ) : string
$src string The script path
$async boolean True to add the async attribute
Результат string The markup string

generateStyleTag() публичный статический Метод

Generate the markup for a style sheet tag
public static generateStyleTag ( string $href, string $media = null ) : string
$href string The script path
$media string The media type string
Результат string The markup string

getData() публичный Метод

Return the template data as array
public getData ( ) : array
Результат array The data array

getDebugBar() защищенный Метод

Return the debug bar string
Устаревший: Deprecated since Contao 4.0, to be removed in Contao 5.0.
protected getDebugBar ( ) : string
Результат string The debug bar markup

getFormat() публичный Метод

Return the output format
public getFormat ( ) : string
Результат string The output format

getName() публичный Метод

Return the template name
public getName ( ) : string
Результат string The template name

getResponse() публичный Метод

Return a response object
public getResponse ( ) : Response
Результат Symfony\Component\HttpFoundation\Response The response object

minifyHtml() публичный Метод

Minify the HTML markup preserving pre, script, style and textarea tags
public minifyHtml ( string $strHtml ) : string
$strHtml string The HTML markup
Результат string The minified HTML markup

output() публичный Метод

Parse the template file and print it to the screen
Устаревший: Deprecated since Contao 4.0, to be removed in Contao 5.0. Use Template::getResponse() instead.
public output ( )

parse() публичный Метод

Parse the template file and return it as string
public parse ( ) : string
Результат string The template markup

route() публичный Метод

Return a route relative to the base URL
public route ( string $strName, array $arrParams = [] ) : string
$strName string The route name
$arrParams array The route parameters
Результат string The route

setData() публичный Метод

Set the template data from an array
public setData ( array $arrData )
$arrData array The data array

setFormat() публичный Метод

Set the output format
public setFormat ( string $strFormat )
$strFormat string The output format

setName() публичный Метод

Set the template name
public setName ( string $strTemplate )
$strTemplate string The template name

showTemplateVars() публичный Метод

Print all template variables to the screen using print_r
public showTemplateVars ( )

Описание свойств

$arrData защищенное свойство

Template data
protected array $arrData
Результат array

$strBuffer защищенное свойство

Output buffer
protected string $strBuffer
Результат string

$strContentType защищенное свойство

Content type
protected string $strContentType
Результат string

$validJavaScriptTypes защищенное статическое свойство

Valid JavaScipt types
См. также: http://www.w3.org/TR/html5/scripting-1.html#scriptingLanguages
protected static array $validJavaScriptTypes
Результат array