eventespresso / event-espresso-core

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Spacing +140 added lines, -140 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -42,25 +42,25 @@ 
 		$this->_shortcodes = array(
 			'[TXN_ID]' => __('The transaction id for the purchase.', 'event_espresso'),
 			'[PAYMENT_URL]' => __('This is a link to make a payment for the event', 'event_espresso'),
-			'[PAYMENT_LINK_IF_NEEDED_*]' => __('This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:', 'event_espresso') . '<ul>'
-				. '<li>' . sprintf( __('%class:%s This can be used to indicate css class is given to the containing css element (default is "callout").', 'event_espresso' ), '<strong>', '</strong>' ) . '</li>'
-				. '<li>' . sprintf( __('%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)', 'event_espresso' ), '<strong>', '</strong>' ) . '</li>'
-				. '<li>' . sprintf( __('%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").', 'event_espresso' ), '<strong>', '</strong>' ) . '</li>'
+			'[PAYMENT_LINK_IF_NEEDED_*]' => __('This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:', 'event_espresso').'<ul>'
+				. '<li>'.sprintf(__('%class:%s This can be used to indicate css class is given to the containing css element (default is "callout").', 'event_espresso'), '<strong>', '</strong>').'</li>'
+				. '<li>'.sprintf(__('%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)', 'event_espresso'), '<strong>', '</strong>').'</li>'
+				. '<li>'.sprintf(__('%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").', 'event_espresso'), '<strong>', '</strong>').'</li>'
 				. '</ul>',
-			'[PAYMENT_DUE_DATE_*]' => __( 'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:', 'event_espresso' )
+			'[PAYMENT_DUE_DATE_*]' => __('This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:', 'event_espresso')
 				. '<ul>'
-				. '<li>' . sprintf( __( '%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.', 'event_espresso' ), '<strong>', '</strong>' ) . '</li>'
-				. '<li>' . sprintf( __( '%days_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.', 'event_espresso' ), '<strong>', '</strong>' ) . '</li>'
-				. '<li>' . sprintf( __( '%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"', 'event_espresso' ), '<strong>', '</strong>' ) . '</li>',
+				. '<li>'.sprintf(__('%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.', 'event_espresso'), '<strong>', '</strong>').'</li>'
+				. '<li>'.sprintf(__('%days_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.', 'event_espresso'), '<strong>', '</strong>').'</li>'
+				. '<li>'.sprintf(__('%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"', 'event_espresso'), '<strong>', '</strong>').'</li>',
 			'[INVOICE_LINK]' => __('This is a full html link to the invoice', 'event_espresso'),
 			'[INVOICE_URL]' => __('This is just the url for the invoice', 'event_espresso'),
 			'[INVOICE_LOGO_URL]' => __('This returns the url for the logo uploaded via the invoice settings page.', 'event_espresso'),
 			'[INVOICE_LOGO]' => __('This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.', 'event_espresso'),
 			'[INVOICE_PAYEE_NAME]' => __('This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.', 'event_espresso'),
-			'[INVOICE_PAYEE_ADDRESS]' => __('This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.', 'event_espresso' ),
-			'[INVOICE_PAYMENT_INSTRUCTIONS]' => __('This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page', 'event_espresso' ),
-			'[INVOICE_PAYEE_EMAIL]' => __('This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.', 'event_espresso' ),
-			'[INVOICE_PAYEE_TAX_NUMBER_*]' => __('This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: <code>[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]</code> and that will ouptut: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.', 'event_espresso' ),
+			'[INVOICE_PAYEE_ADDRESS]' => __('This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.', 'event_espresso'),
+			'[INVOICE_PAYMENT_INSTRUCTIONS]' => __('This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page', 'event_espresso'),
+			'[INVOICE_PAYEE_EMAIL]' => __('This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.', 'event_espresso'),
+			'[INVOICE_PAYEE_TAX_NUMBER_*]' => __('This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: <code>[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]</code> and that will ouptut: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.', 'event_espresso'),
 			'[TOTAL_COST]' => __('The total cost for the transaction', 'event_espresso'),
 			'[TXN_STATUS]' => __('The transaction status for the transaction.', 'event_espresso'),
 			'[TXN_STATUS_ID]' => __('The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.', 'event_espresso'),
@@ -71,54 +71,54 @@ 
 			'[TOTAL_OWING]' => __('The total owing on a transaction with no attributes.', 'event_espresso'),
 			'[TXN_SUBTOTAL]' => __('The subtotal for all txn line items.', 'event_espresso'),
 			'[TXN_TAX_SUBTOTAL]' => __('The subtotal for all tax line items.', 'event_espresso'),
-			'[OWING_STATUS_MESSAGE_*]' => __('A dynamic shortcode for adjusting how total oweing gets shown. The acceptable attributes on the shortcode are:', 'event_espresso') . '<p></ul>' .
-				'<li><strong>still_owing</strong>:' . __('If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount oweing). The default is:', 'event_espresso' ) . sprintf( __( '%sPlease make a payment.%s', 'event_espresso'),  '<a href="[PAYMENT_URL]" class="noPrint">', '</a>' ) . '</li>' .
-				'<li><strong>none_owing</strong>:' . __('If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total oweing.', 'event_espresso') . '</li></ul></p>',
+			'[OWING_STATUS_MESSAGE_*]' => __('A dynamic shortcode for adjusting how total oweing gets shown. The acceptable attributes on the shortcode are:', 'event_espresso').'<p></ul>'.
+				'<li><strong>still_owing</strong>:'.__('If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount oweing). The default is:', 'event_espresso').sprintf(__('%sPlease make a payment.%s', 'event_espresso'), '<a href="[PAYMENT_URL]" class="noPrint">', '</a>').'</li>'.
+				'<li><strong>none_owing</strong>:'.__('If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total oweing.', 'event_espresso').'</li></ul></p>',
 			'[TXN_TOTAL_TICKETS]' => __('The total number of all tickets purchased in a transaction', 'event_espresso'),
 			'[TKT_QTY_PURCHASED]' => __('The total number of all tickets purchased in a transaction. <strong>NOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.</strong>', 'event_espresso'),
 			'[TRANSACTION_ADMIN_URL]' => __('The url to the admin page for this transaction', 'event_espresso'),
 			'[RECEIPT_URL]' => __('This parses to the generated url for retrieving the receipt for the transaction', 'event_espresso'),
-			'[INVOICE_RECEIPT_SWITCHER_URL]' => __( 'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.', 'event_espresso'),
-			'[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf( __( 'The same as %1$s[INVOICE_RECEIPT_SWITCHER_URL]%2$s except this returns the html for a button linked to the invoice or receipt.', 'event_espresso' ), '<code>', '</code>' )
+			'[INVOICE_RECEIPT_SWITCHER_URL]' => __('This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.', 'event_espresso'),
+			'[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(__('The same as %1$s[INVOICE_RECEIPT_SWITCHER_URL]%2$s except this returns the html for a button linked to the invoice or receipt.', 'event_espresso'), '<code>', '</code>')
 			);
 	}
 
 
