Inheritance diagram for Template:

Public Member Functions
	__construct (\Magento\Framework\Stdlib\StringUtils $string, $variables=[])

	setVariables (array $variables)

	setTemplateProcessor (callable $callback)

	getTemplateProcessor ()

	filter ($value)

	addAfterFilterCallback (callable $afterFilterCallback)

	varDirective ($construction)

	templateDirective ($construction)

	dependDirective ($construction)

	ifDirective ($construction)

Data Fields
const	CONSTRUCTION_PATTERN = '/{{([a-z]{0,10})(.*?)}}/si'

const	CONSTRUCTION_DEPEND_PATTERN = '/{{depend\s(.?)}}(.?){{\\/depend\s}}/si'

const	CONSTRUCTION_IF_PATTERN = '/{{if\s(.?)}}(.?)({{else}}(.?))?{{\\/if\s*}}/si'

const	CONSTRUCTION_TEMPLATE_PATTERN = '/{{(template)(.*?)}}/si'

const	LOOP_PATTERN = '/{{for(?P<loopItem>.? )(in)(?P<loopData>.?)}}(?P<loopBody>.*?){{\/for}}/si'

Protected Member Functions
	afterFilter ($value)

	resetAfterFilterCallbacks ()

	getParameters ($value)

	getVariable ($value, $default='{no_value_defined}')

	getStackArgs ($stack)

Protected Attributes
	$templateVars = []

	$templateProcessor = null

	$string

Detailed Description

@api

Since: 100.0.2

Definition at line 16 of file Template.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Stdlib\StringUtils	$string,
			$variables = `[]`
	)

Parameters

\Magento\Framework\Stdlib\StringUtils	$string
array	$variables

Definition at line 69 of file Template.php.

     {
         $this->string = $string;
         $this->setVariables($variables);
     }

Member Function Documentation

◆ addAfterFilterCallback()

addAfterFilterCallback ( callable $afterFilterCallback )

Adds a callback to run after main filtering has happened. Callback must accept a single argument and return a string of the processed value.

Parameters

callable $afterFilterCallback

Returns: $this

Definition at line 238 of file Template.php.

     {
         // Only add callback if it doesn't already exist
         if (in_array($afterFilterCallback, $this->afterFilterCallbacks)) {
             return $this;
         }
 
         $this->afterFilterCallbacks[] = $afterFilterCallback;
         return $this;
     }

◆ afterFilter()

afterFilter ( $value )

protected

Runs callbacks that have been added to filter content after directive processing is finished.

Parameters

string $value

Returns: string

Definition at line 220 of file Template.php.

     {
         foreach ($this->afterFilterCallbacks as $callback) {
             $value = call_user_func($callback, $value);
         }
         // Since a single instance of this class can be used to filter content multiple times, reset callbacks to
         // prevent callbacks running for unrelated content (e.g., email subject and email body)
         $this->resetAfterFilterCallbacks();
         return $value;
     }

◆ dependDirective()

dependDirective ( $construction )

Parameters

string[] $construction

Returns: string

Definition at line 309 of file Template.php.

     {
         if (count($this->templateVars) == 0) {
             // If template processing
             return $construction[0];
         }
 
         if ($this->getVariable($construction[1], '') == '') {
             return '';
         } else {
             return $construction[2];
         }
     }

◆ filter()

filter ( $value )

Filter the string as template.

Parameters

string $value

Returns: string

Exceptions

Implements Zend_Filter_Interface.

Definition at line 119 of file Template.php.

     {
         // "depend", "if", and "template" directives should be first
         foreach ([
                      self::CONSTRUCTION_DEPEND_PATTERN => 'dependDirective',
                      self::CONSTRUCTION_IF_PATTERN => 'ifDirective',
                      self::CONSTRUCTION_TEMPLATE_PATTERN => 'templateDirective',
                  ] as $pattern => $directive) {
             if (preg_match_all($pattern, $value, $constructions, PREG_SET_ORDER)) {
                 foreach ($constructions as $construction) {
                     $callback = [$this, $directive];
                     if (!is_callable($callback)) {
                         continue;
                     }
                     try {
                         $replacedValue = call_user_func($callback, $construction);
                     } catch (\Exception $e) {
                         throw $e;
                     }
                     $value = str_replace($construction[0], $replacedValue, $value);
                 }
             }
         }
 
         $value = $this->filterFor($value);
 
         if (preg_match_all(self::CONSTRUCTION_PATTERN, $value, $constructions, PREG_SET_ORDER)) {
             foreach ($constructions as $construction) {
                 $callback = [$this, $construction[1] . 'Directive'];
                 if (!is_callable($callback)) {
                     continue;
                 }
                 try {
                     $replacedValue = call_user_func($callback, $construction);
                 } catch (\Exception $e) {
                     throw $e;
                 }
                 $value = str_replace($construction[0], $replacedValue, $value);
             }
         }
 
         $value = $this->afterFilter($value);
         return $value;
     }

