3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2020
35 * This class generates form components for processing a contribution.
37 class CRM_Contribute_Form_UpdateBilling
extends CRM_Contribute_Form_ContributionRecur
{
38 protected $_mode = NULL;
40 protected $_subscriptionDetails = NULL;
42 public $_bltID = NULL;
45 * Set variables up before form is built.
47 * @throws \CRM_Core_Exception
49 public function preProcess() {
52 // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
53 if ($this->_subscriptionDetails
->membership_id
) {
54 $this->_mid
= $this->_subscriptionDetails
->membership_id
;
59 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'info');
60 $this->_paymentProcessor
['object'] = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
64 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'info');
65 $this->_paymentProcessor
['object'] = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'obj');
66 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_mid
, 'membership');
67 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
68 $membershipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_mid
, 'membership_type_id');
69 $this->assign('membershipType', CRM_Utils_Array
::value($membershipTypeId, $membershipTypes));
70 $this->_mode
= 'auto_renew';
73 if ((!$this->_crid
&& !$this->_coid
&& !$this->_mid
) ||
(!$this->_subscriptionDetails
)) {
74 CRM_Core_Error
::fatal('Required information missing.');
77 if (!$this->_paymentProcessor
['object']->supports('updateSubscriptionBillingInfo')) {
78 CRM_Core_Error
::fatal(ts("%1 processor doesn't support updating subscription billing details.",
79 array(1 => $this->_paymentProcessor
['object']->_processorName
)
82 $this->assign('paymentProcessor', $this->_paymentProcessor
);
84 $this->assignBillingType();
86 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
87 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
88 $this->assign('amount', $this->_subscriptionDetails
->amount
);
89 $this->assign('installments', $this->_subscriptionDetails
->installments
);
90 $this->assign('mode', $this->_mode
);
92 // handle context redirection
93 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
97 * Set the default values of various form elements.
102 public function setDefaultValues() {
103 $this->_defaults
= array();
105 if ($this->_subscriptionDetails
->contact_id
) {
111 "street_address-{$this->_bltID}",
112 "city-{$this->_bltID}",
113 "postal_code-{$this->_bltID}",
114 "country_id-{$this->_bltID}",
115 "state_province_id-{$this->_bltID}",
117 foreach ($names as $name) {
120 $fields["state_province-{$this->_bltID}"] = 1;
121 $fields["country-{$this->_bltID}"] = 1;
122 $fields["email-{$this->_bltID}"] = 1;
123 $fields['email-Primary'] = 1;
125 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_subscriptionDetails
->contact_id
, $fields, $this->_defaults
);
127 // use primary email address if billing email address is empty
128 if (empty($this->_defaults
["email-{$this->_bltID}"]) &&
129 !empty($this->_defaults
['email-Primary'])
131 $this->_defaults
["email-{$this->_bltID}"] = $this->_defaults
['email-Primary'];
134 foreach ($names as $name) {
135 if (!empty($this->_defaults
[$name])) {
136 $this->_defaults
['billing_' . $name] = $this->_defaults
[$name];
141 $config = CRM_Core_Config
::singleton();
142 // set default country from config if no country set
143 if (empty($this->_defaults
["billing_country_id-{$this->_bltID}"])) {
144 $this->_defaults
["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
147 return $this->_defaults
;
151 * Build the form object.
153 public function buildQuickForm() {
155 if ($this->isSelfService()) {
159 $this->addButtons(array(
162 'name' => ts('Save'),
167 'name' => ts('Cancel'),
171 CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, TRUE, TRUE);
172 $this->addFormRule(array('CRM_Contribute_Form_UpdateBilling', 'formRule'), $this);
178 * @param array $fields
179 * The input form values.
180 * @param array $files
181 * The uploaded files if any.
182 * @param CRM_Core_Form $self
186 * true if no errors, else array of errors
188 public static function formRule($fields, $files, $self) {
190 CRM_Core_Form
::validateMandatoryFields($self->_fields
, $fields, $errors);
192 // validate the payment instrument values (e.g. credit card number)
193 CRM_Core_Payment_Form
::validatePaymentInstrument($self->_paymentProcessor
['id'], $fields, $errors, NULL);
195 return empty($errors) ?
TRUE : $errors;
201 public function postProcess() {
202 $params = $this->controller
->exportValues($this->_name
);
205 // now set the values for the billing location.
206 foreach ($this->_fields
as $name => $value) {
209 $fields["email-{$this->_bltID}"] = 1;
211 $processorParams = array();
212 foreach ($params as $key => $val) {
213 $key = str_replace('billing_', '', $key);
214 list($key) = explode('-', $key);
215 $processorParams[$key] = $val;
217 $processorParams['state_province'] = CRM_Core_PseudoConstant
::stateProvince($params["billing_state_province_id-{$this->_bltID}"], FALSE);
218 $processorParams['country'] = CRM_Core_PseudoConstant
::country($params["billing_country_id-{$this->_bltID}"], FALSE);
219 $processorParams['month'] = $processorParams['credit_card_exp_date']['M'];
220 $processorParams['year'] = $processorParams['credit_card_exp_date']['Y'];
221 $processorParams['subscriptionId'] = $this->_subscriptionDetails
->subscription_id
;
222 $processorParams['amount'] = $this->_subscriptionDetails
->amount
;
223 $updateSubscription = $this->_paymentProcessor
['object']->updateSubscriptionBillingInfo($message, $processorParams);
224 if (is_a($updateSubscription, 'CRM_Core_Error')) {
225 CRM_Core_Error
::displaySessionError($updateSubscription);
227 elseif ($updateSubscription) {
228 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_subscriptionDetails
->contact_id
, 'contact_type');
229 $contact = &CRM_Contact_BAO_Contact
::createProfileContact($params,
231 $this->_subscriptionDetails
->contact_id
,
238 if ($this->_subscriptionDetails
->membership_id
) {
239 $inputParams = array('id' => $this->_subscriptionDetails
->membership_id
);
240 CRM_Member_BAO_Membership
::getValues($inputParams, $tplParams);
241 $tplParams = $tplParams[$this->_subscriptionDetails
->membership_id
];
242 $tplParams['membership_status'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
243 $tplParams['membershipType'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
244 $status = ts('Billing details for your automatically renewed %1 membership have been updated.',
245 array(1 => $tplParams['membershipType'])
247 $msgTitle = ts('Details Updated');
248 $msgType = 'success';
251 $status = ts('Billing details for the recurring contribution of %1, every %2 %3 have been updated.',
253 1 => $this->_subscriptionDetails
->amount
,
254 2 => $this->_subscriptionDetails
->frequency_interval
,
255 3 => $this->_subscriptionDetails
->frequency_unit
,
258 $msgTitle = ts('Details Updated');
259 $msgType = 'success';
262 'recur_frequency_interval' => $this->_subscriptionDetails
->frequency_interval
,
263 'recur_frequency_unit' => $this->_subscriptionDetails
->frequency_unit
,
264 'amount' => $this->_subscriptionDetails
->amount
,
268 // format new address for display
269 $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
270 foreach ($addressParts as $part) {
271 $addressParts[$part] = CRM_Utils_Array
::value($part, $processorParams);
273 $tplParams['address'] = CRM_Utils_Address
::format($addressParts);
275 // format old address to store in activity details
276 $this->_defaults
["state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvince($this->_defaults
["state_province-{$this->_bltID}"], FALSE);
277 $this->_defaults
["country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::country($this->_defaults
["country-{$this->_bltID}"], FALSE);
278 $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
279 foreach ($addressParts as $part) {
280 $key = "{$part}-{$this->_bltID}";
281 $addressParts[$part] = CRM_Utils_Array
::value($key, $this->_defaults
);
283 $this->_defaults
['address'] = CRM_Utils_Address
::format($addressParts);
285 // format new billing name
286 $name = $processorParams['first_name'];
287 if (!empty($processorParams['middle_name'])) {
288 $name .= " {$processorParams['middle_name']}";
290 $name .= ' ' . $processorParams['last_name'];
292 $tplParams['billingName'] = $name;
294 // format old billing name
295 $name = $this->_defaults
['first_name'];
296 if (!empty($this->_defaults
['middle_name'])) {
297 $name .= " {$this->_defaults['middle_name']}";
299 $name .= ' ' . $this->_defaults
['last_name'];
301 $this->_defaults
['billingName'] = $name;
304 <br/><br/>New Billing Name and Address
305 <br/>==============================
306 <br/>{$tplParams['billingName']}
307 <br/>{$tplParams['address']}
309 <br/><br/>Previous Billing Name and Address
310 <br/>==================================
311 <br/>{$this->_defaults['billingName']}
312 <br/>{$this->_defaults['address']}";
314 $activityParams = array(
315 'source_contact_id' => $this->_subscriptionDetails
->contact_id
,
316 'activity_type_id' => CRM_Core_PseudoConstant
::getKey(
317 'CRM_Activity_BAO_Activity',
319 'Update Recurring Contribution Billing Details'
321 'subject' => ts('Recurring Contribution Billing Details Updated'),
322 'details' => $message,
323 'activity_date_time' => date('YmdHis'),
324 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
326 $session = CRM_Core_Session
::singleton();
327 $cid = $session->get('userID');
329 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
330 $activityParams['source_contact_id'] = $cid;
332 CRM_Activity_BAO_Activity
::create($activityParams);
335 if ($this->_subscriptionDetails
->contribution_page_id
) {
336 CRM_Core_DAO
::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id',
337 $this->_subscriptionDetails
->contribution_page_id
, $value, array(
340 'receipt_from_email',
343 $receiptFrom = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) . '" <' . $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] . '>';
346 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
347 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
349 list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
350 $tplParams['contact'] = array('display_name' => $donorDisplayName);
352 $date = CRM_Utils_Date
::format($processorParams['credit_card_exp_date']);
353 $tplParams['credit_card_exp_date'] = CRM_Utils_Date
::mysqlToIso($date);
354 $tplParams['credit_card_number'] = CRM_Utils_System
::mungeCreditCard($processorParams['credit_card_number']);
355 $tplParams['credit_card_type'] = $processorParams['credit_card_type'];
357 $sendTemplateParams = array(
358 'groupName' => $this->_subscriptionDetails
->membership_id ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
359 'valueName' => $this->_subscriptionDetails
->membership_id ?
'membership_autorenew_billing' : 'contribution_recurring_billing',
360 'contactId' => $this->_subscriptionDetails
->contact_id
,
361 'tplParams' => $tplParams,
362 'isTest' => $this->_subscriptionDetails
->is_test
,
363 'PDFFilename' => 'receipt.pdf',
364 'from' => $receiptFrom,
365 'toName' => $donorDisplayName,
366 'toEmail' => $donorEmail,
368 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
371 $status = ts('There was some problem updating the billing details.');
372 $msgTitle = ts('Update Error');
376 $session = CRM_Core_Session
::singleton();
377 $userID = $session->get('userID');
378 if ($userID && $status) {
379 $session->setStatus($status, $msgTitle, $msgType);
383 CRM_Utils_System
::setUFMessage($status);
385 $result = (int) ($updateSubscription && isset($ctype));
386 if (isset($tplParams)) {
387 $session->set('resultParams', $tplParams);
389 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
390 "reset=1&task=billing&result={$result}"));