852 lines
27 KiB
PHP
852 lines
27 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| CiviCRM version 4.7 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| This file is a part of CiviCRM. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
|
| under the terms of the GNU Affero General Public License |
|
||
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
|
|
| See the GNU Affero General Public License for more details. |
|
||
|
|
| |
|
||
|
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
|
| License and the CiviCRM Licensing Exception along |
|
||
|
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Batch BAO class.
|
||
|
|
*/
|
||
|
|
class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Cache for the current batch object.
|
||
|
|
*/
|
||
|
|
static $_batch = NULL;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Not sure this is the best way to do this. Depends on how exportFinancialBatch() below gets called.
|
||
|
|
* Maybe a parameter to that function is better.
|
||
|
|
*/
|
||
|
|
static $_exportFormat = NULL;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a new batch.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
* $batch batch object
|
||
|
|
*/
|
||
|
|
public static function create(&$params) {
|
||
|
|
$op = 'edit';
|
||
|
|
$batchId = CRM_Utils_Array::value('id', $params);
|
||
|
|
if (!$batchId) {
|
||
|
|
$op = 'create';
|
||
|
|
$params['name'] = CRM_Utils_String::titleToVar($params['title']);
|
||
|
|
}
|
||
|
|
CRM_Utils_Hook::pre($op, 'Batch', $batchId, $params);
|
||
|
|
$batch = new CRM_Batch_DAO_Batch();
|
||
|
|
$batch->copyValues($params);
|
||
|
|
$batch->save();
|
||
|
|
|
||
|
|
CRM_Utils_Hook::post($op, 'Batch', $batch->id, $batch);
|
||
|
|
|
||
|
|
return $batch;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieve the information about the batch.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* (reference ) an assoc array of name/value pairs.
|
||
|
|
* @param array $defaults
|
||
|
|
* (reference ) an assoc array to hold the flattened values.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* CRM_Batch_BAO_Batch object on success, null otherwise
|
||
|
|
*/
|
||
|
|
public static function retrieve(&$params, &$defaults) {
|
||
|
|
$batch = new CRM_Batch_DAO_Batch();
|
||
|
|
$batch->copyValues($params);
|
||
|
|
if ($batch->find(TRUE)) {
|
||
|
|
CRM_Core_DAO::storeValues($batch, $defaults);
|
||
|
|
return $batch;
|
||
|
|
}
|
||
|
|
return NULL;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get profile id associated with the batch type.
|
||
|
|
*
|
||
|
|
* @param int $batchTypeId
|
||
|
|
* Batch type id.
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
* $profileId profile id
|
||
|
|
*/
|
||
|
|
public static function getProfileId($batchTypeId) {
|
||
|
|
//retrieve the profile specific to batch type
|
||
|
|
switch ($batchTypeId) {
|
||
|
|
case 1:
|
||
|
|
case 3:
|
||
|
|
//batch profile used for pledges
|
||
|
|
$profileName = "contribution_batch_entry";
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 2:
|
||
|
|
//batch profile used for memberships
|
||
|
|
$profileName = "membership_batch_entry";
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
// get and return the profile id
|
||
|
|
return CRM_Core_DAO::getFieldValue('CRM_Core_BAO_UFGroup', $profileName, 'id', 'name');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Generate batch name.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
* batch name
|
||
|
|
*/
|
||
|
|
public static function generateBatchName() {
|
||
|
|
$sql = "SELECT max(id) FROM civicrm_batch";
|
||
|
|
$batchNo = CRM_Core_DAO::singleValueQuery($sql) + 1;
|
||
|
|
return ts('Batch %1', array(1 => $batchNo)) . ': ' . date('Y-m-d');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete batch entry.
|
||
|
|
*
|
||
|
|
* @param int $batchId
|
||
|
|
* Batch id.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function deleteBatch($batchId) {
|
||
|
|
// delete entry from batch table
|
||
|
|
CRM_Utils_Hook::pre('delete', 'Batch', $batchId, CRM_Core_DAO::$_nullArray);
|
||
|
|
$batch = new CRM_Batch_DAO_Batch();
|
||
|
|
$batch->id = $batchId;
|
||
|
|
$batch->delete();
|
||
|
|
CRM_Utils_Hook::post('delete', 'Batch', $batch->id, $batch);
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* wrapper for ajax batch selector.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Associated array for params record id.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* associated array of batch list
|
||
|
|
*/
|
||
|
|
public static function getBatchListSelector(&$params) {
|
||
|
|
// format the params
|
||
|
|
$params['offset'] = ($params['page'] - 1) * $params['rp'];
|
||
|
|
$params['rowCount'] = $params['rp'];
|
||
|
|
$params['sort'] = CRM_Utils_Array::value('sortBy', $params);
|
||
|
|
|
||
|
|
// get batches
|
||
|
|
$batches = self::getBatchList($params);
|
||
|
|
|
||
|
|
// get batch totals for open batches
|
||
|
|
$fetchTotals = array();
|
||
|
|
$batchStatus = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'status_id', array('labelColumn' => 'name'));
|
||
|
|
$batchStatus = array(
|
||
|
|
array_search('Open', $batchStatus),
|
||
|
|
array_search('Reopened', $batchStatus),
|
||
|
|
);
|
||
|
|
if ($params['context'] == 'financialBatch') {
|
||
|
|
foreach ($batches as $id => $batch) {
|
||
|
|
if (in_array($batch['status_id'], $batchStatus)) {
|
||
|
|
$fetchTotals[] = $id;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$totals = self::batchTotals($fetchTotals);
|
||
|
|
|
||
|
|
// add count
|
||
|
|
$params['total'] = self::getBatchCount($params);
|
||
|
|
|
||
|
|
// format params and add links
|
||
|
|
$batchList = array();
|
||
|
|
|
||
|
|
foreach ($batches as $id => $value) {
|
||
|
|
$batch = array();
|
||
|
|
if ($params['context'] == 'financialBatch') {
|
||
|
|
$batch['check'] = $value['check'];
|
||
|
|
}
|
||
|
|
$batch['batch_name'] = $value['title'];
|
||
|
|
$batch['total'] = '';
|
||
|
|
$batch['payment_instrument'] = $value['payment_instrument'];
|
||
|
|
$batch['item_count'] = CRM_Utils_Array::value('item_count', $value);
|
||
|
|
$batch['type'] = CRM_Utils_Array::value('batch_type', $value);
|
||
|
|
if (!empty($value['total'])) {
|
||
|
|
// CRM-21205
|
||
|
|
$batch['total'] = CRM_Utils_Money::format($value['total'], $value['currency']);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Compare totals with actuals
|
||
|
|
if (isset($totals[$id])) {
|
||
|
|
$batch['item_count'] = self::displayTotals($totals[$id]['item_count'], $batch['item_count']);
|
||
|
|
$batch['total'] = self::displayTotals(CRM_Utils_Money::format($totals[$id]['total']), $batch['total']);
|
||
|
|
}
|
||
|
|
$batch['status'] = $value['batch_status'];
|
||
|
|
$batch['created_by'] = $value['created_by'];
|
||
|
|
$batch['links'] = $value['action'];
|
||
|
|
$batchList[$id] = $batch;
|
||
|
|
}
|
||
|
|
return $batchList;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get list of batches.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Associated array for params.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public static function getBatchList(&$params) {
|
||
|
|
$apiParams = self::whereClause($params);
|
||
|
|
|
||
|
|
if (!empty($params['rowCount']) && is_numeric($params['rowCount'])
|
||
|
|
&& is_numeric($params['offset']) && $params['rowCount'] > 0
|
||
|
|
) {
|
||
|
|
$apiParams['options'] = array('offset' => $params['offset'], 'limit' => $params['rowCount']);
|
||
|
|
}
|
||
|
|
$apiParams['options']['sort'] = 'id DESC';
|
||
|
|
if (!empty($params['sort'])) {
|
||
|
|
$apiParams['options']['sort'] = CRM_Utils_Type::escape($params['sort'], 'String');
|
||
|
|
}
|
||
|
|
|
||
|
|
$return = array(
|
||
|
|
"id",
|
||
|
|
"name",
|
||
|
|
"title",
|
||
|
|
"description",
|
||
|
|
"created_date",
|
||
|
|
"status_id",
|
||
|
|
"modified_id",
|
||
|
|
"modified_date",
|
||
|
|
"type_id",
|
||
|
|
"mode_id",
|
||
|
|
"total",
|
||
|
|
"item_count",
|
||
|
|
"exported_date",
|
||
|
|
"payment_instrument_id",
|
||
|
|
"created_id.sort_name",
|
||
|
|
"created_id",
|
||
|
|
);
|
||
|
|
$apiParams['return'] = $return;
|
||
|
|
$batches = civicrm_api3('Batch', 'get', $apiParams);
|
||
|
|
$obj = new CRM_Batch_BAO_Batch();
|
||
|
|
if (!empty($params['context'])) {
|
||
|
|
$links = $obj->links($params['context']);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$links = $obj->links();
|
||
|
|
}
|
||
|
|
|
||
|
|
$batchTypes = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'type_id');
|
||
|
|
$batchStatus = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'status_id');
|
||
|
|
$batchStatusByName = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'status_id', array('labelColumn' => 'name'));
|
||
|
|
$paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
|
||
|
|
|
||
|
|
$results = array();
|
||
|
|
foreach ($batches['values'] as $values) {
|
||
|
|
$newLinks = $links;
|
||
|
|
$action = array_sum(array_keys($newLinks));
|
||
|
|
|
||
|
|
if ($values['status_id'] == array_search('Closed', $batchStatusByName) && $params['context'] != 'financialBatch') {
|
||
|
|
$newLinks = array();
|
||
|
|
}
|
||
|
|
elseif ($params['context'] == 'financialBatch') {
|
||
|
|
$values['check'] = "<input type='checkbox' id='check_" .
|
||
|
|
$values['id'] .
|
||
|
|
"' name='check_" .
|
||
|
|
$values['id'] .
|
||
|
|
"' value='1' data-status_id='" .
|
||
|
|
$values['status_id'] . "' class='select-row'></input>";
|
||
|
|
|
||
|
|
switch ($batchStatusByName[$values['status_id']]) {
|
||
|
|
case 'Open':
|
||
|
|
case 'Reopened':
|
||
|
|
CRM_Utils_Array::remove($newLinks, 'reopen', 'download');
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'Closed':
|
||
|
|
CRM_Utils_Array::remove($newLinks, 'close', 'edit', 'download');
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'Exported':
|
||
|
|
CRM_Utils_Array::remove($newLinks, 'close', 'edit', 'reopen', 'export');
|
||
|
|
}
|
||
|
|
if (!CRM_Batch_BAO_Batch::checkBatchPermission('edit', $values['created_id'])) {
|
||
|
|
CRM_Utils_Array::remove($newLinks, 'edit');
|
||
|
|
}
|
||
|
|
if (!CRM_Batch_BAO_Batch::checkBatchPermission('close', $values['created_id'])) {
|
||
|
|
CRM_Utils_Array::remove($newLinks, 'close', 'export');
|
||
|
|
}
|
||
|
|
if (!CRM_Batch_BAO_Batch::checkBatchPermission('reopen', $values['created_id'])) {
|
||
|
|
CRM_Utils_Array::remove($newLinks, 'reopen');
|
||
|
|
}
|
||
|
|
if (!CRM_Batch_BAO_Batch::checkBatchPermission('export', $values['created_id'])) {
|
||
|
|
CRM_Utils_Array::remove($newLinks, 'export', 'download');
|
||
|
|
}
|
||
|
|
if (!CRM_Batch_BAO_Batch::checkBatchPermission('delete', $values['created_id'])) {
|
||
|
|
CRM_Utils_Array::remove($newLinks, 'delete');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (!empty($values['type_id'])) {
|
||
|
|
$values['batch_type'] = $batchTypes[$values['type_id']];
|
||
|
|
}
|
||
|
|
$values['batch_status'] = $batchStatus[$values['status_id']];
|
||
|
|
$values['created_by'] = $values['created_id.sort_name'];
|
||
|
|
$values['payment_instrument'] = '';
|
||
|
|
if (!empty($values['payment_instrument_id'])) {
|
||
|
|
$values['payment_instrument'] = $paymentInstrument[$values['payment_instrument_id']];
|
||
|
|
}
|
||
|
|
$tokens = array('id' => $values['id'], 'status' => $values['status_id']);
|
||
|
|
if ($values['status_id'] == array_search('Exported', $batchStatusByName)) {
|
||
|
|
$aid = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Export Accounting Batch');
|
||
|
|
$activityParams = array('source_record_id' => $values['id'], 'activity_type_id' => $aid);
|
||
|
|
$exportActivity = CRM_Activity_BAO_Activity::retrieve($activityParams, $val);
|
||
|
|
$fid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_EntityFile', $exportActivity->id, 'file_id', 'entity_id');
|
||
|
|
$tokens = array_merge(array('eid' => $exportActivity->id, 'fid' => $fid), $tokens);
|
||
|
|
}
|
||
|
|
$values['action'] = CRM_Core_Action::formLink(
|
||
|
|
$newLinks,
|
||
|
|
$action,
|
||
|
|
$tokens,
|
||
|
|
ts('more'),
|
||
|
|
FALSE,
|
||
|
|
'batch.selector.row',
|
||
|
|
'Batch',
|
||
|
|
$values['id']
|
||
|
|
);
|
||
|
|
// CRM-21205
|
||
|
|
$values['currency'] = CRM_Core_DAO::singleValueQuery("
|
||
|
|
SELECT GROUP_CONCAT(DISTINCT ft.currency)
|
||
|
|
FROM civicrm_batch batch
|
||
|
|
JOIN civicrm_entity_batch eb
|
||
|
|
ON batch.id = eb.batch_id
|
||
|
|
JOIN civicrm_financial_trxn ft
|
||
|
|
ON eb.entity_id = ft.id
|
||
|
|
WHERE batch.id = %1
|
||
|
|
GROUP BY batch.id
|
||
|
|
", array(1 => array($values['id'], 'Positive')));
|
||
|
|
$results[$values['id']] = $values;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $results;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get count of batches.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Associated array for params.
|
||
|
|
*
|
||
|
|
* @return null|string
|
||
|
|
*/
|
||
|
|
public static function getBatchCount(&$params) {
|
||
|
|
$apiParams = self::whereClause($params);
|
||
|
|
return civicrm_api3('Batch', 'getCount', $apiParams);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Format where clause for getting lists of batches.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Associated array for params.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public static function whereClause($params) {
|
||
|
|
$clauses = array();
|
||
|
|
// Exclude data-entry batches
|
||
|
|
$batchStatus = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'status_id', array('labelColumn' => 'name'));
|
||
|
|
if (empty($params['status_id'])) {
|
||
|
|
$clauses['status_id'] = array('NOT IN' => array("Data Entry"));
|
||
|
|
}
|
||
|
|
|
||
|
|
$return = array(
|
||
|
|
"id",
|
||
|
|
"name",
|
||
|
|
"title",
|
||
|
|
"description",
|
||
|
|
"created_date",
|
||
|
|
"status_id",
|
||
|
|
"modified_id",
|
||
|
|
"modified_date",
|
||
|
|
"type_id",
|
||
|
|
"mode_id",
|
||
|
|
"total",
|
||
|
|
"item_count",
|
||
|
|
"exported_date",
|
||
|
|
"payment_instrument_id",
|
||
|
|
"created_id.sort_name",
|
||
|
|
"created_id",
|
||
|
|
);
|
||
|
|
if (!CRM_Core_Permission::check("view all manual batches")) {
|
||
|
|
if (CRM_Core_Permission::check("view own manual batches")) {
|
||
|
|
$loggedInContactId = CRM_Core_Session::singleton()->get('userID');
|
||
|
|
$params['created_id'] = $loggedInContactId;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params['created_id'] = 0;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
foreach ($return as $field) {
|
||
|
|
if (!isset($params[$field])) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
$value = CRM_Utils_Type::escape($params[$field], 'String', FALSE);
|
||
|
|
if (in_array($field, array('name', 'title', 'description', 'created_id.sort_name'))) {
|
||
|
|
$clauses[$field] = array('LIKE' => "%{$value}%");
|
||
|
|
}
|
||
|
|
elseif ($field == 'status_id' && $value == array_search('Open', $batchStatus)) {
|
||
|
|
$clauses['status_id'] = array('IN' => array("Open", 'Reopened'));
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$clauses[$field] = $value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return $clauses;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Define action links.
|
||
|
|
*
|
||
|
|
* @param null $context
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* array of action links
|
||
|
|
*/
|
||
|
|
public function links($context = NULL) {
|
||
|
|
if ($context == 'financialBatch') {
|
||
|
|
$links = array(
|
||
|
|
'transaction' => array(
|
||
|
|
'name' => ts('Transactions'),
|
||
|
|
'url' => 'civicrm/batchtransaction',
|
||
|
|
'qs' => 'reset=1&bid=%%id%%',
|
||
|
|
'title' => ts('View/Add Transactions to Batch'),
|
||
|
|
),
|
||
|
|
'edit' => array(
|
||
|
|
'name' => ts('Edit'),
|
||
|
|
'url' => 'civicrm/financial/batch',
|
||
|
|
'qs' => 'reset=1&action=update&id=%%id%%&context=1',
|
||
|
|
'title' => ts('Edit Batch'),
|
||
|
|
),
|
||
|
|
'close' => array(
|
||
|
|
'name' => ts('Close'),
|
||
|
|
'title' => ts('Close Batch'),
|
||
|
|
'url' => '#',
|
||
|
|
'extra' => 'rel="close"',
|
||
|
|
),
|
||
|
|
'export' => array(
|
||
|
|
'name' => ts('Export'),
|
||
|
|
'title' => ts('Export Batch'),
|
||
|
|
'url' => '#',
|
||
|
|
'extra' => 'rel="export"',
|
||
|
|
),
|
||
|
|
'reopen' => array(
|
||
|
|
'name' => ts('Re-open'),
|
||
|
|
'title' => ts('Re-open Batch'),
|
||
|
|
'url' => '#',
|
||
|
|
'extra' => 'rel="reopen"',
|
||
|
|
),
|
||
|
|
'delete' => array(
|
||
|
|
'name' => ts('Delete'),
|
||
|
|
'title' => ts('Delete Batch'),
|
||
|
|
'url' => '#',
|
||
|
|
'extra' => 'rel="delete"',
|
||
|
|
),
|
||
|
|
'download' => array(
|
||
|
|
'name' => ts('Download'),
|
||
|
|
'url' => 'civicrm/file',
|
||
|
|
'qs' => 'reset=1&id=%%fid%%&eid=%%eid%%',
|
||
|
|
'title' => ts('Download Batch'),
|
||
|
|
),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$links = array(
|
||
|
|
CRM_Core_Action::COPY => array(
|
||
|
|
'name' => ts('Enter records'),
|
||
|
|
'url' => 'civicrm/batch/entry',
|
||
|
|
'qs' => 'id=%%id%%&reset=1',
|
||
|
|
'title' => ts('Batch Data Entry'),
|
||
|
|
),
|
||
|
|
CRM_Core_Action::UPDATE => array(
|
||
|
|
'name' => ts('Edit'),
|
||
|
|
'url' => 'civicrm/batch',
|
||
|
|
'qs' => 'action=update&id=%%id%%&reset=1',
|
||
|
|
'title' => ts('Edit Batch'),
|
||
|
|
),
|
||
|
|
CRM_Core_Action::DELETE => array(
|
||
|
|
'name' => ts('Delete'),
|
||
|
|
'url' => 'civicrm/batch',
|
||
|
|
'qs' => 'action=delete&id=%%id%%',
|
||
|
|
'title' => ts('Delete Batch'),
|
||
|
|
),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
return $links;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get batch list.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* all batches excluding batches with data entry in progress
|
||
|
|
*/
|
||
|
|
public static function getBatches() {
|
||
|
|
$dataEntryStatusId = CRM_Core_PseudoConstant::getKey('CRM_Batch_BAO_Batch', 'status_id', 'Data Entry');
|
||
|
|
$query = "SELECT id, title
|
||
|
|
FROM civicrm_batch
|
||
|
|
WHERE item_count >= 1
|
||
|
|
AND status_id != {$dataEntryStatusId}
|
||
|
|
ORDER BY title";
|
||
|
|
|
||
|
|
$batches = array();
|
||
|
|
$dao = CRM_Core_DAO::executeQuery($query);
|
||
|
|
while ($dao->fetch()) {
|
||
|
|
$batches[$dao->id] = $dao->title;
|
||
|
|
}
|
||
|
|
return $batches;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Calculate sum of all entries in a batch.
|
||
|
|
* Used to validate and update item_count and total when closing an accounting batch
|
||
|
|
*
|
||
|
|
* @param array $batchIds
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public static function batchTotals($batchIds) {
|
||
|
|
$totals = array_fill_keys($batchIds, array('item_count' => 0, 'total' => 0));
|
||
|
|
if ($batchIds) {
|
||
|
|
$sql = "SELECT eb.batch_id, COUNT(tx.id) AS item_count, SUM(tx.total_amount) AS total
|
||
|
|
FROM civicrm_entity_batch eb
|
||
|
|
INNER JOIN civicrm_financial_trxn tx ON tx.id = eb.entity_id AND eb.entity_table = 'civicrm_financial_trxn'
|
||
|
|
WHERE eb.batch_id IN (" . implode(',', $batchIds) . ")
|
||
|
|
GROUP BY eb.batch_id";
|
||
|
|
$dao = CRM_Core_DAO::executeQuery($sql);
|
||
|
|
while ($dao->fetch()) {
|
||
|
|
$totals[$dao->batch_id] = (array) $dao;
|
||
|
|
}
|
||
|
|
$dao->free();
|
||
|
|
}
|
||
|
|
return $totals;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Format markup for comparing two totals.
|
||
|
|
*
|
||
|
|
* @param $actual
|
||
|
|
* calculated total
|
||
|
|
* @param $expected
|
||
|
|
* user-entered total
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public static function displayTotals($actual, $expected) {
|
||
|
|
$class = 'actual-value';
|
||
|
|
if ($expected && $expected != $actual) {
|
||
|
|
$class .= ' crm-error';
|
||
|
|
}
|
||
|
|
$actualTitle = ts('Current Total');
|
||
|
|
$output = "<span class='$class' title='$actualTitle'>$actual</span>";
|
||
|
|
if ($expected) {
|
||
|
|
$expectedTitle = ts('Expected Total');
|
||
|
|
$output .= " / <span class='expected-value' title='$expectedTitle'>$expected</span>";
|
||
|
|
}
|
||
|
|
return $output;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Function for exporting financial accounts, currently we support CSV and IIF format
|
||
|
|
* @see http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+Specifications+-++Batches#CiviAccountsSpecifications-Batches-%C2%A0Overviewofimplementation
|
||
|
|
*
|
||
|
|
* @param array $batchIds
|
||
|
|
* Associated array of batch ids.
|
||
|
|
* @param string $exportFormat
|
||
|
|
* Export format.
|
||
|
|
*/
|
||
|
|
public static function exportFinancialBatch($batchIds, $exportFormat) {
|
||
|
|
if (empty($batchIds)) {
|
||
|
|
CRM_Core_Error::fatal(ts('No batches were selected.'));
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
if (empty($exportFormat)) {
|
||
|
|
CRM_Core_Error::fatal(ts('No export format selected.'));
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
self::$_exportFormat = $exportFormat;
|
||
|
|
|
||
|
|
// Instantiate appropriate exporter based on user-selected format.
|
||
|
|
$exporterClass = "CRM_Financial_BAO_ExportFormat_" . self::$_exportFormat;
|
||
|
|
if (class_exists($exporterClass)) {
|
||
|
|
$exporter = new $exporterClass();
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
CRM_Core_Error::fatal("Could not locate exporter: $exporterClass");
|
||
|
|
}
|
||
|
|
$export = array();
|
||
|
|
foreach ($batchIds as $batchId) {
|
||
|
|
// export only batches whose status is set to Exported.
|
||
|
|
$result = civicrm_api3('Batch', 'getcount', array(
|
||
|
|
'id' => $batchId,
|
||
|
|
'status_id' => "Exported",
|
||
|
|
));
|
||
|
|
if (!$result) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
$export[$batchId] = $exporter->generateExportQuery($batchId);
|
||
|
|
}
|
||
|
|
if ($export) {
|
||
|
|
$exporter->makeExport($export);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param array $batchIds
|
||
|
|
* @param $status
|
||
|
|
*/
|
||
|
|
public static function closeReOpen($batchIds = array(), $status) {
|
||
|
|
$batchStatus = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'status_id');
|
||
|
|
$params['status_id'] = CRM_Utils_Array::key($status, $batchStatus);
|
||
|
|
$session = CRM_Core_Session::singleton();
|
||
|
|
$params['modified_date'] = date('YmdHis');
|
||
|
|
$params['modified_id'] = $session->get('userID');
|
||
|
|
foreach ($batchIds as $key => $value) {
|
||
|
|
$params['id'] = $ids['batchID'] = $value;
|
||
|
|
self::create($params, $ids);
|
||
|
|
}
|
||
|
|
$url = CRM_Utils_System::url('civicrm/financial/financialbatches', "reset=1&batchStatus={$params['status_id']}");
|
||
|
|
CRM_Utils_System::redirect($url);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieve financial items assigned for a batch.
|
||
|
|
*
|
||
|
|
* @param int $entityID
|
||
|
|
* @param array $returnValues
|
||
|
|
* @param bool $notPresent
|
||
|
|
* @param array $params
|
||
|
|
* @param bool $getCount
|
||
|
|
*
|
||
|
|
* @return CRM_Core_DAO
|
||
|
|
*/
|
||
|
|
public static function getBatchFinancialItems($entityID, $returnValues, $notPresent = NULL, $params = NULL, $getCount = FALSE) {
|
||
|
|
if (!$getCount) {
|
||
|
|
if (!empty($params['rowCount']) &&
|
||
|
|
$params['rowCount'] > 0
|
||
|
|
) {
|
||
|
|
$limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// action is taken depending upon the mode
|
||
|
|
$select = 'civicrm_financial_trxn.id ';
|
||
|
|
if (!empty($returnValues)) {
|
||
|
|
$select .= " , " . implode(' , ', $returnValues);
|
||
|
|
}
|
||
|
|
|
||
|
|
$orderBy = " ORDER BY civicrm_financial_trxn.id";
|
||
|
|
if (!empty($params['sort'])) {
|
||
|
|
$orderBy = ' ORDER BY ' . CRM_Utils_Type::escape($params['sort'], 'String');
|
||
|
|
}
|
||
|
|
|
||
|
|
$from = "civicrm_financial_trxn
|
||
|
|
INNER JOIN civicrm_entity_financial_trxn ON civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id
|
||
|
|
INNER JOIN civicrm_contribution ON (civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id
|
||
|
|
AND civicrm_entity_financial_trxn.entity_table='civicrm_contribution')
|
||
|
|
LEFT JOIN civicrm_entity_batch ON civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
|
||
|
|
AND civicrm_entity_batch.entity_id = civicrm_financial_trxn.id
|
||
|
|
LEFT JOIN civicrm_financial_type ON civicrm_financial_type.id = civicrm_contribution.financial_type_id
|
||
|
|
LEFT JOIN civicrm_contact contact_a ON contact_a.id = civicrm_contribution.contact_id
|
||
|
|
LEFT JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id
|
||
|
|
";
|
||
|
|
|
||
|
|
$searchFields = array(
|
||
|
|
'sort_name',
|
||
|
|
'financial_type_id',
|
||
|
|
'contribution_page_id',
|
||
|
|
'payment_instrument_id',
|
||
|
|
'contribution_trxn_id',
|
||
|
|
'contribution_source',
|
||
|
|
'contribution_currency_type',
|
||
|
|
'contribution_pay_later',
|
||
|
|
'contribution_recurring',
|
||
|
|
'contribution_test',
|
||
|
|
'contribution_thankyou_date_is_not_null',
|
||
|
|
'contribution_receipt_date_is_not_null',
|
||
|
|
'contribution_pcp_made_through_id',
|
||
|
|
'contribution_pcp_display_in_roll',
|
||
|
|
'contribution_date_relative',
|
||
|
|
'contribution_amount_low',
|
||
|
|
'contribution_amount_high',
|
||
|
|
'contribution_in_honor_of',
|
||
|
|
'contact_tags',
|
||
|
|
'group',
|
||
|
|
'contribution_date_relative',
|
||
|
|
'contribution_date_high',
|
||
|
|
'contribution_date_low',
|
||
|
|
'contribution_check_number',
|
||
|
|
'contribution_status_id',
|
||
|
|
);
|
||
|
|
$values = array();
|
||
|
|
foreach ($searchFields as $field) {
|
||
|
|
if (isset($params[$field])) {
|
||
|
|
$values[$field] = $params[$field];
|
||
|
|
if ($field == 'sort_name') {
|
||
|
|
$from .= " LEFT JOIN civicrm_contact contact_b ON contact_b.id = civicrm_contribution.contact_id
|
||
|
|
LEFT JOIN civicrm_email ON contact_b.id = civicrm_email.contact_id";
|
||
|
|
}
|
||
|
|
if ($field == 'contribution_in_honor_of') {
|
||
|
|
$from .= " LEFT JOIN civicrm_contact contact_b ON contact_b.id = civicrm_contribution.contact_id";
|
||
|
|
}
|
||
|
|
if ($field == 'contact_tags') {
|
||
|
|
$from .= " LEFT JOIN civicrm_entity_tag `civicrm_entity_tag-{$params[$field]}` ON `civicrm_entity_tag-{$params[$field]}`.entity_id = contact_a.id";
|
||
|
|
}
|
||
|
|
if ($field == 'group') {
|
||
|
|
$from .= " LEFT JOIN civicrm_group_contact `civicrm_group_contact-{$params[$field]}` ON contact_a.id = `civicrm_group_contact-{$params[$field]}`.contact_id ";
|
||
|
|
}
|
||
|
|
if ($field == 'contribution_date_relative') {
|
||
|
|
$relativeDate = explode('.', $params[$field]);
|
||
|
|
$date = CRM_Utils_Date::relativeToAbsolute($relativeDate[0], $relativeDate[1]);
|
||
|
|
$values['contribution_date_low'] = $date['from'];
|
||
|
|
$values['contribution_date_high'] = $date['to'];
|
||
|
|
}
|
||
|
|
$searchParams = CRM_Contact_BAO_Query::convertFormValues($values);
|
||
|
|
// @todo the use of defaultReturnProperties means the search will be inefficient
|
||
|
|
// as slow-unneeded properties are included.
|
||
|
|
$query = new CRM_Contact_BAO_Query($searchParams,
|
||
|
|
CRM_Contribute_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CONTRIBUTE,
|
||
|
|
FALSE
|
||
|
|
), NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE
|
||
|
|
);
|
||
|
|
if ($field == 'contribution_date_high' || $field == 'contribution_date_low') {
|
||
|
|
$query->dateQueryBuilder($params[$field], 'civicrm_contribution', 'contribution_date', 'receive_date', 'Contribution Date');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (!empty($query->_where[0])) {
|
||
|
|
$where = implode(' AND ', $query->_where[0]) .
|
||
|
|
" AND civicrm_entity_batch.batch_id IS NULL ";
|
||
|
|
$where = str_replace('civicrm_contribution.payment_instrument_id', 'civicrm_financial_trxn.payment_instrument_id', $where);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
if (!$notPresent) {
|
||
|
|
$where = " civicrm_entity_batch.batch_id = {$entityID} ";
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$where = " civicrm_entity_batch.batch_id IS NULL ";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$sql = "
|
||
|
|
SELECT {$select}
|
||
|
|
FROM {$from}
|
||
|
|
WHERE {$where}
|
||
|
|
{$orderBy}
|
||
|
|
";
|
||
|
|
|
||
|
|
if (isset($limit)) {
|
||
|
|
$sql .= "{$limit}";
|
||
|
|
}
|
||
|
|
|
||
|
|
$result = CRM_Core_DAO::executeQuery($sql);
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get batch names.
|
||
|
|
* @param string $batchIds
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* array of batches
|
||
|
|
*/
|
||
|
|
public static function getBatchNames($batchIds) {
|
||
|
|
$query = 'SELECT id, title
|
||
|
|
FROM civicrm_batch
|
||
|
|
WHERE id IN (' . $batchIds . ')';
|
||
|
|
|
||
|
|
$batches = array();
|
||
|
|
$dao = CRM_Core_DAO::executeQuery($query);
|
||
|
|
while ($dao->fetch()) {
|
||
|
|
$batches[$dao->id] = $dao->title;
|
||
|
|
}
|
||
|
|
return $batches;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Function get batch statuses.
|
||
|
|
*
|
||
|
|
* @param string $batchIds
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* array of batches
|
||
|
|
*/
|
||
|
|
public static function getBatchStatuses($batchIds) {
|
||
|
|
$query = 'SELECT id, status_id
|
||
|
|
FROM civicrm_batch
|
||
|
|
WHERE id IN (' . $batchIds . ')';
|
||
|
|
|
||
|
|
$batches = array();
|
||
|
|
$dao = CRM_Core_DAO::executeQuery($query);
|
||
|
|
while ($dao->fetch()) {
|
||
|
|
$batches[$dao->id] = $dao->status_id;
|
||
|
|
}
|
||
|
|
return $batches;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Function to check permission for batch.
|
||
|
|
*
|
||
|
|
* @param string $action
|
||
|
|
* @param int $batchCreatedId
|
||
|
|
* batch created by contact id
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function checkBatchPermission($action, $batchCreatedId = NULL) {
|
||
|
|
if (CRM_Core_Permission::check("{$action} all manual batches")) {
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
if (CRM_Core_Permission::check("{$action} own manual batches")) {
|
||
|
|
$loggedInContactId = CRM_Core_Session::singleton()->get('userID');
|
||
|
|
if ($batchCreatedId == $loggedInContactId) {
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
elseif (CRM_Utils_System::isNull($batchCreatedId)) {
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return FALSE;
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|