◆ getParameters()

getParameters ( $value )

protected

Return associative array of parameters.

Parameters

string $value raw parameters

Returns: array

Definition at line 349 of file Template.php.

     {
         $tokenizer = new Template\Tokenizer\Parameter();
         $tokenizer->setString($value);
         $params = $tokenizer->tokenize();
         foreach ($params as $key => $value) {
             if (substr($value, 0, 1) === '$') {
                 $params[$key] = $this->getVariable(substr($value, 1), null);
             }
         }
         return $params;
     }

◆ getStackArgs()

getStackArgs ( $stack )

protected

Loops over a set of stack args to process variables into array argument values

Parameters

array $stack

Returns: array

Definition at line 434 of file Template.php.

     {
         foreach ($stack as $i => $value) {
             if (is_array($value)) {
                 $stack[$i] = $this->getStackArgs($value);
             } elseif (substr($value, 0, 1) === '$') {
                 $stack[$i] = $this->getVariable(substr($value, 1), null);
             }
         }
         return $stack;
     }

◆ getTemplateProcessor()

getTemplateProcessor ( )

Sets the processor for template directive.

Returns: callable|null

Definition at line 106 of file Template.php.

     {
         return is_callable($this->templateProcessor) ? $this->templateProcessor : null;
     }

◆ getVariable()

getVariable	(	$value,
		$default = `'{no_value_defined}'`
	)

protected

Return variable value for var construction

Parameters

string	$value	raw parameters
string	$default	default value

Returns: string @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 370 of file Template.php.

                                                        {no_value_defined}')
     {
         \Magento\Framework\Profiler::start('email_template_processing_variables');
         $tokenizer = new Template\Tokenizer\Variable();
         $tokenizer->setString($value);
         $stackVars = $tokenizer->tokenize();
         $result = $default;
         $last = 0;
         for ($i = 0; $i < count($stackVars); $i++) {
             if ($i == 0 && isset($this->templateVars[$stackVars[$i]['name']])) {
                 // Getting of template value
                 $stackVars[$i]['variable'] = & $this->templateVars[$stackVars[$i]['name']];
             } elseif (isset($stackVars[$i - 1]['variable'])
                     && $stackVars[$i - 1]['variable'] instanceof \Magento\Framework\DataObject
             ) {
                 // If data object calling methods or getting properties
                 if ($stackVars[$i]['type'] == 'property') {
                     $caller = 'get' . $this->string->upperCaseWords($stackVars[$i]['name'], '_', '');
                     $stackVars[$i]['variable'] = method_exists(
                         $stackVars[$i - 1]['variable'],
                         $caller
                     ) ? $stackVars[$i - 1]['variable']->{$caller}() : $stackVars[$i - 1]['variable']->getData(
                         $stackVars[$i]['name']
                     );
                 } elseif ($stackVars[$i]['type'] == 'method') {
                     // Calling of data object method
                     if (method_exists($stackVars[$i - 1]['variable'], $stackVars[$i]['name'])
                             || substr($stackVars[$i]['name'], 0, 3) == 'get'
                     ) {
                         $stackVars[$i]['args'] = $this->getStackArgs($stackVars[$i]['args']);
                         $stackVars[$i]['variable'] = call_user_func_array(
                             [$stackVars[$i - 1]['variable'], $stackVars[$i]['name']],
                             $stackVars[$i]['args']
                         );
                     }
                 }
                 $last = $i;
             } elseif (isset($stackVars[$i - 1]['variable']) && $stackVars[$i]['type'] == 'method') {
                 // Calling object methods
                 if (method_exists($stackVars[$i - 1]['variable'], $stackVars[$i]['name'])) {
                     $stackVars[$i]['args'] = $this->getStackArgs($stackVars[$i]['args']);
                     $stackVars[$i]['variable'] = call_user_func_array(
                         [$stackVars[$i - 1]['variable'], $stackVars[$i]['name']],
                         $stackVars[$i]['args']
                     );
                 }
                 $last = $i;
             }
         }
 
         if (isset($stackVars[$last]['variable'])) {
             // If value for construction exists set it
             $result = $stackVars[$last]['variable'];
         }
         \Magento\Framework\Profiler::stop('email_template_processing_variables');
         return $result;
     }

◆ ifDirective()

ifDirective ( $construction )

Parameters

string[] $construction

Returns: string

