DonationActions.php
11 months ago
Endpoint.php
1 year ago
ListDonations.php
11 months ago
ListDonationsStats.php
11 months ago
SwitchDonationView.php
4 years ago
DonationActions.php
204 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Donations\Endpoints; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\Donations\Models\Donation; |
| 7 | use WP_Error; |
| 8 | use WP_REST_Request; |
| 9 | use WP_REST_Response; |
| 10 | |
| 11 | class DonationActions extends Endpoint |
| 12 | { |
| 13 | /** |
| 14 | * @var string |
| 15 | */ |
| 16 | protected $endpoint = 'admin/donations/(?P<action>[\S]+)'; |
| 17 | |
| 18 | /** |
| 19 | * @inheritDoc |
| 20 | * |
| 21 | * @since 4.10.0 Add force parameter to delete action |
| 22 | */ |
| 23 | public function registerRoute() |
| 24 | { |
| 25 | register_rest_route( |
| 26 | 'give-api/v2', |
| 27 | $this->endpoint, |
| 28 | [ |
| 29 | [ |
| 30 | 'methods' => ['POST', 'DELETE'], |
| 31 | 'callback' => [$this, 'handleRequest'], |
| 32 | 'permission_callback' => [$this, 'permissionsCheck'], |
| 33 | ], |
| 34 | 'args' => [ |
| 35 | 'action' => [ |
| 36 | 'type' => 'string', |
| 37 | 'required' => true, |
| 38 | 'enum' => [ |
| 39 | 'delete', |
| 40 | 'setStatus', |
| 41 | 'resendEmailReceipt', |
| 42 | ], |
| 43 | ], |
| 44 | 'force' => [ |
| 45 | 'type' => 'boolean', |
| 46 | 'default' => false, |
| 47 | 'description' => 'Whether to permanently delete (force=true) or move to trash (force=false, default).', |
| 48 | ], |
| 49 | 'ids' => [ |
| 50 | 'type' => 'string', |
| 51 | 'required' => true, |
| 52 | 'validate_callback' => function ($ids) { |
| 53 | foreach ($this->splitString($ids) as $id) { |
| 54 | if (!$this->validateInt($id)) { |
| 55 | return false; |
| 56 | } |
| 57 | } |
| 58 | |
| 59 | return true; |
| 60 | }, |
| 61 | ], |
| 62 | 'status' => [ |
| 63 | 'type' => 'string', |
| 64 | 'required' => false, |
| 65 | 'enum' => [ |
| 66 | 'publish', // Completed |
| 67 | 'pending', |
| 68 | 'processing', |
| 69 | 'refunded', |
| 70 | 'revoked', |
| 71 | 'failed', |
| 72 | 'cancelled', |
| 73 | 'abandoned', |
| 74 | 'preapproval', |
| 75 | ], |
| 76 | ], |
| 77 | ], |
| 78 | ] |
| 79 | ); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * @since 2.25.2 |
| 84 | * |
| 85 | * @inheritDoc |
| 86 | */ |
| 87 | public function permissionsCheck() |
| 88 | { |
| 89 | if (!current_user_can('edit_give_payments')) { |
| 90 | return new WP_Error( |
| 91 | 'rest_forbidden', |
| 92 | esc_html__('You don\'t have permission to edit Donations', 'give'), |
| 93 | ['status' => $this->authorizationStatusCode()] |
| 94 | ); |
| 95 | } |
| 96 | |
| 97 | return true; |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * @since 4.10.0 Add force parameter to delete action |
| 102 | * @since 4.3.1 add permissions check for delete |
| 103 | * @since 2.20.0 |
| 104 | * |
| 105 | * @param WP_REST_Request $request |
| 106 | * |
| 107 | * @return WP_Error |
| 108 | */ |
| 109 | public function handleRequest(WP_REST_Request $request) |
| 110 | { |
| 111 | $ids = $this->splitString($request->get_param('ids')); |
| 112 | $errors = $successes = []; |
| 113 | |
| 114 | switch ($request->get_param('action')) { |
| 115 | case 'delete': |
| 116 | if (!current_user_can('delete_give_payments')) { |
| 117 | return new WP_Error( |
| 118 | 'rest_forbidden', |
| 119 | esc_html__('You don\'t have permission to delete Donations', 'give'), |
| 120 | ['status' => $this->authorizationStatusCode()] |
| 121 | ); |
| 122 | } |
| 123 | foreach ($ids as $id) { |
| 124 | try { |
| 125 | $donation = Donation::find($id); |
| 126 | |
| 127 | if (!$donation) { |
| 128 | return new WP_REST_Response(['message' => __('Donation not found', 'give')], 404); |
| 129 | } |
| 130 | |
| 131 | if ($request->get_param('force')) { |
| 132 | $deleted = $donation->delete(); // Permanently delete the donation |
| 133 | |
| 134 | if (!$deleted) { |
| 135 | return new WP_REST_Response(['message' => __('Failed to delete donation', 'give')], 500); |
| 136 | } |
| 137 | } else { |
| 138 | $trashed = $donation->trash(); // Move the donation to trash (soft delete) |
| 139 | |
| 140 | if (!$trashed) { |
| 141 | return new WP_REST_Response(['message' => __('Failed to trash donation', 'give')], 500); |
| 142 | } |
| 143 | } |
| 144 | |
| 145 | $successes[] = $id; |
| 146 | } catch (Exception $e) { |
| 147 | $errors[] = $id; |
| 148 | } |
| 149 | } |
| 150 | |
| 151 | break; |
| 152 | |
| 153 | case 'setStatus': |
| 154 | if (!current_user_can('view_give_payments')) { |
| 155 | return new WP_Error( |
| 156 | 'rest_forbidden', |
| 157 | esc_html__('You don\'t have permission to change donation statuses', 'give'), |
| 158 | ['status' => $this->authorizationStatusCode()] |
| 159 | ); |
| 160 | } |
| 161 | foreach ($ids as $id) { |
| 162 | $updated = give_update_payment_status($id, $request->get_param('status')); |
| 163 | $updated ? $successes[] = $id : $errors[] = $id; |
| 164 | } |
| 165 | |
| 166 | break; |
| 167 | |
| 168 | case 'resendEmailReceipt': |
| 169 | foreach ($ids as $id) { |
| 170 | try { |
| 171 | do_action('give_donation-receipt_email_notification', $id); |
| 172 | $successes[] = $id; |
| 173 | } catch (Exception $e) { |
| 174 | $errors[] = $id; |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | break; |
| 179 | } |
| 180 | |
| 181 | return new WP_REST_Response([ |
| 182 | 'errors' => $errors, |
| 183 | 'successes' => $successes |
| 184 | ]); |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * Split string |
| 189 | * |
| 190 | * @param string $ids |
| 191 | * @since 2.20.0 |
| 192 | * |
| 193 | * @return string[] |
| 194 | */ |
| 195 | protected function splitString($ids) |
| 196 | { |
| 197 | if (strpos($ids, ',')) { |
| 198 | return array_map('trim', explode(',', $ids)); |
| 199 | } |
| 200 | |
| 201 | return [trim($ids)]; |
| 202 | } |
| 203 | } |
| 204 |