Actions
2 years ago
Blocks
2 years ago
Controllers
2 years ago
DataTransferObjects
2 years ago
Exceptions
2 years ago
Factories
2 years ago
FormDesigns
2 years ago
FormPage
2 years ago
Listeners
2 years ago
Migrations
2 years ago
Models
2 years ago
Properties
2 years ago
Repositories
2 years ago
Routes
2 years ago
Rules
2 years ago
Shortcodes
2 years ago
V2
2 years ago
ValueObjects
2 years ago
ViewModels
2 years ago
resources
2 years ago
DonationQuery.php
2 years ago
ServiceProvider.php
2 years ago
SubscriptionQuery.php
2 years ago
DonationQuery.php
106 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonationForms; |
| 4 | |
| 5 | use Give\Donations\ValueObjects\DonationMetaKeys; |
| 6 | use Give\Framework\QueryBuilder\JoinQueryBuilder; |
| 7 | use Give\Framework\QueryBuilder\QueryBuilder; |
| 8 | |
| 9 | /** |
| 10 | * An opinionated Query Builder for GiveWP donations and meta fields. |
| 11 | * |
| 12 | * @since 3.12.0 |
| 13 | * |
| 14 | * Example usage: |
| 15 | * (new DonationQuery) |
| 16 | * ->form(1816) |
| 17 | * ->between('2024-02-00', '2024-02-23') |
| 18 | * ->sumIntendedAmount(); |
| 19 | */ |
| 20 | class DonationQuery extends QueryBuilder |
| 21 | { |
| 22 | /** |
| 23 | * @since 3.12.0 |
| 24 | */ |
| 25 | public function __construct() |
| 26 | { |
| 27 | $this->from('posts', 'donation'); |
| 28 | } |
| 29 | |
| 30 | /** |
| 31 | * An opinionated join method for the donation meta table. |
| 32 | * @since 3.12.0 |
| 33 | */ |
| 34 | public function joinMeta($key, $alias) |
| 35 | { |
| 36 | $this->join(function (JoinQueryBuilder $builder) use ($key, $alias) { |
| 37 | $builder |
| 38 | ->leftJoin('give_donationmeta', $alias) |
| 39 | ->on('donation.ID', $alias . '.donation_id') |
| 40 | ->andOn($alias . '.meta_key', $key, true); |
| 41 | }); |
| 42 | return $this; |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * An opinionated where method for the donation form ID meta field. |
| 47 | * @since 3.12.0 |
| 48 | */ |
| 49 | public function form($formId) |
| 50 | { |
| 51 | $this->joinMeta('_give_payment_form_id', 'formId'); |
| 52 | $this->where('formId.meta_value', $formId); |
| 53 | return $this; |
| 54 | } |
| 55 | |
| 56 | |
| 57 | /** |
| 58 | * An opinionated where method for the multiple donation form IDs meta field. |
| 59 | * @since 3.12.0 |
| 60 | */ |
| 61 | public function forms(array $formIds) |
| 62 | { |
| 63 | $this->joinMeta('_give_payment_form_id', 'formId'); |
| 64 | $this->whereIn('formId.meta_value', $formIds); |
| 65 | return $this; |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * An opinionated whereBetween method for the completed date meta field. |
| 70 | * @since 3.12.0 |
| 71 | */ |
| 72 | public function between($startDate, $endDate) |
| 73 | { |
| 74 | // If the dates are empty or invalid, they will fallback to January 1st, 1970. |
| 75 | // For the start date, this is exactly what we need, but for the end date, we should set it as the current date so that we have a correct date range. |
| 76 | $startDate = date('Y-m-d H:i:s', strtotime($startDate)); |
| 77 | $endDate = empty($endDate) |
| 78 | ? date('Y-m-d H:i:s') |
| 79 | : date('Y-m-d H:i:s', strtotime($endDate)); |
| 80 | |
| 81 | $this->joinMeta('_give_completed_date', 'completed'); |
| 82 | $this->whereBetween('completed.meta_value', $startDate, $endDate); |
| 83 | return $this; |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Returns a calculated sum of the intended amounts (without recovered fees) for the donations. |
| 88 | * @since 3.12.0 |
| 89 | * @return int|float |
| 90 | */ |
| 91 | public function sumIntendedAmount() |
| 92 | { |
| 93 | $this->joinMeta('_give_payment_total', 'amount'); |
| 94 | $this->joinMeta('_give_fee_donation_amount', 'intendedAmount'); |
| 95 | return $this->sum( |
| 96 | 'COALESCE(intendedAmount.meta_value, amount.meta_value)' |
| 97 | ); |
| 98 | } |
| 99 | |
| 100 | public function countDonors() |
| 101 | { |
| 102 | $this->joinMeta(DonationMetaKeys::DONOR_ID, 'donorId'); |
| 103 | return $this->count('DISTINCT donorId.meta_value'); |
| 104 | } |
| 105 | } |
| 106 |