CRM/Financial/Form/SalesTaxTrait.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 trait CRM_Financial_Form_SalesTaxTrait {
  35
  36   /**
  37    * Assign the sales tax term to the template.
  38    */
  39   public function assignSalesTaxTermToTemplate() {
  40     $this->assign('taxTerm', $this->getSalesTaxTerm());
  41   }
  42
  43   /**
  44    * Assign sales tax rates to the template.
  45    */
  46   public function assignSalesTaxRates() {
  47     $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant::getTaxRates()));
  48   }
  49
  50   /**
  51    * Return the string to be assigned to the template for sales tax - e.g GST, VAT.
  52    *
  53    * @return string
  54    */
  55   public function getSalesTaxTerm() {
  56     $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
  57     $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
  58     if (!$invoicing) {
  59       return '';
  60     }
  61     return CRM_Utils_Array::value('tax_term', $invoiceSettings);
  62   }
  63
  64   /**
  65    * Assign information to the template required for sales tax purposes.
  66    */
  67   public function assignSalesTaxMetadataToTemplate() {
  68     $this->assignSalesTaxRates();
  69     $this->assignSalesTaxTermToTemplate();
  70   }
  71
  72   /**
  73    * Get sales tax rates.
  74    *
  75    * @return array
  76    */
  77   public function getTaxRatesForFinancialTypes() {
  78     return CRM_Core_PseudoConstant::getTaxRates();
  79   }
  80
  81   /**
  82    * @param int $financialTypeID
  83    *
  84    * @return string
  85    */
  86   public function getTaxRateForFinancialType($financialTypeID) {
  87     return CRM_Utils_Array::value($financialTypeID, $this->getTaxRatesForFinancialTypes());
  88   }
  89
  90 }