give / blocks / donation-form-grid / class-give-donation-form-grid-block.php

class-give-donation-form-grid-block.php in GiveWP – Donation Plugin and Fundraising Platform 4.18.0, at blocks/donation-form-grid/class-give-donation-form-grid-block.php

308 lines 8.4 KB

Raw Download Zip

1	<?php
2	/**
3	* Give Donation Grid Block Class
4	*
5	* @package Give
6	* @subpackage Classes/Blocks
7	* @copyright Copyright (c) 2019, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 2.0.2
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17	/**
18	* Give_Donation_Form_Grid_Block Class.
19	*
20	* This class handles donation forms block.
21	*
22	* @since 2.0.2
23	*/
24	class Give_Donation_Form_Grid_Block {
25	/**
26	* Instance.
27	*
28	* @since
29	* @access private
30	* @var Give_Donation_Form_Grid_Block
31	*/
32	private static $instance;
33
34	/**
35	* Singleton pattern.
36	*
37	* @since
38	* @access private
39	*/
40	private function __construct() {
41	}
42
43
44	/**
45	* Get instance.
46	*
47	* @since
48	* @access public
49	* @return Give_Donation_Form_Grid_Block
50	*/
51	public static function get_instance() {
52	if ( null === static::$instance ) {
53	self::$instance = new static();
54
55	self::$instance->init();
56	}
57
58	return self::$instance;
59	}
60
61	/**
62	* Class Constructor
63	*
64	* Set up the Give Donation Grid Block class.
65	*
66	* @since 2.0.2
67	* @access private
68	*/
69	private function init() {
70	add_action( 'init', array( $this, 'register_block' ), 999 );
71	}
72
73	/**
74	* Register block
75	*
76	* @access public
77	*/
78	public function register_block() {
79	// Bailout.
80	if ( ! function_exists( 'register_block_type' ) ) {
81	return;
82	}
83
84	// Register block.
85	register_block_type(
86	'give/donation-form-grid',
87	array(
88	'render_callback' => array( $this, 'render_block' ),
89	'attributes' => array(
90	'formsPerPage' => array(
91	'type' => 'string',
92	'default' => '12',
93	),
94	'formIDs' => array(
95	'type' => 'array',
96	'default' => [],
97	),
98	'excludeForms' => array(
99	'type' => 'boolean',
100	'default' => false,
101	),
102	'excludedFormIDs' => array(
103	'type' => 'array',
104	'default' => [],
105	),
106	'orderBy' => array(
107	'type' => 'string',
108	'default' => 'date',
109	),
110	'order' => array(
111	'type' => 'string',
112	'default' => 'DESC',
113	),
114	'categories' => array(
115	'type' => 'array',
116	'default' => [],
117	),
118	'tags' => array(
119	'type' => 'array',
120	'default' => [],
121	),
122	'columns' => array(
123	'type' => 'string',
124	'default' => '1',
125	),
126	'imageSize' => array(
127	'type' => 'string',
128	'default' => 'medium',
129	),
130	'imageHeight' => array(
131	'type' => 'string',
132	'default' => 'auto',
133	),
134	'showTitle' => array(
135	'type' => 'boolean',
136	'default' => true,
137	),
138	'showExcerpt' => array(
139	'type' => 'boolean',
140	'default' => true,
141	),
142	'excerptLength' => array(
143	'type' => 'integer',
144	'default' => 16,
145	),
146	'showGoal' => array(
147	'type' => 'boolean',
148	'default' => true,
149	),
150	'showProgressBar' => array(
151	'type' => 'boolean',
152	'default' => true,
153	),
154	'showFeaturedImage' => array(
155	'type' => 'boolean',
156	'default' => true,
157	),
158	'showDonateButton' => array(
159	'type' => 'boolean',
160	'default' => true,
161	),
162	'tagBackgroundColor' => array(
163	'type' => 'string',
164	'default' => '#69b86b',
165	),
166	'tagTextColor' => array(
167	'type' => 'string',
168	'default' => '#ffffff',
169	),
170	'donateButtonTextColor' => array(
171	'type' => 'string',
172	'default' => '#69b86b',
173	),
174	'displayType' => array(
175	'type' => 'string',
176	'default' => 'redirect',
177	),
178	'paged' => array(
179	'type' => 'boolean',
180	'default' => true,
181	),
182	'filterOptions' => array(
183	'type' => 'string',
184	'default' => 'tags',
185	),
186	'imageHeightOptions' => array(
187	'type' => 'string',
188	'default' => 'auto',
189	),
190	'progressBarColor' => array(
191	'type' => 'string',
192	'default' => '#69b86b'
193	)
194	),
195	)
196	);
197	}
198
199	/**
200	* Block render callback
201	*
202	* @since 3.1.0 Use static function on array_map callback to pass the id as reference for _give_redirect_form_id to prevent warnings on PHP 8.0.1 or plus
203	*
204	* @param array $attributes Block parameters.
205	*
206	* @access public
207	* @return string;
208	*/
209	public function render_block( $attributes ) {
210	$parameters = array(
211	'forms_per_page' => absint( $attributes['formsPerPage'] ),
212	'ids' => implode(',',
213	array_map(
214	static function ($id) {
215	_give_redirect_form_id($id);
216
217	return $id;
218	},
219	$this->getAsArray($attributes['formIDs'])
220	)
221	),
222	'exclude' => implode(',', $this->getAsArray($attributes['excludedFormIDs'] ) ),
223	'orderby' => $attributes['orderBy'],
224	'order' => $attributes['order'],
225	'cats' => implode(',', $this->getAsArray($attributes['categories'] ) ),
226	'tags' => implode(',', $this->getAsArray($attributes['tags'] ) ),
227	'columns' => $attributes['columns'],
228	'show_title' => $attributes['showTitle'],
229	'show_goal' => $attributes['showGoal'],
230	'show_excerpt' => $attributes['showExcerpt'],
231	'excerpt_length' => $attributes['excerptLength'],
232	'show_featured_image' => $attributes['showFeaturedImage'],
233	'show_donate_button' => $attributes['showDonateButton'],
234	'tag_background_color' => $attributes['tagBackgroundColor'],
235	'tag_text_color' => $attributes['tagTextColor'],
236	'donate_button_text_color' => $attributes['donateButtonTextColor'],
237	'display_style' => $attributes['displayType'],
238	'paged' => $attributes['paged'],
239	'image_size' => $attributes['imageSize'],
240	'image_height' => $attributes['imageHeight'],
241	'image_height_options' => $attributes['imageHeightOptions'],
242	'progress_bar_color' => $attributes['progressBarColor']
243	);
244
245	$html = give_form_grid_shortcode( $parameters );
246	$html = ! empty( $html ) ? $html : $this->blank_slate();
247
248	return $html;
249	}
250
251	/**
252	* @since 2.25.0
253	*
254	* @param string\|array $value
255	* @return array
256	*/
257	private function getAsArray($value) {
258	if ( is_array($value) ) {
259	return $value;
260	}
261
262	// Backward compatibility
263	if (strpos($value, ',')) {
264	return explode(',', $value);
265	}
266
267	return [$value];
268	}
269
270	/**
271	* Return formatted notice when shortcode return empty string
272	*
273	* @since 4.0.0 Replace "new form" with "new campaign form" link
274	* @since 2.4.0
275	*
276	* @return string
277	*/
278	private function blank_slate() {
279	if ( ! defined( 'REST_REQUEST' ) ) {
280	return '';
281	}
282
283	ob_start();
284
285	$content = array(
286	'image_url' => GIVE_PLUGIN_URL . 'build/assets/dist/images/give-icon-full-circle.svg',
287	'image_alt' => __( 'Give Icon', 'give' ),
288	'heading' => __('No campaign forms found.', 'give'),
289	'message' => __('The first step towards accepting online donations is to create a campaign.',
290	'give'),
291	'cta_text' => __('Create Campaign Form', 'give'),
292	'cta_link' => admin_url('edit.php?post_type=give_forms&page=give-campaigns&new=campaign'),
293	'help' => sprintf(
294	/* translators: 1: Opening anchor tag. 2: Closing anchor tag. */
295	__( 'Need help? Get started with %1$sGive 101%2$s.', 'give' ),
296	'<a href="http://docs.givewp.com/give101/" target="_blank">',
297	'</a>'
298	),
299	);
300
301	include_once GIVE_PLUGIN_DIR . 'includes/admin/views/blank-slate.php';
302
303	return ob_get_clean();
304	}
305	}
306
307	Give_Donation_Form_Grid_Block::get_instance();
308