139 lines
4.7 KiB
PHP
139 lines
4.7 KiB
PHP
<?php
|
|
/*------------------------------------------------------------+
|
|
| SYSTOPIA Twingle Integration |
|
|
| Copyright (C) 2018 SYSTOPIA |
|
|
| Author: J. Schuppe (schuppe@systopia.de) |
|
|
+-------------------------------------------------------------+
|
|
| This program is released as free software under the |
|
|
| Affero GPL license. You can redistribute it and/or |
|
|
| modify it under the terms of this license which you |
|
|
| can read by viewing the included agpl.txt or online |
|
|
| at www.gnu.org/licenses/agpl.html. Removal of this |
|
|
| copyright header is strictly prohibited without |
|
|
| written permission from the original author(s). |
|
|
+-------------------------------------------------------------*/
|
|
|
|
use CRM_Twingle_ExtensionUtil as E;
|
|
|
|
/**
|
|
* TwingleDonation.Cancel API specification (optional)
|
|
* This is used for documentation and validation.
|
|
*
|
|
* @param array $params description of fields supported by this API call
|
|
*
|
|
* @return void
|
|
*
|
|
* @see http://wiki.civicrm.org/confluence/display/CRMDOC/API+Architecture+Standards
|
|
*/
|
|
function _civicrm_api3_twingle_donation_Cancel_spec(&$params) {
|
|
$params['project_id'] = array(
|
|
'name' => 'project_id',
|
|
'title' => 'Project ID',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'api.required' => 1,
|
|
'description' => 'The Twingle project ID.',
|
|
);
|
|
$params['trx_id'] = array(
|
|
'name' => 'trx_id',
|
|
'title' => 'Transaction ID',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'api.required' => 1,
|
|
'description' => 'The unique transaction ID of the donation',
|
|
);
|
|
$params['cancelled_at'] = array(
|
|
'name' => 'cancelled_at',
|
|
'title' => 'Cancelled at',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'api.required' => 1,
|
|
'description' => 'The date when the donation was cancelled, format: YYYYMMDD.',
|
|
);
|
|
$params['cancel_reason'] = array(
|
|
'name' => 'cancel_reason',
|
|
'title' => 'Cancel reason',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'api.required' => 1,
|
|
'description' => 'The reason for the donation being cancelled.',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* TwingleDonation.Cancel API
|
|
*
|
|
* @param array $params
|
|
* @return array API result descriptor
|
|
* @see civicrm_api3_create_success
|
|
* @see civicrm_api3_create_error
|
|
*/
|
|
function civicrm_api3_twingle_donation_Cancel($params) {
|
|
// Log call if debugging is enabled within civicrm.settings.php.
|
|
if (defined('TWINGLE_API_LOGGING') && TWINGLE_API_LOGGING) {
|
|
CRM_Core_Error::debug_log_message('TwingleDonation.Cancel: ' . json_encode($params, JSON_PRETTY_PRINT));
|
|
}
|
|
|
|
try {
|
|
// Validate date for parameter "cancelled_at".
|
|
if (!DateTime::createFromFormat('Ymd', $params['cancelled_at'])) {
|
|
throw new CiviCRM_API3_Exception(
|
|
E::ts('Invalid date for parameter "cancelled_at".'),
|
|
'invalid_format'
|
|
);
|
|
}
|
|
|
|
// Retrieve (recurring) contribution.
|
|
try {
|
|
$contribution = civicrm_api3('Contribution', 'getsingle', array(
|
|
'trxn_id' => $params['trx_id'],
|
|
));
|
|
$contribution_type = 'Contribution';
|
|
}
|
|
catch (CiviCRM_API3_Exception $exception) {
|
|
$contribution = civicrm_api3('ContributionRecur', 'getsingle', array(
|
|
'trxn_id' => $params['trx_id'],
|
|
));
|
|
$contribution_type = 'ContributionRecur';
|
|
}
|
|
|
|
// End SEPA mandate if applicable.
|
|
if (
|
|
CRM_Twingle_Submission::civiSepaEnabled()
|
|
&& CRM_Sepa_Logic_Settings::isSDD($contribution)
|
|
) {
|
|
$mandate_id = CRM_Sepa_Logic_Settings::getMandateFor($contribution['id']);
|
|
// Mandates can not be terminated in the past.
|
|
$end_date = date('Ymd', max(
|
|
time(),
|
|
date_create_from_format('Ymd', $params['cancelled_at'])->getTimestamp()
|
|
));
|
|
if (!CRM_Sepa_BAO_SEPAMandate::terminateMandate(
|
|
$mandate_id,
|
|
$end_date,
|
|
$params['cancel_reason']
|
|
)) {
|
|
throw new CiviCRM_API3_Exception(
|
|
E::ts('Could not terminate SEPA mandate'),
|
|
'api_error'
|
|
);
|
|
}
|
|
|
|
// Retrieve updated contribution for return value.
|
|
$contribution = civicrm_api3($contribution_type, 'getsingle', array(
|
|
'id' => $contribution['id'],
|
|
));
|
|
}
|
|
else {
|
|
$contribution = civicrm_api3($contribution_type, 'create', array(
|
|
'id' => $contribution['id'],
|
|
'cancel_date' => $params['cancelled_at'],
|
|
'contribution_status_id' => 'Cancelled',
|
|
'cancel_reason' => $params['cancel_reason'],
|
|
));
|
|
}
|
|
|
|
$result = civicrm_api3_create_success($contribution);
|
|
}
|
|
catch (CiviCRM_API3_Exception $exception) {
|
|
$result = civicrm_api3_create_error($exception->getMessage());
|
|
}
|
|
|
|
return $result;
|
|
}
|