diff --git a/app/code/core/Mage/Newsletter/Block/Subscribe.php b/app/code/core/Mage/Newsletter/Block/Subscribe.php index 7fd5b453b10..0b95d39e249 100644 --- a/app/code/core/Mage/Newsletter/Block/Subscribe.php +++ b/app/code/core/Mage/Newsletter/Block/Subscribe.php @@ -34,12 +34,18 @@ class Mage_Newsletter_Block_Subscribe extends Mage_Core_Block_Template { + /** + * @return string + */ public function getSuccessMessage() { $message = Mage::getSingleton('newsletter/session')->getSuccess(); return $message; } + /** + * @return string + */ public function getErrorMessage() { $message = Mage::getSingleton('newsletter/session')->getError(); diff --git a/app/code/core/Mage/Newsletter/Helper/Data.php b/app/code/core/Mage/Newsletter/Helper/Data.php index 7327aba4cd0..cdec5306666 100644 --- a/app/code/core/Mage/Newsletter/Helper/Data.php +++ b/app/code/core/Mage/Newsletter/Helper/Data.php @@ -73,7 +73,7 @@ public function getUnsubscribeUrl($subscriber) /** * Retrieve Template processor for Newsletter template * - * @return Varien_Filter_Template + * @return false|Mage_Core_Model_Abstract|Varien_Filter_Template */ public function getTemplateProcessor() { @@ -81,4 +81,3 @@ public function getTemplateProcessor() return Mage::getModel($model); } } - diff --git a/app/code/core/Mage/Newsletter/Model/Observer.php b/app/code/core/Mage/Newsletter/Model/Observer.php index 3fb626c385c..aff1214df25 100644 --- a/app/code/core/Mage/Newsletter/Model/Observer.php +++ b/app/code/core/Mage/Newsletter/Model/Observer.php @@ -31,7 +31,11 @@ */ class Mage_Newsletter_Model_Observer { - public function subscribeCustomer($observer) + /** + * @param Varien_Event_Observer $observer + * @return $this + */ + public function subscribeCustomer(Varien_Event_Observer $observer) { $customer = $observer->getEvent()->getCustomer(); if (($customer instanceof Mage_Customer_Model_Customer)) { @@ -43,19 +47,22 @@ public function subscribeCustomer($observer) /** * Customer delete handler * - * @param Varien_Object $observer + * @param Varien_Event_Observer $observer * @return $this */ - public function customerDeleted($observer) + public function customerDeleted(Varien_Event_Observer $observer) { $subscriber = Mage::getModel('newsletter/subscriber') ->loadByEmail($observer->getEvent()->getCustomer()->getEmail()); - if($subscriber->getId()) { + if ($subscriber->getId()) { $subscriber->delete(); } return $this; } + /** + * @param Varien_Event_Observer $schedule + */ public function scheduledSend($schedule) { $countOfQueue = 3; diff --git a/app/code/core/Mage/Newsletter/Model/Problem.php b/app/code/core/Mage/Newsletter/Model/Problem.php index a6dde8dff15..c0087787464 100644 --- a/app/code/core/Mage/Newsletter/Model/Problem.php +++ b/app/code/core/Mage/Newsletter/Model/Problem.php @@ -29,14 +29,18 @@ * * @method Mage_Newsletter_Model_Resource_Problem _getResource() * @method Mage_Newsletter_Model_Resource_Problem getResource() - * @method int getSubscriberId() - * @method Mage_Newsletter_Model_Problem setSubscriberId(int $value) + * @method int getCustomerId() + * @method $this setCustomerName(string $value) + * @method $this setCustomerFirstName(string $value) + * @method $this setCustomerLastName(string $value) * @method int getQueueId() - * @method Mage_Newsletter_Model_Problem setQueueId(int $value) + * @method $this setQueueId(int $value) * @method int getProblemErrorCode() - * @method Mage_Newsletter_Model_Problem setProblemErrorCode(int $value) + * @method $this setProblemErrorCode(int $value) * @method string getProblemErrorText() - * @method Mage_Newsletter_Model_Problem setProblemErrorText(string $value) + * @method $this setProblemErrorText(string $value) + * @method int getSubscriberId() + * @method $this setSubscriberId(int $value) * * @category Mage * @package Mage_Newsletter @@ -46,10 +50,10 @@ class Mage_Newsletter_Model_Problem extends Mage_Core_Model_Abstract { /** * Current Subscriber - * + * * @var Mage_Newsletter_Model_Subscriber */ - protected $_subscriber = null; + protected $_subscriber = null; /** * Initialize Newsletter Problem Model @@ -103,11 +107,11 @@ public function addErrorData(Exception $e) */ public function getSubscriber() { - if(!$this->getSubscriberId()) { + if (!$this->getSubscriberId()) { return null; } - if(is_null($this->_subscriber)) { + if (is_null($this->_subscriber)) { $this->_subscriber = Mage::getModel('newsletter/subscriber') ->load($this->getSubscriberId()); } @@ -122,12 +126,11 @@ public function getSubscriber() */ public function unsubscribe() { - if($this->getSubscriber()) { + if ($this->getSubscriber()) { $this->getSubscriber()->setSubscriberStatus(Mage_Newsletter_Model_Subscriber::STATUS_UNSUBSCRIBED) ->setIsStatusChanged(true) ->save(); } return $this; } - } diff --git a/app/code/core/Mage/Newsletter/Model/Queue.php b/app/code/core/Mage/Newsletter/Model/Queue.php index e12edd620e8..fb91007aa6a 100644 --- a/app/code/core/Mage/Newsletter/Model/Queue.php +++ b/app/code/core/Mage/Newsletter/Model/Queue.php @@ -29,26 +29,28 @@ * * @method Mage_Newsletter_Model_Resource_Queue _getResource() * @method Mage_Newsletter_Model_Resource_Queue getResource() + * @method Mage_Newsletter_Model_Resource_Queue_Collection getCollection() + * * @method int getTemplateId() - * @method Mage_Newsletter_Model_Queue setTemplateId(int $value) + * @method $this setTemplateId(int $value) * @method int getNewsletterType() - * @method Mage_Newsletter_Model_Queue setNewsletterType(int $value) + * @method $this setNewsletterType(int $value) * @method string getNewsletterText() - * @method Mage_Newsletter_Model_Queue setNewsletterText(string $value) + * @method $this setNewsletterText(string $value) * @method string getNewsletterStyles() - * @method Mage_Newsletter_Model_Queue setNewsletterStyles(string $value) + * @method $this setNewsletterStyles(string $value) * @method string getNewsletterSubject() - * @method Mage_Newsletter_Model_Queue setNewsletterSubject(string $value) + * @method $this setNewsletterSubject(string $value) * @method string getNewsletterSenderName() - * @method Mage_Newsletter_Model_Queue setNewsletterSenderName(string $value) + * @method $this setNewsletterSenderName(string $value) * @method string getNewsletterSenderEmail() - * @method Mage_Newsletter_Model_Queue setNewsletterSenderEmail(string $value) + * @method $this setNewsletterSenderEmail(string $value) * @method int getQueueStatus() - * @method Mage_Newsletter_Model_Queue setQueueStatus(int $value) + * @method $this setQueueStatus(int $value) * @method string getQueueStartAt() - * @method Mage_Newsletter_Model_Queue setQueueStartAt(string $value) + * @method $this setQueueStartAt(string $value) * @method string getQueueFinishAt() - * @method Mage_Newsletter_Model_Queue setQueueFinishAt(string $value) + * @method $this setQueueFinishAt(string $value) * * @category Mage * @package Mage_Newsletter @@ -65,7 +67,7 @@ class Mage_Newsletter_Model_Queue extends Mage_Core_Model_Template /** * Subscribers collection - * @var Varien_Data_Collection_Db + * @var Mage_Newsletter_Model_Resource_Subscriber_Collection */ protected $_subscribersCollection = null; @@ -118,7 +120,7 @@ public function isNew() /** * Returns subscribers collection for this queue * - * @return Varien_Data_Collection_Db + * @return Mage_Newsletter_Model_Resource_Subscriber_Collection */ public function getSubscribersCollection() { @@ -155,7 +157,7 @@ public function addTemplateData($data) */ public function setQueueStartAtByString($startAt) { - if(is_null($startAt) || $startAt == '') { + if (is_null($startAt) || $startAt == '') { $this->setQueueStartAt(null); } else { $locale = Mage::app()->getLocale(); @@ -164,7 +166,7 @@ public function setQueueStartAtByString($startAt) $this->setQueueStartAt(Mage::getModel('core/date')->gmtDate(null, $time)); } return $this; - } + } /** * Send messages to subscribers for this queue @@ -173,9 +175,9 @@ public function setQueueStartAtByString($startAt) * @param array $additionalVariables * @return $this */ - public function sendPerSubscriber($count=20, array $additionalVariables=array()) + public function sendPerSubscriber($count = 20, array $additionalVariables = array()) { - if($this->getQueueStatus()!=self::STATUS_SENDING + if ($this->getQueueStatus()!=self::STATUS_SENDING && ($this->getQueueStatus()!=self::STATUS_NEVER && $this->getQueueStartAt()) ) { return $this; @@ -186,7 +188,6 @@ public function sendPerSubscriber($count=20, array $additionalVariables=array()) return $this; } - /** @var Mage_Newsletter_Model_Resource_Subscriber_Collection $collection */ $collection = $this->getSubscribersCollection() ->useOnlyUnsent() ->showCustomerInfo() @@ -194,7 +195,6 @@ public function sendPerSubscriber($count=20, array $additionalVariables=array()) ->setCurPage(1) ->load(); - /** @var Mage_Core_Model_Email_Template $sender */ $sender = Mage::getModel('core/email_template'); $sender->setSenderName($this->getNewsletterSenderName()) ->setSenderEmail($this->getNewsletterSenderEmail()) @@ -204,7 +204,8 @@ public function sendPerSubscriber($count=20, array $additionalVariables=array()) ->setTemplateStyles($this->getNewsletterStyles()) ->setTemplateFilter(Mage::helper('newsletter')->getTemplateProcessor()); - foreach($collection->getItems() as $item) { + /** @var Mage_Newsletter_Model_Subscriber $item */ + foreach ($collection->getItems() as $item) { $email = $item->getSubscriberEmail(); $name = $item->getSubscriberFullName(); @@ -212,7 +213,7 @@ public function sendPerSubscriber($count=20, array $additionalVariables=array()) $successSend = $sender->send($email, $name, array('subscriber' => $item)); $sender->revertDesign(); - if($successSend) { + if ($successSend) { $item->received($this); } else { $problem = Mage::getModel('newsletter/problem'); @@ -225,7 +226,7 @@ public function sendPerSubscriber($count=20, array $additionalVariables=array()) } } - if(count($collection->getItems()) < $count-1 || count($collection->getItems()) == 0) { + if (count($collection->getItems()) < $count-1 || count($collection->getItems()) == 0) { $this->_finishQueue(); } return $this; @@ -288,7 +289,6 @@ public function setSaveTemplateFlag($value) /** * Getter for save template flag. * - * @param void * @return boolean * @deprecated since 1.4.0.1 */ @@ -312,7 +312,6 @@ public function setSaveStoresFlag($value) /** * Getter for save stores flag. * - * @param void * @return boolean */ public function getSaveStoresFlag() @@ -323,7 +322,7 @@ public function getSaveStoresFlag() /** * Setter for stores of queue. * - * @param array + * @param array $storesIds * @return $this */ public function setStores(array $storesIds) @@ -340,7 +339,7 @@ public function setStores(array $storesIds) */ public function getStores() { - if(!$this->_stores) { + if (!$this->_stores) { $this->_stores = $this->_getResource()->getStores($this); } @@ -366,8 +365,8 @@ public function getTemplate() * * @return int|string */ - public function getType(){ + public function getType() + { return $this->getNewsletterType(); } - } diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Problem/Collection.php b/app/code/core/Mage/Newsletter/Model/Resource/Problem/Collection.php index 9b7fa37fe49..8f49affef42 100644 --- a/app/code/core/Mage/Newsletter/Model/Resource/Problem/Collection.php +++ b/app/code/core/Mage/Newsletter/Model/Resource/Problem/Collection.php @@ -24,13 +24,17 @@ * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) */ - /** * Newsletter problems collection * * @category Mage * @package Mage_Newsletter * @author Magento Core Team + * + * @method Mage_Newsletter_Model_Problem[] getItems() + * @method Mage_Newsletter_Model_Problem[] getItemsByColumnValue(string $column, string $value) + * @method $this setCustomerFirstName(string $value) + * @method $this setCustomerLastName(string $value) */ class Mage_Newsletter_Model_Resource_Problem_Collection extends Mage_Core_Model_Resource_Db_Collection_Abstract { @@ -64,7 +68,8 @@ protected function _construct() */ public function addSubscriberInfo() { - $this->getSelect()->joinLeft(array('subscriber'=>$this->getTable('newsletter/subscriber')), + $this->getSelect()->joinLeft( + array('subscriber'=>$this->getTable('newsletter/subscriber')), 'main_table.subscriber_id = subscriber.subscriber_id', array('subscriber_email','customer_id','subscriber_status') ); @@ -81,11 +86,14 @@ public function addSubscriberInfo() */ public function addQueueInfo() { - $this->getSelect()->joinLeft(array('queue'=>$this->getTable('newsletter/queue')), + $this->getSelect()->joinLeft( + array('queue'=>$this->getTable('newsletter/queue')), 'main_table.queue_id = queue.queue_id', array('queue_start_at', 'queue_finish_at') ) - ->joinLeft(array('template'=>$this->getTable('newsletter/template')), 'queue.template_id = template.template_id', + ->joinLeft( + array('template'=>$this->getTable('newsletter/template')), + 'queue.template_id = template.template_id', array('template_subject','template_code','template_sender_name','template_sender_email') ); return $this; diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Queue.php b/app/code/core/Mage/Newsletter/Model/Resource/Queue.php index f47576d9ae7..1a7f5412549 100644 --- a/app/code/core/Mage/Newsletter/Model/Resource/Queue.php +++ b/app/code/core/Mage/Newsletter/Model/Resource/Queue.php @@ -79,8 +79,7 @@ public function addSubscribersToQueue(Mage_Newsletter_Model_Queue $queue, array $adapter->insert($this->getTable('newsletter/queue_link'), $data); } $adapter->commit(); - } - catch (Exception $e) { + } catch (Exception $e) { $adapter->rollBack(); } } @@ -103,8 +102,7 @@ public function removeSubscribersFromQueue(Mage_Newsletter_Model_Queue $queue) ); $adapter->commit(); - } - catch (Exception $e) { + } catch (Exception $e) { $adapter->rollBack(); } } @@ -147,6 +145,7 @@ public function setStores(Mage_Newsletter_Model_Queue $queue) $subscriberIds = array(); + /** @var Mage_Newsletter_Model_Subscriber $subscriber */ foreach ($subscribers as $subscriber) { $subscriberIds[] = $subscriber->getId(); } @@ -180,7 +179,7 @@ public function getStores(Mage_Newsletter_Model_Queue $queue) /** * Saving template after saving queue action * - * @param Mage_Core_Model_Abstract $queue + * @param Mage_Core_Model_Abstract|Mage_Newsletter_Model_Queue $queue * @return $this */ protected function _afterSave(Mage_Core_Model_Abstract $queue) diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Queue/Collection.php b/app/code/core/Mage/Newsletter/Model/Resource/Queue/Collection.php index b72adb3c720..37eed503510 100644 --- a/app/code/core/Mage/Newsletter/Model/Resource/Queue/Collection.php +++ b/app/code/core/Mage/Newsletter/Model/Resource/Queue/Collection.php @@ -67,7 +67,8 @@ protected function _construct() */ public function addTemplateInfo() { - $this->getSelect()->joinLeft(array('template'=>$this->getTable('template')), + $this->getSelect()->joinLeft( + array('template'=>$this->getTable('template')), 'template.template_id=main_table.template_id', array('template_subject','template_sender_name','template_sender_email') ); @@ -82,7 +83,7 @@ public function addTemplateInfo() */ protected function _addSubscriberInfoToSelect() { - /** @var $select Varien_Db_Select */ + /** @var Varien_Db_Select $select */ $select = $this->getConnection()->select() ->from(array('qlt' => $this->getTable('newsletter/queue_link')), 'COUNT(qlt.queue_link_id)') ->where('qlt.queue_id = main_table.queue_id'); @@ -103,9 +104,7 @@ protected function _addSubscriberInfoToSelect() /** * Adds subscribers info to select and loads collection * - * @param bool $printQuery - * @param bool $logQuery - * @return $this + * @inheritDoc */ public function load($printQuery = false, $logQuery = false) { @@ -130,9 +129,7 @@ public function addSubscribersInfo() * Checks if field is 'subscribers_total', 'subscribers_sent' * to add specific filter or adds reguler filter * - * @param string $field - * @param mixed $condition - * @return $this + * @inheritDoc */ public function addFieldToFilter($field, $condition = null) { @@ -182,7 +179,8 @@ protected function _getIdsFromLink($field, $condition) */ public function addSubscriberFilter($subscriberId) { - $this->getSelect()->join(array('link'=>$this->getTable('newsletter/queue_link')), + $this->getSelect()->join( + array('link'=>$this->getTable('newsletter/queue_link')), 'main_table.queue_id=link.queue_id', array('letter_sent_at') ) @@ -238,8 +236,10 @@ public function toOptionArray() public function addStoreFilter($storeIds) { if (!$this->_isStoreFilter) { - $this->getSelect()->joinInner(array('store_link' => $this->getTable('newsletter/queue_store_link')), - 'main_table.queue_id = store_link.queue_id', array() + $this->getSelect()->joinInner( + array('store_link' => $this->getTable('newsletter/queue_store_link')), + 'main_table.queue_id = store_link.queue_id', + array() ) ->where('store_link.store_id IN (?)', $storeIds) ->group('main_table.queue_id'); diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Subscriber.php b/app/code/core/Mage/Newsletter/Model/Resource/Subscriber.php index 301a269e091..e9682af454b 100644 --- a/app/code/core/Mage/Newsletter/Model/Resource/Subscriber.php +++ b/app/code/core/Mage/Newsletter/Model/Resource/Subscriber.php @@ -164,8 +164,7 @@ public function received(Mage_Newsletter_Model_Subscriber $subscriber, Mage_News 'queue_id = ?' => $queue->getId() )); $this->_write->commit(); - } - catch (Exception $e) { + } catch (Exception $e) { $this->_write->rollBack(); Mage::throwException(Mage::helper('newsletter')->__('Cannot mark as received subscriber.')); } diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Subscriber/Collection.php b/app/code/core/Mage/Newsletter/Model/Resource/Subscriber/Collection.php index 3e0360e1b05..e14f5e8fcac 100644 --- a/app/code/core/Mage/Newsletter/Model/Resource/Subscriber/Collection.php +++ b/app/code/core/Mage/Newsletter/Model/Resource/Subscriber/Collection.php @@ -140,22 +140,19 @@ public function showCustomerInfo() ->joinLeft( array('customer_lastname_table' => $lastname->getBackend()->getTable()), $adapter->quoteInto('customer_lastname_table.entity_id=main_table.customer_id - AND customer_lastname_table.attribute_id = ?', (int) $lastname->getAttributeId() - ), + AND customer_lastname_table.attribute_id = ?', (int) $lastname->getAttributeId()), array('customer_lastname'=>'value') ) ->joinLeft( array('customer_middlename_table' => $middlename->getBackend()->getTable()), $adapter->quoteInto('customer_middlename_table.entity_id=main_table.customer_id - AND customer_middlename_table.attribute_id = ?', (int) $middlename->getAttributeId() - ), + AND customer_middlename_table.attribute_id = ?', (int) $middlename->getAttributeId()), array('customer_middlename'=>'value') ) ->joinLeft( array('customer_firstname_table' => $firstname->getBackend()->getTable()), $adapter->quoteInto('customer_firstname_table.entity_id=main_table.customer_id - AND customer_firstname_table.attribute_id = ?', (int) $firstname->getAttributeId() - ), + AND customer_firstname_table.attribute_id = ?', (int) $firstname->getAttributeId()), array('customer_firstname'=>'value') ); @@ -201,7 +198,7 @@ public function showStoreInfo() public function _getFieldTableAlias($field) { if (strpos($field, 'customer') === 0) { - return $field .'_table.value'; + return $field .'_table.value'; } if ($field == 'type') { diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Template.php b/app/code/core/Mage/Newsletter/Model/Resource/Template.php index 64a094e4a12..dc5c4190855 100644 --- a/app/code/core/Mage/Newsletter/Model/Resource/Template.php +++ b/app/code/core/Mage/Newsletter/Model/Resource/Template.php @@ -122,8 +122,8 @@ public function checkCodeUsage(Mage_Newsletter_Model_Template $template) /** * Perform actions before object save * - * @param Mage_Core_Model_Abstract $object - * @return $this + * @param Mage_Newsletter_Model_Template $object + * @inheritDoc */ protected function _beforeSave(Mage_Core_Model_Abstract $object) { diff --git a/app/code/core/Mage/Newsletter/Model/Session.php b/app/code/core/Mage/Newsletter/Model/Session.php index 54293b47018..0b9e5c6eaad 100644 --- a/app/code/core/Mage/Newsletter/Model/Session.php +++ b/app/code/core/Mage/Newsletter/Model/Session.php @@ -39,18 +39,29 @@ public function __construct() $this->init('newsletter'); } + /** + * @param string $message + * @return $this + */ public function addError($message) { $this->setErrorMessage($message); return $this; } + /** + * @param string $message + * @return $this + */ public function addSuccess($message) { $this->setSuccessMessage($message); return $this; } + /** + * @return string + */ public function getError() { $message = $this->getErrorMessage(); @@ -58,6 +69,9 @@ public function getError() return $message; } + /** + * @return string + */ public function getSuccess() { $message = $this->getSuccessMessage(); diff --git a/app/code/core/Mage/Newsletter/Model/Subscriber.php b/app/code/core/Mage/Newsletter/Model/Subscriber.php index 029ef27b1cb..2510690abd8 100644 --- a/app/code/core/Mage/Newsletter/Model/Subscriber.php +++ b/app/code/core/Mage/Newsletter/Model/Subscriber.php @@ -29,18 +29,28 @@ * * @method Mage_Newsletter_Model_Resource_Subscriber _getResource() * @method Mage_Newsletter_Model_Resource_Subscriber getResource() - * @method int getStoreId() - * @method Mage_Newsletter_Model_Subscriber setStoreId(int $value) * @method string getChangeStatusAt() - * @method Mage_Newsletter_Model_Subscriber setChangeStatusAt(string $value) + * @method $this setChangeStatusAt(string $value) + * @method bool hasCheckCode() + * @method string getCheckCode() + * @method $this setCheckCode(string $value) * @method int getCustomerId() - * @method Mage_Newsletter_Model_Subscriber setCustomerId(int $value) + * @method $this setCustomerId(int $value) + * @method setImportMode(bool $value) + * @method string getName() + * @method int getStoreId() + * @method $this setStoreId(int $value) + * @method string getSubscriberConfirmCode() + * @method $this setSubscriberConfirmCode(string $value) * @method string getSubscriberEmail() - * @method Mage_Newsletter_Model_Subscriber setSubscriberEmail(string $value) + * @method $this setSubscriberEmail(string $value) + * @method int getSubscriberId() + * @method $this setSubscriberId(int $value) * @method int getSubscriberStatus() - * @method Mage_Newsletter_Model_Subscriber setSubscriberStatus(int $value) - * @method string getSubscriberConfirmCode() - * @method Mage_Newsletter_Model_Subscriber setSubscriberConfirmCode(string $value) + * @method $this setSubscriberStatus(int $value) + * @method bool getImportMode() + * @method bool hasCustomerFirstname() + * @method bool hasCustomerLastname() * * @category Mage * @package Mage_Newsletter @@ -112,6 +122,7 @@ public function getId() * Alias for setSubscriberId() * * @param int $value + * @return $this */ public function setId($value) { @@ -133,7 +144,8 @@ public function getCode() * * @return string */ - public function getConfirmationLink() { + public function getConfirmationLink() + { return Mage::helper('newsletter')->getConfirmationUrl($this); } @@ -142,7 +154,8 @@ public function getConfirmationLink() { * * @return string */ - public function getUnsubscriptionLink() { + public function getUnsubscriptionLink() + { return Mage::helper('newsletter')->getUnsubscribeUrl($this); } @@ -150,6 +163,7 @@ public function getUnsubscriptionLink() { * Alias for setSubscriberConfirmCode() * * @param string $value + * @return $this */ public function setCode($value) { @@ -169,7 +183,8 @@ public function getStatus() /** * Alias for setSubscriberStatus() * - * @param int + * @param int $value + * @return $this */ public function setStatus($value) { @@ -203,6 +218,7 @@ public function getEmail() * Alias for setSubscriberEmail() * * @param string $value + * @return $this */ public function setEmail($value) { @@ -213,6 +229,7 @@ public function setEmail($value) * Set for status change flag * * @param boolean $value + * @return $this */ public function setIsStatusChanged($value) { @@ -237,7 +254,7 @@ public function getIsStatusChanged() */ public function isSubscribed() { - if($this->getId() && $this->getStatus()==self::STATUS_SUBSCRIBED) { + if ($this->getId() && $this->getStatus()==self::STATUS_SUBSCRIBED) { return true; } @@ -245,10 +262,11 @@ public function isSubscribed() } - /** + /** * Load subscriber data from resource model by email * - * @param int $subscriberId + * @param string $subscriberEmail + * @return $this */ public function loadByEmail($subscriberEmail) { @@ -283,13 +301,13 @@ public function loadByCustomer(Mage_Customer_Model_Customer $customer) * @param int $length * @return string */ - public function randomSequence($length=32) + public function randomSequence($length = 32) { $id = ''; $par = array(); - $char = array_merge(range('a','z'),range(0,9)); + $char = array_merge(range('a', 'z'), range(0, 9)); $charLen = count($char)-1; - for ($i=0;$i<$length;$i++){ + for ($i=0; $i<$length; $i++) { $disc = mt_rand(0, $charLen); $par[$i] = $char[$disc]; $id = $id.$char[$disc]; @@ -309,7 +327,7 @@ public function subscribe($email) $this->loadByEmail($email); $customerSession = Mage::getSingleton('customer/session'); - if(!$this->getId()) { + if (!$this->getId()) { $this->setSubscriberConfirmCode($this->randomSequence()); } @@ -327,7 +345,7 @@ public function subscribe($email) if ($isConfirmNeed === true) { // if user subscribes own login email - confirmation is not needed $isOwnSubscribes = $isSubscribeOwnEmail; - if ($isOwnSubscribes == true){ + if ($isOwnSubscribes == true) { $this->setStatus(self::STATUS_SUBSCRIBED); } else { $this->setStatus(self::STATUS_NOT_ACTIVE); @@ -384,7 +402,7 @@ public function unsubscribe() * Saving customer subscription status * * @param Mage_Customer_Model_Customer $customer - * @return Mage_Newsletter_Model_Subscriber + * @return $this */ public function subscribeCustomer($customer) { @@ -400,17 +418,17 @@ public function subscribeCustomer($customer) return $this; } - if(!$this->getId()) { + if (!$this->getId()) { $this->setSubscriberConfirmCode($this->randomSequence()); } - /* + /** * Logical mismatch between customer registration confirmation code and customer password confirmation */ - $confirmation = null; - if ($customer->isConfirmationRequired() && ($customer->getConfirmation() != $customer->getPassword())) { - $confirmation = $customer->getConfirmation(); - } + $confirmation = null; + if ($customer->isConfirmationRequired() && ($customer->getConfirmation() != $customer->getPassword())) { + $confirmation = $customer->getConfirmation(); + } $sendInformationEmail = false; if ($customer->hasIsSubscribed()) { @@ -430,13 +448,13 @@ public function subscribeCustomer($customer) $status = ($this->getStatus() == self::STATUS_NOT_ACTIVE ? self::STATUS_UNSUBSCRIBED : $this->getStatus()); } - if($status != $this->getStatus()) { + if ($status != $this->getStatus()) { $this->setIsStatusChanged(true); } $this->setStatus($status); - if(!$this->getId()) { + if (!$this->getId()) { $storeId = $customer->getStoreId(); if ($customer->getStoreId() == 0) { $storeId = Mage::app()->getWebsite($customer->getWebsiteId())->getDefaultStore()->getId(); @@ -469,7 +487,7 @@ public function subscribeCustomer($customer) */ public function confirm($code) { - if($this->getCode()==$code) { + if ($this->getCode()==$code) { $this->setStatus(self::STATUS_SUBSCRIBED) ->setIsStatusChanged(true) ->save(); @@ -482,12 +500,12 @@ public function confirm($code) /** * Mark receiving subscriber of queue newsletter * - * @param Mage_Newsletter_Model_Queue $queue - * @return boolean + * @param Mage_Newsletter_Model_Queue $queue + * @return $this */ public function received(Mage_Newsletter_Model_Queue $queue) { - $this->getResource()->received($this,$queue); + $this->getResource()->received($this, $queue); return $this; } @@ -502,14 +520,14 @@ public function sendConfirmationRequestEmail() return $this; } - if(!Mage::getStoreConfig(self::XML_PATH_CONFIRM_EMAIL_TEMPLATE) + if (!Mage::getStoreConfig(self::XML_PATH_CONFIRM_EMAIL_TEMPLATE) || !Mage::getStoreConfig(self::XML_PATH_CONFIRM_EMAIL_IDENTITY) - ) { + ) { return $this; } $translate = Mage::getSingleton('core/translate'); - /* @var $translate Mage_Core_Model_Translate */ + /* @var Mage_Core_Model_Translate $translate */ $translate->setTranslateInline(false); $email = Mage::getModel('core/email_template'); @@ -539,14 +557,14 @@ public function sendConfirmationSuccessEmail() return $this; } - if(!Mage::getStoreConfig(self::XML_PATH_SUCCESS_EMAIL_TEMPLATE) + if (!Mage::getStoreConfig(self::XML_PATH_SUCCESS_EMAIL_TEMPLATE) || !Mage::getStoreConfig(self::XML_PATH_SUCCESS_EMAIL_IDENTITY) ) { return $this; } $translate = Mage::getSingleton('core/translate'); - /* @var $translate Mage_Core_Model_Translate */ + /* @var Mage_Core_Model_Translate $translate */ $translate->setTranslateInline(false); $email = Mage::getModel('core/email_template'); @@ -575,14 +593,14 @@ public function sendUnsubscriptionEmail() if ($this->getImportMode()) { return $this; } - if(!Mage::getStoreConfig(self::XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE) + if (!Mage::getStoreConfig(self::XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE) || !Mage::getStoreConfig(self::XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY) ) { return $this; } $translate = Mage::getSingleton('core/translate'); - /* @var $translate Mage_Core_Model_Translate */ + /* @var Mage_Core_Model_Translate $translate */ $translate->setTranslateInline(false); $email = Mage::getModel('core/email_template'); diff --git a/app/code/core/Mage/Newsletter/Model/Template.php b/app/code/core/Mage/Newsletter/Model/Template.php index 9d9dec3d87b..e1c99ac343a 100644 --- a/app/code/core/Mage/Newsletter/Model/Template.php +++ b/app/code/core/Mage/Newsletter/Model/Template.php @@ -30,25 +30,29 @@ * @method Mage_Newsletter_Model_Resource_Template _getResource() * @method Mage_Newsletter_Model_Resource_Template getResource() * @method string getTemplateCode() - * @method Mage_Newsletter_Model_Template setTemplateCode(string $value) - * @method Mage_Newsletter_Model_Template setTemplateText(string $value) - * @method Mage_Newsletter_Model_Template setTemplateTextPreprocessed(string $value) + * @method $this setTemplateCode(string $value) + * @method $this setTemplateText(string $value) + * @method $this setTemplateTextPreprocessed(string $value) * @method string getTemplateStyles() - * @method Mage_Newsletter_Model_Template setTemplateStyles(string $value) + * @method $this setTemplateStyles(string $value) * @method int getTemplateType() - * @method Mage_Newsletter_Model_Template setTemplateType(int $value) + * @method $this setTemplateType(int $value) * @method string getTemplateSubject() - * @method Mage_Newsletter_Model_Template setTemplateSubject(string $value) + * @method $this setTemplateSubject(string $value) * @method string getTemplateSenderName() - * @method Mage_Newsletter_Model_Template setTemplateSenderName(string $value) + * @method $this setTemplateSenderName(string $value) * @method string getTemplateSenderEmail() - * @method Mage_Newsletter_Model_Template setTemplateSenderEmail(string $value) + * @method $this setTemplateSenderEmail(string $value) + * @method bool hasTemplateActual() * @method int getTemplateActual() - * @method Mage_Newsletter_Model_Template setTemplateActual(int $value) + * @method $this setTemplateActual(int $value) + * @method bool hasAddedAt() * @method string getAddedAt() - * @method Mage_Newsletter_Model_Template setAddedAt(string $value) + * @method $this setAddedAt(string $value) * @method string getModifiedAt() - * @method Mage_Newsletter_Model_Template setModifiedAt(string $value) + * @method $this setModifiedAt(string $value) + * @method bool getIsSystem() + * @method $this setInlineCssFile(bool|string $value) * * @category Mage * @package Mage_Newsletter @@ -105,8 +109,7 @@ public function validate() foreach ($messages as $message) { $errorMessages[] = $message; } - } - else { + } else { $errorMessages[] = $messages; } } @@ -118,7 +121,7 @@ public function validate() /** * Processing object before save data * - * @return $this + * @inheritDoc */ protected function _beforeSave() { @@ -157,7 +160,8 @@ public function isValidForSend() * * @return int|string */ - public function getType(){ + public function getType() + { return $this->getTemplateType(); } @@ -194,7 +198,7 @@ public function getTemplateTextPreprocessed() */ public function getProcessedTemplate(array $variables = array(), $usePreprocess = false) { - /* @var $processor Mage_Newsletter_Model_Template_Filter */ + /* @var Mage_Newsletter_Model_Template_Filter $processor */ $processor = Mage::helper('newsletter')->getTemplateProcessor(); if (!$this->_preprocessFlag) { @@ -234,6 +238,7 @@ public function getProcessedTemplate(array $variables = array(), $usePreprocess * Makes additional text preparations for HTML templates * * @param bool $usePreprocess Use Preprocessed text or original text + * @param string|null $html * @return string */ public function getPreparedTemplateText($usePreprocess = false, $html = null) @@ -292,7 +297,7 @@ public function getMail() * @return boolean * @deprecated since 1.4.0.1 **/ - public function send($subscriber, array $variables = array(), $name=null, Mage_Newsletter_Model_Queue $queue=null) + public function send($subscriber, array $variables = array(), $name = null, Mage_Newsletter_Model_Queue $queue = null) { if (!$this->isValidForSend()) { return false; @@ -304,8 +309,7 @@ public function send($subscriber, array $variables = array(), $name=null, Mage_N if (is_null($name)) { $name = $subscriber->getSubscriberFullName(); } - } - else { + } else { $email = (string) $subscriber; } @@ -322,8 +326,7 @@ public function send($subscriber, array $variables = array(), $name=null, Mage_N if ($this->isPlain()) { $mail->setBodyText($text); - } - else { + } else { $mail->setBodyHtml($text); } @@ -336,8 +339,7 @@ public function send($subscriber, array $variables = array(), $name=null, Mage_N if (!is_null($queue)) { $subscriber->received($queue); } - } - catch (Exception $e) { + } catch (Exception $e) { if ($subscriber instanceof Mage_Newsletter_Model_Subscriber) { // If letter sent for subscriber, we create a problem report entry $problem = Mage::getModel('newsletter/problem'); @@ -401,7 +403,8 @@ public function getProcessedTemplateSubject(array $variables) public function getTemplateText() { if (!$this->getData('template_text') && !$this->getId()) { - $this->setData('template_text', + $this->setData( + 'template_text', Mage::helper('newsletter')->__('Follow this link to unsubscribe {{var subscriber.getUnsubscriptionLink()}}') ); } diff --git a/app/code/core/Mage/Newsletter/controllers/ManageController.php b/app/code/core/Mage/Newsletter/controllers/ManageController.php index cff66a01eb8..4acaef583e3 100644 --- a/app/code/core/Mage/Newsletter/controllers/ManageController.php +++ b/app/code/core/Mage/Newsletter/controllers/ManageController.php @@ -60,6 +60,9 @@ public function indexAction() $this->renderLayout(); } + /** + * @return Mage_Newsletter_ManageController + */ public function saveAction() { if (!$this->_validateFormKey()) { @@ -75,8 +78,7 @@ public function saveAction() } else { Mage::getSingleton('customer/session')->addSuccess($this->__('The subscription has been removed.')); } - } - catch (Exception $e) { + } catch (Exception $e) { Mage::getSingleton('customer/session')->addError($this->__('An error occurred while saving your subscription.')); } $this->_redirect('customer/account/'); diff --git a/app/code/core/Mage/Newsletter/controllers/SubscriberController.php b/app/code/core/Mage/Newsletter/controllers/SubscriberController.php index 0ea68a972c8..0458f33fffe 100644 --- a/app/code/core/Mage/Newsletter/controllers/SubscriberController.php +++ b/app/code/core/Mage/Newsletter/controllers/SubscriberController.php @@ -48,7 +48,7 @@ public function newAction() Mage::throwException($this->__('Please enter a valid email address.')); } - if (Mage::getStoreConfig(Mage_Newsletter_Model_Subscriber::XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG) != 1 && + if (Mage::getStoreConfig(Mage_Newsletter_Model_Subscriber::XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG) != 1 && !$customerSession->isLoggedIn()) { Mage::throwException($this->__('Sorry, but administrator denied subscription for guests. Please register.', Mage::helper('customer')->getRegisterUrl())); } @@ -64,15 +64,12 @@ public function newAction() $status = Mage::getModel('newsletter/subscriber')->subscribe($email); if ($status == Mage_Newsletter_Model_Subscriber::STATUS_NOT_ACTIVE) { $session->addSuccess($this->__('Confirmation request has been sent.')); - } - else { + } else { $session->addSuccess($this->__('Thank you for your subscription.')); } - } - catch (Mage_Core_Exception $e) { + } catch (Mage_Core_Exception $e) { $session->addException($e, $this->__('There was a problem with the subscription: %s', $e->getMessage())); - } - catch (Exception $e) { + } catch (Exception $e) { $session->addException($e, $this->__('There was a problem with the subscription.')); } } @@ -91,8 +88,8 @@ public function confirmAction() $subscriber = Mage::getModel('newsletter/subscriber')->load($id); $session = Mage::getSingleton('core/session'); - if($subscriber->getId() && $subscriber->getCode()) { - if($subscriber->confirm($code)) { + if ($subscriber->getId() && $subscriber->getCode()) { + if ($subscriber->confirm($code)) { $session->addSuccess($this->__('Your subscription has been confirmed.')); } else { $session->addError($this->__('Invalid subscription confirmation code.')); @@ -120,11 +117,9 @@ public function unsubscribeAction() ->setCheckCode($code) ->unsubscribe(); $session->addSuccess($this->__('You have been unsubscribed.')); - } - catch (Mage_Core_Exception $e) { + } catch (Mage_Core_Exception $e) { $session->addException($e, $e->getMessage()); - } - catch (Exception $e) { + } catch (Exception $e) { $session->addException($e, $this->__('There was a problem with the un-subscription.')); } } diff --git a/app/code/core/Mage/Newsletter/data/newsletter_setup/data-upgrade-1.6.0.0-1.6.0.1.php b/app/code/core/Mage/Newsletter/data/newsletter_setup/data-upgrade-1.6.0.0-1.6.0.1.php index b0e93a4e6c1..d6162b1328f 100644 --- a/app/code/core/Mage/Newsletter/data/newsletter_setup/data-upgrade-1.6.0.0-1.6.0.1.php +++ b/app/code/core/Mage/Newsletter/data/newsletter_setup/data-upgrade-1.6.0.0-1.6.0.1.php @@ -24,7 +24,7 @@ * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) */ -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer = $this; $subscriberTable = $installer->getTable('newsletter/subscriber'); diff --git a/app/code/core/Mage/Newsletter/data/newsletter_setup/data-upgrade-1.6.0.1-1.6.0.2.php b/app/code/core/Mage/Newsletter/data/newsletter_setup/data-upgrade-1.6.0.1-1.6.0.2.php index d31de4b59bd..2bae372f54a 100644 --- a/app/code/core/Mage/Newsletter/data/newsletter_setup/data-upgrade-1.6.0.1-1.6.0.2.php +++ b/app/code/core/Mage/Newsletter/data/newsletter_setup/data-upgrade-1.6.0.1-1.6.0.2.php @@ -24,7 +24,7 @@ * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) */ -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer = $this; @@ -269,7 +269,7 @@ $data = array( 'template_code' => 'Example Newsletter Template', 'template_text' => $newsletterContent , - 'template_styles' => NULL, + 'template_styles' => null, 'template_type' => Mage_Newsletter_Model_Template::TYPE_HTML, 'template_subject' => 'Example Subject', 'template_sender_name' => Mage::getStoreConfig('trans_email/ident_general/name'), @@ -283,6 +283,6 @@ try { $model->save(); -} catch (Exception $e){ +} catch (Exception $e) { Mage::logException($e->getMessage()); } diff --git a/app/code/core/Mage/Newsletter/sql/newsletter_setup/install-1.6.0.0.php b/app/code/core/Mage/Newsletter/sql/newsletter_setup/install-1.6.0.0.php index 752cf28ef2d..d22534c2cc7 100644 --- a/app/code/core/Mage/Newsletter/sql/newsletter_setup/install-1.6.0.0.php +++ b/app/code/core/Mage/Newsletter/sql/newsletter_setup/install-1.6.0.0.php @@ -33,7 +33,7 @@ * @author Magento Core Team */ $installer = $this; -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer->startSetup(); @@ -70,13 +70,22 @@ ->addColumn('subscriber_confirm_code', Varien_Db_Ddl_Table::TYPE_TEXT, 32, array( 'default' => 'NULL', ), 'Subscriber Confirm Code') - ->addIndex($installer->getIdxName('newsletter/subscriber', array('customer_id')), - array('customer_id')) - ->addIndex($installer->getIdxName('newsletter/subscriber', array('store_id')), - array('store_id')) - ->addForeignKey($installer->getFkName('newsletter/subscriber', 'store_id', 'core/store', 'store_id'), - 'store_id', $installer->getTable('core/store'), 'store_id', - Varien_Db_Ddl_Table::ACTION_SET_NULL, Varien_Db_Ddl_Table::ACTION_CASCADE) + ->addIndex( + $installer->getIdxName('newsletter/subscriber', array('customer_id')), + array('customer_id') + ) + ->addIndex( + $installer->getIdxName('newsletter/subscriber', array('store_id')), + array('store_id') + ) + ->addForeignKey( + $installer->getFkName('newsletter/subscriber', 'store_id', 'core/store', 'store_id'), + 'store_id', + $installer->getTable('core/store'), + 'store_id', + Varien_Db_Ddl_Table::ACTION_SET_NULL, + Varien_Db_Ddl_Table::ACTION_CASCADE + ) ->setComment('Newsletter Subscriber'); $installer->getConnection()->createTable($table); @@ -116,12 +125,18 @@ ), 'Added At') ->addColumn('modified_at', Varien_Db_Ddl_Table::TYPE_TIMESTAMP, null, array( ), 'Modified At') - ->addIndex($installer->getIdxName('newsletter/template', array('template_actual')), - array('template_actual')) - ->addIndex($installer->getIdxName('newsletter/template', array('added_at')), - array('added_at')) - ->addIndex($installer->getIdxName('newsletter/template', array('modified_at')), - array('modified_at')) + ->addIndex( + $installer->getIdxName('newsletter/template', array('template_actual')), + array('template_actual') + ) + ->addIndex( + $installer->getIdxName('newsletter/template', array('added_at')), + array('added_at') + ) + ->addIndex( + $installer->getIdxName('newsletter/template', array('modified_at')), + array('modified_at') + ) ->setComment('Newsletter Template'); $installer->getConnection()->createTable($table); @@ -162,11 +177,18 @@ ), 'Queue Start At') ->addColumn('queue_finish_at', Varien_Db_Ddl_Table::TYPE_TIMESTAMP, null, array( ), 'Queue Finish At') - ->addIndex($installer->getIdxName('newsletter/queue', array('template_id')), - array('template_id')) - ->addForeignKey($installer->getFkName('newsletter/queue', 'template_id', 'newsletter/template', 'template_id'), - 'template_id', $installer->getTable('newsletter/template'), 'template_id', - Varien_Db_Ddl_Table::ACTION_CASCADE, Varien_Db_Ddl_Table::ACTION_CASCADE) + ->addIndex( + $installer->getIdxName('newsletter/queue', array('template_id')), + array('template_id') + ) + ->addForeignKey( + $installer->getFkName('newsletter/queue', 'template_id', 'newsletter/template', 'template_id'), + 'template_id', + $installer->getTable('newsletter/template'), + 'template_id', + Varien_Db_Ddl_Table::ACTION_CASCADE, + Varien_Db_Ddl_Table::ACTION_CASCADE + ) ->setComment('Newsletter Queue'); $installer->getConnection()->createTable($table); @@ -193,19 +215,34 @@ ), 'Subscriber Id') ->addColumn('letter_sent_at', Varien_Db_Ddl_Table::TYPE_TIMESTAMP, null, array( ), 'Letter Sent At') - ->addIndex($installer->getIdxName('newsletter/queue_link', array('subscriber_id')), - array('subscriber_id')) - ->addIndex($installer->getIdxName('newsletter/queue_link', array('queue_id')), - array('queue_id')) - ->addIndex($installer->getIdxName('newsletter/queue_link', array('queue_id', 'letter_sent_at')), - array('queue_id', 'letter_sent_at')) - ->addForeignKey($installer->getFkName('newsletter/queue_link', 'queue_id', 'newsletter/queue', 'queue_id'), - 'queue_id', $installer->getTable('newsletter/queue'), 'queue_id', - Varien_Db_Ddl_Table::ACTION_CASCADE, Varien_Db_Ddl_Table::ACTION_CASCADE) + ->addIndex( + $installer->getIdxName('newsletter/queue_link', array('subscriber_id')), + array('subscriber_id') + ) + ->addIndex( + $installer->getIdxName('newsletter/queue_link', array('queue_id')), + array('queue_id') + ) + ->addIndex( + $installer->getIdxName('newsletter/queue_link', array('queue_id', 'letter_sent_at')), + array('queue_id', 'letter_sent_at') + ) + ->addForeignKey( + $installer->getFkName('newsletter/queue_link', 'queue_id', 'newsletter/queue', 'queue_id'), + 'queue_id', + $installer->getTable('newsletter/queue'), + 'queue_id', + Varien_Db_Ddl_Table::ACTION_CASCADE, + Varien_Db_Ddl_Table::ACTION_CASCADE + ) ->addForeignKey( $installer->getFkName('newsletter/queue_link', 'subscriber_id', 'newsletter/subscriber', 'subscriber_id'), - 'subscriber_id', $installer->getTable('newsletter/subscriber'), 'subscriber_id', - Varien_Db_Ddl_Table::ACTION_CASCADE, Varien_Db_Ddl_Table::ACTION_CASCADE) + 'subscriber_id', + $installer->getTable('newsletter/subscriber'), + 'subscriber_id', + Varien_Db_Ddl_Table::ACTION_CASCADE, + Varien_Db_Ddl_Table::ACTION_CASCADE + ) ->setComment('Newsletter Queue Link'); $installer->getConnection()->createTable($table); @@ -226,14 +263,26 @@ 'primary' => true, 'default' => '0', ), 'Store Id') - ->addIndex($installer->getIdxName('newsletter/queue_store_link', array('store_id')), - array('store_id')) - ->addForeignKey($installer->getFkName('newsletter/queue_store_link', 'queue_id', 'newsletter/queue', 'queue_id'), - 'queue_id', $installer->getTable('newsletter/queue'), 'queue_id', - Varien_Db_Ddl_Table::ACTION_CASCADE, Varien_Db_Ddl_Table::ACTION_CASCADE) - ->addForeignKey($installer->getFkName('newsletter/queue_store_link', 'store_id', 'core/store', 'store_id'), - 'store_id', $installer->getTable('core/store'), 'store_id', - Varien_Db_Ddl_Table::ACTION_CASCADE, Varien_Db_Ddl_Table::ACTION_CASCADE) + ->addIndex( + $installer->getIdxName('newsletter/queue_store_link', array('store_id')), + array('store_id') + ) + ->addForeignKey( + $installer->getFkName('newsletter/queue_store_link', 'queue_id', 'newsletter/queue', 'queue_id'), + 'queue_id', + $installer->getTable('newsletter/queue'), + 'queue_id', + Varien_Db_Ddl_Table::ACTION_CASCADE, + Varien_Db_Ddl_Table::ACTION_CASCADE + ) + ->addForeignKey( + $installer->getFkName('newsletter/queue_store_link', 'store_id', 'core/store', 'store_id'), + 'store_id', + $installer->getTable('core/store'), + 'store_id', + Varien_Db_Ddl_Table::ACTION_CASCADE, + Varien_Db_Ddl_Table::ACTION_CASCADE + ) ->setComment('Newsletter Queue Store Link'); $installer->getConnection()->createTable($table); @@ -262,17 +311,30 @@ ), 'Problem Error Code') ->addColumn('problem_error_text', Varien_Db_Ddl_Table::TYPE_TEXT, 200, array( ), 'Problem Error Text') - ->addIndex($installer->getIdxName('newsletter/problem', array('subscriber_id')), - array('subscriber_id')) - ->addIndex($installer->getIdxName('newsletter/problem', array('queue_id')), - array('queue_id')) - ->addForeignKey($installer->getFkName('newsletter/problem', 'queue_id', 'newsletter/queue', 'queue_id'), - 'queue_id', $installer->getTable('newsletter/queue'), 'queue_id', - Varien_Db_Ddl_Table::ACTION_CASCADE, Varien_Db_Ddl_Table::ACTION_CASCADE) + ->addIndex( + $installer->getIdxName('newsletter/problem', array('subscriber_id')), + array('subscriber_id') + ) + ->addIndex( + $installer->getIdxName('newsletter/problem', array('queue_id')), + array('queue_id') + ) + ->addForeignKey( + $installer->getFkName('newsletter/problem', 'queue_id', 'newsletter/queue', 'queue_id'), + 'queue_id', + $installer->getTable('newsletter/queue'), + 'queue_id', + Varien_Db_Ddl_Table::ACTION_CASCADE, + Varien_Db_Ddl_Table::ACTION_CASCADE + ) ->addForeignKey( $installer->getFkName('newsletter/problem', 'subscriber_id', 'newsletter/subscriber', 'subscriber_id'), - 'subscriber_id', $installer->getTable('newsletter/subscriber'), 'subscriber_id', - Varien_Db_Ddl_Table::ACTION_CASCADE, Varien_Db_Ddl_Table::ACTION_CASCADE) + 'subscriber_id', + $installer->getTable('newsletter/subscriber'), + 'subscriber_id', + Varien_Db_Ddl_Table::ACTION_CASCADE, + Varien_Db_Ddl_Table::ACTION_CASCADE + ) ->setComment('Newsletter Problems'); $installer->getConnection()->createTable($table); diff --git a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-install-0.7.0.php b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-install-0.7.0.php index b8342862446..c234570b951 100644 --- a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-install-0.7.0.php +++ b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-install-0.7.0.php @@ -25,7 +25,7 @@ */ $installer = $this; -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer->startSetup(); diff --git a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-install-0.8.0.php b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-install-0.8.0.php index bd1bab1470e..6ba41ee8aff 100644 --- a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-install-0.8.0.php +++ b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-install-0.8.0.php @@ -33,7 +33,7 @@ * @author Magento Core Team */ $installer = $this; -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer->startSetup(); $installer->run(" diff --git a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.7.0-0.7.1.php b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.7.0-0.7.1.php index 6e007bf2d82..38125831cf9 100644 --- a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.7.0-0.7.1.php +++ b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.7.0-0.7.1.php @@ -33,7 +33,7 @@ */ $installer = $this; -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer->startSetup(); diff --git a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.0-0.8.1.php b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.0-0.8.1.php index 79f7e9dfbb6..639c9546497 100644 --- a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.0-0.8.1.php +++ b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.0-0.8.1.php @@ -33,7 +33,7 @@ */ $installer = $this; -/* @var $installer Mage_Tax_Model_Mysql4_Setup */ +/* @var Mage_Tax_Model_Mysql4_Setup $installer */ $installer->startSetup(); diff --git a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.1-0.8.2.php b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.1-0.8.2.php index bc106722421..3ec1cd03639 100644 --- a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.1-0.8.2.php +++ b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.1-0.8.2.php @@ -24,10 +24,12 @@ * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) */ -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer = $this; $installer->startSetup(); $installer->getConnection()->addColumn( - $installer->getTable('newsletter_template'), 'template_styles', "text AFTER `template_text_preprocessed`" + $installer->getTable('newsletter_template'), + 'template_styles', + "text AFTER `template_text_preprocessed`" ); $installer->endSetup(); diff --git a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.2-0.8.3.php b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.2-0.8.3.php index 88e7cdb7922..059cd5fc59f 100644 --- a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.2-0.8.3.php +++ b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-0.8.2-0.8.3.php @@ -24,7 +24,7 @@ * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) */ -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer = $this; $queueTable = $installer->getTable('newsletter_queue'); $templateTable = $installer->getTable('newsletter_template'); @@ -36,8 +36,11 @@ $conn->addColumn($queueTable, 'newsletter_styles', "text AFTER `newsletter_text`"); $conn->addColumn($queueTable, 'newsletter_subject', "varchar(200) default NULL AFTER `newsletter_styles`"); $conn->addColumn($queueTable, 'newsletter_sender_name', "varchar(200) default NULL AFTER `newsletter_subject`"); -$conn->addColumn($queueTable, 'newsletter_sender_email', - "varchar(200) character set latin1 collate latin1_general_ci default NULL AFTER `newsletter_sender_name`"); +$conn->addColumn( + $queueTable, + 'newsletter_sender_email', + "varchar(200) character set latin1 collate latin1_general_ci default NULL AFTER `newsletter_sender_name`" +); $conn->modifyColumn($templateTable, 'template_text_preprocessed', "text comment 'deprecated since 1.4.0.1'"); @@ -47,8 +50,8 @@ $select = $conn->select() ->from(array('main_table' => $queueTable), array('main_table.queue_id', 'main_table.template_id')) ->joinLeft( - $templateTable, - "$templateTable.template_id = main_table.template_id", + $templateTable, + "$templateTable.template_id = main_table.template_id", array( 'template_type', 'template_text', @@ -61,7 +64,7 @@ $rows = $conn->fetchAll($select); if ($rows) { - foreach($rows as $row) { + foreach ($rows as $row) { $whereBind = $conn ->quoteInto('queue_id=?', $row['queue_id']); diff --git a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-1.5.9.9-1.6.0.0.php b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-1.5.9.9-1.6.0.0.php index e1a91190461..717039fb523 100644 --- a/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-1.5.9.9-1.6.0.0.php +++ b/app/code/core/Mage/Newsletter/sql/newsletter_setup/mysql4-upgrade-1.5.9.9-1.6.0.0.php @@ -24,7 +24,7 @@ * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) */ -/* @var $installer Mage_Core_Model_Resource_Setup */ +/* @var Mage_Core_Model_Resource_Setup $installer */ $installer = $this; $installer->startSetup();