template.php ➔ give_get_preview_email_header() - Code Metrics - Inspection of "Fix #2560" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — release/2.0 ( 6ea777...f7bd0b )

by Ravinder

created 2017-12-22 04:43 UTC

template.php ➔ give_get_preview_email_header() B

↳ Parent: Project

Complexity

Conditions	5
Paths	5

Size

Total Lines	79
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	36
nc	5
nop	0
dl	0
loc	79
rs	8.4178
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * Email Template
 *
 * @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;
}

/**
 * Gets all the email templates that have been registered. The list is extendable
 * and more templates can be added.
 *
 * This is simply a wrapper to Give_Email_Templates->get_templates()
 *
 * @since 1.0
 * @return array $templates All the registered email templates.
 */
function give_get_email_templates() {
	$templates = new Give_Emails;

	return $templates->get_templates();
}

/**
 * Email Template Tags.
 * @todo Modify this function to remove payment id dependency.
 *
 * @since 1.0
 *
 * @param string $message      Message with the template tags.
 * @param array  $payment_data Payment Data.
 * @param int    $payment_id   Payment ID.
 * @param bool   $admin_notice Whether or not this is a notification email.
 *
 * @return string $message Fully formatted message
 */
function give_email_template_tags( $message, $payment_data, $payment_id, $admin_notice = false ) {

	return give_do_email_tags( $message, $payment_id );
}

/**
 * Email Preview Template Tags.
 *
 * Provides sample content for the preview email functionality within settings > email.
 *
 * @since 1.0
 *
 * @param string $message Email message with template tags
 *
 * @return string $message Fully formatted message
 */
function give_email_preview_template_tags( $message ) {

	$price = give_currency_filter( give_format_amount( 10.50, array( 'sanitize' => false ) ) );

	$gateway = 'PayPal';

	$receipt_id = strtolower( md5( uniqid() ) );

	$payment_id = rand( 1, 100 );
	$receipt_link_url = esc_url( add_query_arg( array( 'payment_key' => $receipt_id ), give_get_history_page_uri() ) );

	$receipt_link     = sprintf(
		'<a href="%1$s">%2$s</a>',
		$receipt_link_url,
		esc_html__( 'View the receipt in your browser &raquo;', 'give' )
	);

	// Set user.
	$user = wp_get_current_user();

	$message = str_replace( '{name}', $user->display_name, $message );
	$message = str_replace( '{fullname}', $user->display_name, $message );
	$message = str_replace( '{username}', $user->user_login, $message );
	$message = str_replace( '{user_email}', $user->user_email, $message );
	$message = str_replace( '{billing_address}', "123 Test Street, Unit 222\nSomewhere Town, CA, 92101", $message );
	$message = str_replace( '{date}', date( give_date_format(), current_time( 'timestamp' ) ), $message );
	$message = str_replace( '{amount}', $price, $message );
	$message = str_replace( '{price}', $price, $message );
	$message = str_replace( '{donation}', esc_html__( 'Sample Donation Form Title', 'give' ), $message );
	$message = str_replace( '{form_title}', esc_html__( 'Sample Donation Form Title - Sample Donation Level', 'give' ), $message );
	$message = str_replace( '{receipt_id}', $receipt_id, $message );
	$message = str_replace( '{payment_method}', $gateway, $message );
	$message = str_replace( '{sitename}', get_bloginfo( 'name' ), $message );
	$message = str_replace( '{payment_id}', $payment_id, $message );
	$message = str_replace( '{receipt_link}', $receipt_link, $message );
	$message = str_replace( '{receipt_link_url}', $receipt_link_url, $message );
	$message = str_replace( '{pdf_receipt}', '<a href="#">Download Receipt</a>', $message );

	return wpautop( apply_filters( 'give_email_preview_template_tags', $message ) );
}



/**
 * Output Email Template Preview Buttons.
 *
 * @access private
 * @since  1.0
 * @since  1.8 Field arguments param added.
 *
 * @param array $field Field arguments.
 *
 * @return array
 */
