Commit 469da524 authored by Monish Deb's avatar Monish Deb

AGBU-16: remove overriden files

parent 5fdd363b
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.4 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2013 |
+--------------------------------------------------------------------+
| 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-2013
* $Id$
*
*/
/**
*
*/
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 associated array
* @param array $ids associated array of ids
* @param string $context string
*
* @return object $batch batch object
* @access public
*/
static function create(&$params, $ids = NULL, $context = NULL) {
if (!CRM_Utils_Array::value('id', $params)) {
$params['name'] = CRM_Utils_String::titleToVar($params['title']);
}
$batch = new CRM_Batch_DAO_Batch();
$batch->copyValues($params);
if ($context == 'financialBatch' && CRM_Utils_Array::value('batchID', $ids)) {
$batch->id = $ids['batchID'];
}
$batch->save();
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
* @access public
* @static
*/
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
* @static
*/
static function getProfileId($batchTypeId) {
//retrieve the profile specific to batch type
switch ($batchTypeId) {
case 1:
//batch profile used for contribution
$profileName = "contribution_batch_entry";
break;
case 2:
//batch profile used for memberships
$profileName = "membership_batch_entry";
}
// get and return the profile id
return CRM_Core_DAO::getFieldValue('CRM_Core_BAO_UFGroup', $profileName, 'id', 'name');
}
/**
* generate batch name
*
* @return batch name
* @static
*/
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');
}
/**
* create entity batch entry
* @param array $params associated array
* @return batch array
* @access public
*/
static function addBatchEntity(&$params) {
$entityBatch = new CRM_Batch_DAO_EntityBatch();
$entityBatch->copyValues($params);
$entityBatch->save();
return $entityBatch;
}
/**
* Remove entries from entity batch
* @param array $params associated array
* @return object CRM_Batch_DAO_EntityBatch
*/
static function removeBatchEntity($params) {
$entityBatch = new CRM_Batch_DAO_EntityBatch();
$entityBatch->copyValues($params);
$entityBatch->delete();
return $entityBatch;
}
/**
* function to delete batch entry
*
* @param int $batchId batch id
*
* @return void
* @access public
*/
static function deleteBatch($batchId) {
//delete batch entries from cache
$cacheKeyString = CRM_Batch_BAO_Batch::getCacheKeyForBatch($batchId);
CRM_Core_BAO_Cache::deleteGroup('batch entry', $cacheKeyString, FALSE);
// delete entry from batch table
$batch = new CRM_Batch_DAO_Batch();
$batch->id = $batchId;
$batch->delete();
return true;
}
/**
* function to get cachekey for batch
*
* @param int $batchId batch id
*
* @retun string $cacheString
* @static
* @access public
*/
static function getCacheKeyForBatch($batchId) {
return "batch-entry-{$batchId}";
}
/**
* This function is a wrapper for ajax batch selector
*
* @param array $params associated array for params record id.
*
* @return array $batchList associated array of batch list
* @access public
*/
public 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();
if ($params['context'] == 'financialBatch') {
foreach ($batches as $id => $batch) {
if ($batch['status_id'] == 1) {
$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['item_count'] = '';
$batch['payment_instrument'] = $value['payment_instrument'];
$batch['item_count'] = CRM_Utils_Array::value('item_count', $value);
if (CRM_Utils_Array::value('total', $value)) {
$batch['total'] = CRM_Utils_Money::format($value['total']);
}
// 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
* @access public
*/
static function getBatchList(&$params) {
$whereClause = self::whereClause($params);
if (!empty($params['rowCount']) && is_numeric($params['rowCount'])
&& is_numeric($params['offset']) && $params['rowCount'] > 0
) {
$limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
}
$orderBy = ' ORDER BY batch.id desc';
if (!empty($params['sort'])) {
$orderBy = ' ORDER BY ' . CRM_Utils_Type::escape($params['sort'], 'String');
}
$query = "
SELECT batch.*, c.sort_name created_by
FROM civicrm_batch batch
INNER JOIN civicrm_contact c ON batch.created_id = c.id
WHERE {$whereClause}
{$orderBy}
{$limit}";
$object = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Batch_DAO_Batch');
if (CRM_Utils_Array::value('context', $params)) {
$links = self::links($params['context']);
}
else {
$links = self::links();
}
$batchTypes = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'type_id');
$batchStatus = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'status_id');
$paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
$results = array();
while ($object->fetch()) {
$values = array();
$newLinks = $links;
CRM_Core_DAO::storeValues($object, $values);
$action = array_sum(array_keys($newLinks));
if ($values['status_id'] == 2 && $params['context'] != 'financialBatch') {
$newLinks = array();
}
elseif ($params['context'] == 'financialBatch') {
$values['check'] =
"<input type='checkbox' id='check_" .
$object->id .
"' name='check_" .
$object->id .
"' value='1' data-status_id='" .
$values['status_id']."' class='select-row'></input>";
switch ($values['status_id']) {
case '1':
CRM_Utils_Array::remove($newLinks, 'reopen', 'download');
break;
case '2':
CRM_Utils_Array::remove($newLinks, 'close', 'edit', 'download');
break;
case '5':
CRM_Utils_Array::remove($newLinks, 'close', 'edit', 'reopen', 'export');
}
}
if (CRM_Utils_Array::value('type_id', $values)) {
$values['batch_type'] = $batchTypes[$values['type_id']];
}
$values['batch_status'] = $batchStatus[$values['status_id']];
$values['created_by'] = $object->created_by;
$values['payment_instrument'] = '';
if (!empty($object->payment_instrument_id)) {
$values['payment_instrument'] = $paymentInstrument[$object->payment_instrument_id];
}
$tokens = array('id' => $object->id, 'status' => $values['status_id']);
if ($values['status_id'] == CRM_Core_OptionGroup::getValue('batch_status', 'Exported')) {
$aid = CRM_Core_OptionGroup::getValue('activity_type','Export Accounting Batch');
$activityParams = array('source_record_id' => $object->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
);
$results[$object->id] = $values;
}
return $results;
}
/**
* Get count of batches
*
* @param array $params associated array for params
* @access public
*/
public static function getBatchCount(&$params) {
$args = array();
$whereClause = self::whereClause($params, $args);
$query = " SELECT COUNT(*) FROM civicrm_batch batch
INNER JOIN civicrm_contact c ON batch.created_id = c.id
WHERE {$whereClause}";
return CRM_Core_DAO::singleValueQuery($query);
}
/**
* Format where clause for getting lists of batches
*
* @param array $params associated array for params
* @access public
*/
public static function whereClause($params) {
$clauses = array();
// Exclude data-entry batches
if (empty($params['status_id'])) {
$clauses[] = 'batch.status_id <> 3';
}
$fields = array(
'title' => 'String',
'sort_name' => 'String',
'status_id' => 'Integer',
'payment_instrument_id' => 'Integer',
'item_count' => 'Integer',
'total' => 'Float',
);
foreach ($fields as $field => $type) {
$table = $field == 'sort_name' ? 'c' : 'batch';
if (isset($params[$field])) {
$value = CRM_Utils_Type::escape($params[$field], $type, FALSE);
if ($value && $type == 'String') {
$clauses[] = "$table.$field LIKE '%$value%'";
}
elseif ($value && $type == 'Float') {
$clauses[] = "$table.$field = '$value'";
}
elseif ($value) {
$clauses[] = "$table.$field = $value";
}
}
}
return $clauses ? implode(' AND ', $clauses) : '1';
}
/**
* Function to define action links
*
* @return array $links array of action links
* @access 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;
}
/**
* function to get batch list
*
* @return array array of all batches
* excluding batches with data entry in progress
*/
static function getBatches() {
$dataEntryStatusId = CRM_Core_OptionGroup::getValue('batch_status','Data Entry');
$query = "SELECT id, title
FROM civicrm_batch
WHERE item_count >= 1
AND status_id != {$dataEntryStatusId}
ORDER BY id DESC";
$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
*/
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
*/
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
*
* @return void
*
* @static
* @access 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");
}
switch (self::$_exportFormat) {
case 'CSV':
foreach ($batchIds as $batchId) {
$export[$batchId] = $exporter->generateExportQuery($batchId);
}
$exporter->makeCSV($export);
break;
case 'IIF':
foreach ($batchIds as $batchId) {
$export[$batchId] = $exporter->generateExportQuery($batchId);
}
$exporter->makeIIF($export);
break;
}
}
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);
}
/**
* Function to retrieve financial items assigned for a batch
*
* @param int $entityID
* @param array $returnValues
* @param null $notPresent
* @param null $params
* @return Object
*/
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
LEFT JOIN civicrm_entity_financial_trxn ON civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id
LEFT JOIN civicrm_entity_batch ON civicrm_entity_batch.entity_id = civicrm_financial_trxn.id
LEFT OUTER JOIN civicrm_contribution ON civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id AND civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
LEFT OUTER JOIN civicrm_grant ON civicrm_grant.id = civicrm_entity_financial_trxn.entity_id AND civicrm_entity_financial_trxn.entity_table = 'civicrm_grant'
LEFT JOIN civicrm_financial_type ON civicrm_financial_type.id = IFNULL(civicrm_contribution.financial_type_id, civicrm_grant.financial_type_id)
LEFT JOIN civicrm_contact contact_a ON contact_a.id = IFNULL(civicrm_contribution.contact_id, civicrm_grant.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',
'contribution_payment_instrument_id',
'contribution_transaction_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";