Permissions
9 months ago
ValueObjects
1 year ago
ViewModels
7 months ago
CampaignCommentsController.php
7 months ago
CampaignController.php
7 months ago
CampaignPageController.php
7 months ago
CampaignRevenueController.php
7 months ago
CampaignStatisticsController.php
7 months ago
CampaignStatisticsController.php
156 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\API\REST\V3\Routes\Campaigns; |
| 4 | |
| 5 | use DateInterval; |
| 6 | use DatePeriod; |
| 7 | use DateTimeImmutable; |
| 8 | use Exception; |
| 9 | use Give\API\REST\V3\Routes\Campaigns\ValueObjects\CampaignRoute; |
| 10 | use Give\Campaigns\CampaignDonationQuery; |
| 11 | use Give\Campaigns\Models\Campaign; |
| 12 | use Give\Framework\Support\Facades\DateTime\Temporal; |
| 13 | use WP_Error; |
| 14 | use WP_REST_Controller; |
| 15 | use WP_REST_Response; |
| 16 | use WP_REST_Server; |
| 17 | |
| 18 | /** |
| 19 | * @since 4.13.1 |
| 20 | */ |
| 21 | class CampaignStatisticsController extends WP_REST_Controller |
| 22 | { |
| 23 | /** |
| 24 | * @var string |
| 25 | */ |
| 26 | protected $namespace; |
| 27 | |
| 28 | /** |
| 29 | * @since 4.13.1 |
| 30 | */ |
| 31 | public function __construct() |
| 32 | { |
| 33 | $this->namespace = CampaignRoute::NAMESPACE; |
| 34 | } |
| 35 | |
| 36 | /** |
| 37 | * @since 4.13.0 add schema |
| 38 | * @since 4.0.0 |
| 39 | */ |
| 40 | public function register_routes() |
| 41 | { |
| 42 | register_rest_route( |
| 43 | $this->namespace, |
| 44 | '/' . CampaignRoute::CAMPAIGN . '/statistics', |
| 45 | [ |
| 46 | [ |
| 47 | 'methods' => WP_REST_Server::READABLE, |
| 48 | 'callback' => [$this, 'get_items'], |
| 49 | 'permission_callback' => function () { |
| 50 | return current_user_can('manage_options'); |
| 51 | }, |
| 52 | 'args' => [ |
| 53 | 'id' => [ |
| 54 | 'type' => 'integer', |
| 55 | 'required' => true, |
| 56 | 'sanitize_callback' => 'absint', |
| 57 | ], |
| 58 | 'rangeInDays' => [ |
| 59 | 'type' => 'integer', |
| 60 | 'required' => false, |
| 61 | 'sanitize_callback' => 'absint', |
| 62 | 'default' => 0, |
| 63 | ], |
| 64 | ], |
| 65 | ], |
| 66 | 'schema' => [$this, 'get_public_item_schema'], |
| 67 | ] |
| 68 | ); |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * @since 4.13.0 return 404 error if campaign is not found |
| 73 | * @since 4.0.0 |
| 74 | * |
| 75 | * @throws Exception |
| 76 | */ |
| 77 | public function get_items($request): WP_REST_Response |
| 78 | { |
| 79 | $campaign = Campaign::find($request->get_param('id')); |
| 80 | |
| 81 | if (!$campaign) { |
| 82 | $response = new WP_Error('campaign_not_found', __('Campaign not found', 'give'), ['status' => 404]); |
| 83 | |
| 84 | return rest_ensure_response($response); |
| 85 | } |
| 86 | |
| 87 | $query = new CampaignDonationQuery($campaign); |
| 88 | |
| 89 | if (!$request->get_param('rangeInDays')) { |
| 90 | $data = [[ |
| 91 | 'amountRaised' => $query->sumIntendedAmount(), |
| 92 | 'donationCount' => $query->countDonations(), |
| 93 | 'donorCount' => $query->countDonors(), |
| 94 | ]]; |
| 95 | |
| 96 | $items = new WP_REST_Response($data); |
| 97 | |
| 98 | return rest_ensure_response($items); |
| 99 | } |
| 100 | |
| 101 | $days = (int)$request->get_param('rangeInDays'); |
| 102 | $date = new DateTimeImmutable('now', wp_timezone()); |
| 103 | $interval = DateInterval::createFromDateString("-$days days"); |
| 104 | $period = new DatePeriod($date, $interval, 1); |
| 105 | |
| 106 | $data = array_map(function ($targetDate) use ($query, $interval) { |
| 107 | $rangeQuery = $query->between( |
| 108 | Temporal::withStartOfDay($targetDate->add($interval)), |
| 109 | Temporal::withEndOfDay($targetDate) |
| 110 | ); |
| 111 | |
| 112 | return [ |
| 113 | 'amountRaised' => $rangeQuery->sumIntendedAmount(), |
| 114 | 'donationCount' => $rangeQuery->countDonations(), |
| 115 | 'donorCount' => $rangeQuery->countDonors(), |
| 116 | ]; |
| 117 | }, iterator_to_array($period)); |
| 118 | |
| 119 | $items = new WP_REST_Response($data); |
| 120 | |
| 121 | return rest_ensure_response($items); |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * @since 4.13.0 |
| 126 | */ |
| 127 | public function get_item_schema(): array |
| 128 | { |
| 129 | return [ |
| 130 | 'title' => 'givewp/campaign-statistics', |
| 131 | 'description' => esc_html__('Provides statistics for a specific campaign.', 'give'), |
| 132 | 'type' => 'array', |
| 133 | 'readonly' => true, |
| 134 | 'items' => [ |
| 135 | 'type' => 'object', |
| 136 | 'properties' => [ |
| 137 | 'amountRaised' => [ |
| 138 | 'type' => ['integer', 'number'], |
| 139 | 'description' => esc_html__('The amount raised for the campaign.', 'give'), |
| 140 | ], |
| 141 | 'donationCount' => [ |
| 142 | 'type' => 'integer', |
| 143 | 'description' => esc_html__('The number of donations for the campaign.', 'give'), |
| 144 | ], |
| 145 | 'donorCount' => [ |
| 146 | 'type' => 'integer', |
| 147 | 'description' => esc_html__('The number of donors for the campaign.', 'give'), |
| 148 | ], |
| 149 | ], |
| 150 | ], |
| 151 | ]; |
| 152 | } |
| 153 | } |
| 154 | |
| 155 | |
| 156 |