Give_New_Offline_Donation_Email::init() - Code Metrics - Inspection of "Fix: set template in email preview" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — release/2.0 ( 9c875b...4d845f )

by Ravinder

created 2017-05-16 06:03 UTC

Give_New_Offline_Donation_Email::init() A

↳ Parent: Give_New_Offline_Donation_Email

Complexity

Conditions	2
Paths	1

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	15
nc	1
nop	0
dl	0
loc	21
rs	9.3142
c	0
b	0
f	0

<?php

/**
 * New Offline Donation Email
 *
 * This class handles all email notification settings.
 *
 * @package     Give
 * @subpackage  Classes/Emails
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       2.0
 */

// Exit if access directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

if ( ! class_exists( 'Give_New_Offline_Donation_Email' ) ) :

	/**
	 * Give_New_Offline_Donation_Email
	 *
	 * @abstract
	 * @since       2.0
	 */
	class Give_New_Offline_Donation_Email extends Give_Email_Notification {
		/* @var Give_Payment $payment */
		public $payment;

		/**
		 * Create a class instance.
		 *
		 * @access  public
		 * @since   2.0
		 */
		public function init() {
			// Initialize empty payment.
			$this->payment = new Give_Payment( 0 );

			$this->load( array(
				'id'                           => 'new-offline-donation',
				'label'                        => __( 'New Offline Donation', 'give' ),
				'description'                  => __( 'Donation Notification will be sent to admin when new offline donation received.', 'give' ),
				'has_recipient_field'          => true,
				'notification_status'          => give_is_gateway_active( 'offline' ) ? 'enabled' : 'disabled',
				'notification_status_editable' => false,
				'preview_email_tags_values'    => array(
					'payment_method' => esc_html__( 'Offline', 'give' ),
				),
				'default_email_subject'        => $this->get_default_email_subject(),
				'default_email_message'        => $this->get_default_email_message(),
			) );

			add_action( 'give_insert_payment', array( $this, 'setup_email_notification' ) );
			add_action( 'give_save_settings_give_settings', array( $this, 'set_notification_status' ), 10, 2 );
		}

		/**
		 * Get default email subject.
		 *
		 * @since  2.0
		 * @access public
		 * @return string
		 */
		public function get_default_email_subject() {
			/**
			 * Filter the default subject.
			 * Note: This filter will deprecate soon.
			 *
			 * @since 1.0
			 */
			$subject = apply_filters(
				'give_offline_admin_donation_notification_subject',
				__( 'New Pending Donation', 'give' )
			);

			/**
			 * Filter the default subject
			 *
			 * @since 2.0
			 */
			return apply_filters(
				"give_{$this->config['id']}_get_default_email_subject",
				$subject,
				$this
			);
		}


		/**
		 * Get default email message.
		 *
		 * @since  2.0
		 * @access public
		 *
		 * @return string
		 */
		public function get_default_email_message() {
			$message = __( 'Dear Admin,', 'give' ) . "\n\n";
			$message .= __( 'An offline donation has been made on your website:', 'give' ) . ' ' . get_bloginfo( 'name' ) . ' ';
			$message .= __( 'Hooray! The donation is in a pending status and is awaiting payment. Donation instructions have been emailed to the donor. Once you receive payment, be sure to mark the donation as complete using the link below.', 'give' ) . "\n\n";

			$message .= '<strong>' . __( 'Donor:', 'give' ) . '</strong> {fullname}' . "\n";
			$message .= '<strong>' . __( 'Amount:', 'give' ) . '</strong> {amount}' . "\n\n";

			$message .= sprintf(
				'<a href="%1$s">%2$s</a>',
				admin_url( 'edit.php?post_type=give_forms&page=give-payment-history&view=view-order-details&id=' . $this->payment->ID ),
				__( 'Click Here to View and/or Update Donation Details', 'give' )
			) . "\n\n";

			/**
			 * Filter the donation receipt email message
			 * Note: This filter will deprecate soon.
			 *
			 * @since 1.0
			 *
			 * @param string $message
			 */
			$message = apply_filters(
				'give_default_new_offline_donation_email',
				$message,
				$this->payment->ID
			);

			/**
			 * Filter the default message
			 *
			 * @since 2.0
			 */
			return apply_filters(
				"give_{$this->config['id']}_get_default_email_message",
				$message,
				$this
			);
		}


		/**
		 * Get message
		 *
		 * @since 2.0
		 *
		 * @param int $form_id
		 *
		 * @return string
		 */
		public function get_email_message( $form_id = null ) {
			$message = Give_Email_Notification_Util::get_value(
				$this,
				Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_message',
				$form_id,
				$this->config['default_email_message']
			);

			/**
			 * Filter the email message.
			 * Note: This filter will deprecate soon.
			 *
			 * @since 1.0
			 */
			$message = apply_filters(
				'give_offline_admin_donation_notification',
				$message,
				$this->payment->ID
			);

			/**
			 * Filter the email message
			 *
			 * @since 2.0
			 */
			return apply_filters(
				"give_{$this->config['id']}_get_email_message",
				$message,
				$this,
				$form_id
			);
		}


		/**
		 * Get attachments.
		 *
		 * @since 2.0
		 *
		 * @param int $form_id
		 *
		 * @return array
		 */
		public function get_email_attachments( $form_id = null ) {
			/**
			 * Filter the attachments.
			 * Note: This filter will deprecate soon.
			 *
			 * @since 1.0
			 */
			$attachment = apply_filters(
				'give_offline_admin_donation_notification_attachments',
				array(),
				$this->payment->ID
			);

			/**
			 * Filter the attachments.
			 *
			 * @since 2.0
			 */
			return apply_filters(
				"give_{$this->config['id']}_get_email_attachments",
				$attachment,
				$this
			);
		}


		/**
		 * Set email data.
		 *
		 * @since 2.0
		 */
		public function setup_email_data() {
			// Set header.
			Give()->emails->__set(
				'headers',
				apply_filters(
					'give_offline_admin_donation_notification_headers',
					Give()->emails->get_headers(),
					$this->payment->ID
				)
			);
		}

		/**
		 * Setup email notification.
		 *
		 * @since  2.0
		 * @access public
		 *
		 * @param int $payment_id
		 */
		public function setup_email_notification( $payment_id ) {
			$this->payment = new Give_Payment( $payment_id );

			// Exit if not donation was not with offline donation.
			if ( 'offline' !== $this->payment->gateway ) {
				return;
			}

			// Set email data.
			$this->setup_email_data();

			// Send email.
			$this->send_email_notification( array(
				'payment_id' => $this->payment->ID,
			) );
		}

		/**
		 * Set notification status
		 *
		 * @since  2.0
		 * @access public
		 *
		 * @param $update_options
		 * @param $option_name
		 */
		public function set_notification_status( $update_options, $option_name ) {
			// Get updated settings.
			$update_options = give_get_settings();

			$notification_status = isset( $update_options['gateways']['offline'] ) ? 'enabled' : 'disabled';

			if (
				empty( $update_options[ "{$this->config['id']}_notification" ] )
				|| $notification_status !== $update_options[ "{$this->config['id']}_notification" ]
			) {
				$update_options[ "{$this->config['id']}_notification" ] = $notification_status;
				update_option( $option_name, $update_options );
			}
		}
	}

