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:  * Abstract items renderer
 30:  *
 31:  * @category    Mage
 32:  * @package     Mage_Adminhtml
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class  Mage_Adminhtml_Block_Sales_Items_Abstract extends Mage_Adminhtml_Block_Template
 36: {
 37:     /**
 38:      * Renderers with render type key
 39:      * block    => the block name
 40:      * template => the template file
 41:      * renderer => the block object
 42:      *
 43:      * @var array
 44:      */
 45:     protected $_itemRenders = array();
 46: 
 47:     /**
 48:      * Renderers for other column with column name key
 49:      * block    => the block name
 50:      * template => the template file
 51:      * renderer => the block object
 52:      *
 53:      * @var array
 54:      */
 55:     protected $_columnRenders = array();
 56: 
 57:     /**
 58:      * Flag - if it is set method canEditQty will return value of it
 59:      *
 60:      * @var boolean | null
 61:      */
 62:     protected $_canEditQty = null;
 63: 
 64:     /**
 65:      * Init block
 66:      *
 67:      */
 68:     protected function _construct()
 69:     {
 70:         $this->addColumnRender('qty', 'adminhtml/sales_items_column_qty', 'sales/items/column/qty.phtml');
 71:         $this->addColumnRender('name', 'adminhtml/sales_items_column_name', 'sales/items/column/name.phtml');
 72:         parent::_construct();
 73:     }
 74: 
 75:     /**
 76:      * Add item renderer
 77:      *
 78:      * @param string $type
 79:      * @param string $block
 80:      * @param string $template
 81:      * @return Mage_Adminhtml_Block_Sales_Items_Abstract
 82:      */
 83:     public function addItemRender($type, $block, $template)
 84:     {
 85:         $this->_itemRenders[$type] = array(
 86:             'block'     => $block,
 87:             'template'  => $template,
 88:             'renderer'  => null
 89:         );
 90:         return $this;
 91:     }
 92: 
 93:     /**
 94:      * Add column renderer
 95:      *
 96:      * @param string $column
 97:      * @param string $block
 98:      * @param string $template
 99:      * @return Mage_Adminhtml_Block_Sales_Items_Abstract
100:      */
101:     public function addColumnRender($column, $block, $template, $type=null)
102:     {
103:         if (!is_null($type)) {
104:             $column .= '_' . $type;
105:         }
106:         $this->_columnRenders[$column] = array(
107:             'block'     => $block,
108:             'template'  => $template,
109:             'renderer'  => null
110:         );
111:         return $this;
112:     }
113: 
114:     /**
115:      * Retrieve item renderer block
116:      *
117:      * @param string $type
118:      * @return Mage_Core_Block_Abstract
119:      */
120:     public function getItemRenderer($type)
121:     {
122:         if (!isset($this->_itemRenders[$type])) {
123:             $type = 'default';
124:         }
125:         if (is_null($this->_itemRenders[$type]['renderer'])) {
126:             $this->_itemRenders[$type]['renderer'] = $this->getLayout()
127:                 ->createBlock($this->_itemRenders[$type]['block'])
128:                 ->setTemplate($this->_itemRenders[$type]['template']);
129:             foreach ($this->_columnRenders as $columnType=>$renderer) {
130:                 $this->_itemRenders[$type]['renderer']->addColumnRender($columnType, $renderer['block'], $renderer['template']);
131:             }
132:         }
133:         return $this->_itemRenders[$type]['renderer'];
134:     }
135: 
136:     /**
137:      * Retrieve column renderer block
138:      *
139:      * @param string $column
140:      * @param string $compositePart
141:      * @return Mage_Core_Block_Abstract
142:      */
143:     public function getColumnRenderer($column, $compositePart='')
144:     {
145:         if (isset($this->_columnRenders[$column . '_' . $compositePart])) {
146:             $column .= '_' . $compositePart;
147:         }
148:         if (!isset($this->_columnRenders[$column])) {
149:             return false;
150:         }
151:         if (is_null($this->_columnRenders[$column]['renderer'])) {
152:             $this->_columnRenders[$column]['renderer'] = $this->getLayout()
153:                 ->createBlock($this->_columnRenders[$column]['block'])
154:                 ->setTemplate($this->_columnRenders[$column]['template'])
155:                 ->setRenderedBlock($this);
156:         }
157:         return $this->_columnRenders[$column]['renderer'];
158:     }
159: 
160:     /**
161:      * Retrieve rendered item html content
162:      *
163:      * @param Varien_Object $item
164:      * @return string
165:      */
166:     public function getItemHtml(Varien_Object $item)
167:     {
168:         if ($item->getOrderItem()) {
169:             $type = $item->getOrderItem()->getProductType();
170:         } else {
171:             $type = $item->getProductType();
172:         }
173: 
174:         return $this->getItemRenderer($type)
175:             ->setItem($item)
176:             ->setCanEditQty($this->canEditQty())
177:             ->toHtml();
178:     }
179: 
180:     /**
181:      * Retrieve rendered item extra info html content
182:      *
183:      * @param Varien_Object $item
184:      * @return string
185:      */
186:     public function getItemExtraInfoHtml(Varien_Object $item)
187:     {
188:         $extraInfoBlock = $this->getChild('order_item_extra_info');
189:         if ($extraInfoBlock) {
190:             return $extraInfoBlock
191:                 ->setItem($item)
192:                 ->toHtml();
193:         }
194:         return '';
195:     }
196: 
197:     /**
198:      * Retrieve rendered column html content
199:      *
200:      * @param Varien_Object $item
201:      * @param string $column the column key
202:      * @param string $field the custom item field
203:      * @return string
204:      */
205:     public function getColumnHtml(Varien_Object $item, $column, $field = null)
206:     {
207:         if ($item->getOrderItem()) {
208:             $block = $this->getColumnRenderer($column, $item->getOrderItem()->getProductType());
209:         } else {
210:             $block = $this->getColumnRenderer($column, $item->getProductType());
211:         }
212: 
213:         if ($block) {
214:             $block->setItem($item);
215:             if (!is_null($field)) {
216:                 $block->setField($field);
217:             }
218:             return $block->toHtml();
219:         }
220:         return '&nbsp;';
221:     }
222: 
223:     public function getCreditmemo()
224:     {
225:         return Mage::registry('current_creditmemo');
226:     }
227: 
228:     /**
229:      * ######################### SALES ##################################
230:      */
231: 
232:     /**
233:      * Retrieve available order
234:      *
235:      * @return Mage_Sales_Model_Order
236:      */
237:     public function getOrder()
238:     {
239:         if ($this->hasOrder()) {
240:             return $this->getData('order');
241:         }
242:         if (Mage::registry('current_order')) {
243:             return Mage::registry('current_order');
244:         }
245:         if (Mage::registry('order')) {
246:             return Mage::registry('order');
247:         }
248:         if ($this->getInvoice())
249:         {
250:             return $this->getInvoice()->getOrder();
251:         }
252:         if ($this->getCreditmemo())
253:         {
254:             return $this->getCreditmemo()->getOrder();
255:         }
256:         if ($this->getItem()->getOrder())
257:         {
258:             return $this->getItem()->getOrder();
259:         }
260: 
261:         Mage::throwException(Mage::helper('sales')->__('Cannot get order instance'));
262:     }
263: 
264:     /**
265:      * Retrieve price data object
266:      *
267:      * @return Mage_Sales_Model_Order
268:      */
269:     public function getPriceDataObject()
270:     {
271:         $obj = $this->getData('price_data_object');
272:         if (is_null($obj)) {
273:             return $this->getOrder();
274:         }
275:         return $obj;
276:     }
277: 
278:     /**
279:      * Retrieve price attribute html content
280:      *
281:      * @param string $code
282:      * @param bool $strong
283:      * @param string $separator
284:      * @return string
285:      */
286:     public function displayPriceAttribute($code, $strong = false, $separator = '<br />')
287:     {
288:         if ($code == 'tax_amount' && $this->getOrder()->getRowTaxDisplayPrecision()) {
289:             return $this->displayRoundedPrices(
290:                 $this->getPriceDataObject()->getData('base_'.$code),
291:                 $this->getPriceDataObject()->getData($code),
292:                 $this->getOrder()->getRowTaxDisplayPrecision(),
293:                 $strong,
294:                 $separator
295:             );
296:         } else {
297:             return $this->displayPrices(
298:                 $this->getPriceDataObject()->getData('base_'.$code),
299:                 $this->getPriceDataObject()->getData($code),
300:                 $strong,
301:                 $separator
302:             );
303:         }
304:     }
305: 
306:     /**
307:      * Retrieve price formated html content
308:      *
309:      * @param float $basePrice
310:      * @param float $price
311:      * @param bool $strong
312:      * @param string $separator
313:      * @return string
314:      */
315:     public function displayPrices($basePrice, $price, $strong = false, $separator = '<br />')
316:     {
317:         return $this->displayRoundedPrices($basePrice, $price, 2, $strong, $separator);
318:     }
319: 
320:     /**
321:      * Display base and regular prices with specified rounding precision
322:      *
323:      * @param   float $basePrice
324:      * @param   float $price
325:      * @param   int $precision
326:      * @param   bool $strong
327:      * @param   string $separator
328:      * @return  string
329:      */
330:     public function displayRoundedPrices($basePrice, $price, $precision=2, $strong = false, $separator = '<br />')
331:     {
332:         if ($this->getOrder()->isCurrencyDifferent()) {
333:             $res = '';
334:             $res.= $this->getOrder()->formatBasePricePrecision($basePrice, $precision);
335:             $res.= $separator;
336:             $res.= $this->getOrder()->formatPricePrecision($price, $precision, true);
337:         }
338:         else {
339:             $res = $this->getOrder()->formatPricePrecision($price, $precision);
340:             if ($strong) {
341:                 $res = '<strong>'.$res.'</strong>';
342:             }
343:         }
344:         return $res;
345:     }
346: 
347:     /**
348:      * Retrieve include tax html formated content
349:      *
350:      * @param Varien_Object $item
351:      * @return string
352:      */
353:     public function displayPriceInclTax(Varien_Object $item)
354:     {
355:         $qty = ($item->getQtyOrdered() ? $item->getQtyOrdered() : ($item->getQty() ? $item->getQty() : 1));
356:         $baseTax = ($item->getTaxBeforeDiscount() ? $item->getTaxBeforeDiscount() : ($item->getTaxAmount() ? $item->getTaxAmount() : 0));
357:         $tax = ($item->getBaseTaxBeforeDiscount() ? $item->getBaseTaxBeforeDiscount() : ($item->getBaseTaxAmount() ? $item->getBaseTaxAmount() : 0));
358: 
359:         $basePriceTax = 0;
360:         $priceTax = 0;
361: 
362:         if (floatval($qty)) {
363:             $basePriceTax = $item->getBasePrice()+$baseTax/$qty;
364:             $priceTax = $item->getPrice()+$tax/$qty;
365:         }
366: 
367:         return $this->displayPrices(
368:             $this->getOrder()->getStore()->roundPrice($basePriceTax),
369:             $this->getOrder()->getStore()->roundPrice($priceTax)
370:         );
371:     }
372: 
373:     /**
374:      * Retrieve subtotal price include tax html formated content
375:      *
376:      * @param Varien_Object $item
377:      * @return string
378:      */
379:     public function displaySubtotalInclTax($item)
380:     {
381:         $baseTax = ($item->getTaxBeforeDiscount() ? $item->getTaxBeforeDiscount() : ($item->getTaxAmount() ? $item->getTaxAmount() : 0));
382:         $tax = ($item->getBaseTaxBeforeDiscount() ? $item->getBaseTaxBeforeDiscount() : ($item->getBaseTaxAmount() ? $item->getBaseTaxAmount() : 0));
383: 
384:         return $this->displayPrices(
385:             $item->getBaseRowTotal()+$baseTax,
386:             $item->getRowTotal()+$tax
387:         );
388:     }
389: 
390:     /**
391:      * Retrieve tax calculation html content
392:      *
393:      * @param Varien_Object $item
394:      * @return string
395:      */
396:     public function displayTaxCalculation(Varien_Object $item)
397:     {
398:         if ($item->getTaxPercent() && $item->getTaxString() == '') {
399:             $percents = array($item->getTaxPercent());
400:         } else if ($item->getTaxString()) {
401:             $percents = explode(Mage_Tax_Model_Config::CALCULATION_STRING_SEPARATOR, $item->getTaxString());
402:         } else {
403:             return '0%';
404:         }
405: 
406:         foreach ($percents as &$percent) {
407:             $percent = sprintf('%.2f%%', $percent);
408:         }
409:         return implode(' + ', $percents);
410:     }
411: 
412:     /**
413:      * Retrieve tax with persent html content
414:      *
415:      * @param Varien_Object $item
416:      * @return string
417:      */
418:     public function displayTaxPercent(Varien_Object $item)
419:     {
420:         if ($item->getTaxPercent()) {
421:             return sprintf('%s%%', $item->getTaxPercent() + 0);
422:         } else {
423:             return '0%';
424:         }
425:     }
426: 
427:     /**
428:      *  INVOICES
429:      */
430: 
431:     /**
432:      * Check shipment availability for current invoice
433:      *
434:      * @return bool
435:      */
436:     public function canCreateShipment()
437:     {
438:         foreach ($this->getInvoice()->getAllItems() as $item) {
439:             if ($item->getOrderItem()->getQtyToShip()) {
440:                 return true;
441:             }
442:         }
443:         return false;
444:     }
445: 
446:     /**
447:      * Setter for flag _canEditQty
448:      *
449:      * @return Mage_Adminhtml_Block_Sales_Items_Abstract
450:      * @see self::_canEditQty
451:      * @see self::canEditQty
452:      */
453:     public function setCanEditQty($value) {
454:         $this->_canEditQty = $value;
455:         return $this;
456:     }
457: 
458:     /**
459:      * Check availability to edit quantity of item
460:      *
461:      * @return boolean
462:      */
463:     public function canEditQty()
464:     {
465:         /**
466:          * If parent block has set
467:          */
468:         if (!is_null($this->_canEditQty)) {
469:             return $this->_canEditQty;
470:         }
471: 
472:         /**
473:          * Disable editing of quantity of item if creating of shipment forced
474:          * and ship partially disabled for order
475:          */
476:         if ($this->getOrder()->getForcedDoShipmentWithInvoice()
477:             && ($this->canShipPartially($this->getOrder()) || $this->canShipPartiallyItem($this->getOrder()))
478:         ) {
479:             return false;
480:         }
481:         if ($this->getOrder()->getPayment()->canCapture()) {
482:             return $this->getOrder()->getPayment()->canCapturePartial();
483:         }
484:         return true;
485:     }
486: 
487:     public function canCapture()
488:     {
489:         if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/capture')) {
490:             return $this->getInvoice()->canCapture();
491:         }
492:         return false;
493:     }
494: 
495:     public function formatPrice($price)
496:     {
497:         return $this->getOrder()->formatPrice($price);
498:     }
499: 
500:     /**
501:      * Retrieve source
502:      *
503:      * @return Mage_Sales_Model_Order_Invoice
504:      */
505:     public function getSource()
506:     {
507:         return $this->getInvoice();
508:     }
509: 
510:     /**
511:      * Retrieve invoice model instance
512:      *
513:      * @return Mage_Sales_Model_Invoice
514:      */
515:     public function getInvoice()
516:     {
517:         return Mage::registry('current_invoice');
518:     }
519: 
520:     /**
521:      * CREDITMEMO
522:      */
523: 
524:     public function canReturnToStock() {
525:         $canReturnToStock = Mage::getStoreConfig(Mage_CatalogInventory_Model_Stock_Item::XML_PATH_CAN_SUBTRACT);
526:         if (Mage::getStoreConfig(Mage_CatalogInventory_Model_Stock_Item::XML_PATH_CAN_SUBTRACT)) {
527:             return true;
528:         } else {
529:             return false;
530:         }
531:     }
532: 
533:     /**
534:      * Whether to show 'Return to stock' checkbox for item
535:      * @param Mage_Sales_Model_Order_Creditmemo_Item $item
536:      * @return bool
537:      */
538:     public function canReturnItemToStock($item=null) {
539:         $canReturnToStock = Mage::getStoreConfig(Mage_CatalogInventory_Model_Stock_Item::XML_PATH_CAN_SUBTRACT);
540:         if (!is_null($item)) {
541:             if (!$item->hasCanReturnToStock()) {
542:                 $product = Mage::getModel('catalog/product')->load($item->getOrderItem()->getProductId());
543:                 if ( $product->getId() && $product->getStockItem()->getManageStock() ) {
544:                     $item->setCanReturnToStock(true);
545:                 }
546:                 else {
547:                     $item->setCanReturnToStock(false);
548:                 }
549:             }
550:             $canReturnToStock = $item->getCanReturnToStock();
551:         }
552:         return $canReturnToStock;
553:     }
554:     /**
555:      * Whether to show 'Return to stock' column for item parent
556:      * @param Mage_Sales_Model_Order_Creditmemo_Item $item
557:      * @return bool
558:      */
559:     public function canParentReturnToStock($item = null)
560:     {
561:         $canReturnToStock = Mage::getStoreConfig(Mage_CatalogInventory_Model_Stock_Item::XML_PATH_CAN_SUBTRACT);
562:         if (!is_null($item)) {
563:             if ( $item->getCreditmemo()->getOrder()->hasCanReturnToStock() ) {
564:                 $canReturnToStock = $item->getCreditmemo()->getOrder()->getCanReturnToStock();
565:             }
566:         } elseif ( $this->getOrder()->hasCanReturnToStock() ) {
567:             $canReturnToStock = $this->getOrder()->getCanReturnToStock();
568:         }
569:         return $canReturnToStock;
570:     }
571: 
572:     /**
573:      * Return true if can ship partially
574:      *
575:      * @param Mage_Sales_Model_Order|null $order
576:      * @return boolean
577:      */
578:     public function canShipPartially($order = null)
579:     {
580:         if (is_null($order) || !$order instanceof Mage_Sales_Model_Order) {
581:             $order = Mage::registry('current_shipment')->getOrder();
582:         }
583:         $value = $order->getCanShipPartially();
584:         if (!is_null($value) && !$value) {
585:             return false;
586:         }
587:         return true;
588:     }
589: 
590:     /**
591:      * Return true if can ship items partially
592:      *
593:      * @param Mage_Sales_Model_Order|null $order
594:      * @return boolean
595:      */
596:     public function canShipPartiallyItem($order = null)
597:     {
598:         if (is_null($order) || !$order instanceof Mage_Sales_Model_Order) {
599:             $order = Mage::registry('current_shipment')->getOrder();
600:         }
601:         $value = $order->getCanShipPartiallyItem();
602:         if (!is_null($value) && !$value) {
603:             return false;
604:         }
605:         return true;
606:     }
607: 
608:     public function isShipmentRegular()
609:     {
610:         if (!$this->canShipPartiallyItem() || !$this->canShipPartially()) {
611:             return false;
612:         }
613:         return true;
614:     }
615: 
616: }
617: