abstract-shortcode-generator.php — GiveWP – Donation Plugin and Fundraising Platform 2.5.7

give / includes / admin / shortcodes / abstract-shortcode-generator.php

give / includes / admin / shortcodes Last commit date

abstract-shortcode-generator.php

469 lines

1	<?php
2	/**
3	* Shortcode Dialog Generator abstract class
4	*
5	* @package Give/Admin
6	* @author Paul Ryley
7	* @copyright Copyright (c) 2016, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @version 1.0
10	* @since 1.3
11	*/
12
13	// Exit if accessed directly.
14	if ( ! defined( 'ABSPATH' ) ) {
15	exit;
16	}
17
18	/**
19	* Class Give_Shortcode_Generator
20	*/
21	abstract class Give_Shortcode_Generator {
22
23	/**
24	* The current class name
25	*
26	* @since 1.0
27	*/
28	public $self;
29
30	/**
31	* The current shortcode
32	*
33	* @since 1.0
34	*/
35	public $shortcode;
36
37	/**
38	* The current shortcode tag
39	*
40	* @since 1.0
41	*/
42	public $shortcode_tag;
43
44	/**
45	* Shortcode field errors
46	*
47	* @since 1.0
48	*/
49	protected $errors;
50
51	/**
52	* Required shortcode fields
53	*
54	* @since 1.0
55	*/
56	protected $required;
57
58	/**
59	* Class constructor
60	*
61	* @param string $shortcode The shortcode tag
62	*
63	* @since 1.0
64	*/
65	public function __construct( $shortcode ) {
66
67	$this->shortcode_tag = $shortcode;
68
69	add_action( 'admin_init', array( $this, 'init' ) );
70
71	}
72
73	/**
74	* Kick things off for the shortcode generator
75	*
76	* @since 1.3.0.2
77	*/
78	public function init() {
79
80	if ( $this->shortcode_tag ) {
81
82	$this->self = get_class( $this );
83
84	$this->errors = array();
85	$this->required = array();
86
87	// Generate the fields, errors, and requirements
88	$fields = $this->get_fields();
89
90	$defaults = array(
91	'btn_close' => esc_html__( 'Close', 'give' ),
92	'btn_okay' => esc_html__( 'Insert Shortcode', 'give' ),
93	'errors' => $this->errors,
94	'fields' => $fields,
95	'label' => '[' . $this->shortcode_tag . ']',
96	'required' => $this->required,
97	'title' => esc_html__( 'Insert Shortcode', 'give' ),
98	);
99
100	if ( user_can_richedit() ) {
101
102	Give_Shortcode_Button::$shortcodes[ $this->shortcode_tag ] = wp_parse_args( $this->shortcode, $defaults );
103
104	}
105	}
106
107	}
108
109
110	/**
111	* Define the shortcode attribute fields
112	*
113	* @return false\|array
114	*
115	* @since 1.0
116	*/
117	public function define_fields() {
118
119	return false;
120	}
121
122	/**
123	* Generate the shortcode dialog fields
124	*
125	* @param array $defined_fields
126	*
127	* @return array
128	*
129	* @since 1.0
130	*/
131	protected function generate_fields( $defined_fields ) {
132
133	$fields = array();
134
135	if ( is_array( $defined_fields ) ) {
136
137	foreach ( $defined_fields as $field ) {
138
139	$defaults = array(
140	'label' => false,
141	'name' => false,
142	'options' => array(),
143	'placeholder' => false,
144	'tooltip' => false,
145	'type' => '',
146	);
147
148	$field = wp_parse_args( (array) $field, $defaults );
149	$method = 'generate_' . strtolower( $field['type'] );
150
151	if ( method_exists( $this, $method ) ) {
152
153	$field = call_user_func( array( $this, $method ), $field );
154
155	if ( $field ) {
156	$fields[] = $field;
157	}
158	}
159	}
160	}
161
162	return $fields;
163	}
164
165	/**
166	* Get the generated shortcode dialog fields
167	*
168	* @return array
169	*
170	* @since 1.0
171	*/
172	protected function get_fields() {
173
174	$defined_fields = $this->define_fields();
175	$generated_fields = $this->generate_fields( $defined_fields );
176
177	$errors = array();
178
179	if ( ! empty( $this->errors ) ) {
180	foreach ( $this->required as $name => $alert ) {
181	// Using WordPress function in place of array_column wp_list_pluck as it support older version as well.
182	if ( false === array_search( $name, give_list_pluck( $generated_fields, 'name' ) ) ) {
183
184	$errors[] = $this->errors[ $name ];
185	}
186	}
187
188	$this->errors = $errors;
189	}
190
191	if ( ! empty( $errors ) ) {
192
193	return $errors;
194	}
195
196	return $generated_fields;
197	}
198
199
200	/**
201	* Generate a TinyMCE docs_link field
202	*
203	* @param $field
204	*
205	* @return array
206	*/
207	protected function generate_docs_link( $field ){
208	// Add custom style to override mce style.
209	$dashicon_style = 'width: 20px;
210	height: 20px;
211	font-size: 17px;
212	line-height: 1;
213	font-family: dashicons;
214	text-decoration: inherit;
215	font-weight: normal;
216	font-style: normal;
217	vertical-align: top;
218	text-align: center;
219	transition: color .1s ease-in 0;';
220
221	$a_style = 'color: #999;
222	text-decoration: none;
223	font-style: italic;
224	font-size: 13px;';
225
226	$p_style = 'text-align:right;';
227
228	return $this->generate_container(
229	array(
230	'type' => 'container',
231	'html' => sprintf(
232	'<p class="give-docs-link" style="%5$s"><a href="%4$s" style="%3$s" target="_blank">%1$s<span class="dashicons dashicons-editor-help" style="%2$s"></a></span></p>',
233	$field['text'],
234	$dashicon_style,
235	$a_style,
236	esc_url( $field['link'] ),
237	$p_style
238	)
239	)
240	);
241	}
242
243	/**
244	* Generate a TinyMCE container field
245	*
246	* @param array $field
247	*
248	* @return array\|false
249	*
250	* @since 1.0
251	*/
252	protected function generate_container( $field ) {
253
254	if ( array_key_exists( 'html', $field ) ) {
255
256	return array(
257	'type' => $field['type'],
258	'html' => $field['html'],
259	);
260	}
261
262	return false;
263	}
264
265	/**
266	* Generate a TinyMCE listbox field
267	*
268	* @param array $field
269	*
270	* @return array\|false
271	*
272	* @since 1.0
273	*/
274	protected function generate_listbox( $field ) {
275
276	$listbox = shortcode_atts( array(
277	'label' => '',
278	'minWidth' => '',
279	'name' => false,
280	'tooltip' => '',
281	'type' => '',
282	'value' => '',
283	'classes' => ''
284	), $field );
285
286	if ( $this->validate( $field ) ) {
287
288	$new_listbox = array();
289
290	foreach ( $listbox as $key => $value ) {
291
292	if ( $key == 'value' && empty( $value ) ) {
293	$new_listbox[ $key ] = $listbox['name'];
294	} else if ( $value ) {
295	$new_listbox[ $key ] = $value;
296	}
297	}
298
299	// do not reindex array!
300	$field['options'] = array(
301	'' => ( $field['placeholder'] ? $field['placeholder'] : esc_attr__( '- Select -', 'give' ) ),
302	) + $field['options'];
303
304	foreach ( $field['options'] as $value => $text ) {
305	$new_listbox['values'][] = array(
306	'text' => $text,
307	'value' => $value,
308	);
309	}
310
311	return $new_listbox;
312	}
313
314	return false;
315	}
316
317	/**
318	* Generate a TinyMCE listbox field for a post_type.
319	*
320	* @param array $field
321	*
322	* @return array\|false
323	*
324	* @since 1.0
325	*/
326	protected function generate_post( $field ) {
327
328	$args = array(
329	'post_type' => 'post',
330	'orderby' => 'title',
331	'order' => 'ASC',
332	'posts_per_page' => 30,
333	'suppress_filters' => false,
334	);
335
336	$args = wp_parse_args( (array) $field['query_args'], $args );
337
338	$posts = get_posts( $args );
339	$options = array();
340
341	if ( ! empty( $posts ) ) {
342	foreach ( $posts as $post ) {
343	$options[ absint( $post->ID ) ] = empty( $post->post_title )
344	? sprintf( __( 'Untitled (#%s)', 'give' ), $post->ID )
345	/** This filter is documented in wp-includes/post-template.php */
346	: apply_filters( 'the_title', $post->post_title, $post->ID );
347	}
348
349	$field['type'] = 'listbox';
350	$field['options'] = $options;
351
352	return $this->generate_listbox( $field );
353	}
354
355	// perform validation here before returning false
356	$this->validate( $field );
357
358	return false;
359	}
360
361	/**
362	* Generate a TinyMCE textbox field
363	*
364	* @param array $field
365	*
366	* @return array\|false
367	*
368	* @since 1.0
369	*/
370	protected function generate_textbox( $field ) {
371
372	$textbox = shortcode_atts( array(
373	'label' => '',
374	'maxLength' => '',
375	'minHeight' => '',
376	'minWidth' => '',
377	'multiline' => false,
378	'name' => false,
379	'tooltip' => '',
380	'type' => '',
381	'value' => '',
382	'classes' => '',
383	'placeholder' => ''
384	), $field );
385
386	// Remove empty placeholder.
387	if( empty( $textbox['placeholder'] ) ) {
388	unset( $textbox['placeholder'] );
389	}
390
391	if ( $this->validate( $field ) ) {
392	return array_filter( $textbox, array( $this, 'return_textbox_value' ) );
393	}
394
395	return false;
396	}
397
398	/**
399	* Validate Textbox Value
400	*
401	* @param $value
402	*
403	* @return bool
404	*/
405	function return_textbox_value( $value ) {
406	return $value !== '';
407	}
408
409	/**
410	* Perform validation for a single field
411	*
412	* Returns true or false depending on whether the field has a 'name' attribute.
413	* This method also populates the shortcode's $errors and $required arrays.
414	*
415	* @param array $field
416	*
417	* @return bool
418	*
419	* @since 1.0
420	*/
421	protected function validate( $field ) {
422
423	extract( shortcode_atts(
424	array(
425	'name' => false,
426	'required' => false,
427	'label' => '',
428	), $field )
429	);
430
431	if ( $name ) {
432
433	if ( isset( $required['error'] ) ) {
434
435	$error = array(
436	'type' => 'container',
437	'html' => $required['error'],
438	);
439
440	$this->errors[ $name ] = $this->generate_container( $error );
441	}
442
443	if ( ! ! $required \|\| is_array( $required ) ) {
444
445	$alert = esc_html__( 'Some of the shortcode options are required.', 'give' );
446
447	if ( isset( $required['alert'] ) ) {
448
449	$alert = $required['alert'];
450
451	} else if ( ! empty( $label ) ) {
452
453	$alert = sprintf(
454	/* translators: %s: option label */
455	esc_html__( 'The "%s" option is required.', 'give' ),
456	str_replace( ':', '', $label )
457	);
458	}
459
460	$this->required[ $name ] = $alert;
461	}
462
463	return true;
464	}
465
466	return false;
467	}
468	}
469