Inheritance diagram for AbstractTemplate:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\View\DesignInterface $design, \Magento\Framework\Registry $registry, \Magento\Store\Model\App\Emulation $appEmulation, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\View\Asset\Repository $assetRepo, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Email\Model\Template\Config $emailConfig, \Magento\Email\Model\TemplateFactory $templateFactory, \Magento\Framework\Filter\FilterManager $filterManager, \Magento\Framework\UrlInterface $urlModel, array $data=[])

	getTemplateContent ($configPath, array $variables)

	loadByConfigPath ($configPath)

	loadDefault ($templateId)

	getProcessedTemplate (array $variables=[])

	getDefaultEmailLogo ()

	setForcedArea ($templateId)

	setForcedTheme ($templateId, $theme)

	getDesignParams ()

	getDesignConfig ()

	setDesignConfig (array $config)

	isChildTemplate ()

	setIsChildTemplate ($isChildTemplate)

	setTemplateFilter (Template\Filter $filter)

	getTemplateFilter ()

	emulateDesign ($storeId, $area=self::DEFAULT_DESIGN_AREA)

	revertDesign ()

	isPlain ()

	getType ()

	getUrl (Store $store, $route='', $params=[])

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	DEFAULT_DESIGN_AREA = 'frontend'

const	DEFAULT_LOGO_FILE_ID = 'Magento_Email::logo_email.png'

const	XML_PATH_DESIGN_EMAIL_LOGO = 'design/email/logo'

const	XML_PATH_DESIGN_EMAIL_LOGO_ALT = 'design/email/logo_alt'

const	XML_PATH_DESIGN_EMAIL_LOGO_WIDTH = 'design/email/logo_width'

const	XML_PATH_DESIGN_EMAIL_LOGO_HEIGHT = 'design/email/logo_height'

Data Fields inherited from TemplateTypesInterface
const	TYPE_TEXT = 1

const	TYPE_HTML = 2

Protected Member Functions
	getTemplateInstance ()

	getLogoUrl ($store)

	getLogoAlt ($store)

	addEmailVariables ($variables, $storeId)

	applyDesignConfig ()

	cancelDesignConfig ()

	getFilterFactory ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$templateFactory = null

	$design = null

	$appEmulation

	$storeManager

	$assetRepo

	$filesystem

	$scopeConfig

	$emailConfig

	$filterManager

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Template model class

Author: Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields) @api

Since: 100.0.2

Definition at line 27 of file AbstractTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\View\DesignInterface	$design,
		\Magento\Framework\Registry	$registry,
		\Magento\Store\Model\App\Emulation	$appEmulation,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\View\Asset\Repository	$assetRepo,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Email\Model\Template\Config	$emailConfig,
		\Magento\Email\Model\TemplateFactory	$templateFactory,
		\Magento\Framework\Filter\FilterManager	$filterManager,
		\Magento\Framework\UrlInterface	$urlModel,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\View\DesignInterface	$design
\Magento\Framework\Registry	$registry
\Magento\Store\Model\App\Emulation	$appEmulation
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\View\Asset\Repository	$assetRepo
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Email\Model\Template\Config	$emailConfig
\Magento\Email\Model\TemplateFactory	$templateFactory
\Magento\Framework\Filter\FilterManager	$filterManager
\Magento\Framework\UrlInterface	$urlModel
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 183 of file AbstractTemplate.php.

       {
         $this->design = $design;
         $this->area = isset($data['area']) ? $data['area'] : null;
         $this->store = isset($data['store']) ? $data['store'] : null;
         $this->appEmulation = $appEmulation;
         $this->storeManager = $storeManager;
         $this->assetRepo = $assetRepo;
         $this->filesystem = $filesystem;
         $this->scopeConfig = $scopeConfig;
         $this->emailConfig = $emailConfig;
         $this->templateFactory = $templateFactory;
         $this->filterManager = $filterManager;
         $this->urlModel = $urlModel;
         parent::__construct($context, $registry, null, null, $data);
     }

Member Function Documentation

◆ addEmailVariables()

addEmailVariables	(	$variables,
		$storeId
	)

protected

