3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2019
34 * This class generates form components generic to recurring contributions.
36 * It delegates the work to lower level subclasses and integrates the changes
37 * back in. It also uses a lot of functionality with the CRM API's, so any change
38 * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
40 class CRM_Contribute_Form_UpdateSubscription
extends CRM_Contribute_Form_ContributionRecur
{
42 protected $_subscriptionDetails = NULL;
44 protected $_selfService = FALSE;
46 public $_paymentProcessor = NULL;
48 public $_paymentProcessorObj = NULL;
51 * Fields that affect the schedule and are defined as editable by the processor.
55 protected $editableScheduleFields = [];
58 * The id of the contact associated with this recurring contribution.
65 * Pre-processing for the form.
69 public function preProcess() {
72 $this->setAction(CRM_Core_Action
::UPDATE
);
74 if ($this->contributionRecurID
) {
76 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getPaymentProcessorForRecurringContribution($this->contributionRecurID
);
78 catch (CRM_Core_Exception
$e) {
79 CRM_Core_Error
::statusBounce(ts('There is no valid processor for this subscription so it cannot be edited.'));
81 catch (CiviCRM_API3_Exception
$e) {
82 CRM_Core_Error
::statusBounce(ts('There is no valid processor for this subscription so it cannot be edited.'));
84 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->contributionRecurID
);
88 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'info');
89 // @todo test & replace with $this->_paymentProcessorObj = Civi\Payment\System::singleton()->getById($this->_paymentProcessor['id']);
90 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
91 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_coid
, 'contribution');
92 $this->contributionRecurID
= $this->_subscriptionDetails
->recur_id
;
94 elseif ($this->contributionRecurID
) {
95 $this->_coid
= CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->contributionRecurID
, 'id', 'contribution_recur_id');
98 if (!$this->contributionRecurID ||
!$this->_subscriptionDetails
) {
99 CRM_Core_Error
::statusBounce(ts('Required information missing.'));
102 if ($this->_subscriptionDetails
->membership_id
&& $this->_subscriptionDetails
->auto_renew
) {
103 // Add Membership details to form
104 $membership = civicrm_api3('Membership', 'get', [
105 'contribution_recur_id' => $this->contributionRecurID
,
107 if (!empty($membership['count'])) {
108 $membershipDetails = reset($membership['values']);
109 $values['membership_id'] = $membershipDetails['id'];
110 $values['membership_name'] = $membershipDetails['membership_name'];
112 $this->assign('recurMembership', $values);
113 $this->assign('contactId', $this->_subscriptionDetails
->contact_id
);
116 if (!CRM_Core_Permission
::check('edit contributions')) {
117 if ($this->_subscriptionDetails
->contact_id
!= $this->getContactID()) {
118 CRM_Core_Error
::statusBounce(ts('You do not have permission to update subscription.'));
120 $this->_selfService
= TRUE;
122 $this->assign('self_service', $this->_selfService
);
124 $this->editableScheduleFields
= $this->_paymentProcessorObj
->getEditableRecurringScheduleFields();
126 $changeHelpText = $this->_paymentProcessorObj
->getRecurringScheduleUpdateHelpText();
127 if (!in_array('amount', $this->editableScheduleFields
)) {
128 // Not sure if this is good behaviour - maintaining this existing behaviour for now.
129 CRM_Core_Session
::setStatus($changeHelpText, ts('Warning'), 'alert');
132 $this->assign('changeHelpText', $changeHelpText);
134 $alreadyHardCodedFields = ['amount', 'installments'];
135 foreach ($this->editableScheduleFields
as $editableScheduleField) {
136 if (!in_array($editableScheduleField, $alreadyHardCodedFields)) {
137 $this->addField($editableScheduleField, ['entity' => 'ContributionRecur'], FALSE, FALSE);
141 // when custom data is included in this page
142 if (!empty($_POST['hidden_custom'])) {
143 CRM_Custom_Form_CustomData
::preProcess($this, NULL, NULL, 1, 'ContributionRecur', $this->contributionRecurID
);
144 CRM_Custom_Form_CustomData
::buildQuickForm($this);
145 CRM_Custom_Form_CustomData
::setDefaultValues($this);
148 $this->assign('editableScheduleFields', array_diff($this->editableScheduleFields
, $alreadyHardCodedFields));
150 if ($this->_subscriptionDetails
->contact_id
) {
151 list($this->_donorDisplayName
, $this->_donorEmail
) = CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
154 CRM_Utils_System
::setTitle(ts('Update Recurring Contribution'));
156 // Handle context redirection.
157 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
161 * Set default values for the form.
163 * Note that in edit/view mode the default values are retrieved from the database.
165 public function setDefaultValues() {
166 $this->_defaults
= [];
167 $this->_defaults
['amount'] = $this->_subscriptionDetails
->amount
;
168 $this->_defaults
['installments'] = $this->_subscriptionDetails
->installments
;
169 $this->_defaults
['campaign_id'] = $this->_subscriptionDetails
->campaign_id
;
170 $this->_defaults
['financial_type_id'] = $this->_subscriptionDetails
->financial_type_id
;
171 $this->_defaults
['is_notify'] = 1;
172 foreach ($this->editableScheduleFields
as $field) {
173 $this->_defaults
[$field] = isset($this->_subscriptionDetails
->$field) ?
$this->_subscriptionDetails
->$field : NULL;
176 return $this->_defaults
;
180 * Actually build the components of the form.
182 public function buildQuickForm() {
183 // CRM-16398: If current recurring contribution got > 1 lineitems then make amount field readonly
184 $amtAttr = ['size' => 20];
185 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->_coid
);
186 if (count($lineItems) > 1) {
187 $amtAttr +
= ['readonly' => TRUE];
189 $this->addMoney('amount', ts('Recurring Contribution Amount'), TRUE, $amtAttr,
190 TRUE, 'currency', $this->_subscriptionDetails
->currency
, TRUE
193 $this->add('text', 'installments', ts('Number of Installments'), ['size' => 20], FALSE);
195 if ($this->_donorEmail
) {
196 $this->add('checkbox', 'is_notify', ts('Notify Contributor?'));
199 if (CRM_Core_Permission
::check('edit contributions')) {
200 CRM_Campaign_BAO_Campaign
::addCampaign($this, $this->_subscriptionDetails
->campaign_id
);
203 if (CRM_Contribute_BAO_ContributionRecur
::supportsFinancialTypeChange($this->contributionRecurID
)) {
204 $this->addEntityRef('financial_type_id', ts('Financial Type'), ['entity' => 'FinancialType'], !$this->_selfService
);
208 $this->assign('customDataType', 'ContributionRecur');
209 $this->assign('entityID', $this->contributionRecurID
);
212 if ($this->_selfService
) {
216 // define the buttons
220 'name' => ts('Save'),
225 'name' => ts('Cancel'),
232 * Called after the user submits the form.
234 public function postProcess() {
235 // store the submitted values in an array
236 $params = $this->exportValues();
238 if ($this->_selfService
&& $this->_donorEmail
) {
239 // for self service force notify
240 $params['is_notify'] = 1;
243 // if this is an update of an existing recurring contribution, pass the ID
244 $params['id'] = $this->_subscriptionDetails
->recur_id
;
247 $params['subscriptionId'] = $this->_subscriptionDetails
->subscription_id
;
248 $updateSubscription = TRUE;
249 if ($this->_paymentProcessorObj
->supports('changeSubscriptionAmount')) {
250 $updateSubscription = $this->_paymentProcessorObj
->changeSubscriptionAmount($message, $params);
252 if (is_a($updateSubscription, 'CRM_Core_Error')) {
253 CRM_Core_Error
::displaySessionError($updateSubscription);
254 $status = ts('Could not update the Recurring contribution details');
255 $msgTitle = ts('Update Error');
258 elseif ($updateSubscription) {
259 // Handle custom data
260 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params, $this->contributionRecurID
, 'ContributionRecur');
262 CRM_Contribute_BAO_ContributionRecur
::add($params);
263 $status = ts('Recurring contribution has been updated to: %1, every %2 %3(s) for %4 installments.',
265 1 => CRM_Utils_Money
::format($params['amount'], $this->_subscriptionDetails
->currency
),
266 2 => $this->_subscriptionDetails
->frequency_interval
,
267 3 => $this->_subscriptionDetails
->frequency_unit
,
268 4 => $params['installments'],
272 $msgTitle = ts('Update Success');
273 $msgType = 'success';
274 $msg = ts('Recurring Contribution Updated');
275 $contactID = $this->_subscriptionDetails
->contact_id
;
277 if ($this->_subscriptionDetails
->amount
!= $params['amount']) {
278 $message .= "<br /> " . ts("Recurring contribution amount has been updated from %1 to %2 for this subscription.",
280 1 => CRM_Utils_Money
::format($this->_subscriptionDetails
->amount
, $this->_subscriptionDetails
->currency
),
281 2 => CRM_Utils_Money
::format($params['amount'], $this->_subscriptionDetails
->currency
),
283 if ($this->_subscriptionDetails
->amount
< $params['amount']) {
284 $msg = ts('Recurring Contribution Updated - increased installment amount');
287 $msg = ts('Recurring Contribution Updated - decreased installment amount');
291 if ($this->_subscriptionDetails
->installments
!= $params['installments']) {
292 $message .= "<br /> " . ts("Recurring contribution installments have been updated from %1 to %2 for this subscription.", [
293 1 => $this->_subscriptionDetails
->installments
,
294 2 => $params['installments'],
299 'source_contact_id' => $contactID,
300 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Update Recurring Contribution'),
302 'details' => $message,
303 'activity_date_time' => date('YmdHis'),
304 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
307 $session = CRM_Core_Session
::singleton();
308 $cid = $session->get('userID');
311 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
312 $activityParams['source_contact_id'] = $cid;
314 CRM_Activity_BAO_Activity
::create($activityParams);
316 if (!empty($params['is_notify'])) {
318 if ($this->_subscriptionDetails
->contribution_page_id
) {
319 CRM_Core_DAO
::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id',
320 $this->_subscriptionDetails
->contribution_page_id
, $value, [
323 'receipt_from_email',
326 $receiptFrom = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) . '" <' . $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] . '>';
329 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
330 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
333 list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact
::getContactDetails($contactID);
336 'recur_frequency_interval' => $this->_subscriptionDetails
->frequency_interval
,
337 'recur_frequency_unit' => $this->_subscriptionDetails
->frequency_unit
,
338 'amount' => CRM_Utils_Money
::format($params['amount']),
339 'installments' => $params['installments'],
342 $tplParams['contact'] = ['display_name' => $donorDisplayName];
343 $tplParams['receipt_from_email'] = $receiptFrom;
345 $sendTemplateParams = [
346 'groupName' => 'msg_tpl_workflow_contribution',
347 'valueName' => 'contribution_recurring_edit',
348 'contactId' => $contactID,
349 'tplParams' => $tplParams,
350 'isTest' => $this->_subscriptionDetails
->is_test
,
351 'PDFFilename' => 'receipt.pdf',
352 'from' => $receiptFrom,
353 'toName' => $donorDisplayName,
354 'toEmail' => $donorEmail,
356 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
360 $session = CRM_Core_Session
::singleton();
361 $userID = $session->get('userID');
362 if ($userID && $status) {
363 CRM_Core_Session
::setStatus($status, $msgTitle, $msgType);
367 CRM_Utils_System
::setUFMessage($status);
369 // keep result as 1, since we not displaying anything on the redirected page anyway
370 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
371 "reset=1&task=update&result=1"));