CancellationInsightsListTable.php — SureCart – Ecommerce Made Easy For Selling Physical Products, Digital Downloads, Subscriptions, Donations, & Payments 3.0.0-beta2

surecart / app / src / Controllers / Admin / CancellationInsights / CancellationInsightsListTable.php

surecart / app / src / Controllers / Admin / CancellationInsights Last commit date

CancellationInsightsController.php 2 years ago CancellationInsightsListTable.php 2 years ago CancellationInsightsScriptsController.php 3 years ago

CancellationInsightsListTable.php

209 lines

1	<?php
2
3	namespace SureCart\Controllers\Admin\CancellationInsights;
4
5	use SureCart\Controllers\Admin\Tables\ListTable;
6	use SureCart\Models\CancellationAct;
7
8	/**
9	* Create a new table class that will extend the WP_List_Table
10	*/
11	class CancellationInsightsListTable extends ListTable {
12	/**
13	* Prepare the items for the table to process
14	*
15	* @return Void
16	*/
17	public function prepare_items() {
18	$columns = $this->get_columns();
19	$hidden = $this->get_hidden_columns();
20	$sortable = $this->get_sortable_columns();
21
22	$this->_column_headers = array( $columns, $hidden, $sortable );
23
24	$query = $this->table_data();
25	if ( is_wp_error( $query ) ) {
26	$this->items = [];
27	return;
28	}
29
30	$this->set_pagination_args(
31	[
32	'total_items' => $query->pagination->count,
33	'per_page' => $this->get_items_per_page( 'orders' ),
34	]
35	);
36
37	$this->items = $query->data;
38	}
39
40
41	/**
42	* Override the parent columns method. Defines the columns to use in your listing table
43	*
44	* @return Array
45	*/
46	public function get_columns() {
47	return [
48	'customer' => __( 'Customer', 'surecart' ),
49	'plan' => __( 'Plan', 'surecart' ),
50	'cancellation_reason' => __( 'Cancellation Reason', 'surecart' ),
51	'comment' => __( 'Comment', 'surecart' ),
52	'status' => __( 'Plan Status', 'surecart' ),
53	'date' => __( 'Date', 'surecart' ),
54	];
55	}
56
57	/**
58	* The subscription product.
59	*
60	* @param \SureCart\Models\CancellationAct $act Cancellation reason model.
61	*
62	* @return string
63	*/
64	public function column_plan( $act ) {
65	if ( empty( $act->subscription->price->product ) ) {
66	return __( 'No product', 'surecart' );
67	}
68	return '<a href="' . esc_url( \SureCart::getUrl()->show( 'subscription', $act->subscription->id ) ) . '">' . $act->subscription->price->product->name . '</a>';
69	}
70
71	/**
72	* The subscription product.
73	*
74	* @param \SureCart\Models\CancellationAct $act Cancellation reason model.
75	*
76	* @return string
77	*/
78	public function column_date( $act ) {
79	return '<sc-format-date date="' . (int) $act->performed_at . '" type="timestamp" month="short" day="numeric" year="numeric" hour="numeric" minute="numeric"></sc-format-date>';
80	}
81
82	/**
83	* We only have one default view.
84	*/
85	protected function get_views() {
86	return [ 'all' => __( 'All Cancellation Attempts', 'surecart' ) ];
87	}
88
89	/**
90	* Get the table data
91	*
92	* @return Object
93	*/
94	protected function table_data() {
95	return CancellationAct::where(
96	[
97	'live_mode' => 'false' !== sanitize_text_field( wp_unslash( $_GET['live_mode'] ?? '' ) ), // phpcs:ignore WordPress.Security.NonceVerification.Recommended
98	]
99	)
100	->with(
101	[
102	'subscription',
103	'subscription.customer',
104	'cancellation_reason',
105	'subscription.price',
106	'price.product',
107	]
108	)
109	->paginate(
110	[
111	'per_page' => $this->get_items_per_page( 'cancellation_acts' ),
112	'page' => $this->get_pagenum(),
113	]
114	);
115	}
116
117	/**
118	* Nothing found.
119	*
120	* @return void
121	*/
122	public function no_items() {
123	echo esc_html_e( 'No cancellation acts.', 'surecart' );
124	}
125
126	/**
127	* The cancellation reason.
128	*
129	* @param \SureCart\Models\CancellationAct $act Cancellation act.
130	*
131	* @return string
132	*/
133	public function column_cancellation_reason( $act ) {
134	return $act->cancellation_reason->label ?? '-';
135	}
136
137	/**
138	* The customer.
139	*
140	* @param \SureCart\Models\CancellationAct $act Cancellation act model.
141	*
142	* @return string
143	*/
144	public function column_customer( $act ) {
145	ob_start();
146	?>
147	<a class="row-title" aria-label="<?php esc_attr_e( 'Edit Customer', 'surecart' ); ?>" href="<?php echo esc_url( \SureCart::getUrl()->edit( 'customers', $act->subscription->customer->id ) ); ?>">
148	<?php echo wp_kses_post( $act->subscription->customer->name ?? $act->subscription->customer->email ?? esc_html__( 'No name provided', 'surecart' ) ); ?>
149	</a>
150
151	<?php
152	echo $this->row_actions(
153	[
154	'edit' => '<a href="' . esc_url( \SureCart::getUrl()->edit( 'customers', $act->subscription->customer->id ) ) . '" aria-label="' . esc_attr( 'View Customer', 'surecart' ) . '">' . esc_html__( 'View Customer', 'surecart' ) . '</a>',
155	],
156	);
157	?>
158
159	<?php
160	return ob_get_clean();
161	}
162
163	/**
164	* Cancellation comment.
165	*
166	* @param \SureCart\Models\CancellationAct $act Cancellation act model.
167	*
168	* @return string
169	*/
170	public function column_comment( $act ) {
171	return $act->comment ?? '-';
172	}
173
174	/**
175	* The status
176	*
177	* @param \SureCart\Models\CancellationAct $act Cancellation act model.
178	*
179	* @return string
180	*/
181	public function column_status( $act ) {
182
183	if ( $act->preserved ) {
184	ob_start();
185	?>
186	<sc-tag type="success"><?php
187	// translators: Subscription saver feature. This is displayed if the subscription has been "Saved" from cancellation.
188	echo esc_html__( 'Saved', 'surecart' ); ?> </sc-tag>
189	<?php if ( $act->coupon_applied ) { ?>
190	<sc-tag type="info"><?php echo esc_html__( 'Coupon Applied', 'surecart' ); ?></sc-tag>
191	<?php } ?>
192	<?php
193	return ob_get_clean();
194	}
195
196	$badge = '<sc-subscription-status-badge id="act-' . esc_attr( $act->id ) . '"></sc-subscription-status-badge>';
197
198	\SureCart::assets()->addComponentData(
199	'sc-subscription-status-badge',
200	'#act-' . esc_attr( $act->id ),
201	[
202	'subscription' => $act->subscription,
203	]
204	);
205
206	return $badge;
207	}
208	}
209