/
Calculation.php
executable file
·518 lines (468 loc) · 17.3 KB
/
Calculation.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
<?php
/**
* Magento
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@magentocommerce.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Magento to newer
* versions in the future. If you wish to customize Magento for your
* needs please refer to http://www.magentocommerce.com for more information.
*
* @category Mage
* @package Mage_Tax
* @copyright Copyright (c) 2011 Magento Inc. (http://www.magentocommerce.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/
/**
* Tax Calculation Model
*
* @author Magento Core Team <core@magentocommerce.com>
*/
class Mage_Tax_Model_Calculation extends Mage_Core_Model_Abstract
{
const CALC_TAX_BEFORE_DISCOUNT_ON_EXCL = '0_0';
const CALC_TAX_BEFORE_DISCOUNT_ON_INCL = '0_1';
const CALC_TAX_AFTER_DISCOUNT_ON_EXCL = '1_0';
const CALC_TAX_AFTER_DISCOUNT_ON_INCL = '1_1';
const CALC_UNIT_BASE = 'UNIT_BASE_CALCULATION';
const CALC_ROW_BASE = 'ROW_BASE_CALCULATION';
const CALC_TOTAL_BASE = 'TOTAL_BASE_CALCULATION';
protected $_rates = array();
protected $_ctc = array();
protected $_ptc = array();
protected $_rateCache = array();
protected $_rateCalculationProcess = array();
protected $_customer = null;
protected $_defaultCustomerTaxClass = null;
protected function _construct()
{
$this->_init('tax/calculation');
}
/**
* Specify customer object which can be used for rate calculation
*
* @param Mage_Customer_Model_Customer $customer
* @return Mage_Tax_Model_Calculation
*/
public function setCustomer(Mage_Customer_Model_Customer $customer)
{
$this->_customer = $customer;
return $this;
}
public function getDefaultCustomerTaxClass($store = null)
{
if ($this->_defaultCustomerTaxClass === null) {
$defaultCustomerGroup = Mage::getStoreConfig(Mage_Customer_Model_Group::XML_PATH_DEFAULT_ID, $store);
$this->_defaultCustomerTaxClass = Mage::getModel('customer/group')->getTaxClassId($defaultCustomerGroup);
}
return $this->_defaultCustomerTaxClass;
}
/**
* Get customer object
*
* @return Mage_Customer_Model_Customer | false
*/
public function getCustomer()
{
if ($this->_customer === null) {
$session = Mage::getSingleton('customer/session');
if ($session->isLoggedIn()) {
$this->_customer = $session->getCustomer();
} elseif ($session->getCustomerId()) {
$this->_customer = Mage::getModel('customer/customer')->load($session->getCustomerId());
} else {
$this->_customer = false;
}
}
return $this->_customer;
}
/**
* Delete calculation settings by rule id
*
* @param int $ruleId
* @return Mage_Tax_Model_Calculation
*/
public function deleteByRuleId($ruleId)
{
$this->_getResource()->deleteByRuleId($ruleId);
return $this;
}
/**
* Get calculation rates by rule id
*
* @param int $ruleId
* @return array
*/
public function getRates($ruleId)
{
if (!isset($this->_rates[$ruleId])) {
$this->_rates[$ruleId] = $this->_getResource()->getDistinct('tax_calculation_rate_id', $ruleId);
}
return $this->_rates[$ruleId];
}
/**
* Get allowed customer tax classes by rule id
*
* @param int $ruleId
* @return array
*/
public function getCustomerTaxClasses($ruleId)
{
if (!isset($this->_ctc[$ruleId])) {
$this->_ctc[$ruleId] = $this->_getResource()->getDistinct('customer_tax_class_id', $ruleId);
}
return $this->_ctc[$ruleId];
}
/**
* Get allowed product tax classes by rule id
*
* @param int $ruleId
* @return array
*/
public function getProductTaxClasses($ruleId)
{
if (!isset($this->_ptc[$ruleId])) {
$this->_ptc[$ruleId] = $this->getResource()->getDistinct('product_tax_class_id', $ruleId);
}
return $this->_ptc[$ruleId];
}
/**
* Aggregate tax calculation data to array
*
* @return array
*/
protected function _formCalculationProcess()
{
$title = $this->getRateTitle();
$value = $this->getRateValue();
$id = $this->getRateId();
$rate = array('code'=>$title, 'title'=>$title, 'percent'=>$value, 'position'=>1, 'priority'=>1);
$process = array();
$process['percent'] = $value;
$process['id'] = "{$id}-{$value}";
$process['rates'][] = $rate;
return array($process);
}
/**
* Get calculation tax rate by specific request
*
* @param Varien_Object $request
* @return float
*/
public function getRate($request)
{
if (!$request->getCountryId() || !$request->getCustomerClassId() || !$request->getProductClassId()) {
return 0;
}
$cacheKey = $this->_getRequestCacheKey($request);
if (!isset($this->_rateCache[$cacheKey])) {
$this->unsRateValue();
$this->unsCalculationProcess();
$this->unsEventModuleId();
Mage::dispatchEvent('tax_rate_data_fetch', array('request'=>$request));
if (!$this->hasRateValue()) {
$rateInfo = $this->_getResource()->getRateInfo($request);
$this->setCalculationProcess($rateInfo['process']);
$this->setRateValue($rateInfo['value']);
} else {
$this->setCalculationProcess($this->_formCalculationProcess());
}
$this->_rateCache[$cacheKey] = $this->getRateValue();
$this->_rateCalculationProcess[$cacheKey] = $this->getCalculationProcess();
}
return $this->_rateCache[$cacheKey];
}
/**
* Get cache key value for specific tax rate request
*
* @param $request
* @return string
*/
protected function _getRequestCacheKey($request)
{
$key = $request->getStore() ? $request->getStore()->getId() . '|' : '';
$key.= $request->getProductClassId() . '|' . $request->getCustomerClassId() . '|'
. $request->getCountryId() . '|'. $request->getRegionId() . '|' . $request->getPostcode();
return $key;
}
/**
* Get tax rate based on store shipping origin address settings
* This rate can be used for conversion store price including tax to
* store price excluding tax
*
* @param Varien_Object $request
* @return float
*/
public function getStoreRate($request, $store=null)
{
$storeRequest = $this->getRateOriginRequest($store)
->setProductClassId($request->getProductClassId());
return $this->getRate($storeRequest);
}
/**
* Get request object for getting tax rate based on store shippig original address
*
* @param null|store $store
* @return Varien_Object
*/
public function getRateOriginRequest($store = null)
{
$request = new Varien_Object();
$request->setCountryId(Mage::getStoreConfig(Mage_Shipping_Model_Config::XML_PATH_ORIGIN_COUNTRY_ID, $store))
->setRegionId(Mage::getStoreConfig(Mage_Shipping_Model_Config::XML_PATH_ORIGIN_REGION_ID, $store))
->setPostcode(Mage::getStoreConfig(Mage_Shipping_Model_Config::XML_PATH_ORIGIN_POSTCODE, $store))
->setCustomerClassId($this->getDefaultCustomerTaxClass($store))
->setStore($store);
return $request;
}
/**
* Get request object with information necessary for getting tax rate
* Request object contain:
* country_id (->getCountryId())
* region_id (->getRegionId())
* postcode (->getPostcode())
* customer_class_id (->getCustomerClassId())
* store (->getStore())
*
* @param null|false|Varien_Object $shippingAddress
* @param null|false|Varien_Object $billingAddress
* @param null|int $customerTaxClass
* @param null|int $store
* @return Varien_Object
*/
public function getRateRequest(
$shippingAddress = null,
$billingAddress = null,
$customerTaxClass = null,
$store = null)
{
if ($shippingAddress === false && $billingAddress === false && $customerTaxClass === false) {
return $this->getRateOriginRequest($store);
}
$address = new Varien_Object();
$customer = $this->getCustomer();
$basedOn = Mage::getStoreConfig(Mage_Tax_Model_Config::CONFIG_XML_PATH_BASED_ON, $store);
if (($shippingAddress === false && $basedOn == 'shipping')
|| ($billingAddress === false && $basedOn == 'billing')) {
$basedOn = 'default';
} else {
if ((($billingAddress === false || is_null($billingAddress) || !$billingAddress->getCountryId())
&& $basedOn == 'billing')
|| (($shippingAddress === false || is_null($shippingAddress) || !$shippingAddress->getCountryId())
&& $basedOn == 'shipping')
){
if ($customer) {
$defBilling = $customer->getDefaultBillingAddress();
$defShipping = $customer->getDefaultShippingAddress();
if ($basedOn == 'billing' && $defBilling && $defBilling->getCountryId()) {
$billingAddress = $defBilling;
} else if ($basedOn == 'shipping' && $defShipping && $defShipping->getCountryId()) {
$shippingAddress = $defShipping;
} else {
$basedOn = 'default';
}
} else {
$basedOn = 'default';
}
}
}
switch ($basedOn) {
case 'billing':
$address = $billingAddress;
break;
case 'shipping':
$address = $shippingAddress;
break;
case 'origin':
$address = $this->getRateOriginRequest($store);
break;
case 'default':
$address
->setCountryId(Mage::getStoreConfig(
Mage_Tax_Model_Config::CONFIG_XML_PATH_DEFAULT_COUNTRY,
$store))
->setRegionId(Mage::getStoreConfig(Mage_Tax_Model_Config::CONFIG_XML_PATH_DEFAULT_REGION, $store))
->setPostcode(Mage::getStoreConfig(
Mage_Tax_Model_Config::CONFIG_XML_PATH_DEFAULT_POSTCODE,
$store));
break;
}
if (is_null($customerTaxClass) && $customer) {
$customerTaxClass = $customer->getTaxClassId();
} elseif (($customerTaxClass === false) || !$customer) {
$customerTaxClass = $this->getDefaultCustomerTaxClass($store);
}
$request = new Varien_Object();
$request
->setCountryId($address->getCountryId())
->setRegionId($address->getRegionId())
->setPostcode($address->getPostcode())
->setStore($store)
->setCustomerClassId($customerTaxClass);
return $request;
}
/**
* Compare data and rates for two tax rate requests for same products (product tax class ids).
* Returns true if requests are similar (i.e. equal taxes rates will be applied to them)
*
* Notice:
* a) productClassId MUST be identical for both requests, because we intend to check selling SAME products to DIFFERENT locations
* b) due to optimization productClassId can be array of ids, not only single id
*
* @param Varien_Object $first
* @param Varien_Object $second
* @return bool
*/
public function compareRequests($first, $second)
{
$country = $first->getCountryId() == $second->getCountryId();
// "0" support for admin dropdown with --please select--
$region = (int)$first->getRegionId() == (int)$second->getRegionId();
$postcode= $first->getPostcode() == $second->getPostcode();
$taxClass= $first->getCustomerClassId() == $second->getCustomerClassId();
if ($country && $region && $postcode && $taxClass) {
return true;
}
/**
* Compare available tax rates for both requests
*/
$firstReqRates = $this->_getResource()->getRateIds($first);
$secondReqRates = $this->_getResource()->getRateIds($second);
if ($firstReqRates === $secondReqRates) {
return true;
}
/**
* If rates are not equal by ids then compare actual values
* All product classes must have same rates to assume requests been similar
*/
$productClassId1 = $first->getProductClassId(); // Save to set it back later
$productClassId2 = $second->getProductClassId(); // Save to set it back later
// Ids are equal for both requests, so take any of them to process
$ids = is_array($productClassId1) ? $productClassId1 : array($productClassId1);
$identical = true;
foreach ($ids as $productClassId) {
$first->setProductClassId($productClassId);
$rate1 = $this->getRate($first);
$second->setProductClassId($productClassId);
$rate2 = $this->getRate($second);
if ($rate1 != $rate2) {
$identical = false;
break;
}
}
$first->setProductClassId($productClassId1);
$second->setProductClassId($productClassId2);
return $identical;
}
protected function _getRates($request, $fieldName, $type)
{
$result = array();
$classes = Mage::getModel('tax/class')->getCollection()
->addFieldToFilter('class_type', $type)
->load();
foreach ($classes as $class) {
$request->setData($fieldName, $class->getId());
$result[$class->getId()] = $this->getRate($request);
}
return $result;
}
public function getRatesForAllProductTaxClasses($request)
{
return $this->_getRates($request, 'product_class_id', Mage_Tax_Model_Class::TAX_CLASS_TYPE_PRODUCT);
}
public function getRatesForAllCustomerTaxClasses($request)
{
return $this->_getRates($request, 'customer_class_id', Mage_Tax_Model_Class::TAX_CLASS_TYPE_CUSTOMER);
}
/**
* Get information about tax rates applied to request
*
* @param Varien_Object $request
* @return array
*/
public function getAppliedRates($request)
{
$cacheKey = $this->_getRequestCacheKey($request);
if (!isset($this->_rateCalculationProcess[$cacheKey])) {
$this->_rateCalculationProcess[$cacheKey] = $this->_getResource()->getCalculationProcess($request);
}
return $this->_rateCalculationProcess[$cacheKey];
}
public function reproduceProcess($rates)
{
return $this->getResource()->getCalculationProcess(null, $rates);
}
public function getRatesByCustomerTaxClass($customerTaxClass)
{
return $this->getResource()->getRatesByCustomerTaxClass($customerTaxClass);
}
public function getRatesByCustomerAndProductTaxClasses($customerTaxClass, $productTaxClass)
{
return $this->getResource()->getRatesByCustomerTaxClass($customerTaxClass, $productTaxClass);
}
/**
* Calculate rated tax abount based on price and tax rate.
* If you are using price including tax $priceIncludeTax should be true.
*
* @param float $price
* @param float $taxRate
* @param boolean $priceIncludeTax
* @return float
*/
public function calcTaxAmount($price, $taxRate, $priceIncludeTax=false, $round=true)
{
$taxRate = $taxRate/100;
if ($priceIncludeTax) {
$amount = $price*(1-1/(1+$taxRate));
} else {
$amount = $price*$taxRate;
}
if ($round) {
return $this->round($amount);
}
return $amount;
}
/**
* Truncate number to specified precision
*
* @param float $price
* @param int $precision
* @return float
*/
public function truncate($price, $precision=4)
{
$exp = pow(10,$precision);
$price = floor($price*$exp)/$exp;
return $price;
}
/**
* Round tax amount
*
* @param float $price
* @return float
*/
public function round($price)
{
return Mage::app()->getStore()->roundPrice($price);
}
/**
* Round price up
*
* @param float $price
* @return float
*/
public function roundUp($price)
{
return ceil($price*100)/100;
}
}