3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
35 * This class generates form components for processing a contribution.
37 class CRM_Contribute_Form_UpdateBilling
extends CRM_Core_Form
{
38 protected $_crid = NULL;
39 protected $_coid = NULL;
40 protected $_mode = NULL;
42 protected $_subscriptionDetails = NULL;
44 protected $_selfService = FALSE;
46 public $_bltID = NULL;
49 * @var array current payment processor including a copy of the object in 'object' key
51 public $_paymentProcessor = array();
53 public $_paymentProcessorObj = NULL;
56 * Set variables up before form is built.
58 public function preProcess() {
59 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE);
60 $this->_crid
= CRM_Utils_Request
::retrieve('crid', 'Integer', $this, FALSE);
62 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_crid
, 'recur', 'info');
63 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_crid
, 'recur', 'obj');
64 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_crid
);
66 // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
67 if ($this->_subscriptionDetails
->membership_id
) {
68 $this->_mid
= $this->_subscriptionDetails
->membership_id
;
72 $this->_coid
= CRM_Utils_Request
::retrieve('coid', 'Integer', $this, FALSE);
74 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'info');
75 $this->_paymentProcessor
['object'] = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
76 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_coid
, 'contribution');
80 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'info');
81 $this->_paymentProcessor
['object'] = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'obj');
82 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_mid
, 'membership');
83 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
84 $membershipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_mid
, 'membership_type_id');
85 $this->assign('membershipType', CRM_Utils_Array
::value($membershipTypeId, $membershipTypes));
86 $this->_mode
= 'auto_renew';
89 if ((!$this->_crid
&& !$this->_coid
&& !$this->_mid
) ||
90 ($this->_subscriptionDetails
== CRM_Core_DAO
::$_nullObject)
92 CRM_Core_Error
::fatal('Required information missing.');
94 if (!CRM_Core_Permission
::check('edit contributions')) {
95 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this, FALSE);
96 if (!CRM_Contact_BAO_Contact_Utils
::validChecksum($this->_subscriptionDetails
->contact_id
, $userChecksum)) {
97 CRM_Core_Error
::fatal(ts('You do not have permission to cancel subscription.'));
99 $this->_selfService
= TRUE;
102 if (!$this->_paymentProcessor
['object']->isSupported('updateSubscriptionBillingInfo')) {
103 CRM_Core_Error
::fatal(ts("%1 processor doesn't support updating subscription billing details.",
104 array(1 => $this->_paymentProcessor
['object']->_processorName
)
107 $this->assign('paymentProcessor', $this->_paymentProcessor
);
109 $this->assignBillingType();
111 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
112 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
113 $this->assign('amount', $this->_subscriptionDetails
->amount
);
114 $this->assign('installments', $this->_subscriptionDetails
->installments
);
115 $this->assign('mode', $this->_mode
);
117 // handle context redirection
118 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
122 * Set the default values of various form elements.
127 public function setDefaultValues() {
128 $this->_defaults
= array();
130 if ($this->_subscriptionDetails
->contact_id
) {
136 "street_address-{$this->_bltID}",
137 "city-{$this->_bltID}",
138 "postal_code-{$this->_bltID}",
139 "country_id-{$this->_bltID}",
140 "state_province_id-{$this->_bltID}",
142 foreach ($names as $name) {
145 $fields["state_province-{$this->_bltID}"] = 1;
146 $fields["country-{$this->_bltID}"] = 1;
147 $fields["email-{$this->_bltID}"] = 1;
148 $fields['email-Primary'] = 1;
150 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_subscriptionDetails
->contact_id
, $fields, $this->_defaults
);
152 // use primary email address if billing email address is empty
153 if (empty($this->_defaults
["email-{$this->_bltID}"]) &&
154 !empty($this->_defaults
['email-Primary'])
156 $this->_defaults
["email-{$this->_bltID}"] = $this->_defaults
['email-Primary'];
159 foreach ($names as $name) {
160 if (!empty($this->_defaults
[$name])) {
161 $this->_defaults
['billing_' . $name] = $this->_defaults
[$name];
166 $config = CRM_Core_Config
::singleton();
167 // set default country from config if no country set
168 if (empty($this->_defaults
["billing_country_id-{$this->_bltID}"])) {
169 $this->_defaults
["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
172 return $this->_defaults
;
176 * Build the form object.
178 public function buildQuickForm() {
180 if ($this->_selfService
) {
184 $this->addButtons(array(
187 'name' => ts('Save'),
192 'name' => ts('Cancel'),
197 CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, TRUE, TRUE);
198 $this->addFormRule(array('CRM_Contribute_Form_UpdateBilling', 'formRule'), $this);
204 * @param array $fields
205 * The input form values.
206 * @param array $files
207 * The uploaded files if any.
208 * @param CRM_Core_Form $self
212 * true if no errors, else array of errors
214 public static function formRule($fields, $files, $self) {
216 CRM_Core_Form
::validateMandatoryFields($self->_fields
, $fields, $errors);
218 // validate the payment instrument values (e.g. credit card number)
219 CRM_Core_Payment_Form
::validatePaymentInstrument($self->_paymentProcessor
['id'], $fields, $errors, NULL);
221 return empty($errors) ?
TRUE : $errors;
227 public function postProcess() {
228 $params = $this->controller
->exportValues($this->_name
);
231 // now set the values for the billing location.
232 foreach ($this->_fields
as $name => $value) {
235 $fields["email-{$this->_bltID}"] = 1;
237 $processorParams = array();
238 foreach ($params as $key => $val) {
239 $key = str_replace('billing_', '', $key);
240 list($key) = explode('-', $key);
241 $processorParams[$key] = $val;
243 $processorParams['state_province'] = CRM_Core_PseudoConstant
::stateProvince($params["billing_state_province_id-{$this->_bltID}"], FALSE);
244 $processorParams['country'] = CRM_Core_PseudoConstant
::country($params["billing_country_id-{$this->_bltID}"], FALSE);
245 $processorParams['month'] = $processorParams['credit_card_exp_date']['M'];
246 $processorParams['year'] = $processorParams['credit_card_exp_date']['Y'];
247 $processorParams['subscriptionId'] = $this->_subscriptionDetails
->subscription_id
;
248 $processorParams['amount'] = $this->_subscriptionDetails
->amount
;
250 $updateSubscription = $this->_paymentProcessorObj
->updateSubscriptionBillingInfo($message, $processorParams);
252 if (is_a($updateSubscription, 'CRM_Core_Error')) {
253 CRM_Core_Error
::displaySessionError($updateSubscription);
255 elseif ($updateSubscription) {
256 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_subscriptionDetails
->contact_id
, 'contact_type');
257 $contact = &CRM_Contact_BAO_Contact
::createProfileContact($params,
259 $this->_subscriptionDetails
->contact_id
,
266 if ($this->_subscriptionDetails
->membership_id
) {
267 $inputParams = array('id' => $this->_subscriptionDetails
->membership_id
);
268 CRM_Member_BAO_Membership
::getValues($inputParams, $tplParams);
269 $tplParams = $tplParams[$this->_subscriptionDetails
->membership_id
];
270 $tplParams['membership_status'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
271 $tplParams['membershipType'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
272 $status = ts('Billing details for your automatically renewed %1 membership have been updated.',
273 array(1 => $tplParams['membershipType'])
275 $msgTitle = ts('Details Updated');
276 $msgType = 'success';
279 $status = ts('Billing details for the recurring contribution of %1, every %2 %3 have been updated.',
281 1 => $this->_subscriptionDetails
->amount
,
282 2 => $this->_subscriptionDetails
->frequency_interval
,
283 3 => $this->_subscriptionDetails
->frequency_unit
,
286 $msgTitle = ts('Details Updated');
287 $msgType = 'success';
290 'recur_frequency_interval' => $this->_subscriptionDetails
->frequency_interval
,
291 'recur_frequency_unit' => $this->_subscriptionDetails
->frequency_unit
,
292 'amount' => $this->_subscriptionDetails
->amount
,
296 // format new address for display
297 $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
298 foreach ($addressParts as $part) {
299 $addressParts[$part] = CRM_Utils_Array
::value($part, $processorParams);
301 $tplParams['address'] = CRM_Utils_Address
::format($addressParts);
303 // format old address to store in activity details
304 $this->_defaults
["state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvince($this->_defaults
["state_province-{$this->_bltID}"], FALSE);
305 $this->_defaults
["country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::country($this->_defaults
["country-{$this->_bltID}"], FALSE);
306 $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
307 foreach ($addressParts as $part) {
308 $key = "{$part}-{$this->_bltID}";
309 $addressParts[$part] = CRM_Utils_Array
::value($key, $this->_defaults
);
311 $this->_defaults
['address'] = CRM_Utils_Address
::format($addressParts);
313 // format new billing name
314 $name = $processorParams['first_name'];
315 if (!empty($processorParams['middle_name'])) {
316 $name .= " {$processorParams['middle_name']}";
318 $name .= ' ' . $processorParams['last_name'];
320 $tplParams['billingName'] = $name;
322 // format old billing name
323 $name = $this->_defaults
['first_name'];
324 if (!empty($this->_defaults
['middle_name'])) {
325 $name .= " {$this->_defaults['middle_name']}";
327 $name .= ' ' . $this->_defaults
['last_name'];
329 $this->_defaults
['billingName'] = $name;
332 <br/><br/>New Billing Name and Address
333 <br/>==============================
334 <br/>{$tplParams['billingName']}
335 <br/>{$tplParams['address']}
337 <br/><br/>Previous Billing Name and Address
338 <br/>==================================
339 <br/>{$this->_defaults['billingName']}
340 <br/>{$this->_defaults['address']}";
342 $activityParams = array(
343 'source_contact_id' => $this->_subscriptionDetails
->contact_id
,
344 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
345 'Update Recurring Contribution Billing Details',
348 'subject' => ts('Recurring Contribution Billing Details Updated'),
349 'details' => $message,
350 'activity_date_time' => date('YmdHis'),
351 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
356 $session = CRM_Core_Session
::singleton();
357 $cid = $session->get('userID');
359 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
360 $activityParams['source_contact_id'] = $cid;
362 CRM_Activity_BAO_Activity
::create($activityParams);
365 if ($this->_subscriptionDetails
->contribution_page_id
) {
366 CRM_Core_DAO
::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id',
367 $this->_subscriptionDetails
->contribution_page_id
, $value, array(
370 'receipt_from_email',
373 $receiptFrom = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) . '" <' . $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] . '>';
376 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
377 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
379 list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
380 $tplParams['contact'] = array('display_name' => $donorDisplayName);
382 $date = CRM_Utils_Date
::format($processorParams['credit_card_exp_date']);
383 $tplParams['credit_card_exp_date'] = CRM_Utils_Date
::mysqlToIso($date);
384 $tplParams['credit_card_number'] = CRM_Utils_System
::mungeCreditCard($processorParams['credit_card_number']);
385 $tplParams['credit_card_type'] = $processorParams['credit_card_type'];
387 $sendTemplateParams = array(
388 'groupName' => $this->_subscriptionDetails
->membership_id ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
389 'valueName' => $this->_subscriptionDetails
->membership_id ?
'membership_autorenew_billing' : 'contribution_recurring_billing',
390 'contactId' => $this->_subscriptionDetails
->contact_id
,
391 'tplParams' => $tplParams,
392 'isTest' => $this->_subscriptionDetails
->is_test
,
393 'PDFFilename' => 'receipt.pdf',
394 'from' => $receiptFrom,
395 'toName' => $donorDisplayName,
396 'toEmail' => $donorEmail,
398 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
401 $status = ts('There was some problem updating the billing details.');
402 $msgTitle = ts('Update Error');
406 $session = CRM_Core_Session
::singleton();
407 $userID = $session->get('userID');
408 if ($userID && $status) {
409 $session->setStatus($status, $msgTitle, $msgType);
413 CRM_Utils_System
::setUFMessage($status);
415 $result = (int) ($updateSubscription && isset($ctype));
416 if (isset($tplParams)) {
417 $session->set('resultParams', $tplParams);
419 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
420 "reset=1&task=billing&result={$result}"));