CRM/Financial/BAO/FinancialAccount.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.3                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2013                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2013
  33  * $Id$
  34  *
  35  */
  36
  37 class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAccount {
  38
  39   /**
  40    * static holder for the default LT
  41    */
  42   static $_defaultContributionType = NULL;
  43
  44   /**
  45    * class constructor
  46    */
  47   function __construct() {
  48     parent::__construct();
  49   }
  50
  51   /**
  52    * Takes a bunch of params that are needed to match certain criteria and
  53    * retrieves the relevant objects. Typically the valid params are only
  54    * contact_id. We'll tweak this function to be more full featured over a period
  55    * of time. This is the inverse function of create. It also stores all the retrieved
  56    * values in the default array
  57    *
  58    * @param array $params   (reference ) an assoc array of name/value pairs
  59    * @param array $defaults (reference ) an assoc array to hold the flattened values
  60    *
  61    * @return object CRM_Contribute_BAO_FinancialAccount object
  62    * @access public
  63    * @static
  64    */
  65   static function retrieve(&$params, &$defaults) {
  66     $financialAccount = new CRM_Financial_DAO_FinancialAccount();
  67     $financialAccount->copyValues($params);
  68     if ($financialAccount->find(TRUE)) {
  69       CRM_Core_DAO::storeValues($financialAccount, $defaults);
  70       return $financialAccount;
  71     }
  72     return NULL;
  73   }
  74
  75   /**
  76    * update the is_active flag in the db
  77    *
  78    * @param int      $id        id of the database record
  79    * @param boolean  $is_active value we want to set the is_active field
  80    *
  81    * @return Object             DAO object on sucess, null otherwise
  82    * @static
  83    */
  84   static function setIsActive($id, $is_active) {
  85     return CRM_Core_DAO::setFieldValue('CRM_Financial_DAO_FinancialAccount', $id, 'is_active', $is_active);
  86   }
  87
  88   /**
  89    * function to add the financial types
  90    *
  91    * @param array $params reference array contains the values submitted by the form
  92    * @param array $ids    reference array contains the id
  93    *
  94    * @access public
  95    * @static
  96    * @return object
  97    */
  98   static function add(&$params, &$ids) {
  99     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 100     $params['is_deductible'] = CRM_Utils_Array::value('is_deductible', $params, FALSE);
 101     $params['is_tax'] = CRM_Utils_Array::value('is_tax', $params, FALSE);
 102     $params['is_header_account'] = CRM_Utils_Array::value('is_header_account', $params, FALSE);
 103     $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
 104     if (CRM_Utils_Array::value('is_default', $params)) {
 105       $query = 'UPDATE civicrm_financial_account SET is_default = 0 WHERE financial_account_type_id = %1';
 106       $queryParams = array(1 => array($params['financial_account_type_id'], 'Integer'));
 107       CRM_Core_DAO::executeQuery($query, $queryParams);
 108     }
 109
 110     // action is taken depending upon the mode
 111     $financialAccount = new CRM_Financial_DAO_FinancialAccount();
 112     $financialAccount->copyValues($params);
 113     $financialAccount->id = CRM_Utils_Array::value('contributionType', $ids);
 114     $financialAccount->save();
 115     return $financialAccount;
 116   }
 117
 118   /**
 119    * Function to delete financial Types
 120    *
 121    * @param int $financialAccountId
 122    * @static
 123    */
 124   static function del($financialAccountId) {
 125     //checking if financial type is present
 126     $check = FALSE;
 127
 128     //check dependencies
 129     $dependancy = array(
 130       array('Core', 'FinancialTrxn', 'to_financial_account_id'),
 131       array('Financial', 'FinancialTypeAccount', 'financial_account_id'),
 132       );
 133     foreach ($dependancy as $name) {
 134       require_once (str_replace('_', DIRECTORY_SEPARATOR, "CRM_" . $name[0] . "_BAO_" . $name[1]) . ".php");
 135       eval('$bao = new CRM_' . $name[0] . '_BAO_' . $name[1] . '();');
 136       $bao->$name[2] = $financialAccountId;
 137       if ($bao->find(TRUE)) {
 138         $check = TRUE;
 139       }
 140     }
 141
 142     if ($check) {
 143       CRM_Core_Session::setStatus(ts('This financial account cannot be deleted since it is being used as a header account. Please remove it from being a header account before trying to delete it again.'));
 144       return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/financial/financialAccount', "reset=1&action=browse"));
 145     }
 146
 147     //delete from financial Type table
 148     $financialAccount = new CRM_Financial_DAO_FinancialAccount();
 149     $financialAccount->id = $financialAccountId;
 150     $financialAccount->delete();
 151   }
 152
 153   /**
 154    * get accounting code for a financial type with account relation Income Account is
 155    *
 156    * @financialTypeId int      Financial Type Id
 157    *
 158    * @return accounting code
 159    * @static
 160    */
 161   static function getAccountingCode($financialTypeId) {
 162     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
 163     $query = "SELECT cfa.accounting_code
 164 FROM civicrm_financial_type cft
 165 LEFT JOIN civicrm_entity_financial_account cefa ON cefa.entity_id = cft.id AND cefa.entity_table = 'civicrm_financial_type'
 166 LEFT JOIN  civicrm_financial_account cfa ON cefa.financial_account_id = cfa.id
 167 WHERE cft.id = %1
 168   AND account_relationship = %2";
 169     $params = array(
 170       1 => array($financialTypeId, 'Integer'),
 171       2 => array($relationTypeId, 'Integer'),
 172     );
 173     return CRM_Core_DAO::singleValueQuery($query, $params);
 174   }
 175
 176   /**
 177    * get AR account
 178    *
 179    * @param $financialAccountId financial account id
 180    *
 181    * @param $financialAccountTypeId financial account type id
 182    *
 183    * @param $accountTypeCode account type code
 184    *
 185    * @return integer count
 186    * @static
 187    */
 188   static function getARAccounts($financialAccountId, $financialAccountTypeId, $accountTypeCode = 'ar') {
 189     $query = "SELECT count(id) FROM civicrm_financial_account WHERE financial_account_type_id = %1 AND LCASE(account_type_code) = %2
 190       AND id != %3;";
 191     $params = array(
 192       1 => array($financialAccountTypeId, 'Integer'),
 193       2 => array(strtolower($accountTypeCode), 'String'),
 194       3 => array($financialAccountId, 'Integer'),
 195     );
 196      return CRM_Core_DAO::singleValueQuery($query, $params);
 197   }
 198 }
 199