-	protected function _parser( $shortcode ) {
+	protected function _parser($shortcode) {
 
-		EE_Registry::instance()->load_helper( 'Template' );
+		EE_Registry::instance()->load_helper('Template');
 
 		//attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the _extra_data for the transaction.
 		$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-		$transaction = ! $transaction instanceof EE_Transaction && is_array( $this->_extra_data ) &&  isset( $this->_extra_data['data'] ) && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->txn: $transaction;
+		$transaction = ! $transaction instanceof EE_Transaction && is_array($this->_extra_data) && isset($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->txn : $transaction;
 
 		//payment
 		$payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
-		$payment = ! $payment instanceof EE_Payment && is_array( $this->_extra_data ) &&  isset( $this->_extra_data['data'] ) && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment: $payment;
+		$payment = ! $payment instanceof EE_Payment && is_array($this->_extra_data) && isset($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment : $payment;
 
 
-		if ( ! $transaction instanceof EE_Transaction )
+		if ( ! $transaction instanceof EE_Transaction)
 			return '';
 
-		switch ( $shortcode ) {
+		switch ($shortcode) {
 			case '[TXN_ID]' :
 				return $transaction->ID();
 				break;
 
 			case '[PAYMENT_URL]' :
 				$payment_url = $transaction->payment_overview_url();
-				return empty( $payment_url ) ? __( 'http://dummypaymenturlforpreview.com', 'event_espresso') : $payment_url;
+				return empty($payment_url) ? __('http://dummypaymenturlforpreview.com', 'event_espresso') : $payment_url;
 				break;
 
 			case '[INVOICE_LINK]' :
 				$invoice_url = $transaction->invoice_url();
-				$invoice_url = empty( $invoice_url ) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-				return sprintf( __('%sClick here for Invoice%s', 'event_espresso'), '<a href="' . $invoice_url . '">', '</a>' );
+				$invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				return sprintf(__('%sClick here for Invoice%s', 'event_espresso'), '<a href="'.$invoice_url.'">', '</a>');
 				break; /**/
 
 			case '[INVOICE_URL]' :
 				$invoice_url = $transaction->invoice_url();
-				return empty( $invoice_url ) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
 				break;
 
 			case '[INVOICE_LOGO_URL]' :
@@ -126,7 +126,7 @@ 
 				break;
 
 			case '[INVOICE_LOGO]' :
-				return $this->_get_invoice_logo( TRUE );
+				return $this->_get_invoice_logo(TRUE);
 				break;
 
 			case '[INVOICE_PAYEE_NAME]' :
@@ -148,18 +148,18 @@ 
 
 			case "[TOTAL_COST]" :
 				$total = $transaction->total();
-				return ! empty($total) ? EEH_Template::format_currency( $total ) : '';
+				return ! empty($total) ? EEH_Template::format_currency($total) : '';
 				break;
 
 			case "[PAYMENT_STATUS]" :
 				$status = $transaction->pretty_status();
-				return !empty($status) ? $status : __('Unknown', 'event_espresso');
+				return ! empty($status) ? $status : __('Unknown', 'event_espresso');
 				break; /**/
 
 			// note the [payment_status] shortcode is kind of misleading because payment status might be different from txn status so I'm adding this here for clarity.
 			case "[TXN_STATUS]" :
 				$status = $transaction->pretty_status();
-				return !empty( $status ) ? $status : __('Unknown', 'event_espresso');
+				return ! empty($status) ? $status : __('Unknown', 'event_espresso');
 				break;
 
 			case "[TXN_STATUS_ID]" :
@@ -167,21 +167,21 @@ 
 				break;
 
 			case "[PAYMENT_GATEWAY]" :
-				return $this->_get_payment_gateway( $transaction );
+				return $this->_get_payment_gateway($transaction);
 				break;
 
 			case "[AMOUNT_PAID]" :
 				$amount = $payment instanceof EE_Payment ? $payment->amount() : 0;
-				return EEH_Template::format_currency( $amount );
+				return EEH_Template::format_currency($amount);
 				break;
 
 			case "[TOTAL_AMOUNT_PAID]" :
-				return EEH_Template::format_currency( $transaction->paid() );
+				return EEH_Template::format_currency($transaction->paid());
 				break;
 
 			case "[TOTAL_OWING]" :
 				$total_owing = $transaction->remaining();
-				return EEH_Template::format_currency( $total_owing );
+				return EEH_Template::format_currency($total_owing);
 				break;
 
 			case "[TXN_SUBTOTAL]" :
@@ -189,7 +189,7 @@ 
 				break;
 
 			case "[TXN_TAX_SUBTOTAL]" :
-				return EEH_Template::format_currency($this->_get_subtotal( TRUE ));
+				return EEH_Template::format_currency($this->_get_subtotal(TRUE));
 				break;
 
 			case "[TKT_QTY_PURCHASED]" :
@@ -198,9 +198,9 @@ 
 				break;
 
 			case "[TRANSACTION_ADMIN_URL]" :
-				require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
-				$query_args = array( 'page' => 'espresso_transactions', 'action' => 'view_transaction', 'TXN_ID' => $transaction->ID() );
-				$url = EE_Admin_Page::add_query_args_and_nonce( $query_args, admin_url('admin.php') );
+				require_once EE_CORE.'admin/EE_Admin_Page.core.php';
+				$query_args = array('page' => 'espresso_transactions', 'action' => 'view_transaction', 'TXN_ID' => $transaction->ID());
+				$url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
 				return $url;
 				break;
 
@@ -208,14 +208,14 @@ 
 				//get primary_registration
 				$reg = $this->_data->primary_reg_obj;
 
-				if ( ! $reg instanceof EE_Registration ) {
+				if ( ! $reg instanceof EE_Registration) {
 					return '';
 				}
 				return $reg->receipt_url();
 				break;
 
 			case "[INVOICE_RECEIPT_SWITCHER_URL]" :
-				return $this->_get_invoice_receipt_switcher( FALSE );
+				return $this->_get_invoice_receipt_switcher(FALSE);
 				break;
 
 			case "[INVOICE_RECEIPT_SWITCHER_BUTTON]" :
@@ -225,20 +225,20 @@ 
 
 		}
 
-		if ( strpos( $shortcode, '[OWING_STATUS_MESSAGE_*' ) !== FALSE ) {
-			return $this->_get_custom_total_oweing( $shortcode );
+		if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== FALSE) {
+			return $this->_get_custom_total_oweing($shortcode);
 		}
 
-		if ( strpos( $shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*' ) !== FALSE ) {
-			return $this->_get_invoice_payee_tax_number( $shortcode );
+		if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== FALSE) {
+			return $this->_get_invoice_payee_tax_number($shortcode);
 		}
 
-		if ( strpos( $shortcode, '[PAYMENT_LINK_IF_NEEDED_*' ) !== FALSE ) {
-			return $this->_get_payment_link_if_needed( $shortcode );
+		if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== FALSE) {
+			return $this->_get_payment_link_if_needed($shortcode);
 		}
 
-		if ( strpos( $shortcode, '[PAYMENT_DUE_DATE_*' ) !== false ) {
-			return $this->_get_payment_due_date( $shortcode, $transaction );
+		if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
+			return $this->_get_payment_due_date($shortcode, $transaction);
 		}
 
 		return '';
@@ -255,22 +255,22 @@ 
 	 *
 	 * @return string parsed.
 	 */
-	private function _get_custom_total_oweing( $shortcode ) {
-		$valid_shortcodes = array( 'transaction' );
-		$attrs = $this->_get_shortcode_attrs( $shortcode );
+	private function _get_custom_total_oweing($shortcode) {
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
 
 		//ensure default is set.
 		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
 		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction ? $addressee->txn->remaining() : 0;
 
-		if ( $total_owing > 0 ) {
-			$owing_content = ! empty( $attrs['still_owing'] ) ? $attrs['still_owing'] : sprintf( __( '%sPlease make a payment.%s', 'event_espresso'),  '<a href="[PAYMENT_URL]" class="noPrint">', '</a>' );
+		if ($total_owing > 0) {
+			$owing_content = ! empty($attrs['still_owing']) ? $attrs['still_owing'] : sprintf(__('%sPlease make a payment.%s', 'event_espresso'), '<a href="[PAYMENT_URL]" class="noPrint">', '</a>');
 
 			//we need to re run this string through the parser to catch any shortcodes that are in it.
 			$this->_set_shortcode_helper();
-			$owing_content = $this->_shortcode_helper->parse_message_template( $owing_content, $addressee, $valid_shortcodes, $this->_message_type, $this->_messenger, $this->_context, $this->_GRP_ID );
+			$owing_content = $this->_shortcode_helper->parse_message_template($owing_content, $addressee, $valid_shortcodes, $this->_message_type, $this->_messenger, $this->_context, $this->_GRP_ID);
 		} else {
-			$owing_content = !empty( $attrs['none_owing']) ? $attrs['none_owing'] : '';
+			$owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
 		}
 
 		return $owing_content;
@@ -278,8 +278,8 @@ 
 
 
 
-	private function _get_payment_gateway( $transaction ) {
-		$pm = $this->_get_payment_method( $transaction );
+	private function _get_payment_gateway($transaction) {
+		$pm = $this->_get_payment_method($transaction);
 		return $pm instanceof EE_Payment_Method ? $pm->name() : '';
 	}
 
@@ -294,37 +294,37 @@ 
 	 *
 	 * @return string url or html
 	 */
-	private function _get_invoice_logo( $img_tags = FALSE ) {
+	private function _get_invoice_logo($img_tags = FALSE) {
 		//try to get the invoice payment method's logo for this transaction image first
 		$pm = $this->_get_payment_method();
-		if ( $pm instanceof EE_Payment_Method ){
-			$invoice_logo_url = $pm->get_extra_meta( 'pdf_logo_image', TRUE );
-		}else{
+		if ($pm instanceof EE_Payment_Method) {
+			$invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', TRUE);
+		} else {
 			$invoice_logo_url = NULL;
 		}
-		if( empty( $invoice_logo_url ) ){
+		if (empty($invoice_logo_url)) {
 			$invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
 		}
 
-		if ( empty( $invoice_logo_url ) ) {
+		if (empty($invoice_logo_url)) {
 			return '';
 		}
 
-		if ( ! $img_tags ) {
+		if ( ! $img_tags) {
 			return $invoice_logo_url;
 		}
 
 		//image tags have been requested.
-		$image_size = getimagesize( $invoice_logo_url );
+		$image_size = getimagesize($invoice_logo_url);
 		
 		//if image is wider than 200px, set the wideth to 200
-		if ( $image_size[0] > 300 ) {
+		if ($image_size[0] > 300) {
 			$image_width = 300;
-		}else{
+		} else {
 			$image_width = $image_size[0];
 		}
 
-		return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+		return '<img class="logo screen" src="'.$invoice_logo_url.'" width="'.$image_width.'" alt="logo" />';
 	}
 
 
@@ -341,26 +341,26 @@ 
 	private function _get_invoice_payee_name() {
 		$payee_name = NULL;
 		$pm = $this->_get_payment_method();
-		if( $pm instanceof EE_Payment_Method ){
-			$payee_name = $pm->get_extra_meta( 'pdf_payee_name', TRUE );
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_name = $pm->get_extra_meta('pdf_payee_name', TRUE);
 		}
-		$payee_name = empty( $payee_name ) ? EE_Registry::instance()->CFG->organization->get_pretty( 'name' ) : $payee_name;
+		$payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
 		return $payee_name;
 	}
 
 	/**
 	 * gets the payment method for this transaction. Otherwise gets a default one.
 	 */
-	private function _get_payment_method( $transaction = null ){
-		if( $transaction instanceof EE_Transaction ) {
+	private function _get_payment_method($transaction = null) {
+		if ($transaction instanceof EE_Transaction) {
 			$payment_method = $transaction->payment_method();
-			if ( empty( $payment_method ) ) {
-				return apply_filters( 'FHEE__EE_Transaction_Shortcodes__get_payment_method__default', EEM_Payment_Method::instance()->get_one_of_type('Invoice'));
+			if (empty($payment_method)) {
+				return apply_filters('FHEE__EE_Transaction_Shortcodes__get_payment_method__default', EEM_Payment_Method::instance()->get_one_of_type('Invoice'));
 			}
 			return $payment_method;
-		}else{
+		} else {
 			//get the first payment method we can find
-			return apply_filters( 'FHEE__EE_Transaction_Shortcodes__get_payment_method__default', EEM_Payment_Method::instance()->get_one_of_type('Invoice'));
+			return apply_filters('FHEE__EE_Transaction_Shortcodes__get_payment_method__default', EEM_Payment_Method::instance()->get_one_of_type('Invoice'));
 		}
 	}
 
@@ -377,10 +377,10 @@ 
 	private function _get_invoice_payee_email() {
 		$payee_email = NULL;
 		$pm = $this->_get_payment_method();
-		if( $pm instanceof EE_Payment_Method ){
-			$payee_email = $pm->get_extra_meta( 'pdf_payee_email', TRUE );
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_email = $pm->get_extra_meta('pdf_payee_email', TRUE);
 		}
-		$payee_email = empty( $payee_email ) ? EE_Registry::instance()->CFG->organization->get_pretty( 'email' ) : $payee_email;
+		$payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email') : $payee_email;
 		return $payee_email;
 	}
 
@@ -396,24 +396,24 @@ 
 	 *
 	 * @return string
 	 */
-	private function _get_invoice_payee_tax_number( $shortcode ) {
+	private function _get_invoice_payee_tax_number($shortcode) {
 		$payee_tax_number = NULL;
 		$pm = $this->_get_payment_method();
-		if( $pm instanceof EE_Payment_Method ){
-			$payee_tax_number = $pm->get_extra_meta( 'pdf_payee_tax_number', TRUE );
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', TRUE);
 		}
-		$payee_tax_number = empty( $payee_tax_number ) ? EE_Registry::instance()->CFG->organization->vat : $payee_tax_number;
+		$payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat : $payee_tax_number;
 
-		if ( empty( $payee_tax_number ) ) {
+		if (empty($payee_tax_number)) {
 			return '';
 		}
 
 		//any attributes?
-		$attrs = $this->_get_shortcode_attrs( $shortcode );
+		$attrs = $this->_get_shortcode_attrs($shortcode);
 
 		//prefix?
-		$prefix = isset( $attrs['prefix'] ) ? $attrs['prefix'] : __( 'VAT/Tax Number: ', 'event_espresso' );
-		return $prefix . $payee_tax_number;
+		$prefix = isset($attrs['prefix']) ? $attrs['prefix'] : __('VAT/Tax Number: ', 'event_espresso');
+		return $prefix.$payee_tax_number;
 	}
 
 
@@ -430,22 +430,22 @@ 
 	private function _get_invoice_payee_address() {
 		$payee_address = NULL;
 		$pm = $this->_get_payment_method();
-		if( $pm instanceof EE_Payment_Method ){
-			$payee_address = $pm->get_extra_meta( 'pdf_payee_address', TRUE );
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_address = $pm->get_extra_meta('pdf_payee_address', TRUE);
 		}
-		if ( empty( $payee_address ) ) {
+		if (empty($payee_address)) {
 			$organization = EE_Registry::instance()->CFG->organization;
-			$payee_address = $organization->get_pretty( 'address_1' ) . '<br>';
-			$payee_address .= !empty( $organization->address_2 ) ? $organization->get_pretty( 'address_2' ) . '<br>' : '';
-			$payee_address .= $organization->get_pretty( 'city' ) . '<br>';
+			$payee_address = $organization->get_pretty('address_1').'<br>';
+			$payee_address .= ! empty($organization->address_2) ? $organization->get_pretty('address_2').'<br>' : '';
+			$payee_address .= $organization->get_pretty('city').'<br>';
 
 			//state
-			$state = EE_Registry::instance()->load_model( 'State' )->get_one_by_ID( $organization->STA_ID );
-			$payee_address .= $state instanceof EE_State ? $state->name()  : '';
+			$state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
+			$payee_address .= $state instanceof EE_State ? $state->name() : '';
 
 			//Country
-			$payee_address .= ! empty( $organization->CNT_ISO ) ? ', ' . $organization->CNT_ISO . '<br>' : '';
-			$payee_address .= ! empty( $organization->zip ) ? $organization->zip : '';
+			$payee_address .= ! empty($organization->CNT_ISO) ? ', '.$organization->CNT_ISO.'<br>' : '';
+			$payee_address .= ! empty($organization->zip) ? $organization->zip : '';
 		}
 		return $payee_address;
 	}
@@ -463,7 +463,7 @@ 
 	private function _get_invoice_payment_instructions() {
 		$instructions = NULL;
 		$pm = $this->_get_payment_method();
-		return ( $pm instanceof EE_Payment_Method ) ? $pm->get_extra_meta( 'pdf_instructions', TRUE) : '';
+		return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', TRUE) : '';
 	}
 
 
@@ -477,27 +477,27 @@ 
 	 *
 	 * @return string
 	 */
-	protected function _get_invoice_receipt_switcher( $button = TRUE ) {
+	protected function _get_invoice_receipt_switcher($button = TRUE) {
 		$reg = $this->_data->primary_reg_obj;
-		$message_type = isset( $this->_extra_data['message_type'] ) ? $this->_extra_data['message_type'] : '';
-		if ( ! $reg instanceof EE_Registration || empty( $message_type ) ) {
+		$message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
+		if ( ! $reg instanceof EE_Registration || empty($message_type)) {
 			return'';
 		}
 
-		$switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type  ? true : false;
-		$switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type ? __('View Invoice', 'event_espresso' ) : __( 'Switch to Invoice', 'event_espresso' );
-		$switch_to_label = ! $switch_to_invoice ? __( 'Switch to Receipt', 'event_espresso' ) : $switch_to_label;
+		$switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
+		$switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type ? __('View Invoice', 'event_espresso') : __('Switch to Invoice', 'event_espresso');
+		$switch_to_label = ! $switch_to_invoice ? __('Switch to Receipt', 'event_espresso') : $switch_to_label;
 		$switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
 
-		if ( ! $button ) {
+		if ( ! $button) {
 			return $switch_to_url;
 		}
 
-		if ( ! empty( $switch_to_url ) ) {
+		if ( ! empty($switch_to_url)) {
 
 		return  '
-<form method="post" action="' . $switch_to_url . '" >
-	<input class="print_button" type="submit" value="' . $switch_to_label . '" />
+<form method="post" action="' . $switch_to_url.'" >
+	<input class="print_button" type="submit" value="' . $switch_to_label.'" />
 </form>
 		';
 		}
@@ -517,11 +517,11 @@ 
 	 *
 	 * @return string
 	 */
-	private function _get_receipt_url( EE_Transaction $transaction ) {
+	private function _get_receipt_url(EE_Transaction $transaction) {
 		//get primary_registration
 		$reg = $this->_data->primary_reg_obj;
 
-		if ( ! $reg instanceof EE_Registration ) {
+		if ( ! $reg instanceof EE_Registration) {
 			return '';
 		}
 
@@ -537,10 +537,10 @@ 
 	 *
 	 * @return int
 	 */
-	private function _get_subtotal( $tax = FALSE ) {
-		$grand_total = isset( $this->_data->grand_total_line_item ) ? $this->_data->grand_total_line_item : NULL;
+	private function _get_subtotal($tax = FALSE) {
+		$grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : NULL;
 
-		if ( ! $grand_total instanceof EE_Line_Item ) {
+		if ( ! $grand_total instanceof EE_Line_Item) {
 			return 0;
 		}
 
@@ -559,27 +559,27 @@ 
 	 *
 	 * @return string parsed.
 	 */
-	private function _get_payment_link_if_needed( $shortcode ) {
-		$valid_shortcodes = array( 'transaction' );
-		$attrs = $this->_get_shortcode_attrs( $shortcode );
+	private function _get_payment_link_if_needed($shortcode) {
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
 
 		//ensure default is set.
 		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
 		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction ? $addressee->txn->remaining() : 0;
 
-		if ( $total_owing > 0 ) {
-			$class = isset( $attrs['class'] ) ? $attrs['class'] : 'callout';
-			$custom_text = isset( $attrs['custom_text'] ) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
-			$container_tag = isset( $attrs['container_tag'] ) ? $attrs['container_tag'] : 'p';
-			$opening_tag = ! empty( $container_tag ) ? '<' . $container_tag : '';
-			$opening_tag .= ! empty( $opening_tag ) && !empty( $class ) ? ' class="' . $class . '"' : $opening_tag;
-			$opening_tag .= !empty( $opening_tag ) ? '>' : $opening_tag;
-			$closing_tag = ! empty( $container_tag ) ? '</' . $container_tag .'>' : '';
-			$content = $opening_tag . sprintf( $custom_text, '<a href="[PAYMENT_URL]">', '</a>' ) . $closing_tag;
+		if ($total_owing > 0) {
+			$class = isset($attrs['class']) ? $attrs['class'] : 'callout';
+			$custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
+			$container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
+			$opening_tag = ! empty($container_tag) ? '<'.$container_tag : '';
+			$opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="'.$class.'"' : $opening_tag;
+			$opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
+			$closing_tag = ! empty($container_tag) ? '</'.$container_tag.'>' : '';
+			$content = $opening_tag.sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>').$closing_tag;
 
 			//we need to re run this string through the parser to catch any shortcodes that are in it.
 			$this->_set_shortcode_helper();
-			$owing_content = $this->_shortcode_helper->parse_message_template( $content, $addressee, $valid_shortcodes, $this->_message_type, $this->_messenger, $this->_context, $this->_GRP_ID );
+			$owing_content = $this->_shortcode_helper->parse_message_template($content, $addressee, $valid_shortcodes, $this->_message_type, $this->_messenger, $this->_context, $this->_GRP_ID);
 		} else {
 			return '';
 		}
@@ -599,31 +599,31 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return string
 	 */
-	protected function _get_payment_due_date( $shortcode, EE_Transaction $transaction ) {
+	protected function _get_payment_due_date($shortcode, EE_Transaction $transaction) {
 		//if transaction is paid in full then we can just return an empty string
-		if ( $transaction->remaining() === 0 ) {
+		if ($transaction->remaining() === 0) {
 			return '';
 		}
 
-		$attrs = $this->_get_shortcode_attrs( $shortcode );
-		$format = isset( $attrs['format'] ) ? $attrs['format'] : get_option( 'date_format' );
-		$days_until_due = isset( $attrs['days_until_due'] ) ? (int) $attrs['days_until_due'] : 30;
-		$prefix_text = isset( $attrs['prefix_text'] ) ? $attrs['prefix_text'] : __( 'Payment in full due by: ', 'event_espresso' );
-		$transaction_created = $transaction->get_DateTime_object( 'TXN_timestamp' );
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		$format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
+		$days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
+		$prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text'] : __('Payment in full due by: ', 'event_espresso');
+		$transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
 
 		//setup date due:
 		try {
-			if ( $transaction_created instanceof DateTime ) {
-				$date_due = $transaction_created->add( new DateInterval( 'P' . $days_until_due . 'D' ) )->format( $format );
+			if ($transaction_created instanceof DateTime) {
+				$date_due = $transaction_created->add(new DateInterval('P'.$days_until_due.'D'))->format($format);
 			} else {
 				throw new Exception();
 			}
-		} catch( Exception $e ) {
+		} catch (Exception $e) {
 			//format was likely invalid.
 			$date_due = 'Unable to calculate date due, likely the format string is invalid.';
 		}
 
-		return $prefix_text . $date_due;
+		return $prefix_text.$date_due;
 	}
 
 } //end EE_Transaction Shortcodes library

core/libraries/payment_methods/EE_Gateway.lib.php

Indentation +30 added lines, -30 removed lines

@@ -1,35 +1,35 @@
 <?php
 /**
- * Event Espresso
- *
- * Event Registration and Management Plugin for WordPress
- *
- * @ package			Event Espresso
- * @ author				Seth Shoultes
- * @ copyright		(c) 2008-2011 Event Espresso  All Rights Reserved.
- * @ license			http://eventespresso.com/support/terms-conditions/   * see Plugin Licensing *
- * @ link					http://www.eventespresso.com
- * @ version		 	4.2
- *
- * ------------------------------------------------------------------------
- *
- * EE_Gateway
- *
- * Abstract base class for all gateways
- *
- * @package			Event Espresso
- * @subpackage		core/libraries/payment_methods
- * @author			Mike Nelson
- *
- * ------------------------------------------------------------------------
- * Class for processing payments. This has been designed in a way so that other WP Plugins
- * can use this class for processing payments, and theoreitcally any of its children, provided they implement the
- * interfaces it uses.
- * The necessary interfaces to be implemented are contained in core/libaries/payment_methods/EEI_Payment_Method_Interfaces.php and
- * EEI_Interfaces. After constructing a gateway object, you need to set all the properties which reference many of the
- * needed helpers and models (see all the methods starting with "set_", eg seg_line_item_helper which should be passed an object
- * which implements EEHI_Line_Item_Helper; etc).
- */
+	 * Event Espresso
+	 *
+	 * Event Registration and Management Plugin for WordPress
+	 *
+	 * @ package			Event Espresso
+	 * @ author				Seth Shoultes
+	 * @ copyright		(c) 2008-2011 Event Espresso  All Rights Reserved.
+	 * @ license			http://eventespresso.com/support/terms-conditions/   * see Plugin Licensing *
+	 * @ link					http://www.eventespresso.com
+	 * @ version		 	4.2
+	 *
+	 * ------------------------------------------------------------------------
+	 *
+	 * EE_Gateway
+	 *
+	 * Abstract base class for all gateways
+	 *
+	 * @package			Event Espresso
+	 * @subpackage		core/libraries/payment_methods
+	 * @author			Mike Nelson
+	 *
+	 * ------------------------------------------------------------------------
+	 * Class for processing payments. This has been designed in a way so that other WP Plugins
+	 * can use this class for processing payments, and theoreitcally any of its children, provided they implement the
+	 * interfaces it uses.
+	 * The necessary interfaces to be implemented are contained in core/libaries/payment_methods/EEI_Payment_Method_Interfaces.php and
+	 * EEI_Interfaces. After constructing a gateway object, you need to set all the properties which reference many of the
+	 * needed helpers and models (see all the methods starting with "set_", eg seg_line_item_helper which should be passed an object
+	 * which implements EEHI_Line_Item_Helper; etc).
+	 */
 abstract class EE_Gateway{
 	/**
 	 * a constant used as a possible value for $_currencies_supported to indicate