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
37 * This class contains all the function that are called using AJAX
39 class CRM_Financial_Page_AJAX
{
42 * get financial accounts of required account relationship
43 * $financialAccountType array with key account relationship and value financial account type option groups
47 public static function jqFinancial($config) {
48 if (!isset($_GET['_value']) ||
49 empty($_GET['_value'])
51 CRM_Utils_System
::civiExit();
54 if ($_GET['_value'] == 'select') {
55 $result = CRM_Contribute_PseudoConstant
::financialAccount();
58 $financialAccountType = array(
60 '3' => 1, //AR relation
63 '7' => 4, //cost of sales
64 '8' => 1, //premium inventory
65 '9' => 3, //discount account is
66 '10' => 2, //sales tax liability
68 $financialAccountType = CRM_Utils_Array
::value($_GET['_value'], $financialAccountType);
69 $result = CRM_Contribute_PseudoConstant
::financialAccount(NULL, $financialAccountType);
70 if ($financialAccountType) {
71 $defaultId = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = $financialAccountType");
76 'name' => ts('- select -'),
81 if (!empty($result)) {
82 foreach ($result as $id => $name) {
83 $selectedArray = array();
84 if ($id == $defaultId) {
85 $selectedArray['selected'] = 'Selected';
93 CRM_Utils_JSON
::output($elements);
99 public static function jqFinancialRelation($config) {
100 if (!isset($_GET['_value']) ||
101 empty($_GET['_value'])
103 CRM_Utils_System
::civiExit();
106 if ($_GET['_value'] == 'select') {
107 $result = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
110 $financialAccountType = array(
111 '5' => array(5), //expense
112 '1' => array(3, 6, 8), //Asset
113 '3' => array(1, 9), //revenue
114 '4' => array(7), //cost of sales
116 $financialAccountTypeId = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialAccount', $_GET['_value'], 'financial_account_type_id');
117 $result = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
122 'name' => ts('- Select Financial Account Relationship -'),
127 $countResult = count($financialAccountType[$financialAccountTypeId]);
128 if (!empty($result)) {
129 foreach ($result as $id => $name) {
130 if (in_array($id, $financialAccountType[$financialAccountTypeId]) && $_GET['_value'] != 'select') {
131 if ($countResult != 1) {
141 'selected' => 'Selected',
145 elseif ($_GET['_value'] == 'select') {
153 CRM_Utils_JSON
::output($elements);
159 public static function jqFinancialType($config) {
160 if (!isset($_GET['_value']) ||
161 empty($_GET['_value'])
163 CRM_Utils_System
::civiExit();
166 $elements = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Product', $_GET['_value'], 'financial_type_id');
167 CRM_Utils_JSON
::output($elements);
171 * Callback to perform action on batch records.
173 public static function assignRemove() {
174 $op = CRM_Utils_Type
::escape($_POST['op'], 'String');
175 $recordBAO = CRM_Utils_Type
::escape($_POST['recordBAO'], 'String');
176 foreach ($_POST['records'] as $record) {
177 $recordID = CRM_Utils_Type
::escape($record, 'Positive', FALSE);
179 $records[] = $recordID;
183 $entityID = CRM_Utils_Array
::value('entityID', $_POST);
185 'assign' => 'addBatchEntity',
186 'remove' => 'removeBatchEntity',
187 'reopen' => 'create',
189 'delete' => 'deleteBatch',
191 if ($op == 'close') {
192 $totals = CRM_Batch_BAO_Batch
::batchTotals($records);
194 $response = array('status' => 'record-updated-fail');
195 // first munge and clean the recordBAO and get rid of any non alpha numeric characters
196 $recordBAO = CRM_Utils_String
::munge($recordBAO);
197 $recordClass = explode('_', $recordBAO);
198 // make sure recordClass is in the CRM namespace and
199 // at least 3 levels deep
200 if ($recordClass[0] == 'CRM' && count($recordClass) >= 3) {
201 foreach ($records as $recordID) {
207 $recordPID = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $recordID, 'payment_instrument_id');
208 $batchPID = CRM_Core_DAO
::getFieldValue('CRM_Batch_DAO_Batch', $entityID, 'payment_instrument_id');
209 $paymentInstrument = CRM_Core_OptionGroup
::getLabel('payment_instrument', $batchPID);
210 if ($op == 'remove' ||
($recordPID == $batchPID && $op == 'assign') ||
!isset($batchPID)) {
212 'entity_id' => $recordID,
213 'entity_table' => 'civicrm_financial_trxn',
214 'batch_id' => $entityID,
218 $response = array('status' => ts("This batch is configured to include only transactions using %1 payment method. If you want to include other transactions, please edit the batch first and modify the Payment Method.", array(1 => $paymentInstrument)));
223 // Update totals when closing a batch
224 $params = $totals[$recordID];
226 $status = $op == 'close' ?
'Closed' : 'Reopened';
227 $ids['batchID'] = $recordID;
228 $batchStatus = CRM_Core_PseudoConstant
::get('CRM_Batch_DAO_Batch', 'status_id', array('labelColumn' => 'name'));
229 $params['status_id'] = CRM_Utils_Array
::key($status, $batchStatus);
230 $session = CRM_Core_Session
::singleton();
231 $params['modified_date'] = date('YmdHis');
232 $params['modified_id'] = $session->get('userID');
233 $params['id'] = $recordID;
234 $context = "financialBatch";
238 CRM_Utils_System
::redirect("civicrm/financial/batch/export?reset=1&id=$recordID");
243 $context = "financialBatch";
247 if (method_exists($recordBAO, $methods[$op]) & !empty($params)) {
248 if (isset($context)) {
249 $updated = call_user_func_array(array($recordBAO, $methods[$op]), array(&$params, $ids, $context));
252 $updated = call_user_func_array(array($recordBAO, $methods[$op]), array(&$params, $ids));
255 $response = array('status' => 'record-updated-success');
260 CRM_Utils_JSON
::output($response);
263 public static function getFinancialTransactionsList() {
270 5 => 'transaction_date',
271 6 => 'payment_method',
276 $sEcho = CRM_Utils_Type
::escape($_REQUEST['sEcho'], 'Integer');
277 $offset = isset($_REQUEST['iDisplayStart']) ? CRM_Utils_Type
::escape($_REQUEST['iDisplayStart'], 'Integer') : 0;
278 $rowCount = isset($_REQUEST['iDisplayLength']) ? CRM_Utils_Type
::escape($_REQUEST['iDisplayLength'], 'Integer') : 25;
279 $sort = isset($_REQUEST['iSortCol_0']) ? CRM_Utils_Array
::value(CRM_Utils_Type
::escape($_REQUEST['iSortCol_0'], 'Integer'), $sortMapper) : NULL;
280 $sortOrder = isset($_REQUEST['sSortDir_0']) ? CRM_Utils_Type
::escape($_REQUEST['sSortDir_0'], 'String') : 'asc';
281 $context = isset($_REQUEST['context']) ? CRM_Utils_Type
::escape($_REQUEST['context'], 'String') : NULL;
282 $entityID = isset($_REQUEST['entityID']) ? CRM_Utils_Type
::escape($_REQUEST['entityID'], 'String') : NULL;
283 $notPresent = isset($_REQUEST['notPresent']) ? CRM_Utils_Type
::escape($_REQUEST['notPresent'], 'String') : NULL;
284 $statusID = isset($_REQUEST['statusID']) ? CRM_Utils_Type
::escape($_REQUEST['statusID'], 'String') : NULL;
285 $search = isset($_REQUEST['search']) ?
TRUE : FALSE;
288 if ($sort && $sortOrder) {
289 $params['sortBy'] = $sort . ' ' . $sortOrder;
292 $returnvalues = array(
293 'civicrm_financial_trxn.payment_instrument_id as payment_method',
294 'civicrm_contribution.contact_id as contact_id',
295 'civicrm_contribution.id as contributionID',
296 'contact_a.sort_name',
297 'civicrm_financial_trxn.total_amount as amount',
298 'civicrm_financial_trxn.trxn_id as trxn_id',
299 'contact_a.contact_type',
300 'contact_a.contact_sub_type',
301 'civicrm_financial_trxn.trxn_date as transaction_date',
303 'civicrm_contribution.currency as currency',
304 'civicrm_financial_trxn.status_id as status',
305 'civicrm_financial_trxn.check_number as check_number',
308 $columnHeader = array(
309 'contact_type' => '',
310 'sort_name' => ts('Contact Name'),
311 'amount' => ts('Amount'),
312 'trxn_id' => ts('Trxn ID'),
313 'transaction_date' => ts('Received'),
314 'payment_method' => ts('Payment Method'),
315 'status' => ts('Status'),
316 'name' => ts('Type'),
319 if ($sort && $sortOrder) {
320 $params['sortBy'] = $sort . ' ' . $sortOrder;
323 $params['page'] = ($offset / $rowCount) +
1;
324 $params['rp'] = $rowCount;
326 $params['context'] = $context;
327 $params['offset'] = ($params['page'] - 1) * $params['rp'];
328 $params['rowCount'] = $params['rp'];
329 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
330 $params['total'] = 0;
333 if (isset($notPresent)) {
334 $financialItem = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues, $notPresent, $params);
336 $unassignedTransactions = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues, $notPresent, $params, TRUE);
339 $unassignedTransactions = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues, $notPresent, NULL, TRUE);
341 while ($unassignedTransactions->fetch()) {
342 $unassignedTransactionsCount[] = $unassignedTransactions->id
;
344 if (!empty($unassignedTransactionsCount)) {
345 $params['total'] = count($unassignedTransactionsCount);
350 $financialItem = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues, NULL, $params);
351 $assignedTransactions = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues);
352 while ($assignedTransactions->fetch()) {
353 $assignedTransactionsCount[] = $assignedTransactions->id
;
355 if (!empty($assignedTransactionsCount)) {
356 $params['total'] = count($assignedTransactionsCount);
359 $financialitems = array();
360 while ($financialItem->fetch()) {
361 $row[$financialItem->id
] = array();
362 foreach ($columnHeader as $columnKey => $columnValue) {
363 if ($financialItem->contact_sub_type
&& $columnKey == 'contact_type') {
364 $row[$financialItem->id
][$columnKey] = $financialItem->contact_sub_type
;
367 $row[$financialItem->id
][$columnKey] = $financialItem->$columnKey;
368 if ($columnKey == 'sort_name' && $financialItem->$columnKey) {
369 $url = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid=" . $financialItem->contact_id
);
370 $row[$financialItem->id
][$columnKey] = '<a href=' . $url . '>' . $financialItem->$columnKey . '</a>';
372 elseif ($columnKey == 'payment_method' && $financialItem->$columnKey) {
373 $row[$financialItem->id
][$columnKey] = CRM_Core_OptionGroup
::getLabel('payment_instrument', $financialItem->$columnKey);
374 if ($row[$financialItem->id
][$columnKey] == 'Check') {
375 $row[$financialItem->id
][$columnKey] = $row[$financialItem->id
][$columnKey] . ' (' . $financialItem->check_number
. ')';
378 elseif ($columnKey == 'amount' && $financialItem->$columnKey) {
379 $row[$financialItem->id
][$columnKey] = CRM_Utils_Money
::format($financialItem->$columnKey, $financialItem->currency
);
381 elseif ($columnKey == 'transaction_date' && $financialItem->$columnKey) {
382 $row[$financialItem->id
][$columnKey] = CRM_Utils_Date
::customFormat($financialItem->$columnKey);
384 elseif ($columnKey == 'status' && $financialItem->$columnKey) {
385 $row[$financialItem->id
][$columnKey] = CRM_Core_OptionGroup
::getLabel('contribution_status', $financialItem->$columnKey);
388 if ($statusID == CRM_Core_OptionGroup
::getValue('batch_status', 'Open')) {
389 if (isset($notPresent)) {
390 $js = "enableActions('x')";
391 $row[$financialItem->id
]['check'] = "<input type='checkbox' id='mark_x_" . $financialItem->id
. "' name='mark_x_" . $financialItem->id
. "' value='1' onclick={$js}></input>";
392 $row[$financialItem->id
]['action'] = CRM_Core_Action
::formLink(
393 CRM_Financial_Form_BatchTransaction
::links(),
396 'id' => $financialItem->id
,
397 'contid' => $financialItem->contributionID
,
398 'cid' => $financialItem->contact_id
,
402 'financialItem.batch.row',
408 $js = "enableActions('y')";
409 $row[$financialItem->id
]['check'] = "<input type='checkbox' id='mark_y_" . $financialItem->id
. "' name='mark_y_" . $financialItem->id
. "' value='1' onclick={$js}></input>";
410 $row[$financialItem->id
]['action'] = CRM_Core_Action
::formLink(
411 CRM_Financial_Page_BatchTransaction
::links(),
414 'id' => $financialItem->id
,
415 'contid' => $financialItem->contributionID
,
416 'cid' => $financialItem->contact_id
,
420 'financialItem.batch.row',
427 $row[$financialItem->id
]['check'] = NULL;
428 $links = CRM_Financial_Page_BatchTransaction
::links();
429 unset($links['remove']);
430 $row[$financialItem->id
]['action'] = CRM_Core_Action
::formLink(
434 'id' => $financialItem->id
,
435 'contid' => $financialItem->contributionID
,
436 'cid' => $financialItem->contact_id
,
440 'financialItem.batch.row',
445 $row[$financialItem->id
]['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage(CRM_Utils_Array
::value('contact_sub_type', $row[$financialItem->id
]) ? CRM_Utils_Array
::value('contact_sub_type', $row[$financialItem->id
]) : CRM_Utils_Array
::value('contact_type', $row[$financialItem->id
]), FALSE, $financialItem->contact_id
);
446 $financialitems = $row;
449 $iFilteredTotal = $iTotal = $params['total'];
450 $selectorElements = array(
463 echo CRM_Utils_JSON
::encodeDataTableSelector($financialitems, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
464 CRM_Utils_System
::civiExit();
467 public static function bulkAssignRemove() {
468 $checkIDs = $_REQUEST['ID'];
469 $entityID = CRM_Utils_Type
::escape($_REQUEST['entityID'], 'String');
470 $action = CRM_Utils_Type
::escape($_REQUEST['action'], 'String');
471 foreach ($checkIDs as $key => $value) {
472 if ((substr($value, 0, 7) == "mark_x_" && $action == 'Assign') ||
(substr($value, 0, 7) == "mark_y_" && $action == 'Remove')) {
473 $contributions = explode("_", $value);
474 $cIDs[] = $contributions[2];
478 $batchPID = CRM_Core_DAO
::getFieldValue('CRM_Batch_DAO_Batch', $entityID, 'payment_instrument_id');
479 $paymentInstrument = CRM_Core_OptionGroup
::getLabel('payment_instrument', $batchPID);
480 foreach ($cIDs as $key => $value) {
481 $recordPID = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $value, 'payment_instrument_id');
482 if ($action == 'Remove' ||
($recordPID == $batchPID && $action == 'Assign') ||
!isset($batchPID)) {
484 'entity_id' => $value,
485 'entity_table' => 'civicrm_financial_trxn',
486 'batch_id' => $entityID,
488 if ($action == 'Assign') {
489 $updated = CRM_Batch_BAO_Batch
::addBatchEntity($params);
492 $updated = CRM_Batch_BAO_Batch
::removeBatchEntity($params);
497 $status = array('status' => 'record-updated-success');
500 $status = array('status' => ts("This batch is configured to include only transactions using %1 payment method. If you want to include other transactions, please edit the batch first and modify the Payment Method.", array(1 => $paymentInstrument)));
502 CRM_Utils_JSON
::output($status);
505 public static function getBatchSummary() {
506 $batchID = CRM_Utils_Type
::escape($_REQUEST['batchID'], 'String');
507 $params = array('id' => $batchID);
508 $batchInfo = CRM_Batch_BAO_Batch
::retrieve($params, $value);
509 $batchTotals = CRM_Batch_BAO_Batch
::batchTotals(array($batchID));
510 $batchSummary = array(
511 'created_by' => CRM_Contact_BAO_Contact
::displayName($batchInfo->created_id
),
512 'status' => CRM_Core_OptionGroup
::getLabel('batch_status', $batchInfo->status_id
),
513 'description' => $batchInfo->description
,
514 'payment_instrument' => CRM_Core_OptionGroup
::getLabel('payment_instrument', $batchInfo->payment_instrument_id
),
515 'item_count' => $batchInfo->item_count
,
516 'assigned_item_count' => $batchTotals[$batchID]['item_count'],
517 'total' => CRM_Utils_Money
::format($batchInfo->total
),
518 'assigned_total' => CRM_Utils_Money
::format($batchTotals[$batchID]['total']),
519 'opened_date' => CRM_Utils_Date
::customFormat($batchInfo->created_date
),
522 CRM_Utils_JSON
::output($batchSummary);