AbandonedCheckoutListTable.php
3 months ago
AbandonedCheckoutScriptsController.php
3 years ago
AbandonedCheckoutViewController.php
1 year ago
AbandonedCheckoutListTable.php
300 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Controllers\Admin\Abandoned; |
| 4 | |
| 5 | use SureCart\Controllers\Admin\Tables\ListTable; |
| 6 | use SureCart\Models\AbandonedCheckout; |
| 7 | use SureCart\Controllers\Admin\Tables\HasModeFilter; |
| 8 | |
| 9 | /** |
| 10 | * Create a new table class that will extend the WP_List_Table |
| 11 | */ |
| 12 | class AbandonedCheckoutListTable extends ListTable { |
| 13 | use HasModeFilter; |
| 14 | |
| 15 | /** |
| 16 | * Prepare the items for the table to process |
| 17 | * |
| 18 | * @return Void |
| 19 | */ |
| 20 | public function prepare_items() { |
| 21 | $columns = $this->get_columns(); |
| 22 | $hidden = $this->get_hidden_columns(); |
| 23 | $sortable = $this->get_sortable_columns(); |
| 24 | |
| 25 | $this->_column_headers = array( $columns, $hidden, $sortable ); |
| 26 | |
| 27 | $query = $this->table_data(); |
| 28 | if ( is_wp_error( $query ) ) { |
| 29 | $this->items = []; |
| 30 | return; |
| 31 | } |
| 32 | |
| 33 | $this->set_pagination_args( |
| 34 | [ |
| 35 | 'total_items' => $query->pagination->count, |
| 36 | 'per_page' => $this->get_items_per_page( 'abandoned_checkout' ), |
| 37 | ] |
| 38 | ); |
| 39 | |
| 40 | $this->items = $query->data; |
| 41 | } |
| 42 | |
| 43 | protected function get_views() { |
| 44 | $stati = [ |
| 45 | 'all' => __( 'All', 'surecart' ), |
| 46 | 'scheduled' => __( 'Scheduled', 'surecart' ), |
| 47 | 'sent' => __( 'Sent', 'surecart' ), |
| 48 | 'not_scheduled' => __( 'Not Scheduled', 'surecart' ), |
| 49 | ]; |
| 50 | |
| 51 | foreach ( $stati as $status => $label ) { |
| 52 | $link = \SureCart::getUrl()->index( 'abandoned-checkout' ); |
| 53 | |
| 54 | $current_link_attributes = ''; |
| 55 | |
| 56 | if ( ! empty( $_GET['status'] ) ) { |
| 57 | if ( sanitize_text_field( wp_unslash( $_GET['status'] ) ) === $status ) { |
| 58 | $current_link_attributes = ' class="current" aria-current="page"'; |
| 59 | } |
| 60 | } elseif ( 'all' === $status ) { |
| 61 | $current_link_attributes = ' class="current" aria-current="page"'; |
| 62 | } |
| 63 | |
| 64 | $link = add_query_arg( 'status', $status, $link ); |
| 65 | |
| 66 | $link = esc_url( $link ); |
| 67 | |
| 68 | $status_links[ $status ] = "<a href='$link'$current_link_attributes>" . $label . '</a>'; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Filters the comment status links. |
| 73 | * |
| 74 | * @since 2.5.0 |
| 75 | * @since 5.1.0 The 'Mine' link was added. |
| 76 | * |
| 77 | * @param string[] $status_links An associative array of fully-formed comment status links. Includes 'All', 'Mine', |
| 78 | * 'Pending', 'Approved', 'Spam', and 'Trash'. |
| 79 | */ |
| 80 | return apply_filters( 'abandoned_order_status_links', $status_links ); |
| 81 | } |
| 82 | |
| 83 | public function search() { |
| 84 | ?> |
| 85 | <form class="search-form" |
| 86 | method="get"> |
| 87 | <?php $this->search_box( __( 'Search Abanonded Orders', 'surecart' ), 'abandoned_order' ); ?> |
| 88 | <input type="hidden" |
| 89 | name="id" |
| 90 | value="1" /> |
| 91 | </form> |
| 92 | <?php |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Override the parent columns method. Defines the columns to use in your listing table |
| 97 | * |
| 98 | * @return Array |
| 99 | */ |
| 100 | public function get_columns() { |
| 101 | return array_merge( |
| 102 | [ |
| 103 | 'placed_by' => __( 'Placed By', 'surecart' ), |
| 104 | 'created' => __( 'Date', 'surecart' ), |
| 105 | 'notification_status' => __( 'Email Status', 'surecart' ), |
| 106 | 'recovery_status' => __( 'Recovery Status', 'surecart' ), |
| 107 | 'total' => __( 'Total', 'surecart' ), |
| 108 | 'mode' => '', |
| 109 | ], |
| 110 | parent::get_columns() |
| 111 | ); |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * Get the table data |
| 116 | * |
| 117 | * @return Array |
| 118 | */ |
| 119 | protected function table_data() { |
| 120 | $mode = sanitize_text_field( wp_unslash( $_GET['mode'] ?? '' ) ); |
| 121 | $status = $this->getStatus(); |
| 122 | $where = array(); |
| 123 | |
| 124 | if ( ! empty( $mode ) ) { |
| 125 | $where['live_mode'] = 'live' === $mode; |
| 126 | } |
| 127 | |
| 128 | if ( $status ) { |
| 129 | $where['notification_status'] = [ $status ]; |
| 130 | } |
| 131 | |
| 132 | return AbandonedCheckout::where( $where ) |
| 133 | ->with( [ 'recovered_checkout', 'checkout', 'customer' ] ) |
| 134 | ->paginate( |
| 135 | [ |
| 136 | 'per_page' => $this->get_items_per_page( 'abandoned-checkouts' ), |
| 137 | 'page' => $this->get_pagenum(), |
| 138 | 'expand' => [ 'checkout' ], |
| 139 | ] |
| 140 | ); |
| 141 | } |
| 142 | |
| 143 | /** |
| 144 | * Get the archive query status. |
| 145 | * |
| 146 | * @return boolean|null |
| 147 | */ |
| 148 | public function getStatus() { |
| 149 | $status = sanitize_text_field( wp_unslash( $_GET['status'] ?? 'all' ) ); |
| 150 | if ( 'all' === $status ) { |
| 151 | return null; |
| 152 | } |
| 153 | return $status ? [ esc_html( $status ) ] : []; |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Handle the total column |
| 158 | * |
| 159 | * @param \SureCart\Models\AbandonedCheckout $checkout Checkout Session Model. |
| 160 | * |
| 161 | * @return string |
| 162 | */ |
| 163 | public function column_total( $abandoned ) { |
| 164 | return $abandoned->checkout->total_display_amount; |
| 165 | } |
| 166 | |
| 167 | /** |
| 168 | * Handle the notification status |
| 169 | * |
| 170 | * @param \SureCart\Models\AbandonedCheckout $abandoned Abandoned checkout session. |
| 171 | * |
| 172 | * @return string |
| 173 | */ |
| 174 | public function column_notification_status( $abandoned ) { |
| 175 | if ( $abandoned->recovered_checkout ) { |
| 176 | return '--'; |
| 177 | } |
| 178 | |
| 179 | switch ( $abandoned->notification_status ?? '' ) { |
| 180 | case 'scheduled': |
| 181 | return '<sc-tag type="info">' . __( 'Scheduled', 'surecart' ) . '</sc-tag>'; |
| 182 | case 'not_scheduled': |
| 183 | return '<sc-tag type="warning">' . __( 'Not Scheduled', 'surecart' ) . '</sc-tag>'; |
| 184 | case 'sent': |
| 185 | return '<sc-tag type="success">' . __( 'Email Sent', 'surecart' ) . '</sc-tag>'; |
| 186 | } |
| 187 | return '<sc-tag>' . esc_html( $abandoned->notification_status ?? 'Unknown' ) . '</sc-tag>'; |
| 188 | } |
| 189 | |
| 190 | /** |
| 191 | * Handle the recovery status |
| 192 | * |
| 193 | * @param \SureCart\Models\AbandonedCheckout $abandoned Abandoned checkout session. |
| 194 | * |
| 195 | * @return string |
| 196 | */ |
| 197 | public function column_recovery_status( $abandoned ) { |
| 198 | switch ( $abandoned->recovery_status ) { |
| 199 | case 'abandoned': |
| 200 | return '<sc-tag type="warning">' . __( 'Abandoned', 'surecart' ) . '</sc-tag>'; |
| 201 | case 'assisted_recovered': |
| 202 | return '<sc-tag type="success">' . __( 'Recovered', 'surecart' ) . '</sc-tag>'; |
| 203 | case 'unassisted_recovered': |
| 204 | return '<sc-tag type="info">' . __( 'Recovered Before Email Was Sent', 'surecart' ) . '</sc-tag>'; |
| 205 | } |
| 206 | return '<sc-tag type="success">' . esc_html( $abandoned->recovery_status ) . '</sc-tag>'; |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | * Handle the mode column |
| 211 | * |
| 212 | * @param \SureCart\Models\AbandonedCheckout $abandoned Abandoned checkout model. |
| 213 | * |
| 214 | * @return string |
| 215 | */ |
| 216 | public function column_mode( $abandoned ) { |
| 217 | return empty( $abandoned->checkout->live_mode ) ? '<sc-tag type="warning">' . __( 'Test', 'surecart' ) . '</sc-tag>' : ''; |
| 218 | } |
| 219 | |
| 220 | /** |
| 221 | * Email of customer |
| 222 | * |
| 223 | * @param \SureCart\Models\AbandonedCheckout $abandoned Abandoned checkout model. |
| 224 | * |
| 225 | * @return string |
| 226 | */ |
| 227 | public function column_placed_by( $abandoned ) { |
| 228 | ob_start(); |
| 229 | ?> |
| 230 | <a class="row-title" aria-label="<?php esc_attr_e( 'Edit Order', 'surecart' ); ?>" href="<?php echo esc_url( \SureCart::getUrl()->edit( 'abandoned-checkout', $abandoned->id ) ); ?>"> |
| 231 | <?php |
| 232 | // translators: Customer name. |
| 233 | printf( esc_html__( 'By %s', 'surecart' ), esc_html( $abandoned->customer->name ?? $abandoned->customer->email ) ); |
| 234 | ?> |
| 235 | </a> |
| 236 | <br /> |
| 237 | <a aria-label="<?php esc_attr_e( 'View Checkout', 'surecart' ); ?>" href="<?php echo esc_url( \SureCart::getUrl()->edit( 'abandoned-checkout', $abandoned->id ) ); ?>"> |
| 238 | <?php esc_attr_e( 'View Checkout', 'surecart' ); ?> |
| 239 | </a> |
| 240 | <?php |
| 241 | |
| 242 | return ob_get_clean(); |
| 243 | } |
| 244 | |
| 245 | /** |
| 246 | * Displays extra table navigation. |
| 247 | * |
| 248 | * @param string $which Top or bottom placement. |
| 249 | */ |
| 250 | protected function extra_tablenav( $which ) { |
| 251 | ?> |
| 252 | <input type="hidden" name="page" value="sc-abandoned-checkouts" /> |
| 253 | |
| 254 | <div class="alignleft actions"> |
| 255 | <?php |
| 256 | if ( 'top' === $which ) { |
| 257 | ob_start(); |
| 258 | $this->mode_dropdown(); |
| 259 | |
| 260 | /** |
| 261 | * Fires before the Filter button on the Posts and Pages list tables. |
| 262 | * |
| 263 | * The Filter button allows sorting by date and/or category on the |
| 264 | * Posts list table, and sorting by date on the Pages list table. |
| 265 | * |
| 266 | * @since 2.1.0 |
| 267 | * @since 4.4.0 The `$post_type` parameter was added. |
| 268 | * @since 4.6.0 The `$which` parameter was added. |
| 269 | * |
| 270 | * @param string $post_type The post type slug. |
| 271 | * @param string $which The location of the extra table nav markup: |
| 272 | * 'top' or 'bottom' for WP_Posts_List_Table, |
| 273 | * 'bar' for WP_Media_List_Table. |
| 274 | */ |
| 275 | do_action( 'restrict_manage_abandoned_checkouts', $this->screen->post_type, $which ); |
| 276 | |
| 277 | $output = ob_get_clean(); |
| 278 | |
| 279 | if ( ! empty( $output ) ) { |
| 280 | echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 281 | submit_button( __( 'Filter', 'surecart' ), '', 'filter_action', false, array( 'id' => 'filter-by-mode-submit' ) ); |
| 282 | } |
| 283 | } |
| 284 | |
| 285 | ?> |
| 286 | </div> |
| 287 | |
| 288 | <?php |
| 289 | /** |
| 290 | * Fires immediately following the closing "actions" div in the tablenav for the posts |
| 291 | * list table. |
| 292 | * |
| 293 | * @since 4.4.0 |
| 294 | * |
| 295 | * @param string $which The location of the extra table nav markup: 'top' or 'bottom'. |
| 296 | */ |
| 297 | do_action( 'manage_abandoned_checkouts_extra_tablenav', $which ); |
| 298 | } |
| 299 | } |
| 300 |