Revenue.php
171 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Revenue\Repositories; |
| 4 | |
| 5 | use Give\Donations\Models\Donation; |
| 6 | use Give\Framework\Database\DB; |
| 7 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 8 | |
| 9 | /** |
| 10 | * Class Revenue |
| 11 | * @package Give\Revenue\Repositories |
| 12 | * |
| 13 | * Use this class to get data from "give_revenue" table. |
| 14 | * |
| 15 | * @since 2.9.0 |
| 16 | * @since 2.22.1 Added the `updateRevenueAmount()` method |
| 17 | */ |
| 18 | class Revenue |
| 19 | { |
| 20 | /** |
| 21 | * Insert revenue. |
| 22 | * |
| 23 | * @since 2.9.0 |
| 24 | * |
| 25 | * @param array $revenueData |
| 26 | * |
| 27 | * @return bool|int |
| 28 | */ |
| 29 | public function insert($revenueData) |
| 30 | { |
| 31 | global $wpdb; |
| 32 | |
| 33 | // Validate revenue data |
| 34 | $this->validateNewRevenueData($revenueData); |
| 35 | |
| 36 | /** |
| 37 | * Filter revenue data before inserting to revenue table. |
| 38 | * |
| 39 | * @since 2.9.0 |
| 40 | */ |
| 41 | $revenueData = apply_filters('give_revenue_insert_data', $revenueData); |
| 42 | |
| 43 | return DB::insert( |
| 44 | $wpdb->give_revenue, |
| 45 | $revenueData, |
| 46 | $this->getPlaceholderForPrepareQuery($revenueData) |
| 47 | ); |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * Deletes revenue |
| 52 | * |
| 53 | * @param $revenueId |
| 54 | * |
| 55 | * @return false|int |
| 56 | */ |
| 57 | public function deleteByDonationId($revenueId) |
| 58 | { |
| 59 | global $wpdb; |
| 60 | |
| 61 | return DB::delete( |
| 62 | $wpdb->give_revenue, |
| 63 | ['donation_id' => $revenueId], |
| 64 | ['%d'] |
| 65 | ); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * @since 2.22.1 |
| 70 | * |
| 71 | * @param Donation $donation |
| 72 | * |
| 73 | * @return false|int |
| 74 | */ |
| 75 | public function updateRevenueAmount(Donation $donation) |
| 76 | { |
| 77 | global $wpdb; |
| 78 | |
| 79 | return DB::update( |
| 80 | $wpdb->give_revenue, |
| 81 | ['amount' => $donation->amount->formatToMinorAmount()], |
| 82 | ['donation_id' => $donation->id], |
| 83 | ['%d'], |
| 84 | ['%d'] |
| 85 | ); |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Validate new revenue data. |
| 90 | * |
| 91 | * @since 2.9.0 |
| 92 | * @since 2.9.4 Mention donation id in exception message. |
| 93 | * |
| 94 | * @param array $array |
| 95 | */ |
| 96 | protected function validateNewRevenueData($array) |
| 97 | { |
| 98 | $required = ['donation_id', 'form_id', 'amount']; |
| 99 | |
| 100 | if (empty($array['donation_id'])) { |
| 101 | unset($array['donation_id']); |
| 102 | } |
| 103 | |
| 104 | if (empty($array['form_id'])) { |
| 105 | unset($array['form_id']); |
| 106 | } |
| 107 | |
| 108 | if (!is_numeric($array['amount']) || (int)$array['amount'] < 0) { |
| 109 | unset($array['amount']); |
| 110 | } |
| 111 | |
| 112 | if (array_diff($required, array_keys($array))) { |
| 113 | $errorMessage = ''; |
| 114 | if (isset($array['donation_id'])) { |
| 115 | $errorMessage = "An error occurred when processing Donation #{$array['donation_id']}. "; |
| 116 | } |
| 117 | |
| 118 | throw new InvalidArgumentException( |
| 119 | sprintf( |
| 120 | '%2$sTo insert revenue, please provide valid %1$s.', |
| 121 | implode(', ', $required), |
| 122 | $errorMessage |
| 123 | ) |
| 124 | ); |
| 125 | } |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Get placeholder for prepare query. |
| 130 | * |
| 131 | * @param array $data |
| 132 | * |
| 133 | * @return string[] Array of value format type |
| 134 | */ |
| 135 | private function getPlaceholderForPrepareQuery($data) |
| 136 | { |
| 137 | $format = []; |
| 138 | |
| 139 | foreach ($data as $value) { |
| 140 | $format[] = is_numeric($value) ? '%d' : '%s'; |
| 141 | } |
| 142 | |
| 143 | return $format; |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Return whether or not donation id exist in give_revenue table. |
| 148 | * |
| 149 | * @sicne 2.9.0 |
| 150 | * |
| 151 | * @param int $donationId |
| 152 | * |
| 153 | * @return bool |
| 154 | */ |
| 155 | public function isDonationExist($donationId) |
| 156 | { |
| 157 | global $wpdb; |
| 158 | |
| 159 | return (bool)DB::get_var( |
| 160 | DB::prepare( |
| 161 | " |
| 162 | SELECT donation_id |
| 163 | FROM {$wpdb->give_revenue} |
| 164 | WHERE donation_id = %d |
| 165 | ", |
| 166 | $donationId |
| 167 | ) |
| 168 | ); |
| 169 | } |
| 170 | } |
| 171 |