Screen.php — Admin Columns 4.5.5

codepress-admin-columns / classes / Screen.php

codepress-admin-columns / classes Last commit date

Screen.php

158 lines

1	<?php
2
3	namespace AC;
4
5	use AC\Admin\Page\Columns;
6	use AC\Admin\RequestHandlerInterface;
7	use WP_Screen;
8
9	class Screen implements Registrable {
10
11	/**
12	* @var WP_Screen
13	*/
14	protected $screen;
15
16	public function register() {
17	add_action( 'current_screen', [ $this, 'init' ] );
18	}
19
20	/**
21	* @param WP_Screen $screen
22	*/
23	public function init( WP_Screen $screen ) {
24	$this->set_screen( $screen );
25
26	do_action( 'ac/screen', $this, $this->screen->id );
27	}
28
29	/**
30	* @param $id
31	*
32	* @return bool
33	*/
34	public function is_screen( $id ) {
35	return $this->has_screen() && $this->get_screen()->id === $id;
36	}
37
38	/**
39	* @param WP_Screen $screen
40	*
41	* @return $this
42	*/
43	public function set_screen( WP_Screen $screen ) {
44	$this->screen = $screen;
45
46	return $this;
47	}
48
49	/**
50	* @return WP_Screen
51	*/
52	public function get_screen() {
53	return $this->screen;
54	}
55
56	/**
57	* @return bool
58	*/
59	public function has_screen() {
60	return $this->screen instanceof WP_Screen;
61	}
62
63	/**
64	* @return string
65	*/
66	public function get_id() {
67	return $this->screen->id;
68	}
69
70	/**
71	* @return string
72	*/
73	public function get_base() {
74	return $this->screen->base;
75	}
76
77	/**
78	* @return string
79	*/
80	public function get_post_type() {
81	return $this->screen->post_type;
82	}
83
84	/**
85	* @return string\|null
86	*/
87	public function get_list_screen() {
88	foreach ( ListScreenTypes::instance()->get_list_screens() as $list_screen ) {
89	if ( $list_screen->is_current_screen( $this->screen ) ) {
90	return $list_screen->get_key();
91	}
92	}
93
94	return null;
95	}
96
97	/**
98	* @return bool
99	*/
100	private function is_admin_network() {
101	return $this->screen->in_admin( 'network' );
102	}
103
104	/**
105	* @return bool
106	*/
107	public function is_list_screen() {
108	return null !== $this->get_list_screen();
109	}
110
111	/**
112	* Check if current screen is plugins screen
113	* @return bool
114	*/
115	public function is_plugin_screen() {
116	$id = 'plugins';
117
118	if ( $this->is_admin_network() ) {
119	$id .= '-network';
120	}
121
122	return $this->is_screen( $id );
123	}
124
125	/**
126	* @param string\|null $slug
127	*
128	* @return bool
129	*/
130	public function is_admin_screen( $slug = null ) {
131	if ( null !== $slug ) {
132	$tabs = [ $slug ];
133
134	// When the column page is requested from the setting menu the 'tab' querystring is not set.
135	if ( Columns::NAME === $slug ) {
136	$tabs[] = null;
137	}
138
139	return $this->is_main_admin_screen() && in_array( filter_input( INPUT_GET, RequestHandlerInterface::PARAM_TAB ), $tabs, true );
140	}
141
142	return $this->is_main_admin_screen();
143	}
144
145	/**
146	* @return bool
147	*/
148	private function is_main_admin_screen() {
149	$id = 'settings_page_' . Admin\Admin::NAME;
150
151	if ( $this->is_admin_network() ) {
152	$id .= '-network';
153	}
154
155	return $this->is_screen( $id );
156	}
157
158	}