endif; // End class_exists check

return Give_New_Offline_Donation_Email::get_instance();


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-04-19 05:37 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 27 and the first side effect is on line 16. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* New Offline Donation 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_New_Offline_Donation_Email' ) ) :
20
21			/**
22			* Give_New_Offline_Donation_Email
23			*
24			* @abstract
25			* @since 2.0
26			*/
27			class Give_New_Offline_Donation_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' => 'new-offline-donation',
43			'label' => __( 'New Offline Donation', 'give' ),
44			'description' => __( 'Donation Notification will be sent to admin when new offline donation received.', 'give' ),
45			'has_recipient_field' => true,
46			'notification_status' => give_is_gateway_active( 'offline' ) ? 'enabled' : 'disabled',
47			'notification_status_editable' => false,
48			'preview_email_tags_values' => array(
49			'payment_method' => esc_html__( 'Offline', 'give' ),
50			),
51			'default_email_subject' => $this->get_default_email_subject(),
52			'default_email_message' => $this->get_default_email_message(),
53			) );
54
55			add_action( 'give_insert_payment', array( $this, 'setup_email_notification' ) );
56			add_action( 'give_save_settings_give_settings', array( $this, 'set_notification_status' ), 10, 2 );
57			}
58
59			/**
60			* Get default email subject.
61			*
62			* @since 2.0
63			* @access public
64			* @return string
65			*/
66			public function get_default_email_subject() {
67			/**
68			* Filter the default subject.
69			* Note: This filter will deprecate soon.
70			*
71			* @since 1.0
72			*/
73			$subject = apply_filters(
74			'give_offline_admin_donation_notification_subject',
75			__( 'New Pending Donation', 'give' )
76			);
77
78			/**
79			* Filter the default subject
80			*
81			* @since 2.0
82			*/
83			return apply_filters(
84			"give_{$this->config['id']}_get_default_email_subject",
85			$subject,
86			$this
87			);
88			}
89
90
91			/**
92			* Get default email message.
93			*
94			* @since 2.0
95			* @access public
96			*
97			* @return string
98			*/
99			public function get_default_email_message() {
100			$message = __( 'Dear Admin,', 'give' ) . "\n\n";
101			$message .= __( 'An offline donation has been made on your website:', 'give' ) . ' ' . get_bloginfo( 'name' ) . ' ';
102			$message .= __( 'Hooray! The donation is in a pending status and is awaiting payment. Donation instructions have been emailed to the donor. Once you receive payment, be sure to mark the donation as complete using the link below.', 'give' ) . "\n\n";
103
104			$message .= '<strong>' . __( 'Donor:', 'give' ) . '</strong> {fullname}' . "\n";
105			$message .= '<strong>' . __( 'Amount:', 'give' ) . '</strong> {amount}' . "\n\n";
106
107			$message .= sprintf(
108			'<a href="%1$s">%2$s</a>',
109			admin_url( 'edit.php?post_type=give_forms&page=give-payment-history&view=view-order-details&id=' . $this->payment->ID ),
110			__( 'Click Here to View and/or Update Donation Details', 'give' )
111			) . "\n\n";
112
113			/**
114			* Filter the donation receipt email message
115			* Note: This filter will deprecate soon.
116			*
117			* @since 1.0
118			*
119			* @param string $message
120			*/
121			$message = apply_filters(
122			'give_default_new_offline_donation_email',
123			$message,
124			$this->payment->ID
125			);
126
127			/**
128			* Filter the default message
129			*
130			* @since 2.0
131			*/
132			return apply_filters(
133			"give_{$this->config['id']}_get_default_email_message",
134			$message,
135			$this
136			);
137			}
138
139
140			/**
141			* Get message
142			*
143			* @since 2.0
144			*
145			* @param int $form_id
146			*
147			* @return string
148			*/
149			public function get_email_message( $form_id = null ) {
150			$message = Give_Email_Notification_Util::get_value(
151			$this,
152			Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_message',
153			$form_id,
154			$this->config['default_email_message']
155			);
156
157			/**
158			* Filter the email message.
159			* Note: This filter will deprecate soon.
160			*
161			* @since 1.0
162			*/
163			$message = apply_filters(
164			'give_offline_admin_donation_notification',
165			$message,
166			$this->payment->ID
167			);
168
169			/**
170			* Filter the email message
171			*
172			* @since 2.0
173			*/
174			return apply_filters(
175			"give_{$this->config['id']}_get_email_message",
176			$message,
177			$this,
178			$form_id
179			);
180			}
181
182
183			/**
184			* Get attachments.
185			*
186			* @since 2.0
187			*
188			* @param int $form_id
189			*
190			* @return array
191			*/
192			public function get_email_attachments( $form_id = null ) {
193			/**
194			* Filter the attachments.
195			* Note: This filter will deprecate soon.
196			*
197			* @since 1.0
198			*/
199			$attachment = apply_filters(
200			'give_offline_admin_donation_notification_attachments',
201			array(),
202			$this->payment->ID
203			);
204
205			/**
206			* Filter the attachments.
207			*
208			* @since 2.0
209			*/
210			return apply_filters(
211			"give_{$this->config['id']}_get_email_attachments",
212			$attachment,
213			$this
214			);
215			}
216
217
218			/**
219			* Set email data.
220			*
221			* @since 2.0
222			*/
223			public function setup_email_data() {
224			// Set header.
225			Give()->emails->__set(
226			'headers',
227			apply_filters(
228			'give_offline_admin_donation_notification_headers',
229			Give()->emails->get_headers(),
230			$this->payment->ID
231			)
232			);
233			}
234
235			/**
236			* Setup email notification.
237			*
238			* @since 2.0
239			* @access public
240			*
241			* @param int $payment_id
242			*/
243			public function setup_email_notification( $payment_id ) {
244			$this->payment = new Give_Payment( $payment_id );
245
246			// Exit if not donation was not with offline donation.
247			if ( 'offline' !== $this->payment->gateway ) {
248			return;
249			}
250
251			// Set email data.
252			$this->setup_email_data();
253
254			// Send email.
255			$this->send_email_notification( array(
256			'payment_id' => $this->payment->ID,
257			) );
258			}
259
260			/**
261			* Set notification status
262			*
263			* @since 2.0
264			* @access public
265			*
266			* @param $update_options
267			* @param $option_name
268			*/
269			public function set_notification_status( $update_options, $option_name ) {
270			// Get updated settings.
271			$update_options = give_get_settings();
272
273			$notification_status = isset( $update_options['gateways']['offline'] ) ? 'enabled' : 'disabled';
274
275			if (
276			empty( $update_options[ "{$this->config['id']}_notification" ] )
277			\|\| $notification_status !== $update_options[ "{$this->config['id']}_notification" ]
278			) {
279			$update_options[ "{$this->config['id']}_notification" ] = $notification_status;
280			update_option( $option_name, $update_options );
281			}
282			}
283			}
284
285			endif; // End class_exists check
286
287			return Give_New_Offline_Donation_Email::get_instance();
288

ravinderk / Give

Push — release/2.0 ( 9c875b...4d845f )

Give_New_Offline_Donation_Email::init() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like