ListForms.php
206 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonationForms\Endpoints; |
| 4 | |
| 5 | use WP_REST_Request; |
| 6 | use WP_REST_Response; |
| 7 | |
| 8 | /** |
| 9 | * @since 2.19.0 |
| 10 | */ |
| 11 | class ListForms extends Endpoint |
| 12 | { |
| 13 | /** |
| 14 | * @var string |
| 15 | */ |
| 16 | protected $endpoint = 'admin/forms'; |
| 17 | |
| 18 | /** |
| 19 | * @inheritDoc |
| 20 | */ |
| 21 | public function registerRoute() |
| 22 | { |
| 23 | register_rest_route( |
| 24 | 'give-api/v2', |
| 25 | $this->endpoint, |
| 26 | [ |
| 27 | [ |
| 28 | 'methods' => 'GET', |
| 29 | 'callback' => [$this, 'handleRequest'], |
| 30 | 'permission_callback' => [$this, 'permissionsCheck'], |
| 31 | ], |
| 32 | 'args' => [ |
| 33 | 'page' => [ |
| 34 | 'type' => 'integer', |
| 35 | 'required' => false, |
| 36 | 'default' => 1, |
| 37 | 'minimum' => 1 |
| 38 | ], |
| 39 | 'perPage' => [ |
| 40 | 'type' => 'integer', |
| 41 | 'required' => false, |
| 42 | 'default' => 30, |
| 43 | 'minimum' => 1 |
| 44 | ], |
| 45 | 'status' => [ |
| 46 | 'type' => 'string', |
| 47 | 'required' => false, |
| 48 | 'default' => 'any', |
| 49 | 'enum' => [ |
| 50 | 'publish', |
| 51 | 'future', |
| 52 | 'draft', |
| 53 | 'pending', |
| 54 | 'trash', |
| 55 | 'auto-draft', |
| 56 | 'inherit', |
| 57 | 'any' |
| 58 | ] |
| 59 | ], |
| 60 | 'search' => [ |
| 61 | 'type' => 'string', |
| 62 | 'required' => false |
| 63 | ] |
| 64 | ], |
| 65 | ] |
| 66 | ); |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * @param WP_REST_Request $request |
| 71 | * |
| 72 | * @return WP_REST_Response |
| 73 | */ |
| 74 | public function handleRequest(WP_REST_Request $request) |
| 75 | { |
| 76 | $data = []; |
| 77 | $forms = give()->donationFormsRepository->getFormsForRequest($request); |
| 78 | $totalForms = give()->donationFormsRepository->getTotalFormsCountForRequest($request); |
| 79 | $totalPages = (int)ceil($totalForms / $request->get_param('perPage')); |
| 80 | |
| 81 | foreach ($forms as $form) { |
| 82 | $data[] = [ |
| 83 | 'id' => $form->id, |
| 84 | 'name' => $form->title, |
| 85 | 'status' => $form->status, |
| 86 | 'goal' => $form->goalEnabled === 'enabled' ? $this->getGoal($form->id) : false, |
| 87 | 'donations' => give()->donationFormsRepository->getFormDonationsCount($form->id), |
| 88 | 'amount' => $this->getFormAmount($form), |
| 89 | 'revenue' => $this->formatAmount($form->revenue), |
| 90 | 'datetime' => $this->getDateTime($form->createdAt), |
| 91 | 'shortcode' => sprintf('[give_form id="%d"]', $form->id), |
| 92 | 'permalink' => html_entity_decode(get_permalink($form->id)), |
| 93 | 'edit' => html_entity_decode(get_edit_post_link($form->id)) |
| 94 | ]; |
| 95 | } |
| 96 | |
| 97 | return new WP_REST_Response( |
| 98 | [ |
| 99 | 'forms' => $data, |
| 100 | 'totalForms' => $totalForms, |
| 101 | 'totalPages' => $totalPages |
| 102 | ] |
| 103 | ); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * @param int $formId |
| 108 | * |
| 109 | * @return array |
| 110 | */ |
| 111 | private function getGoal($formId) |
| 112 | { |
| 113 | $goal = give_goal_progress_stats($formId); |
| 114 | |
| 115 | $getFormatFromGoal = function ($goal) { |
| 116 | switch ($goal[ 'format' ]) { |
| 117 | case 'donation': |
| 118 | return _n('donation', 'donations', $goal[ 'raw_goal' ], 'give'); |
| 119 | |
| 120 | case 'donors': |
| 121 | return _n('donor', 'donors', $goal[ 'raw_goal' ], 'give'); |
| 122 | |
| 123 | case 'amount': |
| 124 | return __('amount', 'give'); |
| 125 | |
| 126 | case 'percentage': |
| 127 | return __('percentage', 'give'); |
| 128 | |
| 129 | default: |
| 130 | return ''; |
| 131 | } |
| 132 | }; |
| 133 | |
| 134 | return [ |
| 135 | 'actual' => html_entity_decode($goal[ 'actual' ]), |
| 136 | 'goal' => html_entity_decode($goal[ 'goal' ]), |
| 137 | 'progress' => html_entity_decode($goal[ 'progress' ]), |
| 138 | 'format' => $getFormatFromGoal($goal) |
| 139 | ]; |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Returns human readable date. |
| 144 | * |
| 145 | * @param string $date Date in mysql format. |
| 146 | * |
| 147 | * @return string |
| 148 | */ |
| 149 | private function getDateTime($date) |
| 150 | { |
| 151 | $dateTimestamp = strtotime($date); |
| 152 | $currentTimestamp = current_time('timestamp'); |
| 153 | $todayTimestamp = strtotime('today', $currentTimestamp); |
| 154 | $yesterdayTimestamp = strtotime('yesterday', $currentTimestamp); |
| 155 | |
| 156 | if ($dateTimestamp >= $todayTimestamp) { |
| 157 | return sprintf( |
| 158 | '%1$s %2$s %3$s', |
| 159 | esc_html__('Today', 'give'), |
| 160 | esc_html__('at', 'give'), |
| 161 | date_i18n(get_option('time_format'), $dateTimestamp) |
| 162 | ); |
| 163 | } |
| 164 | |
| 165 | if ($dateTimestamp < $todayTimestamp && $dateTimestamp >= $yesterdayTimestamp) { |
| 166 | return sprintf( |
| 167 | '%1$s %2$s %3$s', |
| 168 | esc_html__('Yesterday', 'give'), |
| 169 | esc_html__('at', 'give'), |
| 170 | date_i18n(get_option('time_format'), $dateTimestamp) |
| 171 | ); |
| 172 | } |
| 173 | |
| 174 | return date_i18n(get_option('date_format'), $dateTimestamp); |
| 175 | } |
| 176 | |
| 177 | /** |
| 178 | * @param object $form |
| 179 | * |
| 180 | * |
| 181 | * @return string |
| 182 | */ |
| 183 | private function getFormAmount($form) |
| 184 | { |
| 185 | $donationLevels = unserialize($form->donationLevels); |
| 186 | |
| 187 | if (is_array($donationLevels)) { |
| 188 | $amount = array_column($donationLevels, '_give_amount'); |
| 189 | |
| 190 | return $this->formatAmount(min($amount)) . ' - ' . $this->formatAmount(max($amount)); |
| 191 | } |
| 192 | |
| 193 | return $this->formatAmount($form->setPrice); |
| 194 | } |
| 195 | |
| 196 | /** |
| 197 | * @param string $amount |
| 198 | * |
| 199 | * @return string |
| 200 | */ |
| 201 | private function formatAmount($amount) |
| 202 | { |
| 203 | return html_entity_decode(give_currency_filter(give_format_amount($amount))); |
| 204 | } |
| 205 | } |
| 206 |