Definition at line 327 of file Template.php.

     {
         if (count($this->templateVars) == 0) {
             return $construction[0];
         }
 
         if ($this->getVariable($construction[1], '') == '') {
             if (isset($construction[3]) && isset($construction[4])) {
                 return $construction[4];
             }
             return '';
         } else {
             return $construction[2];
         }
     }

◆ resetAfterFilterCallbacks()

resetAfterFilterCallbacks ( )

protected

Resets the after filter callbacks

Returns: $this

Definition at line 254 of file Template.php.

     {
         $this->afterFilterCallbacks = [];
         return $this;
     }

◆ setTemplateProcessor()

setTemplateProcessor ( callable $callback )

Sets the processor for template directive.

Parameters

callable $callback it must return string

Returns: $this

Definition at line 95 of file Template.php.

     {
         $this->templateProcessor = $callback;
         return $this;
     }

◆ setVariables()

setVariables ( array $variables )

Sets template variables that's can be called through {var ...} statement

Parameters

array $variables

Returns: \Magento\Framework\Filter\Template

Definition at line 81 of file Template.php.

     {
         foreach ($variables as $name => $value) {
             $this->templateVars[$name] = $value;
         }
         return $this;
     }

◆ templateDirective()

templateDirective ( $construction )

Allows templates to be included inside other templates

Usage:

{{template config_path="<PATH>"}}

<PATH> equals the XPATH to the system configuration value that contains the value of the template. This directive is useful to include things like a global header/footer.

Parameters

string[] $construction

Returns: mixed

Definition at line 288 of file Template.php.

     {
         // Processing of {template config_path=... [...]} statement
         $templateParameters = $this->getParameters($construction[2]);
         if (!isset($templateParameters['config_path']) or !$this->getTemplateProcessor()) {
             // Not specified template or not set include processor
             $replacedValue = '{Error in template processing}';
         } else {
             // Including of template
             $configPath = $templateParameters['config_path'];
             unset($templateParameters['config_path']);
             $templateParameters = array_merge_recursive($templateParameters, $this->templateVars);
             $replacedValue = call_user_func($this->getTemplateProcessor(), $configPath, $templateParameters);
         }
         return $replacedValue;
     }

◆ varDirective()

varDirective ( $construction )

Parameters

string[] $construction

Returns: string

Definition at line 264 of file Template.php.

     {
         if (count($this->templateVars) == 0) {
             // If template prepossessing
             return $construction[0];
         }
 
         $replacedValue = $this->getVariable($construction[2], '');
         return $replacedValue;
     }

Field Documentation

◆ $string

$string

protected

Definition at line 63 of file Template.php.

◆ $templateProcessor

$templateProcessor = null

protected

Definition at line 58 of file Template.php.

◆ $templateVars

$templateVars = []

protected

Definition at line 51 of file Template.php.

◆ CONSTRUCTION_DEPEND_PATTERN

const CONSTRUCTION_DEPEND_PATTERN = '/{{depend\s*(.*?)}}(.*?){{\\/depend\s*}}/si'

Construction depend regular expression

Definition at line 26 of file Template.php.

◆ CONSTRUCTION_IF_PATTERN

const CONSTRUCTION_IF_PATTERN = '/{{if\s*(.*?)}}(.*?)({{else}}(.*?))?{{\\/if\s*}}/si'

Construction if regular expression

Definition at line 31 of file Template.php.

◆ CONSTRUCTION_PATTERN

const CONSTRUCTION_PATTERN = '/{{([a-z]{0,10})(.*?)}}/si'

Construction regular expression

Definition at line 21 of file Template.php.

◆ CONSTRUCTION_TEMPLATE_PATTERN

const CONSTRUCTION_TEMPLATE_PATTERN = '/{{(template)(.*?)}}/si'

Construction template regular expression

Definition at line 36 of file Template.php.

◆ LOOP_PATTERN

const LOOP_PATTERN = '/{{for(?P<loopItem>.*? )(in)(?P<loopData>.*?)}}(?P<loopBody>.*?){{\/for}}/si'

Construction for regular expression

Definition at line 41 of file Template.php.

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

vendor/magento/framework/Filter/Template.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAfterFilterCallback()

◆ afterFilter()

◆ dependDirective()

◆ filter()

◆ getParameters()

◆ getStackArgs()

◆ getTemplateProcessor()

◆ getVariable()

◆ ifDirective()

◆ resetAfterFilterCallbacks()

◆ setTemplateProcessor()

◆ setVariables()

◆ templateDirective()

◆ varDirective()

Field Documentation

◆ $string

◆ $templateProcessor

◆ $templateVars

◆ CONSTRUCTION_DEPEND_PATTERN

◆ CONSTRUCTION_IF_PATTERN

◆ CONSTRUCTION_PATTERN

◆ CONSTRUCTION_TEMPLATE_PATTERN

◆ LOOP_PATTERN