CRM/Contribute/Form/UpdateSubscription.php

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