functions.php ➔ give_email_test_donation_receipt() - 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

functions.php ➔ give_email_test_donation_receipt() B

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	39
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	17
nc	1
nop	0
dl	0
loc	39
rs	8.8571
c	0
b	0
f	0

<?php

/**
 * Email Functions
 *
 * @package     Give
 * @subpackage  Emails
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       1.0
 */

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

/**
 * Email Donation Receipt.
 *
 * Email the donation confirmation to the donor via the customizable "Donation Receipt" settings.
 *
 * @since 1.0
 *
 * @param int  $payment_id   Payment ID.
 * @param bool $admin_notice Whether to send the admin email notification or not (default: true).
 *
 * @return void
 */
function give_email_donation_receipt( $payment_id, $admin_notice = true ) {
	$payment = new Give_Payment( $payment_id );
	/**
	 * Fire the action
	 */
	do_action( 'give_donation-receipt_email_notification', $payment_id );

	//If admin notifications are on, send the admin notice.
	if ( $admin_notice && ! give_admin_notices_disabled( $payment_id ) ) {

		/**
		 * Fires in the donation email receipt.
		 *
		 * When admin email notices are not disabled, you can add new email notices.
		 *
		 * @since 1.0
		 *
		 * @param int   $payment_id   Payment id.
		 * @param mixed $payment_data Payment meta data.
		 */
		do_action( 'give_new-donation_email_notification', $payment_id, $payment->payment_meta );
	}
}

/**
 * Sends the Admin Sale Notification Email
 *
 * @since 1.0
 *
 * @param int $payment_id Payment ID (default: 0)
 *
 * @return void
 */
function give_admin_email_notice( $payment_id ) {
	/**
	 * Fires in the donation email receipt.
	 *
	 * When admin email notices are not disabled, you can add new email notices.
	 *
	 * @since 1.0
	 *
	 * @param int   $payment_id   Payment id.
	 * @param mixed $payment_data Payment meta data.
	 */
	do_action( 'give_new-donation_email_notification', $payment_id );
}

add_action( 'give_admin_donation_email', 'give_admin_email_notice' );

/**
 * Retrieves the emails for which admin notifications are sent to (these can be changed in the Give Settings).
 *
 * @since 1.0
 * @deprecated 2.0
 *
 * @return mixed
 */
function give_get_admin_notice_emails() {

	$email_option = give_get_option( 'admin_notice_emails' );

	$emails = ! empty( $email_option ) && strlen( trim( $email_option ) ) > 0 ? $email_option : get_bloginfo( 'admin_email' );
	$emails = array_map( 'trim', explode( "\n", $emails ) );

	return apply_filters( 'give_admin_notice_emails', $emails );
}

/**
 * Checks whether admin donation notices are disabled
 *
 * @since 1.0
 * @deprecated 2.0
 *
 * @param int $payment_id
 *
 * @return mixed
 */
function give_admin_notices_disabled( $payment_id = 0 ) {

	return apply_filters(
		'give_admin_notices_disabled',
		! give_is_setting_enabled( give_get_option( 'new-donation_notification' ) ),
		$payment_id
	);
}

/**
 * Get default donation notification email text
 *
 * Returns the stored email text if available, the standard email text if not
 *
 * @since  1.0
 * @return string $message
 */
function give_get_default_donation_notification_email() {

	$default_email_body = esc_html__( 'Hi there,', 'give' ) . "\n\n";
	$default_email_body .= esc_html__( 'This email is to inform you that a new donation has been made on your website:', 'give' ) . ' <a href="' . get_bloginfo( 'url' ) . '" target="_blank">' . get_bloginfo( 'url' ) . '</a>' . ".\n\n";
	$default_email_body .= '<strong>' . esc_html__( 'Donor:', 'give' ) . '</strong> {name}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Donation:', 'give' ) . '</strong> {donation}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Amount:', 'give' ) . '</strong> {amount}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Payment Method:', 'give' ) . '</strong> {payment_method}' . "\n\n";
	$default_email_body .= esc_html__( 'Thank you,', 'give' ) . "\n\n";
	$default_email_body .= '{sitename}' . "\n";

	return apply_filters( 'give_default_donation_notification_email', $default_email_body );
}


/**
 * Get default donation receipt email text
 *
 * Returns the stored email text if available, the standard email text if not
 *
 * @since  1.3.7
 * @return string $message
 */
