DeleteDonor.php
5 months ago
Endpoint.php
5 months ago
ListDonors.php
8 months ago
ListDonorsStats.php
8 months ago
SwitchDonorView.php
4 years ago
DeleteDonor.php
144 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Donors\Endpoints; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\Donors\Models\Donor; |
| 7 | use Give\Framework\Permissions\Facades\UserPermissions; |
| 8 | use WP_Error; |
| 9 | use WP_REST_Request; |
| 10 | use WP_REST_Response; |
| 11 | |
| 12 | class DeleteDonor extends Endpoint |
| 13 | { |
| 14 | /** |
| 15 | * @var string |
| 16 | */ |
| 17 | protected $endpoint = 'admin/donors/delete'; |
| 18 | |
| 19 | /** |
| 20 | * @inheritDoc |
| 21 | */ |
| 22 | public function registerRoute() |
| 23 | { |
| 24 | register_rest_route( |
| 25 | 'give-api/v2', |
| 26 | $this->endpoint, |
| 27 | [ |
| 28 | [ |
| 29 | 'methods' => 'DELETE', |
| 30 | 'callback' => [$this, 'handleRequest'], |
| 31 | 'permission_callback' => [$this, 'permissionsCheck'], |
| 32 | ], |
| 33 | 'args' => [ |
| 34 | 'ids' => [ |
| 35 | 'type' => 'string', |
| 36 | 'required' => true, |
| 37 | 'validate_callback' => function ($ids) { |
| 38 | foreach ($this->splitString($ids) as $id) { |
| 39 | if ( ! $this->validateInt($id)) { |
| 40 | return false; |
| 41 | } |
| 42 | } |
| 43 | |
| 44 | return true; |
| 45 | }, |
| 46 | ], |
| 47 | 'deleteDonationsAndRecords' => [ |
| 48 | 'type' => 'boolean', |
| 49 | 'required' => 'false', |
| 50 | 'default' => 'false', |
| 51 | ], |
| 52 | ], |
| 53 | ] |
| 54 | ); |
| 55 | } |
| 56 | |
| 57 | /** |
| 58 | * @since 4.14.0.0 replace permission callback logic with UserPermissions facade |
| 59 | * @since 4.3.1 updated permissions check |
| 60 | * @since 3.0.0 update validation to align with legacy view |
| 61 | * @since 2.25.2 |
| 62 | * |
| 63 | * @inheritDoc |
| 64 | */ |
| 65 | public function permissionsCheck() |
| 66 | { |
| 67 | if (UserPermissions::donors()->canDelete()) { |
| 68 | return true; |
| 69 | } |
| 70 | |
| 71 | return new WP_Error( |
| 72 | 'rest_forbidden', |
| 73 | __('You don\'t have permission to delete Donors', 'give'), |
| 74 | ['status' => $this->authorizationStatusCode()] |
| 75 | ); |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * @since 2.20.0 |
| 80 | * @since 2.23.1 Cast `$ids` as integers. |
| 81 | * |
| 82 | * @param WP_REST_Request $request |
| 83 | * |
| 84 | * @return WP_REST_Response |
| 85 | */ |
| 86 | public function handleRequest(WP_REST_Request $request) |
| 87 | { |
| 88 | $ids = array_map('intval', $this->splitString($request->get_param('ids'))); |
| 89 | $delete_donation = $request->get_param('deleteDonationsAndRecords'); |
| 90 | $errors = $successes = []; |
| 91 | |
| 92 | foreach ($ids as $id) { |
| 93 | try { |
| 94 | /** |
| 95 | * Fires before deleting donor. |
| 96 | * |
| 97 | * @since 2.20.0 |
| 98 | * |
| 99 | * @param int $donor_id The ID of the donor. |
| 100 | * @param bool $delete_donor Confirm Donor Deletion. |
| 101 | * @param bool $delete_donation Confirm Donor related donations deletion. |
| 102 | */ |
| 103 | do_action('give_pre_delete_donor', $id, true, $delete_donation); |
| 104 | $donor = Donor::find($id); |
| 105 | if ($delete_donation) { |
| 106 | foreach ($donor->donations as $donation) { |
| 107 | $donation->delete(); |
| 108 | } |
| 109 | } else { |
| 110 | give_update_payment_meta($id, '_give_payment_donor_id', 0); |
| 111 | } |
| 112 | $donor->delete(); |
| 113 | $successes[] = $id; |
| 114 | } catch (Exception $e) { |
| 115 | $errors[] = $id; |
| 116 | } |
| 117 | } |
| 118 | |
| 119 | return new WP_REST_Response([ |
| 120 | 'errors' => $errors, |
| 121 | 'successes' => $successes, |
| 122 | ]); |
| 123 | } |
| 124 | |
| 125 | |
| 126 | /** |
| 127 | * Split string |
| 128 | * |
| 129 | * @since 2.20.0 |
| 130 | * |
| 131 | * @param string $ids |
| 132 | * |
| 133 | * @return string[] |
| 134 | */ |
| 135 | protected function splitString($ids) |
| 136 | { |
| 137 | if (strpos($ids, ',')) { |
| 138 | return array_map('trim', explode(',', $ids)); |
| 139 | } |
| 140 | |
| 141 | return [trim($ids)]; |
| 142 | } |
| 143 | } |
| 144 |