ActiveDonationFormsData.php
4 years ago
DonationData.php
4 years ago
DonationFormsData.php
2 years ago
DonationMetricsData.php
4 years ago
EditedDonationFormsData.php
4 years ago
GivePluginSettingsData.php
4 years ago
PluginsData.php
4 years ago
ServerData.php
4 years ago
ThemeData.php
4 years ago
WebsiteData.php
4 years ago
WebsiteInfoData.php
4 years ago
DonationFormsData.php
264 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Tracking\TrackingData; |
| 4 | |
| 5 | use Give\DonationForms\Models\DonationForm; |
| 6 | use Give\Framework\Database\DB; |
| 7 | use Give\Helpers\ArrayDataSet; |
| 8 | use Give\Helpers\Form\Template; |
| 9 | use Give\Helpers\Form\Utils; |
| 10 | use Give\Tracking\Contracts\TrackData; |
| 11 | use Give\Tracking\Helpers\DonationStatuses; |
| 12 | use Give\Tracking\Repositories\TrackEvents; |
| 13 | |
| 14 | /** |
| 15 | * Class DonationFormsData |
| 16 | * |
| 17 | * Represents donation forms data |
| 18 | * |
| 19 | * @package Give\Tracking\TrackingData |
| 20 | * @since 2.10.0 |
| 21 | */ |
| 22 | class DonationFormsData implements TrackData |
| 23 | { |
| 24 | protected $formIds = []; |
| 25 | protected $formRevenues = []; |
| 26 | protected $formDonorCounts = []; |
| 27 | |
| 28 | /** |
| 29 | * @var TrackEvents |
| 30 | */ |
| 31 | protected $trackEvents; |
| 32 | |
| 33 | /** |
| 34 | * DonationFormsData constructor. |
| 35 | * |
| 36 | * @param TrackEvents $trackEvents |
| 37 | */ |
| 38 | public function __construct(TrackEvents $trackEvents) |
| 39 | { |
| 40 | $this->trackEvents = $trackEvents; |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * @inheritdoc |
| 45 | */ |
| 46 | public function get() |
| 47 | { |
| 48 | $this->setFormIds(); |
| 49 | |
| 50 | if (! $this->formIds) { |
| 51 | return []; |
| 52 | } |
| 53 | |
| 54 | $this->setRevenues() |
| 55 | ->setDonorCounts(); |
| 56 | |
| 57 | return $this->getData(); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Get forms data. |
| 62 | * |
| 63 | * @since 3.0.0 Add support for v3 forms |
| 64 | * @since 2.10.0 |
| 65 | * @return array |
| 66 | */ |
| 67 | protected function getData() |
| 68 | { |
| 69 | if (! $this->formIds) { |
| 70 | return []; |
| 71 | } |
| 72 | |
| 73 | $data = []; |
| 74 | |
| 75 | foreach ($this->formIds as $formId) { |
| 76 | $temp = [ |
| 77 | 'form_id' => (int)$formId, |
| 78 | 'form_url' => untrailingslashit(get_permalink($formId)), |
| 79 | 'form_name' => get_post_field('post_name', $formId, 'db'), |
| 80 | 'form_type' => give()->form_meta->get_meta($formId, '_give_price_option', true), |
| 81 | 'form_template' => $this->getFormTemplate($formId), |
| 82 | 'donor_count' => $this->formDonorCounts[$formId], |
| 83 | 'revenue' => $this->formRevenues[$formId], |
| 84 | ]; |
| 85 | $this->addAddonsInformation($temp, $formId); |
| 86 | $data[] = $temp; |
| 87 | } |
| 88 | |
| 89 | return $data; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Set form ids. |
| 94 | * |
| 95 | * @since 2.10.0 |
| 96 | * @return self |
| 97 | */ |
| 98 | protected function setFormIds() |
| 99 | { |
| 100 | global $wpdb; |
| 101 | |
| 102 | $statues = DonationStatuses::getCompletedDonationsStatues(true); |
| 103 | $time = $this->trackEvents->getRequestTime(); |
| 104 | |
| 105 | $this->formIds = DB::get_col( |
| 106 | " |
| 107 | SELECT DISTINCT dm.meta_value |
| 108 | FROM {$wpdb->donationmeta} as dm |
| 109 | INNER JOIN {$wpdb->posts} as p ON dm.donation_id = p.ID |
| 110 | INNER JOIN {$wpdb->donationmeta} as dm2 ON dm.donation_id = dm2.donation_id |
| 111 | WHERE p.post_status IN ({$statues}) |
| 112 | AND p.post_date>='{$time}' |
| 113 | AND p.post_type='give_payment' |
| 114 | AND dm2.meta_key='_give_payment_mode' |
| 115 | AND dm2.meta_value='live' |
| 116 | AND dm.meta_key='_give_payment_form_id' |
| 117 | " |
| 118 | ); |
| 119 | |
| 120 | return $this; |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Set forms revenues. |
| 125 | * |
| 126 | * @since 2.10.0 |
| 127 | * @return self |
| 128 | */ |
| 129 | protected function setRevenues() |
| 130 | { |
| 131 | global $wpdb; |
| 132 | |
| 133 | $formIds = ArrayDataSet::getStringSeparatedByCommaEnclosedWithSingleQuote($this->formIds); |
| 134 | $defaultResult = array_combine( |
| 135 | $this->formIds, |
| 136 | array_fill(0, count($this->formIds), 0) // Set default revenue to 0 |
| 137 | ); |
| 138 | |
| 139 | $result = DB::get_results( |
| 140 | " |
| 141 | SELECT SUM(r.amount) as amount, r.form_id |
| 142 | FROM {$wpdb->give_revenue} as r |
| 143 | INNER JOIN {$wpdb->donationmeta} as dm ON r.donation_id = dm.donation_id |
| 144 | WHERE dm.meta_key='_give_payment_mode' |
| 145 | AND dm.meta_value='live' |
| 146 | AND r.form_id IN ({$formIds}) |
| 147 | GROUP BY form_id |
| 148 | ", |
| 149 | ARRAY_A |
| 150 | ); |
| 151 | |
| 152 | if ($result) { |
| 153 | $result = array_map( |
| 154 | 'absint', |
| 155 | array_combine( |
| 156 | wp_list_pluck($result, 'form_id'), |
| 157 | wp_list_pluck($result, 'amount') |
| 158 | ) |
| 159 | ); |
| 160 | } |
| 161 | |
| 162 | $this->formRevenues = array_replace($defaultResult, $result); |
| 163 | |
| 164 | return $this; |
| 165 | } |
| 166 | |
| 167 | /** |
| 168 | * Set forms revenues till current date. |
| 169 | * |
| 170 | * @since 2.10.0 |
| 171 | * |
| 172 | * @return self |
| 173 | */ |
| 174 | protected function setDonorCounts() |
| 175 | { |
| 176 | global $wpdb; |
| 177 | |
| 178 | $formIds = ArrayDataSet::getStringSeparatedByCommaEnclosedWithSingleQuote($this->formIds); |
| 179 | $statues = DonationStatuses::getCompletedDonationsStatues(true); |
| 180 | $defaultResult = array_combine( |
| 181 | $this->formIds, |
| 182 | array_fill(0, count($this->formIds), 0) // Set default donor count to 0 |
| 183 | ); |
| 184 | |
| 185 | $result = DB::get_results( |
| 186 | " |
| 187 | SELECT COUNT(DISTINCT dm2.meta_value) as donor_count, dm.meta_value as form_id |
| 188 | FROM {$wpdb->donationmeta} as dm |
| 189 | INNER JOIN {$wpdb->posts} as p ON donation_id = p.ID |
| 190 | INNER JOIN {$wpdb->donationmeta} as dm2 ON dm.donation_id = dm2.donation_id |
| 191 | INNER JOIN {$wpdb->donors} as donor ON dm2.meta_value = donor.id |
| 192 | INNER JOIN {$wpdb->donationmeta} as dm3 ON dm.donation_id = dm3.donation_id |
| 193 | WHERE p.post_status IN ({$statues}) |
| 194 | AND dm3.meta_key='_give_payment_mode' |
| 195 | AND dm3.meta_value='live' |
| 196 | AND dm.meta_key='_give_payment_form_id' |
| 197 | AND dm.meta_value IN ({$formIds}) |
| 198 | AND dm2.meta_key='_give_payment_donor_id' |
| 199 | AND donor.purchase_value > 0 |
| 200 | GROUP BY dm.meta_value |
| 201 | ", |
| 202 | ARRAY_A |
| 203 | ); |
| 204 | |
| 205 | if ($result) { |
| 206 | $result = array_map( |
| 207 | 'absint', |
| 208 | array_combine( |
| 209 | wp_list_pluck($result, 'form_id'), |
| 210 | wp_list_pluck($result, 'donor_count') |
| 211 | ) |
| 212 | ); |
| 213 | } |
| 214 | |
| 215 | $this->formDonorCounts = array_replace($defaultResult, $result); |
| 216 | |
| 217 | return $this; |
| 218 | } |
| 219 | |
| 220 | /** |
| 221 | * Add addon information whether or not they active for donation form. |
| 222 | * |
| 223 | * @since 2.10.0 |
| 224 | * |
| 225 | * @param array $array |
| 226 | * @param int $formId |
| 227 | */ |
| 228 | private function addAddonsInformation(&$array, $formId) |
| 229 | { |
| 230 | $array = array_merge( |
| 231 | $array, |
| 232 | [ |
| 233 | 'recurring_donations' => (int)apply_filters('give_telemetry_form_uses_addon_recurring', false, $formId), |
| 234 | 'fee_recovery' => (int)apply_filters('give_telemetry_form_uses_addon_fee_recovery', false, $formId), |
| 235 | 'form_field_manager' => (int)apply_filters( |
| 236 | 'give_telemetry_form_uses_addon_form_field_manager', |
| 237 | false, |
| 238 | $formId |
| 239 | ), |
| 240 | ] |
| 241 | ); |
| 242 | } |
| 243 | |
| 244 | /** |
| 245 | * This function is used to get the form template. |
| 246 | * |
| 247 | * @since 3.0.0 |
| 248 | */ |
| 249 | private function getFormTemplate(int $formId): string |
| 250 | { |
| 251 | if (Utils::isV3Form($formId)) { |
| 252 | /* @var DonationForm $form */ |
| 253 | $form = DonationForm::find($formId); |
| 254 | |
| 255 | return $form->settings->designId . ' (V3)'; |
| 256 | } |
| 257 | |
| 258 | $formTemplate = Template::getActiveID($formId); |
| 259 | return ( ! $formTemplate || 'legacy' === $formTemplate ) |
| 260 | ? 'legacy' |
| 261 | : $formTemplate; |
| 262 | } |
| 263 | } |
| 264 |