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_Weee
 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: class Mage_Weee_Model_Total_Quote_Weee extends Mage_Tax_Model_Sales_Total_Quote_Tax
 29: {
 30:     /**
 31:      * Weee module helper object
 32:      *
 33:      * @var Mage_Weee_Helper_Data
 34:      */
 35:     protected $_helper;
 36:     protected $_store;
 37: 
 38:     /**
 39:      * Tax configuration object
 40:      *
 41:      * @var Mage_Tax_Model_Config
 42:      */
 43:     protected $_config;
 44: 
 45:     /**
 46:      * Flag which notify what tax amount can be affected by fixed porduct tax
 47:      *
 48:      * @var bool
 49:      */
 50:     protected $_isTaxAffected;
 51: 
 52:     /**
 53:      * Initialize Weee totals collector
 54:      */
 55:     public function __construct()
 56:     {
 57:         $this->setCode('weee');
 58:         $this->_helper = Mage::helper('weee');
 59:         $this->_config = Mage::getSingleton('tax/config');
 60:     }
 61: 
 62:     /**
 63:      * Collect Weee taxes amount and prepare items prices for taxation and discount
 64:      *
 65:      * @param   Mage_Sales_Model_Quote_Address $address
 66:      * @return  Mage_Weee_Model_Total_Quote_Weee
 67:      */
 68:     public function collect(Mage_Sales_Model_Quote_Address $address)
 69:     {
 70:         Mage_Sales_Model_Quote_Address_Total_Abstract::collect($address);
 71:         $this->_isTaxAffected = false;
 72:         $items = $this->_getAddressItems($address);
 73:         if (!count($items)) {
 74:             return $this;
 75:         }
 76: 
 77:         $address->setAppliedTaxesReset(true);
 78:         $address->setAppliedTaxes(array());
 79: 
 80:         $this->_store = $address->getQuote()->getStore();
 81:         foreach ($items as $item) {
 82:             if ($item->getParentItemId()) {
 83:                 continue;
 84:             }
 85:             $this->_resetItemData($item);
 86:             if ($item->getHasChildren() && $item->isChildrenCalculated()) {
 87:                 foreach ($item->getChildren() as $child) {
 88:                     $this->_resetItemData($child);
 89:                     $this->_process($address, $child);
 90:                 }
 91:                 $this->_recalculateParent($item);
 92:             } else {
 93:                 $this->_process($address, $item);
 94:             }
 95:         }
 96: 
 97:         if ($this->_isTaxAffected) {
 98:             $address->unsSubtotalInclTax();
 99:             $address->unsBaseSubtotalInclTax();
100:         }
101: 
102:         return $this;
103:     }
104: 
105:     /**
106:      * Calculate item fixed tax and prepare information for discount and recular taxation
107:      *
108:      * @param   Mage_Sales_Model_Quote_Address $address
109:      * @param   Mage_Sales_Model_Quote_Item_Abstract $item
110:      * @return  Mage_Weee_Model_Total_Quote_Weee
111:      */
112:     protected function _process(Mage_Sales_Model_Quote_Address $address, $item)
113:     {
114:         if (!$this->_helper->isEnabled($this->_store)) {
115:             return $this;
116:         }
117: 
118:         $attributes = $this->_helper->getProductWeeeAttributes(
119:             $item->getProduct(),
120:             $address,
121:             $address->getQuote()->getBillingAddress(),
122:             $this->_store->getWebsiteId()
123:         );
124: 
125:         $applied = array();
126:         $productTaxes = array();
127: 
128:         $totalValue         = 0;
129:         $baseTotalValue     = 0;
130:         $totalRowValue      = 0;
131:         $baseTotalRowValue  = 0;
132: 
133:         foreach ($attributes as $k=>$attribute) {
134:             $baseValue      = $attribute->getAmount();
135:             $value          = $this->_store->convertPrice($baseValue);
136:             $rowValue       = $value*$item->getTotalQty();
137:             $baseRowValue   = $baseValue*$item->getTotalQty();
138:             $title          = $attribute->getName();
139: 
140:             $totalValue         += $value;
141:             $baseTotalValue     += $baseValue;
142:             $totalRowValue      += $rowValue;
143:             $baseTotalRowValue  += $baseRowValue;
144: 
145:             $productTaxes[] = array(
146:                 'title'         => $title,
147:                 'base_amount'   => $baseValue,
148:                 'amount'        => $value,
149:                 'row_amount'    => $rowValue,
150:                 'base_row_amount'=> $baseRowValue,
151:                 /**
152:                  * Tax value can't be presented as include/exclude tax
153:                  */
154:                 'base_amount_incl_tax'      => $baseValue,
155:                 'amount_incl_tax'           => $value,
156:                 'row_amount_incl_tax'       => $rowValue,
157:                 'base_row_amount_incl_tax'  => $baseRowValue,
158:             );
159: 
160:             $applied[] = array(
161:                 'id'        => $attribute->getCode(),
162:                 'percent'   => null,
163:                 'hidden'    => $this->_helper->includeInSubtotal($this->_store),
164:                 'rates'     => array(array(
165:                     'base_real_amount'=> $baseRowValue,
166:                     'base_amount'   => $baseRowValue,
167:                     'amount'        => $rowValue,
168:                     'code'          => $attribute->getCode(),
169:                     'title'         => $title,
170:                     'percent'       => null,
171:                     'position'      => 1,
172:                     'priority'      => -1000+$k,
173:                 ))
174:             );
175:         }
176: 
177:         $item->setWeeeTaxAppliedAmount($totalValue)
178:             ->setBaseWeeeTaxAppliedAmount($baseTotalValue)
179:             ->setWeeeTaxAppliedRowAmount($totalRowValue)
180:             ->setBaseWeeeTaxAppliedRowAmount($baseTotalRowValue);
181: 
182:         $this->_processTaxSettings($item, $totalValue, $baseTotalValue, $totalRowValue, $baseTotalRowValue)
183:             ->_processTotalAmount($address, $totalRowValue, $baseTotalRowValue)
184:             ->_processDiscountSettings($item, $totalValue, $baseTotalValue);
185: 
186:         $this->_helper->setApplied($item, array_merge($this->_helper->getApplied($item), $productTaxes));
187:         if ($applied) {
188:             $this->_saveAppliedTaxes($address, $applied,
189:                $item->getWeeeTaxAppliedAmount(),
190:                $item->getBaseWeeeTaxAppliedAmount(),
191:                null
192:             );
193:         }
194: 
195:     }
196: 
197:     /**
198:      * Check if discount should be applied to weee and add weee to discounted price
199:      *
200:      * @param   Mage_Sales_Model_Quote_Item_Abstract $item
201:      * @param   float $value
202:      * @param   float $baseValue
203:      * @return  Mage_Weee_Model_Total_Quote_Weee
204:      */
205:     protected function _processDiscountSettings($item, $value, $baseValue)
206:     {
207:         if ($this->_helper->isDiscounted($this->_store)) {
208:             Mage::helper('salesrule')->addItemDiscountPrices($item, $baseValue, $value);
209:         }
210:         return $this;
211:     }
212: 
213:     /**
214:      * Add extra amount which should be taxable by regular tax
215:      *
216:      * @param   Mage_Sales_Model_Quote_Item_Abstract $item
217:      * @param   float $value
218:      * @param   float $baseValue
219:      * @param   float $rowValue
220:      * @param   float $baseRowValue
221:      * @return  Mage_Weee_Model_Total_Quote_Weee
222:      */
223:     protected function _processTaxSettings($item, $value, $baseValue, $rowValue, $baseRowValue)
224:     {
225:         if ($this->_helper->isTaxable($this->_store) && $rowValue) {
226:             if (!$this->_config->priceIncludesTax($this->_store)) {
227:                 $item->setExtraTaxableAmount($value)
228:                     ->setBaseExtraTaxableAmount($baseValue)
229:                     ->setExtraRowTaxableAmount($rowValue)
230:                     ->setBaseExtraRowTaxableAmount($baseRowValue);
231:             }
232:             $item->unsRowTotalInclTax()
233:                 ->unsBaseRowTotalInclTax()
234:                 ->unsPriceInclTax()
235:                 ->unsBasePriceInclTax();
236:             $this->_isTaxAffected = true;
237:         }
238:         return $this;
239:     }
240: 
241:     /**
242:      * Proces row amount based on FPT total amount configuration setting
243:      *
244:      * @param   Mage_Sales_Model_Quote_Address $address
245:      * @param   float $rowValue
246:      * @param   float $baseRowValue
247:      * @return  Mage_Weee_Model_Total_Quote_Weee
248:      */
249:     protected function _processTotalAmount($address, $rowValue, $baseRowValue)
250:     {
251:         if ($this->_helper->includeInSubtotal($this->_store)) {
252:             $address->addTotalAmount('subtotal', $rowValue);
253:             $address->addBaseTotalAmount('subtotal', $baseRowValue);
254:             $this->_isTaxAffected = true;
255:         } else {
256:             $address->setExtraTaxAmount($address->getExtraTaxAmount() + $rowValue);
257:             $address->setBaseExtraTaxAmount($address->getBaseExtraTaxAmount() + $baseRowValue);
258:         }
259:         return $this;
260:     }
261: 
262:     /**
263:      * Recalculate parent item amounts based on children results
264:      *
265:      * @param   Mage_Sales_Model_Quote_Item_Abstract $item
266:      * @return  Mage_Weee_Model_Total_Quote_Weee
267:      */
268:     protected function _recalculateParent(Mage_Sales_Model_Quote_Item_Abstract $item)
269:     {
270: 
271:     }
272: 
273:     /**
274:      * Reset information about FPT for shopping cart item
275:      *
276:      * @param   Mage_Sales_Model_Quote_Item_Abstract $item
277:      * @return  Mage_Weee_Model_Total_Quote_Weee
278:      */
279:     protected function _resetItemData($item)
280:     {
281:         $this->_helper->setApplied($item, array());
282: 
283:         $item->setBaseWeeeTaxDisposition(0);
284:         $item->setWeeeTaxDisposition(0);
285: 
286:         $item->setBaseWeeeTaxRowDisposition(0);
287:         $item->setWeeeTaxRowDisposition(0);
288: 
289:         $item->setBaseWeeeTaxAppliedAmount(0);
290:         $item->setBaseWeeeTaxAppliedRowAmount(0);
291: 
292:         $item->setWeeeTaxAppliedAmount(0);
293:         $item->setWeeeTaxAppliedRowAmount(0);
294:     }
295: 
296:     /**
297:      * Fetch FPT data to address object for display in totals block
298:      *
299:      * @param   Mage_Sales_Model_Quote_Address $address
300:      * @return  Mage_Weee_Model_Total_Quote_Weee
301:      */
302:     public function fetch(Mage_Sales_Model_Quote_Address $address)
303:     {
304:         return $this;
305:     }
306: 
307:     /**
308:      * Process model configuration array.
309:      * This method can be used for changing totals collect sort order
310:      *
311:      * @param   array $config
312:      * @param   store $store
313:      * @return  array
314:      */
315:     public function processConfigArray($config, $store)
316:     {
317:         return $config;
318:     }
319: 
320:     /**
321:      * Process item fixed taxes
322:      *
323:      * @deprecated since 1.3.2.3
324:      * @param   Mage_Sales_Model_Quote_Address $address
325:      * @param   Mage_Sales_Model_Quote_Item_Abstract $item
326:      * @param   bool $updateParent
327:      * @return  Mage_Weee_Model_Total_Quote_Weee
328:      */
329:     protected function _processItem(Mage_Sales_Model_Quote_Address $address, $item, $updateParent = false)
330:     {
331:         $store = $address->getQuote()->getStore();
332:         if (!$this->_helper->isEnabled($store)) {
333:             return $this;
334:         }
335:         $custTaxClassId = $address->getQuote()->getCustomerTaxClassId();
336: 
337:         $taxCalculationModel = Mage::getSingleton('tax/calculation');
338:         /* @var $taxCalculationModel Mage_Tax_Model_Calculation */
339:         $request = $taxCalculationModel->getRateRequest(
340:             $address,
341:             $address->getQuote()->getBillingAddress(),
342:             $custTaxClassId,
343:             $store
344:         );
345:         $defaultRateRequest = $taxCalculationModel->getRateRequest(false, false, false, $store);
346: 
347:         $attributes = $this->_helper->getProductWeeeAttributes(
348:             $item->getProduct(),
349:             $address,
350:             $address->getQuote()->getBillingAddress(),
351:             $store->getWebsiteId()
352:         );
353: 
354:         $applied = array();
355:         $productTaxes = array();
356: 
357:         foreach ($attributes as $k=>$attribute) {
358:             $baseValue = $attribute->getAmount();
359:             $value = $store->convertPrice($baseValue);
360: 
361:             $rowValue = $value*$item->getQty();
362:             $baseRowValue = $baseValue*$item->getQty();
363: 
364:             $title = $attribute->getName();
365: 
366:             /**
367:              * Apply discount to fixed tax
368:              */
369:             if ($item->getDiscountPercent() && $this->_helper->isDiscounted($store)) {
370:                 $valueDiscount = $value/100*$item->getDiscountPercent();
371:                 $baseValueDiscount = $baseValue/100*$item->getDiscountPercent();
372: 
373:                 $rowValueDiscount = $rowValue/100*$item->getDiscountPercent();
374:                 $baseRowValueDiscount = $baseRowValue/100*$item->getDiscountPercent();
375: 
376:                 $address->setDiscountAmount($address->getDiscountAmount()+$rowValueDiscount);
377:                 $address->setBaseDiscountAmount($address->getBaseDiscountAmount()+$baseRowValueDiscount);
378: 
379:                 $address->setGrandTotal($address->getGrandTotal() - $rowValueDiscount);
380:                 $address->setBaseGrandTotal($address->getBaseGrandTotal() - $baseRowValueDiscount);
381:             }
382: 
383:             $oneDisposition = $baseOneDisposition = $disposition = $baseDisposition = 0;
384: 
385:             /**
386:              * Apply tax percent to fixed tax
387:              */
388:             if ($this->_helper->isTaxable($store)) {
389:                 $currentPercent = $item->getTaxPercent();
390:                 $defaultPercent = $taxCalculationModel->getRate(
391:                     $defaultRateRequest->setProductClassId($item->getProduct()->getTaxClassId())
392:                 );
393: 
394:                 $valueBeforeVAT = $rowValue;
395:                 $baseValueBeforeVAT = $baseRowValue;
396: 
397:                 $oneDisposition = $store->roundPrice($value/(100+$defaultPercent)*$currentPercent);
398:                 $baseOneDisposition = $store->roundPrice($baseValue/(100+$defaultPercent)*$currentPercent);
399: 
400:                 $disposition = $store->roundPrice($rowValue/(100+$defaultPercent)*$currentPercent);
401:                 $baseDisposition = $store->roundPrice($baseRowValue/(100+$defaultPercent)*$currentPercent);
402: 
403:                 $item->setBaseTaxAmount($item->getBaseTaxAmount()+$baseDisposition);
404:                 $item->setTaxAmount($item->getTaxAmount()+$disposition);
405: 
406:                 $value -= $oneDisposition;
407:                 $baseValue -= $baseOneDisposition;
408: 
409:                 $rowValue -= $baseDisposition;
410:                 $baseRowValue -= $disposition;
411: 
412:                 $item->setWeeeTaxDisposition($item->getWeeeTaxDisposition() + $oneDisposition);
413:                 $item->setBaseWeeeTaxDisposition($item->getBaseWeeeTaxDisposition() + $baseOneDisposition);
414:                 $item->setWeeeTaxRowDisposition($item->getWeeeTaxRowDisposition() + $disposition);
415:                 $item->setBaseWeeeTaxRowDisposition($item->getBaseWeeeTaxRowDisposition() + $baseDisposition);
416: 
417: //                $item->setTaxBeforeDiscount($item->getTaxBeforeDiscount() + $disposition);
418: //                $item->setBaseTaxBeforeDiscount($item->getBaseTaxBeforeDiscount() + $baseDisposition);
419: 
420:                 $address->setTaxAmount($address->getTaxAmount() + $disposition);
421:                 $address->setBaseTaxAmount($address->getBaseTaxAmount() + $baseDisposition);
422: 
423:                 $rate = $taxCalculationModel->getRate(
424:                     $request->setProductClassId($item->getProduct()->getTaxClassId())
425:                 );
426: 
427:                 $this->_saveAppliedTaxes(
428:                    $address,
429:                    $taxCalculationModel->getAppliedRates($request),
430:                    $store->roundPrice($valueBeforeVAT-$rowValue),
431:                    $store->roundPrice($baseValueBeforeVAT-$baseRowValue),
432:                    $rate
433:                 );
434: 
435:                 $address->setGrandTotal(
436:                     $address->getGrandTotal() + $store->roundPrice($valueBeforeVAT - $rowValue)
437:                 );
438:                 $address->setBaseGrandTotal(
439:                     $address->getBaseGrandTotal() + $store->roundPrice($baseValueBeforeVAT - $baseRowValue)
440:                 );
441:             }
442: 
443:             /**
444:              * Check if need include fixed tax amount to subtotal
445:              */
446:             if ($this->_helper->includeInSubtotal($store)) {
447:                 $address->setSubtotal($address->getSubtotal() + $rowValue);
448:                 $address->setBaseSubtotal($address->getBaseSubtotal() + $baseRowValue);
449: 
450: //                $address->setSubtotalWithDiscount($address->getSubtotalWithDiscount() + $rowValue);
451: //                $address->setBaseSubtotalWithDiscount($address->getBaseSubtotalWithDiscount() + $baseRowValue);
452:             } else {
453:                 $address->setTaxAmount($address->getTaxAmount() + $rowValue);
454:                 $address->setBaseTaxAmount($address->getBaseTaxAmount() + $baseRowValue);
455:             }
456: 
457: 
458:             $productTaxes[] = array(
459:                 'title'=>$title,
460:                 'base_amount'=>$baseValue,
461:                 'amount'=>$value,
462: 
463:                 'row_amount'=>$rowValue,
464:                 'base_row_amount'=>$baseRowValue,
465: 
466:                 'base_amount_incl_tax'=>$baseValue+$baseOneDisposition,
467:                 'amount_incl_tax'=>$value+$oneDisposition,
468: 
469:                 'row_amount_incl_tax'=>$rowValue+$disposition,
470:                 'base_row_amount_incl_tax'=>$baseRowValue+$baseDisposition,
471:             );
472: 
473:             $applied[] = array(
474:                 'id'=>$attribute->getCode(),
475:                 'percent'=>null,
476:                 'hidden'=>$this->_helper->includeInSubtotal($store),
477:                 'rates' => array(array(
478:                     'amount'=>$rowValue,
479:                     'base_amount'=>$baseRowValue,
480:                     'base_real_amount'=>$baseRowValue,
481:                     'code'=>$attribute->getCode(),
482:                     'title'=>$title,
483:                     'percent'=>null,
484:                     'position'=>1,
485:                     'priority'=>-1000+$k,
486:                 ))
487:             );
488: 
489:             $item->setBaseWeeeTaxAppliedAmount($item->getBaseWeeeTaxAppliedAmount() + $baseValue);
490:             $item->setBaseWeeeTaxAppliedRowAmount($item->getBaseWeeeTaxAppliedRowAmount() + $baseRowValue);
491: 
492:             $item->setWeeeTaxAppliedAmount($item->getWeeeTaxAppliedAmount() + $value);
493:             $item->setWeeeTaxAppliedRowAmount($item->getWeeeTaxAppliedRowAmount() + $rowValue);
494:         }
495: 
496:         $this->_helper->setApplied($item, array_merge($this->_helper->getApplied($item), $productTaxes));
497: 
498:         if ($updateParent) {
499:             $parent = $item->getParentItem();
500: 
501:             $parent->setBaseWeeeTaxDisposition(
502:                 $parent->getBaseWeeeTaxDisposition() + $item->getBaseWeeeTaxDisposition()
503:             );
504:             $parent->setWeeeTaxDisposition(
505:                 $parent->getWeeeTaxDisposition() + $item->getWeeeTaxDisposition()
506:             );
507: 
508:             $parent->setBaseWeeeTaxRowDisposition(
509:                 $parent->getBaseWeeeTaxRowDisposition() + $item->getBaseWeeeTaxRowDisposition()
510:             );
511:             $parent->setWeeeTaxRowDisposition(
512:                 $parent->getWeeeTaxRowDisposition() + $item->getWeeeTaxRowDisposition()
513:             );
514: 
515:             $parent->setBaseWeeeTaxAppliedAmount(
516:                 $parent->getBaseWeeeTaxAppliedAmount() + $item->getBaseWeeeTaxAppliedAmount()
517:             );
518:             $parent->setBaseWeeeTaxAppliedRowAmount(
519:                 $parent->getBaseWeeeTaxAppliedRowAmount() + $item->getBaseWeeeTaxAppliedRowAmount()
520:             );
521: 
522:             $parent->setWeeeTaxAppliedAmount(
523:                 $parent->getWeeeTaxAppliedAmount() + $item->getWeeeTaxAppliedAmount()
524:             );
525:             $parent->setWeeeTaxAppliedRowAmount(
526:                 $parent->getWeeeTaxAppliedRowAmount() + $item->getWeeeTaxAppliedRowAmount()
527:             );
528:         }
529: 
530:         if ($applied) {
531:             $this->_saveAppliedTaxes(
532:                $address,
533:                $applied,
534:                $item->getWeeeTaxAppliedAmount(),
535:                $item->getBaseWeeeTaxAppliedAmount(),
536:                null
537:             );
538:         }
539:     }
540: 
541:     /**
542:      * No aggregated label for fixed product tax
543:      *
544:      * TODO: fix
545:      */
546:     public function getLabel()
547:     {
548:         return '';
549:     }
550: }
551: