Documentation

Environment
in package

Application

Stores the Twig configuration and renders templates.

Constants

EXTRA_VERSION = ''
MAJOR_VERSION = 3
MINOR_VERSION = 22
RELEASE_VERSION = 2
VERSION = '3.22.2'
VERSION_ID = 32202

Properties

$autoReload : mixed
$cache : mixed
$charset : mixed
$compiler : mixed
$debug : mixed
$defaultRuntimeLoader : mixed
$extensionSet : mixed
$globals : array<string, mixed>
$hotCache : array<string|int, mixed>
$lexer : mixed
$loadedTemplates : mixed
$loader : mixed
$optionsHash : mixed
$originalCache : mixed
$parser : mixed
$resolvedGlobals : mixed
$runtimeLoaders : mixed
$runtimes : mixed
$strictVariables : mixed
$useYield : bool

Methods

__construct() : mixed: Constructor.
addExtension() : void
addFilter() : void
addFunction() : void
addGlobal() : void: Registers a Global.
addNodeVisitor() : void
addRuntimeLoader() : void
addTest() : void
addTokenParser() : void
compile() : string: Compiles a node and returns the PHP code.
compileSource() : string: Compiles a template source code.
createTemplate() : TemplateWrapper: Creates a template from source.
disableAutoReload() : void: Disables the auto_reload option.
disableDebug() : void: Disables debugging mode.
disableStrictVariables() : void: Disables the strict_variables option.
display() : void: Displays a template.
enableAutoReload() : void: Enables the auto_reload option.
enableDebug() : void: Enables debugging mode.
enableStrictVariables() : void: Enables the strict_variables option.
getCache() : CacheInterface|string|false: Gets the current cache implementation.
getCharset() : string
getExtension() : TExtension
getExtensions() : array<string|int, ExtensionInterface>
getGlobals() : array<string, mixed>
getLoader() : LoaderInterface
getRuntime() : TRuntime: Returns the runtime implementation of a Twig element (filter/function/tag/test).
hasExtension() : bool
isAutoReload() : bool: Checks if the auto_reload option is enabled.
isDebug() : bool: Checks if debug mode is enabled.
isStrictVariables() : bool: Checks if the strict_variables option is enabled.
isTemplateFresh() : bool: Returns true if the template is still fresh.
load() : TemplateWrapper: Loads a template.
mergeGlobals() : array<string|int, mixed>
parse() : ModuleNode: Converts a token stream to a node tree.
registerUndefinedFilterCallback() : void
registerUndefinedFunctionCallback() : void
registerUndefinedTestCallback() : void
registerUndefinedTokenParserCallback() : void
removeCache() : void
render() : string: Renders a template.
resetGlobals() : void
resolveTemplate() : TemplateWrapper: Tries to load a template consecutively from an array.
setCache() : void: Sets the current cache implementation.
setCharset() : void
setCompiler() : void
setExtensions() : void
setLexer() : void
setLoader() : void
setParser() : void
tokenize() : TokenStream
updateOptionsHash() : void

EXTRA_VERSION


    public
        mixed
    EXTRA_VERSION
    = ''

MAJOR_VERSION


    public
        mixed
    MAJOR_VERSION
    = 3

MINOR_VERSION


    public
        mixed
    MINOR_VERSION
    = 22

RELEASE_VERSION


    public
        mixed
    RELEASE_VERSION
    = 2

VERSION


    public
        mixed
    VERSION
    = '3.22.2'

VERSION_ID


    public
        mixed
    VERSION_ID
    = 32202

$autoReload


        private
            mixed
    $autoReload

$cache


        private
            mixed
    $cache

$charset


        private
            mixed
    $charset

$compiler


        private
            mixed
    $compiler

$debug


        private
            mixed
    $debug

$defaultRuntimeLoader


        private
            mixed
    $defaultRuntimeLoader

$extensionSet


        private
            mixed
    $extensionSet

$globals


        private
            array<string, mixed>
    $globals
     = []

$hotCache


        private
            array<string|int, mixed>
    $hotCache
     = []

$lexer


        private
            mixed
    $lexer

$loadedTemplates


        private
            mixed
    $loadedTemplates

$loader


        private
            mixed
    $loader

$optionsHash


        private
            mixed
    $optionsHash

$originalCache


        private
            mixed
    $originalCache

$parser


        private
            mixed
    $parser

$resolvedGlobals


        private
            mixed
    $resolvedGlobals

$runtimeLoaders


        private
            mixed
    $runtimeLoaders
     = []

$runtimes


        private
            mixed
    $runtimes
     = []

$strictVariables


        private
            mixed
    $strictVariables

$useYield


        private
            bool
    $useYield

__construct()

Constructor.


    public
                    __construct(LoaderInterface $loader[, array<string|int, mixed> $options = [] ]) : mixed

Available options:

debug: When set to true, it automatically set "auto_reload" to true as well (default to false).
charset: The charset used by the templates (default to UTF-8).
cache: An absolute path where to store the compiled templates, a \Twig\Cache\CacheInterface implementation, or false to disable compilation cache (default).
auto_reload: Whether to reload the template if the original source changed. If you don't provide the auto_reload option, it will be determined automatically based on the debug value.
strict_variables: Whether to ignore invalid variables in templates (default to false).
autoescape: Whether to enable auto-escaping (default to html): * false: disable auto-escaping * html, js: set the autoescaping to one of the supported strategies * name: set the autoescaping strategy based on the template name extension * PHP callback: a PHP callback that returns an escaping strategy based on the template "name"
optimizations: A flag that indicates which optimizations to apply (default to -1 which means that all optimizations are enabled; set it to 0 to disable).
use_yield: true: forces templates to exclusively use "yield" instead of "echo" (all extensions must be yield ready) false (default): allows templates to use a mix of "yield" and "echo" calls to allow for a progressive migration Switch to "true" when possible as this will be the only supported mode in Twig 4.0

Parameters

$loader : LoaderInterface
$options : array<string|int, mixed> = []

addExtension()


    public
                    addExtension(ExtensionInterface $extension) : void

Parameters

$extension : ExtensionInterface

addFilter()


    public
                    addFilter(TwigFilter $filter) : void

Parameters

$filter : TwigFilter

addFunction()


    public
                    addFunction(TwigFunction $function) : void

Parameters

$function : TwigFunction

addGlobal()

Registers a Global.


    public
                    addGlobal(string $name, mixed $value) : void

New globals can be added before compiling or rendering a template; but after, you can only update existing globals.

Parameters

$name : string
$value : mixed: The global value

addNodeVisitor()


    public
                    addNodeVisitor(NodeVisitorInterface $visitor) : void

Parameters

$visitor : NodeVisitorInterface

addRuntimeLoader()


    public
                    addRuntimeLoader(RuntimeLoaderInterface $loader) : void

Parameters

$loader : RuntimeLoaderInterface

addTest()


    public
                    addTest(TwigTest $test) : void

Parameters

$test : TwigTest

addTokenParser()


    public
                    addTokenParser(TokenParserInterface $parser) : void

Parameters

$parser : TokenParserInterface

compile()

Compiles a node and returns the PHP code.


    public
                    compile(Node $node) : string

Parameters

$node : Node

Return values

string

compileSource()

Compiles a template source code.


    public
                    compileSource(Source $source) : string

Parameters

$source : Source

Return values

string

createTemplate()

Creates a template from source.


    public
                    createTemplate(string $template[, string|null $name = null ]) : TemplateWrapper

This method should not be used as a generic way to load templates.

Parameters

$template : string: The template source
$name : string|null = null: An optional name of the template to be used in error messages

Return values

TemplateWrapper

disableAutoReload()

Disables the auto_reload option.


    public
                    disableAutoReload() : void

disableDebug()

Disables debugging mode.


    public
                    disableDebug() : void

disableStrictVariables()

Disables the strict_variables option.


    public
                    disableStrictVariables() : void

display()

Displays a template.


    public
                    display(string|TemplateWrapper $name[, array<string|int, mixed> $context = [] ]) : void

Parameters

$name : string|TemplateWrapper: The template name
$context : array<string|int, mixed> = []

enableAutoReload()

Enables the auto_reload option.


    public
                    enableAutoReload() : void

enableDebug()

Enables debugging mode.


    public
                    enableDebug() : void

enableStrictVariables()

Enables the strict_variables option.


    public
                    enableStrictVariables() : void

getCache()

Gets the current cache implementation.


    public
                    getCache([bool $original = true ]) : CacheInterface|string|false

Parameters

$original : bool = true: Whether to return the original cache option or the real cache instance

Return values

CacheInterface|string|false —

A Twig\Cache\CacheInterface implementation, an absolute path to the compiled templates, or false to disable cache

getCharset()


    public
                    getCharset() : string

Return values

string

getExtension()


    public
                    getExtension(TExtension> $class) : TExtension

Parameters

$class : TExtension>

Return values

TExtension

getExtensions()


    public
                    getExtensions() : array<string|int, ExtensionInterface>

Return values

array<string|int, ExtensionInterface> —

An array of extensions (keys are for internal usage only and should not be relied on)

getGlobals()


    public
                    getGlobals() : array<string, mixed>

Return values

array<string, mixed>

getLoader()


    public
                    getLoader() : LoaderInterface

Return values

LoaderInterface

getRuntime()

Returns the runtime implementation of a Twig element (filter/function/tag/test).


    public
                    getRuntime(TRuntime> $class) : TRuntime

Parameters

$class : TRuntime>: A runtime class name

Return values

TRuntime —

The runtime implementation

hasExtension()


    public
                    hasExtension(string $class) : bool

Parameters

$class : string

Return values

bool

isAutoReload()

Checks if the auto_reload option is enabled.


    public
                    isAutoReload() : bool

Return values

bool —

true if auto_reload is enabled, false otherwise

isDebug()

Checks if debug mode is enabled.


    public
                    isDebug() : bool

Return values

bool —

true if debug mode is enabled, false otherwise

isStrictVariables()

Checks if the strict_variables option is enabled.


    public
                    isStrictVariables() : bool

Return values

bool —

true if strict_variables is enabled, false otherwise

isTemplateFresh()

Returns true if the template is still fresh.


    public
                    isTemplateFresh(string $name, int $time) : bool

Besides checking the loader for freshness information, this method also checks if the enabled extensions have not changed.

Parameters

$name : string
$time : int: The last modification time of the cached template

Return values

bool

load()

Loads a template.


    public
                    load(string|TemplateWrapper $name) : TemplateWrapper

Parameters

$name : string|TemplateWrapper: The template name

Return values

TemplateWrapper

mergeGlobals()


    public
                    mergeGlobals(array<string|int, mixed> $context) : array<string|int, mixed>

since Twig 3.14

Parameters

$context : array<string|int, mixed>

Return values

array<string|int, mixed>

parse()

Converts a token stream to a node tree.


    public
                    parse(TokenStream $stream) : ModuleNode

Parameters

$stream : TokenStream

Return values

ModuleNode

registerUndefinedFilterCallback()


    public
                    registerUndefinedFilterCallback(
Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 78
callable(string): Array $callable) : void

Parameters

$callable : Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 78 callable(string): Array

registerUndefinedFunctionCallback()


    public
                    registerUndefinedFunctionCallback(
Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 78
callable(string): Array $callable) : void

Parameters

$callable : Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 78 callable(string): Array

registerUndefinedTestCallback()


    public
                    registerUndefinedTestCallback(
Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 78
callable(string): Array $callable) : void

Parameters

$callable : Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 78 callable(string): Array

registerUndefinedTokenParserCallback()


    public
                    registerUndefinedTokenParserCallback(
Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 78
callable(string): Array $callable) : void

Parameters

$callable : Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 78 callable(string): Array

removeCache()


    public
                    removeCache(string $name) : void

Parameters

$name : string

render()

Renders a template.


    public
                    render(string|TemplateWrapper $name[, array<string|int, mixed> $context = [] ]) : string

Parameters

$name : string|TemplateWrapper: The template name
$context : array<string|int, mixed> = []

Return values

string

resetGlobals()


    public
                    resetGlobals() : void

resolveTemplate()

Tries to load a template consecutively from an array.


    public
                    resolveTemplate(string|TemplateWrapper|array<string|int, string|TemplateWrapper> $names) : TemplateWrapper

Similar to load() but it also accepts instances of \Twig\TemplateWrapper and an array of templates where each is tried to be loaded.

Parameters

$names : string|TemplateWrapper|array<string|int, string|TemplateWrapper>: A template or an array of templates to try consecutively

Return values

TemplateWrapper

setCache()

Sets the current cache implementation.


    public
                    setCache(CacheInterface|string|false $cache) : void

Parameters

$cache : CacheInterface|string|false: A Twig\Cache\CacheInterface implementation, an absolute path to the compiled templates, or false to disable cache

setCharset()


    public
                    setCharset(string $charset) : void

Parameters

$charset : string

setCompiler()


    public
                    setCompiler(Compiler $compiler) : void

Parameters

$compiler : Compiler

setExtensions()


    public
                    setExtensions(array<string|int, ExtensionInterface> $extensions) : void

Parameters

$extensions : array<string|int, ExtensionInterface>: An array of extensions

setLexer()


    public
                    setLexer(Lexer $lexer) : void

Parameters

$lexer : Lexer

setLoader()


    public
                    setLoader(LoaderInterface $loader) : void

Parameters

$loader : LoaderInterface

setParser()


    public
                    setParser(Parser $parser) : void

Parameters

$parser : Parser

tokenize()


    public
                    tokenize(Source $source) : TokenStream

Parameters

$source : Source

Return values

TokenStream

updateOptionsHash()


    private
                    updateOptionsHash() : void

Environment in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

EXTRA_VERSION

MAJOR_VERSION

MINOR_VERSION

RELEASE_VERSION

VERSION

VERSION_ID

Properties

$autoReload

$cache

$charset

$compiler

$debug

$defaultRuntimeLoader

$extensionSet

$globals

$hotCache

$lexer

$loadedTemplates

$loader

$optionsHash

$originalCache

$parser

$resolvedGlobals

$runtimeLoaders

$runtimes

$strictVariables

$useYield

Methods

__construct()

Parameters

addExtension()

Parameters

addFilter()

Parameters

addFunction()

Parameters

addGlobal()

Parameters

addNodeVisitor()

Parameters

addRuntimeLoader()

Parameters

addTest()

Parameters

addTokenParser()

Parameters

compile()

Parameters

Return values

compileSource()

Parameters

Tags

Return values

createTemplate()

Parameters

Tags

Return values

disableAutoReload()

disableDebug()

disableStrictVariables()

display()

Parameters

Tags

enableAutoReload()

enableDebug()

enableStrictVariables()

getCache()

Parameters

Return values

getCharset()

Return values

getExtension()

Parameters

Environment
in package

Application