Add variables that are used by transactional and newsletter emails

Parameters

array	$variables
null \| string \| bool \| int \| Store	$storeId

Returns: mixed

@SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 436 of file AbstractTemplate.php.

     {
         $store = $this->storeManager->getStore($storeId);
         if (!isset($variables['store'])) {
             $variables['store'] = $store;
         }
         if (!isset($variables['logo_url'])) {
             $variables['logo_url'] = $this->getLogoUrl($storeId);
         }
         if (!isset($variables['logo_alt'])) {
             $variables['logo_alt'] = $this->getLogoAlt($storeId);
         }
         if (!isset($variables['logo_width'])) {
             $variables['logo_width'] = $this->scopeConfig->getValue(
                 self::XML_PATH_DESIGN_EMAIL_LOGO_WIDTH,
                 ScopeInterface::SCOPE_STORE,
                 $store
             );
         }
         if (!isset($variables['logo_height'])) {
             $variables['logo_height'] = $this->scopeConfig->getValue(
                 self::XML_PATH_DESIGN_EMAIL_LOGO_HEIGHT,
                 ScopeInterface::SCOPE_STORE,
                 $store
             );
         }
         if (!isset($variables['store_phone'])) {
             $variables['store_phone'] = $this->scopeConfig->getValue(
                 StoreInformation::XML_PATH_STORE_INFO_PHONE,
                 ScopeInterface::SCOPE_STORE,
                 $store
             );
         }
         if (!isset($variables['store_hours'])) {
             $variables['store_hours'] = $this->scopeConfig->getValue(
                 StoreInformation::XML_PATH_STORE_INFO_HOURS,
                 ScopeInterface::SCOPE_STORE,
                 $store
             );
         }
         if (!isset($variables['store_email'])) {
             $variables['store_email'] = $this->scopeConfig->getValue(
                 'trans_email/ident_support/email',
                 ScopeInterface::SCOPE_STORE,
                 $store
             );
         }
         // If template is text mode, don't include styles
         if (!$this->isPlain() && !isset($variables['template_styles'])) {
             $variables['template_styles'] = $this->getTemplateStyles();
         }
 
         return $variables;
     }

◆ applyDesignConfig()

applyDesignConfig ( )

protected

Apply design config so that emails are processed within the context of the appropriate area/store/theme. Can be called multiple times without issue.

Returns: bool

Definition at line 497 of file AbstractTemplate.php.

     {
         // Only run app emulation if this is the parent template and emulation isn't already running.
         // Otherwise child will run inside parent emulation.
         if ($this->isChildTemplate() || $this->hasDesignBeenApplied) {
             return false;
         }
         $this->hasDesignBeenApplied = true;
 
         $designConfig = $this->getDesignConfig();
         $storeId = $designConfig->getStore();
         $area = $designConfig->getArea();
         if ($storeId !== null) {
             // Force emulation in case email is being sent from same store so that theme will be loaded. Helpful
             // for situations where emails may be sent from bootstrap files that load frontend store, but not theme
             $this->appEmulation->startEnvironmentEmulation($storeId, $area, true);
         }
         return true;
     }

◆ cancelDesignConfig()

cancelDesignConfig ( )

protected

Revert design settings to previous

Returns: $this

Definition at line 522 of file AbstractTemplate.php.

     {
         $this->appEmulation->stopEnvironmentEmulation();
         $this->hasDesignBeenApplied = false;
         return $this;
     }

◆ emulateDesign()

emulateDesign	(	$storeId,
		$area = `self::DEFAULT_DESIGN_AREA`
	)

Save current design config and replace with design config from specified store Event is not dispatched.

Parameters

null \| bool \| int \| string	$storeId
string	$area

Returns: void

Definition at line 674 of file AbstractTemplate.php.

     {
         if ($storeId !== null && $storeId !== false) {
             // save current design settings
             $this->emulatedDesignConfig = clone $this->getDesignConfig();
             if ($this->getDesignConfig()->getStore() != $storeId
                 || $this->getDesignConfig()->getArea() != $area
             ) {
                 $this->setDesignConfig(['area' => $area, 'store' => $storeId]);
                 $this->applyDesignConfig();
             }
         } else {
             $this->emulatedDesignConfig = false;
         }
     }

