3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
33 class CRM_Financial_BAO_FinancialTypeAccount
extends CRM_Financial_DAO_EntityFinancialAccount
{
38 public function __construct() {
39 parent
::__construct();
43 * Fetch object based on array of properties.
45 * @param array $params
46 * (reference ) an assoc array of name/value pairs.
47 * @param array $defaults
48 * (reference ) an assoc array to hold the flattened values.
50 * @param array $allValues
52 * @return CRM_Contribute_BAO_ContributionType
54 public static function retrieve(&$params, &$defaults, &$allValues = array()) {
55 $financialTypeAccount = new CRM_Financial_DAO_EntityFinancialAccount();
56 $financialTypeAccount->copyValues($params);
57 $financialTypeAccount->find();
58 while ($financialTypeAccount->fetch()) {
59 CRM_Core_DAO
::storeValues($financialTypeAccount, $defaults);
60 $allValues[] = $defaults;
66 * Add the financial types.
68 * @param array $params
69 * Reference array contains the values submitted by the form.
71 * Reference array contains the id.
75 public static function add(&$params, &$ids = NULL) {
76 // action is taken depending upon the mode
77 $financialTypeAccount = new CRM_Financial_DAO_EntityFinancialAccount();
78 if ($params['entity_table'] != 'civicrm_financial_type') {
79 $financialTypeAccount->entity_id
= $params['entity_id'];
80 $financialTypeAccount->entity_table
= $params['entity_table'];
81 $financialTypeAccount->find(TRUE);
83 if (!empty($ids['entityFinancialAccount'])) {
84 $financialTypeAccount->id
= $ids['entityFinancialAccount'];
85 $financialTypeAccount->find(TRUE);
87 $financialTypeAccount->copyValues($params);
88 self
::validateRelationship($financialTypeAccount);
89 $financialTypeAccount->save();
90 return $financialTypeAccount;
94 * Delete financial Types.
96 * @param int $financialTypeAccountId
97 * @param int $accountId
100 public static function del($financialTypeAccountId, $accountId = NULL) {
101 // check if financial type is present
103 $relationValues = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
105 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_EntityFinancialAccount', $financialTypeAccountId, 'entity_id');
106 // check dependencies
107 // FIXME more table containing financial_type_id to come
109 array('Contribute', 'Contribution'),
110 array('Contribute', 'ContributionPage'),
111 array('Member', 'MembershipType'),
112 array('Price', 'PriceFieldValue'),
113 array('Grant', 'Grant'),
114 array('Contribute', 'PremiumsProduct'),
115 array('Contribute', 'Product'),
116 array('Price', 'LineItem'),
119 foreach ($dependency as $name) {
120 $daoString = 'CRM_' . $name[0] . '_DAO_' . $name[1];
121 $dao = new $daoString();
122 $dao->financial_type_id
= $financialTypeId;
123 if ($dao->find(TRUE)) {
130 if ($name[1] == 'PremiumsProduct' ||
$name[1] == 'Product') {
131 CRM_Core_Session
::setStatus(ts('You cannot remove an account with a %1 relationship while the Financial Type is used for a Premium.', array(1 => $relationValues[$financialTypeAccountId])));
134 $accountRelationShipId = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_EntityFinancialAccount', $financialTypeAccountId, 'account_relationship');
135 CRM_Core_Session
::setStatus(ts('You cannot remove an account with a %1 relationship because it is being referenced by one or more of the following types of records: Contributions, Contribution Pages, or Membership Types. Consider disabling this type instead if you no longer want it used.', array(1 => $relationValues[$accountRelationShipId])), NULL, 'error');
137 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/financial/financialType/accounts', "reset=1&action=browse&aid={$accountId}"));
140 // delete from financial Type table
141 $financialType = new CRM_Financial_DAO_EntityFinancialAccount();
142 $financialType->id
= $financialTypeAccountId;
143 $financialType->find(TRUE);
144 $financialType->delete();
145 CRM_Core_Session
::setStatus(ts('Unbalanced transactions may be created if you delete the account of type: %1.', array(1 => $relationValues[$financialType->account_relationship
])));
149 * Financial Account for payment instrument.
151 * @param int $paymentInstrumentValue
152 * Payment instrument value.
156 public static function getInstrumentFinancialAccount($paymentInstrumentValue) {
157 if (!isset(\Civi
::$statics[__CLASS__
]['instrument_financial_accounts'][$paymentInstrumentValue])) {
158 $paymentInstrumentID = civicrm_api3('OptionValue', 'getvalue', array(
160 'value' => $paymentInstrumentValue,
161 'option_group_id' => "payment_instrument",
163 $accounts = civicrm_api3('EntityFinancialAccount', 'get', [
164 'return' => 'financial_account_id',
165 'entity_table' => 'civicrm_option_value',
166 'entity_id' => $paymentInstrumentID,
167 'options' => ['limit' => 1],
170 if (empty($accounts)) {
171 \Civi
::$statics[__CLASS__
]['instrument_financial_accounts'][$paymentInstrumentValue] = NULL;
174 \Civi
::$statics[__CLASS__
]['instrument_financial_accounts'][$paymentInstrumentValue] = $accounts[0]['financial_account_id'];
177 return \Civi
::$statics[__CLASS__
]['instrument_financial_accounts'][$paymentInstrumentValue];
181 * Create default entity financial accounts
185 * @param $financialType
189 public static function createDefaultFinancialAccounts($financialType) {
191 $financialAccountTypeID = CRM_Core_OptionGroup
::values('financial_account_type', FALSE, FALSE, FALSE, NULL, 'name');
192 $accountRelationship = CRM_Core_OptionGroup
::values('account_relationship', FALSE, FALSE, FALSE, NULL, 'name');
194 $relationships = array(
195 array_search('Accounts Receivable Account is', $accountRelationship) => array_search('Asset', $financialAccountTypeID),
196 array_search('Expense Account is', $accountRelationship) => array_search('Expenses', $financialAccountTypeID),
197 array_search('Cost of Sales Account is', $accountRelationship) => array_search('Cost of Sales', $financialAccountTypeID),
198 array_search('Income Account is', $accountRelationship) => array_search('Revenue', $financialAccountTypeID),
201 $dao = CRM_Core_DAO
::executeQuery('SELECT id, financial_account_type_id FROM civicrm_financial_account WHERE name LIKE %1',
202 array(1 => array($financialType->name
, 'String'))
205 $existingFinancialAccount = array();
208 'name' => $financialType->name
,
209 'contact_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', CRM_Core_Config
::domainID(), 'contact_id'),
210 'financial_account_type_id' => array_search('Revenue', $financialAccountTypeID),
211 'description' => $financialType->description
,
212 'account_type_code' => 'INC',
215 $financialAccount = CRM_Financial_BAO_FinancialAccount
::add($params);
218 $existingFinancialAccount[$dao->financial_account_type_id
] = $dao->id
;
221 'entity_table' => 'civicrm_financial_type',
222 'entity_id' => $financialType->id
,
224 foreach ($relationships as $key => $value) {
225 if (!array_key_exists($value, $existingFinancialAccount)) {
226 if ($accountRelationship[$key] == 'Accounts Receivable Account is') {
227 $params['financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialAccount', 'Accounts Receivable', 'id', 'name');
228 if (!empty($params['financial_account_id'])) {
229 $titles[] = 'Accounts Receivable';
232 $query = "SELECT financial_account_id, name FROM civicrm_entity_financial_account
233 LEFT JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id
234 WHERE account_relationship = {$key} AND entity_table = 'civicrm_financial_type' LIMIT 1";
235 $dao = CRM_Core_DAO
::executeQuery($query);
237 $params['financial_account_id'] = $dao->financial_account_id
;
238 $titles[] = $dao->name
;
241 elseif ($accountRelationship[$key] == 'Income Account is' && empty($existingFinancialAccount)) {
242 $params['financial_account_id'] = $financialAccount->id
;
245 $query = "SELECT id, name FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = {$value}";
246 $dao = CRM_Core_DAO
::executeQuery($query);
248 $params['financial_account_id'] = $dao->id
;
249 $titles[] = $dao->name
;
253 $params['financial_account_id'] = $existingFinancialAccount[$value];
254 $titles[] = $financialType->name
;
256 $params['account_relationship'] = $key;
259 if (!empty($existingFinancialAccount)) {
266 * Validate account relationship with financial account type
268 * @param obj $financialTypeAccount of CRM_Financial_DAO_EntityFinancialAccount
270 * @throws CRM_Core_Exception
272 public static function validateRelationship($financialTypeAccount) {
273 $financialAccountLinks = CRM_Financial_BAO_FinancialAccount
::getfinancialAccountRelations();
274 $financialAccountType = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialAccount', $financialTypeAccount->financial_account_id
, 'financial_account_type_id');
275 if (CRM_Utils_Array
::value($financialTypeAccount->account_relationship
, $financialAccountLinks) != $financialAccountType) {
276 $accountRelationships = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
278 1 => $accountRelationships[$financialTypeAccount->account_relationship
],
280 throw new CRM_Core_Exception(ts("This financial account cannot have '%1' relationship.", $params));