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();
54 * Set variables up before form is built.
56 public function preProcess() {
57 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE);
58 $this->_crid
= CRM_Utils_Request
::retrieve('crid', 'Integer', $this, FALSE);
60 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_crid
, 'recur', 'info');
61 $this->_paymentProcessor
['object'] = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_crid
, 'recur', 'obj');
62 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_crid
);
64 // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
65 if ($this->_subscriptionDetails
->membership_id
) {
66 $this->_mid
= $this->_subscriptionDetails
->membership_id
;
70 $this->_coid
= CRM_Utils_Request
::retrieve('coid', 'Integer', $this, FALSE);
72 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'info');
73 $this->_paymentProcessor
['object'] = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
74 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_coid
, 'contribution');
78 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'info');
79 $this->_paymentProcessor
['object'] = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'obj');
80 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_mid
, 'membership');
81 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
82 $membershipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_mid
, 'membership_type_id');
83 $this->assign('membershipType', CRM_Utils_Array
::value($membershipTypeId, $membershipTypes));
84 $this->_mode
= 'auto_renew';
87 if ((!$this->_crid
&& !$this->_coid
&& !$this->_mid
) ||
(!$this->_subscriptionDetails
)) {
88 CRM_Core_Error
::fatal('Required information missing.');
90 if (!CRM_Core_Permission
::check('edit contributions')) {
91 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this, FALSE);
92 if (!CRM_Contact_BAO_Contact_Utils
::validChecksum($this->_subscriptionDetails
->contact_id
, $userChecksum)) {
93 CRM_Core_Error
::fatal(ts('You do not have permission to cancel subscription.'));
95 $this->_selfService
= TRUE;
98 if (!$this->_paymentProcessor
['object']->isSupported('updateSubscriptionBillingInfo')) {
99 CRM_Core_Error
::fatal(ts("%1 processor doesn't support updating subscription billing details.",
100 array(1 => $this->_paymentProcessor
['object']->_processorName
)
103 $this->assign('paymentProcessor', $this->_paymentProcessor
);
105 $this->assignBillingType();
107 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
108 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
109 $this->assign('amount', $this->_subscriptionDetails
->amount
);
110 $this->assign('installments', $this->_subscriptionDetails
->installments
);
111 $this->assign('mode', $this->_mode
);
113 // handle context redirection
114 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
118 * Set the default values of various form elements.
123 public function setDefaultValues() {
124 $this->_defaults
= array();
126 if ($this->_subscriptionDetails
->contact_id
) {
132 "street_address-{$this->_bltID}",
133 "city-{$this->_bltID}",
134 "postal_code-{$this->_bltID}",
135 "country_id-{$this->_bltID}",
136 "state_province_id-{$this->_bltID}",
138 foreach ($names as $name) {
141 $fields["state_province-{$this->_bltID}"] = 1;
142 $fields["country-{$this->_bltID}"] = 1;
143 $fields["email-{$this->_bltID}"] = 1;
144 $fields['email-Primary'] = 1;
146 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_subscriptionDetails
->contact_id
, $fields, $this->_defaults
);
148 // use primary email address if billing email address is empty
149 if (empty($this->_defaults
["email-{$this->_bltID}"]) &&
150 !empty($this->_defaults
['email-Primary'])
152 $this->_defaults
["email-{$this->_bltID}"] = $this->_defaults
['email-Primary'];
155 foreach ($names as $name) {
156 if (!empty($this->_defaults
[$name])) {
157 $this->_defaults
['billing_' . $name] = $this->_defaults
[$name];
162 $config = CRM_Core_Config
::singleton();
163 // set default country from config if no country set
164 if (empty($this->_defaults
["billing_country_id-{$this->_bltID}"])) {
165 $this->_defaults
["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
168 return $this->_defaults
;
172 * Build the form object.
174 public function buildQuickForm() {
176 if ($this->_selfService
) {
180 $this->addButtons(array(
183 'name' => ts('Save'),
188 'name' => ts('Cancel'),
193 CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, TRUE, TRUE);
194 $this->addFormRule(array('CRM_Contribute_Form_UpdateBilling', 'formRule'), $this);
200 * @param array $fields
201 * The input form values.
202 * @param array $files
203 * The uploaded files if any.
204 * @param CRM_Core_Form $self
208 * true if no errors, else array of errors
210 public static function formRule($fields, $files, $self) {
212 CRM_Core_Form
::validateMandatoryFields($self->_fields
, $fields, $errors);
214 // validate the payment instrument values (e.g. credit card number)
215 CRM_Core_Payment_Form
::validatePaymentInstrument($self->_paymentProcessor
['id'], $fields, $errors, NULL);
217 return empty($errors) ?
TRUE : $errors;
223 public function postProcess() {
224 $params = $this->controller
->exportValues($this->_name
);
227 // now set the values for the billing location.
228 foreach ($this->_fields
as $name => $value) {
231 $fields["email-{$this->_bltID}"] = 1;
233 $processorParams = array();
234 foreach ($params as $key => $val) {
235 $key = str_replace('billing_', '', $key);
236 list($key) = explode('-', $key);
237 $processorParams[$key] = $val;
239 $processorParams['state_province'] = CRM_Core_PseudoConstant
::stateProvince($params["billing_state_province_id-{$this->_bltID}"], FALSE);
240 $processorParams['country'] = CRM_Core_PseudoConstant
::country($params["billing_country_id-{$this->_bltID}"], FALSE);
241 $processorParams['month'] = $processorParams['credit_card_exp_date']['M'];
242 $processorParams['year'] = $processorParams['credit_card_exp_date']['Y'];
243 $processorParams['subscriptionId'] = $this->_subscriptionDetails
->subscription_id
;
244 $processorParams['amount'] = $this->_subscriptionDetails
->amount
;
245 $updateSubscription = $this->_paymentProcessor
['object']->updateSubscriptionBillingInfo($message, $processorParams);
246 if (is_a($updateSubscription, 'CRM_Core_Error')) {
247 CRM_Core_Error
::displaySessionError($updateSubscription);
249 elseif ($updateSubscription) {
250 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_subscriptionDetails
->contact_id
, 'contact_type');
251 $contact = &CRM_Contact_BAO_Contact
::createProfileContact($params,
253 $this->_subscriptionDetails
->contact_id
,
260 if ($this->_subscriptionDetails
->membership_id
) {
261 $inputParams = array('id' => $this->_subscriptionDetails
->membership_id
);
262 CRM_Member_BAO_Membership
::getValues($inputParams, $tplParams);
263 $tplParams = $tplParams[$this->_subscriptionDetails
->membership_id
];
264 $tplParams['membership_status'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
265 $tplParams['membershipType'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
266 $status = ts('Billing details for your automatically renewed %1 membership have been updated.',
267 array(1 => $tplParams['membershipType'])
269 $msgTitle = ts('Details Updated');
270 $msgType = 'success';
273 $status = ts('Billing details for the recurring contribution of %1, every %2 %3 have been updated.',
275 1 => $this->_subscriptionDetails
->amount
,
276 2 => $this->_subscriptionDetails
->frequency_interval
,
277 3 => $this->_subscriptionDetails
->frequency_unit
,
280 $msgTitle = ts('Details Updated');
281 $msgType = 'success';
284 'recur_frequency_interval' => $this->_subscriptionDetails
->frequency_interval
,
285 'recur_frequency_unit' => $this->_subscriptionDetails
->frequency_unit
,
286 'amount' => $this->_subscriptionDetails
->amount
,
290 // format new address for display
291 $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
292 foreach ($addressParts as $part) {
293 $addressParts[$part] = CRM_Utils_Array
::value($part, $processorParams);
295 $tplParams['address'] = CRM_Utils_Address
::format($addressParts);
297 // format old address to store in activity details
298 $this->_defaults
["state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvince($this->_defaults
["state_province-{$this->_bltID}"], FALSE);
299 $this->_defaults
["country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::country($this->_defaults
["country-{$this->_bltID}"], FALSE);
300 $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
301 foreach ($addressParts as $part) {
302 $key = "{$part}-{$this->_bltID}";
303 $addressParts[$part] = CRM_Utils_Array
::value($key, $this->_defaults
);
305 $this->_defaults
['address'] = CRM_Utils_Address
::format($addressParts);
307 // format new billing name
308 $name = $processorParams['first_name'];
309 if (!empty($processorParams['middle_name'])) {
310 $name .= " {$processorParams['middle_name']}";
312 $name .= ' ' . $processorParams['last_name'];
314 $tplParams['billingName'] = $name;
316 // format old billing name
317 $name = $this->_defaults
['first_name'];
318 if (!empty($this->_defaults
['middle_name'])) {
319 $name .= " {$this->_defaults['middle_name']}";
321 $name .= ' ' . $this->_defaults
['last_name'];
323 $this->_defaults
['billingName'] = $name;
326 <br/><br/>New Billing Name and Address
327 <br/>==============================
328 <br/>{$tplParams['billingName']}
329 <br/>{$tplParams['address']}
331 <br/><br/>Previous Billing Name and Address
332 <br/>==================================
333 <br/>{$this->_defaults['billingName']}
334 <br/>{$this->_defaults['address']}";
336 $activityParams = array(
337 'source_contact_id' => $this->_subscriptionDetails
->contact_id
,
338 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
339 'Update Recurring Contribution Billing Details',
342 'subject' => ts('Recurring Contribution Billing Details Updated'),
343 'details' => $message,
344 'activity_date_time' => date('YmdHis'),
345 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
350 $session = CRM_Core_Session
::singleton();
351 $cid = $session->get('userID');
353 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
354 $activityParams['source_contact_id'] = $cid;
356 CRM_Activity_BAO_Activity
::create($activityParams);
359 if ($this->_subscriptionDetails
->contribution_page_id
) {
360 CRM_Core_DAO
::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id',
361 $this->_subscriptionDetails
->contribution_page_id
, $value, array(
364 'receipt_from_email',
367 $receiptFrom = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) . '" <' . $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] . '>';
370 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
371 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
373 list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
374 $tplParams['contact'] = array('display_name' => $donorDisplayName);
376 $date = CRM_Utils_Date
::format($processorParams['credit_card_exp_date']);
377 $tplParams['credit_card_exp_date'] = CRM_Utils_Date
::mysqlToIso($date);
378 $tplParams['credit_card_number'] = CRM_Utils_System
::mungeCreditCard($processorParams['credit_card_number']);
379 $tplParams['credit_card_type'] = $processorParams['credit_card_type'];
381 $sendTemplateParams = array(
382 'groupName' => $this->_subscriptionDetails
->membership_id ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
383 'valueName' => $this->_subscriptionDetails
->membership_id ?
'membership_autorenew_billing' : 'contribution_recurring_billing',
384 'contactId' => $this->_subscriptionDetails
->contact_id
,
385 'tplParams' => $tplParams,
386 'isTest' => $this->_subscriptionDetails
->is_test
,
387 'PDFFilename' => 'receipt.pdf',
388 'from' => $receiptFrom,
389 'toName' => $donorDisplayName,
390 'toEmail' => $donorEmail,
392 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
395 $status = ts('There was some problem updating the billing details.');
396 $msgTitle = ts('Update Error');
400 $session = CRM_Core_Session
::singleton();
401 $userID = $session->get('userID');
402 if ($userID && $status) {
403 $session->setStatus($status, $msgTitle, $msgType);
407 CRM_Utils_System
::setUFMessage($status);
409 $result = (int) ($updateSubscription && isset($ctype));
410 if (isset($tplParams)) {
411 $session->set('resultParams', $tplParams);
413 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
414 "reset=1&task=billing&result={$result}"));