◆ getDefaultEmailLogo()

getDefaultEmailLogo ( )

Get default email logo image

Returns: string

Definition at line 371 of file AbstractTemplate.php.

     {
         $designParams = $this->getDesignParams();
         return $this->assetRepo->getUrlWithParams(
             self::DEFAULT_LOGO_FILE_ID,
             $designParams
         );
     }

◆ getDesignConfig()

getDesignConfig ( )

Get design configuration data

Returns: DataObject

Definition at line 582 of file AbstractTemplate.php.

     {
         if ($this->designConfig === null) {
             if ($this->area === null) {
                 $this->area = $this->design->getArea();
             }
             if ($this->store === null) {
                 $this->store = $this->storeManager->getStore()->getId();
             }
             $this->designConfig = new DataObject(
                 ['area' => $this->area, 'store' => $this->store]
             );
         }
         return $this->designConfig;
     }

◆ getDesignParams()

getDesignParams ( )

Returns the design params for the template being processed

Returns: array

Definition at line 565 of file AbstractTemplate.php.

     {
         return [
             // Retrieve area from getDesignConfig, rather than the getDesignTheme->getArea(), as the latter doesn't
             // return the emulated area
             'area' => $this->getDesignConfig()->getArea(),
             'theme' => $this->design->getDesignTheme()->getCode(),
             'themeModel' => $this->design->getDesignTheme(),
             'locale' => $this->design->getLocale(),
         ];
     }

◆ getFilterFactory()

getFilterFactory ( )

abstractprotected

Getter for filter factory that is specific to the type of template being processed

Returns: mixed

◆ getLogoAlt()

getLogoAlt ( $store )

protected

Return logo alt for emails

Parameters

Store | int | string $store

Returns: string

Definition at line 412 of file AbstractTemplate.php.

     {
         $store = $this->storeManager->getStore($store);
         $alt = $this->scopeConfig->getValue(
             self::XML_PATH_DESIGN_EMAIL_LOGO_ALT,
             ScopeInterface::SCOPE_STORE,
             $store
         );
         if ($alt) {
             return $alt;
         }
         return $store->getFrontendName();
     }

◆ getLogoUrl()

getLogoUrl ( $store )

protected

Return logo URL for emails. Take logo from theme if custom logo is undefined

Parameters

Store | int | string $store

Returns: string

Definition at line 386 of file AbstractTemplate.php.

     {
         $store = $this->storeManager->getStore($store);
         $fileName = $this->scopeConfig->getValue(
             self::XML_PATH_DESIGN_EMAIL_LOGO,
             ScopeInterface::SCOPE_STORE,
             $store
         );
         if ($fileName) {
             $uploadDir = \Magento\Email\Model\Design\Backend\Logo::UPLOAD_DIR;
             $mediaDirectory = $this->filesystem->getDirectoryRead(DirectoryList::MEDIA);
             if ($mediaDirectory->isFile($uploadDir . '/' . $fileName)) {
                 return $this->storeManager->getStore()->getBaseUrl(
                     \Magento\Framework\UrlInterface::URL_TYPE_MEDIA
                 ) . $uploadDir . '/' . $fileName;
             }
         }
         return $this->getDefaultEmailLogo();
     }

◆ getProcessedTemplate()

getProcessedTemplate ( array $variables = [] )

Process email template code

Parameters

array $variables

Returns: string

Exceptions

