Give_Email_Notifications::load()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
/**
3
 * Email Notification
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
/**
15
 * Class Give_Email_Notifications
16
 */
17
class Give_Email_Notifications {
0 ignored issues
show
Coding Style introduced by
Since you have declared the constructor as private, maybe you should also declare the class as final.
Loading history...
18
	/**
19
	 * Instance.
20
	 *
21
	 * @since  2.0
22
	 * @access static
23
	 * @var
24
	 */
25
	static private $instance;
26
27
	/**
28
	 * Array of email notifications.
29
	 *
30
	 * @since  2.0
31
	 * @access private
32
	 * @var array
33
	 */
34
	private $emails = array();
35
36
	/**
37
	 * Singleton pattern.
38
	 *
39
	 * @since  2.0
40
	 * @access private
41
	 * Give_Payumoney_API constructor.
42
	 */
43
	private function __construct() {
44
	}
45
46
47
	/**
48
	 * Get instance.
49
	 *
50
	 * @since  2.0
51
	 * @access static
52
	 * @return static
53
	 */
54
	static function get_instance() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
55
		if ( null === static::$instance ) {
56
			self::$instance = new static();
57
		}
58
59
		return self::$instance;
60
	}
61
62
	/**
63
	 * Setup dependencies
64
	 *
65
	 * @since 2.0
66
	 */
67
	public function init() {
68
		// Load files.
69
		require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/ajax-handler.php';
70
		require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/class-email-setting-field.php';
71
		require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/filters.php';
72
73
		// Load email notifications.
74
		$this->add_emails_notifications();
75
76
		add_filter( 'give_metabox_form_data_settings', array( $this, 'add_metabox_setting_fields' ), 10, 2 );
77
		add_action( 'init', array( $this, 'preview_email' ) );
78
		add_action( 'init', array( $this, 'send_preview_email' ) );
79
		add_action( 'init', array( $this, 'validate_settings' ) );
80
81
		/* @var Give_Email_Notification $email */
82
		foreach ( $this->get_email_notifications() as $email ) {
83
			// Setup email section.
84
			if( Give_Email_Notification_Util::is_show_on_emails_setting_page( $email ) ) {
0 ignored issues
show
introduced by
Space after opening control structure is required
Loading history...
introduced by
No space before opening parenthesis is prohibited
Loading history...
85
				add_filter( 'give_get_sections_emails', array( $email, 'add_section' ) );
86
				add_filter( "give_hide_section_{$email->config['id']}_on_emails_page", array( $email, 'hide_section' ) );
87
			}
88
89
			// Setup email preview.
90
			if ( Give_Email_Notification_Util::is_email_preview_has_header( $email ) ) {
91
				add_action( "give_{$email->config['id']}_email_preview", array( $this, 'email_preview_header' ) );
92
				add_filter( "give_{$email->config['id']}_email_preview_data", array( $this, 'email_preview_data' ) );
93
				add_filter( "give_{$email->config['id']}_email_preview_message", array( $this, 'email_preview_message' ), 1, 2 );
94
			}
95
		}
96
	}
97
98
99
	/**
100
	 * Add setting to metabox.
101
	 *
102
	 * @since  2.0
103
	 * @access public
104
	 *
105
	 * @param array $settings
106
	 * @param int   $post_id
107
	 *
108
	 * @return array
109
	 */
110
	public function add_metabox_setting_fields( $settings, $post_id ) {
111
		$emails = $this->get_email_notifications();
112
113
		// Bailout.
114
		if ( empty( $emails ) ) {
115
			return $settings;
116
		}
117
118
		// Email notification setting.
119
		$settings['email_notification_options'] = array(
120
			'id'         => 'email_notification_options',
121
			'title'      => __( 'Email Notifications', 'give' ),
122
			'icon-html' => '<span class="dashicons dashicons-email-alt"></span>',
123
			'fields'     => array(
124
				array(
125
					'name'        => __( 'Email Options', 'give' ),
126
					'id'          => '_give_email_options',
127
					'type'        => 'radio_inline',
128
					'default'     => 'global',
129
					'options'     => array(
130
						'global'   => __( 'Global Options' ),
131
						'enabled'  => __( 'Customize', 'give' ),
132
					),
133
				),
134
				array(
135
					'id'      => '_give_email_template',
136
					'name'    => esc_html__( 'Email Template', 'give' ),
137
					'desc'    => esc_html__( 'Choose your template from the available registered template types.', 'give' ),
138
					'type'    => 'select',
139
					'default' => 'default',
140
					'options' => give_get_email_templates(),
141
				),
142
				array(
143
					'id'   => '_give_email_logo',
144
					'name' => esc_html__( 'Logo', 'give' ),
145
					'desc' => esc_html__( 'Upload or choose a logo to be displayed at the top of the donation receipt emails. Displayed on HTML emails only.', 'give' ),
146
					'type' => 'file',
147
				),
148
				array(
149
					'id'      => '_give_from_name',
150
					'name'    => esc_html__( 'From Name', 'give' ),
151
					'desc'    => esc_html__( 'The name which appears in the "From" field in all Give donation emails.', 'give' ),
152
					'default' => get_bloginfo( 'name' ),
153
					'type'    => 'text',
154
				),
155
				array(
156
					'id'      => '_give_from_email',
157
					'name'    => esc_html__( 'From Email', 'give' ),
158
					'desc'    => esc_html__( 'Email address from which all Give emails are sent from. This will act as the "from" and "reply-to" email address.', 'give' ),
159
					'default' => get_bloginfo( 'admin_email' ),
160
					'type'    => 'text',
161
				),
162
				array(
163
					'name'  => 'email_notification_docs',
164
					'type'  => 'docs_link',
165
					'url'   => 'http://docs.givewp.com/email-notification',
166
					'title' => __( 'Email Notification', 'give' ),
167
				),
168
			),
169
170
			/**
171
			 * Filter the email notification settings.
172
			 *
173
			 * @since 2.0
174
			 */
175
			'sub-fields' => apply_filters( 'give_email_notification_options_metabox_fields', array(), $post_id ),
176
		);
177
178
		return $settings;
179
	}
