| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | Copyright CiviCRM LLC. All rights reserved. | |
| 5 | | | |
| 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 | +--------------------------------------------------------------------+ |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * @package CRM |
| 14 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
| 15 | */ |
| 16 | |
| 17 | |
| 18 | /** |
| 19 | * This class generates form components generic to recurring contributions. |
| 20 | * |
| 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. |
| 24 | */ |
| 25 | class CRM_Contribute_Form_UpdateSubscription extends CRM_Contribute_Form_ContributionRecur { |
| 26 | |
| 27 | protected $_subscriptionDetails = NULL; |
| 28 | |
| 29 | public $_paymentProcessor = NULL; |
| 30 | |
| 31 | public $_paymentProcessorObj = NULL; |
| 32 | |
| 33 | /** |
| 34 | * Fields that affect the schedule and are defined as editable by the processor. |
| 35 | * |
| 36 | * @var array |
| 37 | */ |
| 38 | protected $editableScheduleFields = []; |
| 39 | |
| 40 | /** |
| 41 | * The id of the contact associated with this recurring contribution. |
| 42 | * |
| 43 | * @var int |
| 44 | */ |
| 45 | public $_contactID; |
| 46 | |
| 47 | /** |
| 48 | * Pre-processing for the form. |
| 49 | * |
| 50 | * @throws \Exception |
| 51 | */ |
| 52 | public function preProcess() { |
| 53 | |
| 54 | parent::preProcess(); |
| 55 | $this->setAction(CRM_Core_Action::UPDATE); |
| 56 | |
| 57 | if ($this->_coid) { |
| 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; |
| 62 | } |
| 63 | elseif ($this->contributionRecurID) { |
| 64 | $this->_coid = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->contributionRecurID, 'id', 'contribution_recur_id'); |
| 65 | } |
| 66 | |
| 67 | if (!$this->contributionRecurID || !$this->_subscriptionDetails) { |
| 68 | CRM_Core_Error::statusBounce(ts('Required information missing.')); |
| 69 | } |
| 70 | |
| 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, |
| 75 | ]); |
| 76 | if (!empty($membership['count'])) { |
| 77 | $membershipDetails = reset($membership['values']); |
| 78 | $values['membership_id'] = $membershipDetails['id']; |
| 79 | $values['membership_name'] = $membershipDetails['membership_name']; |
| 80 | } |
| 81 | $this->assign('recurMembership', $values); |
| 82 | $this->assign('contactId', $this->_subscriptionDetails->contact_id); |
| 83 | } |
| 84 | |
| 85 | $this->assign('self_service', $this->isSelfService()); |
| 86 | |
| 87 | $this->editableScheduleFields = $this->_paymentProcessorObj->getEditableRecurringScheduleFields(); |
| 88 | |
| 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'); |
| 93 | } |
| 94 | else { |
| 95 | $this->assign('changeHelpText', $changeHelpText); |
| 96 | } |
| 97 | $alreadyHardCodedFields = ['amount', 'installments']; |
| 98 | foreach ($this->editableScheduleFields as $editableScheduleField) { |
| 99 | if (!in_array($editableScheduleField, $alreadyHardCodedFields)) { |
| 100 | $this->addField($editableScheduleField, ['entity' => 'ContributionRecur'], FALSE, FALSE); |
| 101 | } |
| 102 | } |
| 103 | |
| 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); |
| 109 | } |
| 110 | |
| 111 | $this->assign('editableScheduleFields', array_diff($this->editableScheduleFields, $alreadyHardCodedFields)); |
| 112 | |
| 113 | if ($this->_subscriptionDetails->contact_id) { |
| 114 | list($this->_donorDisplayName, $this->_donorEmail) = CRM_Contact_BAO_Contact::getContactDetails($this->_subscriptionDetails->contact_id); |
| 115 | } |
| 116 | |
| 117 | CRM_Utils_System::setTitle(ts('Update Recurring Contribution')); |
| 118 | |
| 119 | // Handle context redirection. |
| 120 | CRM_Contribute_BAO_ContributionRecur::setSubscriptionContext(); |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Set default values for the form. |
| 125 | * |
| 126 | * Note that in edit/view mode the default values are retrieved from the database. |
| 127 | */ |
| 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 | foreach ($this->editableScheduleFields as $field) { |
| 135 | $this->_defaults[$field] = $this->_subscriptionDetails->$field ?? NULL; |
| 136 | } |
| 137 | |
| 138 | return $this->_defaults; |
| 139 | } |
| 140 | |
| 141 | /** |
| 142 | * Actually build the components of the form. |
| 143 | */ |
| 144 | public function buildQuickForm() { |
| 145 | // CRM-16398: If current recurring contribution got > 1 lineitems then make amount field readonly |
| 146 | $amtAttr = ['size' => 20]; |
| 147 | $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($this->_coid); |
| 148 | if (count($lineItems) > 1) { |
| 149 | $amtAttr += ['readonly' => TRUE]; |
| 150 | } |
| 151 | $this->addMoney('amount', ts('Recurring Contribution Amount'), TRUE, $amtAttr, |
| 152 | TRUE, 'currency', $this->_subscriptionDetails->currency, TRUE |
| 153 | ); |
| 154 | |
| 155 | $this->add('text', 'installments', ts('Number of Installments'), ['size' => 20], FALSE); |
| 156 | |
| 157 | if ($this->_donorEmail) { |
| 158 | $this->add('checkbox', 'is_notify', ts('Notify Contributor?')); |
| 159 | } |
| 160 | |
| 161 | if (CRM_Core_Permission::check('edit contributions')) { |
| 162 | CRM_Campaign_BAO_Campaign::addCampaign($this, $this->_subscriptionDetails->campaign_id); |
| 163 | } |
| 164 | |
| 165 | if (CRM_Contribute_BAO_ContributionRecur::supportsFinancialTypeChange($this->contributionRecurID)) { |
| 166 | $this->addEntityRef('financial_type_id', ts('Financial Type'), ['entity' => 'FinancialType'], !$this->isSelfService()); |
| 167 | } |
| 168 | |
| 169 | // Add custom data |
| 170 | $this->assign('customDataType', 'ContributionRecur'); |
| 171 | $this->assign('entityID', $this->contributionRecurID); |
| 172 | |
| 173 | $type = 'next'; |
| 174 | if ($this->isSelfService()) { |
| 175 | $type = 'submit'; |
| 176 | } |
| 177 | |
| 178 | // define the buttons |
| 179 | $this->addButtons([ |
| 180 | [ |
| 181 | 'type' => $type, |
| 182 | 'name' => ts('Save'), |
| 183 | 'isDefault' => TRUE, |
| 184 | ], |
| 185 | [ |
| 186 | 'type' => 'cancel', |
| 187 | 'name' => ts('Cancel'), |
| 188 | ], |
| 189 | ]); |
| 190 | } |
| 191 | |
| 192 | /** |
| 193 | * Called after the user submits the form. |
| 194 | */ |
| 195 | public function postProcess() { |
| 196 | // store the submitted values in an array |
| 197 | $params = $this->exportValues(); |
| 198 | |
| 199 | if ($this->isSelfService() && $this->_donorEmail) { |
| 200 | // for self service force notify |
| 201 | $params['is_notify'] = 1; |
| 202 | } |
| 203 | |
| 204 | // if this is an update of an existing recurring contribution, pass the ID |
| 205 | $params['id'] = $this->_subscriptionDetails->recur_id; |
| 206 | $message = ''; |
| 207 | |
| 208 | $params['subscriptionId'] = $this->getSubscriptionDetails()->processor_id; |
| 209 | $updateSubscription = TRUE; |
| 210 | if ($this->_paymentProcessorObj->supports('changeSubscriptionAmount')) { |
| 211 | try { |
| 212 | $updateSubscription = $this->_paymentProcessorObj->changeSubscriptionAmount($message, $params); |
| 213 | } |
| 214 | catch (\Civi\Payment\Exception\PaymentProcessorException $e) { |
| 215 | CRM_Core_Error::statusBounce($e->getMessage()); |
| 216 | } |
| 217 | } |
| 218 | if (is_a($updateSubscription, 'CRM_Core_Error')) { |
| 219 | CRM_Core_Error::displaySessionError($updateSubscription); |
| 220 | $status = ts('Could not update the Recurring contribution details'); |
| 221 | $msgTitle = ts('Update Error'); |
| 222 | $msgType = 'error'; |
| 223 | } |
| 224 | elseif ($updateSubscription) { |
| 225 | // Handle custom data |
| 226 | $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params, $this->contributionRecurID, 'ContributionRecur'); |
| 227 | // save the changes |
| 228 | CRM_Contribute_BAO_ContributionRecur::add($params); |
| 229 | $status = ts('Recurring contribution has been updated to: %1, every %2 %3(s) for %4 installments.', |
| 230 | [ |
| 231 | 1 => CRM_Utils_Money::format($params['amount'], $this->_subscriptionDetails->currency), |
| 232 | 2 => $this->_subscriptionDetails->frequency_interval, |
| 233 | 3 => $this->_subscriptionDetails->frequency_unit, |
| 234 | 4 => $params['installments'], |
| 235 | ] |
| 236 | ); |
| 237 | |
| 238 | $msgTitle = ts('Update Success'); |
| 239 | $msgType = 'success'; |
| 240 | $msg = ts('Recurring Contribution Updated'); |
| 241 | $contactID = $this->_subscriptionDetails->contact_id; |
| 242 | |
| 243 | if ($this->_subscriptionDetails->amount != $params['amount']) { |
| 244 | $message .= "<br /> " . ts("Recurring contribution amount has been updated from %1 to %2 for this subscription.", |
| 245 | [ |
| 246 | 1 => CRM_Utils_Money::format($this->_subscriptionDetails->amount, $this->_subscriptionDetails->currency), |
| 247 | 2 => CRM_Utils_Money::format($params['amount'], $this->_subscriptionDetails->currency), |
| 248 | ]) . ' '; |
| 249 | if ($this->_subscriptionDetails->amount < $params['amount']) { |
| 250 | $msg = ts('Recurring Contribution Updated - increased installment amount'); |
| 251 | } |
| 252 | else { |
| 253 | $msg = ts('Recurring Contribution Updated - decreased installment amount'); |
| 254 | } |
| 255 | } |
| 256 | |
| 257 | if ($this->_subscriptionDetails->installments != $params['installments']) { |
| 258 | $message .= "<br /> " . ts("Recurring contribution installments have been updated from %1 to %2 for this subscription.", [ |
| 259 | 1 => $this->_subscriptionDetails->installments, |
| 260 | 2 => $params['installments'], |
| 261 | ]) . ' '; |
| 262 | } |
| 263 | |
| 264 | $activityParams = [ |
| 265 | 'source_contact_id' => $contactID, |
| 266 | 'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Update Recurring Contribution'), |
| 267 | 'subject' => $msg, |
| 268 | 'details' => $message, |
| 269 | 'activity_date_time' => date('YmdHis'), |
| 270 | 'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'), |
| 271 | ]; |
| 272 | |
| 273 | $session = CRM_Core_Session::singleton(); |
| 274 | $cid = $session->get('userID'); |
| 275 | |
| 276 | if ($cid) { |
| 277 | $activityParams['target_contact_id'][] = $activityParams['source_contact_id']; |
| 278 | $activityParams['source_contact_id'] = $cid; |
| 279 | } |
| 280 | CRM_Activity_BAO_Activity::create($activityParams); |
| 281 | |
| 282 | if (!empty($params['is_notify'])) { |
| 283 | // send notification |
| 284 | if ($this->_subscriptionDetails->contribution_page_id) { |
| 285 | CRM_Core_DAO::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id', |
| 286 | $this->_subscriptionDetails->contribution_page_id, $value, [ |
| 287 | 'title', |
| 288 | 'receipt_from_name', |
| 289 | 'receipt_from_email', |
| 290 | ] |
| 291 | ); |
| 292 | $receiptFrom = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$this->_subscriptionDetails->contribution_page_id]) . '" <' . $value[$this->_subscriptionDetails->contribution_page_id]['receipt_from_email'] . '>'; |
| 293 | } |
| 294 | else { |
| 295 | $domainValues = CRM_Core_BAO_Domain::getNameAndEmail(); |
| 296 | $receiptFrom = "$domainValues[0] <$domainValues[1]>"; |
| 297 | } |
| 298 | |
| 299 | list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact::getContactDetails($contactID); |
| 300 | |
| 301 | $tplParams = [ |
| 302 | 'recur_frequency_interval' => $this->_subscriptionDetails->frequency_interval, |
| 303 | 'recur_frequency_unit' => $this->_subscriptionDetails->frequency_unit, |
| 304 | 'amount' => CRM_Utils_Money::format($params['amount']), |
| 305 | 'installments' => $params['installments'], |
| 306 | ]; |
| 307 | |
| 308 | $tplParams['contact'] = ['display_name' => $donorDisplayName]; |
| 309 | $tplParams['receipt_from_email'] = $receiptFrom; |
| 310 | |
| 311 | $sendTemplateParams = [ |
| 312 | 'groupName' => 'msg_tpl_workflow_contribution', |
| 313 | 'valueName' => 'contribution_recurring_edit', |
| 314 | 'contactId' => $contactID, |
| 315 | 'tplParams' => $tplParams, |
| 316 | 'isTest' => $this->_subscriptionDetails->is_test, |
| 317 | 'PDFFilename' => 'receipt.pdf', |
| 318 | 'from' => $receiptFrom, |
| 319 | 'toName' => $donorDisplayName, |
| 320 | 'toEmail' => $donorEmail, |
| 321 | ]; |
| 322 | list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams); |
| 323 | } |
| 324 | } |
| 325 | |
| 326 | $session = CRM_Core_Session::singleton(); |
| 327 | $userID = $session->get('userID'); |
| 328 | if ($userID && $status) { |
| 329 | CRM_Core_Session::setStatus($status, $msgTitle, $msgType); |
| 330 | } |
| 331 | elseif (!$userID) { |
| 332 | if ($status) { |
| 333 | CRM_Utils_System::setUFMessage($status); |
| 334 | } |
| 335 | // keep result as 1, since we not displaying anything on the redirected page anyway |
| 336 | return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus', |
| 337 | "reset=1&task=update&result=1")); |
| 338 | } |
| 339 | } |
| 340 | |
| 341 | } |