Definition at line 328 of file AbstractTemplate.php.

     {
         $processor = $this->getTemplateFilter()
             ->setUseSessionInUrl(false)
             ->setPlainTemplateMode($this->isPlain())
             ->setIsChildTemplate($this->isChildTemplate())
             ->setTemplateProcessor([$this, 'getTemplateContent']);
 
         $variables['this'] = $this;
 
         $isDesignApplied = $this->applyDesignConfig();
 
         // Set design params so that CSS will be loaded from the proper theme
         $processor->setDesignParams($this->getDesignParams());
 
         if (isset($variables['subscriber'])) {
             $storeId = $variables['subscriber']->getStoreId();
         } else {
             $storeId = $this->getDesignConfig()->getStore();
         }
         $processor->setStoreId($storeId);
 
         // Populate the variables array with store, store info, logo, etc. variables
         $variables = $this->addEmailVariables($variables, $storeId);
         $processor->setVariables($variables);
 
         try {
             $result = $processor->filter($this->getTemplateText());
         } catch (\Exception $e) {
             $this->cancelDesignConfig();
             throw new \LogicException(__($e->getMessage()), $e->getCode(), $e);
         }
         if ($isDesignApplied) {
             $this->cancelDesignConfig();
         }
         return $result;
     }

◆ getTemplateContent()

getTemplateContent	(		$configPath,
		array	$variables
	)

Get contents of the included template for template directive

Parameters

string	$configPath
array	$variables

Returns: string

Definition at line 220 of file AbstractTemplate.php.

     {
         $template = $this->getTemplateInstance();
 
         // Ensure child templates have the same area/store context as parent
         $template->setDesignConfig($this->getDesignConfig()->toArray())
             ->loadByConfigPath($configPath, $variables)
             ->setTemplateType($this->getType())
             ->setIsChildTemplate(true);
 
         // automatically strip tags if in a plain-text parent
         if ($this->isPlain()) {
             $templateText = $this->filterManager->stripTags($template->getTemplateText());
             $template->setTemplateText(trim($templateText));
         }
 
         $processedTemplate = $template->getProcessedTemplate($variables);
         if ($this->isPlain()) {
             $processedTemplate = trim($processedTemplate);
         }
 
         return $processedTemplate;
     }

◆ getTemplateFilter()

getTemplateFilter ( )

Get filter object for template processing

Returns: \Magento\Email\Model\Template\Filter

Definition at line 655 of file AbstractTemplate.php.

     {
         if (empty($this->templateFilter)) {
             $this->templateFilter = $this->getFilterFactory()->create();
             $this->templateFilter->setUseAbsoluteLinks($this->getUseAbsoluteLinks())
                 ->setStoreId($this->getDesignConfig()->getStore())
                 ->setUrlModel($this->urlModel);
         }
         return $this->templateFilter;
     }

◆ getTemplateInstance()

getTemplateInstance ( )

protected

Return a new instance of the template object. Used by the template directive.

Returns: \Magento\Email\Model\AbstractTemplate

Definition at line 249 of file AbstractTemplate.php.

     {
         return $this->templateFactory->create();
     }

◆ getType()

getType ( )

abstract

Getter for template type

Returns: int|string

Implements TemplateTypesInterface.

◆ getUrl()

getUrl	(	Store	$store,
			$route = `''`,
			$params = `[]`
	)

Generate URL for the specified store.

Parameters

Store	$store
string	$route
array	$params

Returns: string

Definition at line 736 of file AbstractTemplate.php.

     {
         $url = $this->urlModel->setScope($store);
         if ($this->storeManager->getStore()->getId() != $store->getId()) {
             $params['_scope_to_url'] = true;
         }
         return $url->getUrl($route, $params);
     }

◆ isChildTemplate()

isChildTemplate ( )

Check whether template is child of another template

Returns: bool

Definition at line 621 of file AbstractTemplate.php.

     {
         return $this->isChildTemplate;
     }

◆ isPlain()

isPlain ( )

Return true if template type eq text

Returns: boolean

Implements TemplateTypesInterface.

Definition at line 709 of file AbstractTemplate.php.

     {
         return $this->getType() == self::TYPE_TEXT;
     }

◆ loadByConfigPath()

loadByConfigPath ( $configPath )

Load template from database when overridden in configuration or load default from relevant file system location.

Parameters

string $configPath

Returns: \Magento\Email\Model\AbstractTemplate

Definition at line 260 of file AbstractTemplate.php.

     {
         $store = $this->getDesignConfig()->getStore();
         $templateId = $this->scopeConfig->getValue($configPath, ScopeInterface::SCOPE_STORE, $store);
 
         if (is_numeric($templateId)) {
             $this->load($templateId);
         } else {
             $this->loadDefault($templateId);
         }
         return $this;
     }

