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:  * Order history tab
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Adminhtml
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Adminhtml_Block_Sales_Order_View_Tab_History
 35:     extends Mage_Adminhtml_Block_Template
 36:     implements Mage_Adminhtml_Block_Widget_Tab_Interface
 37: {
 38:     protected function _construct()
 39:     {
 40:         parent::_construct();
 41:         $this->setTemplate('sales/order/view/tab/history.phtml');
 42:     }
 43: 
 44:     /**
 45:      * Retrieve order model instance
 46:      *
 47:      * @return Mage_Sales_Model_Order
 48:      */
 49:     public function getOrder()
 50:     {
 51:         return Mage::registry('current_order');
 52:     }
 53: 
 54:     /**
 55:      * Compose and get order full history.
 56:      * Consists of the status history comments as well as of invoices, shipments and creditmemos creations
 57:      *
 58:      * @return array
 59:      */
 60:     public function getFullHistory()
 61:     {
 62:         $order = $this->getOrder();
 63: 
 64:         $history = array();
 65:         foreach ($order->getAllStatusHistory() as $orderComment){
 66:             $history[] = $this->_prepareHistoryItem(
 67:                 $orderComment->getStatusLabel(),
 68:                 $orderComment->getIsCustomerNotified(),
 69:                 $orderComment->getCreatedAtDate(),
 70:                 $orderComment->getComment()
 71:             );
 72:         }
 73: 
 74:         foreach ($order->getCreditmemosCollection() as $_memo){
 75:             $history[] = $this->_prepareHistoryItem(
 76:                 $this->__('Credit memo #%s created', $_memo->getIncrementId()),
 77:                 $_memo->getEmailSent(),
 78:                 $_memo->getCreatedAtDate()
 79:             );
 80: 
 81:             foreach ($_memo->getCommentsCollection() as $_comment){
 82:                 $history[] = $this->_prepareHistoryItem(
 83:                     $this->__('Credit memo #%s comment added', $_memo->getIncrementId()),
 84:                     $_comment->getIsCustomerNotified(),
 85:                     $_comment->getCreatedAtDate(),
 86:                     $_comment->getComment()
 87:                 );
 88:             }
 89:         }
 90: 
 91:         foreach ($order->getShipmentsCollection() as $_shipment){
 92:             $history[] = $this->_prepareHistoryItem(
 93:                 $this->__('Shipment #%s created', $_shipment->getIncrementId()),
 94:                 $_shipment->getEmailSent(),
 95:                 $_shipment->getCreatedAtDate()
 96:             );
 97: 
 98:             foreach ($_shipment->getCommentsCollection() as $_comment){
 99:                 $history[] = $this->_prepareHistoryItem(
100:                     $this->__('Shipment #%s comment added', $_shipment->getIncrementId()),
101:                     $_comment->getIsCustomerNotified(),
102:                     $_comment->getCreatedAtDate(),
103:                     $_comment->getComment()
104:                 );
105:             }
106:         }
107: 
108:         foreach ($order->getInvoiceCollection() as $_invoice){
109:             $history[] = $this->_prepareHistoryItem(
110:                 $this->__('Invoice #%s created', $_invoice->getIncrementId()),
111:                 $_invoice->getEmailSent(),
112:                 $_invoice->getCreatedAtDate()
113:             );
114: 
115:             foreach ($_invoice->getCommentsCollection() as $_comment){
116:                 $history[] = $this->_prepareHistoryItem(
117:                     $this->__('Invoice #%s comment added', $_invoice->getIncrementId()),
118:                     $_comment->getIsCustomerNotified(),
119:                     $_comment->getCreatedAtDate(),
120:                     $_comment->getComment()
121:                 );
122:             }
123:         }
124: 
125:         foreach ($order->getTracksCollection() as $_track){
126:             $history[] = $this->_prepareHistoryItem(
127:                 $this->__('Tracking number %s for %s assigned', $_track->getNumber(), $_track->getTitle()),
128:                 false,
129:                 $_track->getCreatedAtDate()
130:             );
131:         }
132: 
133:         usort($history, array(__CLASS__, "_sortHistoryByTimestamp"));
134:         return $history;
135:     }
136: 
137:     /**
138:      * Status history date/datetime getter
139:      *
140:      * @param array $item
141:      * @param string $dateType
142:      * @param string $format
143:      * @return string
144:      */
145:     public function getItemCreatedAt(array $item, $dateType = 'date', $format = 'medium')
146:     {
147:         if (!isset($item['created_at'])) {
148:             return '';
149:         }
150:         if ('date' === $dateType) {
151:             return $this->helper('core')->formatDate($item['created_at'], $format);
152:         }
153:         return $this->helper('core')->formatTime($item['created_at'], $format);
154:     }
155: 
156:     /**
157:      * Status history item title getter
158:      *
159:      * @param array $item
160:      * @return string
161:      */
162:     public function getItemTitle(array $item)
163:     {
164:         return (isset($item['title']) ? $this->escapeHtml($item['title']) : '');
165:     }
166: 
167:     /**
168:      * Check whether status history comment is with customer notification
169:      *
170:      * @param array $item
171:      * @param boolean $isSimpleCheck
172:      * @return bool
173:      */
174:     public function isItemNotified(array $item, $isSimpleCheck = true)
175:     {
176:         if ($isSimpleCheck) {
177:             return !empty($item['notified']);
178:         }
179:         return isset($item['notified']) && false !== $item['notified'];
180:     }
181: 
182:     /**
183:      * Status history item comment getter
184:      *
185:      * @param array $item
186:      * @return string
187:      */
188:     public function getItemComment(array $item)
189:     {
190:         $allowedTags = array('b','br','strong','i','u');
191:         return (isset($item['comment']) ? $this->escapeHtml($item['comment'], $allowedTags) : '');
192:     }
193: 
194:     /**
195:      * Map history items as array
196:      *
197:      * @param string $label
198:      * @param bool $notified
199:      * @param Zend_Date $created
200:      * @param string $comment
201:      * @return array
202:      */
203:     protected function _prepareHistoryItem($label, $notified, $created, $comment = '')
204:     {
205:         return array(
206:             'title'      => $label,
207:             'notified'   => $notified,
208:             'comment'    => $comment,
209:             'created_at' => $created
210:         );
211:     }
212: 
213:     /**
214:      * Get Tab Label
215:      *
216:      * @return string
217:      */
218:     public function getTabLabel()
219:     {
220:         return Mage::helper('sales')->__('Comments History');
221:     }
222: 
223:     /**
224:      * Get Tab Title
225:      *
226:      * @return string
227:      */
228:     public function getTabTitle()
229:     {
230:         return Mage::helper('sales')->__('Order History');
231:     }
232: 
233:     /**
234:      * Get Tab Class
235:      *
236:      * @return string
237:      */
238:     public function getTabClass()
239:     {
240:         return 'ajax only';
241:     }
242: 
243:     /**
244:      * Get Class
245:      *
246:      * @return string
247:      */
248:     public function getClass()
249:     {
250:         return $this->getTabClass();
251:     }
252: 
253:     /**
254:      * Get Tab Url
255:      *
256:      * @return string
257:      */
258:     public function getTabUrl()
259:     {
260:         return $this->getUrl('*/*/commentsHistory', array('_current' => true));
261:     }
262: 
263:     /**
264:      * Can Show Tab
265:      *
266:      * @return boolean
267:      */
268:     public function canShowTab()
269:     {
270:         return true;
271:     }
272: 
273:     /**
274:      * Is Hidden
275:      *
276:      * @return boolean
277:      */
278:     public function isHidden()
279:     {
280:         return false;
281:     }
282: 
283:     /**
284:      * Customer Notification Applicable check method
285:      *
286:      * @param array $historyItem
287:      * @return boolean
288:      */
289:     public function isCustomerNotificationNotApplicable($historyItem)
290:     {
291:         return $historyItem['notified'] == Mage_Sales_Model_Order_Status_History::CUSTOMER_NOTIFICATION_NOT_APPLICABLE;
292:     }
293: 
294:     /**
295:      * Comparison For Sorting History By Timestamp
296:      *
297:      * @param mixed $a
298:      * @param mixed $b
299:      * @return int
300:      */
301:     private static function _sortHistoryByTimestamp($a, $b)
302:     {
303:         $createdAtA = $a['created_at'];
304:         $createdAtB = $b['created_at'];
305: 
306:         /** @var $createdAta Zend_Date */
307:         if ($createdAtA->getTimestamp() == $createdAtB->getTimestamp()) {
308:             return 0;
309:         }
310:         return ($createdAtA->getTimestamp() < $createdAtB->getTimestamp()) ? -1 : 1;
311:     }
312: }
313: