give / includes / admin / emails / class-email-access-email.php

class-email-access-email.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at includes/admin/emails/class-email-access-email.php

334 lines 8.5 KB

Raw Download Zip

1	<?php
2	/**
3	* Email access notification
4	*
5	* @package Give
6	* @subpackage Classes/Emails
7	* @copyright Copyright (c) 2016, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 2.0
10	*/
11
12	// Exit if access directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17	if ( ! class_exists( 'Give_Email_Access_Email' ) ) :
18
19	/**
20	* Give_Email_Access_Email
21	*
22	* @abstract
23	* @since 2.0
24	*/
25	class Give_Email_Access_Email extends Give_Email_Notification {
26	/**
27	* Create a class instance.
28	*
29	* @access public
30	* @since 2.0
31	*/
32	public function init() {
33	$this->load(
34	array(
35	'id' => 'email-access',
36	'label' => __( 'Email access', 'give' ),
37	'description' => __( 'Sent when donors request access to their donation history using only their email as verification. (See Settings > General > Access Control)', 'give' ),
38	'notification_status' => give_get_option( 'email_access', 'disabled' ),
39	'form_metabox_setting' => false,
40	'notification_status_editable' => false,
41	'email_tag_context' => 'donor',
42	'recipient_group_name' => __( 'Donor', 'give' ),
43	'default_email_subject' => sprintf( __( 'Please confirm your email for %s', 'give' ), get_bloginfo( 'url' ) ),
44	'default_email_message' => $this->get_default_email_message(),
45	'default_email_header' => __( 'Confirm Email', 'give' ),
46	'notices' => array(
47	'non-notification-status-editable' => sprintf(
48	'%1$s <a href="%2$s">%3$s »</a>',
49	__( 'This notification is automatically toggled based on whether the email access is enabled or not.', 'give' ),
50	esc_url( admin_url( 'edit.php?post_type=give_forms&page=give-settings&tab=general&section=access-control' ) ),
51	__( 'Edit Setting', 'give' )
52	),
53	),
54	)
55	);
56
57	add_filter( "give_{$this->config['id']}_email_notification", array( $this, 'setup_email_notification' ), 10, 2 );
58	add_action( 'give_save_settings_give_settings', array( $this, 'set_notification_status' ), 10, 2 );
59	add_filter( 'give_email_preview_header', array( $this, 'email_preview_header' ), 10, 2 );
60	}
61
62	/**
63	* Get email subject.
64	*
65	* @since 2.0
66	* @access public
67	*
68	* @param int $form_id
69	*
70	* @return string
71	*/
72	public function get_email_subject( $form_id = null ) {
73	$subject = wp_strip_all_tags(
74	Give_Email_Notification_Util::get_value(
75	$this,
76	Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_subject',
77	$form_id,
78	$this->config['default_email_subject']
79	)
80	);
81
82	/**
83	* Filters the donation notification subject.
84	* Note: This filter will deprecate soon.
85	*
86	* @since 1.0
87	*/
88	$subject = apply_filters( 'give_email_access_token_subject', $subject );
89
90	/**
91	* Filters the donation notification subject.
92	*
93	* @since 2.0
94	*/
95	$subject = apply_filters( "give_{$this->config['id']}_get_email_subject", $subject, $this, $form_id );
96
97	return $subject;
98	}
99
100
101	/**
102	* Get email attachment.
103	*
104	* @since 2.0
105	* @access public
106	*
107	* @param int $form_id
108	*
109	* @return string
110	*/
111	public function get_email_message( $form_id = null ) {
112	$message = Give_Email_Notification_Util::get_value(
113	$this,
114	Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_message',
115	$form_id,
116	$this->config['default_email_message']
117	);
118
119	/**
120	* Filter the email message
121	* Note: This filter will deprecate soon.
122	*
123	* @since 1.0
124	*/
125	$message = apply_filters( 'give_email_access_token_message', $message );
126
127	/**
128	* Filter the email message
129	*
130	* @since 2.0
131	*/
132	$message = apply_filters( "give_{$this->config['id']}_get_default_email_message", $message, $this, $form_id );
133
134	return $message;
135	}
136
137
138	/**
139	* Get email attachment.
140	*
141	* @since 2.0
142	* @access public
143	*
144	* @param int $form_id
145	* @return array
146	*/
147	public function get_email_attachments( $form_id = null ) {
148	/**
149	* Filters the donation notification email attachments.
150	* By default, there is no attachment but plugins can hook in to provide one more multiple.
151	* Note: This filter will deprecate soon.
152	*
153	* @since 1.0
154	*/
155	$attachments = apply_filters( 'give_admin_donation_notification_attachments', array() );
156
157	/**
158	* Filters the donation notification email attachments.
159	* By default, there is no attachment but plugins can hook in to provide one more multiple.
160	*
161	* @since 2.0
162	*/
163	$attachments = apply_filters( "give_{$this->config['id']}_get_email_attachments", $attachments, $this, $form_id );
164
165	return $attachments;
166	}
167
168
169	/**
170	* Get default email message.
171	*
172	* @since 2.0
173	* @access public
174	*
175	* @return string
176	*/
177	public function get_default_email_message() {
178	$message = __( 'Please click the link to access your donation history on {site_url}. If you did not request this email, please contact {admin_email}.', 'give' ) . "\n\n";
179	$message .= '{email_access_link}' . "\n\n";
180	$message .= "\n\n";
181	$message .= __( 'Sincerely,', 'give' ) . "\n";
182	$message .= get_bloginfo( 'name' ) . "\n";
183
184	/**
185	* Filter the new donation email message
186	*
187	* @since 2.0
188	*
189	* @param string $message
190	*/
191	return apply_filters( "give_{$this->config['id']}_get_default_email_message", $message, $this );
192	}
193
194
195	/**
196	* Get email header
197	*
198	* @since 2.2.1
199	* @access public
200	*
201	* @param null $form_id
202	*
203	* @return string
204	*/
205	public function get_email_header( $form_id = null ) {
206	$subject = parent::get_email_header( $form_id );
207
208	/**
209	* Filter the email header
210	*
211	* @since 1.0
212	*/
213	$subject = apply_filters( 'give_email_access_token_heading', $subject );
214
215	return $subject;
216	}
217
218
219	/**
220	* Set email data
221	*
222	* @since 2.0
223	*/
224	public function setup_email_data() {
225	/**
226	* Filters the from name.
227	* Note: This filter will deprecate soon.
228	*
229	* @since 1.0
230	*/
231	$from_name = apply_filters( 'give_donation_from_name', Give()->emails->get_from_name() );
232
233	/**
234	* Filters the from email.
235	* Note: This filter will deprecate soon.
236	*
237	* @since 1.0
238	*/
239	$from_email = apply_filters( 'give_donation_from_address', Give()->emails->get_from_address() );
240
241	Give()->emails->__set( 'from_name', $from_name );
242	Give()->emails->__set( 'from_email', $from_email );
243
244	/**
245	* Filters the donation notification email headers.
246	*
247	* @since 1.0
248	*/
249	$headers = apply_filters( 'give_admin_donation_notification_headers', Give()->emails->get_headers() );
250
251	Give()->emails->__set( 'headers', $headers );
252	}
253
254	/**
255	* Setup email notification.
256	*
257	* @param int $donor_id Donor ID.
258	* @param string $email Donor Email.
259	*
260	* @since 4.16.1 Return false instead of wp_die when donor is not found.
261	* @since 2.0
262	* @access public
263	*
264	* @return bool
265	*/
266	public function setup_email_notification( $donor_id, $email ) {
267	$donor = Give()->donors->get_donor_by( 'email', $email );
268
269	if ( ! is_object( $donor ) \|\| ! $donor->id ) {
270	return false;
271	}
272
273	$this->recipient_email = $email;
274
275	// Set email data.
276	$this->setup_email_data();
277
278	// Send email.
279	return $this->send_email_notification(
280	array(
281	'donor_id' => $donor_id,
282	'user_id' => $donor->user_id,
283	)
284	);
285	}
286
287
288	/**
289	* Set notification status
290	*
291	* @since 2.0
292	* @access public
293	*
294	* @param $update_options
295	* @param $option_name
296	*/
297	public function set_notification_status( $update_options, $option_name ) {
298	// Get updated settings.
299	$update_options = give_get_settings();
300
301	if (
302	! empty( $update_options['email_access'] )
303	&& ! empty( $update_options[ "{$this->config['id']}_notification" ] )
304	&& $update_options['email_access'] !== $update_options[ "{$this->config['id']}_notification" ]
305	) {
306	$update_options[ "{$this->config['id']}_notification" ] = $update_options['email_access'];
307	update_option( $option_name, $update_options, false );
308	}
309	}
310
311
312	/**
313	* email preview header.
314	*
315	* @since 2.0
316	* @access public
317	*
318	* @param string $email_preview_header
319	* @param Give_Email_Access_Email $email
320	* @return string
321	*/
322	public function email_preview_header( $email_preview_header, $email ) {
323	if ( $this->config['id'] === $email->config['id'] ) {
324	$email_preview_header = '';
325	}
326
327	return $email_preview_header;
328	}
329	}
330
331	endif; // End class_exists check
332
333	return Give_Email_Access_Email::get_instance();
334