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 order creating gift message item form
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Adminhtml
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Adminhtml_Block_Sales_Order_Create_Giftmessage_Form extends Mage_Adminhtml_Block_Widget_Form
 36: {
 37:     /**
 38:      * Entity for editing of gift message
 39:      *
 40:      * @var Mage_Eav_Model_Entity_Abstract
 41:      */
 42:     protected $_entity;
 43: 
 44:     /**
 45:      * Giftmessage object
 46:      *
 47:      * @var Mage_GiftMessage_Model_Message
 48:      */
 49:     protected $_giftMessage;
 50: 
 51:     /**
 52:      * Set entity for form
 53:      *
 54:      * @param Varien_Object $entity
 55:      * @return Mage_Adminhtml_Block_Sales_Order_Create_Giftmessage_Form
 56:      */
 57:     public function setEntity(Varien_Object $entity)
 58:     {
 59:         $this->_entity  = $entity;
 60:         return $this;
 61:     }
 62: 
 63:     /**
 64:      * Retrive entity for form
 65:      *
 66:      * @return Varien_Object
 67:      */
 68:     public function getEntity()
 69:     {
 70:         return $this->_entity;
 71:     }
 72: 
 73:     protected function _getSession()
 74:     {
 75:         return Mage::getSingleton('adminhtml/session_quote');
 76:     }
 77: 
 78:     /**
 79:      * Retrieve default value for giftmessage sender
 80:      *
 81:      * @return string
 82:      */
 83:     public function getDefaultSender()
 84:     {
 85:         if(!$this->getEntity()) {
 86:             return '';
 87:         }
 88: 
 89:         if($this->_getSession()->getCustomer()->getId()) {
 90:             return $this->_getSession()->getCustomer()->getName();
 91:         }
 92: 
 93:         $object = $this->getEntity();
 94: 
 95:         if ($this->getEntity()->getQuote()) {
 96:             $object = $this->getEntity()->getQuote();
 97:         }
 98: 
 99:         return $object->getBillingAddress()->getName();
100:     }
101: 
102:     /**
103:      * Retrieve default value for giftmessage recipient
104:      *
105:      * @return string
106:      */
107:     public function getDefaultRecipient()
108:     {
109:         if(!$this->getEntity()) {
110:             return '';
111:         }
112: 
113:         $object = $this->getEntity();
114: 
115:         if ($this->getEntity()->getOrder()) {
116:             $object = $this->getEntity()->getOrder();
117:         }
118:         else if ($this->getEntity()->getQuote()){
119:             $object = $this->getEntity()->getQuote();
120:         }
121: 
122:         if ($object->getShippingAddress()) {
123:             return $object->getShippingAddress()->getName();
124:         }
125:         else if ($object->getBillingAddress()) {
126:             return $object->getBillingAddress()->getName();
127:         }
128: 
129:         return '';
130:     }
131: 
132:     /**
133:      * Prepares form
134:      *
135:      * @return Mage_Adminhtml_Block_Sales_Order_Create_Giftmessage_Form
136:      */
137:     public function _prepareForm()
138:     {
139:         $form = new Varien_Data_Form();
140:         $fieldset = $form->addFieldset('main', array('no_container'=>true));
141: 
142:         $fieldset->addField('type','hidden',
143:             array(
144:                 'name' =>  $this->_getFieldName('type'),
145:             )
146:         );
147: 
148:         $form->setHtmlIdPrefix($this->_getFieldIdPrefix());
149: 
150:         if ($this->getEntityType() == 'item') {
151:             $this->_prepareHiddenFields($fieldset);
152:         } else {
153:             $this->_prepareVisibleFields($fieldset);
154:         }
155: 
156:         // Set default sender and recipient from billing and shipping adresses
157:         if(!$this->getMessage()->getSender()) {
158:             $this->getMessage()->setSender($this->getDefaultSender());
159:         }
160: 
161:         if(!$this->getMessage()->getRecipient()) {
162:             $this->getMessage()->setRecipient($this->getDefaultRecipient());
163:         }
164: 
165:         $this->getMessage()->setType($this->getEntityType());
166: 
167:         // Overriden default data with edited when block reloads througth Ajax
168:         $this->_applyPostData();
169: 
170:         $form->setValues($this->getMessage()->getData());
171: 
172:         $this->setForm($form);
173:         return $this;
174:     }
175: 
176:     /**
177:      * Prepare form fieldset
178:      * All fields are hidden
179:      *
180:      * @param Varien_Data_Form_Element_Fieldset $fieldset
181:      *
182:      * @return Mage_Adminhtml_Block_Sales_Order_Create_Giftmessage_Form
183:      */
184:     protected function _prepareHiddenFields(Varien_Data_Form_Element_Fieldset $fieldset)
185:     {
186:         $fieldset->addField('sender', 'hidden',
187:             array(
188:                 'name' => $this->_getFieldName('sender')
189:             )
190:         );
191:         $fieldset->addField('recipient', 'hidden',
192:             array(
193:                 'name' => $this->_getFieldName('recipient')
194:             )
195:         );
196: 
197:         $fieldset->addField('message', 'hidden',
198:             array(
199:                 'name' => $this->_getFieldName('message')
200:             )
201:         );
202:         return $this;
203:     }
204: 
205:     /**
206:      * Prepare form fieldset
207:      * All fields are visible
208:      *
209:      * @param Varien_Data_Form_Element_Fieldset $fieldset
210:      *
211:      * @return Mage_Adminhtml_Block_Sales_Order_Create_Giftmessage_Form
212:      */
213:     protected function _prepareVisibleFields(Varien_Data_Form_Element_Fieldset $fieldset)
214:     {
215:         $fieldset->addField('sender', 'text',
216:             array(
217:                 'name'     => $this->_getFieldName('sender'),
218:                 'label'    => Mage::helper('sales')->__('From'),
219:                 'required' => $this->getMessage()->getMessage() ? true : false
220:             )
221:         );
222:         $fieldset->addField('recipient', 'text',
223:             array(
224:                 'name'     => $this->_getFieldName('recipient'),
225:                 'label'    => Mage::helper('sales')->__('To'),
226:                 'required' => $this->getMessage()->getMessage() ? true : false
227:             )
228:         );
229: 
230:         $fieldset->addField('message', 'textarea',
231:             array(
232:                 'name'      => $this->_getFieldName('message'),
233:                 'label'     => Mage::helper('sales')->__('Message'),
234:                 'rows'      => '5',
235:                 'cols'      => '20',
236:             )
237:         );
238:         return $this;
239:     }
240: 
241:     /**
242:      * Initialize gift message for entity
243:      *
244:      * @return Mage_Adminhtml_Block_Sales_Order_Create_Giftmessage_Form
245:      */
246:     protected function _initMessage()
247:     {
248:         $this->_giftMessage = $this->helper('giftmessage/message')->getGiftMessage(
249:                                    $this->getEntity()->getGiftMessageId()
250:                               );
251:         return $this;
252:     }
253: 
254:     /**
255:      * Retrive gift message for entity
256:      *
257:      * @return Mage_GiftMessage_Model_Message
258:      */
259:     public function getMessage()
260:     {
261:         if(is_null($this->_giftMessage)) {
262:             $this->_initMessage();
263:         }
264: 
265:         return $this->_giftMessage;
266:     }
267: 
268:     /**
269:      * Retrive real name for field
270:      *
271:      * @param string $name
272:      * @return string
273:      */
274:     protected  function _getFieldName($name)
275:     {
276:         return 'giftmessage[' . $this->getEntity()->getId() . '][' . $name . ']';
277:     }
278: 
279:     /**
280:      * Retrive real html id for field
281:      *
282:      * @param string $name
283:      * @return string
284:      */
285:     protected  function _getFieldId($id)
286:     {
287:         return $this->_getFieldIdPrefix() . $id;
288:     }
289: 
290:     /**
291:      * Retrive field html id prefix
292:      *
293:      * @return unknown
294:      */
295:     protected  function _getFieldIdPrefix()
296:     {
297:         return 'giftmessage_' . $this->getEntity()->getId() . '_';
298:     }
299: 
300:     /**
301:      * Aplies posted data to gift message
302:      *
303:      * @return Mage_Adminhtml_Block_Sales_Order_Create_Giftmessage_Form
304:      */
305:     protected function _applyPostData()
306:     {
307:         if(is_array($giftmessages = $this->getRequest()->getParam('giftmessage'))
308:            && isset($giftmessages[$this->getEntity()->getId()])) {
309:             $this->getMessage()->addData($giftmessages[$this->getEntity()->getId()]);
310:         }
311: 
312:         return $this;
313:     }
314: 
315: }
316: