1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Adminhtml
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: 
 28: /**
 29:  * Adminhtml giftmessage save model
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Adminhtml
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Adminhtml_Model_Giftmessage_Save extends Varien_Object
 36: {
 37:     protected $_saved = false;
 38: 
 39:     /**
 40:      * Save all seted giftmessages
 41:      *
 42:      * @return Mage_Adminhtml_Model_Giftmessage_Save
 43:      */
 44:     public function saveAllInQuote()
 45:     {
 46:         $giftmessages = $this->getGiftmessages();
 47: 
 48:         if (!is_array($giftmessages)) {
 49:             return $this;
 50:         }
 51: 
 52:         foreach ($giftmessages as $entityId=>$giftmessage) {
 53:             $this->_saveOne($entityId, $giftmessage);
 54:         }
 55: 
 56:         return $this;
 57:     }
 58: 
 59:     public function getSaved()
 60:     {
 61:         return $this->_saved;
 62:     }
 63: 
 64:     public function saveAllInOrder()
 65:     {
 66:         $giftmessages = $this->getGiftmessages();
 67: 
 68:         if (!is_array($giftmessages)) {
 69:             return $this;
 70:         }
 71: 
 72:         foreach ($giftmessages as $entityId=>$giftmessage) {
 73:             $this->_saveOne($entityId, $giftmessage);
 74:         }
 75: 
 76:         return $this;
 77:     }
 78: 
 79:     /**
 80:      * Save a single gift message
 81:      *
 82:      * @param integer $entityId
 83:      * @param array $giftmessage
 84:      * @return Mage_Adminhtml_Model_Giftmessage_Save
 85:      */
 86:     protected function _saveOne($entityId, $giftmessage) {
 87:         /* @var $giftmessageModel Mage_Giftmessage_Model_Message */
 88:         $giftmessageModel = Mage::getModel('giftmessage/message');
 89:         $entityType = $this->_getMappedType($giftmessage['type']);
 90: 
 91:         switch($entityType) {
 92:             case 'quote':
 93:                 $entityModel = $this->_getQuote();
 94:                 break;
 95: 
 96:             case 'quote_item':
 97:                 $entityModel = $this->_getQuote()->getItemById($entityId);
 98:                 break;
 99: 
100:             default:
101:                 $entityModel = $giftmessageModel->getEntityModelByType($entityType)
102:                     ->load($entityId);
103:                 break;
104:         }
105: 
106:         if (!$entityModel) {
107:             return $this;
108:         }
109: 
110:         if ($entityModel->getGiftMessageId()) {
111:             $giftmessageModel->load($entityModel->getGiftMessageId());
112:         }
113: 
114:         $giftmessageModel->addData($giftmessage);
115: 
116:         if ($giftmessageModel->isMessageEmpty() && $giftmessageModel->getId()) {
117:             // remove empty giftmessage
118:             $this->_deleteOne($entityModel, $giftmessageModel);
119:             $this->_saved = false;
120:         } elseif (!$giftmessageModel->isMessageEmpty()) {
121:             $giftmessageModel->save();
122:             $entityModel->setGiftMessageId($giftmessageModel->getId());
123:             if($entityType != 'quote') {
124:                 $entityModel->save();
125:             }
126:             $this->_saved = true;
127:         }
128: 
129:         return $this;
130:     }
131: 
132:     /**
133:      * Delete a single gift message from entity
134:      *
135:      * @param Mage_GiftMessage_Model_Message|null $giftmessageModel
136:      * @param Varien_Object $entityModel
137:      * @return Mage_Adminhtml_Model_Giftmessage_Save
138:      */
139:     protected function _deleteOne($entityModel, $giftmessageModel=null)
140:     {
141:         if(is_null($giftmessageModel)) {
142:             $giftmessageModel = Mage::getModel('giftmessage/message')
143:                 ->load($entityModel->getGiftMessageId());
144:         }
145:         $giftmessageModel->delete();
146:         $entityModel->setGiftMessageId(0)
147:             ->save();
148:         return $this;
149:     }
150: 
151:     /**
152:      * Set allowed quote items for gift messages
153:      *
154:      * @param array $items
155:      * @return Mage_Adminhtml_Model_Giftmessage_Save
156:      */
157:     public function setAllowQuoteItems($items)
158:     {
159:         $this->_getSession()->setAllowQuoteItemsGiftMessage($items);
160:         return $this;
161:     }
162: 
163:     /**
164:      * Add allowed quote item for gift messages
165:      *
166:      * @param int $item
167:      * @return Mage_Adminhtml_Model_Giftmessage_Save
168:      */
169:     public function addAllowQuoteItem($item)
170:     {
171:         $items = $this->getAllowQuoteItems();
172:         if (!in_array($item, $items)) {
173:             $items[] = $item;
174:         }
175:         $this->setAllowQuoteItems($items);
176: 
177:         return $this;
178:     }
179: 
180:     /**
181:      * Retrive allowed quote items for gift messages
182:      *
183:      * @return array
184:      */
185:     public function getAllowQuoteItems()
186:     {
187:         if(!is_array($this->_getSession()->getAllowQuoteItemsGiftMessage())) {
188:             $this->setAllowQuoteItems(array());
189:         }
190: 
191:         return $this->_getSession()->getAllowQuoteItemsGiftMessage();
192:     }
193: 
194:     /**
195:      * Retrive allowed quote items products for gift messages
196:      *
197:      * @return array
198:      */
199:     public function getAllowQuoteItemsProducts()
200:     {
201:         $result = array();
202:         foreach ($this->getAllowQuoteItems() as $itemId) {
203:             $item = $this->_getQuote()->getItemById($itemId);
204:             if(!$item) {
205:                 continue;
206:             }
207:             $result[] = $item->getProduct()->getId();
208:         }
209:         return $result;
210:     }
211: 
212:     /**
213:      * Checks allowed quote item for gift messages
214:      *
215:      * @param  Varien_Object $item
216:      * @return boolean
217:      */
218:     public function getIsAllowedQuoteItem($item)
219:     {
220:         if(!in_array($item->getId(), $this->getAllowQuoteItems())) {
221:             if ($item->getGiftMessageId() && $this->isGiftMessagesAvailable($item)) {
222:                 $this->addAllowQuoteItem($item->getId());
223:                 return true;
224:             }
225:             return false;
226:         }
227: 
228:         return true;
229:     }
230: 
231:     /**
232:      * Retrieve is gift message available for item (product)
233:      *
234:      * @param Varien_Object $item
235:      * @return bool
236:      */
237:     public function isGiftMessagesAvailable($item)
238:     {
239:         return Mage::helper('giftmessage/message')->getIsMessagesAvailable(
240:             'item', $item, $item->getStore()
241:         );
242:     }
243: 
244:     /**
245:      * Imports quote items for gift messages from products data
246:      *
247:      * @param unknown_type $products
248:      * @return unknown
249:      */
250:     public function importAllowQuoteItemsFromProducts($products)
251:     {
252:         $allowedItems = $this->getAllowQuoteItems();
253:         $deleteAllowedItems = array();
254:         foreach ($products as $productId=>$data) {
255:             $product = Mage::getModel('catalog/product')
256:                 ->setStore($this->_getSession()->getStore())
257:                 ->load($productId);
258:             $item = $this->_getQuote()->getItemByProduct($product);
259: 
260:             if(!$item) {
261:                 continue;
262:             }
263: 
264:             if (in_array($item->getId(), $allowedItems)
265:                 && !isset($data['giftmessage'])) {
266:                 $deleteAllowedItems[] = $item->getId();
267:             } elseif (!in_array($item->getId(), $allowedItems)
268:                       && isset($data['giftmessage'])) {
269:                 $allowedItems[] = $item->getId();
270:             }
271: 
272:         }
273: 
274:         $allowedItems = array_diff($allowedItems, $deleteAllowedItems);
275: 
276:         $this->setAllowQuoteItems($allowedItems);
277:         return $this;
278:     }
279: 
280:     public function importAllowQuoteItemsFromItems($items)
281:     {
282:         $allowedItems = $this->getAllowQuoteItems();
283:         $deleteAllowedItems = array();
284:         foreach ($items as $itemId=>$data) {
285: 
286:             $item = $this->_getQuote()->getItemById($itemId);
287: 
288:             if(!$item) {
289:                 // Clean not exists items
290:                 $deleteAllowedItems[] = $itemId;
291:                 continue;
292:             }
293: 
294:             if (in_array($item->getId(), $allowedItems)
295:                 && !isset($data['giftmessage'])) {
296:                 $deleteAllowedItems[] = $item->getId();
297:             } elseif (!in_array($item->getId(), $allowedItems)
298:                       && isset($data['giftmessage'])) {
299:                 $allowedItems[] = $item->getId();
300:             }
301: 
302:         }
303: 
304:         $allowedItems = array_diff($allowedItems, $deleteAllowedItems);
305:         $this->setAllowQuoteItems($allowedItems);
306:         return $this;
307:     }
308: 
309:     /**
310:      * Retrive mapped type for entity
311:      *
312:      * @param string $type
313:      * @return string
314:      */
315:     protected function _getMappedType($type)
316:     {
317:         $map = array(
318:             'main'          =>  'quote',
319:             'item'          =>  'quote_item',
320:             'order'         =>  'order',
321:             'order_item'    =>  'order_item'
322:         );
323: 
324:         if (isset($map[$type])) {
325:             return $map[$type];
326:         }
327: 
328:         return null;
329:     }
330: 
331:     /**
332:      * Retrieve session object
333:      *
334:      * @return Mage_Adminhtml_Model_Session_Quote
335:      */
336:     protected function _getSession()
337:     {
338:         return Mage::getSingleton('adminhtml/session_quote');
339:     }
340: 
341:     /**
342:      * Retrieve quote object
343:      *
344:      * @return Mage_Sales_Model_Quote
345:      */
346:     protected function _getQuote()
347:     {
348:         return $this->_getSession()->getQuote();
349:     }
350: 
351: }
352: