Magento Extensions Rating 2024
Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
BackendTemplate Class Reference
Inheritance diagram for BackendTemplate:
Template AbstractTemplate TemplateInterface AbstractModel TemplateTypesInterface TemplateTypesInterface DataObject

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, \Magento\Email\Model\Template\FilterFactory $filterFactory, \Magento\Config\Model\Config\Structure $structure, array $data=[], \Magento\Framework\Serialize\Serializer\Json $serializer=null)
 
 getSystemConfigPathsWhereCurrentlyUsed ()
 
- Public Member Functions inherited from Template
 __construct (\Magento\Framework\Model\Context $context, \Magento\Framework\View\DesignInterface $design, \Magento\Framework\Registry $registry, \Magento\Store\Model\App\Emulation $appEmulation, 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, \Magento\Email\Model\Template\FilterFactory $filterFactory, array $data=[], \Magento\Framework\Serialize\Serializer\Json $serializer=null)
 
 getId ()
 
 setId ($value)
 
 isValidForSend ()
 
 getType ()
 
 getSendingException ()
 
 getProcessedTemplateSubject (array $variables)
 
 addBcc ($bcc)
 
 setReturnPath ($email)
 
 setReplyTo ($email)
 
 getVariablesOptionArray ($withGroup=false)
 
 beforeSave ()
 
 processTemplate ()
 
 getSubject ()
 
 setVars (array $vars)
 
 setOptions (array $options)
 
- Public Member Functions inherited from AbstractTemplate
 __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)
 

Additional Inherited Members

- Data Fields inherited from Template
const XML_PATH_SENDING_SET_RETURN_PATH = 'system/smtp/set_return_path'
 
const XML_PATH_SENDING_RETURN_PATH_EMAIL = 'system/smtp/return_path_email'
 
const XML_PATH_SYSTEM_SMTP_DISABLE = 'system/smtp/disable'
 
- Data Fields inherited from AbstractTemplate
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 inherited from Template
 _construct ()
 
 _parseVariablesString ($variablesString)
 
 getFilterFactory ()
 
 _getVars ()
 
- Protected Member Functions inherited from AbstractTemplate
 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 inherited from Template
 $_bcc = []
 
 $_returnPath = ''
 
 $_replyTo = ''
 
 $_vars = []
 
 $_sendingException = null
 
- Protected Attributes inherited from AbstractTemplate
 $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 = []
 
- Static Protected Attributes inherited from DataObject
static $_underscoreCache = []
 

Detailed Description

Adminhtml email template model

@api

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since
100.0.2

Definition at line 18 of file BackendTemplate.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,
\Magento\Email\Model\Template\FilterFactory  $filterFactory,
\Magento\Config\Model\Config\Structure  $structure,
array  $data = [],
\Magento\Framework\Serialize\Serializer\Json  $serializer = null 
)
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
\Magento\Email\Model\Template\FilterFactory$filterFactory
\Magento\Config\Model\Config\Structure$structure
array$data
\Magento\Framework\Serialize\Serializer\Json | null$serializer@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 45 of file BackendTemplate.php.

62  {
63  $this->structure = $structure;
64  parent::__construct(
65  $context,
66  $design,
67  $registry,
68  $appEmulation,
69  $storeManager,
70  $assetRepo,
71  $filesystem,
72  $scopeConfig,
73  $emailConfig,
74  $templateFactory,
75  $filterManager,
76  $urlModel,
77  $filterFactory,
78  $data,
79  $serializer
80  );
81  }
$registry
$registry
Definition: bundle_product_with_not_visible_children_rollback.php:16
$data
$data
Definition: attribute_set_with_image_attribute.php:16

Member Function Documentation

◆ getSystemConfigPathsWhereCurrentlyUsed()

getSystemConfigPathsWhereCurrentlyUsed ( )

Collect all system config paths where current template is currently used

Returns
array

Definition at line 88 of file BackendTemplate.php.

89  {
90  $templateId = $this->getId();
91  if (!$templateId) {
92  return [];
93  }
94 
95  $templatePaths = $this->structure->getFieldPathsByAttribute(
96  'source_model',
97  \Magento\Config\Model\Config\Source\Email\Template::class
98  );
99 
100  if (!count($templatePaths)) {
101  return [];
102  }
103 
104  $configData = $this->_getResource()->getSystemConfigByPathsAndTemplateId($templatePaths, $templateId);
105  foreach ($templatePaths as $path) {
106  if ($this->scopeConfig->getValue($path, ScopeConfigInterface::SCOPE_TYPE_DEFAULT) == $templateId) {
107  foreach ($configData as $data) {
108  if ($data['path'] == $path) {
109  continue 2; // don't add final fallback value if it was found in stored config
110  }
111  }
112 
113  $configData[] = [
114  'scope' => ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
115  'path' => $path
116  ];
117  }
118  }
119 
120  return $configData;
121  }
$templateId
$templateId
Definition: queue.php:15
$data
$data
Definition: attribute_set_with_image_attribute.php:16
$configData
$configData
Definition: payment_configuration.php:26
$path
$path
Definition: import_with_filesystem_images.php:14
The documentation for this class was generated from the following file: