CustomersController.php
2 years ago
CustomersListTable.php
1 year ago
CustomersScriptsController.php
3 years ago
CustomersListTable.php
229 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Controllers\Admin\Customers; |
| 4 | |
| 5 | use SureCart\Models\Product; |
| 6 | use SureCart\Models\Customer; |
| 7 | use SureCart\Controllers\Admin\Tables\ListTable; |
| 8 | use SureCart\Controllers\Admin\Tables\HasModeFilter; |
| 9 | |
| 10 | /** |
| 11 | * Create a new table class that will extend the WP_List_Table |
| 12 | */ |
| 13 | class CustomersListTable extends ListTable { |
| 14 | use HasModeFilter; |
| 15 | |
| 16 | /** |
| 17 | * Prepare the items for the table to process |
| 18 | * |
| 19 | * @return Void |
| 20 | */ |
| 21 | public function prepare_items() { |
| 22 | $columns = $this->get_columns(); |
| 23 | $hidden = $this->get_hidden_columns(); |
| 24 | $sortable = $this->get_sortable_columns(); |
| 25 | |
| 26 | $this->_column_headers = array( $columns, $hidden, $sortable ); |
| 27 | |
| 28 | $query = $this->table_data(); |
| 29 | if ( is_wp_error( $query ) ) { |
| 30 | $this->items = []; |
| 31 | return; |
| 32 | } |
| 33 | |
| 34 | $this->set_pagination_args( |
| 35 | [ |
| 36 | 'total_items' => $query->pagination->count, |
| 37 | 'per_page' => $this->get_items_per_page( 'customerss' ), |
| 38 | ] |
| 39 | ); |
| 40 | |
| 41 | $this->items = $query->data; |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Override the parent columns method. Defines the columns to use in your listing table |
| 46 | * |
| 47 | * @return Array |
| 48 | */ |
| 49 | public function get_columns() { |
| 50 | return [ |
| 51 | 'name' => __( 'Name', 'surecart' ), |
| 52 | 'email' => __( 'Email', 'surecart' ), |
| 53 | 'created' => __( 'Created', 'surecart' ), |
| 54 | 'mode' => '', |
| 55 | ]; |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Displays the checkbox column. |
| 60 | * |
| 61 | * @param Product $product The product model. |
| 62 | */ |
| 63 | public function column_cb( $product ) { |
| 64 | ?> |
| 65 | <label class="screen-reader-text" for="cb-select-<?php echo esc_attr( $product['id'] ); ?>"><?php _e( 'Select comment', 'surecart' ); ?></label> |
| 66 | <input id="cb-select-<?php echo esc_attr( $product['id'] ); ?>" type="checkbox" name="delete_comments[]" value="<?php echo esc_attr( $product['id'] ); ?>" /> |
| 67 | <?php |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Define which columns are hidden |
| 72 | * |
| 73 | * @return Array |
| 74 | */ |
| 75 | public function get_hidden_columns() { |
| 76 | return array(); |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * Define the sortable columns |
| 81 | * |
| 82 | * @return Array |
| 83 | */ |
| 84 | public function get_sortable_columns() { |
| 85 | return array( 'title' => array( 'title', false ) ); |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Get the table data |
| 90 | * |
| 91 | * @return object|\WP_Error |
| 92 | */ |
| 93 | private function table_data() { |
| 94 | $mode = sanitize_text_field( wp_unslash( $_GET['mode'] ?? '' ) ); |
| 95 | $conditions = array( |
| 96 | 'query' => $this->get_search_query(), |
| 97 | ); |
| 98 | |
| 99 | if ( ! empty( $mode ) ) { |
| 100 | $conditions['live_mode'] = 'live' === $mode; |
| 101 | } |
| 102 | |
| 103 | return Customer::where( $conditions ) |
| 104 | ->paginate( |
| 105 | [ |
| 106 | 'per_page' => $this->get_items_per_page( 'customers' ), |
| 107 | 'page' => $this->get_pagenum(), |
| 108 | ] |
| 109 | ); |
| 110 | } |
| 111 | |
| 112 | /** |
| 113 | * Nothing found. |
| 114 | * |
| 115 | * @return void |
| 116 | */ |
| 117 | public function no_items() { |
| 118 | echo esc_html_e( 'No customers found.', 'surecart' ); |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * The customer email. |
| 123 | * |
| 124 | * @param \SureCart\Models\Customer $customer The customer model. |
| 125 | * |
| 126 | * @return string |
| 127 | */ |
| 128 | public function column_email( $customer ) { |
| 129 | return sanitize_email( $customer->email ); |
| 130 | } |
| 131 | |
| 132 | /** |
| 133 | * Name column |
| 134 | * |
| 135 | * @param \SureCart\Models\Customer $customer Customer model. |
| 136 | * |
| 137 | * @return string |
| 138 | */ |
| 139 | public function column_name( $customer ) { |
| 140 | ob_start(); |
| 141 | ?> |
| 142 | <a class="row-title" aria-label="<?php esc_attr_e( 'Edit Customer', 'surecart' ); ?>" href="<?php echo esc_url( \SureCart::getUrl()->edit( 'customers', $customer->id ) ); ?>"> |
| 143 | <?php echo wp_kses_post( $customer->name ?? $customer->email ); ?> |
| 144 | </a> |
| 145 | |
| 146 | <?php |
| 147 | echo $this->row_actions( |
| 148 | [ |
| 149 | 'edit' => '<a href="' . esc_url( \SureCart::getUrl()->edit( 'customers', $customer->id ) ) . '" aria-label="' . esc_attr__( 'Edit Customer', 'surecart' ) . '">' . __( 'Edit', 'surecart' ) . '</a>', |
| 150 | ], |
| 151 | ); |
| 152 | ?> |
| 153 | |
| 154 | <?php |
| 155 | return ob_get_clean(); |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Define what data to show on each column of the table |
| 160 | * |
| 161 | * @param \SureCart\Models\Product $product Product model. |
| 162 | * @param String $column_name - Current column name. |
| 163 | * |
| 164 | * @return Mixed |
| 165 | */ |
| 166 | public function column_default( $product, $column_name ) { |
| 167 | switch ( $column_name ) { |
| 168 | case 'name': |
| 169 | return '<a href="' . \SureCart::getUrl()->edit( 'product', $product->id ) . '">' . $product->name . '</a>'; |
| 170 | case 'name': |
| 171 | case 'description': |
| 172 | return $product->$column_name ?? ''; |
| 173 | } |
| 174 | } |
| 175 | |
| 176 | /** |
| 177 | * Displays extra table navigation. |
| 178 | * |
| 179 | * @param string $which Top or bottom placement. |
| 180 | */ |
| 181 | protected function extra_tablenav( $which ) { |
| 182 | ?> |
| 183 | <input type="hidden" name="page" value="sc-customers" /> |
| 184 | |
| 185 | <div class="alignleft actions"> |
| 186 | <?php |
| 187 | if ( 'top' === $which ) { |
| 188 | ob_start(); |
| 189 | $this->mode_dropdown(); |
| 190 | |
| 191 | /** |
| 192 | * Fires before the Filter button on the Posts and Pages list tables. |
| 193 | * |
| 194 | * The Filter button allows sorting by date and/or category on the |
| 195 | * Posts list table, and sorting by date on the Pages list table. |
| 196 | * |
| 197 | * @since 2.1.0 |
| 198 | * @since 4.4.0 The `$post_type` parameter was added. |
| 199 | * @since 4.6.0 The `$which` parameter was added. |
| 200 | * |
| 201 | * @param string $post_type The post type slug. |
| 202 | * @param string $which The location of the extra table nav markup: |
| 203 | * 'top' or 'bottom' for WP_Posts_List_Table, |
| 204 | * 'bar' for WP_Media_List_Table. |
| 205 | */ |
| 206 | do_action( 'restrict_manage_customers', $this->screen->post_type, $which ); |
| 207 | |
| 208 | $output = ob_get_clean(); |
| 209 | |
| 210 | if ( ! empty( $output ) ) { |
| 211 | echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 212 | submit_button( __( 'Filter' ), '', 'filter_action', false, array( 'id' => 'filter-by-mode-submit' ) ); |
| 213 | } |
| 214 | } |
| 215 | |
| 216 | ?> |
| 217 | </div> |
| 218 | |
| 219 | <?php |
| 220 | /** |
| 221 | * Fires immediately following the closing "actions" div in the tablenav |
| 222 | * for the affiliate referrals list table. |
| 223 | * |
| 224 | * @param string $which The location of the extra table nav markup: 'top' or 'bottom'. |
| 225 | */ |
| 226 | do_action( 'manage_customers_extra_tablenav', $which ); |
| 227 | } |
| 228 | } |
| 229 |