Template
- Type
- Class
- Namespace
- craft\helpers
- Inherits
- craft\helpers\Template
- Since
- 3.0.0
Class Template
View source (opens new window)
# Public Methods
Method | Description |
---|---|
beginProfile() | Begins profiling a template element. |
contextWithoutTemplate() | Filters the template from a context array. |
css() | Registers a CSS file or a CSS code block. |
endProfile() | Finishes profiling a template element. |
fallback() | Provides dynamically-defined fallback variable’s value. |
fallbackExists() | Returns whether a fallback variable has been defined. |
js() | Registers a JS file or a JS code block. |
paginateCriteria() | Paginates a query. |
paginateQuery() | Paginates a query. |
preloadSingles() | Preloads Single section entries as fallback values for \craft\helpers\fallbackValue() |
raw() | Returns a string wrapped in a \Twig\Markup object |
resolveTemplatePathAndLine() | Attempts to resolve a compiled template file path and line number to its source template path and line number. |
# beginProfile()
- Since
- 3.3.0
Begins profiling a template element.
View source (opens new window)
Arguments
$type
(string (opens new window)) – The type of template element being profiled ('template', 'block', or 'macro')$name
(string (opens new window)) – The name of the template element
# contextWithoutTemplate()
- Since
- 4.4.0
Filters the template from a context array.
Used by the dump()
function and dd
tags.
View source (opens new window)
Arguments
$context
(array (opens new window))
Returns
# css()
- Since
- 3.5.6
Registers a CSS file or a CSS code block.
View source (opens new window)
Arguments
$css
(string (opens new window)) – The CSS file URL, or the content of the CSS code block to be registered$options
(array (opens new window)) – The HTML attributes for the<link>
/<style>
tag.$key
(string (opens new window), null (opens new window)) – The key that identifies the CSS code block. If null, it will use$css
as the key. If two CSS code blocks are registered with the same key, the latter will overwrite the former.
Throws
# endProfile()
- Since
- 3.3.0
Finishes profiling a template element.
View source (opens new window)
Arguments
$type
(string (opens new window)) – The type of template element being profiled ('template', 'block', or 'macro')$name
(string (opens new window)) – The name of the template element
# fallback()
- Since
- 4.4.0
Provides dynamically-defined fallback variable’s value.
View source (opens new window)
Arguments
$name
(string (opens new window))
Throws
- yii\base\UnknownPropertyException (opens new window)
if$name
isn’t defined as a fallback variable.
# fallbackExists()
- Since
- 4.4.0
Returns whether a fallback variable has been defined.
View source (opens new window)
Arguments
$name
(string (opens new window))
Returns
# js()
- Since
- 3.5.6
Registers a JS file or a JS code block.
View source (opens new window)
Arguments
$js
(string (opens new window)) – The JS file URL, or the content of the JS code block to be registered$options
(array (opens new window)) – The HTML attributes for the<script>
tag.$key
(string (opens new window), null (opens new window)) – The key that identifies the JS code block. If null, it will use $css as the key. If two JS code blocks are registered with the same key, the latter will overwrite the former.
Throws
# paginateCriteria()
DEPRECATED
Deprecated in 3.6.0. Use paginateQuery() instead.
Paginates a query.
View source (opens new window)
Arguments
Returns
# paginateQuery()
- Since
- 3.6.0
Paginates a query.
View source (opens new window)
Arguments
Returns
# preloadSingles()
- Since
- 4.4.0
Preloads Single section entries as fallback values for \craft\helpers\fallbackValue()
View source (opens new window)
Arguments
$handles
(string (opens new window)[])
# raw()
Returns a string wrapped in a \Twig\Markup object
View source (opens new window)
Arguments
$value
(string (opens new window))
Returns
\Twig\Markup
# resolveTemplatePathAndLine()
- Since
- 4.1.5
Attempts to resolve a compiled template file path and line number to its source template path and line number.
View source (opens new window)
Arguments
$path
(string (opens new window)) – The compiled template path$line
(integer (opens new window), null (opens new window)) – The line number from the compiled template
Returns
array (opens new window), false (opens new window) – The resolved template path and line number, or false
if the path couldn’t be determined.
If a template path could be determined but not the template line number, the line number will be null.
# Constants
Constant | Description |
---|---|
PROFILE_STAGE_BEGIN | |
PROFILE_STAGE_END | |
PROFILE_TYPE_BLOCK | |
PROFILE_TYPE_MACRO | |
PROFILE_TYPE_TEMPLATE |
← StringHelper Typecast →