Test Failed
Push — master ( 966cf3...fe1ced )
by Devin
13:57 queued 06:53
created

Give_Offline_Donation_Instruction_Email   A

Complexity

Total Complexity 14

Size/Duplication

Total Lines 257
Duplicated Lines 57.59 %

Coupling/Cohesion

Components 1
Dependencies 6

Importance

Changes 0
Metric Value
dl 148
loc 257
rs 10
c 0
b 0
f 0
wmc 14
lcom 1
cbo 6

8 Methods

Rating   Name   Duplication   Size   Complexity  
B init() 0 29 2
A get_email_message() 22 22 1
B get_email_subject() 24 24 1
B get_email_attachments() 28 28 1
B setup_email_data() 33 33 1
A setup_email_notification() 16 16 2
A set_notification_status() 14 14 4
A add_metabox_setting_field() 11 11 2

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

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, WordImpress
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
				'notices' => array(
54
					'non-notification-status-editable' => sprintf(
55
						'%1$s <a href="%2$s">%3$s &raquo;</a>',
56
						__( 'This notification is automatically toggled based on whether the gateway is enabled or not.', 'give' ),
57
						esc_url( admin_url('edit.php?post_type=give_forms&page=give-settings&tab=gateways&section=offline-donations') ),
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
58
						__( 'Edit Setting', 'give' )
59
					)
60
				),
61
			) );
62
63
			add_action( 'give_insert_payment', array( $this, 'setup_email_notification' ) );
64
			add_action( 'give_save_settings_give_settings', array( $this, 'set_notification_status' ), 10, 2 );
65
		}
66
67
68
		/**
69
		 * Get email message
70
		 *
71
		 * @since 2.0
72
		 *
73
		 * @param int $form_id
74
		 *
75
		 * @return string
76
		 */
77 View Code Duplication
		public function get_email_message( $form_id = null ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
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 View Code Duplication
		public function get_email_subject( $form_id = null ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
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 View Code Duplication
		public function get_email_attachments( $form_id = null ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
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 View Code Duplication
		public function setup_email_data() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
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( 'heading', __( 'Offline Donation Instructions', 'give' ) );
208
			Give()->emails->__set( 'headers', apply_filters( 'give_receipt_headers', Give()->emails->get_headers(), $this->payment->ID, $this->payment->payment_meta ) );
209
		}
210
211
		/**
212
		 * Setup email notification.
213
		 *
214
		 * @since  2.0
215
		 * @access public
216
		 *
217
		 * @param int $payment_id
218
		 */
219 View Code Duplication
		public function setup_email_notification( $payment_id ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
220
			$this->payment = new Give_Payment( $payment_id );
221
222
			// Exit if not donation was not with offline donation.
223
			if ( 'offline' !== $this->payment->gateway ) {
224
				return;
225
			}
226
227
			// Set email data.
228
			$this->setup_email_data();
229
230
			// Send email.
231
			$this->send_email_notification( array(
232
				'payment_id' => $this->payment->ID,
233
			) );
234
		}
235
236
		/**
237
		 * Set notification status
238
		 *
239
		 * @since  2.0
240
		 * @access public
241
		 *
242
		 * @param $update_options
243
		 * @param $option_name
244
		 */
245 View Code Duplication
		public function set_notification_status( $update_options, $option_name ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
246
			// Get updated settings.
247
			$update_options = give_get_settings();
248
249
			$notification_status = isset( $update_options['gateways']['offline'] ) ? 'enabled' : 'disabled';
250
251
			if (
252
				empty( $update_options["{$this->config['id']}_notification"] )
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
253
				|| $notification_status !== $update_options["{$this->config['id']}_notification"]
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
254
			) {
255
				$update_options["{$this->config['id']}_notification"] = $notification_status;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
256
				update_option( $option_name, $update_options );
257
			}
258
		}
259
260
261
		/**
262
		 * Register email settings to form metabox.
263
		 *
264
		 * @since  2.0
265
		 * @access public
266
		 *
267
		 * @param array $settings
268
		 * @param int   $form_id
269
		 *
270
		 * @return array
271
		 */
272 View Code Duplication
		public function add_metabox_setting_field( $settings, $form_id ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
273
			if ( in_array( 'offline', array_keys( give_get_enabled_payment_gateways($form_id) ) ) ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
274
				$settings[] = array(
275
					'id'     => $this->config['id'],
276
					'title'  => $this->config['label'],
277
					'fields' => $this->get_setting_fields( $form_id ),
278
				);
279
			}
280
281
			return $settings;
282
		}
283
	}
284
285
endif; // End class_exists check
286
287
return Give_Offline_Donation_Instruction_Email::get_instance();
288