abstract-admin-list-table.php — Advanced Ads – Ad Manager & AdSense 2.0.25

advanced-ads / includes / abstracts / abstract-admin-list-table.php

advanced-ads / includes / abstracts Last commit date

abstract-ad.php 2 days ago abstract-admin-list-table.php 1 week ago abstract-data.php 1 week ago abstract-factory.php 2 days ago abstract-group.php 2 days ago abstract-placement-type.php 1 week ago abstract-placement.php 2 days ago abstract-screen.php 3 months ago abstract-types.php 2 days ago index.php 2 years ago

abstract-admin-list-table.php

227 lines

1	<?php
2	/**
3	* This class is serving as the base for admin tables and providing a foundation.
4	*
5	* @package AdvancedAds
6	* @author Advanced Ads <info@wpadvancedads.com>
7	* @since 1.48.2
8	*/
9
10	namespace AdvancedAds\Abstracts;
11
12	use AdvancedAds\Framework\Interfaces\Integration_Interface;
13	use WP_Screen;
14
15	defined( 'ABSPATH' ) \|\| exit;
16
17	/**
18	* Admin List Table.
19	*/
20	abstract class Admin_List_Table implements Integration_Interface {
21
22	/**
23	* Object being shown on the row.
24	*
25	* @var object\|null
26	*/
27	protected $object = null;
28
29	/**
30	* Object type.
31	*
32	* @var string
33	*/
34	protected $object_type = 'unknown';
35
36	/**
37	* Post type.
38	*
39	* @var string
40	*/
41	protected $list_table_type = '';
42
43	/**
44	* Hook into WordPress.
45	*
46	* @return void
47	*/
48	public function hooks(): void {
49	if ( $this->list_table_type ) {
50	// Columns.
51	add_filter( 'default_hidden_columns', [ $this, 'default_hidden_columns' ], 10, 2 );
52	add_filter( 'manage_' . $this->list_table_type . '_posts_columns', [ $this, 'define_columns' ] );
53	add_filter( 'manage_edit-' . $this->list_table_type . '_sortable_columns', [ $this, 'define_sortable_columns' ] );
54	add_action( 'manage_' . $this->list_table_type . '_posts_custom_column', [ $this, 'render_columns' ], 10, 2 );
55
56	// Views.
57	add_filter( 'view_mode_post_types', [ $this, 'disable_view_mode' ] );
58	add_action( 'restrict_manage_posts', [ $this, 'restrict_manage_posts' ] );
59
60	// Query.
61	add_filter( 'request', [ $this, 'request_query' ] );
62	}
63	}
64
65	/**
66	* Define which columns to show on this screen.
67	*
68	* @param array $columns Existing columns.
69	*
70	* @return array
71	*/
72	public function define_columns( $columns ): array {
73	return $columns;
74	}
75
76	/**
77	* Define which columns are sortable.
78	*
79	* @param array $columns Existing columns.
80	*
81	* @return array
82	*/
83	public function define_sortable_columns( $columns ): array {
84	return $columns;
85	}
86
87	/**
88	* Define hidden columns.
89	*
90	* @return array
91	*/
92	protected function define_hidden_columns(): array {
93	return [];
94	}
95
96	/**
97	* Adjust which columns are displayed by default.
98	*
99	* @param array $hidden Current hidden columns.
100	* @param WP_Screen $screen Current screen.
101	*
102	* @return array
103	*/
104	public function default_hidden_columns( $hidden, $screen ): array {
105	if ( isset( $screen->id ) && 'edit-' . $this->list_table_type === $screen->id ) {
106	$hidden = array_merge( $hidden, $this->define_hidden_columns() );
107	}
108
109	return $hidden;
110	}
111
112	/**
113	* Pre-fetch any data for the row each column has access to it.
114	*
115	* @param int $post_id Post ID being shown.
116	*
117	* @return void
118	*/
119	protected function prepare_row_data( $post_id ): void {}
120
121	/**
122	* Render individual columns.
123	*
124	* @param string $column Column ID to render.
125	* @param int $post_id Post ID being shown.
126	*
127	* @return void
128	*/
129	public function render_columns( $column, $post_id ): void {
130	$this->prepare_row_data( $post_id );
131
132	if ( ! $this->object ) {
133	return;
134	}
135
136	if ( is_callable( [ $this, 'render_' . $column . '_column' ] ) ) {
137	$this->{"render_{$column}_column"}();
138	}
139
140	do_action( 'advanced-ads-ad-render-columns', $column, $this->object );
141	do_action( "advanced-ads-{$this->object_type}-render-column-{$column}", $this->object );
142	}
143
144	/**
145	* Removes this type from list of post types that support "View Mode" switching.
146	* View mode is seen on posts where you can switch between list or excerpt. Our post types don't support
147	* it, so we want to hide the useless UI from the screen options tab.
148	*
149	* @param array $post_types Array of post types supporting view mode.
150	*
151	* @return array Array of post types supporting view mode, without this type.
152	*/
153	public function disable_view_mode( $post_types ): array {
154	unset( $post_types[ $this->list_table_type ] );
155
156	return $post_types;
157	}
158
159	/**
160	* Render any custom filters and search inputs for the list table.
161	*
162	* @return void
163	*/
164	protected function render_filters(): void {}
165
166	/**
167	* See if we should render search filters or not.
168	*
169	* @return void
170	*/
171	public function restrict_manage_posts(): void {
172	global $typenow;
173
174	if ( $this->list_table_type === $typenow ) {
175	$this->render_filters();
176	}
177	}
178
179	/**
180	* Handle any filters.
181	*
182	* @param array $query_vars Query vars.
183	*
184	* @return array
185	*/
186	public function request_query( $query_vars ): array {
187	global $typenow;
188
189	if ( $this->list_table_type === $typenow ) {
190	return $this->query_filters( $query_vars );
191	}
192
193	return $query_vars;
194	}
195
196	/**
197	* Handle any custom filters.
198	*
199	* @param array $query_vars Query vars.
200	*
201	* @return array
202	*/
203	protected function query_filters( $query_vars ): array {
204	return $query_vars;
205	}
206
207	/**
208	* Check if all filters are applied.
209	*
210	* @return bool
211	*/
212	protected function is_all_filters_applied(): bool {
213	return count(
214	array_diff_key(
215	$_GET, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
216	[
217	'post_type' => $this->list_table_type,
218	'orderby' => '',
219	'order' => '',
220	'paged' => '',
221	'mode' => '',
222	]
223	)
224	) === 0;
225	}
226	}
227