Mage_Newsletter_Model_Mysql4_Subscriber Class Reference

List of all members.

Public Member Functions
	__construct ()
	load ($subscriberId)
	setMessagesScope ($scope)
	loadByEmail ($subscriberEmail)
	loadByCustomer (Mage_Customer_Model_Customer $customer)
	save (Mage_Newsletter_Model_Subscriber $subscriber)
	delete ($subscriberId)
	received (Mage_Newsletter_Model_Subscriber $subscriber, Mage_Newsletter_Model_Queue $queue)
Protected Member Functions
	_generateRandomCode ()
	_prepareSave (Mage_Newsletter_Model_Subscriber $subscriber)
Protected Attributes
	$_read
	$_write
	$_subscriberTable
	$_subscriberLinkTable
	$_messagesScope = 'newsletter/session'

---

Detailed Description

Definition at line 34 of file Subscriber.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor

Set read and write connection, get tablename from config

Definition at line 76 of file Subscriber.php.

    {
        $this->_subscriberTable = Mage::getSingleton('core/resource')->getTableName("newsletter/subscriber");
        $this->_subscriberLinkTable = Mage::getSingleton('core/resource')->getTableName("newsletter/queue_link");
        $this->_read = Mage::getSingleton('core/resource')->getConnection('newsletter_read');
        $this->_write = Mage::getSingleton('core/resource')->getConnection('newsletter_write');
    }

---

Member Function Documentation

_generateRandomCode

(

)

[protected]

Generates random code for subscription confirmation

Returns:

string

Definition at line 196 of file Subscriber.php.

    {
        return md5(microtime() + rand());
    }

_prepareSave

(

Mage_Newsletter_Model_Subscriber $

subscriber

)

[protected]

Preapares data for saving of subscriber

Parameters:

Mage_Newsletter_Model_Subscriber

$subscriber

Returns:

array

Definition at line 207 of file Subscriber.php.

    {
        $data = array();
        $data['customer_id'] = $subscriber->getCustomerId();
        $data['store_id']    = $subscriber->getStoreId() ? $subscriber->getStoreId() : 0;
        $data['subscriber_status'] = $subscriber->getStatus();
        $data['subscriber_email']  = $subscriber->getEmail();
        $data['subscriber_confirm_code'] = $subscriber->getCode();

        if($subscriber->getIsStatusChanged()) {
            $data['change_status_at'] = Mage::getSingleton('core/date')->gmtDate();
        }

        $validators = array('subscriber_email' => 'EmailAddress');
        $filters = array();
        $input = new Zend_Filter_Input($filters, $validators, $data);
        $session = Mage::getSingleton($this->_messagesScope);
        if ($input->hasInvalid() || $input->hasMissing()) {
            foreach ($input->getMessages() as $message) {
                if(is_array($message)) {
                    foreach( $message as $error ) {
                        $session->addError($error);
                    }
                } else {
                    $session->addError($message);
                }
            }
            Mage::throwException(Mage::helper('newsletter')->__('Form was filled incorrectly'));
        }

        return $data;
    }

delete

(

$

subscriberId

)

Delete subscriber from DB

Parameters:

int

$subscriberId

Definition at line 245 of file Subscriber.php.

    {
        if(!(int)$subscriberId) {
            Mage::throwException(Mage::helper('newsletter')->__('Invalid subscriber ID'));
        }

        $this->_write->beginTransaction();
        try {
            $this->_write->delete($this->_subscriberTable,
                                  $this->_write->quoteInto('subscriber_id=?', $subscriberId));
            $this->_write->commit();
        }
        catch (Exception $e) {
            $this->_write->rollBack();
            Mage::throwException(Mage::helper('newsletter')->__('Cannot delete subscriber'));
        }
    }

load

(

$

subscriberId

)

Load subscriber from DB

Parameters:

int

$subscriberId

Returns:

array

Definition at line 90 of file Subscriber.php.

    {
        $select = $this->_read->select()
            ->from($this->_subscriberTable)
            ->where('subscriber_id=?',$subscriberId);

        return $this->_read->fetchRow($select);
    }

loadByCustomer

(

Mage_Customer_Model_Customer $

customer

)

Load subscriber by customer

Parameters:

Mage_Customer_Model_Customer

$customer

Returns:

array

Definition at line 138 of file Subscriber.php.

    {
        $select = $this->_read->select()
            ->from($this->_subscriberTable)
            ->where('customer_id=?',$customer->getId());

        $result = $this->_read->fetchRow($select);

        if ($result) {
            return $result;
        }

        $select = $this->_read->select()
            ->from($this->_subscriberTable)
            ->where('subscriber_email=?',$customer->getEmail());

        $result = $this->_read->fetchRow($select);

        if ($result) {
            return $result;
        }

        return array();
    }

loadByEmail

(

$

subscriberEmail

)

Load subscriber from DB by email

Parameters:

string

$subscriberEmail

Returns:

array

Definition at line 115 of file Subscriber.php.

    {
        $select = $this->_read->select()
            ->from($this->_subscriberTable)
            ->where('subscriber_email=?',$subscriberEmail);

        $result = $this->_read->fetchRow($select);

        if(!$result) {
            return array();
        }

        return $result;
    }

received	(	Mage_Newsletter_Model_Subscriber $	subscriber,
		Mage_Newsletter_Model_Queue $	queue
	)

Definition at line 263 of file Subscriber.php.

    {
        $this->_write->beginTransaction();
         try {
            $data['letter_sent_at'] = now();
            $this->_write->update($this->_subscriberLinkTable,
                                  $data,
                                  array($this->_write->quoteInto('subscriber_id=?', $subscriber->getId()),
                                        $this->_write->quoteInto('queue_id=?', $queue->getId())));
            $this->_write->commit();
        }
        catch (Exception $e) {
            $this->_write->rollBack();
            Mage::throwException(Mage::helper('newsletter')->__('Cannot mark as received subscriber'));
        }
        return $this;
    }

save

(

Mage_Newsletter_Model_Subscriber $

subscriber

)

Save subscriber info from it model.

Parameters:

Mage_Newsletter_Model_Subscriber

$subscriber

Returns:

Mage_Newsletter_Model_Subscriber

Definition at line 169 of file Subscriber.php.

    {
        $this->_write->beginTransaction();
        try {
            $data = $this->_prepareSave($subscriber);
            if ($subscriber->getId()) {
                $this->_write->update($this->_subscriberTable, $data,
                                      $this->_write->quoteInto('subscriber_id=?',$subscriber->getId()));
            } else {
                $this->_write->insert($this->_subscriberTable, $data);
                $subscriber->setId($this->_write->lastInsertId($this->_subscriberTable));
            }
            $this->_write->commit();
        }
        catch(Exception $e) {
            $this->_write->rollBack();
            Mage::throwException(Mage::helper('newsletter')->__('Cannot save your subscription: %s', $e->getMessage()));
        }

        return $subscriber;
    }

setMessagesScope

(

$

scope

)

Set error messages scope

Parameters:

string

$scope

Definition at line 104 of file Subscriber.php.

    {
        $this->_messagesScope = $scope;
    }

---

Member Data Documentation

$_messagesScope = 'newsletter/session' [protected]

Definition at line 69 of file Subscriber.php.

$_read [protected]

Definition at line 41 of file Subscriber.php.

$_subscriberLinkTable [protected]

Definition at line 62 of file Subscriber.php.

$_subscriberTable [protected]

Definition at line 55 of file Subscriber.php.

$_write [protected]

Definition at line 48 of file Subscriber.php.

---

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

• app/code/core/Mage/Newsletter/Model/Mysql4/Subscriber.php