Mage_Newsletter_Model_Queue Class Reference

Inheritance diagram for Mage_Newsletter_Model_Queue:

List of all members.

Public Member Functions
	getSubscribersCollection ()
	addTemplateData ($data)
	sendPerSubscriber ($count=20, array $additionalVariables=array())
	getDataForSave ()
	addSubscribersToQueue (array $subscriberIds)
	setSaveTemplateFlag ($value)
	getSaveTemplateFlag ()
	setSaveStoresFlag ($value)
	getSaveStoresFlag ()
	setStores (array $storesIds)
	getStores ()
	getTemplate ()
Public Attributes
const	STATUS_NEVER = 0
const	STATUS_SENDING = 1
const	STATUS_CANCEL = 2
const	STATUS_SENT = 3
const	STATUS_PAUSE = 4
Protected Member Functions
	_construct ()
Protected Attributes
	$_template
	$_subscribersCollection = null
	$_saveTemplateFlag = false
	$_saveStoresFlag = false
	$_stores = false

---

Detailed Description

Definition at line 34 of file Queue.php.

---

Member Function Documentation

_construct

(

)

[protected]

Enter description here...

Reimplemented from Varien_Object.

Definition at line 62 of file Queue.php.

    {
        $this->_init('newsletter/queue');
    }

addSubscribersToQueue

(

array $

subscriberIds

)

Definition at line 150 of file Queue.php.

    {
        $this->_getResource()->addSubscribersToQueue($this, $subscriberIds);
        return $this;
    }

addTemplateData

(

$

data

)

Add template data to queue.

Deprecated:

Parameters:

Varien_Object

$data

Returns:

Mage_Newsletter_Model_Queue

Definition at line 89 of file Queue.php.

    {
        $template = $this->getTemplate();
        if ($data->getTemplateId() && $data->getTemplateId() != $template->getId()) {
            $template->load($data->getTemplateId());
        }

        return $this;
    }

getDataForSave

(

)

Definition at line 141 of file Queue.php.

                                     {
        $data = array();
        $data['template_id'] = $this->getTemplateId();
        $data['queue_status'] = $this->getQueueStatus();
        $data['queue_start_at'] = $this->getQueueStartAt();
        $data['queue_finish_at'] = $this->getQueueFinishAt();
        return $data;
    }

getSaveStoresFlag

(

)

Definition at line 173 of file Queue.php.

    {
        return $this->_saveStoresFlag;
    }

getSaveTemplateFlag

(

)

Definition at line 162 of file Queue.php.

    {
        return $this->_saveTemplateFlag;
    }

getStores

(

)

Definition at line 185 of file Queue.php.

    {
        if(!$this->_stores) {
            $this->_stores = $this->_getResource()->getStores($this);
        }

        return $this->_stores;
    }

getSubscribersCollection

(

)

Returns subscribers collection for this queue

Returns:

Varien_Data_Collection_Db

Definition at line 72 of file Queue.php.

    {
        if (is_null($this->_subscribersCollection)) {
            $this->_subscribersCollection = Mage::getResourceModel('newsletter/subscriber_collection')
                ->useQueue($this);
        }

        return $this->_subscribersCollection;
    }

getTemplate

(

)

Retrieve Newsletter Template object

Returns:

Mage_Newsletter_Model_Template

Definition at line 199 of file Queue.php.

    {
        if (is_null($this->_template)) {
            $this->_template = Mage::getModel('newsletter/template')
                ->load($this->getTemplateId());
        }
        return $this->_template;
    }

sendPerSubscriber	(	$	count = 20,
		array $	additionalVariables = array()
	)

Send messages to subscribers for this queue

Parameters:

	int	$count
	array	$additionalVariables

Definition at line 105 of file Queue.php.

    {
        if($this->getQueueStatus()!=self::STATUS_SENDING && ($this->getQueueStatus()!=self::STATUS_NEVER && $this->getQueueStartAt()) ) {
            return $this;
        }

        if($this->getSubscribersCollection()->getSize()==0) {
            return $this;
        }

        $collection = $this->getSubscribersCollection()
            ->useOnlyUnsent()
            ->showCustomerInfo()
            ->setPageSize($count)
            ->setCurPage(1)
            ->load();

        if(!$this->getTemplate()) {
            $this->addTemplateData($this);
            if(!$this->getTemplate()->isPreprocessed()) {
                $this->getTemplate()->preproccess();
            }
        }

        foreach($collection->getItems() as $item) {
            $this->getTemplate()->send($item, array('subscriber'=>$item), null, $this);
        }

        if(count($collection->getItems()) < $count-1 || count($collection->getItems()) == 0) {
            $this->setQueueFinishAt(now());
            $this->setQueueStatus(self::STATUS_SENT);
            $this->save();
        }
        return $this;
    }

setSaveStoresFlag

(

$

value

)

Definition at line 167 of file Queue.php.

    {
        $this->_saveStoresFlag = (boolean)$value;
        return $this;
    }

setSaveTemplateFlag

(

$

value

)

Definition at line 156 of file Queue.php.

    {
        $this->_saveTemplateFlag = (boolean)$value;
        return $this;
    }

setStores

(

array $

storesIds

)

Definition at line 178 of file Queue.php.

    {
        $this->setSaveStoresFlag(true);
        $this->_stores = $storesIds;
        return $this;
    }

---

Member Data Documentation

$_saveStoresFlag = false [protected]

Definition at line 51 of file Queue.php.

$_saveTemplateFlag = false [protected]

Definition at line 49 of file Queue.php.

$_stores = false [protected]

Definition at line 53 of file Queue.php.

$_subscribersCollection = null [protected]

Definition at line 47 of file Queue.php.

$_template [protected]

Definition at line 41 of file Queue.php.

const STATUS_CANCEL = 2

Definition at line 57 of file Queue.php.

const STATUS_NEVER = 0

Definition at line 55 of file Queue.php.

const STATUS_PAUSE = 4

Definition at line 59 of file Queue.php.

const STATUS_SENDING = 1

Definition at line 56 of file Queue.php.

const STATUS_SENT = 3

Definition at line 58 of file Queue.php.

---

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

• app/code/core/Mage/Newsletter/Model/Queue.php