3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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
36 class CRM_Financial_BAO_FinancialTypeAccount
extends CRM_Financial_DAO_EntityFinancialAccount
{
41 function __construct( ) {
42 parent
::__construct( );
50 private static $financialAccount;
53 * Takes a bunch of params that are needed to match certain criteria and
54 * retrieves the relevant objects. Typically the valid params are only
55 * contact_id. We'll tweak this function to be more full featured over a period
56 * of time. This is the inverse function of create. It also stores all the retrieved
57 * values in the default array
59 * @param array $params (reference ) an assoc array of name/value pairs
60 * @param array $defaults (reference ) an assoc array to hold the flattened values
62 * @param array $allValues
64 * @return object CRM_Contribute_BAO_ContributionType object
68 static function retrieve(&$params, &$defaults, &$allValues = array()) {
69 $financialTypeAccount = new CRM_Financial_DAO_EntityFinancialAccount();
70 $financialTypeAccount->copyValues($params);
71 $financialTypeAccount->find();
72 while ($financialTypeAccount->fetch()) {
73 CRM_Core_DAO
::storeValues($financialTypeAccount, $defaults);
74 $allValues[] = $defaults;
80 * function to add the financial types
82 * @param array $params reference array contains the values submitted by the form
83 * @param array $ids reference array contains the id
89 static function add(&$params, &$ids = NULL) {
90 // action is taken depending upon the mode
91 $financialTypeAccount = new CRM_Financial_DAO_EntityFinancialAccount();
92 if ($params['entity_table'] != 'civicrm_financial_type') {
93 $financialTypeAccount->entity_id
= $params['entity_id'];
94 $financialTypeAccount->entity_table
= $params['entity_table'];
95 $financialTypeAccount->find(TRUE);
98 $financialTypeAccount->id
= CRM_Utils_Array
::value('entityFinancialAccount', $ids);
100 if (!empty($ids['entityFinancialAccount'])) {
101 $financialTypeAccount->id
= $ids['entityFinancialAccount'];
103 $financialTypeAccount->copyValues($params);
104 $financialTypeAccount->save();
105 return $financialTypeAccount;
109 * Function to delete financial Types
111 * @param $financialTypeAccountId
112 * @param null $accountId
114 * @internal param int $contributionTypeId
117 static function del($financialTypeAccountId, $accountId = null) {
118 //checking if financial type is present
120 $relationValues = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
122 $financialTypeId = CRM_Core_DAO
::getFieldValue( 'CRM_Financial_DAO_EntityFinancialAccount', $financialTypeAccountId, 'entity_id' );
124 // FIXME more table containing financial_type_id to come
126 array('Contribute', 'Contribution'),
127 array('Contribute', 'ContributionPage'),
128 array('Member', 'MembershipType'),
129 array('Price', 'PriceFieldValue'),
130 array('Grant', 'Grant'),
131 array('Contribute', 'PremiumsProduct'),
132 array('Contribute', 'Product'),
133 array('Price', 'LineItem'),
136 foreach ($dependancy as $name) {
137 $daoString = 'CRM_' . $name[0] . '_DAO_' . $name[1];
138 $dao = new $daoString();
139 $dao->financial_type_id
= $financialTypeId;
140 if ($dao->find(true)) {
147 if ($name[1] == 'PremiumsProduct' ||
$name[1] == 'Product') {
148 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])));
151 $accountRelationShipId = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_EntityFinancialAccount', $financialTypeAccountId, 'account_relationship');
152 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');
154 return CRM_Utils_System
::redirect( CRM_Utils_System
::url( 'civicrm/admin/financial/financialType/accounts', "reset=1&action=browse&aid={$accountId}" ));
157 //delete from financial Type table
158 $financialType = new CRM_Financial_DAO_EntityFinancialAccount( );
159 $financialType->id
= $financialTypeAccountId;
160 $financialType->find(TRUE);
161 $financialType->delete();
162 CRM_Core_Session
::setStatus(ts('Unbalanced transactions may be created if you delete the account of type: %1.', array(1 => $relationValues[$financialType->account_relationship
])));
166 * Function to get Financial Account Name
168 * @param int $entityId
170 * @param string $entityTable
172 * @param string $columnName Column to fetch
174 * @return null|string
177 static function getFinancialAccount($entityId, $entityTable, $columnName = 'name') {
178 $join = $columnName == 'name' ?
'LEFT JOIN civicrm_financial_account ON civicrm_entity_financial_account.financial_account_id = civicrm_financial_account.id' : NULL;
181 FROM civicrm_entity_financial_account
183 WHERE entity_table = %1
187 1 => array($entityTable, 'String'),
188 2 => array($entityId, 'Integer'),
190 return CRM_Core_DAO
::singleValueQuery($query, $params);
194 * Function to financial Account for payment instrument
196 * @param int $paymentInstrumentValue payment instrument value
198 * @return array|null|string
201 static function getInstrumentFinancialAccount($paymentInstrumentValue = NULL) {
202 if (!self
::$financialAccount) {
203 $query = "SELECT ceft.financial_account_id, cov.value
204 FROM civicrm_entity_financial_account ceft
205 INNER JOIN civicrm_option_value cov ON cov.id = ceft.entity_id AND ceft.entity_table = 'civicrm_option_value'
206 INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id
207 WHERE cog.name = 'payment_instrument' ";
209 if ($paymentInstrumentValue) {
210 $query .= " AND cov.value = '{$paymentInstrumentValue}' ";
211 return CRM_Core_DAO
::singleValueQuery($query);
214 $result = CRM_Core_DAO
::executeQuery($query);
215 while ($result->fetch()) {
216 self
::$financialAccount[$result->value
] = $result->financial_account_id
;
218 return self
::$financialAccount;
222 return $paymentInstrumentValue ? self
::$financialAccount[$paymentInstrumentValue] : self
::$financialAccount;
226 * Function to create default entity financial accounts
230 * @param $financialType
233 * @internal param int $financialTypeId financial type id
237 static function createDefaultFinancialAccounts($financialType) {
239 $financialAccountTypeID = CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type');
240 $accountRelationship = CRM_Core_PseudoConstant
::accountOptionValues('account_relationship');
241 $relationships = array (
242 array_search('Accounts Receivable Account is', $accountRelationship) => array_search('Asset', $financialAccountTypeID),
243 array_search('Expense Account is', $accountRelationship) => array_search('Expenses', $financialAccountTypeID),
244 array_search('Cost of Sales Account is', $accountRelationship) => array_search('Cost of Sales', $financialAccountTypeID),
245 array_search('Income Account is', $accountRelationship) => array_search('Revenue', $financialAccountTypeID),
248 $dao = CRM_Core_DAO
::executeQuery('SELECT id, financial_account_type_id FROM civicrm_financial_account WHERE name LIKE %1',
249 array(1 => array($financialType->name
, 'String'))
252 $existingFinancialAccount = array();
255 'name' => $financialType->name
,
256 'contact_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', CRM_Core_Config
::domainID(), 'contact_id'),
257 'financial_account_type_id' => array_search('Revenue', $financialAccountTypeID),
258 'description' => $financialType->description
,
259 'account_type_code' => 'INC',
262 $financialAccount = CRM_Financial_BAO_FinancialAccount
::add($params, CRM_Core_DAO
::$_nullArray);
265 $existingFinancialAccount[$dao->financial_account_type_id
] = $dao->id
;
268 'entity_table' => 'civicrm_financial_type',
269 'entity_id' => $financialType->id
,
271 foreach ($relationships as $key => $value) {
272 if (!array_key_exists($value, $existingFinancialAccount)) {
273 if ($accountRelationship[$key] == 'Accounts Receivable Account is') {
274 $params['financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialAccount', 'Accounts Receivable', 'id', 'name');
275 if (!empty($params['financial_account_id'])) {
276 $titles[] = 'Accounts Receivable';
279 $query = "SELECT financial_account_id, name FROM civicrm_entity_financial_account
280 LEFT JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id
281 WHERE account_relationship = {$key} AND entity_table = 'civicrm_financial_type' LIMIT 1";
282 $dao = CRM_Core_DAO
::executeQuery($query);
284 $params['financial_account_id'] = $dao->financial_account_id
;
285 $titles[] = $dao->name
;
288 elseif ($accountRelationship[$key] == 'Income Account is' && empty($existingFinancialAccount)) {
289 $params['financial_account_id'] = $financialAccount->id
;
292 $query = "SELECT id, name FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = {$value}";
293 $dao = CRM_Core_DAO
::executeQuery($query);
295 $params['financial_account_id'] = $dao->id
;
296 $titles[] = $dao->name
;
300 $params['financial_account_id'] = $existingFinancialAccount[$value];
301 $titles[] = $financialType->name
;
303 $params['account_relationship'] = $key;
306 if (!empty($existingFinancialAccount)) {