Permissions
9 months ago
ValueObjects
1 year ago
GetCampaignComments.php
10 months ago
GetCampaignRevenue.php
9 months ago
GetCampaignStatistics.php
1 year ago
RegisterCampaignRoutes.php
9 months ago
GetCampaignRevenue.php
239 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\API\REST\V3\Routes\Campaigns; |
| 4 | |
| 5 | use DateInterval; |
| 6 | use DatePeriod; |
| 7 | use DateTime; |
| 8 | use DateTimeInterface; |
| 9 | use Exception; |
| 10 | use Give\API\REST\V3\Routes\Campaigns\ValueObjects\CampaignRoute; |
| 11 | use Give\API\RestRoute; |
| 12 | use Give\Campaigns\CampaignDonationQuery; |
| 13 | use Give\Campaigns\Models\Campaign; |
| 14 | use WP_REST_Response; |
| 15 | use WP_REST_Server; |
| 16 | |
| 17 | /** |
| 18 | * @since 4.0.0 |
| 19 | */ |
| 20 | class GetCampaignRevenue implements RestRoute |
| 21 | { |
| 22 | /** |
| 23 | * @since 4.0.0 |
| 24 | */ |
| 25 | public function registerRoute() |
| 26 | { |
| 27 | register_rest_route( |
| 28 | CampaignRoute::NAMESPACE, |
| 29 | CampaignRoute::CAMPAIGN . '/revenue', |
| 30 | [ |
| 31 | [ |
| 32 | 'methods' => WP_REST_Server::READABLE, |
| 33 | 'callback' => [$this, 'handleRequest'], |
| 34 | 'permission_callback' => function () { |
| 35 | return current_user_can('manage_options'); |
| 36 | }, |
| 37 | ], |
| 38 | 'args' => [ |
| 39 | 'id' => [ |
| 40 | 'type' => 'integer', |
| 41 | 'required' => true, |
| 42 | 'sanitize_callback' => 'absint', |
| 43 | ], |
| 44 | ], |
| 45 | 'schema' => [$this, 'getSchema'], |
| 46 | ] |
| 47 | ); |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * |
| 52 | * This request returns revenue over time based on the oldest data point for the campaign in the database. |
| 53 | * The result will return an array of revenue that includes date and amount. |
| 54 | * The revenue is grouped by day, month, or year based on the date range. |
| 55 | * If the date range is less than 7 days, the result will be padded to include the last 7 days. |
| 56 | * If the date range is more than 6 months, the result will be grouped by month. |
| 57 | * If the date range is more than 5 years, the result will be grouped by year. |
| 58 | * |
| 59 | * @since 4.0.0 |
| 60 | * |
| 61 | * @throws Exception |
| 62 | */ |
| 63 | public function handleRequest($request): WP_REST_Response |
| 64 | { |
| 65 | $campaign = Campaign::find((int)$request->get_param('id')); |
| 66 | |
| 67 | if (!$campaign) { |
| 68 | return new WP_REST_Response([], 404); |
| 69 | } |
| 70 | |
| 71 | $query = new CampaignDonationQuery($campaign); |
| 72 | |
| 73 | $oldestRevenueDate = $query->getOldestDonationDate(); |
| 74 | |
| 75 | if (!$oldestRevenueDate) { |
| 76 | return new WP_REST_Response([], 200); |
| 77 | } |
| 78 | |
| 79 | $firstResultDate = new DateTime($oldestRevenueDate, wp_timezone()); |
| 80 | |
| 81 | // the query start date is the earliest of the first result date and the campaign start date |
| 82 | $queryStartDate = ($firstResultDate < $campaign->startDate) ? $firstResultDate : $campaign->startDate; |
| 83 | $queryEndDate = $campaign->endDate ?: current_datetime(); |
| 84 | |
| 85 | $groupBy = $this->getGroupByFromDateRange($queryStartDate, $queryEndDate); |
| 86 | |
| 87 | $results = $query->getDonationsByDate($groupBy); |
| 88 | |
| 89 | if (empty($results)) { |
| 90 | return new WP_REST_Response([], 200); |
| 91 | } |
| 92 | |
| 93 | // Map the results by date |
| 94 | $resultMap = $this->mapResultsByDate($results, $groupBy); |
| 95 | |
| 96 | // Get all dates between the start and end date based on the group by |
| 97 | $dates = $this->getDatesFromRange($queryStartDate, $queryEndDate->modify("+1 day"), $groupBy); |
| 98 | |
| 99 | // Merge the results with the dates to ensure that all dates are included |
| 100 | $data = $this->mergeResultsWithDates($dates, $resultMap); |
| 101 | |
| 102 | return new WP_REST_Response($data, 200); |
| 103 | } |
| 104 | |
| 105 | /** |
| 106 | * @since 4.0.0 |
| 107 | */ |
| 108 | public function getDatesFromRange(DateTimeInterface $startDate, DateTimeInterface $endDate, string $groupBy): array |
| 109 | { |
| 110 | $startDateInterval = $startDate->diff($endDate); |
| 111 | |
| 112 | // If the date range is less than 7 days, pad the start date to include the last 7 days |
| 113 | // This is to ensure that the chart always shows at least 7 days of data |
| 114 | if ($startDateInterval->days < 7) { |
| 115 | $defaultDays = 7 - $startDateInterval->days; |
| 116 | $startDate->modify("-$defaultDays days"); |
| 117 | } |
| 118 | |
| 119 | $differenceInMonths = ($startDateInterval->y * 12) + $startDateInterval->m; |
| 120 | |
| 121 | $intervalTime = 'days'; |
| 122 | if ($startDateInterval->y >= 5) { |
| 123 | // If the date range is more than 5 years, group by year |
| 124 | $intervalTime = 'years'; |
| 125 | } elseif ($differenceInMonths >= 6) { |
| 126 | // If the date range is more than 6 months, group by month |
| 127 | $intervalTime = 'months'; |
| 128 | } |
| 129 | |
| 130 | $interval = DateInterval::createFromDateString("1 $intervalTime"); |
| 131 | $dateRange = new DatePeriod($startDate, $interval, $endDate); |
| 132 | |
| 133 | $dates = []; |
| 134 | foreach ($dateRange as $date) { |
| 135 | $dateFormatted = $this->getFormattedDateFromGroupBy($groupBy, $date); |
| 136 | |
| 137 | $dates[] = $dateFormatted; |
| 138 | } |
| 139 | |
| 140 | return $dates; |
| 141 | } |
| 142 | |
| 143 | /** |
| 144 | * @since 4.0.0 |
| 145 | */ |
| 146 | public function getGroupByFromDateRange(DateTimeInterface $startDate, DateTimeInterface $endDate): string |
| 147 | { |
| 148 | $startDateInterval = $startDate->diff($endDate); |
| 149 | $differenceInMonths = ($startDateInterval->y * 12) + $startDateInterval->m; |
| 150 | |
| 151 | // If the date range is more than 1 year, group by month |
| 152 | if ($startDateInterval->y >= 5) { |
| 153 | return 'YEAR'; |
| 154 | } |
| 155 | |
| 156 | if ($differenceInMonths >= 6) { |
| 157 | // If the date range is more than 90 days, group by week |
| 158 | return 'MONTH'; |
| 159 | } |
| 160 | |
| 161 | return 'DAY'; |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * @since 4.0.0 |
| 166 | */ |
| 167 | public function getFormattedDateFromGroupBy(string $groupBy, DateTimeInterface $date): string |
| 168 | { |
| 169 | if ($groupBy === 'MONTH') { |
| 170 | return $date->format('Y-m'); |
| 171 | } |
| 172 | |
| 173 | if ($groupBy === 'YEAR') { |
| 174 | return $date->format('Y'); |
| 175 | } |
| 176 | |
| 177 | return $date->format('Y-m-d'); |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * @since 4.0.0 |
| 182 | */ |
| 183 | public function mergeResultsWithDates(array $dates, array $resultMap): array |
| 184 | { |
| 185 | $data = []; |
| 186 | // Fill in the data with the results |
| 187 | foreach ($dates as $date) { |
| 188 | $data[] = [ |
| 189 | 'date' => $date, |
| 190 | 'amount' => $resultMap[$date] ?? 0 |
| 191 | ]; |
| 192 | } |
| 193 | |
| 194 | return $data; |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * @since 4.0.0 |
| 199 | */ |
| 200 | public function mapResultsByDate(array $results, string $groupBy): array |
| 201 | { |
| 202 | $resultMap = []; |
| 203 | foreach ($results as $result) { |
| 204 | $date = $this->getFormattedDateFromGroupBy($groupBy, date_create($result->date_created)); |
| 205 | |
| 206 | $resultMap[$date] = $result->amount; |
| 207 | } |
| 208 | |
| 209 | return $resultMap; |
| 210 | } |
| 211 | |
| 212 | /** |
| 213 | * @since 4.10.0 |
| 214 | */ |
| 215 | public function getSchema(): array |
| 216 | { |
| 217 | return [ |
| 218 | 'title' => 'campaign-revenue', |
| 219 | 'description' => 'Provides daily revenue data for a specific campaign.', |
| 220 | 'type' => 'object', |
| 221 | 'properties' => [ |
| 222 | 'date' => [ |
| 223 | 'type' => 'string', |
| 224 | 'format' => 'date', |
| 225 | 'description' => esc_html__('The date for the revenue entry (YYYY-MM-DD).', 'give'), |
| 226 | ], |
| 227 | 'amount' => [ |
| 228 | 'oneOf' => [ |
| 229 | [ 'type' => 'number' ], |
| 230 | [ 'type' => 'string' ], |
| 231 | ], |
| 232 | 'description' => esc_html__('The amount of revenue received on the given date.', 'give'), |
| 233 | ], |
| 234 | ], |
| 235 | 'required' => ['date', 'amount'], |
| 236 | ]; |
| 237 | } |
| 238 | } |
| 239 |