3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
36 * This class provides the functionality to email a group of
39 class CRM_Contribute_Form_Task_PDF
extends CRM_Contribute_Form_Task
{
42 * Are we operating in "single mode", i.e. updating the task of only
43 * one specific contribution?
47 public $_single = FALSE;
52 * Build all the data structures needed to build the form
56 function preProcess() {
57 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
62 $this->_contributionIds
= array($id);
63 $this->_componentClause
= " civicrm_contribution.id IN ( $id ) ";
64 $this->_single
= TRUE;
65 $this->assign('totalSelectedContributions', 1);
71 // check that all the contribution ids have pending status
74 FROM civicrm_contribution
75 WHERE contribution_status_id != 1
76 AND {$this->_componentClause}";
77 $count = CRM_Core_DAO
::singleValueQuery($query);
79 CRM_Core_Error
::statusBounce("Please select only online contributions with Completed status.");
82 // we have all the contribution ids, so now we get the contact ids
83 parent
::setContactIDs();
84 $this->assign('single', $this->_single
);
86 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', $this);
87 $urlParams = 'force=1';
88 if (CRM_Utils_Rule
::qfKey($qfKey)) {
89 $urlParams .= "&qfKey=$qfKey";
92 $url = CRM_Utils_System
::url('civicrm/contribute/search', $urlParams);
95 'title' => ts('Search Results'),
98 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
99 CRM_Utils_System
::setTitle(ts('Print Contribution Receipts'));
103 * Build the form object
108 public function buildQuickForm() {
110 $this->addElement('radio', 'output', NULL, ts('Email Receipts'), 'email_receipt',
111 array('onClick' => "document.getElementById('selectPdfFormat').style.display = 'none';")
113 $this->addElement('radio', 'output', NULL, ts('PDF Receipts'), 'pdf_receipt',
114 array('onClick' => "document.getElementById('selectPdfFormat').style.display = 'block';")
116 $this->addRule('output', ts('Selection required'), 'required');
118 $this->add('select', 'pdf_format_id', ts('Page Format'),
119 array(0 => ts('- default -')) + CRM_Core_BAO_PdfFormat
::getList(TRUE)
121 $this->add('checkbox', 'receipt_update', ts('Update receipt dates for these contributions'), FALSE);
122 $this->add('checkbox', 'override_privacy', ts('Override privacy setting? (Do no email / Do not mail)'), FALSE);
124 $this->addButtons(array(
127 'name' => ts('Process Receipt(s)'),
132 'name' => ts('Cancel'),
141 public function setDefaultValues() {
142 $defaultFormat = CRM_Core_BAO_PdfFormat
::getDefaultValues();
143 return array('pdf_format_id' => $defaultFormat['id'], 'receipt_update' => 1, 'override_privacy' => 0);
147 * Process the form after the input has been submitted and validated
152 public function postProcess() {
153 // get all the details needed to generate a receipt
155 $template = CRM_Core_Smarty
::singleton();
157 $params = $this->controller
->exportValues($this->_name
);
158 $elements = self
::getElements($this->_contributionIds
, $params, $this->_contactIds
);
160 foreach ($elements['details'] as $contribID => $detail) {
161 $input = $ids = $objects = array();
163 if (in_array($detail['contact'], $elements['excludeContactIds'])) {
167 $input['component'] = $detail['component'];
169 $ids['contact'] = $detail['contact'];
170 $ids['contribution'] = $contribID;
171 $ids['contributionRecur'] = NULL;
172 $ids['contributionPage'] = NULL;
173 $ids['membership'] = CRM_Utils_Array
::value('membership', $detail);
174 $ids['participant'] = CRM_Utils_Array
::value('participant', $detail);
175 $ids['event'] = CRM_Utils_Array
::value('event', $detail);
177 if (!$elements['baseIPN']->validateData($input, $ids, $objects, FALSE)) {
178 CRM_Core_Error
::fatal();
181 $contribution = &$objects['contribution'];
183 // set some fake input values so we can reuse IPN code
184 $input['amount'] = $contribution->total_amount
;
185 $input['is_test'] = $contribution->is_test
;
186 $input['fee_amount'] = $contribution->fee_amount
;
187 $input['net_amount'] = $contribution->net_amount
;
188 $input['trxn_id'] = $contribution->trxn_id
;
189 $input['trxn_date'] = isset($contribution->trxn_date
) ?
$contribution->trxn_date
: NULL;
191 // CRM_Contribute_BAO_Contribution::composeMessageArray expects mysql formatted date
192 $objects['contribution']->receive_date
= CRM_Utils_Date
::isoToMysql($objects['contribution']->receive_date
);
195 $mail = $elements['baseIPN']->sendMail($input, $ids, $objects, $values, FALSE, $elements['createPdf']);
199 $message[] = $mail['html'];
202 $message[] = nl2br($mail['body']);
205 // reset template values before processing next transactions
206 $template->clearTemplateVars();
207 if (!empty($params['receipt_update'])) {
208 $objects['contribution']->receipt_date
= date('Y-m-d H-i-s');
209 $objects['contribution']->save();
213 if ($elements['createPdf']) {
214 CRM_Utils_PDF_Utils
::html2pdf($message,
215 'civicrmContributionReceipt.pdf',
217 $elements['params']['pdf_format_id']
219 CRM_Utils_System
::civiExit();
222 if ($elements['suppressedEmails']) {
223 $status = ts('Email was NOT sent to %1 contacts (no email address on file, or communication preferences specify DO NOT EMAIL, or contact is deceased).', array(1 => $elements['suppressedEmails']));
224 $msgTitle = ts('Email Error');
228 $status = ts('Your mail has been sent.');
229 $msgTitle = ts('Sent');
230 $msgType = 'success';
232 CRM_Core_Session
::setStatus($status, $msgTitle, $msgType);
237 * Declaration of common variables for Invoice and PDF
240 * @param array $contribIds Contribution Id
241 * @param array $params parameter for pdf or email invoices
242 * @param array $contactIds Contact Id
244 * @return array array of common elements
248 static public function getElements($contribIds, $params, $contactIds) {
249 $pdfElements = array();
251 $pdfElements['contribIDs'] = implode(',', $contribIds);
253 $pdfElements['details'] = CRM_Contribute_Form_Task_Status
::getDetails($pdfElements['contribIDs']);
255 $pdfElements['baseIPN'] = new CRM_Core_Payment_BaseIPN();
257 $pdfElements['params'] = $params;
259 $pdfElements['createPdf'] = FALSE;
260 if (!empty($pdfElements['params']['output']) &&
261 ($pdfElements['params']['output'] == "pdf_invoice" ||
$pdfElements['params']['output'] == "pdf_receipt")) {
262 $pdfElements['createPdf'] = TRUE;
265 $excludeContactIds = array();
266 if (!$pdfElements['createPdf']) {
267 $returnProperties = array(
274 list($contactDetails) = CRM_Utils_Token
::getTokenDetails($contactIds, $returnProperties, FALSE, FALSE);
275 $pdfElements['suppressedEmails'] = 0;
276 $suppressedEmails = 0;
277 foreach ($contactDetails as $id => $values) {
278 if (empty($values['email']) ||
279 (empty($params['override_privacy']) && !empty($values['do_not_email']))
280 || CRM_Utils_Array
::value('is_deceased', $values)
281 ||
!empty($values['on_hold'])) {
283 $pdfElements['suppressedEmails'] = $suppressedEmails;
284 $excludeContactIds[] = $values['contact_id'];
288 $pdfElements['excludeContactIds'] = $excludeContactIds;