code-snippets / php / Admin / Menus / Manage / Manage_Menu.php

Manage_Menu.php in Code Snippets 3.10.1, at php/Admin/Menus/Manage/Manage_Menu.php

244 lines 6.4 KB

Raw Download Zip

1	<?php
2
3	namespace Code_Snippets\Admin\Menus\Manage;
4
5	use Code_Snippets\Admin\Contextual_Help;
6	use Code_Snippets\Admin\Menus\Admin_Menu;
7	use Code_Snippets\Controller\Cloud_Search_Controller;
8	use function Code_Snippets\code_snippets;
9	use function Code_Snippets\Settings\get_setting;
10	use const Code_Snippets\PLUGIN_FILE;
11	use const Code_Snippets\PLUGIN_VERSION;
12
13	/**
14	* Provides the manage snippets admin menu.
15	*/
16	class Manage_Menu extends Admin_Menu {
17
18	/**
19	* Default number of snippets shown per page in the manage table.
20	*/
21	private const DEFAULT_SNIPPETS_PER_PAGE = 100;
22
23	/**
24	* Manage menu Screen Options.
25	*
26	* @var Manage_Menu_Screen_Options
27	*/
28	private Manage_Menu_Screen_Options $screen_options;
29
30	/**
31	* Class constructor.
32	*/
33	public function __construct() {
34	parent::__construct(
35	'manage',
36	_x( 'All Snippets', 'menu label', 'code-snippets' ),
37	__( 'Snippets', 'code-snippets' )
38	);
39
40	if ( code_snippets()->is_compact_menu() ) {
41	add_action( 'admin_menu', array( $this, 'register_compact_menu' ), 2 );
42	add_action( 'network_admin_menu', array( $this, 'register_compact_menu' ), 2 );
43	}
44
45	$this->screen_options = new Manage_Menu_Screen_Options();
46	new Manage_Menu_Bulk_Download();
47
48	add_action( 'admin_menu', array( $this, 'register_upgrade_menu' ), 500 );
49	add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_menu_css' ) );
50	add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_menu_css' ] );
51	}
52
53	/**
54	* Register the top-level 'Snippets' menu and associated 'Manage' subpage
55	*/
56	public function register() {
57	add_menu_page(
58	__( 'Snippets', 'code-snippets' ),
59	_x( 'Snippets', 'top-level menu label', 'code-snippets' ),
60	code_snippets()->get_cap(),
61	code_snippets()->get_menu_slug(),
62	[ $this, 'render' ],
63	'none', // Added through CSS as a mask to prevent loading 'blinking'.
64	apply_filters( 'code_snippets/admin/menu_position', is_network_admin() ? 21 : 67 )
65	);
66
67	parent::register();
68	}
69
70	/**
71	* Render the snippets table interface.
72	*
73	* @return void
74	*/
75	public function render() {
76	echo '<div id="manage-snippets-container" class="wrap"></div>';
77	}
78
79	/**
80	* Register the 'upgrade' menu item.
81	*
82	* @return void
83	*/
84	public function register_upgrade_menu() {
85	if ( code_snippets()->licensing->is_licensed() \|\| get_setting( 'general', 'hide_upgrade_menu' ) ) {
86	return;
87	}
88
89	$menu_title = sprintf(
90	'<span class="button button-primary code-snippets-upgrade-button">%s %s</span>',
91	_x( 'Go Pro', 'top-level menu label', 'code-snippets' ),
92	'<span class="dashicons dashicons-external" aria-hidden="true"></span>'
93	);
94
95	$hook = add_submenu_page(
96	code_snippets()->get_menu_slug(),
97	__( 'Upgrade to Pro', 'code-snippets' ),
98	$menu_title,
99	code_snippets()->get_cap(),
100	'code_snippets_upgrade',
101	'__return_empty_string',
102	100
103	);
104
105	add_action( "load-$hook", [ $this, 'load_upgrade_menu' ] );
106	}
107
108	/**
109	* Print CSS required for the admin menu icon.
110	*
111	* @return void
112	*/
113	public function enqueue_menu_css() {
114	wp_enqueue_style(
115	'code-snippets-menu',
116	plugins_url( 'dist/menu.css', PLUGIN_FILE ),
117	[],
118	PLUGIN_VERSION
119	);
120	}
121
122	/**
123	* Redirect the user upon opening the upgrade menu.
124	*
125	* @return void
126	*/
127	public function load_upgrade_menu() {
128	wp_safe_redirect( 'https://snipco.de/JE2f' );
129	exit;
130	}
131
132	/**
133	* Retrieve every hookname registered by this menu, including the compact
134	* Tools submenu hookname when compact mode is active.
135	*
136	* @return string[]
137	*/
138	public function get_hooknames(): array {
139	$hooknames = parent::get_hooknames();
140
141	if ( code_snippets()->is_compact_menu() ) {
142	$hooknames[] = get_plugin_page_hookname( $this->base_slug, 'tools.php' );
143	}
144
145	return $hooknames;
146	}
147
148	/**
149	* Add menu pages for the compact menu
150	*/
151	public function register_compact_menu() {
152	if ( ! code_snippets()->is_compact_menu() ) {
153	return;
154	}
155
156	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Value is matched to known classes.
157	$sub = code_snippets()->get_menu_slug( isset( $_GET['sub'] ) ? sanitize_key( $_GET['sub'] ) : 'snippets' );
158	$classmap = [
159	'snippets' => 'manage',
160	'add-snippet' => 'edit',
161	'edit-snippet' => 'edit',
162	'import-code-snippets' => 'import',
163	'snippets-settings' => 'settings',
164	];
165	$menus = code_snippets()->admin->menus;
166	$class = isset( $classmap[ $sub ], $menus[ $classmap[ $sub ] ] ) ? $menus[ $classmap[ $sub ] ] : $this;
167
168	$hook = add_submenu_page(
169	'tools.php',
170	__( 'Snippets', 'code-snippets' ),
171	_x( 'Snippets', 'tools submenu label', 'code-snippets' ),
172	code_snippets()->get_cap(),
173	code_snippets()->get_menu_slug(),
174	[ $class, 'render' ]
175	);
176
177	add_action( 'load-' . $hook, [ $class, 'load' ] );
178	}
179
180	/**
181	* Executed when the admin page is loaded.
182	*/
183	public function load() {
184	parent::load();
185
186	$this->screen_options->load();
187
188	if ( $this->screen_options->is_upsell_view() ) {
189	return;
190	}
191
192	$contextual_help = new Contextual_Help( 'edit' );
193	$contextual_help->load();
194	}
195
196	/**
197	* Enqueue scripts and stylesheets for the admin page.
198	*/
199	public function enqueue_assets() {
200	$assets = new Manage_Menu_Assets( $this->screen_options );
201	$assets->enqueue( self::$script_deps, self::$style_deps );
202	}
203
204	/**
205	* Get the number of snippets to show per page in the cloud search.
206	*
207	* The value defaults to the user's local snippets-per-page preference but can
208	* be overridden independently via the `code_snippets/cloud_search/per_page` filter.
209	* The result is clamped to the REST API's per_page maximum of 100.
210	*
211	* @return int
212	*/
213	public static function get_cloud_search_per_page(): int {
214	$per_page = intval( apply_filters( 'code_snippets/cloud_search/per_page', self::get_snippets_per_page() ) );
215	return min( Cloud_Search_Controller::MAX_RESULTS_PER_PAGE, max( 1, $per_page ) );
216	}
217
218	/**
219	* Get the default number of snippets to show per page.
220	*
221	* @return int
222	*/
223	public static function get_default_snippets_per_page(): int {
224	$default = apply_filters( 'code_snippets/snippets_per_page_default', self::DEFAULT_SNIPPETS_PER_PAGE );
225	return max( 1, intval( $default ) );
226	}
227
228	/**
229	* Get the number of snippets to show per page.
230	*
231	* @return int
232	*/
233	public static function get_snippets_per_page(): int {
234	$per_page = intval( get_user_option( 'snippets_per_page' ) );
235
236	return intval(
237	apply_filters(
238	'snippets_per_page',
239	$per_page > 0 ? $per_page : self::get_default_snippets_per_page()
240	)
241	);
242	}
243	}
244