tablepress / views / view-options.php

view-options.php in TablePress – Tables in WordPress made easy 2.2, at views/view-options.php

236 lines 10.4 KB

Raw Download Zip

1	<?php
2	/**
3	* Plugin Options View
4	*
5	* @package TablePress
6	* @subpackage Views
7	* @author Tobias Bäthge
8	* @since 1.0.0
9	*/
10
11	// Prohibit direct script loading.
12	defined( 'ABSPATH' ) \|\| die( 'No direct script access allowed!' );
13
14	/**
15	* Plugin Options View class
16	*
17	* @package TablePress
18	* @subpackage Views
19	* @author Tobias Bäthge
20	* @since 1.0.0
21	*/
22	class TablePress_Options_View extends TablePress_View {
23
24	/**
25	* Set up the view with data and do things that are specific for this view.
26	*
27	* @since 1.0.0
28	*
29	* @param string $action Action for this view.
30	* @param array<string, mixed> $data Data for this view.
31	*/
32	public function setup( /* string / $action, array $data ) / : void */ {
33	// Don't use type hints in the method declaration to prevent PHP errors, as the method is inherited.
34
35	parent::setup( $action, $data );
36
37	$this->admin_page->enqueue_script( 'options' );
38
39	$this->process_action_messages( array(
40	'success_save' => __( 'Options saved successfully.', 'tablepress' ),
41	'success_save_error_custom_css' => __( 'Options saved successfully, but “Custom CSS” was not saved to file.', 'tablepress' ),
42	'error_save' => __( 'Error: Options could not be saved.', 'tablepress' ),
43	) );
44
45	$this->add_text_box( 'head', array( $this, 'textbox_head' ), 'normal' );
46	if ( current_user_can( 'tablepress_edit_options' ) ) {
47	// Enqueue WordPress copy of CodeMirror, with CSS linting, etc., for the "Custom CSS" textarea, which is only shown to admins.
48	$codemirror_settings = wp_enqueue_code_editor( array( 'type' => 'text/css' ) );
49	if ( ! empty( $codemirror_settings ) ) {
50	// Load CSS adjustments for CodeMirror and the added vertical resizing.
51	$this->admin_page->enqueue_style( 'codemirror', array( 'code-editor' ) );
52	$this->admin_page->enqueue_script( 'codemirror' );
53	}
54
55	$this->add_meta_box( 'default-style', sprintf( __( 'Default Styling %s', 'tablepress' ), '<span class="beta-label">' . ( tb_tp_fs()->is_free_plan() ? __( 'Premium', 'tablepress' ) : __( 'beta', 'tablepress' ) ) . '</span>' ), array( $this, 'postbox_default_style_customizer_screen' ), 'normal' );
56	$this->add_meta_box( 'frontend-options', __( 'Custom Styling', 'tablepress' ), array( $this, 'postbox_frontend_options' ), 'normal' );
57	}
58	$this->add_meta_box( 'user-options', __( 'User Options', 'tablepress' ), array( $this, 'postbox_user_options' ), 'normal' );
59	$this->add_text_box( 'submit', array( $this, 'textbox_submit_button' ), 'submit' );
60	if ( current_user_can( 'deactivate_plugin', TABLEPRESS_BASENAME ) && current_user_can( 'tablepress_edit_options' ) && current_user_can( 'tablepress_delete_tables' ) && ! is_plugin_active_for_network( TABLEPRESS_BASENAME ) ) {
61	$this->add_text_box( 'uninstall-tablepress', array( $this, 'textbox_uninstall_tablepress' ), 'submit' );
62	}
63	}
64
65	/**
66	* Prints the screen head text.
67	*
68	* @since 1.0.0
69	*
70	* @param array<string, mixed> $data Data for this screen.
71	* @param array<string, mixed> $box Information about the text box.
72	*/
73	public function textbox_head( array $data, array $box ): void {
74	?>
75	<p>
76	<?php _e( 'TablePress has some options which affect the plugin’s behavior in different areas.', 'tablepress' ); ?>
77	</p>
78	<?php
79	}
80
81	/**
82	* Prints the content of the "Default Style Customizer Screen" post meta box.
83	*
84	* @since 2.2.0
85	*
86	* @param array<string, mixed> $data Data for this screen.
87	* @param array<string, mixed> $box Information about the meta box.
88	*/
89	public function postbox_default_style_customizer_screen( array $data, array $box ): void {
90	if ( tb_tp_fs()->is_free_plan() ) :
91	?>
92	<div style="display:flex;max-width:800px;gap:20px;font-size:14px;">
93	<div>
94	<p style="font-size:14px;">
95	<strong><?php _e( 'Did you know?', 'tablepress' ); ?></strong>
96	<?php _e( 'The TablePress premium versions come with a table default style customizer!', 'tablepress' ); ?>
97	<?php _e( 'Choose from multiple style variations or define your own color scheme in an easy-to-use visual tool!', 'tablepress' ); ?>
98	<strong><?php _e( 'Change your tables’ default style without touching CSS code!', 'tablepress' ); ?></strong>
99	</p>
100	<div class="buttons" style="text-align:center;">
101	<a href="https://tablepress.org/modules/default-style-customizer/?utm_source=plugin&utm_medium=textlink&utm_content=options-screen" class="tablepress-button">
102	<span><?php _e( 'Find out more', 'tablepress' ); ?></span>
103	<span class="dashicons dashicons-arrow-right-alt"></span>
104	</a>
105	</div>
106	</div>
107	<a href="https://tablepress.org/modules/default-style-customizer/?utm_source=plugin&utm_medium=textlink&utm_content=options-screen"><img src="<?php echo esc_url( plugins_url( 'admin/img/default-style-customizer.png', TABLEPRESS__FILE__ ) ); ?>" width="305" height="172" alt="<?php esc_attr_e( 'Screenshot of the Default Style Customizer that is part of the TablePress premium versions.', 'tablepress' ); ?>" /></a>
108	</div>
109	<?php
110	endif;
111	}
112
113	/**
114	* Prints the content of the "Frontend Options" post meta box.
115	*
116	* @since 1.0.0
117	*
118	* @param array<string, mixed> $data Data for this screen.
119	* @param array<string, mixed> $box Information about the meta box.
120	*/
121	public function postbox_frontend_options( array $data, array $box ): void {
122	?>
123	<table class="tablepress-postbox-table fixed">
124	<tr>
125	<th class="column-1" scope="row"><label for="option-custom-css"><?php _e( 'Custom CSS', 'tablepress' ); ?></label>:</th>
126	<td class="column-2"><label for="option-use-custom-css"><input type="checkbox" id="option-use-custom-css" name="options[use_custom_css]" value="true"<?php checked( $data['frontend_options']['use_custom_css'] ); ?> /> <?php _e( 'Load this “Custom CSS” code to change the table styling:', 'tablepress' ); ?></label>
127	</td>
128	</tr>
129	<tr>
130	<td class="column-1"></td>
131	<td class="column-2">
132	<textarea name="options[custom_css]" id="option-custom-css" class="large-text" rows="8" autocomplete="off"><?php echo esc_textarea( $data['frontend_options']['custom_css'] ); ?></textarea>
133	<p class="description">
134	<?php
135	printf( __( '“Custom CSS” (<a href="%s">Cascading Style Sheets</a>) can be used to change the styling or layout of a table.', 'tablepress' ), 'https://www.htmldog.com/guides/css/beginner/' );
136	echo ' ';
137	printf( __( 'You can get styling examples from the <a href="%s">FAQ</a>.', 'tablepress' ), 'https://tablepress.org/faq/' );
138	echo ' ';
139	printf( __( 'Information on available CSS selectors can be found in the <a href="%s">Documentation</a>.', 'tablepress' ), 'https://tablepress.org/documentation/' );
140	echo ' ';
141	_e( 'Please note that invalid CSS code will be stripped, if it can not be corrected automatically.', 'tablepress' );
142	?>
143	</p>
144	</td>
145	</tr>
146	</table>
147	<?php
148	}
149
150	/**
151	* Prints the content of the "User Options" post meta box.
152	*
153	* @since 1.0.0
154	*
155	* @param array<string, mixed> $data Data for this screen.
156	* @param array<string, mixed> $box Information about the meta box.
157	*/
158	public function postbox_user_options( array $data, array $box ): void {
159	// Get list of current admin menu entries.
160	$entries = array();
161	foreach ( $GLOBALS['menu'] as $entry ) {
162	if ( str_contains( $entry[2], '.php' ) ) {
163	$entries[ $entry[2] ] = $entry[0];
164	}
165	}
166
167	// Remove <span> elements with notification bubbles (e.g. update or comment count).
168	if ( isset( $entries['plugins.php'] ) ) {
169	$entries['plugins.php'] = preg_replace( '/ <span.*span>/', '', $entries['plugins.php'] );
170	}
171	if ( isset( $entries['edit-comments.php'] ) ) {
172	$entries['edit-comments.php'] = preg_replace( '/ <span.*span>/', '', $entries['edit-comments.php'] );
173	}
174
175	// Add separator and generic positions.
176	$entries['-'] = '---';
177	$entries['top'] = __( 'Top-Level (top)', 'tablepress' );
178	$entries['middle'] = __( 'Top-Level (middle)', 'tablepress' );
179	$entries['bottom'] = __( 'Top-Level (bottom)', 'tablepress' );
180
181	$select_box = '<select id="option-admin-menu-parent-page" name="options[admin_menu_parent_page]">' . "\n";
182	foreach ( $entries as $page => $entry ) {
183	$select_box .= '<option' . selected( $page, $data['user_options']['parent_page'], false ) . disabled( $page, '-', false ) . ' value="' . $page . '">' . $entry . "</option>\n";
184	}
185	$select_box .= "</select>\n";
186	?>
187	<table class="tablepress-postbox-table fixed">
188	<tr>
189	<th class="column-1" scope="row"><label for="option-admin-menu-parent-page"><?php _e( 'Admin menu entry', 'tablepress' ); ?>:</label></th>
190	<td class="column-2"><?php printf( __( 'TablePress shall be shown in this section of my admin menu: %s', 'tablepress' ), $select_box ); ?></td>
191	</tr>
192	</table>
193	<?php
194	}
195
196	/**
197	* Prints "Save Changes" button.
198	*
199	* @since 2.2.0
200	*
201	* @param array<string, mixed> $data Data for this screen.
202	* @param array<string, mixed> $box Information about the text box.
203	*/
204	public function textbox_submit_button( array $data, array $box ): void {
205	?>
206	<p class="submit">
207	<input type="submit" id="tablepress-options-save-changes" class="button button-primary button-large button-save-changes" value="<?php esc_attr_e( 'Save Changes', 'tablepress' ); ?>" data-shortcut="<?php echo esc_attr( _x( '%1$sS', 'keyboard shortcut for Save Changes', 'tablepress' ) ); ?>" />
208	</p>
209	<?php
210	}
211
212	/**
213	* Prints the content of the "Admin Options" post meta box.
214	*
215	* @since 1.0.0
216	*
217	* @param array<string, mixed> $data Data for this screen.
218	* @param array<string, mixed> $box Information about the text box.
219	*/
220	public function textbox_uninstall_tablepress( array $data, array $box ): void {
221	?>
222	<h1 style="margin-top:40px;"><?php _e( 'Uninstall TablePress', 'tablepress' ); ?></h1>
223	<p>
224	<?php
225	echo __( 'Uninstalling <strong>will permanently delete</strong> all TablePress tables and options from the database.', 'tablepress' ) . '<br />'
226	. __( 'It is recommended that you create a backup of the tables (by exporting the tables in the JSON format), in case you later change your mind.', 'tablepress' ) . '<br />'
227	. __( 'You will manually need to remove the plugin’s files from the plugin folder afterwards.', 'tablepress' ) . '<br />'
228	. __( 'Be very careful with this and only click the button if you know what you are doing!', 'tablepress' );
229	?>
230	</p>
231	<p><a href="<?php echo TablePress::url( array( 'action' => 'uninstall_tablepress' ), true, 'admin-post.php' ); ?>" id="uninstall-tablepress" class="button"><?php _e( 'Uninstall TablePress', 'tablepress' ); ?></a></p>
232	<?php
233	}
234
235	} // class TablePress_Options_View
236