Inheritance diagram for Template:

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\Framework\App\RequestInterface $request, \Magento\Newsletter\Model\Template\FilterFactory $filterFactory, array $data=[])

	validate ()

	beforeSave ()

	getType ()

	getProcessedTemplateSubject (array $variables)

	getTemplateText ()

	isValidForSend ()

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)

Protected Member Functions
	_construct ()

	getFilterFactory ()

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
	$_mail

	$_storeManager

	$_request

	$_filterFactory

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 = []

Additional Inherited Members
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

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

Detailed Description

Template model

@method string getTemplateCode() @method \Magento\Newsletter\Model\Template setTemplateCode(string $value) @method \Magento\Newsletter\Model\Template setTemplateText(string $value) @method \Magento\Newsletter\Model\Template setTemplateTextPreprocessed(string $value) @method string getTemplateStyles() @method \Magento\Newsletter\Model\Template setTemplateStyles(string $value) @method int getTemplateType() @method \Magento\Newsletter\Model\Template setTemplateType(int $value) @method string getTemplateSubject() @method \Magento\Newsletter\Model\Template setTemplateSubject(string $value) @method string getTemplateSenderName() @method \Magento\Newsletter\Model\Template setTemplateSenderName(string $value) @method string getTemplateSenderEmail() @method \Magento\Newsletter\Model\Template setTemplateSenderEmail(string $value) @method int getTemplateActual() @method \Magento\Newsletter\Model\Template setTemplateActual(int $value) @method string getAddedAt() @method \Magento\Newsletter\Model\Template setAddedAt(string $value) @method string getModifiedAt() @method \Magento\Newsletter\Model\Template setModifiedAt(string $value)

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

@api

Since: 100.0.2

Definition at line 38 of file Template.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\Framework\App\RequestInterface	$request,
		\Magento\Newsletter\Model\Template\FilterFactory	$filterFactory,
		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	The template directive requires an email template model, not newsletter model, as templates overridden in backend are loaded from email table.
\Magento\Framework\Filter\FilterManager	$filterManager
\Magento\Framework\Url \| \Magento\Framework\UrlInterface	$urlModel
\Magento\Framework\App\RequestInterface	$request
\Magento\Newsletter\Model\Template\FilterFactory	$filterFactory

Definition at line 88 of file Template.php.

       {
         parent::__construct(
             $context,
             $design,
             $registry,
             $appEmulation,
             $storeManager,
             $assetRepo,
             $filesystem,
             $scopeConfig,
             $emailConfig,
             $templateFactory,
             $filterManager,
             $urlModel,
             $data
         );
         $this->_storeManager = $storeManager;
         $this->_request = $request;
         $this->_filterFactory = $filterFactory;
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Initialize resource model

Returns: void

Definition at line 130 of file Template.php.

     {
         $this->_init(\Magento\Newsletter\Model\ResourceModel\Template::class);
     }

◆ beforeSave()

beforeSave ( )

Processing object before save data

Returns: $this

Definition at line 176 of file Template.php.

     {
         $this->validate();
         parent::beforeSave();
         return $this;
     }

◆ getFilterFactory()

getFilterFactory ( )

protected

Returns: \Magento\Newsletter\Model\Template\FilterFactory

Definition at line 232 of file Template.php.

     {
         return $this->_filterFactory;
     }

◆ getProcessedTemplateSubject()

getProcessedTemplateSubject ( array $variables )

Retrieve processed template subject

Parameters

array $variables

Returns: string

Definition at line 199 of file Template.php.

     {
         $variables['this'] = $this;
 
         return $this->getTemplateFilter()
             ->setVariables($variables)
             ->filter($this->getTemplateSubject());
     }

◆ getTemplateText()

getTemplateText ( )

Retrieve template text wrapper

Returns: string

Definition at line 213 of file Template.php.

     {
         if (!$this->getData('template_text') && !$this->getId()) {
             $this->setData(
                 'template_text',
                 __(
                     'Follow this link to unsubscribe <!-- This tag is for unsubscribe link  -->' .
                     '<a href="{{var subscriber.getUnsubscriptionLink()}}">{{var subscriber.getUnsubscriptionLink()}}' .
                     '</a>'
                 )
             );
         }
 
         return $this->getData('template_text');
     }

◆ getType()

getType ( )

Getter for template type

Returns: int|string

Implements TemplateTypesInterface.

Definition at line 188 of file Template.php.

     {
         return $this->getTemplateType();
     }

◆ isValidForSend()

isValidForSend ( )

Check if template can be added to newsletter queue

Returns: boolean

Definition at line 242 of file Template.php.

     {
         return $this->getTemplateSenderName() && $this->getTemplateSenderEmail() && $this->getTemplateSubject();
     }

◆ validate()

validate ( )

Validate Newsletter template

Returns: void

Exceptions

Definition at line 141 of file Template.php.

     {
         $validators = [
             'template_code' => [\Zend_Filter_Input::ALLOW_EMPTY => false],
             'template_type' => 'Int',
             'template_sender_email' => 'EmailAddress',
             'template_sender_name' => [\Zend_Filter_Input::ALLOW_EMPTY => false],
         ];
         $data = [];
         foreach (array_keys($validators) as $validateField) {
             $data[$validateField] = $this->getDataUsingMethod($validateField);
         }
 
         $validateInput = new \Zend_Filter_Input([], $validators, $data);
         if (!$validateInput->isValid()) {
             $errorMessages = [];
             foreach ($validateInput->getMessages() as $messages) {
                 if (is_array($messages)) {
                     foreach ($messages as $message) {
                         $errorMessages[] = $message;
                     }
                 } else {
                     $errorMessages[] = $messages;
                 }
             }
 
             throw new \Magento\Framework\Exception\LocalizedException(__(join("\n", $errorMessages)));
         }
     }

Field Documentation

◆ $_filterFactory

$_filterFactory

protected

Definition at line 67 of file Template.php.

◆ $_mail

$_mail

protected

Mail object

Deprecated:: Unused property

Definition at line 46 of file Template.php.

◆ $_request

$_request

protected

Definition at line 60 of file Template.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 53 of file Template.php.

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

vendor/magento/module-newsletter/Model/Template.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ beforeSave()

◆ getFilterFactory()

◆ getProcessedTemplateSubject()

◆ getTemplateText()

◆ getType()

◆ isValidForSend()

◆ validate()

Field Documentation

◆ $_filterFactory

◆ $_mail

◆ $_request

◆ $_storeManager