180
181
	/**
182
	 * Add email notifications
183
	 *
184
	 * @since  2.0
185
	 * @access private
186
	 */
187
	private function add_emails_notifications() {
188
		$this->emails = array(
189
			include GIVE_PLUGIN_DIR . 'includes/admin/emails/class-new-donation-email.php',
190
			include GIVE_PLUGIN_DIR . 'includes/admin/emails/class-donation-receipt-email.php',
191
			include GIVE_PLUGIN_DIR . 'includes/admin/emails/class-new-offline-donation-email.php',
192
			include GIVE_PLUGIN_DIR . 'includes/admin/emails/class-offline-donation-instruction-email.php',
193
			include GIVE_PLUGIN_DIR . 'includes/admin/emails/class-new-donor-register-email.php',
194
			include GIVE_PLUGIN_DIR . 'includes/admin/emails/class-donor-register-email.php',
195
			include GIVE_PLUGIN_DIR . 'includes/admin/emails/class-donor-note-email.php',
196
			include GIVE_PLUGIN_DIR . 'includes/admin/emails/class-email-access-email.php',
197
		);
198
199
		/**
200
		 * Filter the email notifications.
201
		 *
202
		 * @since 2.0
203
		 */
204
		$this->emails = apply_filters( 'give_email_notifications', $this->emails, $this );
205
206
		// Bailout.
207
		if ( empty( $this->emails ) ) {
208
			return;
209
		}
210
211
		// Initiate email notifications.
212
		foreach ( $this->emails as $email ) {
213
			$email->init();
214
		}
215
	}
216
217
218
	/**
219
	 * Get list of email notifications.
220
	 *
221
	 * @since  2.0
222
	 * @access public
223
	 * @return array
224
	 */
225
	public function get_email_notifications() {
226
		return $this->emails;
227
	}
228
229
230
	/**
231
	 * Displays the email preview
232
	 *
233
	 * @since  2.0
234
	 * @access public
235
	 * @return bool|null
236
	 */
