Endpoint.php
1 year ago
FormActions.php
1 year ago
ListDonationForms.php
2 years ago
SwitchDonationFormView.php
3 years ago
ListDonationForms.php
234 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonationForms\V2\Endpoints; |
| 4 | |
| 5 | use Give\DonationForms\V2\ListTable\DonationFormsListTable; |
| 6 | use Give\Framework\Database\DB; |
| 7 | use Give\Framework\QueryBuilder\QueryBuilder; |
| 8 | use WP_REST_Request; |
| 9 | use WP_REST_Response; |
| 10 | |
| 11 | /** |
| 12 | * @since 2.19.0 |
| 13 | */ |
| 14 | class ListDonationForms extends Endpoint |
| 15 | { |
| 16 | /** |
| 17 | * @var string |
| 18 | */ |
| 19 | protected $endpoint = 'admin/forms'; |
| 20 | |
| 21 | /** |
| 22 | * @var WP_REST_Request |
| 23 | */ |
| 24 | private $request; |
| 25 | |
| 26 | /** |
| 27 | * @var DonationFormsListTable |
| 28 | */ |
| 29 | protected $listTable; |
| 30 | |
| 31 | /** |
| 32 | * @inheritDoc |
| 33 | */ |
| 34 | public function registerRoute() |
| 35 | { |
| 36 | register_rest_route( |
| 37 | 'give-api/v2', |
| 38 | $this->endpoint, |
| 39 | [ |
| 40 | [ |
| 41 | 'methods' => 'GET', |
| 42 | 'callback' => [$this, 'handleRequest'], |
| 43 | 'permission_callback' => [$this, 'permissionsCheck'], |
| 44 | ], |
| 45 | 'args' => [ |
| 46 | 'page' => [ |
| 47 | 'type' => 'integer', |
| 48 | 'required' => false, |
| 49 | 'default' => 1, |
| 50 | 'minimum' => 1, |
| 51 | ], |
| 52 | 'perPage' => [ |
| 53 | 'type' => 'integer', |
| 54 | 'required' => false, |
| 55 | 'default' => 30, |
| 56 | 'minimum' => 1, |
| 57 | ], |
| 58 | 'status' => [ |
| 59 | 'type' => 'string', |
| 60 | 'required' => false, |
| 61 | 'default' => 'any', |
| 62 | 'enum' => [ |
| 63 | 'publish', |
| 64 | 'future', |
| 65 | 'draft', |
| 66 | 'pending', |
| 67 | 'trash', |
| 68 | 'auto-draft', |
| 69 | 'inherit', |
| 70 | 'any', |
| 71 | 'upgraded', |
| 72 | ], |
| 73 | ], |
| 74 | 'search' => [ |
| 75 | 'type' => 'string', |
| 76 | 'required' => false, |
| 77 | ], |
| 78 | 'sortColumn' => [ |
| 79 | 'type' => 'string', |
| 80 | 'required' => false, |
| 81 | 'sanitize_callback' => 'sanitize_text_field', |
| 82 | ], |
| 83 | 'sortDirection' => [ |
| 84 | 'type' => 'string', |
| 85 | 'required' => false, |
| 86 | 'enum' => [ |
| 87 | 'asc', |
| 88 | 'desc', |
| 89 | ], |
| 90 | ], |
| 91 | 'locale' => [ |
| 92 | 'type' => 'string', |
| 93 | 'required' => false, |
| 94 | 'default' => get_locale(), |
| 95 | ], |
| 96 | 'return' => [ |
| 97 | 'type' => 'string', |
| 98 | 'required' => false, |
| 99 | 'default' => 'columns', |
| 100 | 'enum' => [ |
| 101 | 'model', |
| 102 | 'columns', |
| 103 | ], |
| 104 | ], |
| 105 | ], |
| 106 | ] |
| 107 | ); |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * @since 2.24.0 Change this to use the new ListTable class |
| 112 | * |
| 113 | * @param WP_REST_Request $request |
| 114 | * |
| 115 | * @return WP_REST_Response |
| 116 | */ |
| 117 | public function handleRequest(WP_REST_Request $request): WP_REST_Response |
| 118 | { |
| 119 | $this->request = $request; |
| 120 | $this->listTable = give(DonationFormsListTable::class); |
| 121 | |
| 122 | $forms = $this->getForms(); |
| 123 | $totalForms = $this->getTotalFormsCount(); |
| 124 | $totalPages = (int)ceil($totalForms / $this->request->get_param('perPage')); |
| 125 | |
| 126 | if ('model' === $this->request->get_param('return')) { |
| 127 | $items = $forms; |
| 128 | } else { |
| 129 | $this->listTable->items($forms, $this->request->get_param('locale') ?? ''); |
| 130 | $items = $this->listTable->getItems(); |
| 131 | |
| 132 | foreach ($items as $i => &$item) { |
| 133 | $item['name'] = get_the_title($item['id']); |
| 134 | $item['edit'] = get_edit_post_link($item['id'], 'edit'); |
| 135 | $item['permalink'] = get_permalink($item['id']); |
| 136 | $item['v3form'] = (bool)give_get_meta($item['id'], 'formBuilderSettings'); |
| 137 | $item['status_raw'] = $forms[$i]->status->getValue(); |
| 138 | } |
| 139 | } |
| 140 | |
| 141 | return new WP_REST_Response( |
| 142 | [ |
| 143 | 'items' => $items, |
| 144 | 'totalItems' => $totalForms, |
| 145 | 'totalPages' => $totalPages, |
| 146 | 'trash' => defined('EMPTY_TRASH_DAYS') && EMPTY_TRASH_DAYS > 0, |
| 147 | ] |
| 148 | ); |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * @since 3.2.0 added distinct() to the query |
| 153 | * @since 2.24.0 Refactor to query through the ModelQueryBuilder |
| 154 | * |
| 155 | * @return array |
| 156 | */ |
| 157 | public function getForms(): array |
| 158 | { |
| 159 | $page = $this->request->get_param('page'); |
| 160 | $perPage = $this->request->get_param('perPage'); |
| 161 | $sortColumns = $this->listTable->getSortColumnById($this->request->get_param('sortColumn') ?: 'id'); |
| 162 | $sortDirection = $this->request->get_param('sortDirection') ?: 'desc'; |
| 163 | |
| 164 | $query = give()->donationForms->prepareQuery(); |
| 165 | $query = $this->getWhereConditions($query); |
| 166 | |
| 167 | foreach ($sortColumns as $sortColumn) { |
| 168 | $query->orderBy($sortColumn, $sortDirection); |
| 169 | } |
| 170 | |
| 171 | $query->limit($perPage) |
| 172 | ->offset(($page - 1) * $perPage); |
| 173 | |
| 174 | $donationForms = $query->distinct()->getAll(); |
| 175 | |
| 176 | if ( ! $donationForms) { |
| 177 | return []; |
| 178 | } |
| 179 | |
| 180 | return $donationForms; |
| 181 | } |
| 182 | |
| 183 | /** |
| 184 | * @since 2.24.0 Refactor to query through the ModelQueryBuilder |
| 185 | * |
| 186 | * @return int |
| 187 | */ |
| 188 | public function getTotalFormsCount(): int |
| 189 | { |
| 190 | $query = DB::table('posts') |
| 191 | ->where('post_type', 'give_forms'); |
| 192 | |
| 193 | $query = $this->getWhereConditions($query); |
| 194 | |
| 195 | return $query->count(); |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | * @since 2.24.0 |
| 200 | * |
| 201 | * @param QueryBuilder $query |
| 202 | * |
| 203 | * @return QueryBuilder |
| 204 | */ |
| 205 | private function getWhereConditions(QueryBuilder $query): QueryBuilder |
| 206 | { |
| 207 | $search = $this->request->get_param('search'); |
| 208 | $status = $this->request->get_param('status'); |
| 209 | |
| 210 | // Status |
| 211 | if ($status === 'any') { |
| 212 | $query->whereIn('post_status', ['publish', 'draft', 'pending', 'private', 'upgraded']); |
| 213 | } else { |
| 214 | $query->where('post_status', $status); |
| 215 | } |
| 216 | |
| 217 | // Search |
| 218 | if ($search) { |
| 219 | if (ctype_digit($search)) { |
| 220 | $query->where('ID', $search); |
| 221 | } else { |
| 222 | $searchTerms = array_map('trim', explode(' ', $search)); |
| 223 | foreach ($searchTerms as $term) { |
| 224 | if ($term) { |
| 225 | $query->whereLike('post_title', $term); |
| 226 | } |
| 227 | } |
| 228 | } |
| 229 | } |
| 230 | |
| 231 | return $query; |
| 232 | } |
| 233 | } |
| 234 |