Merge remote-tracking branch 'upstream/4.6' into 4.6-master-2015-09-15-10-14-22
[civicrm-core.git] / CRM / Financial / Page / AJAX.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2015
32 * $Id$
33 *
34 */
35
36 /**
37 * This class contains all the function that are called using AJAX
38 */
39 class CRM_Financial_Page_AJAX {
40
41 /**
42 * get financial accounts of required account relationship.
43 * $financialAccountType array with key account relationship and value financial account type option groups
44 *
45 * @param $config
46 */
47 public static function jqFinancial($config) {
48 if (!isset($_GET['_value']) ||
49 empty($_GET['_value'])
50 ) {
51 CRM_Utils_System::civiExit();
52 }
53 $defaultId = NULL;
54 if ($_GET['_value'] == 'select') {
55 $result = CRM_Contribute_PseudoConstant::financialAccount();
56 }
57 else {
58 $financialAccountType = array(
59 '5' => 5, //expense
60 '3' => 1, //AR relation
61 '1' => 3, //revenue
62 '6' => 1, // asset
63 '7' => 4, //cost of sales
64 '8' => 1, //premium inventory
65 '9' => 3, //discount account is
66 '10' => 2, //sales tax liability
67 );
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");
72 }
73 }
74 $elements = array(
75 array(
76 'name' => ts('- select -'),
77 'value' => 'select',
78 ),
79 );
80
81 if (!empty($result)) {
82 foreach ($result as $id => $name) {
83 $selectedArray = array();
84 if ($id == $defaultId) {
85 $selectedArray['selected'] = 'Selected';
86 }
87 $elements[] = array(
88 'name' => $name,
89 'value' => $id,
90 ) + $selectedArray;
91 }
92 }
93 CRM_Utils_JSON::output($elements);
94 }
95
96 /**
97 * @param $config
98 */
99 public static function jqFinancialRelation($config) {
100 if (!isset($_GET['_value']) ||
101 empty($_GET['_value'])
102 ) {
103 CRM_Utils_System::civiExit();
104 }
105
106 if ($_GET['_value'] == 'select') {
107 $result = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
108 }
109 else {
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
115 );
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');
119 }
120
121 $elements = array(
122 array(
123 'name' => ts('- Select Financial Account Relationship -'),
124 'value' => 'select',
125 ),
126 );
127
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) {
133 $elements[] = array(
134 'name' => $name,
135 'value' => $id,
136 );
137 }
138 else {
139 $elements[] = array(
140 'name' => $name,
141 'value' => $id,
142 'selected' => 'Selected',
143 );
144 }
145 }
146 elseif ($_GET['_value'] == 'select') {
147 $elements[] = array(
148 'name' => $name,
149 'value' => $id,
150 );
151 }
152 }
153 }
154 CRM_Utils_JSON::output($elements);
155 }
156
157 /**
158 * @param $config
159 */
160 public static function jqFinancialType($config) {
161 if (!isset($_GET['_value']) ||
162 empty($_GET['_value'])
163 ) {
164 CRM_Utils_System::civiExit();
165 }
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);
169 }
170
171 /**
172 * Callback to perform action on batch records.
173 */
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);
179 if ($recordID) {
180 $records[] = $recordID;
181 }
182 }
183
184 $entityID = CRM_Utils_Request::retrieve('entityID', 'Positive', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'POST');
185 $methods = array(
186 'assign' => 'addBatchEntity',
187 'remove' => 'removeBatchEntity',
188 'reopen' => 'create',
189 'close' => 'create',
190 'delete' => 'deleteBatch',
191 );
192 if ($op == 'close') {
193 $totals = CRM_Batch_BAO_Batch::batchTotals($records);
194 }
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) {
203 $params = array();
204 $ids = NULL;
205 switch ($op) {
206 case 'assign':
207 case 'remove':
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)) {
212 $params = array(
213 'entity_id' => $recordID,
214 'entity_table' => 'civicrm_financial_trxn',
215 'batch_id' => $entityID,
216 );
217 }
218 else {
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)));
220 }
221 break;
222
223 case 'close':
224 // Update totals when closing a batch
225 $params = $totals[$recordID];
226 case 'reopen':
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";
236 break;
237
238 case 'export':
239 CRM_Utils_System::redirect("civicrm/financial/batch/export?reset=1&id=$recordID");
240 break;
241
242 case 'delete':
243 $params = $recordID;
244 $context = "financialBatch";
245 break;
246 }
247
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));
251 }
252 else {
253 $updated = call_user_func_array(array($recordBAO, $methods[$op]), array(&$params, $ids));
254 }
255 if ($updated) {
256 $response = array('status' => 'record-updated-success');
257 }
258 }
259 }
260 }
261 CRM_Utils_JSON::output($response);
262 }
263
264 /**
265 * Get output of financial transactions.
266 *
267 * @param bool $return
268 * Return result. This parameter allows the output to be unit tested.
269 *
270 * @return string
271 */
272 public static function getFinancialTransactionsList($return = FALSE) {
273 $sortMapper = array(
274 0 => '',
275 1 => '',
276 2 => 'sort_name',
277 3 => 'amount',
278 4 => 'trxn_id',
279 5 => 'transaction_date',
280 6 => 'payment_method',
281 7 => 'status',
282 8 => 'name',
283 );
284
285 $sEcho = CRM_Utils_Type::escape($_REQUEST['sEcho'], 'Integer');
286 $return = isset($_REQUEST['return']) ? CRM_Utils_Type::escape($_REQUEST['return'], 'Boolean') : FALSE;
287 $offset = isset($_REQUEST['iDisplayStart']) ? CRM_Utils_Type::escape($_REQUEST['iDisplayStart'], 'Integer') : 0;
288 $rowCount = isset($_REQUEST['iDisplayLength']) ? CRM_Utils_Type::escape($_REQUEST['iDisplayLength'], 'Integer') : 25;
289 $sort = isset($_REQUEST['iSortCol_0']) ? CRM_Utils_Array::value(CRM_Utils_Type::escape($_REQUEST['iSortCol_0'], 'Integer'), $sortMapper) : NULL;
290 $sortOrder = isset($_REQUEST['sSortDir_0']) ? CRM_Utils_Type::escape($_REQUEST['sSortDir_0'], 'String') : 'asc';
291 $context = isset($_REQUEST['context']) ? CRM_Utils_Type::escape($_REQUEST['context'], 'String') : NULL;
292 $entityID = isset($_REQUEST['entityID']) ? CRM_Utils_Type::escape($_REQUEST['entityID'], 'String') : NULL;
293 $notPresent = isset($_REQUEST['notPresent']) ? CRM_Utils_Type::escape($_REQUEST['notPresent'], 'String') : NULL;
294 $statusID = isset($_REQUEST['statusID']) ? CRM_Utils_Type::escape($_REQUEST['statusID'], 'String') : NULL;
295 $search = isset($_REQUEST['search']) ? TRUE : FALSE;
296
297 $params = $_POST;
298 if ($sort && $sortOrder) {
299 $params['sortBy'] = $sort . ' ' . $sortOrder;
300 }
301
302 $returnvalues = array(
303 'civicrm_financial_trxn.payment_instrument_id as payment_method',
304 'civicrm_contribution.contact_id as contact_id',
305 'civicrm_contribution.id as contributionID',
306 'contact_a.sort_name',
307 'civicrm_financial_trxn.total_amount as amount',
308 'civicrm_financial_trxn.trxn_id as trxn_id',
309 'contact_a.contact_type',
310 'contact_a.contact_sub_type',
311 'civicrm_financial_trxn.trxn_date as transaction_date',
312 'name',
313 'civicrm_contribution.currency as currency',
314 'civicrm_financial_trxn.status_id as status',
315 'civicrm_financial_trxn.check_number as check_number',
316 );
317
318 $columnHeader = array(
319 'contact_type' => '',
320 'sort_name' => ts('Contact Name'),
321 'amount' => ts('Amount'),
322 'trxn_id' => ts('Trxn ID'),
323 'transaction_date' => ts('Received'),
324 'payment_method' => ts('Payment Method'),
325 'status' => ts('Status'),
326 'name' => ts('Type'),
327 );
328
329 if ($sort && $sortOrder) {
330 $params['sortBy'] = $sort . ' ' . $sortOrder;
331 }
332
333 $params['page'] = ($offset / $rowCount) + 1;
334 $params['rp'] = $rowCount;
335
336 $params['context'] = $context;
337 $params['offset'] = ($params['page'] - 1) * $params['rp'];
338 $params['rowCount'] = $params['rp'];
339 $params['sort'] = CRM_Utils_Array::value('sortBy', $params);
340 $params['total'] = 0;
341
342 // get batch list
343 if (isset($notPresent)) {
344 $financialItem = CRM_Batch_BAO_Batch::getBatchFinancialItems($entityID, $returnvalues, $notPresent, $params);
345 if ($search) {
346 $unassignedTransactions = CRM_Batch_BAO_Batch::getBatchFinancialItems($entityID, $returnvalues, $notPresent, $params, TRUE);
347 }
348 else {
349 $unassignedTransactions = CRM_Batch_BAO_Batch::getBatchFinancialItems($entityID, $returnvalues, $notPresent, NULL, TRUE);
350 }
351 while ($unassignedTransactions->fetch()) {
352 $unassignedTransactionsCount[] = $unassignedTransactions->id;
353 }
354 if (!empty($unassignedTransactionsCount)) {
355 $params['total'] = count($unassignedTransactionsCount);
356 }
357
358 }
359 else {
360 $financialItem = CRM_Batch_BAO_Batch::getBatchFinancialItems($entityID, $returnvalues, NULL, $params);
361 $assignedTransactions = CRM_Batch_BAO_Batch::getBatchFinancialItems($entityID, $returnvalues);
362 while ($assignedTransactions->fetch()) {
363 $assignedTransactionsCount[] = $assignedTransactions->id;
364 }
365 if (!empty($assignedTransactionsCount)) {
366 $params['total'] = count($assignedTransactionsCount);
367 }
368 }
369 $financialitems = array();
370 while ($financialItem->fetch()) {
371 $row[$financialItem->id] = array();
372 foreach ($columnHeader as $columnKey => $columnValue) {
373 if ($financialItem->contact_sub_type && $columnKey == 'contact_type') {
374 $row[$financialItem->id][$columnKey] = $financialItem->contact_sub_type;
375 continue;
376 }
377 $row[$financialItem->id][$columnKey] = $financialItem->$columnKey;
378 if ($columnKey == 'sort_name' && $financialItem->$columnKey) {
379 $url = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid=" . $financialItem->contact_id);
380 $row[$financialItem->id][$columnKey] = '<a href=' . $url . '>' . $financialItem->$columnKey . '</a>';
381 }
382 elseif ($columnKey == 'payment_method' && $financialItem->$columnKey) {
383 $row[$financialItem->id][$columnKey] = CRM_Core_PseudoConstant::getLabel('CRM_Batch_BAO_Batch', 'payment_instrument_id', $financialItem->$columnKey);
384 if ($row[$financialItem->id][$columnKey] == 'Check') {
385 $checkNumber = $financialItem->check_number ? ' (' . $financialItem->check_number . ')' : '';
386 $row[$financialItem->id][$columnKey] = $row[$financialItem->id][$columnKey] . $checkNumber;
387 }
388 }
389 elseif ($columnKey == 'amount' && $financialItem->$columnKey) {
390 $row[$financialItem->id][$columnKey] = CRM_Utils_Money::format($financialItem->$columnKey, $financialItem->currency);
391 }
392 elseif ($columnKey == 'transaction_date' && $financialItem->$columnKey) {
393 $row[$financialItem->id][$columnKey] = CRM_Utils_Date::customFormat($financialItem->$columnKey);
394 }
395 elseif ($columnKey == 'status' && $financialItem->$columnKey) {
396 $row[$financialItem->id][$columnKey] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $financialItem->$columnKey);
397 }
398 }
399 if ($statusID == CRM_Core_OptionGroup::getValue('batch_status', 'Open')) {
400 if (isset($notPresent)) {
401 $js = "enableActions('x')";
402 $row[$financialItem->id]['check'] = "<input type='checkbox' id='mark_x_" . $financialItem->id . "' name='mark_x_" . $financialItem->id . "' value='1' onclick={$js}></input>";
403 $row[$financialItem->id]['action'] = CRM_Core_Action::formLink(
404 CRM_Financial_Form_BatchTransaction::links(),
405 NULL,
406 array(
407 'id' => $financialItem->id,
408 'contid' => $financialItem->contributionID,
409 'cid' => $financialItem->contact_id,
410 ),
411 ts('more'),
412 FALSE,
413 'financialItem.batch.row',
414 'FinancialItem',
415 $financialItem->id
416 );
417 }
418 else {
419 $js = "enableActions('y')";
420 $row[$financialItem->id]['check'] = "<input type='checkbox' id='mark_y_" . $financialItem->id . "' name='mark_y_" . $financialItem->id . "' value='1' onclick={$js}></input>";
421 $row[$financialItem->id]['action'] = CRM_Core_Action::formLink(
422 CRM_Financial_Page_BatchTransaction::links(),
423 NULL,
424 array(
425 'id' => $financialItem->id,
426 'contid' => $financialItem->contributionID,
427 'cid' => $financialItem->contact_id,
428 ),
429 ts('more'),
430 FALSE,
431 'financialItem.batch.row',
432 'FinancialItem',
433 $financialItem->id
434 );
435 }
436 }
437 else {
438 $row[$financialItem->id]['check'] = NULL;
439 $tempBAO = new CRM_Financial_Page_BatchTransaction();
440 $links = $tempBAO->links();
441 unset($links['remove']);
442 $row[$financialItem->id]['action'] = CRM_Core_Action::formLink(
443 $links,
444 NULL,
445 array(
446 'id' => $financialItem->id,
447 'contid' => $financialItem->contributionID,
448 'cid' => $financialItem->contact_id,
449 ),
450 ts('more'),
451 FALSE,
452 'financialItem.batch.row',
453 'FinancialItem',
454 $financialItem->id
455 );
456 }
457 $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);
458 $financialitems = $row;
459 }
460
461 $iFilteredTotal = $iTotal = $params['total'];
462 $selectorElements = array(
463 'check',
464 'contact_type',
465 'sort_name',
466 'amount',
467 'trxn_id',
468 'transaction_date',
469 'payment_method',
470 'status',
471 'name',
472 'action',
473 );
474
475 if ($return) {
476 return CRM_Utils_JSON::encodeDataTableSelector($financialitems, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
477 }
478 CRM_Utils_System::setHttpHeader('Content-Type', 'application/json');
479 echo CRM_Utils_JSON::encodeDataTableSelector($financialitems, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
480 CRM_Utils_System::civiExit();
481 }
482
483 public static function bulkAssignRemove() {
484 $checkIDs = $_REQUEST['ID'];
485 $entityID = CRM_Utils_Type::escape($_REQUEST['entityID'], 'String');
486 $action = CRM_Utils_Type::escape($_REQUEST['action'], 'String');
487 foreach ($checkIDs as $key => $value) {
488 if ((substr($value, 0, 7) == "mark_x_" && $action == 'Assign') || (substr($value, 0, 7) == "mark_y_" && $action == 'Remove')) {
489 $contributions = explode("_", $value);
490 $cIDs[] = $contributions[2];
491 }
492 }
493
494 $batchPID = CRM_Core_DAO::getFieldValue('CRM_Batch_DAO_Batch', $entityID, 'payment_instrument_id');
495 $paymentInstrument = CRM_Core_OptionGroup::getLabel('payment_instrument', $batchPID);
496 foreach ($cIDs as $key => $value) {
497 $recordPID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $value, 'payment_instrument_id');
498 if ($action == 'Remove' || ($recordPID == $batchPID && $action == 'Assign') || !isset($batchPID)) {
499 $params = array(
500 'entity_id' => $value,
501 'entity_table' => 'civicrm_financial_trxn',
502 'batch_id' => $entityID,
503 );
504 if ($action == 'Assign') {
505 $updated = CRM_Batch_BAO_Batch::addBatchEntity($params);
506 }
507 else {
508 $updated = CRM_Batch_BAO_Batch::removeBatchEntity($params);
509 }
510 }
511 }
512 if ($updated) {
513 $status = array('status' => 'record-updated-success');
514 }
515 else {
516 $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 }
518 CRM_Utils_JSON::output($status);
519 }
520
521 public static function getBatchSummary() {
522 $batchID = CRM_Utils_Type::escape($_REQUEST['batchID'], 'String');
523 $params = array('id' => $batchID);
524 $batchInfo = CRM_Batch_BAO_Batch::retrieve($params, $value);
525 $batchTotals = CRM_Batch_BAO_Batch::batchTotals(array($batchID));
526 $batchSummary = array(
527 'created_by' => CRM_Contact_BAO_Contact::displayName($batchInfo->created_id),
528 'status' => CRM_Core_OptionGroup::getLabel('batch_status', $batchInfo->status_id),
529 'description' => $batchInfo->description,
530 'payment_instrument' => CRM_Core_OptionGroup::getLabel('payment_instrument', $batchInfo->payment_instrument_id),
531 'item_count' => $batchInfo->item_count,
532 'assigned_item_count' => $batchTotals[$batchID]['item_count'],
533 'total' => CRM_Utils_Money::format($batchInfo->total),
534 'assigned_total' => CRM_Utils_Money::format($batchTotals[$batchID]['total']),
535 'opened_date' => CRM_Utils_Date::customFormat($batchInfo->created_date),
536 );
537
538 CRM_Utils_JSON::output($batchSummary);
539 }
540
541 }