◆ loadDefault()

loadDefault ( $templateId )

Load default email template

Parameters

string $templateId

Returns: $this

trim copyright message

Definition at line 279 of file AbstractTemplate.php.

     {
         $designParams = $this->getDesignParams();
         $templateFile = $this->emailConfig->getTemplateFilename($templateId, $designParams);
         $templateType = $this->emailConfig->getTemplateType($templateId);
         $templateTypeCode = $templateType == 'html' ? self::TYPE_HTML : self::TYPE_TEXT;
         $this->setTemplateType($templateTypeCode);
 
         $rootDirectory = $this->filesystem->getDirectoryRead(DirectoryList::ROOT);
         $templateText = $rootDirectory->readFile($rootDirectory->getRelativePath($templateFile));
 
         if (preg_match('/^<!--[\w\W]+?-->/m', $templateText, $matches) && strpos($matches[0], 'Copyright') !== false) {
             $templateText = str_replace($matches[0], '', $templateText);
         }
 
         if (preg_match('/<!--@subject\s*(.*?)\s*@-->/u', $templateText, $matches)) {
             $this->setTemplateSubject($matches[1]);
             $templateText = str_replace($matches[0], '', $templateText);
         }
 
         if (preg_match('/<!--@vars\s*((?:.)*?)\s*@-->/us', $templateText, $matches)) {
             $this->setData('orig_template_variables', str_replace("\n", '', $matches[1]));
             $templateText = str_replace($matches[0], '', $templateText);
         }
 
         if (preg_match('/<!--@styles\s*(.*?)\s*@-->/s', $templateText, $matches)) {
             $this->setTemplateStyles($matches[1]);
             $templateText = str_replace($matches[0], '', $templateText);
         }
 
         // Remove comment lines and extra spaces
         $templateText = trim(preg_replace('#\{\*.*\*\}#suU', '', $templateText));
 
         $this->setTemplateText($templateText);
         $this->setId($templateId);
 
         return $this;
     }

◆ revertDesign()

revertDesign ( )

Revert to last design config, used before emulation

Returns: void

Definition at line 695 of file AbstractTemplate.php.

     {
         if ($this->emulatedDesignConfig) {
             $this->setDesignConfig($this->emulatedDesignConfig->getData());
             $this->cancelDesignConfig();
             $this->emulatedDesignConfig = false;
         }
     }

◆ setDesignConfig()

setDesignConfig ( array $config )

Initialize design information for template processing

Parameters

array $config

Returns: $this

Exceptions

LocalizedException

Definition at line 605 of file AbstractTemplate.php.

     {
         if (!isset($config['area']) || !isset($config['store'])) {
             throw new LocalizedException(
                 __('The design config needs an area and a store. Verify that both are set and try again.')
             );
         }
         $this->getDesignConfig()->setData($config);
         return $this;
     }

◆ setForcedArea()

setForcedArea ( $templateId )

Store the area associated with a template so that it will be returned by getDesignConfig and getDesignParams

Parameters

string $templateId

Returns: $this

Definition at line 535 of file AbstractTemplate.php.

     {
         if ($this->area === null) {
             $this->area = $this->emailConfig->getTemplateArea($templateId);
         }
 
         return $this;
     }

◆ setForcedTheme()

setForcedTheme	(	$templateId,
		$theme
	)

Manually set a theme that will be used by getParams

Used to force the loading of an email template from a specific theme

Parameters

string	$templateId
string	$theme

Returns: $this

Definition at line 553 of file AbstractTemplate.php.

     {
         $area = $this->emailConfig->getTemplateArea($templateId);
         $this->design->setDesignTheme($theme, $area);
         return $this;
     }

◆ setIsChildTemplate()

setIsChildTemplate ( $isChildTemplate )

Set whether template is child of another template

Parameters

bool $isChildTemplate

Returns: $this

Definition at line 632 of file AbstractTemplate.php.

     {
         $this->isChildTemplate = (bool) $isChildTemplate;
         return $this;
     }

◆ setTemplateFilter()

setTemplateFilter ( Template\Filter $filter )

