give / src / Route / Form.php

Form.php in GiveWP – Donation Plugin and Fundraising Platform 2.23.0, at src/Route/Form.php

221 lines 4.1 KB

Raw Download Zip

1	<?php
2
3	/**
4	* Handle Embed Donation Form Route
5	*
6	* @package Give
7	* @since 2.7.0
8	*/
9
10	namespace Give\Route;
11
12	use Give\Controller\Form as Controller;
13	use WP_Post;
14
15	defined('ABSPATH') \|\| exit;
16
17	/**
18	* Template class.
19	*
20	* @since 2.7.0
21	*/
22	class Form
23	{
24	/**
25	* Option name
26	*
27	* @since 2.7.0
28	* @var string
29	*/
30	private $optionName = 'form_page_url_prefix';
31
32	/**
33	* Route base
34	*
35	* @since 2.7.0
36	* @var string
37	*/
38	private $defaultBase = 'give';
39
40	/**
41	* Route base
42	*
43	* @since 2.7.0
44	* @var string
45	*/
46	private $base;
47
48	/**
49	* @since 2.8.0
50	* @var Controller
51	*/
52	private $controller;
53
54	/**
55	* Form constructor.
56	*
57	* @since 2.8.0
58	*
59	* @param Controller $controller
60	*/
61	public function __construct(Controller $controller)
62	{
63	$this->controller = $controller;
64	}
65
66	/**
67	* Form constructor.
68	*/
69	public function init()
70	{
71	$this->setBasePrefix();
72	$this->controller->init();
73
74	add_action('init', [$this, 'addRule']);
75	add_action('query_vars', [$this, 'addQueryVar']);
76	add_action('give-settings_save_advanced', [$this, 'updateRule'], 11);
77	}
78
79	/**
80	* Setup base prefix
81	*
82	* @since 2.7.0
83	*/
84	public function setBasePrefix()
85	{
86	$this->base = give_get_option($this->optionName, $this->defaultBase);
87	}
88
89	/**
90	* Add rewrite rule
91	*
92	* @since 2.7.0
93	*/
94	public function addRule()
95	{
96	add_rewrite_rule(
97	"{$this->base}/(.+?)/?$",
98	sprintf(
99	'index.php?url_prefix=%1$s&give_form_id=$matches[1]',
100	$this->base
101	),
102	'top'
103	);
104	}
105
106	/**
107	* Add query var
108	*
109	* @since 2.7.0
110	*
111	* @param array $queryVars
112	*
113	* @return array
114	*/
115	public function addQueryVar($queryVars)
116	{
117	$queryVars[] = 'give_form_id';
118	$queryVars[] = 'url_prefix';
119
120	return $queryVars;
121	}
122
123	/**
124	* Get form URL.
125	*
126	* @since 2.7.0
127	* @since 2.8.0 Add support for all permalink settings.
128	* @since 2.8.0 Specify URL scheme to avoid mixed content when loaded in the admin.
129	*
130	* @param int $form_id
131	*
132	* @return string
133	*/
134	public function getURL($form_id)
135	{
136	$scheme = (is_ssl()) ? 'https' : 'http';
137
138	return get_option('permalink_structure')
139	? home_url("/{$this->base}/{$form_id}", $scheme)
140	: esc_url(add_query_arg(
141	[
142	'give_form_id' => $form_id,
143	'url_prefix' => $this->base,
144	],
145	home_url('', $scheme)
146	));
147	}
148
149	/**
150	* Get url base.
151	*
152	* @since 2.7.0
153	* @return string
154	*/
155	public function getBase()
156	{
157	return $this->base;
158	}
159
160	/**
161	* Get url base.
162	*
163	* @since 2.7.0
164	* @return string
165	*/
166	public function getOptionName()
167	{
168	return $this->optionName;
169	}
170
171	/**
172	* Update route rule
173	*
174	* @since 2.7.0
175	*/
176	public function updateRule()
177	{
178	global $wp_rewrite;
179
180	$updateBase = give_get_option($this->optionName, $this->defaultBase);
181
182	if ($updateBase !== $this->base) {
183	$this->base = $updateBase;
184
185	// Save rewrite rule manually.
186	$this->addRule();
187	flush_rewrite_rules();
188	$wp_rewrite->wp_rewrite_rules();
189	}
190	}
191
192	/**
193	* Get queried form ID.
194	*
195	* @since 2.7.0
196	* @return int
197	*/
198	public function getQueriedFormID()
199	{
200	$formId = 0;
201
202	if ($queryVar = get_query_var('give_form_id')) {
203	$form = current(
204	get_posts(
205	[
206	'name' => $queryVar,
207	'numberposts' => 1,
208	'post_type' => 'give_forms',
209	]
210	)
211	);
212
213	if ($form instanceof WP_Post) {
214	$formId = $form->ID;
215	}
216	}
217
218	return $formId;
219	}
220	}
221