DonationStatuses.php
34 lines
| 1 | <?php |
| 2 | namespace Give\Tracking\Helpers; |
| 3 | |
| 4 | use Give\Helpers\ArrayDataSet; |
| 5 | |
| 6 | /** |
| 7 | * Class DonationStatuses |
| 8 | * |
| 9 | * @package Give\Tracking\Helpers |
| 10 | * @unreleased |
| 11 | */ |
| 12 | class DonationStatuses { |
| 13 | /** |
| 14 | * Get list of statuses of completed donations. |
| 15 | * |
| 16 | * @unreleased |
| 17 | * @param false $asStringSeparatedBySingleQuotes |
| 18 | * |
| 19 | * @return string|string[] |
| 20 | */ |
| 21 | public static function getCompletedDonationsStatues( $asStringSeparatedBySingleQuotes = false ) { |
| 22 | $statuses = [ |
| 23 | 'publish', // One time donation |
| 24 | 'give_subscription', // Renewal |
| 25 | ]; |
| 26 | |
| 27 | if ( $asStringSeparatedBySingleQuotes ) { |
| 28 | $statuses = ArrayDataSet::getStringSeparatedByCommaEnclosedWithSingleQuote( $statuses ); |
| 29 | } |
| 30 | |
| 31 | return $statuses; |
| 32 | } |
| 33 | } |
| 34 |