CRM/Financial/Form/SalesTaxTrait.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2020                                |
   7   +--------------------------------------------------------------------+
   8   | This file is a part of CiviCRM.                                    |
   9   |                                                                    |
  10   | CiviCRM is free software; you can copy, modify, and distribute it  |
  11   | under the terms of the GNU Affero General Public License           |
  12   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13   |                                                                    |
  14   | CiviCRM is distributed in the hope that it will be useful, but     |
  15   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17   | See the GNU Affero General Public License for more details.        |
  18   |                                                                    |
  19   | You should have received a copy of the GNU Affero General Public   |
  20   | License and the CiviCRM Licensing Exception along                  |
  21   | with this program; if not, contact CiviCRM LLC                     |
  22   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23   | GNU Affero General Public License or the licensing of CiviCRM,     |
  24   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25   +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2020
  32  */
  33 trait CRM_Financial_Form_SalesTaxTrait {
  34
  35   /**
  36    * Assign the sales tax term to the template.
  37    */
  38   public function assignSalesTaxTermToTemplate() {
  39     $this->assign('taxTerm', $this->getSalesTaxTerm());
  40   }
  41
  42   /**
  43    * Assign sales tax rates to the template.
  44    */
  45   public function assignSalesTaxRates() {
  46     $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant::getTaxRates()));
  47   }
  48
  49   /**
  50    * Return the string to be assigned to the template for sales tax - e.g GST, VAT.
  51    *
  52    * @return string
  53    */
  54   public function getSalesTaxTerm() {
  55     $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
  56     $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
  57     if (!$invoicing) {
  58       return '';
  59     }
  60     return CRM_Utils_Array::value('tax_term', $invoiceSettings);
  61   }
  62
  63   /**
  64    * Assign information to the template required for sales tax purposes.
  65    */
  66   public function assignSalesTaxMetadataToTemplate() {
  67     $this->assignSalesTaxRates();
  68     $this->assignSalesTaxTermToTemplate();
  69   }
  70
  71   /**
  72    * Get sales tax rates.
  73    *
  74    * @return array
  75    */
  76   public function getTaxRatesForFinancialTypes() {
  77     return CRM_Core_PseudoConstant::getTaxRates();
  78   }
  79
  80   /**
  81    * @param int $financialTypeID
  82    *
  83    * @return string
  84    */
  85   public function getTaxRateForFinancialType($financialTypeID) {
  86     return CRM_Utils_Array::value($financialTypeID, $this->getTaxRatesForFinancialTypes());
  87   }
  88
  89 }