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 +--------------------------------------------------------------------+
14 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This class generates form components generic to recurring contributions.
21 * It delegates the work to lower level subclasses and integrates the changes
22 * back in. It also uses a lot of functionality with the CRM API's, so any change
23 * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
25 class CRM_Contribute_Form_UpdateSubscription
extends CRM_Contribute_Form_ContributionRecur
{
27 protected $_subscriptionDetails = NULL;
29 public $_paymentProcessor = NULL;
31 public $_paymentProcessorObj = NULL;
34 * Fields that affect the schedule and are defined as editable by the processor.
38 protected $editableScheduleFields = [];
41 * The id of the contact associated with this recurring contribution.
48 * Pre-processing for the form.
52 public function preProcess() {
55 $this->setAction(CRM_Core_Action
::UPDATE
);
58 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'info');
59 // @todo test & replace with $this->_paymentProcessorObj = Civi\Payment\System::singleton()->getById($this->_paymentProcessor['id']);
60 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
61 $this->contributionRecurID
= $this->_subscriptionDetails
->recur_id
;
63 elseif ($this->contributionRecurID
) {
64 $this->_coid
= CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->contributionRecurID
, 'id', 'contribution_recur_id');
67 if (!$this->contributionRecurID ||
!$this->_subscriptionDetails
) {
68 CRM_Core_Error
::statusBounce(ts('Required information missing.'));
71 if ($this->_subscriptionDetails
->membership_id
&& $this->_subscriptionDetails
->auto_renew
) {
72 // Add Membership details to form
73 $membership = civicrm_api3('Membership', 'get', [
74 'contribution_recur_id' => $this->contributionRecurID
,
76 if (!empty($membership['count'])) {
77 $membershipDetails = reset($membership['values']);
78 $values['membership_id'] = $membershipDetails['id'];
79 $values['membership_name'] = $membershipDetails['membership_name'];
81 $this->assign('recurMembership', $values);
82 $this->assign('contactId', $this->_subscriptionDetails
->contact_id
);
85 $this->assign('self_service', $this->isSelfService());
87 $this->editableScheduleFields
= $this->_paymentProcessorObj
->getEditableRecurringScheduleFields();
89 $changeHelpText = $this->_paymentProcessorObj
->getRecurringScheduleUpdateHelpText();
90 if (!in_array('amount', $this->editableScheduleFields
)) {
91 // Not sure if this is good behaviour - maintaining this existing behaviour for now.
92 CRM_Core_Session
::setStatus($changeHelpText, ts('Warning'), 'alert');
95 $this->assign('changeHelpText', $changeHelpText);
97 $alreadyHardCodedFields = ['amount', 'installments'];
98 foreach ($this->editableScheduleFields
as $editableScheduleField) {
99 if (!in_array($editableScheduleField, $alreadyHardCodedFields)) {
100 $this->addField($editableScheduleField, ['entity' => 'ContributionRecur'], FALSE, FALSE);
104 // when custom data is included in this page
105 if (!empty($_POST['hidden_custom']) && !$this->isSelfService()) {
106 CRM_Custom_Form_CustomData
::preProcess($this, NULL, NULL, 1, 'ContributionRecur', $this->contributionRecurID
);
107 CRM_Custom_Form_CustomData
::buildQuickForm($this);
108 CRM_Custom_Form_CustomData
::setDefaultValues($this);
111 $this->assign('editableScheduleFields', array_diff($this->editableScheduleFields
, $alreadyHardCodedFields));
113 if ($this->_subscriptionDetails
->contact_id
) {
114 list($this->_donorDisplayName
, $this->_donorEmail
) = CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
117 CRM_Utils_System
::setTitle(ts('Update Recurring Contribution'));
119 // Handle context redirection.
120 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
124 * Set default values for the form.
126 * Note that in edit/view mode the default values are retrieved from the database.
128 public function setDefaultValues() {
129 $this->_defaults
= [];
130 $this->_defaults
['amount'] = $this->_subscriptionDetails
->amount
;
131 $this->_defaults
['installments'] = $this->_subscriptionDetails
->installments
;
132 $this->_defaults
['campaign_id'] = $this->_subscriptionDetails
->campaign_id
;
133 $this->_defaults
['financial_type_id'] = $this->_subscriptionDetails
->financial_type_id
;
134 $this->_defaults
['is_notify'] = 1;
135 foreach ($this->editableScheduleFields
as $field) {
136 $this->_defaults
[$field] = $this->_subscriptionDetails
->$field ??
NULL;
139 return $this->_defaults
;
143 * Actually build the components of the form.
145 public function buildQuickForm() {
146 // CRM-16398: If current recurring contribution got > 1 lineitems then make amount field readonly
147 $amtAttr = ['size' => 20];
148 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->_coid
);
149 if (count($lineItems) > 1) {
150 $amtAttr +
= ['readonly' => TRUE];
152 $this->addMoney('amount', ts('Recurring Contribution Amount'), TRUE, $amtAttr,
153 TRUE, 'currency', $this->_subscriptionDetails
->currency
, TRUE
156 $this->add('text', 'installments', ts('Number of Installments'), ['size' => 20], FALSE);
158 if ($this->_donorEmail
) {
159 $this->add('checkbox', 'is_notify', ts('Notify Contributor?'));
162 if (CRM_Core_Permission
::check('edit contributions')) {
163 CRM_Campaign_BAO_Campaign
::addCampaign($this, $this->_subscriptionDetails
->campaign_id
);
166 if (CRM_Contribute_BAO_ContributionRecur
::supportsFinancialTypeChange($this->contributionRecurID
)) {
167 $this->addEntityRef('financial_type_id', ts('Financial Type'), ['entity' => 'FinancialType'], !$this->isSelfService());
171 $this->assign('customDataType', 'ContributionRecur');
172 $this->assign('entityID', $this->contributionRecurID
);
175 if ($this->isSelfService()) {
179 // define the buttons
183 'name' => ts('Save'),
188 'name' => ts('Cancel'),
194 * Called after the user submits the form.
196 public function postProcess() {
197 // store the submitted values in an array
198 $params = $this->exportValues();
200 if ($this->isSelfService() && $this->_donorEmail
) {
201 // for self service force notify
202 $params['is_notify'] = 1;
205 // if this is an update of an existing recurring contribution, pass the ID
206 $params['id'] = $this->_subscriptionDetails
->recur_id
;
209 $params['subscriptionId'] = $this->getSubscriptionDetails()->processor_id
;
210 $updateSubscription = TRUE;
211 if ($this->_paymentProcessorObj
->supports('changeSubscriptionAmount')) {
213 $updateSubscription = $this->_paymentProcessorObj
->changeSubscriptionAmount($message, $params);
215 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
216 CRM_Core_Error
::statusBounce($e->getMessage());
219 if (is_a($updateSubscription, 'CRM_Core_Error')) {
220 CRM_Core_Error
::displaySessionError($updateSubscription);
221 $status = ts('Could not update the Recurring contribution details');
222 $msgTitle = ts('Update Error');
225 elseif ($updateSubscription) {
226 // Handle custom data
227 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params, $this->contributionRecurID
, 'ContributionRecur');
229 CRM_Contribute_BAO_ContributionRecur
::add($params);
230 $status = ts('Recurring contribution has been updated to: %1, every %2 %3(s) for %4 installments.',
232 1 => CRM_Utils_Money
::format($params['amount'], $this->_subscriptionDetails
->currency
),
233 2 => $this->_subscriptionDetails
->frequency_interval
,
234 3 => $this->_subscriptionDetails
->frequency_unit
,
235 4 => $params['installments'],
239 $msgTitle = ts('Update Success');
240 $msgType = 'success';
241 $msg = ts('Recurring Contribution Updated');
242 $contactID = $this->_subscriptionDetails
->contact_id
;
244 if ($this->_subscriptionDetails
->amount
!= $params['amount']) {
245 $message .= "<br /> " . ts("Recurring contribution amount has been updated from %1 to %2 for this subscription.",
247 1 => CRM_Utils_Money
::format($this->_subscriptionDetails
->amount
, $this->_subscriptionDetails
->currency
),
248 2 => CRM_Utils_Money
::format($params['amount'], $this->_subscriptionDetails
->currency
),
250 if ($this->_subscriptionDetails
->amount
< $params['amount']) {
251 $msg = ts('Recurring Contribution Updated - increased installment amount');
254 $msg = ts('Recurring Contribution Updated - decreased installment amount');
258 if ($this->_subscriptionDetails
->installments
!= $params['installments']) {
259 $message .= "<br /> " . ts("Recurring contribution installments have been updated from %1 to %2 for this subscription.", [
260 1 => $this->_subscriptionDetails
->installments
,
261 2 => $params['installments'],
266 'source_contact_id' => $contactID,
267 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Update Recurring Contribution'),
269 'details' => $message,
270 'activity_date_time' => date('YmdHis'),
271 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
274 $session = CRM_Core_Session
::singleton();
275 $cid = $session->get('userID');
278 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
279 $activityParams['source_contact_id'] = $cid;
281 CRM_Activity_BAO_Activity
::create($activityParams);
283 if (!empty($params['is_notify'])) {
285 if ($this->_subscriptionDetails
->contribution_page_id
) {
286 CRM_Core_DAO
::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id',
287 $this->_subscriptionDetails
->contribution_page_id
, $value, [
290 'receipt_from_email',
293 $receiptFrom = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) . '" <' . $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] . '>';
296 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
297 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
300 list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact
::getContactDetails($contactID);
303 'recur_frequency_interval' => $this->_subscriptionDetails
->frequency_interval
,
304 'recur_frequency_unit' => $this->_subscriptionDetails
->frequency_unit
,
305 'amount' => CRM_Utils_Money
::format($params['amount']),
306 'installments' => $params['installments'],
309 $tplParams['contact'] = ['display_name' => $donorDisplayName];
310 $tplParams['receipt_from_email'] = $receiptFrom;
312 $sendTemplateParams = [
313 'groupName' => 'msg_tpl_workflow_contribution',
314 'valueName' => 'contribution_recurring_edit',
315 'contactId' => $contactID,
316 'tplParams' => $tplParams,
317 'isTest' => $this->_subscriptionDetails
->is_test
,
318 'PDFFilename' => 'receipt.pdf',
319 'from' => $receiptFrom,
320 'toName' => $donorDisplayName,
321 'toEmail' => $donorEmail,
323 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
327 $session = CRM_Core_Session
::singleton();
328 $userID = $session->get('userID');
329 if ($userID && $status) {
330 CRM_Core_Session
::setStatus($status, $msgTitle, $msgType);
334 CRM_Utils_System
::setUFMessage($status);
336 // keep result as 1, since we not displaying anything on the redirected page anyway
337 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
338 "reset=1&task=update&result=1"));