3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
12 use Civi\Payment\PropertyBag
;
13 use Civi\Payment\Exception\PaymentProcessorException
;
16 * This class provides support for canceling recurring subscriptions.
18 class CRM_Contribute_Form_CancelSubscription
extends CRM_Contribute_Form_ContributionRecur
{
20 protected $_userContext;
25 * The contributor email
29 protected $_donorEmail = '';
32 * Should custom data be suppressed on this form.
34 * We override to suppress custom data because historically it has not been
35 * shown on this form & we don't want to expose it as a by-product of
36 * other change without establishing that it would be good on this form.
40 protected function isSuppressCustomData() {
45 * Set variables up before form is built.
47 * @throws \CRM_Core_Exception
49 public function preProcess() {
52 $cancelRecurTextParams = [
53 'mode' => $this->_mode
,
54 'amount' => $this->getSubscriptionDetails()->amount
,
55 'currency' => $this->getSubscriptionDetails()->currency
,
56 'frequency_interval' => $this->getSubscriptionDetails()->frequency_interval
,
57 'frequency_unit' => $this->getSubscriptionDetails()->frequency_unit
,
58 'installments' => $this->getSubscriptionDetails()->installments
,
59 'selfService' => $this->isSelfService(),
63 // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
64 if ($this->getSubscriptionDetails()->membership_id
) {
65 $this->_mid
= $this->getSubscriptionDetails()->membership_id
;
70 $this->_mode
= 'auto_renew';
71 // CRM-18468: crid is more accurate than mid for getting
72 // subscriptionDetails, so don't get them again.
74 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
75 $membershipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_mid
, 'membership_type_id');
76 $membershipType = $membershipTypes[$membershipTypeId] ??
'';
77 $this->assign('membershipType', $membershipType);
78 $cancelRecurTextParams['membershipType'] = $membershipType;
82 if (CRM_Contribute_BAO_Contribution
::isSubscriptionCancelled($this->_coid
)) {
83 CRM_Core_Error
::statusBounce(ts('The recurring contribution looks to have been cancelled already.'));
85 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
89 (!$this->_crid
&& !$this->_coid
&& !$this->_mid
) ||
90 (!$this->getSubscriptionDetails())
92 CRM_Core_Error
::statusBounce(ts('Required information missing.'));
95 $this->assign('cancelRecurDetailText', $this->_paymentProcessorObj
->getText('cancelRecurDetailText', $cancelRecurTextParams));
97 // handle context redirection
98 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
100 $this->setTitle($this->_mid ?
ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
101 $this->assign('mode', $this->_mode
);
103 if ($this->isSelfService()) {
104 unset($this->entityFields
['send_cancel_request'], $this->entityFields
['is_notify']);
107 if ($this->getSubscriptionDetails()->contact_id
) {
108 list($this->_donorDisplayName
, $this->_donorEmail
)
109 = CRM_Contact_BAO_Contact
::getContactDetails($this->getSubscriptionDetails()->contact_id
);
114 * Set entity fields for this cancellation.
116 public function setEntityFields() {
117 $this->entityFields
= [
118 'cancel_reason' => ['name' => 'cancel_reason'],
120 $this->entityFields
['send_cancel_request'] = [
121 'title' => ts('Send cancellation request?'),
122 'name' => 'send_cancel_request',
123 'not-auto-addable' => TRUE,
125 $this->entityFields
['is_notify'] = [
126 'title' => ts('Notify Contributor?'),
127 'name' => 'is_notify',
128 'not-auto-addable' => TRUE,
133 * Build the form object.
135 public function buildQuickForm() {
136 $this->buildQuickEntityForm();
137 // Determine if we can cancel recurring contribution via API with this processor
138 if ($this->_paymentProcessorObj
->supports('CancelRecurringNotifyOptional')) {
139 $this->addRadio('send_cancel_request', ts('Send cancellation request to %1 ?', [1 => $this->_paymentProcessorObj
->getTitle()]), [ts('No'), ts('Yes')]);
142 $this->assign('cancelRecurNotSupportedText', $this->_paymentProcessorObj
->getText('cancelRecurNotSupportedText', []));
145 if (!empty($this->_donorEmail
)) {
146 $this->add('checkbox', 'is_notify', ts('Notify Contributor?') . " ({$this->_donorEmail})");
149 $cancelButton = ts('Cancel Automatic Membership Renewal');
152 $cancelButton = ts('Cancel Recurring Contribution');
156 if ($this->isSelfService()) {
163 'name' => $cancelButton,
164 'spacing' => ' ',
169 'name' => ts('Not Now'),
175 * Set default values for the form.
178 * array of default values
180 public function setDefaultValues() {
182 'send_cancel_request' => 1,
187 * Process the form submission.
189 * @throws \CRM_Core_Exception
190 * @throws \API_Exception
192 public function postProcess() {
194 $params = $this->controller
->exportValues($this->_name
);
196 if ($this->isSelfService()) {
197 // for self service force sending-request & notify
198 if ($this->_paymentProcessorObj
->supports('cancelRecurring')) {
199 $params['send_cancel_request'] = 1;
202 if (!empty($this->_donorEmail
)) {
203 $params['is_notify'] = 1;
208 $propertyBag = new PropertyBag();
209 if (isset($params['send_cancel_request'])) {
210 $propertyBag->setIsNotifyProcessorOnCancelRecur(!empty($params['send_cancel_request']));
212 $propertyBag->setContributionRecurID($this->getSubscriptionDetails()->recur_id
);
213 $propertyBag->setRecurProcessorID($this->getSubscriptionDetails()->processor_id
);
214 $message = $this->_paymentProcessorObj
->doCancelRecurring($propertyBag)['message'];
216 catch (PaymentProcessorException
$e) {
217 CRM_Core_Error
::statusBounce($e->getMessage());
221 civicrm_api3('ContributionRecur', 'cancel', [
222 'id' => $this->getSubscriptionDetails()->recur_id
,
223 'membership_id' => $this->_mid
,
224 'processor_message' => $message,
225 'cancel_reason' => $this->getSubmittedValue('cancel_reason'),
230 $inputParams = ['id' => $this->_mid
];
231 CRM_Member_BAO_Membership
::getValues($inputParams, $tplParams);
232 $tplParams = $tplParams[$this->_mid
];
233 $tplParams['membership_status']
234 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
235 $tplParams['membershipType']
236 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
237 $status = ts('The automatic renewal of your %1 membership has been cancelled as requested. This does not affect the status of your membership - you will receive a separate notification when your membership is up for renewal.', [1 => $tplParams['membershipType']]);
238 $msgTitle = 'Membership Renewal Cancelled';
242 $status = ts('The recurring contribution of %1, every %2 %3 has been cancelled.',
244 1 => CRM_Utils_Money
::format($this->getSubscriptionDetails()->amount
, $this->getSubscriptionDetails()->currency
),
245 2 => $this->getSubscriptionDetails()->frequency_interval
,
246 3 => $this->getSubscriptionDetails()->frequency_unit
,
249 $msgTitle = 'Contribution Cancelled';
250 $msgType = 'success';
253 if (CRM_Utils_Array
::value('is_notify', $params) == 1) {
257 'groupName' => $this->_mode
== 'auto_renew' ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
258 'valueName' => $this->_mode
== 'auto_renew' ?
'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
259 'contactId' => $this->getSubscriptionDetails()->contact_id
,
260 'tplParams' => $tplParams,
261 'tokenContext' => ['contribution_recurId' => $this->getContributionRecurID()],
262 //'isTest' => $isTest, set this from _objects
263 'PDFFilename' => 'receipt.pdf',
264 'from' => CRM_Contribute_BAO_ContributionRecur
::getRecurFromAddress($this->getContributionRecurID()),
265 'toName' => $this->_donorDisplayName
,
266 'toEmail' => $this->_donorEmail
,
268 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
271 catch (CiviCRM_API3_Exception
$e) {
273 $msgTitle = ts('Error');
274 if ($params['send_cancel_request'] == 1) {
275 $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.');
278 $status = ts('Recurring contribution could not be cancelled in the database.');
282 $userID = CRM_Core_Session
::getLoggedInContactID();
283 if ($userID && $status) {
284 CRM_Core_Session
::singleton()->setStatus($status, $msgTitle, $msgType);
288 CRM_Utils_System
::setUFMessage($status);
289 // keep result as 1, since we not displaying anything on the redirected page anyway
290 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
291 'reset=1&task=cancel&result=1'));