GetCampaignsListTable.php
245 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Campaigns\ListTable\Routes; |
| 4 | |
| 5 | use Give\API\REST\V3\Routes\Campaigns\ValueObjects\CampaignRoute; |
| 6 | use Give\API\RestRoute; |
| 7 | use Give\Campaigns\ListTable\CampaignsListTable; |
| 8 | use Give\Campaigns\ListTable\Columns\RevenueColumn; |
| 9 | use Give\Campaigns\Models\Campaign; |
| 10 | use Give\Campaigns\Repositories\CampaignRepository; |
| 11 | use Give\Campaigns\Repositories\CampaignsDataRepository; |
| 12 | use Give\Framework\QueryBuilder\QueryBuilder; |
| 13 | use WP_Error; |
| 14 | use WP_REST_Request; |
| 15 | use WP_REST_Response; |
| 16 | use WP_REST_Server; |
| 17 | |
| 18 | /** |
| 19 | * @since 4.0.0 |
| 20 | */ |
| 21 | class GetCampaignsListTable implements RestRoute |
| 22 | { |
| 23 | /** |
| 24 | * @var string |
| 25 | */ |
| 26 | protected $endpoint = 'campaigns/list-table'; |
| 27 | |
| 28 | /** |
| 29 | * @var WP_REST_Request |
| 30 | */ |
| 31 | protected $request; |
| 32 | |
| 33 | /** |
| 34 | * @var CampaignsListTable |
| 35 | */ |
| 36 | protected $listTable; |
| 37 | |
| 38 | /** |
| 39 | * @since 4.0.0 |
| 40 | */ |
| 41 | public function registerRoute(): void |
| 42 | { |
| 43 | register_rest_route( |
| 44 | CampaignRoute::NAMESPACE, |
| 45 | $this->endpoint, |
| 46 | [ |
| 47 | [ |
| 48 | 'methods' => WP_REST_Server::READABLE, |
| 49 | 'callback' => [$this, 'handleRequest'], |
| 50 | 'permission_callback' => [$this, 'permissionsCheck'], |
| 51 | ], |
| 52 | 'args' => [ |
| 53 | 'page' => [ |
| 54 | 'type' => 'integer', |
| 55 | 'default' => 1, |
| 56 | 'minimum' => 1, |
| 57 | ], |
| 58 | 'perPage' => [ |
| 59 | 'type' => 'integer', |
| 60 | 'default' => 30, |
| 61 | 'minimum' => 1, |
| 62 | ], |
| 63 | 'search' => [ |
| 64 | 'type' => 'string', |
| 65 | 'required' => false, |
| 66 | 'sanitize_callback' => 'sanitize_text_field', |
| 67 | ], |
| 68 | 'status' => [ |
| 69 | 'type' => 'string', |
| 70 | 'required' => false, |
| 71 | 'sanitize_callback' => 'sanitize_text_field', |
| 72 | ], |
| 73 | 'sortColumn' => [ |
| 74 | 'type' => 'string', |
| 75 | 'default' => 'id', |
| 76 | 'sanitize_callback' => 'sanitize_text_field', |
| 77 | ], |
| 78 | 'sortDirection' => [ |
| 79 | 'type' => 'string', |
| 80 | 'default' => 'asc', |
| 81 | 'enum' => ['asc', 'desc'], |
| 82 | ], |
| 83 | 'locale' => [ |
| 84 | 'type' => 'string', |
| 85 | 'required' => false, |
| 86 | 'default' => get_locale(), |
| 87 | ], |
| 88 | ], |
| 89 | ] |
| 90 | ); |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * @since 4.12.0 add support for sorting by revenue column |
| 95 | * @since 4.0.0 |
| 96 | */ |
| 97 | public function handleRequest(WP_REST_Request $request): WP_REST_Response |
| 98 | { |
| 99 | $this->request = $request; |
| 100 | $this->listTable = give(CampaignsListTable::class); |
| 101 | $sortColumns = $this->listTable->getSortColumnById($request->get_param('sortColumn') ?: 'id'); |
| 102 | $sortDirection = $request->get_param('sortDirection') ?: 'desc'; |
| 103 | |
| 104 | $campaignsCount = $this->getTotalCampaignsCount(); |
| 105 | |
| 106 | if ($campaignsCount === 0) { |
| 107 | return new WP_REST_Response( |
| 108 | [ |
| 109 | 'items' => [], |
| 110 | 'totalItems' => 0, |
| 111 | 'totalPages' => 0, |
| 112 | ] |
| 113 | ); |
| 114 | } |
| 115 | |
| 116 | $campaigns = $this->getCampaigns(); |
| 117 | $pageCount = (int)ceil($campaignsCount / $request->get_param('perPage')); |
| 118 | |
| 119 | $ids = array_map(function (Campaign $campaign) { |
| 120 | return $campaign->id; |
| 121 | }, $campaigns); |
| 122 | |
| 123 | $campaignsData = CampaignsDataRepository::campaigns($ids); |
| 124 | |
| 125 | // Sort by revenue column |
| 126 | if (in_array(RevenueColumn::getId(), $sortColumns)) { |
| 127 | usort($campaigns, function(Campaign $a, Campaign $b) use ($campaignsData, $sortDirection) { |
| 128 | return $sortDirection === 'asc' |
| 129 | ? $campaignsData->getRevenue($a) <=> $campaignsData->getRevenue($b) |
| 130 | : $campaignsData->getRevenue($b) <=> $campaignsData->getRevenue($a); |
| 131 | }); |
| 132 | } |
| 133 | |
| 134 | $this->listTable |
| 135 | ->setData($campaignsData) |
| 136 | ->items($campaigns, $this->request->get_param('locale') ?? ''); |
| 137 | |
| 138 | $items = $this->listTable->getItems(); |
| 139 | |
| 140 | foreach ($items as $i => $item) { |
| 141 | $items[$i]['titleRaw'] = $campaigns[$i]->title; |
| 142 | } |
| 143 | |
| 144 | return new WP_REST_Response( |
| 145 | [ |
| 146 | 'items' => $items, |
| 147 | 'totalItems' => $campaignsCount, |
| 148 | 'totalPages' => $pageCount, |
| 149 | ] |
| 150 | ); |
| 151 | } |
| 152 | |
| 153 | /** |
| 154 | * @since 4.12.0 remove revenue column from sort |
| 155 | * @since 4.0.0 |
| 156 | */ |
| 157 | public function getCampaigns(): 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(CampaignRepository::class)->prepareQuery(); |
| 165 | $query = $this->getWhereConditions($query); |
| 166 | |
| 167 | foreach ($sortColumns as $sortColumn) { |
| 168 | if (RevenueColumn::getId() === $sortColumn) { |
| 169 | continue; |
| 170 | } |
| 171 | |
| 172 | $query->orderBy($sortColumn, $sortDirection); |
| 173 | } |
| 174 | |
| 175 | $query->limit($perPage) |
| 176 | ->offset(($page - 1) * $perPage); |
| 177 | |
| 178 | $campaigns = $query->getAll(); |
| 179 | |
| 180 | if ( ! $campaigns) { |
| 181 | return []; |
| 182 | } |
| 183 | |
| 184 | return $campaigns; |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * @since 4.0.0 |
| 189 | */ |
| 190 | public function getTotalCampaignsCount(): int |
| 191 | { |
| 192 | $query = Campaign::query(); |
| 193 | $query = $this->getWhereConditions($query); |
| 194 | |
| 195 | return $query->count(); |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | * @since 4.0.0 |
| 200 | */ |
| 201 | private function getWhereConditions(QueryBuilder $query): QueryBuilder |
| 202 | { |
| 203 | $search = $this->request->get_param('search'); |
| 204 | $status = $this->request->get_param('status'); |
| 205 | |
| 206 | if ($search) { |
| 207 | if (ctype_digit($search)) { |
| 208 | $query->where('id', $search); |
| 209 | } else { |
| 210 | $query->whereLike('campaign_title', $search); |
| 211 | $query->orWhereLike('short_desc', $search); |
| 212 | } |
| 213 | } |
| 214 | |
| 215 | if ($status === 'any') { |
| 216 | $query->where('status', 'archived', '!='); |
| 217 | } elseif ($status === 'inactive') { |
| 218 | $query->where('status', 'archived'); |
| 219 | } elseif ($status) { |
| 220 | $query->where('status', $status); |
| 221 | } |
| 222 | |
| 223 | return $query; |
| 224 | } |
| 225 | |
| 226 | /** |
| 227 | * @since 4.3.1 update permissions |
| 228 | * @since 4.0.0 |
| 229 | * |
| 230 | * @return bool|WP_Error |
| 231 | */ |
| 232 | public function permissionsCheck() |
| 233 | { |
| 234 | if (current_user_can('manage_options') || current_user_can('edit_give_forms')) { |
| 235 | return true; |
| 236 | } |
| 237 | |
| 238 | return new WP_Error( |
| 239 | 'rest_forbidden', |
| 240 | esc_html__("You don't have permission to view Campaigns", 'give'), |
| 241 | ['status' => is_user_logged_in() ? 403 : 401] |
| 242 | ); |
| 243 | } |
| 244 | } |
| 245 |