Model.php
334 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\MultiFormGoals\ProgressBar; |
| 4 | |
| 5 | use Give\DonationForms\DonationQuery; |
| 6 | |
| 7 | /** |
| 8 | * @since 3.16.0 Add $statusList property |
| 9 | * @since 2.9.0 |
| 10 | */ |
| 11 | class Model |
| 12 | { |
| 13 | |
| 14 | // Settings |
| 15 | protected $ids; |
| 16 | protected $tags; |
| 17 | protected $categories; |
| 18 | protected $goal; |
| 19 | protected $enddate; |
| 20 | protected $color; |
| 21 | |
| 22 | // Internal |
| 23 | protected $forms = []; |
| 24 | protected $donationRevenueResults; |
| 25 | |
| 26 | protected $statusList = []; |
| 27 | |
| 28 | /** |
| 29 | * Constructs and sets up setting variables for a new Progress Bar model |
| 30 | * |
| 31 | * @since 3.16.0 Add statusList support for $args |
| 32 | * @since 2.9.0 |
| 33 | **@param array $args Arguments for new Progress Bar, including 'ids' |
| 34 | */ |
| 35 | public function __construct(array $args) |
| 36 | { |
| 37 | isset($args['ids']) ? $this->ids = $args['ids'] : $this->ids = []; |
| 38 | isset($args['tags']) ? $this->tags = $args['tags'] : $this->tags = []; |
| 39 | isset($args['categories']) ? $this->categories = $args['categories'] : $this->categories = []; |
| 40 | isset($args['goal']) ? $this->goal = $args['goal'] : $this->goal = '1000'; |
| 41 | isset($args['enddate']) ? $this->enddate = $args['enddate'] : $this->enddate = ''; |
| 42 | isset($args['color']) ? $this->color = $args['color'] : $this->color = '#28c77b'; |
| 43 | isset($args['statusList']) ? $this->statusList = $args['statusList'] : $this->statusList = ['publish']; |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * Get forms associated with Progress Bar |
| 48 | * |
| 49 | * @since 3.16.0 Use $statusList property |
| 50 | * @since 3.0.3 Return empty array instead of false |
| 51 | * @since 2.9.0 |
| 52 | */ |
| 53 | public function getForms(): array |
| 54 | { |
| 55 | if ( ! empty($this->forms)) { |
| 56 | return $this->forms; |
| 57 | } |
| 58 | |
| 59 | $query_args = [ |
| 60 | 'post_type' => 'give_forms', |
| 61 | 'post_status' => $this->statusList, |
| 62 | 'post__in' => $this->ids, |
| 63 | 'posts_per_page' => -1, |
| 64 | 'fields' => 'ids', |
| 65 | 'tax_query' => [ |
| 66 | 'relation' => 'AND', |
| 67 | ], |
| 68 | ]; |
| 69 | |
| 70 | if ( ! empty($this->tags)) { |
| 71 | $query_args['tax_query'][] = [ |
| 72 | 'taxonomy' => 'give_forms_tag', |
| 73 | 'terms' => $this->tags, |
| 74 | ]; |
| 75 | } |
| 76 | |
| 77 | if ( ! empty($this->categories)) { |
| 78 | $query_args['tax_query'][] = [ |
| 79 | 'taxonomy' => 'give_forms_category', |
| 80 | 'terms' => $this->categories, |
| 81 | ]; |
| 82 | } |
| 83 | |
| 84 | $query = new \WP_Query($query_args); |
| 85 | |
| 86 | if ($query->posts) { |
| 87 | $this->forms = $query->posts; |
| 88 | |
| 89 | return $query->posts; |
| 90 | } else { |
| 91 | return []; |
| 92 | } |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * @since 2.9.0 |
| 97 | */ |
| 98 | public function getDonations(): array |
| 99 | { |
| 100 | $query_args = [ |
| 101 | 'post_status' => [ |
| 102 | 'publish', |
| 103 | 'give_subscription', |
| 104 | ], |
| 105 | 'number' => -1, |
| 106 | 'give_forms' => $this->getForms(), |
| 107 | ]; |
| 108 | $query = new \Give_Payments_Query($query_args); |
| 109 | |
| 110 | return $query->get_payments(); |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * Get output markup for Progress Bar |
| 115 | * |
| 116 | * @since 2.9.0 |
| 117 | */ |
| 118 | public function getOutput(): string |
| 119 | { |
| 120 | ob_start(); |
| 121 | $output = ''; |
| 122 | require $this->getTemplatePath(); |
| 123 | return ob_get_clean(); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * Returns query results for Donation Revenue. |
| 128 | * @since 2.9.0 |
| 129 | * @return stdClass seem MultiFormGoals/ProgressBar/Query.php |
| 130 | */ |
| 131 | public function getDonationRevenueResults() |
| 132 | { |
| 133 | if ( ! $this->donationRevenueResults) { |
| 134 | $query = new Query($this->getForms()); |
| 135 | $this->donationRevenueResults = $query->getResults(); |
| 136 | } |
| 137 | |
| 138 | return $this->donationRevenueResults; |
| 139 | } |
| 140 | |
| 141 | /** |
| 142 | * Get raw earnings value for Progress Bar |
| 143 | * |
| 144 | * @since 3.12.0 use DonationQuery |
| 145 | * @since 2.9.0 |
| 146 | */ |
| 147 | public function getTotal(): string |
| 148 | { |
| 149 | return (new DonationQuery())->forms($this->getForms())->sumIntendedAmount(); |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * Get number of donations for Progress Bar |
| 154 | * |
| 155 | * @since 2.9.0 |
| 156 | */ |
| 157 | public function getDonationCount(): int |
| 158 | { |
| 159 | $results = $this->getDonationRevenueResults(); |
| 160 | |
| 161 | return $results->count; |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * Get formatted total remaining (ex: $75) |
| 166 | * |
| 167 | * @since 2.9.0 |
| 168 | */ |
| 169 | protected function getFormattedTotalRemaining() |
| 170 | { |
| 171 | $total_remaining = ($this->getGoal() - $this->getTotal()) > 0 ? ($this->getGoal() - $this->getTotal()) : 0; |
| 172 | |
| 173 | return give_currency_filter( |
| 174 | give_format_amount( |
| 175 | $total_remaining, |
| 176 | [ |
| 177 | 'sanitize' => false, |
| 178 | 'decimal' => false, |
| 179 | ] |
| 180 | ) |
| 181 | ); |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Get goal for Progress Bar |
| 186 | * |
| 187 | * @since 2.9.0 |
| 188 | */ |
| 189 | public function getGoal(): string |
| 190 | { |
| 191 | return $this->goal; |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Get goal color for Progress Bar |
| 196 | * |
| 197 | * @since 2.9.0 |
| 198 | */ |
| 199 | public function getColor(): string |
| 200 | { |
| 201 | return $this->color; |
| 202 | } |
| 203 | |
| 204 | /** |
| 205 | * Get template path for Progress Bar component template |
| 206 | * @since 2.9.0 |
| 207 | **/ |
| 208 | public function getTemplatePath() |
| 209 | { |
| 210 | return GIVE_PLUGIN_DIR . '/src/MultiFormGoals/resources/views/progressbar.php'; |
| 211 | } |
| 212 | |
| 213 | /** |
| 214 | * @since 2.24.0 |
| 215 | * |
| 216 | * @return mixed|string |
| 217 | */ |
| 218 | public function getFormattedTotal() |
| 219 | { |
| 220 | return give_currency_filter( |
| 221 | give_format_amount( |
| 222 | $this->getTotal(), |
| 223 | [ |
| 224 | 'sanitize' => false, |
| 225 | 'decimal' => false, |
| 226 | ] |
| 227 | ) |
| 228 | ); |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * @since 2.24.0 |
| 233 | * |
| 234 | * @return mixed|string |
| 235 | */ |
| 236 | public function getFormattedGoal() |
| 237 | { |
| 238 | return give_currency_filter( |
| 239 | give_format_amount( |
| 240 | $this->getGoal(), |
| 241 | [ |
| 242 | 'sanitize' => false, |
| 243 | 'decimal' => false, |
| 244 | ] |
| 245 | ) |
| 246 | ); |
| 247 | } |
| 248 | |
| 249 | /** |
| 250 | * Get end date for Progress Bar |
| 251 | * |
| 252 | * @since 2.9.0 |
| 253 | */ |
| 254 | public function getEndDate(): string |
| 255 | { |
| 256 | return $this->enddate; |
| 257 | } |
| 258 | |
| 259 | /** |
| 260 | * Get minutes remaining before Progress Bar end date |
| 261 | * |
| 262 | * @since 2.9.0 |
| 263 | */ |
| 264 | public function getMinutesRemaining(): string |
| 265 | { |
| 266 | $enddate = strtotime($this->getEndDate()); |
| 267 | if ($enddate) { |
| 268 | $now = current_time('timestamp', false); |
| 269 | |
| 270 | return $now < $enddate ? ($enddate - $now) / 60 : 0; |
| 271 | } else { |
| 272 | return false; |
| 273 | } |
| 274 | } |
| 275 | |
| 276 | /** |
| 277 | * Get time remaining before Progress Bar end date |
| 278 | * |
| 279 | * @since 2.9.0 |
| 280 | * |
| 281 | * @return float|int |
| 282 | */ |
| 283 | public function getTimeToGo() |
| 284 | { |
| 285 | $minutes = $this->getMinutesRemaining(); |
| 286 | |
| 287 | switch ($minutes) { |
| 288 | case $minutes > 1440: |
| 289 | { |
| 290 | return round($minutes / 1440); |
| 291 | } |
| 292 | case $minutes < 1440 && $minutes > 60: |
| 293 | { |
| 294 | return round($minutes / 60); |
| 295 | } |
| 296 | case $minutes < 60: |
| 297 | { |
| 298 | return round($minutes); |
| 299 | } |
| 300 | default: |
| 301 | { |
| 302 | return 0; |
| 303 | } |
| 304 | } |
| 305 | } |
| 306 | |
| 307 | /** |
| 308 | * Get time remaining before Progress Bar end date |
| 309 | * |
| 310 | * @since 2.9.0 |
| 311 | */ |
| 312 | public function getTimeToGoLabel(): string |
| 313 | { |
| 314 | $minutes = $this->getMinutesRemaining(); |
| 315 | |
| 316 | switch ($minutes) { |
| 317 | case $minutes > 1440: |
| 318 | { |
| 319 | return _n('day to go', 'days to go', $this->getTimeToGo(), 'give'); |
| 320 | } |
| 321 | case $minutes < 1440 && $minutes > 60: |
| 322 | { |
| 323 | return _n('hour to go', 'hours to go', $this->getTimeToGo(), 'give'); |
| 324 | } |
| 325 | case $minutes < 60: |
| 326 | { |
| 327 | return _n('minute to go', 'minutes to go', $this->getTimeToGo(), 'give'); |
| 328 | } |
| 329 | default: |
| 330 | return ''; |
| 331 | } |
| 332 | } |
| 333 | } |
| 334 |