_exportParams = $exportParams;
return $exportParams;
}
/**
* Exports sbatches in $this->_batchIds, and saves to file.
*
* @param string $fileName - use this file name (if applicable)
*/
public function output($fileName = NULL) {
// Default behaviour, override if needed:
self::createActivityExport($this->_batchIds, $fileName);
}
/**
* Abstract function that generates exports, and downloads them as zip file.
*
* @param $exportDaos array with DAO's for queries to be exported.
*/
abstract public function makeExport($exportDaos);
/**
* @return string
*/
public function getMimeType() {
return 'text/plain';
}
/**
* Returns some kind of identification for your export format.
*
* This does not really has to be a file extension, you can name your
* file as you wish as you override output.
*
* @return string
*/
abstract public function getFileExtension();
/**
* @return object
*/
public static function &getTemplate() {
return self::$_template;
}
/**
* @param $var
* @param null $value
*/
public function assign($var, $value = NULL) {
self::$_template->assign($var, $value);
}
/*
* This gets called for every item of data being compiled before being sent to the exporter for output.
*
* Depending on the output format might want to override this, e.g. for IIF tabs need to be escaped etc,
* but for CSV it doesn't make sense because php has built in csv output functions.
*/
/**
* @param $s
* @param string $type
*
* @return null
*/
public static function format($s, $type = 'string') {
if (!empty($s)) {
return $s;
}
else {
return NULL;
}
}
public function initiateDownload() {
if (!$this->_isDownloadFile) {
return NULL;
}
$config = CRM_Core_Config::singleton();
// zip files if more than one.
if (count($this->_downloadFile) > 1) {
$zip = $config->customFileUploadDir . 'Financial_Transactions_' . date('YmdHis') . '.zip';
$result = $this->createZip($this->_downloadFile, $zip, TRUE);
if ($result) {
CRM_Utils_System::setHttpHeader('Content-Type', 'application/zip');
CRM_Utils_System::setHttpHeader('Content-Disposition', 'attachment; filename=' . CRM_Utils_File::cleanFileName(basename($zip)));
CRM_Utils_System::setHttpHeader('Content-Length', '' . filesize($zip));
ob_clean();
flush();
readfile($config->customFileUploadDir . CRM_Utils_File::cleanFileName(basename($zip)));
//delete the zip to avoid clutter.
unlink($zip);
CRM_Utils_System::civiExit();
}
}
else {
CRM_Utils_System::setHttpHeader('Content-Type', 'text/plain');
CRM_Utils_System::setHttpHeader('Content-Disposition', 'attachment; filename=' . CRM_Utils_File::cleanFileName(basename($this->_downloadFile[0])));
CRM_Utils_System::setHttpHeader('Content-Length', '' . filesize($this->_downloadFile[0]));
ob_clean();
flush();
readfile($config->customFileUploadDir . CRM_Utils_File::cleanFileName(basename($this->_downloadFile[0])));
CRM_Utils_System::civiExit();
}
}
/**
* @param $batchIds
* @param string $fileName
*
* @throws CRM_Core_Exception
*/
public static function createActivityExport($batchIds, $fileName) {
$session = CRM_Core_Session::singleton();
$values = [];
$params = ['id' => $batchIds];
CRM_Batch_BAO_Batch::retrieve($params, $values);
$createdBy = CRM_Contact_BAO_Contact::displayName($values['created_id']);
$modifiedBy = CRM_Contact_BAO_Contact::displayName($values['modified_id']);
$values['payment_instrument_id'] = '';
if (isset($values['payment_instrument_id'])) {
$paymentInstrument = array_flip(CRM_Contribute_PseudoConstant::paymentInstrument('label'));
$values['payment_instrument_id'] = array_search($values['payment_instrument_id'], $paymentInstrument);
}
$details = '' . ts('Record:') . ' ' . $values['title'] . '
' . ts('Description:') . '
' . ts('Created By:') . " $createdBy" . '
' . ts('Created Date:') . ' ' . $values['created_date'] . '
' . ts('Last Modified By:') . ' ' . $modifiedBy . '
' . ts('Payment Method:') . ' ' . $values['payment_instrument_id'] . '
';
$subject = '';
if (!empty($values['total'])) {
$subject .= ts('Total') . '[' . CRM_Utils_Money::format($values['total']) . '],';
}
if (!empty($values['item_count'])) {
$subject .= ' ' . ts('Count') . '[' . $values['item_count'] . '],';
}
// create activity.
$subject .= ' ' . ts('Batch') . '[' . $values['title'] . ']';
$activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
$activityParams = [
'activity_type_id' => array_search('Export Accounting Batch', $activityTypes),
'subject' => $subject,
'status_id' => 2,
'activity_date_time' => date('YmdHis'),
'source_contact_id' => $session->get('userID'),
'source_record_id' => $values['id'],
'target_contact_id' => $session->get('userID'),
'details' => $details,
'attachFile_1' => [
'uri' => $fileName,
'type' => 'text/csv',
'location' => $fileName,
'upload_date' => date('YmdHis'),
],
];
CRM_Activity_BAO_Activity::create($activityParams);
}
/**
* @param array $files
* @param null $destination
* @param bool $overwrite
*
* @return bool
*/
public function createZip($files = [], $destination = NULL, $overwrite = FALSE) {
// if the zip file already exists and overwrite is false, return false
if (file_exists($destination) && !$overwrite) {
return FALSE;
}
$valid_files = [];
if (is_array($files)) {
foreach ($files as $file) {
// make sure the file exists
if (file_exists($file)) {
$validFiles[] = $file;
}
}
}
if (count($validFiles)) {
$zip = new ZipArchive();
if ($zip->open($destination, $overwrite ? ZIPARCHIVE::CREATE | ZIPARCHIVE::OVERWRITE : ZIPARCHIVE::CREATE) !== TRUE) {
return FALSE;
}
foreach ($validFiles as $file) {
$zip->addFile($file, CRM_Utils_File::cleanFileName(basename($file)));
}
$zip->close();
return file_exists($destination);
}
else {
return FALSE;
}
}
}