3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 $financialAccountId = CRM_Utils_Request
::retrieve('_value', 'Positive', CRM_Core_DAO
::$_nullObject);
117 $financialAccountTypeId = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialAccount', $financialAccountId, 'financial_account_type_id');
118 $result = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
123 'name' => ts('- Select Financial Account Relationship -'),
128 $countResult = count($financialAccountType[$financialAccountTypeId]);
129 if (!empty($result)) {
130 foreach ($result as $id => $name) {
131 if (in_array($id, $financialAccountType[$financialAccountTypeId]) && $_GET['_value'] != 'select') {
132 if ($countResult != 1) {
142 'selected' => 'Selected',
146 elseif ($_GET['_value'] == 'select') {
154 CRM_Utils_JSON
::output($elements);
160 public static function jqFinancialType($config) {
161 if (!isset($_GET['_value']) ||
162 empty($_GET['_value'])
164 CRM_Utils_System
::civiExit();
166 $productId = CRM_Utils_Request
::retrieve('_value', 'Positive', CRM_Core_DAO
::$_nullObject);
167 $elements = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Product', $productId, 'financial_type_id');
168 CRM_Utils_JSON
::output($elements);
172 * Callback to perform action on batch records.
174 public static function assignRemove() {
175 $op = CRM_Utils_Type
::escape($_POST['op'], 'String');
176 $recordBAO = CRM_Utils_Type
::escape($_POST['recordBAO'], 'String');
177 foreach ($_POST['records'] as $record) {
178 $recordID = CRM_Utils_Type
::escape($record, 'Positive', FALSE);
180 $records[] = $recordID;
184 $entityID = CRM_Utils_Request
::retrieve('entityID', 'Positive', CRM_Core_DAO
::$_nullObject, FALSE, NULL, 'POST');
186 'assign' => 'addBatchEntity',
187 'remove' => 'removeBatchEntity',
188 'reopen' => 'create',
190 'delete' => 'deleteBatch',
192 if ($op == 'close') {
193 $totals = CRM_Batch_BAO_Batch
::batchTotals($records);
195 $response = array('status' => 'record-updated-fail');
196 // first munge and clean the recordBAO and get rid of any non alpha numeric characters
197 $recordBAO = CRM_Utils_String
::munge($recordBAO);
198 $recordClass = explode('_', $recordBAO);
199 // make sure recordClass is in the CRM namespace and
200 // at least 3 levels deep
201 if ($recordClass[0] == 'CRM' && count($recordClass) >= 3) {
202 foreach ($records as $recordID) {
208 $recordPID = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $recordID, 'payment_instrument_id');
209 $batchPID = CRM_Core_DAO
::getFieldValue('CRM_Batch_DAO_Batch', $entityID, 'payment_instrument_id');
210 $paymentInstrument = CRM_Core_PseudoConstant
::getLabel('CRM_Batch_BAO_Batch', 'payment_instrument_id', $batchPID);
211 if ($op == 'remove' ||
($recordPID == $batchPID && $op == 'assign') ||
!isset($batchPID)) {
213 'entity_id' => $recordID,
214 'entity_table' => 'civicrm_financial_trxn',
215 'batch_id' => $entityID,
219 $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)));
224 // Update totals when closing a batch
225 $params = $totals[$recordID];
227 $status = $op == 'close' ?
'Closed' : 'Reopened';
228 $ids['batchID'] = $recordID;
229 $batchStatus = CRM_Core_PseudoConstant
::get('CRM_Batch_DAO_Batch', 'status_id', array('labelColumn' => 'name'));
230 $params['status_id'] = CRM_Utils_Array
::key($status, $batchStatus);
231 $session = CRM_Core_Session
::singleton();
232 $params['modified_date'] = date('YmdHis');
233 $params['modified_id'] = $session->get('userID');
234 $params['id'] = $recordID;
235 $context = "financialBatch";
239 CRM_Utils_System
::redirect("civicrm/financial/batch/export?reset=1&id=$recordID");
244 $context = "financialBatch";
248 if (method_exists($recordBAO, $methods[$op]) & !empty($params)) {
249 if (isset($context)) {
250 $updated = call_user_func_array(array($recordBAO, $methods[$op]), array(&$params, $ids, $context));
253 $updated = call_user_func_array(array($recordBAO, $methods[$op]), array(&$params, $ids));
256 $response = array('status' => 'record-updated-success');
261 CRM_Utils_JSON
::output($response);
265 * Get output of financial transactions.
267 * @param bool $return
268 * Return result. This parameter allows the output to be unit tested.
272 public static function getFinancialTransactionsList($return = FALSE) {
279 5 => 'transaction_date',
280 6 => 'payment_method',
285 $sEcho = CRM_Utils_Type
::escape($_REQUEST['sEcho'], 'Integer');
286 $offset = isset($_REQUEST['iDisplayStart']) ? CRM_Utils_Type
::escape($_REQUEST['iDisplayStart'], 'Integer') : 0;
287 $rowCount = isset($_REQUEST['iDisplayLength']) ? CRM_Utils_Type
::escape($_REQUEST['iDisplayLength'], 'Integer') : 25;
288 $sort = isset($_REQUEST['iSortCol_0']) ? CRM_Utils_Array
::value(CRM_Utils_Type
::escape($_REQUEST['iSortCol_0'], 'Integer'), $sortMapper) : NULL;
289 $sortOrder = isset($_REQUEST['sSortDir_0']) ? CRM_Utils_Type
::escape($_REQUEST['sSortDir_0'], 'String') : 'asc';
290 $context = isset($_REQUEST['context']) ? CRM_Utils_Type
::escape($_REQUEST['context'], 'String') : NULL;
291 $entityID = isset($_REQUEST['entityID']) ? CRM_Utils_Type
::escape($_REQUEST['entityID'], 'String') : NULL;
292 $notPresent = isset($_REQUEST['notPresent']) ? CRM_Utils_Type
::escape($_REQUEST['notPresent'], 'String') : NULL;
293 $statusID = isset($_REQUEST['statusID']) ? CRM_Utils_Type
::escape($_REQUEST['statusID'], 'String') : NULL;
294 $search = isset($_REQUEST['search']) ?
TRUE : FALSE;
297 if ($sort && $sortOrder) {
298 $params['sortBy'] = $sort . ' ' . $sortOrder;
301 $returnvalues = array(
302 'civicrm_financial_trxn.payment_instrument_id as payment_method',
303 'civicrm_contribution.contact_id as contact_id',
304 'civicrm_contribution.id as contributionID',
305 'contact_a.sort_name',
306 'civicrm_financial_trxn.total_amount as amount',
307 'civicrm_financial_trxn.trxn_id as trxn_id',
308 'contact_a.contact_type',
309 'contact_a.contact_sub_type',
310 'civicrm_financial_trxn.trxn_date as transaction_date',
312 'civicrm_contribution.currency as currency',
313 'civicrm_financial_trxn.status_id as status',
314 'civicrm_financial_trxn.check_number as check_number',
317 $columnHeader = array(
318 'contact_type' => '',
319 'sort_name' => ts('Contact Name'),
320 'amount' => ts('Amount'),
321 'trxn_id' => ts('Trxn ID'),
322 'transaction_date' => ts('Received'),
323 'payment_method' => ts('Payment Method'),
324 'status' => ts('Status'),
325 'name' => ts('Type'),
328 if ($sort && $sortOrder) {
329 $params['sortBy'] = $sort . ' ' . $sortOrder;
332 $params['page'] = ($offset / $rowCount) +
1;
333 $params['rp'] = $rowCount;
335 $params['context'] = $context;
336 $params['offset'] = ($params['page'] - 1) * $params['rp'];
337 $params['rowCount'] = $params['rp'];
338 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
339 $params['total'] = 0;
342 if (isset($notPresent)) {
343 $financialItem = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues, $notPresent, $params);
345 $unassignedTransactions = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues, $notPresent, $params, TRUE);
348 $unassignedTransactions = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues, $notPresent, NULL, TRUE);
350 while ($unassignedTransactions->fetch()) {
351 $unassignedTransactionsCount[] = $unassignedTransactions->id
;
353 if (!empty($unassignedTransactionsCount)) {
354 $params['total'] = count($unassignedTransactionsCount);
359 $financialItem = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues, NULL, $params);
360 $assignedTransactions = CRM_Batch_BAO_Batch
::getBatchFinancialItems($entityID, $returnvalues);
361 while ($assignedTransactions->fetch()) {
362 $assignedTransactionsCount[] = $assignedTransactions->id
;
364 if (!empty($assignedTransactionsCount)) {
365 $params['total'] = count($assignedTransactionsCount);
368 $financialitems = array();
369 while ($financialItem->fetch()) {
370 $row[$financialItem->id
] = array();
371 foreach ($columnHeader as $columnKey => $columnValue) {
372 if ($financialItem->contact_sub_type
&& $columnKey == 'contact_type') {
373 $row[$financialItem->id
][$columnKey] = $financialItem->contact_sub_type
;
376 $row[$financialItem->id
][$columnKey] = $financialItem->$columnKey;
377 if ($columnKey == 'sort_name' && $financialItem->$columnKey) {
378 $url = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid=" . $financialItem->contact_id
);
379 $row[$financialItem->id
][$columnKey] = '<a href=' . $url . '>' . $financialItem->$columnKey . '</a>';
381 elseif ($columnKey == 'payment_method' && $financialItem->$columnKey) {
382 $row[$financialItem->id
][$columnKey] = CRM_Core_PseudoConstant
::getLabel('CRM_Batch_BAO_Batch', 'payment_instrument_id', $financialItem->$columnKey);
383 if ($row[$financialItem->id
][$columnKey] == 'Check') {
384 $checkNumber = $financialItem->check_number ?
' (' . $financialItem->check_number
. ')' : '';
385 $row[$financialItem->id
][$columnKey] = $row[$financialItem->id
][$columnKey] . $checkNumber;
388 elseif ($columnKey == 'amount' && $financialItem->$columnKey) {
389 $row[$financialItem->id
][$columnKey] = CRM_Utils_Money
::format($financialItem->$columnKey, $financialItem->currency
);
391 elseif ($columnKey == 'transaction_date' && $financialItem->$columnKey) {
392 $row[$financialItem->id
][$columnKey] = CRM_Utils_Date
::customFormat($financialItem->$columnKey);
394 elseif ($columnKey == 'status' && $financialItem->$columnKey) {
395 $row[$financialItem->id
][$columnKey] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $financialItem->$columnKey);
398 if ($statusID == CRM_Core_OptionGroup
::getValue('batch_status', 'Open')) {
399 if (isset($notPresent)) {
400 $js = "enableActions('x')";
401 $row[$financialItem->id
]['check'] = "<input type='checkbox' id='mark_x_" . $financialItem->id
. "' name='mark_x_" . $financialItem->id
. "' value='1' onclick={$js}></input>";
402 $row[$financialItem->id
]['action'] = CRM_Core_Action
::formLink(
403 CRM_Financial_Form_BatchTransaction
::links(),
406 'id' => $financialItem->id
,
407 'contid' => $financialItem->contributionID
,
408 'cid' => $financialItem->contact_id
,
412 'financialItem.batch.row',
418 $js = "enableActions('y')";
419 $row[$financialItem->id
]['check'] = "<input type='checkbox' id='mark_y_" . $financialItem->id
. "' name='mark_y_" . $financialItem->id
. "' value='1' onclick={$js}></input>";
420 $row[$financialItem->id
]['action'] = CRM_Core_Action
::formLink(
421 CRM_Financial_Page_BatchTransaction
::links(),
424 'id' => $financialItem->id
,
425 'contid' => $financialItem->contributionID
,
426 'cid' => $financialItem->contact_id
,
430 'financialItem.batch.row',
437 $row[$financialItem->id
]['check'] = NULL;
438 $tempBAO = new CRM_Financial_Page_BatchTransaction();
439 $links = $tempBAO->links();
440 unset($links['remove']);
441 $row[$financialItem->id
]['action'] = CRM_Core_Action
::formLink(
445 'id' => $financialItem->id
,
446 'contid' => $financialItem->contributionID
,
447 'cid' => $financialItem->contact_id
,
451 'financialItem.batch.row',
456 $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
);
457 $financialitems = $row;
460 $iFilteredTotal = $iTotal = $params['total'];
461 $selectorElements = array(
475 return CRM_Utils_JSON
::encodeDataTableSelector($financialitems, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
477 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/json');
478 echo CRM_Utils_JSON
::encodeDataTableSelector($financialitems, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
479 CRM_Utils_System
::civiExit();
482 public static function bulkAssignRemove() {
483 $checkIDs = $_REQUEST['ID'];
484 $entityID = CRM_Utils_Type
::escape($_REQUEST['entityID'], 'String');
485 $action = CRM_Utils_Type
::escape($_REQUEST['action'], 'String');
486 foreach ($checkIDs as $key => $value) {
487 if ((substr($value, 0, 7) == "mark_x_" && $action == 'Assign') ||
(substr($value, 0, 7) == "mark_y_" && $action == 'Remove')) {
488 $contributions = explode("_", $value);
489 $cIDs[] = $contributions[2];
493 $batchPID = CRM_Core_DAO
::getFieldValue('CRM_Batch_DAO_Batch', $entityID, 'payment_instrument_id');
494 $paymentInstrument = CRM_Core_OptionGroup
::getLabel('payment_instrument', $batchPID);
495 foreach ($cIDs as $key => $value) {
496 $recordPID = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $value, 'payment_instrument_id');
497 if ($action == 'Remove' ||
($recordPID == $batchPID && $action == 'Assign') ||
!isset($batchPID)) {
499 'entity_id' => $value,
500 'entity_table' => 'civicrm_financial_trxn',
501 'batch_id' => $entityID,
503 if ($action == 'Assign') {
504 $updated = CRM_Batch_BAO_Batch
::addBatchEntity($params);
507 $updated = CRM_Batch_BAO_Batch
::removeBatchEntity($params);
512 $status = array('status' => 'record-updated-success');
515 $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)));
517 CRM_Utils_JSON
::output($status);
520 public static function getBatchSummary() {
521 $batchID = CRM_Utils_Type
::escape($_REQUEST['batchID'], 'String');
522 $params = array('id' => $batchID);
523 $batchInfo = CRM_Batch_BAO_Batch
::retrieve($params, $value);
524 $batchTotals = CRM_Batch_BAO_Batch
::batchTotals(array($batchID));
525 $batchSummary = array(
526 'created_by' => CRM_Contact_BAO_Contact
::displayName($batchInfo->created_id
),
527 'status' => CRM_Core_OptionGroup
::getLabel('batch_status', $batchInfo->status_id
),
528 'description' => $batchInfo->description
,
529 'payment_instrument' => CRM_Core_OptionGroup
::getLabel('payment_instrument', $batchInfo->payment_instrument_id
),
530 'item_count' => $batchInfo->item_count
,
531 'assigned_item_count' => $batchTotals[$batchID]['item_count'],
532 'total' => CRM_Utils_Money
::format($batchInfo->total
),
533 'assigned_total' => CRM_Utils_Money
::format($batchTotals[$batchID]['total']),
534 'opened_date' => CRM_Utils_Date
::customFormat($batchInfo->created_date
),
537 CRM_Utils_JSON
::output($batchSummary);