Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_Newsletter_Block_Subscribe
  • Mage_Newsletter_Helper_Data
  • Mage_Newsletter_ManageController
  • Mage_Newsletter_Model_Message
  • Mage_Newsletter_Model_Mysql4_Problem
  • Mage_Newsletter_Model_Mysql4_Problem_Collection
  • Mage_Newsletter_Model_Mysql4_Queue
  • Mage_Newsletter_Model_Mysql4_Queue_Collection
  • Mage_Newsletter_Model_Mysql4_Subscriber
  • Mage_Newsletter_Model_Mysql4_Subscriber_Collection
  • Mage_Newsletter_Model_Mysql4_Template
  • Mage_Newsletter_Model_Mysql4_Template_Collection
  • Mage_Newsletter_Model_Observer
  • Mage_Newsletter_Model_Problem
  • Mage_Newsletter_Model_Queue
  • Mage_Newsletter_Model_Resource_Problem
  • Mage_Newsletter_Model_Resource_Problem_Collection
  • Mage_Newsletter_Model_Resource_Queue
  • Mage_Newsletter_Model_Resource_Queue_Collection
  • Mage_Newsletter_Model_Resource_Subscriber
  • Mage_Newsletter_Model_Resource_Subscriber_Collection
  • Mage_Newsletter_Model_Resource_Template
  • Mage_Newsletter_Model_Resource_Template_Collection
  • Mage_Newsletter_Model_Session
  • Mage_Newsletter_Model_Subscriber
  • Mage_Newsletter_Model_Template
  • Mage_Newsletter_Model_Template_Filter
  • Mage_Newsletter_SubscriberController
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Newsletter_Model_Queue

Newsletter queue model.

Varien_Object
Extended by Mage_Core_Model_Abstract
Extended by Mage_Core_Model_Template
Extended by Mage_Newsletter_Model_Queue
Package: Mage\Newsletter
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Newsletter/Model/Queue.php
Methods summary
protected
# _construct( )

Initialize resource model

Initialize resource model

public boolean
# isNew( )

Return: is this queue newly created or not.

Return: is this queue newly created or not.

Returns

boolean
public Varien_Data_Collection_Db
# getSubscribersCollection( )

Returns subscribers collection for this queue

Returns subscribers collection for this queue

Returns

Varien_Data_Collection_Db
public Mage_Newsletter_Model_Queue
# setQueueStartAtByString( string|null $startAt )

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

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

Parameters

$startAt
string|null
$startAt start date of the mailing queue

Returns

Mage_Newsletter_Model_Queue
public Mage_Newsletter_Model_Queue
# sendPerSubscriber( integer $count = 20, array $additionalVariables = array() )

Send messages to subscribers for this queue

Send messages to subscribers for this queue

Parameters

$count
integer
$count
$additionalVariables
array
$additionalVariables

Returns

Mage_Newsletter_Model_Queue
protected Mage_Newsletter_Model_Queue
# _finishQueue( )

Finish queue: set status SENT and update finish date

Finish queue: set status SENT and update finish date

Returns

Mage_Newsletter_Model_Queue
public array
# getDataForSave( )

Getter data for saving

Getter data for saving

Returns

array
public Mage_Newsletter_Model_Queue
# addSubscribersToQueue( array $subscriberIds )

Add subscribers to queue.

Add subscribers to queue.

Parameters

$subscriberIds
array
$subscriberIds

Returns

Mage_Newsletter_Model_Queue
public Mage_Newsletter_Model_Queue
# setSaveStoresFlag( boolean|integer|string $value )

Setter for save stores flag.

Setter for save stores flag.

Parameters

$value
boolean|integer|string
$value

Returns

Mage_Newsletter_Model_Queue
public boolean
# getSaveStoresFlag( )

Getter for save stores flag.

Getter for save stores flag.

Returns

boolean
public Mage_Newsletter_Model_Queue
# setStores( array $storesIds )

Setter for stores of queue.

Setter for stores of queue.

Parameters

$storesIds
array

Returns

Mage_Newsletter_Model_Queue
public array
# getStores( )

Getter for stores of queue.

Getter for stores of queue.

Returns

array
public Mage_Newsletter_Model_Template
# getTemplate( )

Retrieve Newsletter Template object

Retrieve Newsletter Template object

Returns

Mage_Newsletter_Model_Template
public integer|string
# getType( )

Getter for template type

Getter for template type

Returns

integer|string
Methods inherited from Mage_Core_Model_Template
_applyDesignConfig(), _cancelDesignConfig(), emulateDesign(), getDesignConfig(), isPlain(), revertDesign(), setDesignConfig()
Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _beforeSave(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()
Constants summary
integer STATUS_NEVER 0
#
integer STATUS_SENDING 1
#
integer STATUS_CANCEL 2
#
integer STATUS_SENT 3
#
integer STATUS_PAUSE 4
#
Constants inherited from Mage_Core_Model_Template
DEFAULT_DESIGN_AREA, TYPE_HTML, TYPE_TEXT
Properties summary
protected Mage_Newsletter_Model_Template $_template
#

Newsletter Template object

Newsletter Template object

protected Varien_Data_Collection_Db $_subscribersCollection null
#

Subscribers collection

Subscribers collection

protected boolean $_saveStoresFlag false
#

Save stores flag.

Save stores flag.

protected array $_stores array()
#

Stores assigned to queue.

Stores assigned to queue.

Properties inherited from Mage_Core_Model_Template
$_designConfig, $_emulatedDesignConfig, $_initialEnvironmentInfo
Properties inherited from Mage_Core_Model_Abstract
$_cacheTag, $_dataSaveAllowed, $_eventObject, $_eventPrefix, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0