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_XmlConnect
 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:  * Customer order details xml renderer
 29:  *
 30:  * @category    Mage
 31:  * @package     Mage_XmlConnect
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_XmlConnect_Block_Customer_Order_Details extends Mage_Payment_Block_Info
 35: {
 36:     /**
 37:      * Pre-defined array of methods that we are going to render
 38:      *
 39:      * Core renderer list:
 40:      * - 'ccsave' => Mage_XmlConnect_Block_Checkout_Payment_Method_Info_Ccsave
 41:      * - 'checkmo' => Mage_XmlConnect_Block_Checkout_Payment_Method_Info_Checkmo
 42:      * - 'purchaseorder' => Mage_XmlConnect_Block_Checkout_Payment_Method_Info_Purchaseorder
 43:      * - 'authorizenet' => Mage_XmlConnect_Block_Checkout_Payment_Method_Info_Authorizenet
 44:      * - 'pbridge_authorizenet' => Mage_Paygate_Block_Authorizenet_Info_Cc
 45:      * - 'pbridge_verisign' => Mage_Payment_Block_Info_Cc
 46:      * - 'paypal_express' => Mage_Paypal_Block_Payment_Info
 47:      * - 'paypal_mecl' => Mage_Paypal_Block_Payment_Info
 48:      * - 'pbridge_paypal_direct' => Mage_Paypal_Block_Payment_Info
 49:      * - 'pbridge_paypaluk_direct' => Mage_Paypal_Block_Payment_Info
 50:      * - 'free' => Mage_Payment_Block_Info
 51:      */
 52:     protected $_methodArray = array(
 53:         'ccsave', 'checkmo', 'purchaseorder', 'authorizenet', 'pbridge_authorizenet', 'pbridge_verisign',
 54:         'paypal_express', 'paypal_mecl', 'pbridge_paypal_direct', 'pbridge_paypaluk_direct', 'free'
 55:     );
 56: 
 57:     /**
 58:      * Render customer orders list xml
 59:      *
 60:      * @return string
 61:      */
 62:     protected function _toHtml()
 63:     {
 64:         /** @var $orderXmlObj Mage_XmlConnect_Model_Simplexml_Element */
 65:         $orderXmlObj = Mage::getModel('xmlconnect/simplexml_element', '<order_details></order_details>');
 66: 
 67:         $order = $this->_getOrder();
 68: 
 69:         $orderDate = $this->formatDate($order->getCreatedAtStoreDate(), 'long');
 70:         $orderXmlObj->addCustomChild('order', null, array(
 71:              'label' => $this->__('Order #%s - %s', $order->getRealOrderId(), $order->getStatusLabel()),
 72:              'order_date' => $this->__('Order Date: %s', $orderDate)
 73:         ));
 74:         if (!$order->getIsVirtual()) {
 75:             $shipping = Mage::helper('xmlconnect')->trimLineBreaks($order->getShippingAddress()->format('text'));
 76:             $billing  = Mage::helper('xmlconnect')->trimLineBreaks($order->getBillingAddress()->format('text'));
 77: 
 78:             $orderXmlObj->addCustomChild('shipping_address', $shipping);
 79:             $orderXmlObj->addCustomChild('billing_address', $billing);
 80: 
 81:             if ($order->getShippingDescription()) {
 82:                 $shippingMethodDescription = $order->getShippingDescription();
 83:             } else {
 84:                 $shippingMethodDescription = Mage::helper('sales')->__('No shipping information available');
 85:             }
 86:             $orderXmlObj->addCustomChild('shipping_method', $shippingMethodDescription);
 87:         }
 88: 
 89:         $this->_addPaymentMethodInfoToXmlObj($orderXmlObj);
 90: 
 91:         $itemsBlock = $this->getLayout()->getBlock('xmlconnect.customer.order.items');
 92:         if ($itemsBlock) {
 93:             /** @var $itemsBlock Mage_XmlConnect_Block_Customer_Order_Items */
 94:             $itemsBlock->setItems($order->getItemsCollection());
 95:             $itemsBlock->addItemsToXmlObject($orderXmlObj);
 96:             $totalsBlock = $this->getLayout()->getBlock('xmlconnect.customer.order.totals');
 97:             if ($totalsBlock) {
 98:                 $totalsBlock->setOrder($order);
 99:                 $totalsBlock->addTotalsToXmlObject($orderXmlObj);
100:             }
101:         } else {
102:             $orderXmlObj->addChild('ordered_items');
103:         }
104: 
105:         return $orderXmlObj->asNiceXml();
106:     }
107: 
108:     /**
109:      * Add payment method info to order xml object
110:      *
111:      * @param Mage_XmlConnect_Model_Simplexml_Element $orderXmlObj
112:      * @return Mage_XmlConnect_Model_Simplexml_Element
113:      */
114:     protected function _addPaymentMethodInfoToXmlObj(Mage_XmlConnect_Model_Simplexml_Element $orderXmlObj)
115:     {
116:         $order = $this->_getOrder();
117: 
118:         // TODO: it's need to create an info blocks for other payment methods (including Enterprise)
119:         $method = $this->helper('payment')->getInfoBlock($order->getPayment())->getMethod();
120:         $methodCode = $method->getCode();
121: 
122:         $paymentNode = $orderXmlObj->addChild('payment_method');
123: 
124:         if (in_array($methodCode, $this->_methodArray, true)) {
125:             $currentBlockRenderer = 'xmlconnect/checkout_payment_method_info_' . $methodCode;
126:             $currentBlockName = 'xmlconnect.checkout.payment.method.info.' . $methodCode;
127:             $this->getLayout()->addBlock($currentBlockRenderer, $currentBlockName);
128:             $this->setChild($methodCode, $currentBlockName);
129:             $renderer = $this->getChild($methodCode)->setInfo($order->getPayment());
130:             $renderer->addPaymentInfoToXmlObj($paymentNode);
131:         } else {
132:             $paymentNode->addAttribute('type', $methodCode);
133:             $paymentNode->addAttribute('title', $orderXmlObj->xmlAttribute($method->getTitle()));
134: 
135:             $this->setInfo($order->getPayment());
136: 
137:             $specificInfo = array_merge(
138:                 (array)$order->getPayment()->getAdditionalInformation(),
139:                 (array)$this->getSpecificInformation()
140:             );
141:             if (!empty($specificInfo)) {
142:                 foreach ($specificInfo as $label => $value) {
143:                     if ($value) {
144:                         $paymentNode->addCustomChild('item', implode($this->getValueAsArray($value, true), '\n'),
145:                             array('label' => $label)
146:                         );
147:                     }
148:                 }
149:             }
150:         }
151: 
152:         return $orderXmlObj;
153:     }
154: 
155:     /**
156:      * Get order model
157:      *
158:      * @through Mage_Core_Exception
159:      * @return Mage_Sales_Model_Order
160:      */
161:     protected function _getOrder()
162:     {
163:         $order = Mage::registry('current_order');
164:         if (!($order instanceof Mage_Sales_Model_Order)) {
165:             Mage::throwException($this->__('Order is not available.'));
166:         }
167:         return $order;
168:     }
169: 
170:     /**
171:      * Format address string
172:      *
173:      * @deprecated after 1.6.0.0
174:      * @param string $address
175:      * @return string
176:      */
177:     protected function _formatAddress($address)
178:     {
179:         return preg_replace(
180:             array('@\r@', '@\n+@'),
181:             array('', '\n'),
182:             $address
183:         );
184:     }
185: }
186: