Revenue.php
144 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Revenue\Repositories; |
| 4 | |
| 5 | use Give\Framework\Database\DB; |
| 6 | use Give\Framework\Database\Exceptions\DatabaseQueryException; |
| 7 | use 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 | */ |
| 17 | class Revenue { |
| 18 | /** |
| 19 | * Insert revenue. |
| 20 | * |
| 21 | * @since 2.9.0 |
| 22 | * |
| 23 | * @param array $revenueData |
| 24 | * |
| 25 | * @return bool|int |
| 26 | */ |
| 27 | public function insert( $revenueData ) { |
| 28 | global $wpdb; |
| 29 | |
| 30 | // Validate revenue data |
| 31 | $this->validateNewRevenueData( $revenueData ); |
| 32 | |
| 33 | /** |
| 34 | * Filter revenue data before inserting to revenue table. |
| 35 | * |
| 36 | * @since 2.9.0 |
| 37 | */ |
| 38 | $revenueData = apply_filters( 'give_revenue_insert_data', $revenueData ); |
| 39 | |
| 40 | return $wpdb->insert( |
| 41 | $wpdb->give_revenue, |
| 42 | $revenueData, |
| 43 | $this->getPlaceholderForPrepareQuery( $revenueData ) |
| 44 | ); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Deletes revenue |
| 49 | * |
| 50 | * @param $revenueId |
| 51 | * |
| 52 | * @return false|int |
| 53 | */ |
| 54 | public function deleteByDonationId( $revenueId ) { |
| 55 | global $wpdb; |
| 56 | |
| 57 | try { |
| 58 | return DB::delete( |
| 59 | $wpdb->give_revenue, |
| 60 | [ 'donation_id' => $revenueId ], |
| 61 | [ '%d' ] |
| 62 | ); |
| 63 | } catch ( DatabaseQueryException $exception ) { |
| 64 | give_record_log( |
| 65 | 'Revenue delete by donation failed', |
| 66 | $exception->getLogOutput(), |
| 67 | 0, |
| 68 | 'database' |
| 69 | ); |
| 70 | |
| 71 | throw $exception; |
| 72 | } |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Validate new revenue data. |
| 77 | * |
| 78 | * @since 2.9.0 |
| 79 | * |
| 80 | * @param array $array |
| 81 | */ |
| 82 | protected function validateNewRevenueData( $array ) { |
| 83 | $required = [ 'donation_id', 'form_id', 'amount' ]; |
| 84 | |
| 85 | $array = array_filter( $array ); // Remove empty values. |
| 86 | |
| 87 | if ( array_diff( $required, array_keys( $array ) ) ) { |
| 88 | throw new InvalidArgumentException( |
| 89 | sprintf( |
| 90 | 'To insert revenue, please provide valid %1$s.', |
| 91 | implode( ', ', $required ) |
| 92 | ) |
| 93 | ); |
| 94 | } |
| 95 | |
| 96 | foreach ( $required as $columnName ) { |
| 97 | if ( empty( $array[ $columnName ] ) ) { |
| 98 | throw new InvalidArgumentException( 'Empty value is not allowed to create revenue.' ); |
| 99 | } |
| 100 | } |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Get placeholder for prepare query. |
| 105 | * |
| 106 | * @param array $data |
| 107 | * |
| 108 | * @return string[] Array of value format type |
| 109 | */ |
| 110 | private function getPlaceholderForPrepareQuery( $data ) { |
| 111 | $format = []; |
| 112 | |
| 113 | foreach ( $data as $value ) { |
| 114 | $format[] = is_numeric( $value ) ? '%d' : '%s'; |
| 115 | } |
| 116 | |
| 117 | return $format; |
| 118 | } |
| 119 | |
| 120 | /** |
| 121 | * Return whether or not donation id exist in give_revenue table. |
| 122 | * |
| 123 | * @sicne 2.9.0 |
| 124 | * |
| 125 | * @param int $donationId |
| 126 | * |
| 127 | * @return bool |
| 128 | */ |
| 129 | public function isDonationExist( $donationId ) { |
| 130 | global $wpdb; |
| 131 | |
| 132 | return (bool) $wpdb->get_var( |
| 133 | $wpdb->prepare( |
| 134 | " |
| 135 | SELECT donation_id |
| 136 | FROM {$wpdb->give_revenue} |
| 137 | WHERE donation_id = %d |
| 138 | ", |
| 139 | $donationId |
| 140 | ) |
| 141 | ); |
| 142 | } |
| 143 | } |
| 144 |