3 require_once 'contributioncancelactions.civix.php';
5 use CRM_Contributioncancelactions_ExtensionUtil
as E
;
7 use Civi\Api4\LineItem
;
8 use Civi\Api4\Participant
;
11 * Implements hook_civicrm_preProcess().
13 * This enacts the following
14 * - find and cancel any related pending memberships
15 * - (not yet implemented) find and cancel any related pending participant
17 * - (not yet implemented) find any related pledge payment records. Remove the
20 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_post
22 * @throws \CiviCRM_API3_Exception
23 * @throws \API_Exception
25 function contributioncancelactions_civicrm_post($op, $objectName, $objectId, $objectRef) {
26 if ($op === 'edit' && $objectName === 'Contribution') {
27 if (in_array(CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $objectRef->contribution_status_id
),
28 ['Cancelled', 'Failed']
30 contributioncancelactions_cancel_related_pending_memberships((int) $objectId);
31 contributioncancelactions_cancel_related_pending_participant_records((int) $objectId);
37 * Find and cancel any pending participant records.
39 * @param int $contributionID
40 * @throws CiviCRM_API3_Exception
42 function contributioncancelactions_cancel_related_pending_participant_records($contributionID): void
{
43 $pendingStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Pending'");
44 $waitingStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Waiting'");
45 $cancellableParticipantRecords = civicrm_api3('ParticipantPayment', 'get', [
46 'contribution_id' => $contributionID,
47 'participant_id.status_id' => ['IN' => array_merge(array_keys($pendingStatuses), array_keys($waitingStatuses))],
49 if (empty($cancellableParticipantRecords)) {
52 Participant
::update(FALSE)
53 ->addWhere('id', 'IN', array_keys($cancellableParticipantRecords))
54 ->setValues(['status_id:name' => 'Cancelled'])
59 * Find and cancel any pending memberships.
61 * @param int $contributionID
62 * @throws API_Exception
63 * @throws CiviCRM_API3_Exception
65 function contributioncancelactions_cancel_related_pending_memberships($contributionID): void
{
66 $connectedMemberships = (array) LineItem
::get(FALSE)->setWhere([
67 ['contribution_id', '=', $contributionID],
68 ['entity_table', '=', 'civicrm_membership'],
69 ])->execute()->indexBy('entity_id');
71 if (empty($connectedMemberships)) {
74 // @todo we don't have v4 membership api yet so v3 for now.
75 $connectedMemberships = array_keys(civicrm_api3('Membership', 'get', [
76 'status_id' => 'Pending',
77 'id' => ['IN' => array_keys($connectedMemberships)],
79 if (empty($connectedMemberships)) {
82 foreach ($connectedMemberships as $membershipID) {
83 civicrm_api3('Membership', 'create', ['status_id' => 'Cancelled', 'id' => $membershipID, 'is_override' => 1, 'status_override_end_date' => 'null']);