Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Event Cart: convert to use standard payment forms #17886

Closed
wants to merge 3 commits into from
Closed

Event Cart: convert to use standard payment forms #17886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf37f34
Stop parsing doPayment params into class _params and access directly
mattwire May 19, 2021
949a5c9
Multiple fixes/improvements to propertyBag
mattwire May 19, 2021
007d84a
Convert event cart to use standard payment forms
mattwire Aug 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 54 additions & 56 deletions CRM/Core/Payment/AuthorizeNet.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,19 +139,16 @@ public function doPayment(&$params, $component = 'contribute') {
$newParams
);
}
foreach ($newParams as $field => $value) {
$this->_setParam($field, $value);
}

if (!empty($params['is_recur']) && !empty($params['contributionRecurID'])) {
$this->doRecurPayment();
$this->doRecurPayment($newParams);
$params['payment_status_id'] = array_search('Pending', $statuses);
$params['payment_status'] = 'Pending';
return $params;
}

$postFields = [];
$authorizeNetFields = $this->_getAuthorizeNetFields();
$authorizeNetFields = $this->_getAuthorizeNetFields($newParams);

// Set up our call for hook_civicrm_paymentProcessor,
// since we now have our parameters as assigned for the AIM back end.
Expand Down Expand Up @@ -213,13 +210,15 @@ public function doPayment(&$params, $component = 'contribute') {
}