237
	public function preview_email() {
238
		// Bailout.
239
		if ( ! Give_Email_Notification_Util::can_preview_email() ) {
240
			return false;
241
		}
242
243
		// Security check.
244
		give_validate_nonce( $_GET['_wpnonce'], 'give-preview-email' );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_GET
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
245
246
		// Get email type.
247
		$email_type = isset( $_GET['email_type'] ) ? esc_attr( $_GET['email_type'] ) : '';
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
248
249
		/* @var Give_Email_Notification $email */
250
		foreach ( $this->get_email_notifications() as $email ) {
251
			if ( $email_type !== $email->config['id'] ) {
252
				continue;
253
			}
254
255
			// Set form id.
256
			$form_id = empty( $_GET['form_id'] ) ? null : absint( $_GET['form_id'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
257
258
			// Call setup email data to apply filter and other thing to email.
259
			$email->send_preview_email( false );
260
261
			// Decode message.
262
			$email_message = $email->preview_email_template_tags( $email->get_email_message( $form_id ) );
263
264
			// Show formatted text in browser even text/plain content type set for an email.
265
			Give()->emails->html = true;
266
267
			Give()->emails->form_id = $form_id;
268
269
			if ( 'text/plain' === $email->config['content_type'] ) {
270
				// Give()->emails->__set( 'html', false );
271
				Give()->emails->__set( 'template', 'none' );
272
			}
273
274
			if ( $email_message = Give()->emails->build_email( $email_message ) ) {
275
276
				/**
277
				 * Filter the email preview data
278
				 *
279
				 * @since 2.0
280
				 *
281
				 * @param array
282
				 */
283
				$email_preview_data = apply_filters( "give_{$email_type}_email_preview_data", array() );
284
285
				/**
286
				 * Fire the give_{$email_type}_email_preview action
287
				 *
288
				 * @since 2.0
289
				 */
290
				do_action( "give_{$email_type}_email_preview", $email );
291
292
				/**
293
				 * Filter the email message
294
				 *
295
				 * @since 2.0
296
				 *
297
				 * @param string                  $email_message
298
				 * @param array                   $email_preview_data
299
				 * @param Give_Email_Notification $email
300
				 */
301
				echo apply_filters( "give_{$email_type}_email_preview_message", $email_message, $email_preview_data, $email );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'apply_filters'
Loading history...
302
303
				exit();
304
			}
305
		}// End foreach().
306
	}
307
308
309
	/**
310
	 * Add header to donation receipt email preview
311
	 *
312
	 * @since   2.0
313
	 * @access  public
314
	 *
315
	 * @param Give_Email_Notification $email
316
	 */
317
	public function email_preview_header( $email ) {
318
		/**
319
		 * Filter the all email preview headers.
320
		 *
321
		 * @since 2.0
322
		 *
323
		 * @param Give_Email_Notification $email
324
		 */
325
		$email_preview_header = apply_filters( 'give_email_preview_header', give_get_preview_email_header(), $email );
326
327
		echo $email_preview_header;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$email_preview_header'
Loading history...
328
	}
329
330
	/**
331
	 * Add email preview data
332
	 *
333
	 * @since   2.0
334
	 * @access  public
335
	 *
336
	 * @param array $email_preview_data
337
	 *
338
	 * @return array
339
	 */
340
	public function email_preview_data( $email_preview_data ) {
341
		$email_preview_data['payment_id'] = absint( give_check_variable( give_clean( $_GET ), 'isset', 0, 'preview_id' ) );
0 ignored issues
show
Documentation introduced by
0 is of type integer, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
342
		$email_preview_data['user_id']    = absint( give_check_variable( give_clean( $_GET ), 'isset', 0, 'user_id' ) );
0 ignored issues
show
Documentation introduced by
0 is of type integer, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
343
344
		return $email_preview_data;
345
	}
346
347
	/**
348
	 * Replace email template tags.
349
	 *
350
	 * @since   2.0
351
	 * @access  public
352
	 *
353
	 * @param string $email_message
354
	 * @param array  $email_preview_data
355
	 *
356
	 * @return string
357
	 */
358
	public function email_preview_message( $email_message, $email_preview_data ) {
359
		if (
360
			! empty( $email_preview_data['payment_id'] )
361
			|| ! empty( $email_preview_data['user_id'] )
362
		) {
363
			$email_message = give_do_email_tags( $email_message, $email_preview_data );
364
		}
365
366
		return $email_message;
367
	}
368
369
	/**
370
	 * Displays the email preview
371
	 *
372
	 * @since  2.0
373
	 * @access public
374
	 * @return bool|null
375
	 */
376
	public function send_preview_email() {
377
		// Bailout.
378
		if ( ! Give_Email_Notification_Util::can_send_preview_email() ) {
379
			return false;
380
		}
381
382
		// Security check.
383
		give_validate_nonce( $_GET['_wpnonce'], 'give-send-preview-email' );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_GET
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
384
385
		// Get email type.
386
		$email_type = give_check_variable( give_clean( $_GET ), 'isset', '', 'email_type' );
0 ignored issues
show
Documentation introduced by
'' is of type string, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
387
388
		/* @var Give_Email_Notification $email */
389
		foreach ( $this->get_email_notifications() as $email ) {
390
			if ( $email_type === $email->config['id'] && Give_Email_Notification_Util::is_email_preview( $email ) ) {
391
				$email->send_preview_email();
392
				break;
393
			}
394
		}
395
396
		// Remove the test email query arg.
397
		wp_redirect( remove_query_arg( 'give_action' ) );
398
		exit;
399
	}
400
401
402
	/**
403
	 * Load Give_Email_Notifications
404
	 *
405
	 * @since  2.0
406
	 * @access public
407
	 */
408
	public function load() {
409
		add_action( 'init', array( $this, 'init' ), -1 );
410
	}
411
412
413
	/**
414
	 * Verify email setting before saving
415
	 *
416
	 * @since  2.0
417
	 * @access public
418
	 */
419
	public function validate_settings() {
420
		// Bailout.
421
		if (
422
			! Give_Admin_Settings::is_saving_settings() ||
423
			'emails' !== give_get_current_setting_tab() ||
424
			! isset( $_GET['section'] )
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
425
		) {
426
			return;
427
		}
428
429
		// Get email type.
430
		$email_type = give_get_current_setting_section();
431
432
		if ( ! empty( $_POST["{$email_type}_recipient"] ) ) {
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
433
			$_POST["{$email_type}_recipient"] = array_unique( array_filter( $_POST["{$email_type}_recipient"] ) );
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
434
		}
435
	}
436
}
437
438
// Helper class.
439
require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/abstract-email-notification.php';
440
require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/class-email-notification-util.php';
441
442
// Add backward compatibility.
443
require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/backward-compatibility.php';
444
445
/**
446
 * Initialize functionality.
447
 */
448
Give_Email_Notifications::get_instance()->load();
449