function give_email_preview_buttons_callback( $field ) {
	$field_id = str_replace( '_preview_buttons', '', $field['id'] );

	ob_start();

	echo sprintf(

		'<a href="%1$s" class="button-secondary" target="_blank">%2$s</a>',
		wp_nonce_url(
			add_query_arg(
				array( 'give_action' => 'preview_email', 'email_type' => $field_id ),
				home_url()
			), 'give-preview-email'
		),
		$field['name']
	);

	echo sprintf(

		' <a href="%1$s" aria-label="%2$s" class="button-secondary">%3$s</a>',
		wp_nonce_url(
				add_query_arg( array(

			'give_action'  => 'send_preview_email',

			'email_type' => $field_id,

			'give-message' => 'sent-test-email',

		) ), 'give-send-preview-email' ),

		esc_attr__( 'Send Test Email.', 'give' ),
		esc_html__( 'Send Test Email', 'give' )
	);

	echo ob_get_clean();

}


/**
 * Give Preview Email Header.
 *
 * Displays a header bar with the ability to change donations to preview actual data within the preview. Will not display if
 *
 * @since 1.6
 *
 */
function give_get_preview_email_header() {

	//Payment receipt switcher
	$payment_count = give_count_payments()->publish;
	$payment_id    = give_check_variable( give_clean( $_GET ), 'isset', 0, 'preview_id' );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

	if ( $payment_count <= 0 ) {
		return false;
	}

	//Get payments.
	$payments = new Give_Payments_Query( array(
		'number' => 100,
	) );
	$payments = $payments->get_payments();
	$options  = array();

	// Default option.
	$options[0] = esc_html__( 'No donations found.', 'give' );

	//Provide nice human readable options.
	if ( $payments ) {

		$options[0] = esc_html__( '- Select a donation -', 'give' );
		foreach ( $payments as $payment ) {

			$options[ $payment->ID ] = esc_html( '#' . $payment->ID . ' - ' . $payment->email . ' - ' . $payment->form_title );

		}
	}

	//Start constructing HTML output.
	$transaction_header = '<div style="margin:0;padding:10px 0;width:100%;background-color:#FFF;border-bottom:1px solid #eee; text-align:center;">';

	//Inline JS function for switching donations.
	$request_url = $_SERVER['REQUEST_URI'];


	// Remove payment id query param if set from request url.
	if ( $payment_id ) {
		$request_url_data = wp_parse_url( $_SERVER['REQUEST_URI'] );

		$query            = $request_url_data['query'];
		$query            = str_replace( "&preview_id={$payment_id}", '', $query );

		$request_url = home_url( '/?' . str_replace( '', '', $query ) );
	}



	$transaction_header .= '<script>
				 function change_preview(){
				  var transactions = document.getElementById("give_preview_email_payment_id");
			        var selected_trans = transactions.options[transactions.selectedIndex];
				        console.log(selected_trans);
				        if (selected_trans){
				            var url_string = "' . $request_url . '&preview_id=" + selected_trans.value;
				                window.location = url_string;
				        }
				    }
			    </script>';

	$transaction_header .= '<label for="give_preview_email_payment_id" style="font-size:12px;color:#333;margin:0 4px 0 0;">' . esc_html__( 'Preview email with a donation:', 'give' ) . '</label>';

	//The select field with 100 latest transactions
	$transaction_header .= Give()->html->select( array(
		'name'             => 'preview_email_payment_id',
		'selected'         => $payment_id,
		'id'               => 'give_preview_email_payment_id',
		'class'            => 'give-preview-email-payment-id',
		'options'          => $options,
		'chosen'           => false,
		'select_atts'      => 'onchange="change_preview()"',
		'show_option_all'  => false,
		'show_option_none' => false,
	) );

	//Closing tag
	$transaction_header .= '</div>';

	return apply_filters( 'give_preview_email_receipt_header', $transaction_header );

}