/**
* @param array|\Civi\Payment\PropertyBag $params
*
* Submit an Automated Recurring Billing subscription.
*/
public function doRecurPayment() {
public function doRecurPayment($params) {
$template = CRM_Core_Smarty::singleton();

$intervalLength = $this->_getParam('frequency_interval');
$intervalUnit = $this->_getParam('frequency_unit');
$intervalLength = $params['frequency_interval'] ?? '';
$intervalUnit = $params['frequency_unit'] ?? '';
if ($intervalUnit === 'week') {
$intervalLength *= 7;
$intervalUnit = 'days';
Expand Down Expand Up @@ -253,11 +252,11 @@ public function doRecurPayment() {

$template->assign('apiLogin', $this->_getParam('apiLogin'));
$template->assign('paymentKey', $this->_getParam('paymentKey'));
$template->assign('refId', substr($this->_getParam('invoiceID'), 0, 20));
$template->assign('refId', substr($params['invoiceID'] ?? '', 0, 20));

//for recurring, carry first contribution id
$template->assign('invoiceNumber', $this->_getParam('contributionID'));
$firstPaymentDate = $this->_getParam('receive_date');
$template->assign('invoiceNumber', $params['contributionID'] ?? '');
$firstPaymentDate = $params['receive_date'] ?? '';
if (!empty($firstPaymentDate)) {
//allow for post dated payment if set in form
$startDate = date_create($firstPaymentDate);
Expand All @@ -279,31 +278,31 @@ public function doRecurPayment() {

$template->assign('startDate', $startDate->format('Y-m-d'));

$installments = $this->_getParam('installments');
$installments = $params['installments'] ?? '';

// for open ended subscription totalOccurrences has to be 9999
$installments = empty($installments) ? 9999 : $installments;
$template->assign('totalOccurrences', $installments);

$template->assign('amount', $this->_getParam('amount'));
$template->assign('amount', $params['amount'] ?? '');

$template->assign('cardNumber', $this->_getParam('credit_card_number'));
$exp_month = str_pad($this->_getParam('month'), 2, '0', STR_PAD_LEFT);
$exp_year = $this->_getParam('year');
$template->assign('cardNumber', $params['credit_card_number'] ?? '');
$exp_month = str_pad($params['month'] ?? '', 2, '0', STR_PAD_LEFT);
$exp_year = $params['year'] ?? '';
$template->assign('expirationDate', $exp_year . '-' . $exp_month);

// name rather than description is used in the tpl - see http://www.authorize.net/support/ARB_guide.pdf
$template->assign('name', $this->_getParam('description', TRUE));

$template->assign('email', $this->_getParam('email'));
$template->assign('contactID', $this->_getParam('contactID'));
$template->assign('billingFirstName', $this->_getParam('billing_first_name'));
$template->assign('billingLastName', $this->_getParam('billing_last_name'));
$template->assign('billingAddress', $this->_getParam('street_address', TRUE));
$template->assign('billingCity', $this->_getParam('city', TRUE));
$template->assign('billingState', $this->_getParam('state_province'));
$template->assign('billingZip', $this->_getParam('postal_code', TRUE));
$template->assign('billingCountry', $this->_getParam('country'));
$template->assign('name', $this->makeXmlSafe($params['description'] ?? ''));

$template->assign('email', $params['email']) ?? '';
$template->assign('contactID', $params['contactID'] ?? '');
$template->assign('billingFirstName', $params['billing_first_name'] ?? '');
$template->assign('billingLastName', $params['billing_last_name'] ?? '');
$template->assign('billingAddress', $this->makeXmlSafe($params['street_address'] ?? ''));
$template->assign('billingCity', $this->makeXmlSafe($params['city'] ?? ''));
$template->assign('billingState', $params['state_province'] ?? '');
$template->assign('billingZip', $this->makeXmlSafe($params['postal_code'] ?? ''));
$template->assign('billingCountry', $params['country'] ?? '');

$arbXML = $template->fetch('CRM/Contribute/Form/Contribution/AuthorizeNetARB.tpl');

Expand All @@ -325,7 +324,7 @@ public function doRecurPayment() {
}

// update recur processor_id with subscriptionId
CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_ContributionRecur', $this->_getParam('contributionRecurID'),
CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_ContributionRecur', $params['contributionRecurID'] ?? '',
'processor_id', $responseFields['subscriptionId']
);
//only impact of assigning this here is is can be used to cancel the subscription in an automated test
Expand All @@ -336,44 +335,39 @@ public function doRecurPayment() {
}

/**
* @param array|\Civi\Payment\PropertyBag $params
* @return array
*/
public function _getAuthorizeNetFields() {
//Total amount is from the form contribution field
$amount = $this->_getParam('total_amount');
//CRM-9894 would this ever be the case??
if (empty($amount)) {
$amount = $this->_getParam('amount');
}
public function _getAuthorizeNetFields($params) {
$fields = [];
$fields['x_login'] = $this->_getParam('apiLogin');
$fields['x_tran_key'] = $this->_getParam('paymentKey');
$fields['x_email_customer'] = $this->_getParam('emailCustomer');
$fields['x_first_name'] = $this->_getParam('billing_first_name');
$fields['x_last_name'] = $this->_getParam('billing_last_name');
$fields['x_address'] = $this->_getParam('street_address');
$fields['x_city'] = $this->_getParam('city');
$fields['x_state'] = $this->_getParam('state_province');
$fields['x_zip'] = $this->_getParam('postal_code');
$fields['x_country'] = $this->_getParam('country');
$fields['x_customer_ip'] = $this->_getParam('ip_address');
$fields['x_email'] = $this->_getParam('email');
$fields['x_invoice_num'] = $this->_getParam('invoiceID');
$fields['x_amount'] = $amount;
$fields['x_currency_code'] = $this->_getParam('currencyID');
$fields['x_description'] = $this->_getParam('description');
$fields['x_cust_id'] = $this->_getParam('contactID');
if ($this->_getParam('paymentType') == 'AIM') {
$fields['x_email_customer'] = $params['emailCustomer'] ?? '';
$fields['x_first_name'] = $params['billing_first_name'] ?? '';
$fields['x_last_name'] = $params['billing_last_name'] ?? '';
$fields['x_address'] = $params['street_address'] ?? '';
$fields['x_city'] = $params['city'] ?? '';
$fields['x_state'] = $params['state_province'] ?? '';
$fields['x_zip'] = $params['postal_code'] ?? '';
$fields['x_country'] = $params['country'] ?? '';
$fields['x_customer_ip'] = $params['ip_address'] ?? '';
$fields['x_email'] = $params['email'] ?? '';
$fields['x_invoice_num'] = $params['invoiceID'] ?? '';
$fields['x_amount'] = $params['total_amount'] ?? $params['amount'];
$fields['x_currency_code'] = $params['currencyID'] ?? '';
$fields['x_description'] = $params['description'] ?? '';
$fields['x_cust_id'] = $params['contactID'] ?? '';
if ($this->_getParam('paymentType') === 'AIM') {
$fields['x_relay_response'] = 'FALSE';
// request response in CSV format
$fields['x_delim_data'] = 'TRUE';
$fields['x_delim_char'] = ',';
$fields['x_encap_char'] = '"';
// cc info
$fields['x_card_num'] = $this->_getParam('credit_card_number');
$fields['x_card_code'] = $this->_getParam('cvv2');
$exp_month = str_pad($this->_getParam('month'), 2, '0', STR_PAD_LEFT);
$exp_year = $this->_getParam('year');
$fields['x_card_num'] = $params['credit_card_number'] ?? '';
$fields['x_card_code'] = $params['cvv2'] ?? '';
$exp_month = str_pad($params['month'] ?? '', 2, '0', STR_PAD_LEFT);
$exp_year = $params['year'] ?? '';
$fields['x_exp_date'] = "$exp_month/$exp_year";
}

Expand Down Expand Up @@ -483,11 +477,15 @@ public function _substring_between(&$haystack, $start, $end) {
public function _getParam($field, $xmlSafe = FALSE) {
$value = CRM_Utils_Array::value($field, $this->_params, '');
if ($xmlSafe) {
$value = str_replace(['&', '"', "'", '<', '>'], '', $value);
$value = $this->makeXmlSafe($value);
}
return $value;
}

private function makeXmlSafe($value) {
return str_replace(['&', '"', "'", '<', '>'], '', $value) ?? '';
}

/**
* Set a field to the specified value. Value must be a scalar (int,
* float, string, or boolean)
Expand Down
51 changes: 48 additions & 3 deletions Civi/Payment/PropertyBag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,23 @@ class PropertyBag implements \ArrayAccess {

protected static $propMap = [
'amount' => TRUE,
'total_amount' => 'amount',
'billingStreetAddress' => TRUE,
'billing_street_address' => 'billingStreetAddress',
'street_address' => 'billingStreetAddress',
'billingSupplementalAddress1' => TRUE,
'billingSupplementalAddress2' => TRUE,
'billingSupplementalAddress3' => TRUE,
'billingCity' => TRUE,
'billing_city' => 'billingCity',
'city' => 'billingCity',
'billingPostalCode' => TRUE,
'billing_postal_code' => 'billingPostalCode',
'postal_code' => 'billingPostalCode',
'billingCounty' => TRUE,
'billingStateProvince' => TRUE,
'billing_state_province' => 'billingStateProvince',
'state_province' => 'billingStateProvince',
'billingCountry' => TRUE,
'contactID' => TRUE,
'contact_id' => 'contactID',
Expand Down Expand Up @@ -174,13 +184,16 @@ public function offsetGet($offset) {
}
}

// These lines are here (and not in try block) because the catch must only
// catch the case when the prop is custom.
$getter = 'get' . ucfirst($prop);
if (!$this->getSuppressLegacyWarnings()) {
CRM_Core_Error::deprecatedFunctionWarning(
"get" . ucfirst($offset) . "()",
"PropertyBag array access for core property '$offset'"
);
}
return $this->get($prop, 'default');
return $this->$getter('default');
}

/**
Expand Down Expand Up @@ -258,13 +271,18 @@ protected function handleLegacyPropNames($prop, $silent = FALSE) {
if ($newName === NULL && substr($prop, -2) === '-' . \CRM_Core_BAO_LocationType::getBilling()
&& isset(static::$propMap[substr($prop, 0, -2)])
) {
$newName = substr($prop, 0, -2);
$billingAddressProp = substr($prop, 0, -2);
$newName = static::$propMap[$billingAddressProp] ?? NULL;
if ($newName === TRUE) {
// Good, modern name.
return $billingAddressProp;
}
}

if ($newName === NULL) {
if ($silent) {
// Only for use by offsetExists
return;
return NULL;
}
throw new \InvalidArgumentException("Unknown property '$prop'.");
}
Expand Down Expand Up @@ -591,6 +609,27 @@ public function setBillingCounty($input, $label = 'default') {
return $this->set('billingCounty', $label, (string) $input);
}

/**
* BillingStateProvince getter.
*
* @return string
*/
public function getBillingStateProvince($label = 'default') {
return $this->get('billingStateProvince', $label);
}

/**
* BillingStateProvince setter.
*
* Nb. we can't validate this unless we have the country ID too, so we don't.
*
* @param string $input
* @param string $label e.g. 'default'
*/
public function setBillingStateProvince($input, $label = 'default') {
return $this->set('billingStateProvince', $label, (string) $input);
}

/**
* BillingCountry getter.
*
Expand Down Expand Up @@ -717,6 +756,9 @@ public function setCurrency($value, $label = 'default') {
* @return string
*/
public function getDescription($label = 'default') {
if (!$this->has('description')) {
return '';
}
return $this->get('description', $label);
}

Expand Down Expand Up @@ -804,6 +846,9 @@ public function setFirstName($firstName, $label = 'default') {
* @return string|null
*/
public function getInvoiceID($label = 'default') {
if (!$this->has('invoiceID')) {
$this->set('invoiceID', $label, md5(uniqid(mt_rand(), TRUE)));
}
return $this->get('invoiceID', $label);
}

Expand Down
Loading