3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Financial_BAO_FinancialTypeAccount
extends CRM_Financial_DAO_EntityFinancialAccount
{
40 public function __construct() {
41 parent
::__construct();
48 private static $financialAccount;
51 * Fetch object based on array of properties
53 * @param array $params
54 * (reference ) an assoc array of name/value pairs.
55 * @param array $defaults
56 * (reference ) an assoc array to hold the flattened values.
58 * @param array $allValues
60 * @return CRM_Contribute_BAO_ContributionType
62 public static function retrieve(&$params, &$defaults, &$allValues = array()) {
63 $financialTypeAccount = new CRM_Financial_DAO_EntityFinancialAccount();
64 $financialTypeAccount->copyValues($params);
65 $financialTypeAccount->find();
66 while ($financialTypeAccount->fetch()) {
67 CRM_Core_DAO
::storeValues($financialTypeAccount, $defaults);
68 $allValues[] = $defaults;
74 * Add the financial types
76 * @param array $params
77 * Reference array contains the values submitted by the form.
79 * Reference array contains the id.
83 public static function add(&$params, &$ids = NULL) {
84 // action is taken depending upon the mode
85 $financialTypeAccount = new CRM_Financial_DAO_EntityFinancialAccount();
86 if ($params['entity_table'] != 'civicrm_financial_type') {
87 $financialTypeAccount->entity_id
= $params['entity_id'];
88 $financialTypeAccount->entity_table
= $params['entity_table'];
89 $financialTypeAccount->find(TRUE);
92 $financialTypeAccount->id
= CRM_Utils_Array
::value('entityFinancialAccount', $ids);
94 if (!empty($ids['entityFinancialAccount'])) {
95 $financialTypeAccount->id
= $ids['entityFinancialAccount'];
97 $financialTypeAccount->copyValues($params);
98 $financialTypeAccount->save();
99 return $financialTypeAccount;
103 * Delete financial Types
105 * @param int $financialTypeAccountId
106 * @param int $accountId
109 public static function del($financialTypeAccountId, $accountId = NULL) {
110 //checking if financial type is present
112 $relationValues = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
114 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_EntityFinancialAccount', $financialTypeAccountId, 'entity_id');
116 // FIXME more table containing financial_type_id to come
118 array('Contribute', 'Contribution'),
119 array('Contribute', 'ContributionPage'),
120 array('Member', 'MembershipType'),
121 array('Price', 'PriceFieldValue'),
122 array('Grant', 'Grant'),
123 array('Contribute', 'PremiumsProduct'),
124 array('Contribute', 'Product'),
125 array('Price', 'LineItem'),
128 foreach ($dependancy as $name) {
129 $daoString = 'CRM_' . $name[0] . '_DAO_' . $name[1];
130 $dao = new $daoString();
131 $dao->financial_type_id
= $financialTypeId;
132 if ($dao->find(TRUE)) {
139 if ($name[1] == 'PremiumsProduct' ||
$name[1] == 'Product') {
140 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])));
143 $accountRelationShipId = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_EntityFinancialAccount', $financialTypeAccountId, 'account_relationship');
144 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');
146 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/financial/financialType/accounts', "reset=1&action=browse&aid={$accountId}"));
149 //delete from financial Type table
150 $financialType = new CRM_Financial_DAO_EntityFinancialAccount();
151 $financialType->id
= $financialTypeAccountId;
152 $financialType->find(TRUE);
153 $financialType->delete();
154 CRM_Core_Session
::setStatus(ts('Unbalanced transactions may be created if you delete the account of type: %1.', array(1 => $relationValues[$financialType->account_relationship
])));
158 * Get Financial Account Name
160 * @param int $entityId
162 * @param string $entityTable
164 * @param string $columnName
167 * @return null|string
169 public static function getFinancialAccount($entityId, $entityTable, $columnName = 'name') {
170 $join = $columnName == 'name' ?
'LEFT JOIN civicrm_financial_account ON civicrm_entity_financial_account.financial_account_id = civicrm_financial_account.id' : NULL;
173 FROM civicrm_entity_financial_account
175 WHERE entity_table = %1
179 1 => array($entityTable, 'String'),
180 2 => array($entityId, 'Integer'),
182 return CRM_Core_DAO
::singleValueQuery($query, $params);
186 * Financial Account for payment instrument
188 * @param int $paymentInstrumentValue
189 * Payment instrument value.
191 * @return array|null|string
193 public static function getInstrumentFinancialAccount($paymentInstrumentValue = NULL) {
194 if (!self
::$financialAccount) {
195 $query = "SELECT ceft.financial_account_id, cov.value
196 FROM civicrm_entity_financial_account ceft
197 INNER JOIN civicrm_option_value cov ON cov.id = ceft.entity_id AND ceft.entity_table = 'civicrm_option_value'
198 INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id
199 WHERE cog.name = 'payment_instrument' ";
201 if ($paymentInstrumentValue) {
202 $query .= " AND cov.value = '{$paymentInstrumentValue}' ";
203 return CRM_Core_DAO
::singleValueQuery($query);
206 $result = CRM_Core_DAO
::executeQuery($query);
207 while ($result->fetch()) {
208 self
::$financialAccount[$result->value
] = $result->financial_account_id
;
210 return self
::$financialAccount;
214 return $paymentInstrumentValue ? self
::$financialAccount[$paymentInstrumentValue] : self
::$financialAccount;
218 * Create default entity financial accounts
222 * @param $financialType
226 public static function createDefaultFinancialAccounts($financialType) {
228 $financialAccountTypeID = CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type');
229 $accountRelationship = CRM_Core_PseudoConstant
::accountOptionValues('account_relationship');
230 $relationships = array(
231 array_search('Accounts Receivable Account is', $accountRelationship) => array_search('Asset', $financialAccountTypeID),
232 array_search('Expense Account is', $accountRelationship) => array_search('Expenses', $financialAccountTypeID),
233 array_search('Cost of Sales Account is', $accountRelationship) => array_search('Cost of Sales', $financialAccountTypeID),
234 array_search('Income Account is', $accountRelationship) => array_search('Revenue', $financialAccountTypeID),
237 $dao = CRM_Core_DAO
::executeQuery('SELECT id, financial_account_type_id FROM civicrm_financial_account WHERE name LIKE %1',
238 array(1 => array($financialType->name
, 'String'))
241 $existingFinancialAccount = array();
244 'name' => $financialType->name
,
245 'contact_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', CRM_Core_Config
::domainID(), 'contact_id'),
246 'financial_account_type_id' => array_search('Revenue', $financialAccountTypeID),
247 'description' => $financialType->description
,
248 'account_type_code' => 'INC',
251 $financialAccount = CRM_Financial_BAO_FinancialAccount
::add($params, CRM_Core_DAO
::$_nullArray);
254 $existingFinancialAccount[$dao->financial_account_type_id
] = $dao->id
;
257 'entity_table' => 'civicrm_financial_type',
258 'entity_id' => $financialType->id
,
260 foreach ($relationships as $key => $value) {
261 if (!array_key_exists($value, $existingFinancialAccount)) {
262 if ($accountRelationship[$key] == 'Accounts Receivable Account is') {
263 $params['financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialAccount', 'Accounts Receivable', 'id', 'name');
264 if (!empty($params['financial_account_id'])) {
265 $titles[] = 'Accounts Receivable';
268 $query = "SELECT financial_account_id, name FROM civicrm_entity_financial_account
269 LEFT JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id
270 WHERE account_relationship = {$key} AND entity_table = 'civicrm_financial_type' LIMIT 1";
271 $dao = CRM_Core_DAO
::executeQuery($query);
273 $params['financial_account_id'] = $dao->financial_account_id
;
274 $titles[] = $dao->name
;
277 elseif ($accountRelationship[$key] == 'Income Account is' && empty($existingFinancialAccount)) {
278 $params['financial_account_id'] = $financialAccount->id
;
281 $query = "SELECT id, name FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = {$value}";
282 $dao = CRM_Core_DAO
::executeQuery($query);
284 $params['financial_account_id'] = $dao->id
;
285 $titles[] = $dao->name
;
289 $params['financial_account_id'] = $existingFinancialAccount[$value];
290 $titles[] = $financialType->name
;
292 $params['account_relationship'] = $key;
295 if (!empty($existingFinancialAccount)) {