Class Mage_Newsletter_Model_Queue

Description

Newsletter queue model.

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

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Core_Model_Template
         |
         --Mage_Newsletter_Model_Queue
Class Constant Summary
Variable Summary
Method Summary
array getDataForSave ()
boolean getSaveStoresFlag (void 0)
boolean getSaveTemplateFlag (void 0)
array getStores ()
Varien_Data_Collection_Db getSubscribersCollection ()
int|string getType ()
boolean isNew ()
Mage_Newsletter_Model_Queue sendPerSubscriber ([int $count = 20], [ $additionalVariables = array()])
Mage_Newsletter_Model_Queue setSaveStoresFlag (boolean|integer|string $value)
Mage_Newsletter_Model_Queue setSaveTemplateFlag (boolean|integer|string $value)
void _construct ()
Variables
boolean $_saveStoresFlag = false (line 62)

Save stores flag.

  • access: protected
boolean $_saveTemplateFlag = false (line 55)

save template flag

  • deprecated: since 1.4.0.1
  • access: protected
array $_stores = array() (line 69)

Stores assigned to queue.

  • access: protected
Varien_Data_Collection_Db $_subscribersCollection = null (line 47)

Subscribers collection

  • access: protected
Mage_Newsletter_Model_Template $_template (line 41)

Newsletter Template object

  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Template

Mage_Core_Model_Template::$_designConfig
Mage_Core_Model_Template::$_emulatedDesignConfig
Mage_Core_Model_Template::$_initialEnvironmentInfo

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_eventObject
Mage_Core_Model_Abstract::$_eventPrefix
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName
Methods
addSubscribersToQueue (line 230)

Add subscribers to queue.

  • access: public
Mage_Newsletter_Model_Queue addSubscribersToQueue ( $subscriberIds)
  • array $subscriberIds
addTemplateData (line 117)

Add template data to queue.

  • deprecated: since 1.4.0.1
  • access: public
Mage_Newsletter_Model_Queue addTemplateData (Varien_Object $data)
  • Varien_Object $data
getDataForSave (line 214)

Getter data for saving

  • access: public
array getDataForSave ()
getSaveStoresFlag (line 279)

Getter for save stores flag.

  • access: public
boolean getSaveStoresFlag (void 0)
  • void 0
getSaveTemplateFlag (line 256)

Getter for save template flag.

  • deprecated: since 1.4.0.1
  • access: public
boolean getSaveTemplateFlag (void 0)
  • void 0
getStores (line 302)

Getter for stores of queue.

  • access: public
array getStores ()
getSubscribersCollection (line 100)

Returns subscribers collection for this queue

  • access: public
Varien_Data_Collection_Db getSubscribersCollection ()
getTemplate (line 316)

Retrieve Newsletter Template object

  • access: public
getType (line 330)

Getter for template type

  • access: public
int|string getType ()

Redefinition of:
Mage_Core_Model_Template::getType()
Getter for template type
isNew (line 90)

Return: is this queue newly created or not.

  • access: public
boolean isNew ()
sendPerSubscriber (line 153)

Send messages to subscribers for this queue

  • access: public
Mage_Newsletter_Model_Queue sendPerSubscriber ([int $count = 20], [ $additionalVariables = array()])
  • int $count
  • array $additionalVariables
setQueueStartAtByString (line 133)

Set $_data['queue_start'] based on string from backend, which based on locale.

  • access: public
Mage_Newsletter_Model_Queue setQueueStartAtByString (string|null $startAt)
  • string|null $startAt: start date of the mailing queue
setSaveStoresFlag (line 267)

Setter for save stores flag.

  • access: public
Mage_Newsletter_Model_Queue setSaveStoresFlag (boolean|integer|string $value)
  • boolean|integer|string $value
setSaveTemplateFlag (line 243)

Setter for save template flag.

  • deprecated: since 1.4.0.1
  • access: public
Mage_Newsletter_Model_Queue setSaveTemplateFlag (boolean|integer|string $value)
  • boolean|integer|string $value
setStores (line 290)

Setter for stores of queue.

  • access: public
Mage_Newsletter_Model_Queue setStores ( $storesIds)
  • array $storesIds
_construct (line 80)

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
STATUS_CANCEL = 2 (line 73)
STATUS_NEVER = 0 (line 71)
STATUS_PAUSE = 4 (line 75)
STATUS_SENDING = 1 (line 72)
STATUS_SENT = 3 (line 74)

Inherited Constants

Inherited from Mage_Core_Model_Template

Mage_Core_Model_Template::DEFAULT_DESIGN_AREA
Mage_Core_Model_Template::TYPE_HTML
Mage_Core_Model_Template::TYPE_TEXT

Documentation generated on Fri, 11 Feb 2011 17:10:45 +0200 by phpDocumentor 1.4.3