function give_get_default_donation_receipt_email() {

	$default_email_body = esc_html__( 'Dear', 'give' ) . " {name},\n\n";
	$default_email_body .= esc_html__( 'Thank you for your donation. Your generosity is appreciated! Here are the details of your donation:', 'give' ) . "\n\n";
	$default_email_body .= '<strong>' . esc_html__( 'Donor:', 'give' ) . '</strong> {fullname}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Donation:', 'give' ) . '</strong> {donation}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Donation Date:', 'give' ) . '</strong> {date}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Amount:', 'give' ) . '</strong> {amount}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Payment Method:', 'give' ) . '</strong> {payment_method}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Payment ID:', 'give' ) . '</strong> {payment_id}' . "\n";
	$default_email_body .= '<strong>' . esc_html__( 'Receipt ID:', 'give' ) . '</strong> {receipt_id}' . "\n\n";
	$default_email_body .= '{receipt_link}' . "\n\n";
	$default_email_body .= "\n\n";
	$default_email_body .= esc_html__( 'Sincerely,', 'give' ) . "\n";
	$default_email_body .= '{sitename}' . "\n";

	return apply_filters( 'give_default_donation_receipt_email', $default_email_body );
}

/**
 * Get various correctly formatted names used in emails
 *
 * @since 1.0
 *
 * @param $user_info
 *
 * @return array $email_names
 */
