class-offline-donation-instruction-email.php — GiveWP – Donation Plugin and Fundraising Platform 2.4.6

give / includes / admin / emails / class-offline-donation-instruction-email.php

give / includes / admin / emails Last commit date

class-offline-donation-instruction-email.php

287 lines

1	<?php
2	/**
3	* Offline Donation Instruction Email
4	*
5	* This class handles all email notification settings.
6	*
7	* @package Give
8	* @subpackage Classes/Emails
9	* @copyright Copyright (c) 2016, GiveWP
10	* @license https://opensource.org/licenses/gpl-license GNU Public License
11	* @since 2.0
12	*/
13
14	// Exit if access directly.
15	if ( ! defined( 'ABSPATH' ) ) {
16	exit;
17	}
18
19	if ( ! class_exists( 'Give_Offline_Donation_Instruction_Email' ) ) :
20
21	/**
22	* Give_Offline_Donation_Instruction_Email
23	*
24	* @abstract
25	* @since 2.0
26	*/
27	class Give_Offline_Donation_Instruction_Email extends Give_Email_Notification {
28	/* @var Give_Payment $payment */
29	public $payment;
30
31	/**
32	* Create a class instance.
33	*
34	* @access public
35	* @since 2.0
36	*/
37	public function init() {
38	// Initialize empty payment.
39	$this->payment = new Give_Payment( 0 );
40
41	$this->load( array(
42	'id' => 'offline-donation-instruction',
43	'label' => __( 'Offline Donation Instructions', 'give' ),
44	'description' => __( 'Sent to the donor when they submit an offline donation.', 'give' ),
45	'notification_status' => give_is_gateway_active( 'offline' ) ? 'enabled' : 'disabled',
46	'form_metabox_setting' => true,
47	'notification_status_editable' => false,
48	'preview_email_tag_values' => array(
49	'payment_method' => esc_html__( 'Offline', 'give' ),
50	),
51	'default_email_subject' => esc_attr__( '{donation} - Offline Donation Instructions', 'give' ),
52	'default_email_message' => give_get_default_offline_donation_email_content(),
53	'default_email_header' => __( 'Offline Donation Instructions', 'give' ),
54	'notices' => array(
55	'non-notification-status-editable' => sprintf(
56	'%1$s <a href="%2$s">%3$s »</a>',
57	__( 'This notification is automatically toggled based on whether the gateway is enabled or not.', 'give' ),
58	esc_url( admin_url('edit.php?post_type=give_forms&page=give-settings&tab=gateways&section=offline-donations') ),
59	__( 'Edit Setting', 'give' )
60	)
61	),
62	) );
63
64	add_action( 'give_insert_payment', array( $this, 'setup_email_notification' ) );
65	add_action( 'give_save_settings_give_settings', array( $this, 'set_notification_status' ), 10, 2 );
66	}
67
68	/**
69	* Get email message
70	*
71	* @since 2.0
72	*
73	* @param int $form_id
74	*
75	* @return string
76	*/
77	public function get_email_message( $form_id = null ) {
78	$message = Give_Email_Notification_Util::get_value(
79	$this,
80	Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_message',
81	$form_id,
82	$this->config['default_email_message']
83	);
84
85	/**
86	* Filter the email message.
87	*
88	* @since 2.0
89	*/
90	$message = apply_filters(
91	"give_{$this->config['id']}_get_email_message",
92	$message,
93	$this,
94	$form_id
95	);
96
97	return $message;
98	}
99
100	/**
101	* Get email message
102	*
103	* @since 2.0
104	*
105	* @param int $form_id
106	*
107	* @return string
108	*/
109	public function get_email_subject( $form_id = null ) {
110	$subject = wp_strip_all_tags(
111	Give_Email_Notification_Util::get_value(
112	$this,
113	Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_subject',
114	$form_id,
115	$this->config['default_email_subject']
116	)
117	);
118
119	/**
120	* Filter the email subject.
121	*
122	* @since 2.0
123	*/
124	$subject = apply_filters(
125	"give_{$this->config['id']}_get_email_subject",
126	$subject,
127	$this,
128	$form_id
129	);
130
131	return $subject;
132	}
133
134	/**
135	* Get attachments.
136	*
137	* @since 2.0
138	*
139	* @param int $form_id
140	* @return array
141	*/
142	public function get_email_attachments( $form_id = null ) {
143	/**
144	* Filter the attachments.
145	* Note: This filter will deprecate soon.
146	*
147	* @since 1.0
148	*/
149	$attachment = apply_filters(
150	'give_offline_donation_attachments',
151	array(),
152	$this->payment->ID,
153	$this->payment->payment_meta
154	);
155
156	/**
157	* Filter the email attachment.
158	*
159	* @since 2.0
160	*/
161	$attachment = apply_filters(
162	"give_{$this->config['id']}_get_email_attachment",
163	$attachment,
164	$this,
165	$form_id
166	);
167
168	return $attachment;
169	}
170
171
172	/**
173	* Set email data.
174	*
175	* @since 2.0
176	*/
177	public function setup_email_data() {
178	// Set recipient email.
179	$this->recipient_email = $this->payment->email;
180
181	/**
182	* Filters the from name.
183	*
184	* @since 1.7
185	*/
186	$from_name = apply_filters(
187	'give_donation_from_name',
188	Give()->emails->get_from_name(),
189	$this->payment->ID,
190	$this->payment->payment_meta
191	);
192
193	/**
194	* Filters the from email.
195	*
196	* @since 1.7
197	*/
198	$from_email = apply_filters(
199	'give_donation_from_address',
200	Give()->emails->get_from_address(),
201	$this->payment->ID,
202	$this->payment->payment_meta
203	);
204
205	Give()->emails->__set( 'from_name', $from_name );
206	Give()->emails->__set( 'from_email', $from_email );
207	Give()->emails->__set( 'headers', apply_filters( 'give_receipt_headers', Give()->emails->get_headers(), $this->payment->ID, $this->payment->payment_meta ) );
208	}
209
210	/**
211	* Setup email notification.
212	*
213	* @since 2.0
214	* @access public
215	*
216	* @param int $payment_id
217	*/
218	public function setup_email_notification( $payment_id ) {
219	$this->payment = new Give_Payment( $payment_id );
220
221	// Exit if not donation was not with offline donation.
222	if ( 'offline' !== $this->payment->gateway ) {
223	return;
224	}
225
226	// Set email data.
227	$this->setup_email_data();
228
229	// Send email.
230	$this->send_email_notification( array(
231	'payment_id' => $this->payment->ID,
232	) );
233	}
234
235	/**
236	* Set notification status
237	*
238	* @since 2.0
239	* @access public
240	*
241	* @param $update_options
242	* @param $option_name
243	*/
244	public function set_notification_status( $update_options, $option_name ) {
245	// Get updated settings.
246	$update_options = give_get_settings();
247
248	$notification_status = isset( $update_options['gateways']['offline'] ) ? 'enabled' : 'disabled';
249
250	if (
251	empty( $update_options["{$this->config['id']}_notification"] )
252	\|\| $notification_status !== $update_options["{$this->config['id']}_notification"]
253	) {
254	$update_options["{$this->config['id']}_notification"] = $notification_status;
255	update_option( $option_name, $update_options, false );
256	}
257	}
258
259
260	/**
261	* Register email settings to form metabox.
262	*
263	* @since 2.0
264	* @access public
265	*
266	* @param array $settings
267	* @param int $form_id
268	*
269	* @return array
270	*/
271	public function add_metabox_setting_field( $settings, $form_id ) {
272	if ( in_array( 'offline', array_keys( give_get_enabled_payment_gateways($form_id) ) ) ) {
273	$settings[] = array(
274	'id' => $this->config['id'],
275	'title' => $this->config['label'],
276	'fields' => $this->get_setting_fields( $form_id ),
277	);
278	}
279
280	return $settings;
281	}
282	}
283
284	endif; // End class_exists check
285
286	return Give_Offline_Donation_Instruction_Email::get_instance();
287