AffiliationPayoutsController.php
10 months ago
AffiliationPayoutsListTable.php
1 year ago
AffiliationPayoutsScriptsController.php
2 years ago
AffiliationPayoutsListTable.php
346 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Controllers\Admin\AffiliationPayouts; |
| 4 | |
| 5 | use SureCart\Controllers\Admin\Tables\ListTable; |
| 6 | use SureCart\Models\Payout; |
| 7 | |
| 8 | /** |
| 9 | * Create a new table class that will extend the WP_List_Table |
| 10 | */ |
| 11 | class AffiliationPayoutsListTable extends ListTable { |
| 12 | |
| 13 | /** |
| 14 | * Checkbox column. |
| 15 | * |
| 16 | * @var boolean |
| 17 | */ |
| 18 | public $checkbox = true; |
| 19 | |
| 20 | /** |
| 21 | * Error message. |
| 22 | * |
| 23 | * @var string |
| 24 | */ |
| 25 | public $error = ''; |
| 26 | |
| 27 | /** |
| 28 | * Pages. |
| 29 | * |
| 30 | * @var array |
| 31 | */ |
| 32 | public $pages = array(); |
| 33 | |
| 34 | /** |
| 35 | * Prepare the items for the table to process |
| 36 | * |
| 37 | * @return void |
| 38 | */ |
| 39 | public function prepare_items() { |
| 40 | $columns = $this->get_columns(); |
| 41 | $hidden = $this->get_hidden_columns(); |
| 42 | $sortable = $this->get_sortable_columns(); |
| 43 | |
| 44 | $this->_column_headers = array( $columns, $hidden, $sortable ); |
| 45 | |
| 46 | $query = $this->table_data(); |
| 47 | |
| 48 | if ( is_wp_error( $query ) ) { |
| 49 | $this->error = $query->get_error_message(); |
| 50 | $this->items = array(); |
| 51 | return; |
| 52 | } |
| 53 | |
| 54 | $this->set_pagination_args( |
| 55 | array( |
| 56 | 'total_items' => $query->pagination->count, |
| 57 | 'per_page' => $this->get_items_per_page( 'affiliate_payouts' ), |
| 58 | ) |
| 59 | ); |
| 60 | |
| 61 | $this->items = $query->data; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Get views for the list table status links. |
| 66 | * |
| 67 | * @global int $post_id |
| 68 | * @global string $comment_status |
| 69 | * @global string $comment_type |
| 70 | */ |
| 71 | protected function get_views() { |
| 72 | foreach ( $this->getStatuses() as $status => $label ) { |
| 73 | $current_link_attributes = ''; |
| 74 | $link = admin_url( 'admin.php?page=sc-affiliate-payouts' ); |
| 75 | |
| 76 | if ( ! empty( $_GET['status'] ) ) { |
| 77 | if ( $status === $_GET['status'] ) { |
| 78 | $current_link_attributes = ' class="current" aria-current="page"'; |
| 79 | } |
| 80 | } elseif ( 'all' === $status ) { |
| 81 | $current_link_attributes = ' class="current" aria-current="page"'; |
| 82 | } |
| 83 | |
| 84 | $link = add_query_arg( 'status', $status, $link ); |
| 85 | |
| 86 | $link = esc_url( $link ); |
| 87 | |
| 88 | $status_links[ $status ] = "<a href='$link'$current_link_attributes>" . $label . '</a>'; |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * Filters the comment status links. |
| 93 | * |
| 94 | * @since 2.5.0 |
| 95 | * @since 5.1.0 The 'Mine' link was added. |
| 96 | * |
| 97 | * @param string[] $status_links An associative array of fully-formed comment status links. Includes 'All', 'Mine','Pending', 'Approved', 'Spam', and 'Trash'. |
| 98 | * */ |
| 99 | return apply_filters( 'payout_status_links', $status_links ); |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Override the parent columns method. Defines the columns to use in your listing table |
| 104 | * |
| 105 | * @return array |
| 106 | */ |
| 107 | public function get_columns() { |
| 108 | return array_merge( |
| 109 | [ |
| 110 | 'date' => __( 'Date', 'surecart' ), |
| 111 | 'status' => __( 'Status', 'surecart' ), |
| 112 | 'affiliate' => __( 'Affiliate', 'surecart' ), |
| 113 | 'payout_email' => __( 'Payout Email', 'surecart' ), |
| 114 | 'period_end' => __( 'Period End', 'surecart' ), |
| 115 | 'referrals' => __( 'Referrals', 'surecart' ), |
| 116 | 'amount' => __( 'Amount', 'surecart' ), |
| 117 | ], |
| 118 | parent::get_columns() |
| 119 | ); |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * Handle the date column. |
| 124 | * |
| 125 | * @param \SureCart\Models\Payout $payout The Payout model. |
| 126 | * |
| 127 | * @return string |
| 128 | */ |
| 129 | public function column_date( $payout ) { |
| 130 | $date = esc_attr( $payout->created_at_date_time ); |
| 131 | |
| 132 | $actions = wp_kses_post( |
| 133 | $this->row_actions( |
| 134 | array_filter( |
| 135 | array( |
| 136 | 'complete' => '<a href="' . esc_url( $this->get_action_url( $payout->id, 'complete' ) ) . '">' . esc_html__( 'Complete', 'surecart' ) . '</a>', |
| 137 | 'make_processing' => '<a href="' . esc_url( $this->get_action_url( $payout->id, 'make_processing' ) ) . '">' . esc_html__( 'Make Processing', 'surecart' ) . '</a>', |
| 138 | 'delete' => '<a href="' . esc_url( $this->get_action_url( $payout->id, 'delete' ) ) . '">' . esc_html__( 'Delete', 'surecart' ) . '</a>', |
| 139 | ), |
| 140 | function ( $action, $key ) use ( $payout ) { |
| 141 | if ( 'complete' === $key && 'completed' === $payout->status ) { |
| 142 | return false; |
| 143 | } |
| 144 | |
| 145 | if ( 'make_processing' === $key && 'processing' === $payout->status ) { |
| 146 | return false; |
| 147 | } |
| 148 | |
| 149 | return true; |
| 150 | }, |
| 151 | ARRAY_FILTER_USE_BOTH |
| 152 | ) |
| 153 | ) |
| 154 | ); |
| 155 | |
| 156 | return $date . $actions; |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Handle the status column. |
| 161 | * |
| 162 | * @param \SureCart\Models\Payout $payout The Payout model. |
| 163 | * |
| 164 | * @return string |
| 165 | */ |
| 166 | public function column_status( $payout ) { |
| 167 | $type = 'completed' === $payout->status ? 'success' : 'warning'; |
| 168 | |
| 169 | return '<sc-tag type="' . $type . '">' . $payout->status_display_text . ' </sc-tag>'; |
| 170 | } |
| 171 | |
| 172 | /** |
| 173 | * Handle the affiliate column. |
| 174 | * |
| 175 | * @param \SureCart\Models\Payout $payout The Payout model. |
| 176 | * |
| 177 | * @return string |
| 178 | */ |
| 179 | public function column_affiliate( $payout ) { |
| 180 | $affiliation = $payout->affiliation ?? null; |
| 181 | if ( empty( $affiliation->id ) ) { |
| 182 | return ''; |
| 183 | } |
| 184 | |
| 185 | ob_start(); |
| 186 | ?> |
| 187 | <div class="sc-affiliate-name"> |
| 188 | <a href="<?php echo esc_url( \SureCart::getUrl()->edit( 'affiliates', $affiliation->id ) ); ?>"> |
| 189 | <?php echo esc_html( $affiliation->display_name ); ?> |
| 190 | </a> |
| 191 | </div> |
| 192 | <?php |
| 193 | return ob_get_clean(); |
| 194 | } |
| 195 | |
| 196 | /** |
| 197 | * Handle the payout email column. |
| 198 | * |
| 199 | * @param \SureCart\Models\Payout $payout The Payout model. |
| 200 | * |
| 201 | * @return string |
| 202 | */ |
| 203 | public function column_payout_email( $payout ) { |
| 204 | return esc_html( $payout->affiliation->payout_email ); |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Handle the period end column. |
| 209 | * |
| 210 | * @param \SureCart\Models\Payout $payout The Payout model. |
| 211 | * |
| 212 | * @return string |
| 213 | */ |
| 214 | public function column_period_end( $payout ) { |
| 215 | return $payout->end_at_date; |
| 216 | } |
| 217 | |
| 218 | /** |
| 219 | * Handle the referrals column. |
| 220 | * |
| 221 | * @param \SureCart\Models\Payout $payout The Payout model. |
| 222 | * |
| 223 | * @return string |
| 224 | */ |
| 225 | public function column_referrals( $payout ) { |
| 226 | return (int) $payout->referrals->pagination->count; |
| 227 | } |
| 228 | |
| 229 | /** |
| 230 | * Handle the amount column. |
| 231 | * |
| 232 | * @param \SureCart\Models\Payout $payout The Payout model. |
| 233 | * |
| 234 | * @return string |
| 235 | */ |
| 236 | public function column_amount( $payout ) { |
| 237 | return $payout->total_commission_display_amount; |
| 238 | } |
| 239 | |
| 240 | /** |
| 241 | * Get the table data |
| 242 | * |
| 243 | * @return \SureCart\Models\Collection |
| 244 | */ |
| 245 | private function table_data() { |
| 246 | return Payout::where( |
| 247 | array( |
| 248 | 'query' => $this->get_search_query(), |
| 249 | 'status' => [ $this->getFilteredStatus() ], |
| 250 | 'expand' => [ |
| 251 | 'affiliation', |
| 252 | 'referrals', |
| 253 | ], |
| 254 | ) |
| 255 | )->paginate( |
| 256 | array( |
| 257 | 'per_page' => $this->get_items_per_page( 'affiliate_payouts' ), |
| 258 | 'page' => $this->get_pagenum(), |
| 259 | ) |
| 260 | ); |
| 261 | } |
| 262 | |
| 263 | /** |
| 264 | * Nothing found. |
| 265 | * |
| 266 | * @return void |
| 267 | */ |
| 268 | public function no_items() { |
| 269 | if ( $this->error ) { |
| 270 | echo esc_html( $this->error ); |
| 271 | return; |
| 272 | } |
| 273 | echo esc_html_e( 'No affiliate payouts found.', 'surecart' ); |
| 274 | } |
| 275 | |
| 276 | /** |
| 277 | * Displays extra table navigation. |
| 278 | * |
| 279 | * @param string $which Top or bottom placement. |
| 280 | */ |
| 281 | protected function extra_tablenav( $which ) { |
| 282 | ?> |
| 283 | <input type="hidden" name="page" value="sc-affiliate-payouts" /> |
| 284 | |
| 285 | <?php if ( ! empty( $_GET['status'] ) ) : // phpcs:ignore WordPress.Security.NonceVerification.Recommended ?> |
| 286 | <input type="hidden" name="status" value="<?php echo esc_attr( $_GET['status'] ); ?>" /> |
| 287 | <?php endif; ?> |
| 288 | |
| 289 | <?php |
| 290 | /** |
| 291 | * Fires immediately following the closing "actions" div in the tablenav |
| 292 | * for the affiliate_payouts list table. |
| 293 | * |
| 294 | * @param string $which The location of the extra table nav markup: 'top' or 'bottom'. |
| 295 | */ |
| 296 | do_action( 'manage_affiliate_payouts_extra_tablenav', $which ); |
| 297 | } |
| 298 | |
| 299 | /** |
| 300 | * Get filtered status / default status. |
| 301 | * |
| 302 | * @return string|null |
| 303 | */ |
| 304 | private function getFilteredStatus() { |
| 305 | if ( empty( $_GET['status'] ) || 'all' === $_GET['status'] ) { |
| 306 | return null; |
| 307 | } |
| 308 | |
| 309 | return sanitize_text_field( wp_unslash( $_GET['status'] ) ); |
| 310 | } |
| 311 | |
| 312 | /** |
| 313 | * Get all statuses. |
| 314 | * |
| 315 | * @return array |
| 316 | */ |
| 317 | private function getStatuses(): array { |
| 318 | return array( |
| 319 | 'all' => __( 'All', 'surecart' ), |
| 320 | 'processing' => __( 'Processing', 'surecart' ), |
| 321 | 'completed' => __( 'Completed', 'surecart' ), |
| 322 | ); |
| 323 | } |
| 324 | |
| 325 | /** |
| 326 | * Get action url. |
| 327 | * |
| 328 | * @param int $id The id. |
| 329 | * @param string $action The action. |
| 330 | * |
| 331 | * @return string |
| 332 | */ |
| 333 | public function get_action_url( $id, $action ) { |
| 334 | return esc_url( |
| 335 | add_query_arg( |
| 336 | [ |
| 337 | 'action' => $action, |
| 338 | 'nonce' => wp_create_nonce( $action . '_affiliation_payout' ), |
| 339 | 'id' => $id, |
| 340 | ], |
| 341 | esc_url_raw( admin_url( 'admin.php?page=sc-affiliate-payouts' ) ) |
| 342 | ) |
| 343 | ); |
| 344 | } |
| 345 | } |
| 346 |