class-email-access-email.php — GiveWP – Donation Plugin and Fundraising Platform 2.2.1

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

give / includes / admin / emails Last commit date

abstract-email-notification.php 7 years ago ajax-handler.php 8 years ago backward-compatibility.php 8 years ago class-donation-receipt-email.php 7 years ago class-donor-register-email.php 7 years ago class-email-access-email.php 7 years ago class-email-notification-table.php 8 years ago class-email-notification-util.php 8 years ago class-email-notifications.php 7 years ago class-email-setting-field.php 8 years ago class-new-donation-email.php 7 years ago class-new-donor-register-email.php 7 years ago class-new-offline-donation-email.php 7 years ago class-offline-donation-instruction-email.php 7 years ago filters.php 8 years ago

class-email-access-email.php

327 lines

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