WordImpress / Give

includes/emails/class-give-email-tags.php

Spacing +94 added lines, -94 removed lines

@@ -23,7 +23,7 @@ 
  */
 
 // Exit if accessed directly
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -54,9 +54,9 @@ 
 	 * @param string $tag Email tag to be replace in email
 	 * @param callable $func Hook to run when email tag is found
 	 */
-	public function add( $tag, $description, $func ) {
-		if ( is_callable( $func ) ) {
-			$this->tags[ $tag ] = array(
+	public function add($tag, $description, $func) {
+		if (is_callable($func)) {
+			$this->tags[$tag] = array(
 				'tag'         => $tag,
 				'description' => $description,
 				'func'        => $func
@@ -71,8 +71,8 @@ 
 	 *
 	 * @param string $tag Email tag to remove hook from
 	 */
-	public function remove( $tag ) {
-		unset( $this->tags[ $tag ] );
+	public function remove($tag) {
+		unset($this->tags[$tag]);
 	}
 
 	/**
@@ -84,8 +84,8 @@ 
 	 *
 	 * @return bool
 	 */
-	public function email_tag_exists( $tag ) {
-		return array_key_exists( $tag, $this->tags );
+	public function email_tag_exists($tag) {
+		return array_key_exists($tag, $this->tags);
 	}
 
 	/**
@@ -109,16 +109,16 @@ 
 	 *
 	 * @return string Content with email tags filtered out.
 	 */
-	public function do_tags( $content, $payment_id ) {
+	public function do_tags($content, $payment_id) {
 
 		// Check if there is atleast one tag added
-		if ( empty( $this->tags ) || ! is_array( $this->tags ) ) {
+		if (empty($this->tags) || ! is_array($this->tags)) {
 			return $content;
 		}
 
 		$this->payment_id = $payment_id;
 
-		$new_content = preg_replace_callback( "/{([A-z0-9\-\_]+)}/s", array( $this, 'do_tag' ), $content );
+		$new_content = preg_replace_callback("/{([A-z0-9\-\_]+)}/s", array($this, 'do_tag'), $content);
 
 		$this->payment_id = null;
 
@@ -134,17 +134,17 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function do_tag( $m ) {
+	public function do_tag($m) {
 
 		// Get tag
 		$tag = $m[1];
 
 		// Return tag if tag not set
-		if ( ! $this->email_tag_exists( $tag ) ) {
+		if ( ! $this->email_tag_exists($tag)) {
 			return $m[0];
 		}
 
-		return call_user_func( $this->tags[ $tag ]['func'], $this->payment_id, $tag );
+		return call_user_func($this->tags[$tag]['func'], $this->payment_id, $tag);
 	}
 
 }
@@ -158,8 +158,8 @@ 
  * @param string $description Description of the email tag added
  * @param callable $func Hook to run when email tag is found
  */
-function give_add_email_tag( $tag, $description, $func ) {
-	Give()->email_tags->add( $tag, $description, $func );
+function give_add_email_tag($tag, $description, $func) {
+	Give()->email_tags->add($tag, $description, $func);
 }
 
 /**
@@ -169,8 +169,8 @@ 
  *
  * @param string $tag Email tag to remove hook from
  */
-function give_remove_email_tag( $tag ) {
-	Give()->email_tags->remove( $tag );
+function give_remove_email_tag($tag) {
+	Give()->email_tags->remove($tag);
 }
 
 /**
@@ -182,8 +182,8 @@ 
  *
  * @return bool
  */
-function give_email_tag_exists( $tag ) {
-	return Give()->email_tags->email_tag_exists( $tag );
+function give_email_tag_exists($tag) {
+	return Give()->email_tags->email_tag_exists($tag);
 }
 
 /**
@@ -212,13 +212,13 @@ 
 	$email_tags = give_get_email_tags();
 
 	// Check
-	if ( count( $email_tags ) > 0 ) {
+	if (count($email_tags) > 0) {
 
 		// Loop
-		foreach ( $email_tags as $email_tag ) {
+		foreach ($email_tags as $email_tag) {
 
 			// Add email tag to list
-			$list .= '<code>{' . $email_tag['tag'] . '}</code> - ' . $email_tag['description'] . '<br/>';
+			$list .= '<code>{'.$email_tag['tag'].'}</code> - '.$email_tag['description'].'<br/>';
 
 		}
 
@@ -238,13 +238,13 @@ 
  *
  * @return string Content with email tags filtered out.
  */
-function give_do_email_tags( $content, $payment_id ) {
+function give_do_email_tags($content, $payment_id) {
 
 	// Replace all tags
-	$content = Give()->email_tags->do_tags( $content, $payment_id );
+	$content = Give()->email_tags->do_tags($content, $payment_id);
 
 	// Maintaining backwards compatibility
-	$content = apply_filters( 'give_email_template_tags', $content, give_get_payment_meta( $payment_id ), $payment_id );
+	$content = apply_filters('give_email_template_tags', $content, give_get_payment_meta($payment_id), $payment_id);
 
 	// Return content
 	return $content;
@@ -256,10 +256,10 @@ 
  * @since 1.0
  */
 function give_load_email_tags() {
-	do_action( 'give_add_email_tags' );
+	do_action('give_add_email_tags');
 }
 
-add_action( 'init', 'give_load_email_tags', - 999 );
+add_action('init', 'give_load_email_tags', - 999);
 
 /**
  * Add default Give email template tags.
@@ -272,82 +272,82 @@ 
 	$email_tags = array(
 		array(
 			'tag'         => 'donation',
-			'description' => esc_html__( 'The donation form name, and the donation level (if applicable).', 'give' ),
+			'description' => esc_html__('The donation form name, and the donation level (if applicable).', 'give'),
 			'function'    => 'give_email_tag_donation'
 		),
 		array(
 			'tag'         => 'name',
-			'description' => esc_html__( 'The donor\'s first name.', 'give' ),
+			'description' => esc_html__('The donor\'s first name.', 'give'),
 			'function'    => 'give_email_tag_first_name'
 		),
 		array(
 			'tag'         => 'fullname',
-			'description' => esc_html__( 'The donor\'s full name, first and last.', 'give' ),
+			'description' => esc_html__('The donor\'s full name, first and last.', 'give'),
 			'function'    => 'give_email_tag_fullname'
 		),
 		array(
 			'tag'         => 'username',
-			'description' => esc_html__( 'The donor\'s user name on the site, if they registered an account.', 'give' ),
+			'description' => esc_html__('The donor\'s user name on the site, if they registered an account.', 'give'),
 			'function'    => 'give_email_tag_username'
 		),
 		array(
 			'tag'         => 'user_email',
-			'description' => esc_html__( 'The donor\'s email address.', 'give' ),
+			'description' => esc_html__('The donor\'s email address.', 'give'),
 			'function'    => 'give_email_tag_user_email'
 		),
 		array(
 			'tag'         => 'billing_address',
-			'description' => esc_html__( 'The donor\'s billing address.', 'give' ),
+			'description' => esc_html__('The donor\'s billing address.', 'give'),
 			'function'    => 'give_email_tag_billing_address'
 		),
 		array(
 			'tag'         => 'date',
-			'description' => esc_html__( 'The date of the donation.', 'give' ),
+			'description' => esc_html__('The date of the donation.', 'give'),
 			'function'    => 'give_email_tag_date'
 		),
 		array(
 			'tag'         => 'price',
-			'description' => esc_html__( 'The total price of the donation.', 'give' ),
+			'description' => esc_html__('The total price of the donation.', 'give'),
 			'function'    => 'give_email_tag_price'
 		),
 		array(
 			'tag'         => 'payment_id',
-			'description' => esc_html__( 'The unique ID number for this donation.', 'give' ),
+			'description' => esc_html__('The unique ID number for this donation.', 'give'),
 			'function'    => 'give_email_tag_payment_id'
 		),
 		array(
 			'tag'         => 'receipt_id',
-			'description' => esc_html__( 'The unique ID number for this donation receipt.', 'give' ),
+			'description' => esc_html__('The unique ID number for this donation receipt.', 'give'),
 			'function'    => 'give_email_tag_receipt_id'
 		),
 		array(
 			'tag'         => 'payment_method',
-			'description' => esc_html__( 'The method of payment used for this donation.', 'give' ),
+			'description' => esc_html__('The method of payment used for this donation.', 'give'),
 			'function'    => 'give_email_tag_payment_method'
 		),
 		array(
 			'tag'         => 'sitename',
-			'description' => esc_html__( 'Your site name', 'give' ),
+			'description' => esc_html__('Your site name', 'give'),
 			'function'    => 'give_email_tag_sitename'
 		),
 		array(
 			'tag'         => 'receipt_link',
-			'description' => esc_html__( 'Adds a link so users can view their receipt directly on your website if they are unable to view it in the browser correctly.', 'give' ),
+			'description' => esc_html__('Adds a link so users can view their receipt directly on your website if they are unable to view it in the browser correctly.', 'give'),
 			'function'    => 'give_email_tag_receipt_link'
 		),
 	);
 
 	// Apply give_email_tags filter
-	$email_tags = apply_filters( 'give_email_tags', $email_tags );
+	$email_tags = apply_filters('give_email_tags', $email_tags);
 
 	// Add email tags
-	foreach ( $email_tags as $email_tag ) {
-		give_add_email_tag( $email_tag['tag'], $email_tag['description'], $email_tag['function'] );
+	foreach ($email_tags as $email_tag) {
+		give_add_email_tag($email_tag['tag'], $email_tag['description'], $email_tag['function']);
 	}
 
 }
 
-add_action( 'give_add_email_tags', 'give_setup_email_tags' );
+add_action('give_add_email_tags', 'give_setup_email_tags');
 
 
 /**
@@ -359,15 +359,15 @@ 
  *
  * @return string name
  */
-function give_email_tag_first_name( $payment_id ) {
-	$payment   = new Give_Payment( $payment_id );
+function give_email_tag_first_name($payment_id) {
+	$payment   = new Give_Payment($payment_id);
 	$user_info = $payment->user_info;
 
-	if ( empty( $user_info ) ) {
+	if (empty($user_info)) {
 		return '';
 	}
 
-	$email_name = give_get_email_names( $user_info );
+	$email_name = give_get_email_names($user_info);
 
 	return $email_name['name'];
 }
@@ -381,15 +381,15 @@ 
  *
  * @return string fullname
  */
-function give_email_tag_fullname( $payment_id ) {
-	$payment   = new Give_Payment( $payment_id );
+function give_email_tag_fullname($payment_id) {
+	$payment   = new Give_Payment($payment_id);
 	$user_info = $payment->user_info;
 
-	if ( empty( $user_info ) ) {
+	if (empty($user_info)) {
 		return '';
 	}
 
-	$email_name = give_get_email_names( $user_info );
+	$email_name = give_get_email_names($user_info);
 
 	return $email_name['fullname'];
 }
@@ -402,15 +402,15 @@ 
  *
  * @return string username.
  */
-function give_email_tag_username( $payment_id ) {
-	$payment   = new Give_Payment( $payment_id );
+function give_email_tag_username($payment_id) {
+	$payment   = new Give_Payment($payment_id);
 	$user_info = $payment->user_info;
 
-	if ( empty( $user_info ) ) {
+	if (empty($user_info)) {
 		return '';
 	}
 
-	$email_name = give_get_email_names( $user_info );
+	$email_name = give_get_email_names($user_info);
 
 	return $email_name['username'];
 }
@@ -423,8 +423,8 @@ 
  *
  * @return string user_email
  */
-function give_email_tag_user_email( $payment_id ) {
-	$payment = new Give_Payment( $payment_id );
+function give_email_tag_user_email($payment_id) {
+	$payment = new Give_Payment($payment_id);
 
 	return $payment->email;
 }
@@ -437,10 +437,10 @@ 
  *
  * @return string billing_address
  */
-function give_email_tag_billing_address( $payment_id ) {
+function give_email_tag_billing_address($payment_id) {
 
-	$user_info    = give_get_payment_meta_user_info( $payment_id );
-	$user_address = ! empty( $user_info['address'] ) ? $user_info['address'] : array(
+	$user_info    = give_get_payment_meta_user_info($payment_id);
+	$user_address = ! empty($user_info['address']) ? $user_info['address'] : array(
 		'line1'   => '',
 		'line2'   => '',
 		'city'    => '',
@@ -449,11 +449,11 @@ 
 		'zip'     => ''
 	);
 
-	$return = $user_address['line1'] . "\n";
-	if ( ! empty( $user_address['line2'] ) ) {
-		$return .= $user_address['line2'] . "\n";
+	$return = $user_address['line1']."\n";
+	if ( ! empty($user_address['line2'])) {
+		$return .= $user_address['line2']."\n";
 	}
-	$return .= $user_address['city'] . ' ' . $user_address['zip'] . ' ' . $user_address['state'] . "\n";
+	$return .= $user_address['city'].' '.$user_address['zip'].' '.$user_address['state']."\n";
 	$return .= $user_address['country'];
 
 	return $return;
@@ -467,10 +467,10 @@ 
  *
  * @return string date
  */
-function give_email_tag_date( $payment_id ) {
-	$payment = new Give_Payment( $payment_id );
+function give_email_tag_date($payment_id) {
+	$payment = new Give_Payment($payment_id);
 
-	return date_i18n( get_option( 'date_format' ), strtotime( $payment->date ) );
+	return date_i18n(get_option('date_format'), strtotime($payment->date));
 }
 
 /**
@@ -481,11 +481,11 @@ 
  *
  * @return string price
  */
-function give_email_tag_price( $payment_id ) {
-	$payment = new Give_Payment( $payment_id );
-	$price   = give_currency_filter( give_format_amount( $payment->total ), $payment->currency );
+function give_email_tag_price($payment_id) {
+	$payment = new Give_Payment($payment_id);
+	$price   = give_currency_filter(give_format_amount($payment->total), $payment->currency);
 
-	return html_entity_decode( $price, ENT_COMPAT, 'UTF-8' );
+	return html_entity_decode($price, ENT_COMPAT, 'UTF-8');
 }
 
 /**
@@ -496,8 +496,8 @@ 
  *
  * @return int payment_id
  */
-function give_email_tag_payment_id( $payment_id ) {
-	$payment = new Give_Payment( $payment_id );
+function give_email_tag_payment_id($payment_id) {
+	$payment = new Give_Payment($payment_id);
 
 	return $payment->number;
 }
@@ -510,8 +510,8 @@ 
  *
  * @return string receipt_id
  */
-function give_email_tag_receipt_id( $payment_id ) {
-	$payment = new Give_Payment( $payment_id );
+function give_email_tag_receipt_id($payment_id) {
+	$payment = new Give_Payment($payment_id);
 
 	return $payment->key;
 }
@@ -525,14 +525,14 @@ 
  *
  * @return string $form_title
  */
-function give_email_tag_donation( $payment_id ) {
-	$payment      = new Give_Payment( $payment_id );
+function give_email_tag_donation($payment_id) {
+	$payment      = new Give_Payment($payment_id);
 	$payment_meta = $payment->meta;
-	$level_title  = give_has_variable_prices( $payment_meta['form_id'] );
+	$level_title  = give_has_variable_prices($payment_meta['form_id']);
 	$separator    = $level_title ? '-' : '';
-	$form_title   = strip_tags( give_get_payment_form_title( $payment_meta, $level_title, $separator ) );
+	$form_title   = strip_tags(give_get_payment_form_title($payment_meta, $level_title, $separator));
 
-	return ! empty( $form_title ) ? $form_title : esc_html__( 'There was an error retrieving the donation form name.', 'give' );
+	return ! empty($form_title) ? $form_title : esc_html__('There was an error retrieving the donation form name.', 'give');
 
 }
 
@@ -545,10 +545,10 @@ 
  *
  * @return string gateway
  */
-function give_email_tag_payment_method( $payment_id ) {
-	$payment = new Give_Payment( $payment_id );
+function give_email_tag_payment_method($payment_id) {
+	$payment = new Give_Payment($payment_id);
 
-	return give_get_gateway_checkout_label( $payment->gateway );
+	return give_get_gateway_checkout_label($payment->gateway);
 }
 
 /**
@@ -560,8 +560,8 @@ 
  *
  * @return string sitename
  */
-function give_email_tag_sitename( $payment_id ) {
-	return wp_specialchars_decode( get_bloginfo( 'name' ), ENT_QUOTES );
+function give_email_tag_sitename($payment_id) {
+	return wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
 }
 
 /**
@@ -573,19 +573,19 @@ 
  *
  * @return string receipt_link
  */
-function give_email_tag_receipt_link( $payment_id ) {
+function give_email_tag_receipt_link($payment_id) {
 
-	$receipt_url = esc_url( add_query_arg( array(
-		'payment_key' => give_get_payment_key( $payment_id ),
+	$receipt_url = esc_url(add_query_arg(array(
+		'payment_key' => give_get_payment_key($payment_id),
 		'give_action' => 'view_receipt'
-	), home_url() ) );
-	$formatted   = sprintf(
+	), home_url()));
+	$formatted = sprintf(
 		'<a href="%1$s">%2$s</a>',
 		$receipt_url,
-		esc_html__( 'View it in your browser', 'give' )
+		esc_html__('View it in your browser', 'give')
 	);
 
-	if ( give_get_option( 'email_template' ) !== 'none' ) {
+	if (give_get_option('email_template') !== 'none') {
 		return $formatted;
 	} else {
 		return $receipt_url;