Declare template processing filter

Parameters

\Magento\Email\Model\Template\Filter $filter

Returns: $this

Definition at line 644 of file AbstractTemplate.php.

     {
         $this->templateFilter = $filter;
         return $this;
     }

Field Documentation

◆ $appEmulation

$appEmulation

protected

Definition at line 125 of file AbstractTemplate.php.

◆ $assetRepo

$assetRepo

protected

Definition at line 137 of file AbstractTemplate.php.

◆ $design

$design = null

protected

Definition at line 120 of file AbstractTemplate.php.

◆ $emailConfig

$emailConfig

protected

Definition at line 154 of file AbstractTemplate.php.

◆ $filesystem

$filesystem

protected

Definition at line 142 of file AbstractTemplate.php.

◆ $filterManager

$filterManager

protected

Definition at line 159 of file AbstractTemplate.php.

◆ $scopeConfig

$scopeConfig

protected

Definition at line 149 of file AbstractTemplate.php.

◆ $storeManager

$storeManager

protected

Definition at line 130 of file AbstractTemplate.php.

◆ $templateFactory

$templateFactory = null

protected

Definition at line 113 of file AbstractTemplate.php.

◆ DEFAULT_DESIGN_AREA

const DEFAULT_DESIGN_AREA = 'frontend'

Default design area for emulation

Definition at line 32 of file AbstractTemplate.php.

◆ DEFAULT_LOGO_FILE_ID

const DEFAULT_LOGO_FILE_ID = 'Magento_Email::logo_email.png'

Default path to email logo

Definition at line 37 of file AbstractTemplate.php.

◆ XML_PATH_DESIGN_EMAIL_LOGO

const XML_PATH_DESIGN_EMAIL_LOGO = 'design/email/logo'

Email logo url

Definition at line 42 of file AbstractTemplate.php.

◆ XML_PATH_DESIGN_EMAIL_LOGO_ALT

const XML_PATH_DESIGN_EMAIL_LOGO_ALT = 'design/email/logo_alt'

Email logo alt text

Definition at line 47 of file AbstractTemplate.php.

◆ XML_PATH_DESIGN_EMAIL_LOGO_HEIGHT

const XML_PATH_DESIGN_EMAIL_LOGO_HEIGHT = 'design/email/logo_height'

Email logo height

Definition at line 57 of file AbstractTemplate.php.

◆ XML_PATH_DESIGN_EMAIL_LOGO_WIDTH

const XML_PATH_DESIGN_EMAIL_LOGO_WIDTH = 'design/email/logo_width'

Email logo width

Definition at line 52 of file AbstractTemplate.php.

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

vendor/magento/module-email/Model/AbstractTemplate.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addEmailVariables()

◆ applyDesignConfig()

◆ cancelDesignConfig()

◆ emulateDesign()

◆ getDefaultEmailLogo()

◆ getDesignConfig()

◆ getDesignParams()

◆ getFilterFactory()

◆ getLogoAlt()

◆ getLogoUrl()

◆ getProcessedTemplate()

◆ getTemplateContent()

◆ getTemplateFilter()

◆ getTemplateInstance()

◆ getType()

◆ getUrl()

◆ isChildTemplate()

◆ isPlain()

◆ loadByConfigPath()

◆ loadDefault()

◆ revertDesign()

◆ setDesignConfig()

◆ setForcedArea()

◆ setForcedTheme()

◆ setIsChildTemplate()

◆ setTemplateFilter()

Field Documentation

◆ $appEmulation

◆ $assetRepo

◆ $design

◆ $emailConfig

◆ $filesystem

◆ $filterManager

◆ $scopeConfig

◆ $storeManager

◆ $templateFactory

◆ DEFAULT_DESIGN_AREA

◆ DEFAULT_LOGO_FILE_ID

◆ XML_PATH_DESIGN_EMAIL_LOGO

◆ XML_PATH_DESIGN_EMAIL_LOGO_ALT

◆ XML_PATH_DESIGN_EMAIL_LOGO_HEIGHT

◆ XML_PATH_DESIGN_EMAIL_LOGO_WIDTH