function give_get_email_names( $user_info ) {
	$email_names = array();
	$user_info   = maybe_unserialize( $user_info );

	$email_names['fullname'] = '';
	if ( isset( $user_info['id'] ) && $user_info['id'] > 0 && isset( $user_info['first_name'] ) ) {
		$user_data               = get_userdata( $user_info['id'] );
		$email_names['name']     = $user_info['first_name'];
		$email_names['fullname'] = $user_info['first_name'] . ' ' . $user_info['last_name'];
		$email_names['username'] = $user_data->user_login;
	} elseif ( isset( $user_info['first_name'] ) ) {
		$email_names['name']     = $user_info['first_name'];
		$email_names['fullname'] = $user_info['first_name'] . ' ' . $user_info['last_name'];
		$email_names['username'] = $user_info['first_name'];
	} else {
		$email_names['name']     = $user_info['email'];
		$email_names['username'] = $user_info['email'];
	}

	return $email_names;
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-08 11:11 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 29 and the first side effect is on line 14. 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			* Email Functions
4			*
5			* @package Give
6			* @subpackage Emails
7			* @copyright Copyright (c) 2016, WordImpress
8			* @license https://opensource.org/licenses/gpl-license GNU Public License
9			* @since 1.0
10			*/
11
12			// Exit if accessed directly.
13			if ( ! defined( 'ABSPATH' ) ) {
14			exit;
15			}
16
17			/**
18			* Email Donation Receipt.
19			*
20			* Email the donation confirmation to the donor via the customizable "Donation Receipt" settings.
21			*
22			* @since 1.0
23			*
24			* @param int $payment_id Payment ID.
25			* @param bool $admin_notice Whether to send the admin email notification or not (default: true).
26			*
27			* @return void
28			*/
29			function give_email_donation_receipt( $payment_id, $admin_notice = true ) {
30			$payment = new Give_Payment( $payment_id );
31			/**
32			* Fire the action
33			*/
34			do_action( 'give_donation-receipt_email_notification', $payment_id );
35
36			//If admin notifications are on, send the admin notice.
37			if ( $admin_notice && ! give_admin_notices_disabled( $payment_id ) ) {
			0 ignored issues – show Deprecated Code introduced 2017-05-11 08:57 UTC by Report Bug Copy Issue Report The function `give_admin_notices_disabled()` has been deprecated with message: 2.0 This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
38			/**
39			* Fires in the donation email receipt.
40			*
41			* When admin email notices are not disabled, you can add new email notices.
42			*
43			* @since 1.0
44			*
45			* @param int $payment_id Payment id.
46			* @param mixed $payment_data Payment meta data.
47			*/
48			do_action( 'give_new-donation_email_notification', $payment_id, $payment->payment_meta );
49			}
50			}
51
52			/**
53			* Sends the Admin Sale Notification Email
54			*
55			* @since 1.0
56			*
57			* @param int $payment_id Payment ID (default: 0)
58			*
59			* @return void
60			*/
61			function give_admin_email_notice( $payment_id ) {
62			/**
63			* Fires in the donation email receipt.
64			*
65			* When admin email notices are not disabled, you can add new email notices.
66			*
67			* @since 1.0
68			*
69			* @param int $payment_id Payment id.
70			* @param mixed $payment_data Payment meta data.
71			*/
72			do_action( 'give_new-donation_email_notification', $payment_id );
73			}
74
75			add_action( 'give_admin_donation_email', 'give_admin_email_notice' );
76
77			/**
78			* Retrieves the emails for which admin notifications are sent to (these can be changed in the Give Settings).
79			*
80			* @since 1.0
81			* @deprecated 2.0
82			*
83			* @return mixed
84			*/
85			function give_get_admin_notice_emails() {
86
87			$email_option = give_get_option( 'admin_notice_emails' );
88
89			$emails = ! empty( $email_option ) && strlen( trim( $email_option ) ) > 0 ? $email_option : get_bloginfo( 'admin_email' );
90			$emails = array_map( 'trim', explode( "\n", $emails ) );
91
92			return apply_filters( 'give_admin_notice_emails', $emails );
93			}
94
95			/**
96			* Checks whether admin donation notices are disabled
97			*
98			* @since 1.0
99			* @deprecated 2.0
100			*
101			* @param int $payment_id
102			*
103			* @return mixed
104			*/
105			function give_admin_notices_disabled( $payment_id = 0 ) {
106
107			return apply_filters(
108			'give_admin_notices_disabled',
109			! give_is_setting_enabled( give_get_option( 'new-donation_notification' ) ),
110			$payment_id
111			);
112			}
113
114			/**
115			* Get default donation notification email text
116			*
117			* Returns the stored email text if available, the standard email text if not
118			*
119			* @since 1.0
120			* @return string $message
121			*/
122			function give_get_default_donation_notification_email() {
123
124			$default_email_body = esc_html__( 'Hi there,', 'give' ) . "\n\n";
125			$default_email_body .= esc_html__( 'This email is to inform you that a new donation has been made on your website:', 'give' ) . ' <a href="' . get_bloginfo( 'url' ) . '" target="_blank">' . get_bloginfo( 'url' ) . '</a>' . ".\n\n";
126			$default_email_body .= '<strong>' . esc_html__( 'Donor:', 'give' ) . '</strong> {name}' . "\n";
127			$default_email_body .= '<strong>' . esc_html__( 'Donation:', 'give' ) . '</strong> {donation}' . "\n";
128			$default_email_body .= '<strong>' . esc_html__( 'Amount:', 'give' ) . '</strong> {amount}' . "\n";
129			$default_email_body .= '<strong>' . esc_html__( 'Payment Method:', 'give' ) . '</strong> {payment_method}' . "\n\n";
130			$default_email_body .= esc_html__( 'Thank you,', 'give' ) . "\n\n";
131			$default_email_body .= '{sitename}' . "\n";
132
133			return apply_filters( 'give_default_donation_notification_email', $default_email_body );
134			}
135
136
137			/**
138			* Get default donation receipt email text
139			*
140			* Returns the stored email text if available, the standard email text if not
141			*
142			* @since 1.3.7
143			* @return string $message
144			*/
145			function give_get_default_donation_receipt_email() {
146
147			$default_email_body = esc_html__( 'Dear', 'give' ) . " {name},\n\n";
148			$default_email_body .= esc_html__( 'Thank you for your donation. Your generosity is appreciated! Here are the details of your donation:', 'give' ) . "\n\n";
149			$default_email_body .= '<strong>' . esc_html__( 'Donor:', 'give' ) . '</strong> {fullname}' . "\n";
150			$default_email_body .= '<strong>' . esc_html__( 'Donation:', 'give' ) . '</strong> {donation}' . "\n";
151			$default_email_body .= '<strong>' . esc_html__( 'Donation Date:', 'give' ) . '</strong> {date}' . "\n";
152			$default_email_body .= '<strong>' . esc_html__( 'Amount:', 'give' ) . '</strong> {amount}' . "\n";
153			$default_email_body .= '<strong>' . esc_html__( 'Payment Method:', 'give' ) . '</strong> {payment_method}' . "\n";
154			$default_email_body .= '<strong>' . esc_html__( 'Payment ID:', 'give' ) . '</strong> {payment_id}' . "\n";
155			$default_email_body .= '<strong>' . esc_html__( 'Receipt ID:', 'give' ) . '</strong> {receipt_id}' . "\n\n";
156			$default_email_body .= '{receipt_link}' . "\n\n";
157			$default_email_body .= "\n\n";
158			$default_email_body .= esc_html__( 'Sincerely,', 'give' ) . "\n";
159			$default_email_body .= '{sitename}' . "\n";
160
161			return apply_filters( 'give_default_donation_receipt_email', $default_email_body );
162			}
163
164			/**
165			* Get various correctly formatted names used in emails
166			*
167			* @since 1.0
168			*
169			* @param $user_info
170			*
171			* @return array $email_names
172			*/
173			function give_get_email_names( $user_info ) {
174			$email_names = array();
175			$user_info = maybe_unserialize( $user_info );
176
177			$email_names['fullname'] = '';
178			if ( isset( $user_info['id'] ) && $user_info['id'] > 0 && isset( $user_info['first_name'] ) ) {
179			$user_data = get_userdata( $user_info['id'] );
180			$email_names['name'] = $user_info['first_name'];
181			$email_names['fullname'] = $user_info['first_name'] . ' ' . $user_info['last_name'];
182			$email_names['username'] = $user_data->user_login;
183			} elseif ( isset( $user_info['first_name'] ) ) {
184			$email_names['name'] = $user_info['first_name'];
185			$email_names['fullname'] = $user_info['first_name'] . ' ' . $user_info['last_name'];
186			$email_names['username'] = $user_info['first_name'];
187			} else {
188			$email_names['name'] = $user_info['email'];
189			$email_names['username'] = $user_info['email'];
190			}
191
192			return $email_names;
193			}
194

ravinderk / Give

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

functions.php ➔ give_email_test_donation_receipt() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like