Actions
1 year ago
CustomFields
1 year ago
DataTransferObjects
1 year ago
Endpoints
1 year ago
Exceptions
2 years ago
Factories
1 year ago
ListTable
1 year ago
Migrations
1 year ago
Models
1 year ago
Repositories
1 year ago
ValueObjects
1 year ago
ViewModels
1 year ago
resources
11 months ago
DonorStatisticsQuery.php
11 months ago
DonorsAdminPage.php
1 year ago
DonorsQuery.php
1 year ago
ServiceProvider.php
1 year ago
DonorsQuery.php
141 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Donors; |
| 4 | |
| 5 | use Give\Donations\ValueObjects\DonationMetaKeys; |
| 6 | use Give\Donors\Models\Donor; |
| 7 | use Give\Framework\Models\ModelQueryBuilder; |
| 8 | use Give\Framework\QueryBuilder\JoinQueryBuilder; |
| 9 | use Give\Framework\QueryBuilder\QueryBuilder; |
| 10 | |
| 11 | /** |
| 12 | * @since 4.4.0 |
| 13 | */ |
| 14 | class DonorsQuery |
| 15 | { |
| 16 | /** |
| 17 | * @var ModelQueryBuilder<Donor> |
| 18 | */ |
| 19 | protected $query; |
| 20 | |
| 21 | /** |
| 22 | * @since 4.4.0 |
| 23 | */ |
| 24 | public function __construct() |
| 25 | { |
| 26 | $this->query = Donor::query(); |
| 27 | } |
| 28 | |
| 29 | /** |
| 30 | * Delegates methods not defined locally to the underlying query. |
| 31 | * |
| 32 | * @since 4.4.0 |
| 33 | * |
| 34 | * @return mixed |
| 35 | */ |
| 36 | public function __call(string $method, array $args) |
| 37 | { |
| 38 | if (method_exists($this, $method)) { |
| 39 | return $this->$method(...$args); |
| 40 | } |
| 41 | |
| 42 | return $this->query->$method(...$args); |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * @since 4.4.0 |
| 47 | */ |
| 48 | public function whereDonorsHaveDonations( |
| 49 | string $mode = '', |
| 50 | int $campaignId = 0, |
| 51 | bool $excludeAnonymousDonors = true |
| 52 | ): self { |
| 53 | if (empty($mode)) { |
| 54 | $mode = give_is_test_mode() ? 'test' : 'live'; |
| 55 | } |
| 56 | |
| 57 | $this->query->join(function (JoinQueryBuilder $builder) use ($mode) { |
| 58 | // The donationmeta1.donation_id should be used in other "donationmeta" joins to make sure we are retrieving data from the proper donation |
| 59 | $builder->innerJoin('give_donationmeta', 'donationmeta1') |
| 60 | ->on('donationmeta1.meta_key', DonationMetaKeys::DONOR_ID, true) |
| 61 | ->andOn('donationmeta1.meta_value', 'ID'); |
| 62 | |
| 63 | // Include only current payment "mode" |
| 64 | $builder->innerJoin('give_donationmeta', 'donationmeta2') |
| 65 | ->on('donationmeta2.meta_key', DonationMetaKeys::MODE, true) |
| 66 | ->andOn('donationmeta2.meta_value', $mode, true) |
| 67 | ->andOn('donationmeta2.donation_id', 'donationmeta1.donation_id'); |
| 68 | }); |
| 69 | |
| 70 | if ($campaignId) { |
| 71 | // Filter by CampaignId - Donors only can be filtered by campaignId if they donated to a campaign |
| 72 | $this->query->join(function (JoinQueryBuilder $builder) use ($campaignId) { |
| 73 | $builder->innerJoin('give_donationmeta', 'donationmeta3') |
| 74 | ->on('donationmeta3.meta_key', DonationMetaKeys::CAMPAIGN_ID, true) |
| 75 | ->andOn('donationmeta3.meta_value', $campaignId, true) |
| 76 | ->andOn('donationmeta3.donation_id', 'donationmeta1.donation_id'); |
| 77 | }); |
| 78 | } |
| 79 | |
| 80 | if ($excludeAnonymousDonors) { |
| 81 | // Exclude anonymous donors from results - Donors only can be excluded if they made an anonymous donation |
| 82 | $this->query->join(function (JoinQueryBuilder $builder) { |
| 83 | $builder->innerJoin('give_donationmeta', 'donationmeta4') |
| 84 | ->on('donationmeta4.meta_key', DonationMetaKeys::ANONYMOUS, true) |
| 85 | ->andOn('donationmeta4.meta_value', '0') |
| 86 | ->andOn('donationmeta4.donation_id', 'donationmeta1.donation_id'); |
| 87 | }); |
| 88 | } |
| 89 | |
| 90 | // Make sure the donation is valid |
| 91 | $this->query->whereIn('donationmeta1.donation_id', function (QueryBuilder $builder) { |
| 92 | $builder |
| 93 | ->select('ID') |
| 94 | ->from('posts') |
| 95 | ->where('post_type', 'give_payment') |
| 96 | ->whereIn('post_status', ['publish', 'give_subscription']) |
| 97 | ->whereRaw("AND ID = donationmeta1.donation_id"); |
| 98 | }); |
| 99 | |
| 100 | return $this; |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * @since 4.4.0 |
| 105 | */ |
| 106 | public function limit(int $limit): self |
| 107 | { |
| 108 | $this->query->limit($limit); |
| 109 | |
| 110 | return $this; |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * @since 4.4.0 |
| 115 | */ |
| 116 | public function offset(int $offset): self |
| 117 | { |
| 118 | $this->query->offset($offset); |
| 119 | |
| 120 | return $this; |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * @since 4.4.0 |
| 125 | */ |
| 126 | public function orderBy(string $column, string $direction = 'ASC'): self |
| 127 | { |
| 128 | $this->query->orderBy($column, $direction); |
| 129 | |
| 130 | return $this; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * @since 4.4.0 |
| 135 | */ |
| 136 | public function getAll(): array |
| 137 | { |
| 138 | return $this->query->getAll() ?? []; |
| 139 | } |
| 140 | } |
| 141 |