1			<?php
2			/**
3			* Email Template
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			* Gets all the email templates that have been registered. The list is extendable
19			* and more templates can be added.
20			*
21			* This is simply a wrapper to Give_Email_Templates->get_templates()
22			*
23			* @since 1.0
24			* @return array $templates All the registered email templates.
25			*/
26			function give_get_email_templates() {
27			$templates = new Give_Emails;
28
29			return $templates->get_templates();
30			}
31
32			/**
33			* Email Template Tags.
34			* @todo Modify this function to remove payment id dependency.
35			*
36			* @since 1.0
37			*
38			* @param string $message Message with the template tags.
39			* @param array $payment_data Payment Data.
40			* @param int $payment_id Payment ID.
41			* @param bool $admin_notice Whether or not this is a notification email.
42			*
43			* @return string $message Fully formatted message
44			*/
45			function give_email_template_tags( $message, $payment_data, $payment_id, $admin_notice = false ) {
			0 ignored issues – show Unused Code introduced 2016-12-08 11:11 UTC by Report Bug Copy Issue Report The parameter `$payment_data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-12-08 11:11 UTC by Report Bug Copy Issue Report The parameter `$admin_notice` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
46			return give_do_email_tags( $message, $payment_id );
47			}
48
49			/**
50			* Email Preview Template Tags.
51			*
52			* Provides sample content for the preview email functionality within settings > email.
53			*
54			* @since 1.0
55			*
56			* @param string $message Email message with template tags
57			*
58			* @return string $message Fully formatted message
59			*/
60			function give_email_preview_template_tags( $message ) {
61
62			$price = give_currency_filter( give_format_amount( 10.50, array( 'sanitize' => false ) ) );
63
64			$gateway = 'PayPal';
65
66			$receipt_id = strtolower( md5( uniqid() ) );
67
68			$payment_id = rand( 1, 100 );
69			$receipt_link_url = esc_url( add_query_arg( array( 'payment_key' => $receipt_id ), give_get_history_page_uri() ) );
70
71			$receipt_link = sprintf(
72			'<a href="%1$s">%2$s</a>',
73			$receipt_link_url,
74			esc_html__( 'View the receipt in your browser »', 'give' )
75			);
76
77			// Set user.
78			$user = wp_get_current_user();
79
80			$message = str_replace( '{name}', $user->display_name, $message );
81			$message = str_replace( '{fullname}', $user->display_name, $message );
82			$message = str_replace( '{username}', $user->user_login, $message );
83			$message = str_replace( '{user_email}', $user->user_email, $message );
84			$message = str_replace( '{billing_address}', "123 Test Street, Unit 222\nSomewhere Town, CA, 92101", $message );
85			$message = str_replace( '{date}', date( give_date_format(), current_time( 'timestamp' ) ), $message );
86			$message = str_replace( '{amount}', $price, $message );
87			$message = str_replace( '{price}', $price, $message );
88			$message = str_replace( '{donation}', esc_html__( 'Sample Donation Form Title', 'give' ), $message );
89			$message = str_replace( '{form_title}', esc_html__( 'Sample Donation Form Title - Sample Donation Level', 'give' ), $message );
90			$message = str_replace( '{receipt_id}', $receipt_id, $message );
91			$message = str_replace( '{payment_method}', $gateway, $message );
92			$message = str_replace( '{sitename}', get_bloginfo( 'name' ), $message );
93			$message = str_replace( '{payment_id}', $payment_id, $message );
94			$message = str_replace( '{receipt_link}', $receipt_link, $message );
95			$message = str_replace( '{receipt_link_url}', $receipt_link_url, $message );
96			$message = str_replace( '{pdf_receipt}', '<a href="#">Download Receipt</a>', $message );
97
98			return wpautop( apply_filters( 'give_email_preview_template_tags', $message ) );
99			}
100
101
102
103			/**
104			* Output Email Template Preview Buttons.
105			*
106			* @access private
107			* @since 1.0
108			* @since 1.8 Field arguments param added.
109			*
110			* @param array $field Field arguments.
111			*
112			* @return array
113			*/
114			function give_email_preview_buttons_callback( $field ) {
115			$field_id = str_replace( '_preview_buttons', '', $field['id'] );
116
117			ob_start();
118
119			echo sprintf(
			0 ignored issues – show introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'sprintf' Loading history...
120			'<a href="%1$s" class="button-secondary" target="_blank">%2$s</a>',
121			wp_nonce_url(
122			add_query_arg(
123			array( 'give_action' => 'preview_email', 'email_type' => $field_id ),
124			home_url()
125			), 'give-preview-email'
126			),
127			$field['name']
128			);
129
130			echo sprintf(
			0 ignored issues – show introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'sprintf' Loading history...
131			' <a href="%1$s" aria-label="%2$s" class="button-secondary">%3$s</a>',
132			wp_nonce_url(
133			add_query_arg( array(
			0 ignored issues – show Coding Style introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `12` spaces, but found `16`. Loading history...
134			'give_action' => 'send_preview_email',
			0 ignored issues – show Coding Style introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `20` spaces, but found `12`. Loading history...
135			'email_type' => $field_id,
			0 ignored issues – show Coding Style introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `20` spaces, but found `12`. Loading history...
136			'give-message' => 'sent-test-email',
			0 ignored issues – show Coding Style introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `20` spaces, but found `12`. Loading history...
137			) ), 'give-send-preview-email' ),
			0 ignored issues – show Coding Style introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `16` spaces, but found `8`. Loading history...
138			esc_attr__( 'Send Test Email.', 'give' ),
139			esc_html__( 'Send Test Email', 'give' )
140			);
141
142			echo ob_get_clean();
			0 ignored issues – show introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'ob_get_clean' Loading history...
143			}
144
145
146			/**
147			* Give Preview Email Header.
148			*
149			* Displays a header bar with the ability to change donations to preview actual data within the preview. Will not display if
150			*
151			* @since 1.6
152			*
153			*/
154			function give_get_preview_email_header() {
155
156			//Payment receipt switcher
157			$payment_count = give_count_payments()->publish;
158			$payment_id = give_check_variable( give_clean( $_GET ), 'isset', 0, 'preview_id' );
			0 ignored issues – show Documentation introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report `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 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Detected access of super global var $_GET, probably need manual inspection. Loading history...
159
160			if ( $payment_count <= 0 ) {
161			return false;
162			}
163
164			//Get payments.
165			$payments = new Give_Payments_Query( array(
166			'number' => 100,
167			) );
168			$payments = $payments->get_payments();
169			$options = array();
170
171			// Default option.
172			$options[0] = esc_html__( 'No donations found.', 'give' );
173
174			//Provide nice human readable options.
175			if ( $payments ) {
			0 ignored issues – show Bug Best Practice introduced 2017-04-19 05:37 UTC by Report Bug Copy Issue Report The expression `$payments` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
176			$options[0] = esc_html__( '- Select a donation -', 'give' );
177			foreach ( $payments as $payment ) {
178
179			$options[ $payment->ID ] = esc_html( '#' . $payment->ID . ' - ' . $payment->email . ' - ' . $payment->form_title );
180
181			}
182			}
183
184			//Start constructing HTML output.
185			$transaction_header = '<div style="margin:0;padding:10px 0;width:100%;background-color:#FFF;border-bottom:1px solid #eee; text-align:center;">';
186
187			//Inline JS function for switching donations.
188			$request_url = $_SERVER['REQUEST_URI'];
			0 ignored issues – show introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Detected usage of a non-sanitized input variable: $_SERVER Loading history...
189
190			// Remove payment id query param if set from request url.
191			if ( $payment_id ) {
192			$request_url_data = wp_parse_url( $_SERVER['REQUEST_URI'] );
			0 ignored issues – show introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Detected usage of a non-validated input variable: $_SERVER Loading history... introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Detected usage of a non-sanitized input variable: $_SERVER Loading history...
193			$query = $request_url_data['query'];
194			$query = str_replace( "&preview_id={$payment_id}", '', $query );
195
196			$request_url = home_url( '/?' . str_replace( '', '', $query ) );
197			}
198
			0 ignored issues – show Coding Style introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
199
200			$transaction_header .= '<script>
201			function change_preview(){
202			var transactions = document.getElementById("give_preview_email_payment_id");
203			var selected_trans = transactions.options[transactions.selectedIndex];
204			console.log(selected_trans);
205			if (selected_trans){
206			var url_string = "' . $request_url . '&preview_id=" + selected_trans.value;
207			window.location = url_string;
208			}
209			}
210			</script>';
211
212			$transaction_header .= '<label for="give_preview_email_payment_id" style="font-size:12px;color:#333;margin:0 4px 0 0;">' . esc_html__( 'Preview email with a donation:', 'give' ) . '</label>';
213
214			//The select field with 100 latest transactions
215			$transaction_header .= Give()->html->select( array(
216			'name' => 'preview_email_payment_id',
217			'selected' => $payment_id,
218			'id' => 'give_preview_email_payment_id',
219			'class' => 'give-preview-email-payment-id',
220			'options' => $options,
221			'chosen' => false,
222			'select_atts' => 'onchange="change_preview()"',
223			'show_option_all' => false,
224			'show_option_none' => false,
225			) );
226
227			//Closing tag
228			$transaction_header .= '</div>';
229
230			return apply_filters( 'give_preview_email_receipt_header', $transaction_header );
231
232			}

ravinderk / Give

Push — release/2.0 ( 6ea777...f7bd0b )

template.php ➔ give_get_preview_email_header() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like