CRM/Contribute/Form/UpdateBilling.php

   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  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This class generates form components for processing a contribution.
  20  */
  21 class CRM_Contribute_Form_UpdateBilling extends CRM_Contribute_Form_ContributionRecur {
  22   protected $_mode = NULL;
  23
  24   protected $_subscriptionDetails = NULL;
  25
  26   public $_bltID = NULL;
  27
  28   /**
  29    * Set variables up before form is built.
  30    *
  31    * @throws \CRM_Core_Exception
  32    */
  33   public function preProcess() {
  34     parent::preProcess();
  35     if ($this->_crid) {
  36       // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
  37       if ($this->getSubscriptionDetails()->membership_id) {
  38         $this->_mid = $this->getSubscriptionDetails()->membership_id;
  39       }
  40     }
  41
  42     if ($this->_coid) {
  43       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'info');
  44       $this->_paymentProcessor['object'] = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'obj');
  45     }
  46
  47     if ($this->_mid) {
  48       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_mid, 'membership', 'info');
  49       $this->_paymentProcessor['object'] = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_mid, 'membership', 'obj');
  50       $membershipTypes = CRM_Member_PseudoConstant::membershipType();
  51       $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_mid, 'membership_type_id');
  52       $this->assign('membershipType', CRM_Utils_Array::value($membershipTypeId, $membershipTypes));
  53       $this->_mode = 'auto_renew';
  54     }
  55
  56     if ((!$this->_crid && !$this->_coid && !$this->_mid) || (!$this->getSubscriptionDetails())) {
  57       throw new CRM_Core_Exception('Required information missing.');
  58     }
  59
  60     if (!$this->_paymentProcessor['object']->supports('updateSubscriptionBillingInfo')) {
  61       throw new CRM_Core_Exception(ts("%1 processor doesn't support updating subscription billing details.",
  62         [1 => $this->_paymentProcessor['title']]
  63       ));
  64     }
  65     $this->assign('paymentProcessor', $this->_paymentProcessor);
  66
  67     $this->assignBillingType();
  68
  69     $this->assign('frequency_unit', $this->getSubscriptionDetails()->frequency_unit);
  70     $this->assign('frequency_interval', $this->getSubscriptionDetails()->frequency_interval);
  71     $this->assign('amount', $this->getSubscriptionDetails()->amount);
  72     $this->assign('installments', $this->getSubscriptionDetails()->installments);
  73     $this->assign('mode', $this->_mode);
  74
  75     // handle context redirection
  76     CRM_Contribute_BAO_ContributionRecur::setSubscriptionContext();
  77   }
  78
  79   /**
  80    * Set the default values of various form elements.
  81    *
  82    * @return array
  83    *   Default values
  84    */
  85   public function setDefaultValues() {
  86     $this->_defaults = [];
  87
  88     if ($this->getSubscriptionDetails()->contact_id) {
  89       $fields = [];
  90       $names = array(
  91         'first_name',
  92         'middle_name',
  93         'last_name',
  94         "street_address-{$this->_bltID}",
  95         "city-{$this->_bltID}",
  96         "postal_code-{$this->_bltID}",
  97         "country_id-{$this->_bltID}",
  98         "state_province_id-{$this->_bltID}",
  99       );
 100       foreach ($names as $name) {
 101         $fields[$name] = 1;
 102       }
 103       $fields["state_province-{$this->_bltID}"] = 1;
 104       $fields["country-{$this->_bltID}"] = 1;
 105       $fields["email-{$this->_bltID}"] = 1;
 106       $fields['email-Primary'] = 1;
 107
 108       CRM_Core_BAO_UFGroup::setProfileDefaults($this->getSubscriptionDetails()->contact_id, $fields, $this->_defaults);
 109
 110       // use primary email address if billing email address is empty
 111       if (empty($this->_defaults["email-{$this->_bltID}"]) &&
 112         !empty($this->_defaults['email-Primary'])
 113       ) {
 114         $this->_defaults["email-{$this->_bltID}"] = $this->_defaults['email-Primary'];
 115       }
 116
 117       foreach ($names as $name) {
 118         if (!empty($this->_defaults[$name])) {
 119           $this->_defaults['billing_' . $name] = $this->_defaults[$name];
 120         }
 121       }
 122     }
 123
 124     $config = CRM_Core_Config::singleton();
 125     // set default country from config if no country set
 126     if (empty($this->_defaults["billing_country_id-{$this->_bltID}"])) {
 127       $this->_defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 128     }
 129
 130     return $this->_defaults;
 131   }
 132
 133   /**
 134    * Build the form object.
 135    */
 136   public function buildQuickForm() {
 137     $type = 'next';
 138     if ($this->isSelfService()) {
 139       $type = 'submit';
 140     }
 141
 142     $this->addButtons(array(
 143       array(
 144         'type' => $type,
 145         'name' => ts('Save'),
 146         'isDefault' => TRUE,
 147       ),
 148       array(
 149         'type' => 'cancel',
 150         'name' => ts('Cancel'),
 151       ),
 152     ));
 153
 154     CRM_Core_Payment_Form::buildPaymentForm($this, $this->_paymentProcessor, TRUE, TRUE);
 155     $this->addFormRule(array('CRM_Contribute_Form_UpdateBilling', 'formRule'), $this);
 156   }
 157
 158   /**
 159    * Global form rule.
 160    *
 161    * @param array $fields
 162    *   The input form values.
 163    * @param array $files
 164    *   The uploaded files if any.
 165    * @param CRM_Core_Form $self
 166    *
 167    *
 168    * @return bool|array
 169    *   true if no errors, else array of errors
 170    */
 171   public static function formRule($fields, $files, $self) {
 172     $errors = [];
 173     CRM_Core_Form::validateMandatoryFields($self->_fields, $fields, $errors);
 174
 175     // validate the payment instrument values (e.g. credit card number)
 176     CRM_Core_Payment_Form::validatePaymentInstrument($self->_paymentProcessor['id'], $fields, $errors, NULL);
 177
 178     return empty($errors) ? TRUE : $errors;
 179   }
 180
 181   /**
 182    * Process the form.
 183    */
 184   public function postProcess() {
 185     $params = $this->controller->exportValues($this->_name);
 186     $status = NULL;
 187
 188     // now set the values for the billing location.
 189     foreach ($this->_fields as $name => $value) {
 190       $fields[$name] = 1;
 191     }
 192     $fields["email-{$this->_bltID}"] = 1;
 193
 194     $processorParams = [];
 195     foreach ($params as $key => $val) {
 196       $key = str_replace('billing_', '', $key);
 197       list($key) = explode('-', $key);
 198       $processorParams[$key] = $val;
 199     }
 200     $processorParams['state_province'] = CRM_Core_PseudoConstant::stateProvince($params["billing_state_province_id-{$this->_bltID}"], FALSE);
 201     $processorParams['country'] = CRM_Core_PseudoConstant::country($params["billing_country_id-{$this->_bltID}"], FALSE);
 202     $processorParams['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($processorParams);
 203     $processorParams['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($processorParams);
 204     $processorParams['recurProcessorID'] = $processorParams['subscriptionId'] = $this->getSubscriptionDetails()->processor_id;
 205     $processorParams['amount'] = $this->getSubscriptionDetails()->amount;
 206     $processorParams['contributionRecurID'] = $this->getContributionRecurID();
 207     $message = '';
 208     $updateSubscription = $this->_paymentProcessor['object']->updateSubscriptionBillingInfo($message, $processorParams);
 209     if (is_a($updateSubscription, 'CRM_Core_Error')) {
 210       CRM_Core_Error::displaySessionError($updateSubscription);
 211     }
 212     elseif ($updateSubscription) {
 213       $ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->getSubscriptionDetails()->contact_id, 'contact_type');
 214       CRM_Contact_BAO_Contact::createProfileContact($params,
 215         $fields,
 216         $this->getSubscriptionDetails()->contact_id,
 217         NULL,
 218         NULL,
 219         $ctype
 220       );
 221
 222       // build tpl params
 223       if ($this->getSubscriptionDetails()->membership_id) {
 224         $inputParams = array('id' => $this->getSubscriptionDetails()->membership_id);
 225         CRM_Member_BAO_Membership::getValues($inputParams, $tplParams);
 226         $tplParams = $tplParams[$this->getSubscriptionDetails()->membership_id];
 227         $tplParams['membership_status'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
 228         $tplParams['membershipType'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
 229         $status = ts('Billing details for your automatically renewed %1 membership have been updated.',
 230           [1 => $tplParams['membershipType']]
 231         );
 232         $msgTitle = ts('Details Updated');
 233         $msgType = 'success';
 234       }
 235       else {
 236         $status = ts('Billing details for the recurring contribution of %1, every %2 %3 have been updated.',
 237           array(
 238             1 => $this->getSubscriptionDetails()->amount,
 239             2 => $this->getSubscriptionDetails()->frequency_interval,
 240             3 => $this->getSubscriptionDetails()->frequency_unit,
 241           )
 242         );
 243         $msgTitle = ts('Details Updated');
 244         $msgType = 'success';
 245
 246         $tplParams = array(
 247           'recur_frequency_interval' => $this->getSubscriptionDetails()->frequency_interval,
 248           'recur_frequency_unit' => $this->getSubscriptionDetails()->frequency_unit,
 249           'amount' => $this->getSubscriptionDetails()->amount,
 250         );
 251       }
 252
 253       // format new address for display
 254       $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
 255       foreach ($addressParts as $part) {
 256         $addressParts[$part] = $processorParams[$part] ?? NULL;
 257       }
 258       $tplParams['address'] = CRM_Utils_Address::format($addressParts);
 259
 260       // format old address to store in activity details
 261       $this->_defaults["state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvince($this->_defaults["state_province-{$this->_bltID}"], FALSE);
 262       $this->_defaults["country-{$this->_bltID}"] = CRM_Core_PseudoConstant::country($this->_defaults["country-{$this->_bltID}"], FALSE);
 263       $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
 264       foreach ($addressParts as $part) {
 265         $key = "{$part}-{$this->_bltID}";
 266         $addressParts[$part] = $this->_defaults[$key] ?? NULL;
 267       }
 268       $this->_defaults['address'] = CRM_Utils_Address::format($addressParts);
 269
 270       // format new billing name
 271       $name = $processorParams['first_name'];
 272       if (!empty($processorParams['middle_name'])) {
 273         $name .= " {$processorParams['middle_name']}";
 274       }
 275       $name .= ' ' . $processorParams['last_name'];
 276       $name = trim($name);
 277       $tplParams['billingName'] = $name;
 278
 279       // format old billing name
 280       $name = $this->_defaults['first_name'];
 281       if (!empty($this->_defaults['middle_name'])) {
 282         $name .= " {$this->_defaults['middle_name']}";
 283       }
 284       $name .= ' ' . $this->_defaults['last_name'];
 285       $name = trim($name);
 286       $this->_defaults['billingName'] = $name;
 287
 288       $message .= "
 289 <br/><br/>New Billing Name and Address
 290 <br/>==============================
 291 <br/>{$tplParams['billingName']}
 292 <br/>{$tplParams['address']}
 293
 294 <br/><br/>Previous Billing Name and Address
 295 <br/>==================================
 296 <br/>{$this->_defaults['billingName']}
 297 <br/>{$this->_defaults['address']}";
 298
 299       $activityParams = array(
 300         'source_contact_id' => $this->getSubscriptionDetails()->contact_id,
 301         'activity_type_id' => CRM_Core_PseudoConstant::getKey(
 302           'CRM_Activity_BAO_Activity',
 303           'activity_type_id',
 304           'Update Recurring Contribution Billing Details'
 305         ),
 306         'subject' => ts('Recurring Contribution Billing Details Updated'),
 307         'details' => $message,
 308         'activity_date_time' => date('YmdHis'),
 309         'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
 310       );
 311       $session = CRM_Core_Session::singleton();
 312       $cid = $session->get('userID');
 313       if ($cid) {
 314         $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
 315         $activityParams['source_contact_id'] = $cid;
 316       }
 317       CRM_Activity_BAO_Activity::create($activityParams);
 318
 319       // send notification
 320       if ($this->getSubscriptionDetails()->contribution_page_id) {
 321         CRM_Core_DAO::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id',
 322           $this->getSubscriptionDetails()->contribution_page_id, $value, array(
 323             'title',
 324             'receipt_from_name',
 325             'receipt_from_email',
 326           )
 327         );
 328         $receiptFrom = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$this->getSubscriptionDetails()->contribution_page_id]) . '" <' . $value[$this->getSubscriptionDetails()->contribution_page_id]['receipt_from_email'] . '>';
 329       }
 330       else {
 331         $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
 332         $receiptFrom = "$domainValues[0] <$domainValues[1]>";
 333       }
 334       list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact::getContactDetails($this->getSubscriptionDetails()->contact_id);
 335       $tplParams['contact'] = array('display_name' => $donorDisplayName);
 336
 337       $tplParams = array_merge($tplParams, CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($processorParams));
 338
 339       $sendTemplateParams = array(
 340         'groupName' => $this->getSubscriptionDetails()->membership_id ? 'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
 341         'valueName' => $this->getSubscriptionDetails()->membership_id ? 'membership_autorenew_billing' : 'contribution_recurring_billing',
 342         'contactId' => $this->getSubscriptionDetails()->contact_id,
 343         'tplParams' => $tplParams,
 344         'isTest' => $this->getSubscriptionDetails()->is_test,
 345         'PDFFilename' => 'receipt.pdf',
 346         'from' => $receiptFrom,
 347         'toName' => $donorDisplayName,
 348         'toEmail' => $donorEmail,
 349       );
 350       list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 351     }
 352     else {
 353       $status = ts('There was some problem updating the billing details.');
 354       $msgTitle = ts('Update Error');
 355       $msgType = 'error';
 356     }
 357
 358     $session = CRM_Core_Session::singleton();
 359     $userID = $session->get('userID');
 360     if ($userID && $status) {
 361       $session->setStatus($status, $msgTitle, $msgType);
 362     }
 363     elseif (!$userID) {
 364       if ($status) {
 365         CRM_Utils_System::setUFMessage($status);
 366       }
 367       $result = (int) ($updateSubscription && isset($ctype));
 368       if (isset($tplParams)) {
 369         $session->set('resultParams', $tplParams);
 370       }
 371       return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
 372         "reset=1&task=billing&result={$result}"));
 373     }
 374   }
 375
 376 }