Class Mage_Newsletter_Model_Template

Description

Template model

Located in /Newsletter/Model/Template.php (line 34)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Core_Model_Template
         |
         --Mage_Newsletter_Model_Template
Variable Summary
Zend_Mail $_mail
Method Summary
string getInclude (string $templateCode,  $variables)
Zend_Mail getMail ()
string getPreparedTemplateText ([bool $usePreprocess = false])
string getProcessedTemplate ([ $variables = array()], [bool $usePreprocess = false])
string getProcessedTemplateSubject ( $variables)
string getTemplateText ()
int|string getType ()
bool isPreprocessed ()
boolean isValidForSend ()
Mage_Newsletter_Model_Template loadByCode (string $templateCode)
boolean send (Mage_Newsletter_Model_Subscriber|string $subscriber, [ $variables = array()], [string|null $name = null], [Mage_Newsletter_Model_Queue $queue = null])
bool validate ()
void _construct ()
Variables
Methods
getInclude (line 224)

Retrieve included template

  • access: public
string getInclude (string $templateCode,  $variables)
  • string $templateCode
  • array $variables
getMail (line 237)

Retrieve mail object instance

  • deprecated: since 1.4.0.1
  • access: public
Zend_Mail getMail ()
getPreparedTemplateText (line 205)

Makes additional text preparations for HTML templates

  • access: public
string getPreparedTemplateText ([bool $usePreprocess = false])
  • bool $usePreprocess: Use Preprocessed text or original text
getProcessedTemplate (line 173)

Retrieve processed template

  • access: public
string getProcessedTemplate ([ $variables = array()], [bool $usePreprocess = false])
  • array $variables
  • bool $usePreprocess
getProcessedTemplateSubject (line 345)

Retrieve processed template subject

  • access: public
string getProcessedTemplateSubject ( $variables)
  • array $variables
getTemplateText (line 362)

Retrieve template text wrapper

  • access: public
string getTemplateText ()
getTemplateTextPreprocessed (line 157)

Check Template Text Preprocessed

  • access: public
bool getTemplateTextPreprocessed ()
getType (line 138)

Getter for template type

  • access: public
int|string getType ()

Redefinition of:
Mage_Core_Model_Template::getType()
Getter for template type
isPreprocessed (line 147)

Check is Preprocessed

  • access: public
bool isPreprocessed ()
isValidForSend (line 125)

Return true if this template can be used for sending queue as main template

  • deprecated: since 1.4.0.1
  • access: public
boolean isValidForSend ()
loadByCode (line 113)

Load template by code

  • access: public
Mage_Newsletter_Model_Template loadByCode (string $templateCode)
  • string $templateCode
preprocess (line 331)

Prepare Process (with save)

  • deprecated: since 1.4.0.1
  • access: public
send (line 256)

Send mail to subscriber

  • deprecated: since 1.4.0.1
  • access: public
boolean send (Mage_Newsletter_Model_Subscriber|string $subscriber, [ $variables = array()], [string|null $name = null], [Mage_Newsletter_Model_Queue $queue = null])
validate (line 65)

Validate Newsletter template

  • throws: Mage_Core_Exception
  • access: public
bool validate ()
_beforeSave (line 101)

Processing object before save data

  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::_beforeSave()
Processing object before save data
_construct (line 54)

Initialize resource model

  • access: protected
void _construct ()

Inherited Methods

Inherited From Mage_Core_Model_Template

Mage_Core_Model_Template::emulateDesign()
Mage_Core_Model_Template::getDesignConfig()
Mage_Core_Model_Template::getType()
Mage_Core_Model_Template::isPlain()
Mage_Core_Model_Template::revertDesign()
Mage_Core_Model_Template::setDesignConfig()
Mage_Core_Model_Template::_applyDesignConfig()
Mage_Core_Model_Template::_cancelDesignConfig()

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()
Class Constants

Documentation generated on Fri, 11 Feb 2011 17:14:32 +0200 by phpDocumentor 1.4.3