eventespresso / event-espresso-core

core/libraries/form_sections/strategies/validation/EE_URL_Validation_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
 	 * just checks the field isn't blank
 	 *
 	 * @param $normalized_value
-	 * @return bool
+	 * @return boolean|null
 	 * @throws \EE_Validation_Error
 	 */
 	function validate($normalized_value) {

Braces +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 		if( $normalized_value ){
 			if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false){
 				throw new EE_Validation_Error( $this->get_validation_error_message(), 'invalid_url');
-			}else{
+			} else{
 				EE_Registry::instance()->load_helper('URL');
 				if( ! EEH_URL::remote_file_exists(
 						$normalized_value,

Spacing +13 added lines, -13 removed lines

@@ -8,16 +8,16 @@ 
  * @since 				4.6
  *
  */
-class EE_URL_Validation_Strategy extends EE_Validation_Strategy_Base{
+class EE_URL_Validation_Strategy extends EE_Validation_Strategy_Base {
 
 	/**
 	 * @param null $validation_error_message
 	 */
-	public function __construct( $validation_error_message = NULL ) {
-		if( ! $validation_error_message ){
+	public function __construct($validation_error_message = NULL) {
+		if ( ! $validation_error_message) {
 			$validation_error_message = __("Please enter a valid URL", "event_espresso");
 		}
-		parent::__construct( $validation_error_message );
+		parent::__construct($validation_error_message);
 	}
 
 
@@ -30,16 +30,16 @@ 
 	 * @throws \EE_Validation_Error
 	 */
 	function validate($normalized_value) {
-		if( $normalized_value ){
-			if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false){
-				throw new EE_Validation_Error( $this->get_validation_error_message(), 'invalid_url');
-			}else{
-				if( ! EEH_URL::remote_file_exists(
+		if ($normalized_value) {
+			if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false) {
+				throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url');
+			} else {
+				if ( ! EEH_URL::remote_file_exists(
 						$normalized_value,
 						array(
 							'sslverify' => false, 
-							'limit_response_size' => 4095,//we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
-						))){
+							'limit_response_size' => 4095, //we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
+						))) {
 					throw new EE_Validation_Error(sprintf(__("That URL seems to be broken. Please enter a valid URL", "event_espresso")));
 				}
 			}
@@ -51,8 +51,8 @@ 
 	/**
 	 * @return array
 	 */
-	function get_jquery_validation_rule_array(){
-		return array( 'validUrl'=>true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) );
+	function get_jquery_validation_rule_array() {
+		return array('validUrl'=>true, 'messages' => array('validUrl' => $this->get_validation_error_message()));
 	}
 }
 

core/libraries/line_item_display/EE_Receipt_Line_Item_Display_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
 	/**
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	public function display_line_item( EE_Line_Item $line_item, $options = array() ) {
 

Indentation +11 added lines, -11 removed lines

@@ -14,17 +14,17 @@
  * ------------------------------------------------------------------------
  */
  /**
- *
- * Class EE_Receipt_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- * @since		 	   $VID:$
- *
- */
+  *
+  * Class EE_Receipt_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  * @since		 	   $VID:$
+  *
+  */
 
 class EE_Receipt_Line_Item_Display_Strategy  implements EEI_Line_Item_Display {
 

Spacing +7 added lines, -7 removed lines

@@ -33,7 +33,7 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	public function display_line_item( EE_Line_Item $line_item, $options = array() ) {
+	public function display_line_item(EE_Line_Item $line_item, $options = array()) {
 
 		$html = '';
 		// set some default options and merge with incoming
@@ -41,12 +41,12 @@ 
 			'show_desc' => TRUE,
 			'odd' => FALSE
 		);
-		$options = array_merge( $default_options, (array)$options );
-		switch( $line_item->type() ) {
+		$options = array_merge($default_options, (array) $options);
+		switch ($line_item->type()) {
 
 			case EEM_Line_Item::type_total:
 				// loop thru children
-				foreach( $line_item->children() as $child_line_item ) {
+				foreach ($line_item->children() as $child_line_item) {
 					// recursively feed children back into this method
 //					$html .= $this->display_line_item( $child_line_item, $options );
 				}
@@ -57,7 +57,7 @@ 
 
 			case EEM_Line_Item::type_sub_total:
 				// loop thru children
-				foreach( $line_item->children() as $child_line_item ) {
+				foreach ($line_item->children() as $child_line_item) {
 					// recursively feed children back into this method
 //					$html .= $this->display_line_item( $child_line_item, $options );
 				}
@@ -67,7 +67,7 @@ 
 
 			case EEM_Line_Item::type_tax_sub_total:
 				// loop thru children
-				foreach( $line_item->children() as $child_line_item ) {
+				foreach ($line_item->children() as $child_line_item) {
 					// recursively feed children back into this method
 //					$html .= $this->display_line_item( $child_line_item, $options );
 				}
@@ -79,7 +79,7 @@ 
 				// item row
 //				$html .= $this->_item_row( $line_item, $options );
 				// got any kids?
-				foreach( $line_item->children() as $child_line_item ) {
+				foreach ($line_item->children() as $child_line_item) {
 //					$this->display_line_item( $child_line_item, $options );
 				}
 				break;

core/libraries/line_item_display/EE_SPCO_Line_Item_Display_Strategy.strategy.php

Doc Comments +10 added lines, -10 removed lines

@@ -67,7 +67,7 @@ 
 	/**
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	public function display_line_item( EE_Line_Item $line_item, $options = array() ) {
 
@@ -206,7 +206,7 @@ 
 	 *    _event_row - basically a Heading row displayed once above each event's ticket rows
 	 *
 	 * @param EE_Line_Item $line_item
-	 * @return mixed
+	 * @return string
 	 */
 	private function _event_row( EE_Line_Item $line_item ) {
 		// start of row
@@ -225,7 +225,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _ticket_row( EE_Line_Item $line_item, $options = array() ) {
 		// start of row
@@ -268,7 +268,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _item_row( EE_Line_Item $line_item, $options = array() ) {
 		// start of row
@@ -314,7 +314,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _sub_item_row( EE_Line_Item $line_item, $options = array() ) {
 		// start of row
@@ -344,7 +344,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _tax_row( EE_Line_Item $line_item, $options = array() ) {
 		// start of row
@@ -374,7 +374,7 @@ 
 	 * @param EE_Line_Item $line_item
 	 * @param string $text
 	 * @param array $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _total_tax_row( EE_Line_Item $line_item, $text = '', $options = array() ) {
 		$html = '';
@@ -401,7 +401,7 @@ 
 	 * @param EE_Line_Item $line_item
 	 * @param string       $text
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _sub_total_row( EE_Line_Item $line_item, $text = '', $options = array() ) {
 		$html = '';
@@ -426,7 +426,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param string       $text
-	 * @return mixed
+	 * @return string
 	 */
 	private function _total_row( EE_Line_Item $line_item, $text = '' ) {
 		// start of row
@@ -446,7 +446,7 @@ 
 	 * 	_payments_and_amount_owing_rows
 	 *
 	 * @param EE_Line_Item $line_item
-	 * @return mixed
+	 * @return string
 	 */
 	private function _payments_and_amount_owing_rows( EE_Line_Item $line_item ) {
 		$html = '';

Indentation +11 added lines, -11 removed lines

@@ -1,16 +1,16 @@
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
  /**
- *
- * Class EE_SPCO_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- * @since		 	   $VID:$
- *
- */
+  *
+  * Class EE_SPCO_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  * @since		 	   $VID:$
+  *
+  */
 
 class EE_SPCO_Line_Item_Display_Strategy implements EEI_Line_Item_Display {
 

Spacing +118 added lines, -118 removed lines

@@ -69,101 +69,101 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	public function display_line_item( EE_Line_Item $line_item, $options = array() ) {
+	public function display_line_item(EE_Line_Item $line_item, $options = array()) {
 
 		$html = '';
 		// set some default options and merge with incoming
 		$default_options = array(
-			'show_desc' => true,  // 	true 		false
+			'show_desc' => true, // 	true 		false
 			'odd' => false
 		);
-		$options = array_merge( $default_options, (array)$options );
+		$options = array_merge($default_options, (array) $options);
 
-		switch( $line_item->type() ) {
+		switch ($line_item->type()) {
 
 			case EEM_Line_Item::type_line_item:
 				$this->_show_taxes = $line_item->is_taxable() ? true : $this->_show_taxes;
-				if ( $line_item->OBJ_type() == 'Ticket' ) {
+				if ($line_item->OBJ_type() == 'Ticket') {
 					// item row
-					$html .= $this->_ticket_row( $line_item, $options );
+					$html .= $this->_ticket_row($line_item, $options);
 					// got any kids?
-					foreach ( $line_item->children() as $child_line_item ) {
-						$this->display_line_item( $child_line_item, $options );
+					foreach ($line_item->children() as $child_line_item) {
+						$this->display_line_item($child_line_item, $options);
 					}
 				} else {
 					// item row
-					$html .= $this->_item_row( $line_item, $options );
+					$html .= $this->_item_row($line_item, $options);
 					// got any kids?
-					foreach ( $line_item->children() as $child_line_item ) {
-						$this->display_line_item( $child_line_item, $options );
+					foreach ($line_item->children() as $child_line_item) {
+						$this->display_line_item($child_line_item, $options);
 					}
 				}
 				break;
 
 			case EEM_Line_Item::type_sub_line_item:
-				$html .= $this->_sub_item_row( $line_item, $options );
+				$html .= $this->_sub_item_row($line_item, $options);
 				break;
 
 			case EEM_Line_Item::type_sub_total:
 				static $sub_total = 0;
 				$event_sub_total = 0;
-				$text = __( 'Sub-Total', 'event_espresso' );
-				if ( $line_item->OBJ_type() == 'Event' ) {
-					$options[ 'event_id' ] = $event_id = $line_item->OBJ_ID();
-					if ( ! isset( $this->_events[ $options[ 'event_id' ] ] ) ) {
-						$event = EEM_Event::instance()->get_one_by_ID( $options[ 'event_id' ] );
-						if ( $event instanceof EE_Event ) {
-							if ( $event->default_registration_status() == EEM_Registration::status_id_not_approved ) {
+				$text = __('Sub-Total', 'event_espresso');
+				if ($line_item->OBJ_type() == 'Event') {
+					$options['event_id'] = $event_id = $line_item->OBJ_ID();
+					if ( ! isset($this->_events[$options['event_id']])) {
+						$event = EEM_Event::instance()->get_one_by_ID($options['event_id']);
+						if ($event instanceof EE_Event) {
+							if ($event->default_registration_status() == EEM_Registration::status_id_not_approved) {
 								return '';
 							}
 						}
-						$this->_events[ $options[ 'event_id' ] ] = 0;
-						$html .= $this->_event_row( $line_item );
-						$text = __( 'Event Sub-Total', 'event_espresso' );
+						$this->_events[$options['event_id']] = 0;
+						$html .= $this->_event_row($line_item);
+						$text = __('Event Sub-Total', 'event_espresso');
 					}
 				}
 				$child_line_items = $line_item->children();
 				// loop thru children
-				foreach( $child_line_items as $child_line_item ) {
+				foreach ($child_line_items as $child_line_item) {
 					// recursively feed children back into this method
-					$html .= $this->display_line_item( $child_line_item, $options );
+					$html .= $this->display_line_item($child_line_item, $options);
 				}
-				$event_sub_total += isset( $options[ 'event_id' ] ) ? $this->_events[ $options[ 'event_id' ] ] : 0;
+				$event_sub_total += isset($options['event_id']) ? $this->_events[$options['event_id']] : 0;
 				$sub_total += $event_sub_total;
 				if (
 					(
 						// event subtotals
 						$line_item->code() != 'pre-tax-subtotal' &&
-						count( $child_line_items ) > 1
+						count($child_line_items) > 1
 					)
 					||
 					(
 						// pre-tax subtotals
 						$line_item->code() == 'pre-tax-subtotal' &&
-						count( $this->_events ) > 1
+						count($this->_events) > 1
 					)
 				) {
 					$options['sub_total'] = $line_item->OBJ_type() == 'Event' ? $event_sub_total : $sub_total;
-					$html .= $this->_sub_total_row( $line_item, $text, $options );
+					$html .= $this->_sub_total_row($line_item, $text, $options);
 				}
 				break;
 
 			case EEM_Line_Item::type_tax:
-				if ( $this->_show_taxes ) {
-					$this->_taxes_html .= $this->_tax_row( $line_item, $options );
+				if ($this->_show_taxes) {
+					$this->_taxes_html .= $this->_tax_row($line_item, $options);
 				}
 				break;
 
 			case EEM_Line_Item::type_tax_sub_total:
-				if ( $this->_show_taxes ) {
+				if ($this->_show_taxes) {
 					$child_line_items = $line_item->children();
 					// loop thru children
-					foreach( $child_line_items as $child_line_item ) {
+					foreach ($child_line_items as $child_line_item) {
 						// recursively feed children back into this method
-						$html .= $this->display_line_item( $child_line_item, $options );
+						$html .= $this->display_line_item($child_line_item, $options);
 					}
-					if ( count( $child_line_items ) > 1 ) {
-						$this->_taxes_html .= $this->_total_tax_row( $line_item, __( 'Tax Total', 'event_espresso' ) );
+					if (count($child_line_items) > 1) {
+						$this->_taxes_html .= $this->_total_tax_row($line_item, __('Tax Total', 'event_espresso'));
 					}
 				}
 				break;
@@ -172,25 +172,25 @@ 
 				// get all child line items
 				$children = $line_item->children();
 				// loop thru all non-tax child line items
-				foreach( $children as $child_line_item ) {
-					if ( $child_line_item->type() != EEM_Line_Item::type_tax_sub_total ) {
+				foreach ($children as $child_line_item) {
+					if ($child_line_item->type() != EEM_Line_Item::type_tax_sub_total) {
 						// recursively feed children back into this method
-						$html .= $this->display_line_item( $child_line_item, $options );
+						$html .= $this->display_line_item($child_line_item, $options);
 					}
 				}
 
 				// now loop thru  tax child line items
-				foreach( $children as $child_line_item ) {
-					if ( $child_line_item->type() == EEM_Line_Item::type_tax_sub_total ) {
+				foreach ($children as $child_line_item) {
+					if ($child_line_item->type() == EEM_Line_Item::type_tax_sub_total) {
 						// recursively feed children back into this method
-						$html .= $this->display_line_item( $child_line_item, $options );
+						$html .= $this->display_line_item($child_line_item, $options);
 					}
 				}
 				$html .= $this->_taxes_html;
-				$html .= $this->_total_row( $line_item, __('Total', 'event_espresso') );
+				$html .= $this->_total_row($line_item, __('Total', 'event_espresso'));
 
 
-				$html .= $this->_payments_and_amount_owing_rows( $line_item, $options );
+				$html .= $this->_payments_and_amount_owing_rows($line_item, $options);
 				break;
 
 		}
@@ -205,11 +205,11 @@ 
 	 * @param EE_Line_Item $line_item
 	 * @return mixed
 	 */
-	private function _event_row( EE_Line_Item $line_item ) {
+	private function _event_row(EE_Line_Item $line_item) {
 		// start of row
-		$html = EEH_HTML::tr( '', 'event-cart-total-row', 'total_tr odd' );
+		$html = EEH_HTML::tr('', 'event-cart-total-row', 'total_tr odd');
 		// event name td
-		$html .= EEH_HTML::td( EEH_HTML::strong( $line_item->name() ), '', 'event-header', '', ' colspan="4"' );
+		$html .= EEH_HTML::td(EEH_HTML::strong($line_item->name()), '', 'event-header', '', ' colspan="4"');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -224,10 +224,10 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _ticket_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _ticket_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
 		$row_class = $options['odd'] ? 'item odd' : 'item';
-		$html = EEH_HTML::tr( '', '', $row_class );
+		$html = EEH_HTML::tr('', '', $row_class);
 		// name && desc
 		$name_and_desc = apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
@@ -236,23 +236,23 @@ 
 		);
 		$name_and_desc .= apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-			( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
+			($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : ''),
 			$line_item,
 			$options
 		);
 		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
 		// name td
-		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '',  'item_l' );
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '', 'item_l' );
 		// price td
-		$html .= EEH_HTML::td( $line_item->unit_price_no_code(), '',  'item_c jst-rght' );
+		$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
 		// quantity td
-		$html .= EEH_HTML::td( $line_item->quantity(), '', 'item_l jst-rght' );
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
 		$this->_total_items += $line_item->quantity();
 		// determine total for line item
 		$total = $line_item->total();
-		$this->_events[ $options[ 'event_id' ] ] += $total;
+		$this->_events[$options['event_id']] += $total;
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $total, false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($total, false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -267,41 +267,41 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _item_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _item_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
 		$row_class = $options['odd'] ? 'item odd' : 'item';
-		$html = EEH_HTML::tr( '', '', $row_class );
-		$obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type() . ': ' : '';
+		$html = EEH_HTML::tr('', '', $row_class);
+		$obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type().': ' : '';
 		// name && desc
 		$name_and_desc = apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-			 $obj_name . $line_item->name(),
+			 $obj_name.$line_item->name(),
 			$line_item
 		);
 		$name_and_desc .= apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-			( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
+			($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : ''),
 			$line_item,
 			$options
 		);
 		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
 		// name td
-		$html .= EEH_HTML::td( $name_and_desc, '',  'item_l' );
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l');
 		// price td
-		if ( $line_item->is_percent() ) {
-			$html .= EEH_HTML::td( $line_item->percent() . '%', '', 'item_c jst-rght' );
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c jst-rght');
 		} else {
-			$html .= EEH_HTML::td( $line_item->unit_price_no_code(), '', 'item_c jst-rght' );
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
 		}
 		// quantity td
-		$html .= EEH_HTML::td( $line_item->quantity(), '', 'item_l jst-rght' );
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
 		//$total = $line_item->total() * $line_item->quantity();
 		$total = $line_item->total();
-		if( isset( $options[ 'event_id' ] ) && isset( $this->_events[ $options[ 'event_id' ] ] ) ) {
-			$this->_events[ $options[ 'event_id' ] ] += $total;
+		if (isset($options['event_id']) && isset($this->_events[$options['event_id']])) {
+			$this->_events[$options['event_id']] += $total;
 		}
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $total, false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($total, false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -316,22 +316,22 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _sub_item_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
-		$html = EEH_HTML::tr( '', 'item sub-item-row' );
+		$html = EEH_HTML::tr('', 'item sub-item-row');
 		// name && desc
 		$name_and_desc = $line_item->name();
-		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '';
+		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : '';
 		// name td
-		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '',  'item_l sub-item' );
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item' );
 		// discount/surcharge td
-		if ( $line_item->is_percent() ) {
-			$html .= EEH_HTML::td( $line_item->percent() . '%', '',  'item_c' );
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c');
 		} else {
-			$html .= EEH_HTML::td( $line_item->unit_price_no_code(), '',  'item_c jst-rght' );
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
 		}
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $line_item->total(), false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -346,21 +346,21 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _tax_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _tax_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
-		$html = EEH_HTML::tr( '', 'item sub-item tax-total' );
+		$html = EEH_HTML::tr('', 'item sub-item tax-total');
 		// name && desc
 		$name_and_desc = $line_item->name();
-		$name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">' . __( ' * taxable items', 'event_espresso' ) . '</span>';
-		$name_and_desc .= $options[ 'show_desc' ] ? '<br/>' . $line_item->desc() : '';
+		$name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'.__(' * taxable items', 'event_espresso').'</span>';
+		$name_and_desc .= $options['show_desc'] ? '<br/>'.$line_item->desc() : '';
 		// name td
-		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '',  'item_l sub-item' );
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item' );
 		// percent td
-		$html .= EEH_HTML::td( $line_item->percent() . '%', '',  ' jst-rght', '' );
+		$html .= EEH_HTML::td($line_item->percent().'%', '', ' jst-rght', '');
 		// empty td (price)
-		$html .= EEH_HTML::td( EEH_HTML::nbsp() );
+		$html .= EEH_HTML::td(EEH_HTML::nbsp());
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $line_item->total(), false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -375,17 +375,17 @@ 
 	 * @param string $text
 	 * @return mixed
 	 */
-	private function _total_tax_row( EE_Line_Item $line_item, $text = '' ) {
+	private function _total_tax_row(EE_Line_Item $line_item, $text = '') {
 		$html = '';
-		if ( $line_item->total() ) {
+		if ($line_item->total()) {
 			// start of row
-			$html = EEH_HTML::tr( '', '', 'total_tr odd' );
+			$html = EEH_HTML::tr('', '', 'total_tr odd');
 			// total td
-			$html .= EEH_HTML::td( $text, '', 'total_currency total jst-rght', '', ' colspan="2"' );
+			$html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="2"');
 			// empty td (price)
-			$html .= EEH_HTML::td( EEH_HTML::nbsp() );
+			$html .= EEH_HTML::td(EEH_HTML::nbsp());
 			// total td
-			$html .= EEH_HTML::td( EEH_Template::format_currency( $line_item->total(), false, false ), '', 'total jst-rght' );
+			$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'total jst-rght');
 			// end of row
 			$html .= EEH_HTML::trx();
 		}
@@ -402,15 +402,15 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _sub_total_row( EE_Line_Item $line_item, $text = '', $options = array() ) {
+	private function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array()) {
 		$html = '';
-		if ( $line_item->total() ) {
+		if ($line_item->total()) {
 			// start of row
-			$html = EEH_HTML::tr( '', '', 'total_tr odd' );
+			$html = EEH_HTML::tr('', '', 'total_tr odd');
 			// total td
-			$html .= EEH_HTML::td( $text, '', 'total_currency total jst-rght', '', ' colspan="3"' );
+			$html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="3"');
 			// total td
-			$html .= EEH_HTML::td( EEH_Template::format_currency( $options[ 'sub_total' ], false, false ), '', 'total jst-rght' );
+			$html .= EEH_HTML::td(EEH_Template::format_currency($options['sub_total'], false, false), '', 'total jst-rght');
 			// end of row
 			$html .= EEH_HTML::trx();
 		}
@@ -427,13 +427,13 @@ 
 	 * @param string       $text
 	 * @return mixed
 	 */
-	private function _total_row( EE_Line_Item $line_item, $text = '' ) {
+	private function _total_row(EE_Line_Item $line_item, $text = '') {
 		// start of row
-		$html = EEH_HTML::tr( '', '', 'spco-grand-total total_tr odd' );
+		$html = EEH_HTML::tr('', '', 'spco-grand-total total_tr odd');
 		// total td
-		$html .= EEH_HTML::td( $text, '',  'total_currency total jst-rght',  '',  ' colspan="3"' );
+		$html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="3"');
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $line_item->total(), false, false ), '',  'total jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'total jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -448,30 +448,30 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _payments_and_amount_owing_rows( EE_Line_Item $line_item, $options = array() ) {
+	private function _payments_and_amount_owing_rows(EE_Line_Item $line_item, $options = array()) {
 		$html = '';
 		$owing = $line_item->total();
-		$transaction = EEM_Transaction::instance()->get_one_by_ID( $line_item->TXN_ID() );
-		if ( $transaction instanceof EE_Transaction ) {
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($line_item->TXN_ID());
+		if ($transaction instanceof EE_Transaction) {
 			$registration_payments = array();
-			$registrations = ! empty( $options['registrations'] )
-				? $options[ 'registrations' ]
+			$registrations = ! empty($options['registrations'])
+				? $options['registrations']
 				: $transaction->registrations();
-			foreach ( $registrations as $registration ) {
-				if ( $registration instanceof EE_Registration && $registration->owes_monies_and_can_pay() ) {
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
 					$registration_payments = $registration_payments + $registration->registration_payments();
 				}
 			}
-			if ( ! empty( $registration_payments )) {
-				foreach ( $registration_payments as $registration_payment ) {
-					if ( $registration_payment instanceof EE_Registration_Payment ) {
+			if ( ! empty($registration_payments)) {
+				foreach ($registration_payments as $registration_payment) {
+					if ($registration_payment instanceof EE_Registration_Payment) {
 						$owing = $owing - $registration_payment->amount();
 						$payment = $registration_payment->payment();
-						if ( $payment instanceof EE_Payment ) {
+						if ($payment instanceof EE_Payment) {
 							$payment_desc = sprintf(
-								__( 'Payment%1$s Received: %2$s', 'event_espresso' ),
+								__('Payment%1$s Received: %2$s', 'event_espresso'),
 								$payment->txn_id_chq_nmbr() != ''
-									? ' <span class="small-text">(#' . $payment->txn_id_chq_nmbr() . ')</span> '
+									? ' <span class="small-text">(#'.$payment->txn_id_chq_nmbr().')</span> '
 									: '',
 								$payment->timestamp()
 							);
@@ -479,12 +479,12 @@ 
 							$payment_desc = '';
 						}
 						// start of row
-						$html .= EEH_HTML::tr( '', '', 'total_tr odd' );
+						$html .= EEH_HTML::tr('', '', 'total_tr odd');
 						// payment desc
-						$html .= EEH_HTML::td( $payment_desc, '', '', '', ' colspan="3"' );
+						$html .= EEH_HTML::td($payment_desc, '', '', '', ' colspan="3"');
 						// total td
 						$html .= EEH_HTML::td(
-							EEH_Template::format_currency( $registration_payment->amount(), false, false ),
+							EEH_Template::format_currency($registration_payment->amount(), false, false),
 							'',
 							'total jst-rght'
 						);
@@ -492,17 +492,17 @@ 
 						$html .= EEH_HTML::trx();
 					}
 				}
-				if ( $line_item->total() ) {
+				if ($line_item->total()) {
 					// start of row
-					$html .= EEH_HTML::tr( '', '', 'total_tr odd' );
+					$html .= EEH_HTML::tr('', '', 'total_tr odd');
 					// total td
 					$html .= EEH_HTML::td(
 						__('Amount Owing', 'event_espresso'),
-						'',  'total_currency total jst-rght',  '',  ' colspan="3"'
+						'', 'total_currency total jst-rght', '', ' colspan="3"'
 					);
 					// total td
 					$html .= EEH_HTML::td(
-						EEH_Template::format_currency( $owing, false, false ), '',  'total jst-rght'
+						EEH_Template::format_currency($owing, false, false), '', 'total jst-rght'
 					);
 					// end of row
 					$html .= EEH_HTML::trx();

core/libraries/messages/defaults/EE_Messages_Template_Pack.core.php

Doc Comments +1 added lines

@@ -316,6 +316,7 @@
 	 * @param EE_message_type $message_type
 	 * @param string          $field          The field reference for the specific template being looked up.
 	 * @param string          $context      The context reference for the specific template being looked up
+	 * @param EE_Messages_Template_Pack_Default|null $default_pack
 	 *
 	 * @return string          The template contents.
 	 */

Braces +6 added lines, -3 removed lines

@@ -5,7 +5,9 @@ 
  * @subpackage messages
  * @since           4.5.0
  */
-if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 
 /**
  * EE_Template_Packs are classes that contain all the information related to messages templates for a given "template pack".
@@ -282,8 +284,9 @@ 
 
 		foreach ( $contexts as $context => $details ) {
 			foreach ( $fields as $field => $field_details ) {
-				if ( empty( $field_details ) )
-					continue;
+				if ( empty( $field_details ) ) {
+									continue;
+				}
 				/**
 				 * is this a field array (linked to a main field)?
 				 */

Spacing +85 added lines, -85 removed lines

@@ -167,44 +167,44 @@ 
 	public function __construct() {
 		$this->_set_props();
 		//make sure classname is correct
-		$classname = get_class( $this );
+		$classname = get_class($this);
 		//make sure required props have been set
 
 		//if label is empty then throw an error because we should have it defined by now.
-		if ( ! isset( $this->label )  ) {
-			throw new EE_Error( sprintf( __('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if ( ! isset($this->label)) {
+			throw new EE_Error(sprintf(__('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 
 		//the reference for this template pack
-		if ( ! isset( $this->dbref )  ) {
-			throw new EE_Error( sprintf( __('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if ( ! isset($this->dbref)) {
+			throw new EE_Error(sprintf(__('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 		//make sure dbref is safe
-		$this->dbref = str_replace( '-', '_', sanitize_key( $this->dbref ) );
+		$this->dbref = str_replace('-', '_', sanitize_key($this->dbref));
 
-		$should_be = 'EE_Messages_Template_Pack_' . str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $this->dbref ) ) );
+		$should_be = 'EE_Messages_Template_Pack_'.str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
 
-		if ( $should_be !== $classname ) {
-			throw new EE_Error( sprintf( __('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso' ), $classname, $should_be ) );
+		if ($should_be !== $classname) {
+			throw new EE_Error(sprintf(__('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be));
 		}
 
 		//if _base_path is not set then throw an error because a base path string is needed.
-		if ( empty( $this->_base_path ) ) {
-			throw new EE_Error( sprintf( __('The _base_path property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if (empty($this->_base_path)) {
+			throw new EE_Error(sprintf(__('The _base_path property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 
 		//if _base_url is not set then throw an error because a  string is needed for variations.
-		if ( empty( $this->_base_url ) ) {
-			throw new EE_Error( sprintf( __('The _base_url property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if (empty($this->_base_url)) {
+			throw new EE_Error(sprintf(__('The _base_url property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 
 		//if $supports is not set then throw an error because that effectively means this template_pack does not have any templates!
-		if ( empty( $this->_supports ) ) {
-			throw new EE_Error( sprintf( __('The supports property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if (empty($this->_supports)) {
+			throw new EE_Error(sprintf(__('The supports property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 
@@ -241,8 +241,8 @@ 
 	 *
 	 * @return array
 	 */
-	public function get_templates( EE_messenger $messenger, EE_message_type $message_type ) {
-		return isset( $this->_templates[$messenger->name][$message_type->name] ) ? $this->_templates[$messenger->name][$message_type->name] : $this->_get_templates( $messenger, $message_type );
+	public function get_templates(EE_messenger $messenger, EE_message_type $message_type) {
+		return isset($this->_templates[$messenger->name][$message_type->name]) ? $this->_templates[$messenger->name][$message_type->name] : $this->_get_templates($messenger, $message_type);
 	}
 
 
@@ -259,7 +259,7 @@ 
 	 * @return array          Returns an multi-level associative array indexed by template context and field in the format:
 	 *                                array( 'context' => array( 'field' => 'value', 'another-field', 'value' ) );
 	 */
-	protected function _get_templates( EE_messenger $messenger, EE_message_type $message_type ) {
+	protected function _get_templates(EE_messenger $messenger, EE_message_type $message_type) {
 		$templates = array();
 
 		/**
@@ -278,28 +278,28 @@ 
 		$contexts = $message_type->get_contexts();
 
 
-		foreach ( $contexts as $context => $details ) {
-			foreach ( $fields as $field => $field_details ) {
-				if ( empty( $field_details ) )
+		foreach ($contexts as $context => $details) {
+			foreach ($fields as $field => $field_details) {
+				if (empty($field_details))
 					continue;
 				/**
 				 * is this a field array (linked to a main field)?
 				 */
-				if ( $field == 'extra'  ) {
-					foreach ( $field_details as $main_field => $sub_fields ) {
-						foreach ( $sub_fields as $sub_field => $sub_field_details ) {
+				if ($field == 'extra') {
+					foreach ($field_details as $main_field => $sub_fields) {
+						foreach ($sub_fields as $sub_field => $sub_field_details) {
 							//make sure that the template_field_ref matches what the main template field is for this template group.
 							$template_field_ref = $sub_field == 'main' ? $main_field : $sub_field;
-							$templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template( $default_pack, $messenger, $message_type, $template_field_ref, $context );
+							$templates[$context][$main_field][$sub_field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
 						}
 					}
 				} else {
-					$templates[ $context ][ $field ] = $this->_get_specific_template( $default_pack, $messenger, $message_type, $field, $context );
+					$templates[$context][$field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
 				}
 			}
 		}
 
-		$templates = apply_filters( 'FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this );
+		$templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this);
 
 		$this->_templates[$messenger->name][$message_type->name] = $templates;
 		 return $templates;
@@ -317,22 +317,22 @@ 
 	 *
 	 * @return string          The template contents.
 	 */
-	protected function _get_specific_template( $default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context ) {
+	protected function _get_specific_template($default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context) {
 
 		//default templates
-		$default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates( $messenger, $message_type ) : array();
+		$default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates($messenger, $message_type) : array();
 
 		//first we allow for the $_base_path to be filtered.  However, we assign this to a new variable so that we have the original base_path as a fallback.
-		$filtered_base_path = apply_filters( 'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this );
+		$filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this);
 
 		$master_templates = $message_type->get_master_templates();
-		$master_templates_mt = isset( $master_templates[$messenger->name] ) ? $master_templates[$messenger->name] : $message_type->name;
-		$full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php';
-		$fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php';
-		$mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-		$mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
-		$base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-		$base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
+		$master_templates_mt = isset($master_templates[$messenger->name]) ? $master_templates[$messenger->name] : $message_type->name;
+		$full_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'_'.$context.'.template.php';
+		$fallback_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'.template.php';
+		$mt_defined_full_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php';
+		$mt_defined_fallback_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php';
+		$base_defined_full_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php';
+		$base_defined_fallback_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php';
 
 		/**
 		 * Template checks are done hierarchically in the following order:
@@ -346,28 +346,28 @@ 
 		 */
 
 
-		if ( is_readable( $full_path ) ) {
+		if (is_readable($full_path)) {
 			$actual_path = $full_path;
-		} elseif ( is_readable( $fallback_path ) ) {
+		} elseif (is_readable($fallback_path)) {
 			$actual_path = $fallback_path;
-		} elseif ( is_readable( $mt_defined_full_path ) ) {
+		} elseif (is_readable($mt_defined_full_path)) {
 			$actual_path = $mt_defined_full_path;
-		} elseif ( is_readable( $mt_defined_fallback_path ) ) {
+		} elseif (is_readable($mt_defined_fallback_path)) {
 			$actual_path = $mt_defined_fallback_path;
-		} elseif ( is_readable( $base_defined_full_path ) ) {
+		} elseif (is_readable($base_defined_full_path)) {
 			$actual_path = $base_defined_full_path;
-		} elseif ( is_readable( $base_defined_fallback_path ) ) {
+		} elseif (is_readable($base_defined_fallback_path)) {
 			$actual_path = $base_defined_fallback_path;
-		} else  {
+		} else {
 			$actual_path = '';
 		}
-		if ( empty( $actual_path ) ) {
-			$contents = isset( $default_templates[$context][$field] ) ? $default_templates[$context][$field] : '';
+		if (empty($actual_path)) {
+			$contents = isset($default_templates[$context][$field]) ? $default_templates[$context][$field] : '';
 		} else {
-			$contents = EEH_Template::display_template( $actual_path, array(), TRUE );
+			$contents = EEH_Template::display_template($actual_path, array(), TRUE);
 		}
 
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this );
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this);
 	}
 
 
@@ -382,8 +382,8 @@ 
 	 * @return array
 	 */
 	public function get_supports() {
-		$supports = apply_filters( 'FHEE__' . get_class( $this ) . '__get_supports', $this->_supports );
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this );
+		$supports = apply_filters('FHEE__'.get_class($this).'__get_supports', $this->_supports);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this);
 	}
 
 
@@ -398,11 +398,11 @@ 
 	 *
 	 * @return array|string
 	 */
-	public function get_default_variation_labels( $messenger = '' ) {
-		$label = empty( $messenger ) ? $this->_default_variation_labels : array();
-		$label = empty( $label ) && ! empty( $this->_default_variation_labels[$messenger] ) ? $this->_default_variation_labels[$messenger] : __('Default', 'event_espresso');
+	public function get_default_variation_labels($messenger = '') {
+		$label = empty($messenger) ? $this->_default_variation_labels : array();
+		$label = empty($label) && ! empty($this->_default_variation_labels[$messenger]) ? $this->_default_variation_labels[$messenger] : __('Default', 'event_espresso');
 
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger );
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
 	}
 
 
@@ -418,25 +418,25 @@ 
 	 * @param string $message_type if included then css variations matching the message_type are returned (must have $messenger set).  Otherwise the array of variations per message type are returned.  If message_type is provided but NOT the messenger, then just all variations for all messengers are returned.
 	 * @return array
 	 */
-	public function get_variations( $messenger = '', $message_type = '' ) {
-		$messenger_variations = ! empty( $messenger ) && isset( $this->_variations[$messenger] ) ? $this->_variations[$messenger] : array();
+	public function get_variations($messenger = '', $message_type = '') {
+		$messenger_variations = ! empty($messenger) && isset($this->_variations[$messenger]) ? $this->_variations[$messenger] : array();
 
 		//message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
-		$variations = !empty( $messenger ) && !empty( $message_type ) && isset( $messenger_variations[$message_type] ) ? $messenger_variations[$message_type] : array();
+		$variations = ! empty($messenger) && ! empty($message_type) && isset($messenger_variations[$message_type]) ? $messenger_variations[$message_type] : array();
 
 		//now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
-		$variations = empty( $variations ) && !empty( $messenger ) && empty( $message_type ) ? $messenger_variations : $variations;
+		$variations = empty($variations) && ! empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
 
 		//filter per template pack and globally.
-		$variations = apply_filters( 'FHEE__' . get_class( $this ) . '__get_variations', $variations, $messenger, $message_type );
-		$variations = apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this );
+		$variations = apply_filters('FHEE__'.get_class($this).'__get_variations', $variations, $messenger, $message_type);
+		$variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
 
 		//prepend the _default_variation, but ONLY if we're returning the fully validated array.
-		if ( !empty( $messenger ) && !empty( $message_type ) && ! empty( $variations ) ) {
-			$variations = array( 'default' => $this->get_default_variation_labels( $messenger ) ) + $variations;
+		if ( ! empty($messenger) && ! empty($message_type) && ! empty($variations)) {
+			$variations = array('default' => $this->get_default_variation_labels($messenger)) + $variations;
 		}
 
-		return empty( $variations ) ? array( 'default' => $this->get_default_variation_labels('dft') ): $variations;
+		return empty($variations) ? array('default' => $this->get_default_variation_labels('dft')) : $variations;
 	}
 
 
@@ -457,39 +457,39 @@ 
 	 *
 	 * @return string The variation path or url (typically css reference)
 	 */
-	public function get_variation( $messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = FALSE ) {
+	public function get_variation($messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = FALSE) {
 
 		$base = $url ? $this->_base_url : $this->_base_path;
 		$base_path = $this->_base_path;
 
-		if ( ! $skip_filters ) {
-			$base =  apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this );
-			$base_path = apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, FALSE, $file_extension, $this );
+		if ( ! $skip_filters) {
+			$base = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
+			$base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, FALSE, $file_extension, $this);
 		}
 
-		$default_pack = get_class( $this ) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
+		$default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
 
 		//possible variation paths considering whether message type is present or not in the file name.
-		$path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
-		$default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
+		$path_string = 'variations/'.$messenger.'_'.$message_type.'_'.$type.'_'.$variation.$file_extension;
+		$default_path_string = 'variations/'.$messenger.'_'.$type.'_'.$variation.$file_extension;
 
 		//first see if fully validated file exists.
-		if ( is_readable( $base_path . $path_string ) ) {
-			$variation_path = $base . $path_string;
+		if (is_readable($base_path.$path_string)) {
+			$variation_path = $base.$path_string;
 		//otherwise see if default exists.
-		} elseif ( is_readable( $base_path . $default_path_string ) ) {
-			$variation_path = $base . $default_path_string;
+		} elseif (is_readable($base_path.$default_path_string)) {
+			$variation_path = $base.$default_path_string;
 		} else {
-			$variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation( $messenger, $message_type, $type, $url, $file_extension ) : '';
+			$variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
 		}
 
-		if ( $skip_filters ) {
+		if ($skip_filters) {
 			return $variation_path;
 		}
 
 		//filter result
-		$variation_path = apply_filters( 'FHEE__' . get_class( $this ) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url );
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this );
+		$variation_path = apply_filters('FHEE__'.get_class($this).'__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
 	}
 
 
@@ -504,19 +504,19 @@ 
 	 *
 	 * @return string returns the path for the requested wrapper template.
 	 */
-	public function get_wrapper( $messenger, $type = 'main' ) {
-		$default_pack = get_class( $this ) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : NULL;
+	public function get_wrapper($messenger, $type = 'main') {
+		$default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : NULL;
 
-		$path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
+		$path_string = $this->_base_path.$messenger.'_'.$type.'_wrapper.template.php';
 
-		if ( is_readable( $path_string ) ) {
+		if (is_readable($path_string)) {
 			$template = $path_string;
 		} else {
-			$template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper( $messenger, $type ) : '';
+			$template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : '';
 		}
 
 		//filter
-		$template = apply_filters( 'FHEE__' . get_class( $this ) . '__get_wrapper', $template, $messenger, $type );
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this );
+		$template = apply_filters('FHEE__'.get_class($this).'__get_wrapper', $template, $messenger, $type);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
 	}
 }

core/libraries/messages/EE_message_type.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -269,7 +269,7 @@ 
 	 * @param  EE_messenger $active_messenger The active messenger being used
 	 * @param  string $context if present then a message is only being generated for a specific context
 	 * @param  bool   $preview indicate whether a preview is being generated or not.
-	 * @return void
+	 * @return false|null
 	 */
 	public function set_messages($data, EE_messenger $active_messenger, $context = '', $preview = FALSE ) {
 
@@ -511,7 +511,7 @@ 
 	 * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
 	 * @param array $extra  This is just an extra argument that can be used to pass additional data for setting up page content.
 	 * @access public
-	 * @return void
+	 * @return string
 	 */
 	public function get_message_type_admin_page_content($page, $action = NULL, $extra = array(), $messengers = array() ) {
 		//we can also further refine the context by action (if present).
@@ -570,7 +570,7 @@ 
 	 * The main purpose of this function is to setup the various parameters within the message_type.  $this->addressees, $this->_templates, $this->count, and any extra stuff to the data object that can come from the message_type template options.
 	 * Child classes might overwrite this if they aren't expecting EE_Session as the incoming data object.
 	 *
-	 * @return void
+	 * @return boolean
 	 * @access protected
 	 * @throws EE_Error
 	 */
@@ -614,7 +614,7 @@ 
 	/**
 	 * processes the data object so we get
 	 * @throws EE_Error
-	 * @return void
+	 * @return boolean
 	 */
 	protected function _process_data() {
 		//at a minimum, we NEED EE_Attendee objects.
@@ -765,7 +765,7 @@ 
 	 * Takes care of setting up the addressee object(s) for the primary attendee.
 	 *
 	 * @access protected
-	 * @return array of EE_Addressee objects
+	 * @return EE_Messages_Addressee[] of EE_Addressee objects
 	 */
 	protected function _primary_attendee_addressees() {
 		$aee = $this->_default_addressee_data;
@@ -846,7 +846,7 @@ 
 
 	/**
 	 * get and set the templates for the type and messenger from the database
-	 * @return void
+	 * @return false|null
 	 * @access protected
 	 */
 	protected function _get_templates() {

Indentation +6 added lines, -6 removed lines

@@ -382,12 +382,12 @@
 
 
 	/**
-	* This sets up any action/filter hooks this message type puts in place for a specific messenger.  It's called from the set_messages() method.  Note that by default this does nothing.  Child classes will need to override if they want to add specific hooks for a messenger.
-	*
-	* @since 1.0.0
-	*
-	* @return void
-	*/
+	 * This sets up any action/filter hooks this message type puts in place for a specific messenger.  It's called from the set_messages() method.  Note that by default this does nothing.  Child classes will need to override if they want to add specific hooks for a messenger.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return void
+	 */
 	protected function _do_messenger_hooks() {
 		return;
 	}

Braces +21 added lines, -10 removed lines

@@ -1,6 +1,7 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -280,7 +281,9 @@ 
 
 		//this is a special method that allows child message types to trigger an exit from generating messages early (in cases where there may be a delay on send).
 		$exit = $this->_trigger_exit();
-		if ( $exit && ! $this->_preview ) return FALSE;
+		if ( $exit && ! $this->_preview ) {
+			return FALSE;
+		}
 
 		//todo: need to move require into registration hook but for now we'll require here.
 		EE_Registry::instance()->load_helper( 'Parse_Shortcodes' );
@@ -305,7 +308,9 @@ 
 		$exit = $this->_init_data();
 
 		//final check for if we exit or not cause child objects may have run conditionals that cleared out data so no addresees generated.
-		if ( $exit ) return FALSE;
+		if ( $exit ) {
+			return FALSE;
+		}
 
 		$this->_get_templates(); //get the templates that have been set with this type and for the given messenger that have been saved in the database.
 		$this->_assemble_messages();
@@ -619,14 +624,17 @@ 
 	protected function _process_data() {
 		//at a minimum, we NEED EE_Attendee objects.
 
-		if ( empty( $this->_data->attendees ) )
-			return TRUE;  //EXIT!
+		if ( empty( $this->_data->attendees ) ) {
+					return TRUE;
+		}
+		//EXIT!
 
 		//process addressees for each context.  Child classes will have to have methods for each context defined to handle the processing of the data object within them
 		foreach ( $this->_contexts as $context => $details ) {
 			$xpctd_method = '_' . $context . '_addressees';
-			if ( !method_exists( $this, $xpctd_method ) )
-				throw new EE_Error( sprintf( __('The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present', 'event_espresso'), $this->label['singular'], $xpctd_method) );
+			if ( !method_exists( $this, $xpctd_method ) ) {
+							throw new EE_Error( sprintf( __('The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present', 'event_espresso'), $this->label['singular'], $xpctd_method) );
+			}
 			 $this->_addressees[$context] = call_user_func( array( $this, $xpctd_method ) );
 		}
 		return FALSE; //DON'T EXIT
@@ -796,7 +804,9 @@ 
 			//set the attendee array to blank on each loop;
 			$aee = array();
 
-			if ( isset( $this->_data->reg_obj ) && ( $this->_data->reg_obj->attendee_ID() != $att_id ) && $this->_single_message ) continue;
+			if ( isset( $this->_data->reg_obj ) && ( $this->_data->reg_obj->attendee_ID() != $att_id ) && $this->_single_message ) {
+				continue;
+			}
 
 			//is $this->_regs_for_sending present?  If so, let's make sure we ONLY generate addressee for registrations in that array.
 			if ( ! empty( $this->_regs_for_sending ) && is_array( $this->_regs_for_sending ) ) {
@@ -963,8 +973,9 @@ 
 		$m_shortcodes = $this->_active_messenger->get_valid_shortcodes();
 
 		//if the 'to' field is empty (messages will ALWAYS have a "to" field, then we get out because this context is turned off) EXCEPT if we're previewing
-		if ( ( isset( $this->_templates['to'][$context] ) && empty( $this->_templates['to'][$context] ) ) && !$this->_preview )
-			return false;
+		if ( ( isset( $this->_templates['to'][$context] ) && empty( $this->_templates['to'][$context] ) ) && !$this->_preview ) {
+					return false;
+		}
 
 		if ( empty( $this->_templates ) ) {
 			//unable to setup any messages because there are no templates.  Some sort of catastrophic setup

Spacing +101 added lines, -101 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -271,7 +271,7 @@ 
 	 * @param  bool   $preview indicate whether a preview is being generated or not.
 	 * @return void
 	 */
-	public function set_messages($data, EE_messenger $active_messenger, $context = '', $preview = FALSE ) {
+	public function set_messages($data, EE_messenger $active_messenger, $context = '', $preview = FALSE) {
 
 		$this->_active_messenger = $active_messenger;
 
@@ -280,7 +280,7 @@ 
 
 		//this is a special method that allows child message types to trigger an exit from generating messages early (in cases where there may be a delay on send).
 		$exit = $this->_trigger_exit();
-		if ( $exit && ! $this->_preview ) return FALSE;
+		if ($exit && ! $this->_preview) return FALSE;
 
 		//todo: need to move require into registration hook but for now we'll require here.
 		//get shortcode_replace instance- set when _get_messages is called in child...
@@ -293,9 +293,9 @@ 
 		$this->_data_handler = ! $this->_preview ? $this->_data_handler : 'Preview';
 
 		//if there is an incoming context then this is a preview so let's ONLY show the given context!
-		if ( !empty( $context ) ) {
-			$cntxt = ! empty( $this->_contexts[$context] ) ? $this->_contexts[$context] : '';
-			if ( ! empty( $cntxt )  ) {
+		if ( ! empty($context)) {
+			$cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
+			if ( ! empty($cntxt)) {
 				$this->_contexts = array();
 				$this->_contexts[$context] = $cntxt;
 			}
@@ -304,7 +304,7 @@ 
 		$exit = $this->_init_data();
 
 		//final check for if we exit or not cause child objects may have run conditionals that cleared out data so no addresees generated.
-		if ( $exit ) return FALSE;
+		if ($exit) return FALSE;
 
 		$this->_get_templates(); //get the templates that have been set with this type and for the given messenger that have been saved in the database.
 		$this->_assemble_messages();
@@ -340,7 +340,7 @@ 
 	 * @param int      $id 		Optional. Integer corresponding to the value for the primary key of a EE_Base_Class_Object
 	 * @return mixed ( EE_Base_Class||EE_Base_Class[] )
 	 */
-	abstract protected function _get_data_for_context( $context, EE_Registration $registration, $id );
+	abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
 
 
 
@@ -372,7 +372,7 @@ 
 	 *
 	 * @return int
 	 */
-	protected function _get_id_for_msg_url( $context, EE_Registration $registration ) {
+	protected function _get_id_for_msg_url($context, EE_Registration $registration) {
 		return 0;
 	}
 
@@ -405,27 +405,27 @@ 
 	 *
 	 * @return string          generated url
 	 */
-	public function get_url_trigger( $context, $sending_messenger, EE_Registration $registration ) {
+	public function get_url_trigger($context, $sending_messenger, EE_Registration $registration) {
 
 		//validate context
 		//valid context?
-		if ( !isset( $this->_contexts[$context] ) ) {
-			throw new EE_Error( sprintf( __('The context %s is not a valid context for %s.', 'event_espresso'), $context, get_class( $this ) ) );
+		if ( ! isset($this->_contexts[$context])) {
+			throw new EE_Error(sprintf(__('The context %s is not a valid context for %s.', 'event_espresso'), $context, get_class($this)));
 		}
 
 		//valid sending_messenger?
 		$not_valid_msgr = FALSE;
-		foreach ( $this->_with_messengers as $generating => $sendings ) {
-			if ( empty( $sendings ) || array_search( $sending_messenger, $sendings ) === FALSE ) {
+		foreach ($this->_with_messengers as $generating => $sendings) {
+			if (empty($sendings) || array_search($sending_messenger, $sendings) === FALSE) {
 				$not_valid_msgr = TRUE;
 			}
 		}
 
-		if ( $not_valid_msgr ) {
-			throw new EE_Error( sprintf( __('The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.', 'event_espresso'), $sending_messenger, get_class( $this ) ) );
+		if ($not_valid_msgr) {
+			throw new EE_Error(sprintf(__('The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.', 'event_espresso'), $sending_messenger, get_class($this)));
 		}
 
-		return EEH_MSG_Template::generate_url_trigger( $sending_messenger, $this->_active_messenger->name, $context, $this->name, $registration, $this->_GRP_ID, $this->_get_id_for_msg_url( $context, $registration ) );
+		return EEH_MSG_Template::generate_url_trigger($sending_messenger, $this->_active_messenger->name, $context, $this->name, $registration, $this->_GRP_ID, $this->_get_id_for_msg_url($context, $registration));
 	}
 
 
@@ -446,19 +446,19 @@ 
 	 *
 	 * @return mixed (EE_Base_Class||EE_Base_Class[])
 	 */
-	public function get_data_for_context( $context, EE_Registration $registration, $id = 0 ) {
+	public function get_data_for_context($context, EE_Registration $registration, $id = 0) {
 		//valid context?
-		if ( !isset( $this->_contexts[$context] ) ) {
-			throw new EE_Error( sprintf( __('The context %s is not a valid context for %s.', 'event_espresso'), $context, get_class( $this ) ) );
+		if ( ! isset($this->_contexts[$context])) {
+			throw new EE_Error(sprintf(__('The context %s is not a valid context for %s.', 'event_espresso'), $context, get_class($this)));
 		}
 
 		//get data and apply global and class specific filters on it.
-		$data = apply_filters( 'FHEE__EE_message_type__get_data_for_context__data', $this->_get_data_for_context( $context, $registration, $id ), $this );
-		$data = apply_filters( 'FHEE__' . get_class( $this ) . '__get_data_for_context__data', $data, $this );
+		$data = apply_filters('FHEE__EE_message_type__get_data_for_context__data', $this->_get_data_for_context($context, $registration, $id), $this);
+		$data = apply_filters('FHEE__'.get_class($this).'__get_data_for_context__data', $data, $this);
 
 		//if empty then something went wrong!
-		if ( empty( $data ) ) {
-			throw new EE_Error( sprintf(  __('There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.', 'event_espresso'), $id, $this->name ) );
+		if (empty($data)) {
+			throw new EE_Error(sprintf(__('There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.', 'event_espresso'), $id, $this->name));
 		}
 
 		return $data;
@@ -493,7 +493,7 @@ 
 	 */
 	public function with_messengers() {
 
-		return apply_filters( 'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class( $this ), $this->_with_messengers);
+		return apply_filters('FHEE__EE_message_type__get_with_messengers__with_messengers__'.get_class($this), $this->_with_messengers);
 	}
 
 
@@ -511,9 +511,9 @@ 
 	 * @access public
 	 * @return void
 	 */
-	public function get_message_type_admin_page_content($page, $action = NULL, $extra = array(), $messengers = array() ) {
+	public function get_message_type_admin_page_content($page, $action = NULL, $extra = array(), $messengers = array()) {
 		//we can also further refine the context by action (if present).
-		return $this->_get_admin_page_content( $page, $action, $extra, $messengers );
+		return $this->_get_admin_page_content($page, $action, $extra, $messengers);
 	}
 
 
@@ -557,8 +557,8 @@ 
 	 */
 	public function get_master_templates() {
 		//first class specific filter then filter that by the global filter.
-		$master_templates = apply_filters( 'FHEE__' . get_class( $this ) . '__get_master_templates', $this->_master_templates );
-		return apply_filters( 'FHEE__EE_message_type__get_master_templates', $master_templates, $this );
+		$master_templates = apply_filters('FHEE__'.get_class($this).'__get_master_templates', $this->_master_templates);
+		return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
 	}
 
 
@@ -577,31 +577,31 @@ 
 		/**
 		 * first let's make sure that incoming data isn't empty!
 		 */
-		if ( is_array($this->_data) && empty($this->_data) && !$this->_preview ) {
-			$msg = sprintf( __( '"%s" message type incoming data is empty.  There is nothing to work with so why are you bugging me?', 'event_espresso'), $this->label['singular'] );
-			throw new EE_Error( $msg );
+		if (is_array($this->_data) && empty($this->_data) && ! $this->_preview) {
+			$msg = sprintf(__('"%s" message type incoming data is empty.  There is nothing to work with so why are you bugging me?', 'event_espresso'), $this->label['singular']);
+			throw new EE_Error($msg);
 		}
 
-		if ( empty( $this->_data_handler) ) {
-			$msg = sprintf( __('Hey %s hasn\'t declared a handler for the incoming data, so I\'m stuck', 'event_espresso'), __CLASS__ );
-			throw new EE_Error( $msg );
+		if (empty($this->_data_handler)) {
+			$msg = sprintf(__('Hey %s hasn\'t declared a handler for the incoming data, so I\'m stuck', 'event_espresso'), __CLASS__);
+			throw new EE_Error($msg);
 		}
 
 
 		//setup class name for the data handler
-		$classname = 'EE_Messages_' . $this->_data_handler . '_incoming_data';
+		$classname = 'EE_Messages_'.$this->_data_handler.'_incoming_data';
 
 		//check that the class exists
-		if ( !class_exists( $classname ) ) {
+		if ( ! class_exists($classname)) {
 
 			$msg[] = __('uhoh, Something went wrong and no data handler is found', 'event_espresso');
-			$msg[] = sprintf( __('The %s class has set the "$_data_handler" property but the string included (%s) does not match any existing "EE_Messages_incoming_data" classes (found in "/includes/core/messages/data_class").  Looking for %s.', 'event_espresso'), __CLASS__, $this->_data_handler, $classname );
-			throw new EE_error( implode('||', $msg) );
+			$msg[] = sprintf(__('The %s class has set the "$_data_handler" property but the string included (%s) does not match any existing "EE_Messages_incoming_data" classes (found in "/includes/core/messages/data_class").  Looking for %s.', 'event_espresso'), __CLASS__, $this->_data_handler, $classname);
+			throw new EE_error(implode('||', $msg));
 		}
 
 		//k lets get the prepared data object and replace existing data property with it.
-		$a = new ReflectionClass( $classname );
-		$this->_data = $a->newInstance( $this->_data );
+		$a = new ReflectionClass($classname);
+		$this->_data = $a->newInstance($this->_data);
 
 		$this->_set_default_addressee_data();
 		return $this->_process_data();
@@ -617,15 +617,15 @@ 
 	protected function _process_data() {
 		//at a minimum, we NEED EE_Attendee objects.
 
-		if ( empty( $this->_data->attendees ) )
-			return TRUE;  //EXIT!
+		if (empty($this->_data->attendees))
+			return TRUE; //EXIT!
 
 		//process addressees for each context.  Child classes will have to have methods for each context defined to handle the processing of the data object within them
-		foreach ( $this->_contexts as $context => $details ) {
-			$xpctd_method = '_' . $context . '_addressees';
-			if ( !method_exists( $this, $xpctd_method ) )
-				throw new EE_Error( sprintf( __('The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present', 'event_espresso'), $this->label['singular'], $xpctd_method) );
-			 $this->_addressees[$context] = call_user_func( array( $this, $xpctd_method ) );
+		foreach ($this->_contexts as $context => $details) {
+			$xpctd_method = '_'.$context.'_addressees';
+			if ( ! method_exists($this, $xpctd_method))
+				throw new EE_Error(sprintf(__('The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present', 'event_espresso'), $this->label['singular'], $xpctd_method));
+			 $this->_addressees[$context] = call_user_func(array($this, $xpctd_method));
 		}
 		return FALSE; //DON'T EXIT
 	}
@@ -660,8 +660,8 @@ 
 			'total_ticket_count' => $this->_data->total_ticket_count
 			);
 
-		if ( is_array( $this->_data->primary_attendee_data ) ) {
-			$this->_default_addressee_data = array_merge( $this->_default_addressee_data, $this->_data->primary_attendee_data );
+		if (is_array($this->_data->primary_attendee_data)) {
+			$this->_default_addressee_data = array_merge($this->_default_addressee_data, $this->_data->primary_attendee_data);
 			$this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
 			$this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
 		}
@@ -679,26 +679,26 @@ 
 	 * see abstract declaration in parent class for details, children message types can override these valid shortcodes if desired (we include all for all contexts by default).
 	 */
 	protected function _set_valid_shortcodes() {
-		$all_shortcodes = array( 'attendee_list', 'attendee', 'datetime_list', 'datetime', 'event_list', 'event_meta', 'event', 'organization', 'recipient_details', 'recipient_list', 'ticket_list', 'ticket', 'transaction', 'venue', 'primary_registration_details', 'primary_registration_list', 'event_author', 'email', 'messenger' );
+		$all_shortcodes = array('attendee_list', 'attendee', 'datetime_list', 'datetime', 'event_list', 'event_meta', 'event', 'organization', 'recipient_details', 'recipient_list', 'ticket_list', 'ticket', 'transaction', 'venue', 'primary_registration_details', 'primary_registration_list', 'event_author', 'email', 'messenger');
 		$contexts = $this->get_contexts();
-		foreach ( $contexts as $context => $details ) {
+		foreach ($contexts as $context => $details) {
 			$this->_valid_shortcodes[$context] = $all_shortcodes;
 
 			//make sure non admin context does not include the event_author shortcodes
-			if ( $context != 'admin' ) {
-				if( ($key = array_search('event_author', $this->_valid_shortcodes[$context] ) ) !== false) {
+			if ($context != 'admin') {
+				if (($key = array_search('event_author', $this->_valid_shortcodes[$context])) !== false) {
 					unset($this->_valid_shortcodes[$context][$key]);
 				}
 			}
 		}
 
 		//make sure admin context does not include the recipient_details shortcodes IF we have admin context hooked in message types might not have that context.
-		if ( !empty( $this->_valid_shortcodes['admin'] ) ) {
-			if( ($key = array_search('recipient_details', $this->_valid_shortcodes['admin'] ) ) !== false) {
+		if ( ! empty($this->_valid_shortcodes['admin'])) {
+			if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
 					unset($this->_valid_shortcodes['admin'][$key]);
 				}
 			//make sure admin context does not include the recipient_details shortcodes
-			if( ($key = array_search('recipient_list', $this->_valid_shortcodes['admin'] ) ) !== false) {
+			if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
 					unset($this->_valid_shortcodes['admin'][$key]);
 				}
 		}
@@ -711,8 +711,8 @@ 
 	 * @param  array  $new_config array of valid shortcodes (by context)
 	 * @return void               sets valid_shortcodes property
 	 */
-	public function reset_valid_shortcodes_config( $new_config ) {
-		foreach ( $new_config as $context => $shortcodes ) {
+	public function reset_valid_shortcodes_config($new_config) {
+		foreach ($new_config as $context => $shortcodes) {
 			$this->_valid_shortcodes[$context] = $shortcodes;
 		}
 	}
@@ -732,7 +732,7 @@ 
 		$addressees = array();
 
 		//first we need to get the event admin user id for all the events and setup an addressee object for each unique admin user.
-		foreach ( $this->_data->events as $line_ref => $event ) {
+		foreach ($this->_data->events as $line_ref => $event) {
 			$admin_id = $this->_get_event_admin_id($event['ID']);
 			//get the user_id for the event
 			$admin_ids[] = $admin_id;
@@ -744,14 +744,14 @@ 
 		$admin_ids = array_unique($admin_ids);
 
 		//k now we can loop through the event_admins and setup the addressee data.
-		foreach ( $admin_ids as $event_admin ) {
+		foreach ($admin_ids as $event_admin) {
 			$aee = array(
 				'user_id' => $event_admin,
 				'events' => $admin_events[$event_admin],
 				'attendees' => $this->_data->attendees
 				);
-			$aee = array_merge( $this->_default_addressee_data, $aee );
-			$addressees[] = new EE_Messages_Addressee( $aee );
+			$aee = array_merge($this->_default_addressee_data, $aee);
+			$addressees[] = new EE_Messages_Addressee($aee);
 		}
 
 		return $addressees;
@@ -771,7 +771,7 @@ 
 		$aee['attendees'] = $this->_data->attendees;
 
 		//great now we can instantiate the $addressee object and return (as an array);
-		$add[] = new EE_Messages_Addressee( $aee );
+		$add[] = new EE_Messages_Addressee($aee);
 		return $add;
 	}
 
@@ -790,38 +790,38 @@ 
 		//use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
 		$already_processed = array();
 
-		foreach ( $this->_data->attendees as $att_id => $details ) {
+		foreach ($this->_data->attendees as $att_id => $details) {
 			//set the attendee array to blank on each loop;
 			$aee = array();
 
-			if ( isset( $this->_data->reg_obj ) && ( $this->_data->reg_obj->attendee_ID() != $att_id ) && $this->_single_message ) continue;
+			if (isset($this->_data->reg_obj) && ($this->_data->reg_obj->attendee_ID() != $att_id) && $this->_single_message) continue;
 
 			//is $this->_regs_for_sending present?  If so, let's make sure we ONLY generate addressee for registrations in that array.
-			if ( ! empty( $this->_regs_for_sending ) && is_array( $this->_regs_for_sending ) ) {
-				$regs_allowed = array_intersect_key( array_flip( $this->_regs_for_sending ), $details['reg_objs'] );
-				if ( empty( $regs_allowed ) ) {
+			if ( ! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+				$regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
+				if (empty($regs_allowed)) {
 					continue;
 				}
 			}
 
 			if (
-				in_array( $details['attendee_email'], $already_processed )
-				&& apply_filters( 'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends', true, $this->_data, $this )
+				in_array($details['attendee_email'], $already_processed)
+				&& apply_filters('FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends', true, $this->_data, $this)
 			) {
 				continue;
 			}
 
 			$already_processed[] = $details['attendee_email'];
 
-			foreach ( $details as $item => $value ) {
+			foreach ($details as $item => $value) {
 				$aee[$item] = $value;
-				if ( $item == 'line_ref' ) {
-					foreach ( $value as $event_id ) {
+				if ($item == 'line_ref') {
+					foreach ($value as $event_id) {
 						$aee['events'][$event_id] = $this->_data->events[$event_id];
 					}
 				}
 
-				if ( $item == 'attendee_email' ) {
+				if ($item == 'attendee_email') {
 					$aee['attendee_email'] = $value;
 				}
 
@@ -836,8 +836,8 @@ 
 			$aee['attendees'] = $this->_data->attendees;
 
 			//merge in the primary attendee data
-			$aee = array_merge( $this->_default_addressee_data, $aee );
-			$add[] = new EE_Messages_Addressee( $aee );
+			$aee = array_merge($this->_default_addressee_data, $aee);
+			$add[] = new EE_Messages_Addressee($aee);
 		}
 
 		return $add;
@@ -862,46 +862,46 @@ 
 		);
 
 		//in vanilla EE we're assuming there's only one event.  However, if there are multiple events then we'll just use the default templates instead of different templates per event (which could create problems).
-		if ( count($this->_data->events) === 1 ) {
-			foreach ( $this->_data->events as $event ) {
+		if (count($this->_data->events) === 1) {
+			foreach ($this->_data->events as $event) {
 				$EVT_ID = $event['ID'];
 			}
 		}
 		// is there a Group ID in the incoming request?
-		EE_Registry::instance()->load_core( 'Request_Handler' );
+		EE_Registry::instance()->load_core('Request_Handler');
 		// if not, set a default value of false
-		$GRP_ID = EE_Registry::instance()->REQ->get( 'GRP_ID', false );
+		$GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID', false);
 		//if this is a preview then we just get whatever message group is for the preview and skip this part!
-		if ( $this->_preview && $GRP_ID ) {
-			$mtpg = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+		if ($this->_preview && $GRP_ID) {
+			$mtpg = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
 		} else {
 			//not a preview or test send so lets continue on our way!
 			//is there an evt_id?  If so let's get that. template.
-			if ( !empty( $EVT_ID )  ) {
+			if ( ! empty($EVT_ID)) {
 				$evt_qa = array(
 					'Event.EVT_ID' => $EVT_ID
 				);
-				$qa = array_merge( $template_qa, $evt_qa );
-				$mtpg = EEM_Message_Template_Group::instance()->get_one( array( $qa ) );
+				$qa = array_merge($template_qa, $evt_qa);
+				$mtpg = EEM_Message_Template_Group::instance()->get_one(array($qa));
 			}
 
 			//is there a 'GRP_ID' ? if so let's get that.
 
 			//if global template is NOT an override, and there is a 'GRP_ID' in the request, then we'll assume a specific template has ben requested.
-			if ( $GRP_ID ) {
-				$mtpg = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+			if ($GRP_ID) {
+				$mtpg = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
 			}
 
 
 			$template_qa['MTP_is_global'] = TRUE;
 
 			//this gets the current global template (message template group) for the active messenger and message type.
-			$global_mtpg = EEM_Message_Template_Group::instance()->get_one( array( $template_qa ) );
+			$global_mtpg = EEM_Message_Template_Group::instance()->get_one(array($template_qa));
 
-			$mtpg = $mtpg instanceof EE_Message_Template_Group && ! $global_mtpg->get( 'MTP_is_override' ) ? $mtpg : $global_mtpg;
+			$mtpg = $mtpg instanceof EE_Message_Template_Group && ! $global_mtpg->get('MTP_is_override') ? $mtpg : $global_mtpg;
 		}
 
-		if ( ! $mtpg instanceof EE_Message_Template_Group ) {
+		if ( ! $mtpg instanceof EE_Message_Template_Group) {
 			//get out because we can't process anything, there are no message template groups
 			// and thus some sort of bad setup issues.
 			return false;
@@ -917,8 +917,8 @@ 
 
 
 
-		foreach ( $templates as $context => $template_fields ) {
-			foreach( $template_fields as $template_field=> $template_obj ) {
+		foreach ($templates as $context => $template_fields) {
+			foreach ($template_fields as $template_field=> $template_obj) {
 				$this->_templates[$template_field][$context] = $template_obj->get('MTP_content');
 			}
 		}
@@ -933,11 +933,11 @@ 
 	protected function _assemble_messages() {
 		//make sure any set messages object is cleared
 		$this->messages = array();
-		foreach ( $this->_addressees as $context => $addressees ) {
-			foreach ( $addressees as $addressee ) {
+		foreach ($this->_addressees as $context => $addressees) {
+			foreach ($addressees as $addressee) {
 				$message = $this->_setup_message_object($context, $addressee);
 				//only assign message if everything went okay
-				if ( $message ) {
+				if ($message) {
 					$message->template_pack = $this->_template_pack;
 					$message->variation = $this->_variation;
 					$this->messages[] = $message;
@@ -961,22 +961,22 @@ 
 		$m_shortcodes = $this->_active_messenger->get_valid_shortcodes();
 
 		//if the 'to' field is empty (messages will ALWAYS have a "to" field, then we get out because this context is turned off) EXCEPT if we're previewing
-		if ( ( isset( $this->_templates['to'][$context] ) && empty( $this->_templates['to'][$context] ) ) && !$this->_preview )
+		if ((isset($this->_templates['to'][$context]) && empty($this->_templates['to'][$context])) && ! $this->_preview)
 			return false;
 
-		if ( empty( $this->_templates ) ) {
+		if (empty($this->_templates)) {
 			//unable to setup any messages because there are no templates.  Some sort of catastrophic setup
 			//issue exists
 			return false;
 		}
 
-		foreach ( $this->_templates as $field => $ctxt ) {
+		foreach ($this->_templates as $field => $ctxt) {
 			//let's setup the valid shortcodes for the incoming context.
 			$valid_shortcodes = $mt_shortcodes[$context];
 			//merge in valid shortcodes for the field.
 			$shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
-			if ( isset( $this->_templates[$field][$context] ) ) {
-				$message->{$field} = $this->_shortcode_replace->parse_message_template($this->_templates[$field][$context], $addressee, $shortcodes, $this, $this->_active_messenger, $context, $this->_GRP_ID );
+			if (isset($this->_templates[$field][$context])) {
+				$message->{$field} = $this->_shortcode_replace->parse_message_template($this->_templates[$field][$context], $addressee, $shortcodes, $this, $this->_active_messenger, $context, $this->_GRP_ID);
 			}
 		}
 		return $message;

core/libraries/messages/EE_messages.lib.php

Doc Comments +7 added lines, -6 removed lines

@@ -125,9 +125,6 @@ 
 	/**
 	 * Activates the specified messenger
 	 * @param string $messenger_name
-	 * @param array $message_types (optional) An array of message types to activate with this messenger.  If
-	 *                             				included we do NOT setup the default message types (assuming
-	 *                             				they are already setup.)
 	 * @return boolean an array of generated templates or false if nothing generated/activated.
 	 */
 	public function activate_messenger( $messenger_name, $mts = array() ){
@@ -275,7 +272,7 @@ 
 	 * Used to verify if a message can be sent for the given messenger and message type and that it is a generating messenger (used for generating message templates).
 	 *
 	 * @param EE_messenger $messenger    messenger used in trigger
-	 * @param EE_messagetype $message_type message type used in trigger
+	 * @param EE_message_type $message_type message type used in trigger
 	 *
 	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
 	 */
@@ -500,7 +497,7 @@ 
 	 *
 	 * @param string       $messenger a string matching a valid active messenger in the system
 	 * @param string       $message_type   Although it seems contrary to the name of the method, a message type name is still required to send along the message type to the messenger because this is used for determining what specific variations might be loaded for the generated message.
-	 * @param stdClass $messages  a stdClass object in the format expected by the messenger.
+	 * @param stdClass $message  a stdClass object in the format expected by the messenger.
 	 *
 	 * @return bool          success or fail.
 	 */
@@ -573,6 +570,7 @@ 
 	/**
 	 * This is a wrapper for the protected _create_new_templates function
 	 * @param  string $message_type message type that the templates are being created for
+	 * @param string $messenger
 	 * @return array|object               if creation is succesful then we return an array of info, otherwise an error_object is returned.
 	 */
 	public function create_new_templates( $messenger, $message_type, $GRP_ID = 0, $is_global = false ) {
@@ -594,6 +592,10 @@ 
 		return $this->_create_new_templates($GRP_ID, $is_global);
 	}
 
+	/**
+	 * @param integer $GRP_ID
+	 * @param boolean $is_global
+	 */
 	protected function _create_new_templates($GRP_ID, $is_global) {
 
 		//if we're creating a custom template then we don't need to use the defaults class
@@ -713,7 +715,6 @@ 
 	 *
 	 * @access public
 	 * @param string $type we can indicate just returning installed message types or messengers (or both) via this parameter.
-	 * @param bool  $set if true then we skip the cache and retrieve via files.
 	 * @return array multidimensional array of messenger and message_type objects (messengers index, and message_type index);
 	 */
 	public function get_installed( $type = 'all', $skip_cache = false ) {

Indentation +1 added lines, -1 removed lines

@@ -302,7 +302,7 @@
 	 * @param  string $sending_messenger if included then we ONLY use the specified messenger for delivery.  Otherwise we cycle through all active messengers.
 	 * @param string $generating_messenger if included then this messenger is used for generating the message templates (but not for sending).
 	 * @param string $context If included then only a message type for a specific context will be generated.
-	  * @param bool  $send 			       Default TRUE.  If false, then this will just return the generated EE_Messages objects which might be used by the trigger to setup a batch message (typically html messenger uses it).
+	 * @param bool  $send 			       Default TRUE.  If false, then this will just return the generated EE_Messages objects which might be used by the trigger to setup a batch message (typically html messenger uses it).
 	 * @return bool
 	 */
 	public function send_message( $type, $vars, $sending_messenger = '', $generating_messenger='', $context='', $send = TRUE ) {

Braces +27 added lines, -16 removed lines

@@ -1,7 +1,8 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -90,7 +91,7 @@ 
 		if( ! isset( $active_messengers[ $messenger_name ] ) ) {
 			$this->activate_messenger( $messenger_name );
 			return FALSE;
-		}else{
+		} else{
 			return TRUE;
 		}
 	}
@@ -207,7 +208,9 @@ 
 	private function _load_files($kind, $actives) {
 		$active_names = array();
 		$base_path = EE_LIBRARIES . 'messages' . DS . $kind . DS;
-		if ( empty($actives) ) return false;
+		if ( empty($actives) ) {
+			return false;
+		}
 
 		//make sure autoloaders are set (failsafe)
 		EED_Messages::set_autoloaders();
@@ -418,8 +421,9 @@ 
 			if ( isset( $this->_active_messengers[$messenger] ) ) {
 
 				//we ONLY continue if the given messenger has that message type active with it (note previews only come from primary messengers so no need to check secondarys)
-				if ( !isset( $this->_active_message_types[$messenger][$type] ) )
-					return false;
+				if ( !isset( $this->_active_message_types[$messenger][$type] ) ) {
+									return false;
+				}
 
 				$message = $installed_message_types[$type];
 				$messenger = $this->_active_messengers[$messenger];
@@ -553,8 +557,9 @@ 
 
 
 		//do we have the necessary objects loaded?
-		if ( empty( $this->_messenger) || empty($this->_message_type) )
-			throw new EE_Error( sprintf( __(' The %s messenger or the %s message_type are not active. Are you sure they exist?', 'event_espresso'), $messenger, $message_type ) );
+		if ( empty( $this->_messenger) || empty($this->_message_type) ) {
+					throw new EE_Error( sprintf( __(' The %s messenger or the %s message_type are not active. Are you sure they exist?', 'event_espresso'), $messenger, $message_type ) );
+		}
 
 		//is given message_type valid for given messenger (if this is not a global save)
 		$types_to_check = array();
@@ -597,8 +602,9 @@ 
 	protected function _create_new_templates($GRP_ID, $is_global) {
 
 		//if we're creating a custom template then we don't need to use the defaults class
-		if ( ! $is_global )
-			return $this->_create_custom_template_group( $GRP_ID );
+		if ( ! $is_global ) {
+					return $this->_create_custom_template_group( $GRP_ID );
+		}
 
 		$DFLT = new EE_Message_Template_Defaults( $this, $this->_messenger->name, $this->_message_type->name, $GRP_ID );
 
@@ -663,14 +669,16 @@ 
 
 		//add new message templates and add relation to.
 		foreach ( $mtts as $mtt ) {
-			if ( ! $mtt instanceof EE_Message_Template )
-				continue;
+			if ( ! $mtt instanceof EE_Message_Template ) {
+							continue;
+			}
 			$nmtt = clone $mtt;
 			$nmtt->set('MTP_ID', 0);
 			$nmtt->set( 'GRP_ID', $new_mtg->ID() ); //relation
 			$nmtt->save();
-			if ( empty( $success['MTP_context'] ) )
-				$success['MTP_context'] = $nmtt->get('MTP_context');
+			if ( empty( $success['MTP_context'] ) ) {
+							$success['MTP_context'] = $nmtt->get('MTP_context');
+			}
 		}
 
 		return $success;
@@ -761,7 +769,9 @@ 
 			$classname = preg_match("/" . $replace . "/", $filename ) ? str_replace($replace, "", $filename) : false;
 
 			//no classname? no match? move along, nothing to see here. note, the stripos is checking to make sure the filename (classname) begins with EE.
-			if ( !$classname || 0 !== stripos($classname, 'EE') ) continue;
+			if ( !$classname || 0 !== stripos($classname, 'EE') ) {
+				continue;
+			}
 
 			//note: I'm not sure if this will work without including the file.  We do have autoloaders so it "may" work.
 			$a = new ReflectionClass($classname);
@@ -786,8 +796,9 @@ 
 		$message_types = array();
 		foreach ( $this->_active_message_types as $messenger => $mtvalues ) {
 			foreach ( $mtvalues as $mt => $config ) {
-				if ( !in_array( $mt, $message_types ) )
-					$message_types[] = $mt;
+				if ( !in_array( $mt, $message_types ) ) {
+									$message_types[] = $mt;
+				}
 			}
 		}
 

Spacing +155 added lines, -155 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -59,17 +59,17 @@ 
 		$actives = is_array($_actives) ? array_keys($_actives) : $_actives;
 		$active_names = $this->_load_files('messenger', $actives);
 
-		if ( is_array($active_names) ) {
-			foreach ( $active_names as $name => $class ) {
-				$a = new ReflectionClass( $class );
+		if (is_array($active_names)) {
+			foreach ($active_names as $name => $class) {
+				$a = new ReflectionClass($class);
 				$active = $a->newInstance();
-				if ( is_wp_error($active) ) {
+				if (is_wp_error($active)) {
 					//we've got an error so let's bubble up the error_object to be caught by caller.
 					//todo: would be better to just catch the errors and then return any aggregated errors later.
 					EE_Error::add_error($active->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
 				}
 				$this->_active_messengers[$name] = $active;
-				$this->_active_message_types[$name] = ! empty( $_actives[$name]['settings'][$name . '-message_types'] ) ? $_actives[$name]['settings'][$name . '-message_types'] : array();
+				$this->_active_message_types[$name] = ! empty($_actives[$name]['settings'][$name.'-message_types']) ? $_actives[$name]['settings'][$name.'-message_types'] : array();
 			}
 		}
 	}
@@ -80,13 +80,13 @@ 
 	 * @param string $messenger_name
 	 * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
 	 */
-	public function ensure_messenger_is_active( $messenger_name ){
+	public function ensure_messenger_is_active($messenger_name) {
 		//note: active messengers indexed by their names
 		$active_messengers = EEH_MSG_Template::get_active_messengers_in_db();
-		if( ! isset( $active_messengers[ $messenger_name ] ) ) {
-			$this->activate_messenger( $messenger_name );
+		if ( ! isset($active_messengers[$messenger_name])) {
+			$this->activate_messenger($messenger_name);
 			return FALSE;
-		}else{
+		} else {
 			return TRUE;
 		}
 	}
@@ -101,21 +101,21 @@ 
 	 *
 	 * @return boolean true if it got activated (or was active) and false if not.
 	 */
-	public function ensure_message_type_is_active( $message_type, $messenger ) {
+	public function ensure_message_type_is_active($message_type, $messenger) {
 		//first validate that the incoming messenger allows this message type to be activated.
 		$messengers = $this->get_installed_messengers();
-		if ( ! isset( $messengers[$messenger] ) ) {
-			throw new EE_Error( sprintf( __('The messenger sent to %s is not installed', 'event_espresso'), __METHOD__ ) );
+		if ( ! isset($messengers[$messenger])) {
+			throw new EE_Error(sprintf(__('The messenger sent to %s is not installed', 'event_espresso'), __METHOD__));
 		}
 
 		$msgr = $messengers[$messenger];
 		$valid_message_types = $msgr->get_valid_message_types();
-		if ( ! in_array( $message_type, $valid_message_types ) ) {
-			throw new EE_Error( sprint_f( __('The message type ($1%s) sent to $2%s is not valid for the $3%s messenger.  Doublecheck the spelling and verify that message type has been registered as a valid type with the messenger.', 'event_espresso' ), $message_type, __METHOD__, $messenger ) );
+		if ( ! in_array($message_type, $valid_message_types)) {
+			throw new EE_Error(sprint_f(__('The message type ($1%s) sent to $2%s is not valid for the $3%s messenger.  Doublecheck the spelling and verify that message type has been registered as a valid type with the messenger.', 'event_espresso'), $message_type, __METHOD__, $messenger));
 		}
 
 		//all is good so let's just get it active
-		return $this->activate_messenger( $messenger, array( $message_type ) );
+		return $this->activate_messenger($messenger, array($message_type));
 	}
 
 	/**
@@ -126,7 +126,7 @@ 
 	 *                             				they are already setup.)
 	 * @return boolean an array of generated templates or false if nothing generated/activated.
 	 */
-	public function activate_messenger( $messenger_name, $mts = array() ){
+	public function activate_messenger($messenger_name, $mts = array()) {
 		$active_messengers = EEH_MSG_Template::get_active_messengers_in_db();
 		$message_types = $this->get_installed_message_types();
 		$installed_messengers = $this->get_installed_messengers();
@@ -134,33 +134,33 @@ 
 		$templates = false;
 
 		//get has_active so we can be sure its kept up to date.
-		$has_activated = get_option( 'ee_has_activated_messenger' );
+		$has_activated = get_option('ee_has_activated_messenger');
 
 		//grab the messenger to work with.
-		$messenger = isset( $installed_messengers[$messenger_name] ) ? $installed_messengers[$messenger_name] : null;
+		$messenger = isset($installed_messengers[$messenger_name]) ? $installed_messengers[$messenger_name] : null;
 
 		//it's inactive. Activate it.
 
-		if( $messenger instanceof EE_messenger ) {
-			$active_messengers[ $messenger->name ][ 'obj' ] = $messenger;
+		if ($messenger instanceof EE_messenger) {
+			$active_messengers[$messenger->name]['obj'] = $messenger;
 
 			/** @var EE_messenger[] $installed_messengers  */
-			$mts_to_activate = ! empty( $mts ) ? $mts :  $messenger->get_default_message_types();
-			foreach ( $mts_to_activate as $message_type ) {
+			$mts_to_activate = ! empty($mts) ? $mts : $messenger->get_default_message_types();
+			foreach ($mts_to_activate as $message_type) {
 				//we need to setup any initial settings for message types
 				/** @var EE_message_type[] $installed_mts */
-				$settings_fields = isset( $message_types[$message_type] ) ? $message_types[ $message_type ]->get_admin_settings_fields() : array();
-				if ( !empty( $settings_fields ) ) {
-					foreach ( $settings_fields as $field => $values ) {
-						$settings[$field] = $values[ 'default' ];
+				$settings_fields = isset($message_types[$message_type]) ? $message_types[$message_type]->get_admin_settings_fields() : array();
+				if ( ! empty($settings_fields)) {
+					foreach ($settings_fields as $field => $values) {
+						$settings[$field] = $values['default'];
 					}
 				} else {
 					$settings = array();
 				}
 
-				$active_messengers[ $messenger->name ][ 'settings' ][ $messenger->name . '-message_types' ][ $message_type ][ 'settings' ] = $settings;
+				$active_messengers[$messenger->name]['settings'][$messenger->name.'-message_types'][$message_type]['settings'] = $settings;
 
-				if (  ! empty( $has_activated[$messenger->name] ) && ! in_array( $message_type, $has_activated[$messenger->name] ) ) {
+				if ( ! empty($has_activated[$messenger->name]) && ! in_array($message_type, $has_activated[$messenger->name])) {
 					$has_activated[$messenger->name][] = $message_type;
 				}
 			}
@@ -168,22 +168,22 @@ 
 			//setup any initial settings for the messenger
 			$msgr_settings = $messenger->get_admin_settings_fields();
 
-			if ( !empty( $msgr_settings ) ) {
-				foreach ( $msgr_settings as $field => $value ) {
-					$active_messengers[ $messenger->name ][ 'settings' ][ $field ] = $value;
+			if ( ! empty($msgr_settings)) {
+				foreach ($msgr_settings as $field => $value) {
+					$active_messengers[$messenger->name]['settings'][$field] = $value;
 				}
 			}
 
-			EEH_MSG_Template::update_active_messengers_in_db( $active_messengers );
-			update_option( 'ee_has_activated_messenger', $has_activated );
+			EEH_MSG_Template::update_active_messengers_in_db($active_messengers);
+			update_option('ee_has_activated_messenger', $has_activated);
 
 			//make sure that the cached active_messengers is set on this object
 			$this->_active_messengers[$messenger->name] = $messenger;
 			$this->_active_message_types[$messenger->name] = $active_messengers[$messenger->name];
 
 			//might need to generate new templates
-			if ( ! empty( $mts_to_activate ) ) {
-				$templates = EEH_MSG_Template::generate_new_templates( $messenger->name, $mts_to_activate, 0, TRUE );
+			if ( ! empty($mts_to_activate)) {
+				$templates = EEH_MSG_Template::generate_new_templates($messenger->name, $mts_to_activate, 0, TRUE);
 			}
 		}
 
@@ -202,8 +202,8 @@ 
 	 */
 	private function _load_files($kind, $actives) {
 		$active_names = array();
-		$base_path = EE_LIBRARIES . 'messages' . DS . $kind . DS;
-		if ( empty($actives) ) return false;
+		$base_path = EE_LIBRARIES.'messages'.DS.$kind.DS;
+		if (empty($actives)) return false;
 
 		//make sure autoloaders are set (failsafe)
 		EED_Messages::set_autoloaders();
@@ -211,17 +211,17 @@ 
 		//make sure $actives is an array
 		$actives = (array) $actives;
 
-		foreach ( $actives as $active ) {
-			$msg_name = 'EE_' . ucwords( str_replace( ' ', '_', $active) ) . '_' . $kind;
-			$filename = $msg_name . '.class.php';
-			$load_file = $base_path . DS . $filename;
-			if ( is_readable($load_file) ) {
+		foreach ($actives as $active) {
+			$msg_name = 'EE_'.ucwords(str_replace(' ', '_', $active)).'_'.$kind;
+			$filename = $msg_name.'.class.php';
+			$load_file = $base_path.DS.$filename;
+			if (is_readable($load_file)) {
 				require_once($load_file);
 				$active_names[$active] = $msg_name;
 			} else {
 				$this->_unset_active($active, $kind);
 				//set WP_Error
-				return EE_Error::add_error( sprintf( __("Missing messages system file set as inactive: (%s) %s has been made inactive.", 'event_espresso'), $load_file, $msg_name), __FILE__, __FUNCTION__, __LINE__ );
+				return EE_Error::add_error(sprintf(__("Missing messages system file set as inactive: (%s) %s has been made inactive.", 'event_espresso'), $load_file, $msg_name), __FILE__, __FUNCTION__, __LINE__);
 			}
 		}
 		return $active_names;
@@ -238,24 +238,24 @@ 
 	 * @param  string $kind        messenger or message_type?
 	 * @return void
 	 */
-	private function _unset_active( $active_name, $kind ) {
+	private function _unset_active($active_name, $kind) {
 		//pluralize
 		$active_messengers = EEH_MSG_Template::get_active_messengers_in_db();
-		if ( $kind == 'messenger' ) {
-			unset( $active_messengers[$active_name] );
-			EEH_MSG_Template::update_to_inactive( $active_name );
-			if ( isset( $this->_active_messengers[$active_name] ) ) {
-				unset( $this->_active_messengers[$active_name] );
+		if ($kind == 'messenger') {
+			unset($active_messengers[$active_name]);
+			EEH_MSG_Template::update_to_inactive($active_name);
+			if (isset($this->_active_messengers[$active_name])) {
+				unset($this->_active_messengers[$active_name]);
 			}
 		} else {
-			foreach( $active_messengers as $messenger => $settings ) {
-				if ( ! empty( $settings['settings'][$messenger . '-message_types'][$active_name] ) ) {
-					unset( $active_messengers[$messenger]['settings'][$messenger . '-message_types'][$active_name] );
+			foreach ($active_messengers as $messenger => $settings) {
+				if ( ! empty($settings['settings'][$messenger.'-message_types'][$active_name])) {
+					unset($active_messengers[$messenger]['settings'][$messenger.'-message_types'][$active_name]);
 				}
 			}
-			EEH_MSG_Template::update_to_inactive( '', $active_name );
-			if ( isset( $this->_active_message_types[$active_name] ) ) {
-				unset( $this->_active_message_types[$active_name] );
+			EEH_MSG_Template::update_to_inactive('', $active_name);
+			if (isset($this->_active_message_types[$active_name])) {
+				unset($this->_active_message_types[$active_name]);
 			}
 		}
 
@@ -273,13 +273,13 @@ 
 	 *
 	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
 	 */
-	private function _is_generating_messenger_and_active( EE_messenger $messenger, EE_message_type $message_type ) {
+	private function _is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type) {
 		$generating_msgrs = array();
 		//get the $messengers the message type says it can be used with.
 		$used_with = $message_type->with_messengers();
 
-		foreach ( $used_with as $generating_msgr => $secondary_msgrs ) {
-			if ( $messenger->name == $generating_msgr && isset( $this->_active_message_types[$generating_msgr][$message_type->name] ) ) {
+		foreach ($used_with as $generating_msgr => $secondary_msgrs) {
+			if ($messenger->name == $generating_msgr && isset($this->_active_message_types[$generating_msgr][$message_type->name])) {
 				return true;
 			}
 		}
@@ -299,7 +299,7 @@ 
 	  * @param bool  $send 			       Default TRUE.  If false, then this will just return the generated EE_Messages objects which might be used by the trigger to setup a batch message (typically html messenger uses it).
 	 * @return bool
 	 */
-	public function send_message( $type, $vars, $sending_messenger = '', $generating_messenger='', $context='', $send = TRUE ) {
+	public function send_message($type, $vars, $sending_messenger = '', $generating_messenger = '', $context = '', $send = TRUE) {
 
 		$error = FALSE;
 		$installed_message_types = $this->get_installed_message_types();
@@ -328,34 +328,34 @@ 
 		//);
 
 		// is that a real class ?
-		if ( isset(  $installed_message_types[$type] ) ) {
+		if (isset($installed_message_types[$type])) {
 			//is the messenger specified? If so then let's see if can send.  This is the check where its possible secondary messengers might be in use.
-			if ( !empty ( $sending_messenger ) ) {
-				$generating_messenger =  !empty( $generating_messenger ) && !empty( $this->_active_messengers[$generating_messenger] ) ? $this->_active_messengers[$generating_messenger]: NULL;
-				$generating_messenger = empty( $generating_messenger ) && ! empty( $this->_active_messengers[$sending_messenger] ) ? $this->_active_messengers[$sending_messenger] : $generating_messenger;
+			if ( ! empty ($sending_messenger)) {
+				$generating_messenger = ! empty($generating_messenger) && ! empty($this->_active_messengers[$generating_messenger]) ? $this->_active_messengers[$generating_messenger] : NULL;
+				$generating_messenger = empty($generating_messenger) && ! empty($this->_active_messengers[$sending_messenger]) ? $this->_active_messengers[$sending_messenger] : $generating_messenger;
 
-				if ( !$this->_is_generating_messenger_and_active( $generating_messenger, $installed_message_types[$type] ) ) {
+				if ( ! $this->_is_generating_messenger_and_active($generating_messenger, $installed_message_types[$type])) {
 					return false;
 				}
-				$sending_messenger = ! empty( $this->_active_messengers[$sending_messenger] ) ? $this->_active_messengers[$sending_messenger] : NULL;
+				$sending_messenger = ! empty($this->_active_messengers[$sending_messenger]) ? $this->_active_messengers[$sending_messenger] : NULL;
 
-				$context = !empty( $context ) ? $context : FALSE;
-				$success = $this->_send_message( $generating_messenger, $installed_message_types[$type], $vars, $sending_messenger, $context, $send );
-				if ( ! $send ) {
+				$context = ! empty($context) ? $context : FALSE;
+				$success = $this->_send_message($generating_messenger, $installed_message_types[$type], $vars, $sending_messenger, $context, $send);
+				if ( ! $send) {
 					return $success; //returning generated EE_Messages objects
 				}
 			} else {
 				//no messenger sent so let's just loop through active messengers (this method is only acceptable for primary messengers)
 				$send_messages = array();
-				foreach ( $this->_active_messengers as $active_messenger ) {
+				foreach ($this->_active_messengers as $active_messenger) {
 
 					//we ONLY continue if the given messenger is a primary messenger and is an active messenger for the given message type.  Otherwise we skip.
-					if ( ! $this->_is_generating_messenger_and_active( $active_messenger, $installed_message_types[$type] ) ) {
+					if ( ! $this->_is_generating_messenger_and_active($active_messenger, $installed_message_types[$type])) {
 						continue;
 					}
 
-					$success = $this->_send_message( $active_messenger, $installed_message_types[$type], $vars, $active_messenger );
-					if ( $success === FALSE  ) {
+					$success = $this->_send_message($active_messenger, $installed_message_types[$type], $vars, $active_messenger);
+					if ($success === FALSE) {
 						$error = TRUE;
 					} else {
 						$send_messages[] = $success;
@@ -375,17 +375,17 @@ 
 				//	);
 
 				//return generated EE_Messages objects?
-				if ( ! $send ) {
+				if ( ! $send) {
 					return $send_messages;
 				}
 			}
 		} else {
-			EE_Error::add_error( sprintf( __('Message type: %s does not exist', 'event_espresso'), $type ), __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error(sprintf(__('Message type: %s does not exist', 'event_espresso'), $type), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// add a success message
-		if ( ! $error ) {
-			EE_Error::add_success( sprintf( __( 'The %s message has been successfully sent.', 'event_espresso'), $installed_message_types[$type]->label['singular'] ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $error) {
+			EE_Error::add_success(sprintf(__('The %s message has been successfully sent.', 'event_espresso'), $installed_message_types[$type]->label['singular']), __FILE__, __FUNCTION__, __LINE__);
 		}
 
 		return $error ? FALSE : TRUE; //yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
@@ -402,35 +402,35 @@ 
 	 * @param bool 	$send true we will do a test send using the messenger delivery, false we just do a regular preview
 	 * @return string          The body of the message.
 	 */
-	public function preview_message( $type, $context, $messenger, $send = FALSE ) {
+	public function preview_message($type, $context, $messenger, $send = FALSE) {
 
 		$installed_message_types = $this->get_installed_message_types();
 
 		//does the given type match an actual message type class.
-		if ( isset(  $installed_message_types[$type] ) ) {
+		if (isset($installed_message_types[$type])) {
 			// valid messenger?
-			if ( isset( $this->_active_messengers[$messenger] ) ) {
+			if (isset($this->_active_messengers[$messenger])) {
 
 				//we ONLY continue if the given messenger has that message type active with it (note previews only come from primary messengers so no need to check secondarys)
-				if ( !isset( $this->_active_message_types[$messenger][$type] ) )
+				if ( ! isset($this->_active_message_types[$messenger][$type]))
 					return false;
 
 				$message = $installed_message_types[$type];
 				$messenger = $this->_active_messengers[$messenger];
 
 				//set data for preview
-				$message->set_messages( array(), $messenger, $context, TRUE );
+				$message->set_messages(array(), $messenger, $context, TRUE);
 
 				//let's GET the message body from the messenger (instead of the normal send_message)
-				return $messenger->get_preview( $message->messages[0], $message, $send );
+				return $messenger->get_preview($message->messages[0], $message, $send);
 
 			} else {
-				EE_Error::add_error( sprintf( __('Messenger: %s does not exist', 'event_espresso'), $messenger ), __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error(sprintf(__('Messenger: %s does not exist', 'event_espresso'), $messenger), __FILE__, __FUNCTION__, __LINE__);
 				return FALSE;
 			}
 
 		} else {
-			EE_Error::add_error( sprintf( __('Message type: %s does not exist', 'event_espresso'), $type ), __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error(sprintf(__('Message type: %s does not exist', 'event_espresso'), $type), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 
@@ -451,22 +451,22 @@ 
 	 *
 	 * @return mixed(bool|std_Class[])
 	 */
-	private function _send_message( EE_messenger $generating_messenger, EE_message_type $message_type, $data, EE_messenger $sending_messenger, $context = FALSE, $send = TRUE ) {
+	private function _send_message(EE_messenger $generating_messenger, EE_message_type $message_type, $data, EE_messenger $sending_messenger, $context = FALSE, $send = TRUE) {
 		//can't even get started yo!
-		if ( $message_type === FALSE || is_wp_error( $message_type ) || $message_type->set_messages( $data, $generating_messenger, $context ) === FALSE ) {
+		if ($message_type === FALSE || is_wp_error($message_type) || $message_type->set_messages($data, $generating_messenger, $context) === FALSE) {
 			return FALSE;
 		}
 		// if the generating messenger and the sending messengers are different...
 		// then are there any hooks that the generating messenger sets for the sending messenger (i.e. css file swap outs etc.)
-		if ( $sending_messenger != $generating_messenger ) {
-			$generating_messenger->do_secondary_messenger_hooks( $sending_messenger->name );
+		if ($sending_messenger != $generating_messenger) {
+			$generating_messenger->do_secondary_messenger_hooks($sending_messenger->name);
 		}
 		//it is possible that the user has the messenger turned off for this type.
-		if ( $message_type->count === 0 ) {
+		if ($message_type->count === 0) {
 			return FALSE;
 		}
 		//are we just sending the EE_Messages stdClass objects back?
-		if ( ! $send ) {
+		if ( ! $send) {
 			return $message_type->messages;
 		}
 		//TODO: check count (at some point we'll use this to decide whether we send to queue or not i.e.
@@ -474,12 +474,12 @@ 
 		//else...
 		$success = TRUE;
 		// $success is a flag for the loop.  If there is NO error then everything is a success (true) otherwise it wasn't a success (false)
-		foreach ( $message_type->messages as $message ) {
+		foreach ($message_type->messages as $message) {
 			//todo: should we do some reporting on messages gone out at some point?  I think we could have the $active_messenger object return bool for whether message was sent or not and we can compile a report based on that.
 			// if messages send successfully then $success retains it's value, but a single fail will toggle it to FALSE
-			$success = $sending_messenger->send_message( $message, $message_type ) === TRUE ? $success : FALSE;
+			$success = $sending_messenger->send_message($message, $message_type) === TRUE ? $success : FALSE;
 		}
-		unset( $message_type );
+		unset($message_type);
 		return $success;
 	}
 
@@ -498,24 +498,24 @@ 
 	 *
 	 * @return bool          success or fail.
 	 */
-	public function send_message_with_messenger_only( $messenger, $message_type, $message ) {
+	public function send_message_with_messenger_only($messenger, $message_type, $message) {
 
 		//get EE_messenger object (which also checks if its active)
-		$msgr =  !empty( $messenger ) && !empty( $this->_active_messengers[$messenger] ) ? $this->_active_messengers[$messenger]: NULL;
+		$msgr = ! empty($messenger) && ! empty($this->_active_messengers[$messenger]) ? $this->_active_messengers[$messenger] : NULL;
 		$installed_message_types = $this->get_installed_message_types();
 
-		if ( ! $msgr instanceof EE_messenger ) {
+		if ( ! $msgr instanceof EE_messenger) {
 			return false; //can't do anything without a valid messenger.
 		}
 
 		//check valid message type
-		$mtype = isset(  $installed_message_types[$message_type] ) ? $installed_message_types[$message_type] : NULL;
+		$mtype = isset($installed_message_types[$message_type]) ? $installed_message_types[$message_type] : NULL;
 
-		if( ! $mtype instanceof EE_message_type ) {
+		if ( ! $mtype instanceof EE_message_type) {
 			return false; //can't do anything without a valid message type.
 		}
 
-		return $msgr->send_message( $message, $mtype );
+		return $msgr->send_message($message, $mtype);
 	}
 
 
@@ -531,7 +531,7 @@ 
 	 */
 	private function _validate_setup($messenger, $message_type, $is_global = FALSE) {
 
-		$message_type = strtolower(str_replace(' ', '_', $message_type) );
+		$message_type = strtolower(str_replace(' ', '_', $message_type));
 		$messenger = strtolower(str_replace(' ', '_', $messenger));
 		$installed_message_types = $this->get_installed_message_types();
 
@@ -547,16 +547,16 @@ 
 
 
 		//do we have the necessary objects loaded?
-		if ( empty( $this->_messenger) || empty($this->_message_type) )
-			throw new EE_Error( sprintf( __(' The %s messenger or the %s message_type are not active. Are you sure they exist?', 'event_espresso'), $messenger, $message_type ) );
+		if (empty($this->_messenger) || empty($this->_message_type))
+			throw new EE_Error(sprintf(__(' The %s messenger or the %s message_type are not active. Are you sure they exist?', 'event_espresso'), $messenger, $message_type));
 
 		//is given message_type valid for given messenger (if this is not a global save)
 		$types_to_check = array();
-		if ( !$is_global ) {
-			$has_active = EEM_Message_Template_Group::instance()->count( array( array( 'MTP_is_active' => TRUE, 'MTP_messenger' => $this->_messenger->name, 'MTP_message_type' => $message_type ) ) );
+		if ( ! $is_global) {
+			$has_active = EEM_Message_Template_Group::instance()->count(array(array('MTP_is_active' => TRUE, 'MTP_messenger' => $this->_messenger->name, 'MTP_message_type' => $message_type)));
 
-			if ( $has_active == 0 ) {
-				EE_Error::add_error( sprintf(__(' The %s message type is not registered with the %s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.', 'event_espresso'), $message_type, $messenger), __FILE__, __FUNCTION__, __LINE__ );
+			if ($has_active == 0) {
+				EE_Error::add_error(sprintf(__(' The %s message type is not registered with the %s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.', 'event_espresso'), $message_type, $messenger), __FILE__, __FUNCTION__, __LINE__);
 				return false;
 			}
 
@@ -569,17 +569,17 @@ 
 	 * @param  string $message_type message type that the templates are being created for
 	 * @return array|object               if creation is succesful then we return an array of info, otherwise an error_object is returned.
 	 */
-	public function create_new_templates( $messenger, $message_type, $GRP_ID = 0, $is_global = false ) {
+	public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false) {
 		$valid_mt = false;
 
 		$valid_mt = $this->_validate_setup($messenger, $message_type, $is_global);
 
-		if ( is_wp_error($valid_mt) && $is_global ) {
+		if (is_wp_error($valid_mt) && $is_global) {
 			//we're setting up a brand new global templates (with messenger activation) so we're assuming that the message types sent in are valid.
 			$valid_mt = true;
 		}
 
-		if ( is_wp_error($valid_mt) ) {
+		if (is_wp_error($valid_mt)) {
 			//if we've still got no valid_mt then bubble up error object
 			return $valid_mt;
 		}
@@ -591,10 +591,10 @@ 
 	protected function _create_new_templates($GRP_ID, $is_global) {
 
 		//if we're creating a custom template then we don't need to use the defaults class
-		if ( ! $is_global )
-			return $this->_create_custom_template_group( $GRP_ID );
+		if ( ! $is_global)
+			return $this->_create_custom_template_group($GRP_ID);
 
-		$DFLT = new EE_Message_Template_Defaults( $this, $this->_messenger->name, $this->_message_type->name, $GRP_ID );
+		$DFLT = new EE_Message_Template_Defaults($this, $this->_messenger->name, $this->_message_type->name, $GRP_ID);
 
 		//generate templates
 		$success = $DFLT->create_new_templates();
@@ -622,16 +622,16 @@ 
 	 *                                     			)
 	 * @access private
 	 */
-	private function _create_custom_template_group( $GRP_ID ) {
+	private function _create_custom_template_group($GRP_ID) {
 		//defaults
-		$success = array( 'GRP_ID' => NULL, 'MTP_context' => '' );
+		$success = array('GRP_ID' => NULL, 'MTP_context' => '');
 
 		//get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
-		$mtg = empty( $GRP_ID ) ? EEM_Message_Template_Group::instance()->get_one( array( array( 'MTP_messenger' => $this->_messenger->name, 'MTP_message_type' => $this->_message_type->name, 'MTP_is_global' => TRUE ) ) ) : EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+		$mtg = empty($GRP_ID) ? EEM_Message_Template_Group::instance()->get_one(array(array('MTP_messenger' => $this->_messenger->name, 'MTP_message_type' => $this->_message_type->name, 'MTP_is_global' => TRUE))) : EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
 
 		//if we don't have a mtg at this point then we need to bail.
-		if ( ! $mtg instanceof EE_Message_Template_Group ) {
-			EE_Error::add_error( sprintf( __('Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.', 'event_espresso'), $GRP_ID ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $mtg instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(sprintf(__('Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.', 'event_espresso'), $GRP_ID), __FILE__, __FUNCTION__, __LINE__);
 			return $success;
 		}
 
@@ -643,27 +643,27 @@ 
 		$new_mtg->set('GRP_ID', 0);
 		$new_mtg->set('MTP_is_global', FALSE);
 
-		$template_name = defined('DOING_AJAX') && !empty( $_POST['templateName'] ) ? $_POST['templateName'] : __('New Custom Template', 'event_espresso');
-		$template_description = defined("DOING_AJAX") && !empty( $_POST['templateDescription'] ) ? $_POST['templateDescription'] : sprintf( __('This is a custom template that was created for the %s messenger and %s message type.', 'event_espresso' ), $new_mtg->messenger_obj()->label['singular'], $new_mtg->message_type_obj()->label['singular'] );
+		$template_name = defined('DOING_AJAX') && ! empty($_POST['templateName']) ? $_POST['templateName'] : __('New Custom Template', 'event_espresso');
+		$template_description = defined("DOING_AJAX") && ! empty($_POST['templateDescription']) ? $_POST['templateDescription'] : sprintf(__('This is a custom template that was created for the %s messenger and %s message type.', 'event_espresso'), $new_mtg->messenger_obj()->label['singular'], $new_mtg->message_type_obj()->label['singular']);
 
 
-		$new_mtg->set('MTP_name', $template_name );
-		$new_mtg->set('MTP_description', $template_description );
+		$new_mtg->set('MTP_name', $template_name);
+		$new_mtg->set('MTP_description', $template_description);
 		//remove ALL relations on this template group so they don't get saved!
-		$new_mtg->_remove_relations( 'Message_Template' );
+		$new_mtg->_remove_relations('Message_Template');
 		$new_mtg->save();
 		$success['GRP_ID'] = $new_mtg->ID();
 		$success['template_name'] = $template_name;
 
 		//add new message templates and add relation to.
-		foreach ( $mtts as $mtt ) {
-			if ( ! $mtt instanceof EE_Message_Template )
+		foreach ($mtts as $mtt) {
+			if ( ! $mtt instanceof EE_Message_Template)
 				continue;
 			$nmtt = clone $mtt;
 			$nmtt->set('MTP_ID', 0);
-			$nmtt->set( 'GRP_ID', $new_mtg->ID() ); //relation
+			$nmtt->set('GRP_ID', $new_mtg->ID()); //relation
 			$nmtt->save();
-			if ( empty( $success['MTP_context'] ) )
+			if (empty($success['MTP_context']))
 				$success['MTP_context'] = $nmtt->get('MTP_context');
 		}
 
@@ -688,14 +688,14 @@ 
 
 
 		//okay now let's assemble an array with the messenger template fields added to the message_type contexts.
-		foreach ( $this->_message_type->get_contexts() as $context => $details ) {
-			foreach ( $this->_messenger->get_template_fields() as $field => $value ) {
+		foreach ($this->_message_type->get_contexts() as $context => $details) {
+			foreach ($this->_messenger->get_template_fields() as $field => $value) {
 				$template_fields[$context][$field] = $value;
 			}
 		}
 
-		if ( empty($template_fields) ) {
-			EE_Error::add_error( __('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($template_fields)) {
+			EE_Error::add_error(__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 
@@ -710,30 +710,30 @@ 
 	 * @param bool  $set if true then we skip the cache and retrieve via files.
 	 * @return array multidimensional array of messenger and message_type objects (messengers index, and message_type index);
 	 */
-	public function get_installed( $type = 'all', $skip_cache = false ) {
+	public function get_installed($type = 'all', $skip_cache = false) {
 		$installed = array();
 
 		//first let's account for caching
-		if ( $skip_cache ) {
-			$message_base = EE_LIBRARIES . "messages" . DS;
+		if ($skip_cache) {
+			$message_base = EE_LIBRARIES."messages".DS;
 
-			$messenger_files = $type == 'all' || $type == 'messengers' ? scandir( $message_base . "messenger", 1) : NULL;
-			$messagetype_files = $type == 'all' || $type == 'message_types' ? scandir( $message_base . "message_type", 1) : NULL;
+			$messenger_files = $type == 'all' || $type == 'messengers' ? scandir($message_base."messenger", 1) : NULL;
+			$messagetype_files = $type == 'all' || $type == 'message_types' ? scandir($message_base."message_type", 1) : NULL;
 
 
 			//allow plugins to filter in their messenger/message_type files
-			$messenger_files = apply_filters('FHEE__EE_messages__get_installed__messenger_files', $messenger_files, $type );
-			$messagetype_files = apply_filters('FHEE__EE_messages__get_installed__messagetype_files', $messagetype_files, $type );
+			$messenger_files = apply_filters('FHEE__EE_messages__get_installed__messenger_files', $messenger_files, $type);
+			$messagetype_files = apply_filters('FHEE__EE_messages__get_installed__messagetype_files', $messagetype_files, $type);
 
-			$installed['messengers'] = !empty($messenger_files ) ? $this->_get_installed($messenger_files) : '';
-			$installed['message_types'] = !empty($messagetype_files) ? $this->_get_installed($messagetype_files) : '';
+			$installed['messengers'] = ! empty($messenger_files) ? $this->_get_installed($messenger_files) : '';
+			$installed['message_types'] = ! empty($messagetype_files) ? $this->_get_installed($messagetype_files) : '';
 		} else {
 			$installed['messengers'] = $this->get_installed_messengers();
 			$installed['message_types'] = $this->get_installed_message_types();
 		}
 
 
-		if ( $type != 'all' ) {
+		if ($type != 'all') {
 			$installed = $type == 'messengers' ? $installed['messengers'] : $installed['message_types'];
 		}
 
@@ -751,11 +751,11 @@ 
 		$the_goods = array();
 		$filenames = (array) $filenames;
 		$replace = ".class.php";
-		foreach ( $filenames as $filename ) {
-			$classname = preg_match("/" . $replace . "/", $filename ) ? str_replace($replace, "", $filename) : false;
+		foreach ($filenames as $filename) {
+			$classname = preg_match("/".$replace."/", $filename) ? str_replace($replace, "", $filename) : false;
 
 			//no classname? no match? move along, nothing to see here. note, the stripos is checking to make sure the filename (classname) begins with EE.
-			if ( !$classname || 0 !== stripos($classname, 'EE') ) continue;
+			if ( ! $classname || 0 !== stripos($classname, 'EE')) continue;
 
 			//note: I'm not sure if this will work without including the file.  We do have autoloaders so it "may" work.
 			$a = new ReflectionClass($classname);
@@ -778,9 +778,9 @@ 
 	 */
 	public function get_active_message_types() {
 		$message_types = array();
-		foreach ( $this->_active_message_types as $messenger => $mtvalues ) {
-			foreach ( $mtvalues as $mt => $config ) {
-				if ( !in_array( $mt, $message_types ) )
+		foreach ($this->_active_message_types as $messenger => $mtvalues) {
+			foreach ($mtvalues as $mt => $config) {
+				if ( ! in_array($mt, $message_types))
 					$message_types[] = $mt;
 			}
 		}
@@ -800,17 +800,17 @@ 
 	 *
 	 * @return EE_message_type[]    (or empty array if none present)
 	 */
-	public function get_active_message_types_per_messenger( $messenger ) {
+	public function get_active_message_types_per_messenger($messenger) {
 		$messenger = (string) $messenger;
-		if ( empty( $this->_active_message_types[$messenger] ) ) {
+		if (empty($this->_active_message_types[$messenger])) {
 			return array();
 		}
 
 		$mts = array();
 		$message_types = $this->_active_message_types[$messenger];
 		$installed_message_types = $this->get_installed_message_types();
-		foreach ( $message_types as $mt => $settings ) {
-			if ( ! empty( $installed_message_types[$mt] ) )  {
+		foreach ($message_types as $mt => $settings) {
+			if ( ! empty($installed_message_types[$mt])) {
 				$mts[] = $installed_message_types[$mt];
 			}
 		}
@@ -827,9 +827,9 @@ 
 	 *
 	 * @return EE_Message_Type|null
 	 */
-	public function get_active_message_type( $messenger, $message_type ) {
+	public function get_active_message_type($messenger, $message_type) {
 		$installed_message_types = $this->get_installed_message_types();
-		if ( !empty( $this->_active_message_types[$messenger][$message_type] ) && !empty( $installed_message_types[$message_type] ) )  {
+		if ( ! empty($this->_active_message_types[$messenger][$message_type]) && ! empty($installed_message_types[$message_type])) {
 			return $installed_message_types[$message_type];
 		}
 		return NULL;
@@ -838,13 +838,13 @@ 
 
 
 	public function get_installed_message_types() {
-		$this->_installed_message_types = empty( $this->_installed_message_types ) ? $this->get_installed( 'message_types', true ) : $this->_installed_message_types;
+		$this->_installed_message_types = empty($this->_installed_message_types) ? $this->get_installed('message_types', true) : $this->_installed_message_types;
 		return $this->_installed_message_types;
 	}
 
 
 	public function get_installed_messengers() {
-		$this->_installed_messengers = empty( $this->_installed_messengers ) ? $this->get_installed( 'messengers', true ) : $this->_installed_messengers;
+		$this->_installed_messengers = empty($this->_installed_messengers) ? $this->get_installed('messengers', true) : $this->_installed_messengers;
 		return $this->_installed_messengers;
 	}
 }

core/libraries/messages/messenger/EE_Pdf_messenger.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -332,7 +332,7 @@
 
 
 	/**
-	 * @return string
+	 * @return boolean|null
 	 */
 	protected function _preview() { return $this->_send_message(); }
 

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * This contains the class for the EE PDF messenger.
- *
- * @since 4.5.0
- * @package Event Espresso
- * @subpackage messages
- */
+	 * This contains the class for the EE PDF messenger.
+	 *
+	 * @since 4.5.0
+	 * @package Event Espresso
+	 * @subpackage messages
+	 */
 if (!defined('EVENT_ESPRESSO_VERSION') )
 	exit('NO direct script access allowed');
 

Braces +2 added lines, -1 removed lines

@@ -6,8 +6,9 @@
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  *

Spacing +25 added lines, -25 removed lines

@@ -6,7 +6,7 @@ 
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -20,7 +20,7 @@ 
  * @subpackage		messages
  * @author			Darren Ethier
  */
-class EE_Pdf_messenger extends EE_messenger  {
+class EE_Pdf_messenger extends EE_messenger {
 
 
 	/**
@@ -65,7 +65,7 @@ 
 	 * @see abstract declaration in EE_messenger for details.
 	 */
 	protected function _set_admin_pages() {
-		$this->admin_registered_pages = array( 'events_edit' => false );
+		$this->admin_registered_pages = array('events_edit' => false);
 	}
 
 
@@ -85,10 +85,10 @@ 
 	protected function _set_validator_config() {
 		$this->_validator_config = array(
 			'subject' => array(
-				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email','event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
 				),
 			'content' => array(
-				'shortcodes' => array( 'recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email','event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
 				),
 			'attendee_list' => array(
 				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
@@ -99,7 +99,7 @@ 
 				'required' => array('[EVENT_LIST]')
 				),
 			'ticket_list' => array(
-				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list','primary_registration_details', 'recipient_details'),
+				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
 				'required' => array('[TICKET_LIST]')
 				),
 			'datetime_list' => array(
@@ -119,7 +119,7 @@ 
 	 */
 	public  function enqueue_scripts_styles() {
 		parent::enqueue_scripts_styles();
-		do_action( 'AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
+		do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
 	}
 
 
@@ -245,18 +245,18 @@ 
 	 */
 	protected function _send_message() {
 		$this->_template_args = array(
-			'page_title' => html_entity_decode( stripslashes( $this->_subject ), ENT_QUOTES, "UTF-8"),
-			'base_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation ),
-			'print_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation ),
-			'main_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation ),
-			'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
-			'main_body' => apply_filters( 'FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep( html_entity_decode($this->_content,  ENT_QUOTES,"UTF-8" ) )), $this->_content )
+			'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
+			'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
+			'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
+			'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
+			'extra_css' => EE_LIBRARIES_URL.'messages/defaults/default/variations/pdf_base_default.css',
+			'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), $this->_content)
 			);
 		$this->_deregister_wp_hooks();
-		add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts_styles' ) );
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
 		$content = $this->_get_main_template();
 //		die( $content );
-		$this->_do_pdf( $content );
+		$this->_do_pdf($content);
 		exit(0);
 	}
 
@@ -280,8 +280,8 @@ 
 
 		//just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
 		add_action('wp_head', 'wp_enqueue_scripts');
-		add_action( 'wp_footer', 'wp_print_footer_scripts' );
-		add_action( 'wp_print_footer_scripts', '_wp_footer_scripts' );
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
 	}
 
 
@@ -294,11 +294,11 @@ 
 	 * @param bool $preview
 	 * @return string
 	 */
-	protected function _get_main_template( $preview = FALSE ) {
-		$wrapper_template = $this->_tmp_pack->get_wrapper( 'html', 'main' );
+	protected function _get_main_template($preview = FALSE) {
+		$wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
 		//add message type to template_args
 		$this->_template_args['message_type'] = $this->_incoming_message_type;
-		return EEH_Template::display_template( $wrapper_template, $this->_template_args, TRUE );
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
 	}
 
 
@@ -311,21 +311,21 @@ 
 	 *
 	 * @return void
 	 */
-	protected function _do_pdf( $content = '' ) {
-		$invoice_name = html_entity_decode( $this->_subject, ENT_QUOTES, "UTF-8");
+	protected function _do_pdf($content = '') {
+		$invoice_name = html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8");
 
 		//only load dompdf if nobody else has yet...
-		if( ! defined('DOMPDF_DIR')){
+		if ( ! defined('DOMPDF_DIR')) {
 			define('DOMPDF_ENABLE_REMOTE', TRUE);
 			define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
 			define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
-			require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+			require_once(EE_THIRD_PARTY.'dompdf/dompdf_config.inc.php');
 		}
 		$dompdf = new DOMPDF();
 		$dompdf->load_html($content);
 		$dompdf->render();
 		//forcing the browser to open a download dialog.
-		$dompdf->stream($invoice_name . ".pdf", array( 'Attachment' => TRUE ));
+		$dompdf->stream($invoice_name.".pdf", array('Attachment' => TRUE));
 	}
 
 

core/libraries/messages/validators/EE_Messages_Validator.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -442,7 +442,7 @@
 	 *
 	 * @param  string $value      string to evaluate
 	 * @param  array  $valid_shortcodes array of shortcodes that are acceptable.
-	 * @return mixed (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
+	 * @return false|string (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
 	 */
 	protected function _invalid_shortcodes($value, $valid_shortcodes) {
 		//first we need to go through the string and get the shortcodes in the string

Spacing +96 added lines, -96 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -123,10 +123,10 @@ 
 	 * @param array $fields The fields sent by the EEM object.
 	 * @return void
 	 */
-	public function __construct( $fields, $context ) {
+	public function __construct($fields, $context) {
 		//check that _m_name and _mt_name have been set by child class otherwise we get out.
-		if ( empty($this->_m_name ) || empty( $this->_mt_name) )
-			throw new EE_Error( __('EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this', 'event_espresso') );
+		if (empty($this->_m_name) || empty($this->_mt_name))
+			throw new EE_Error(__('EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this', 'event_espresso'));
 
 		$this->_fields = $fields;
 		$this->_context = $context;
@@ -162,27 +162,27 @@ 
 	 */
 	private function _load_objects() {
 		//load messenger
-		$messenger = ucwords( str_replace( '_', ' ', $this->_m_name ) );
-		$messenger = str_replace( ' ', '_', $messenger );
-		$messenger = 'EE_' . $messenger . '_messenger';
+		$messenger = ucwords(str_replace('_', ' ', $this->_m_name));
+		$messenger = str_replace(' ', '_', $messenger);
+		$messenger = 'EE_'.$messenger.'_messenger';
 
-		if ( !class_exists( $messenger ) ) {
-			$msg = sprintf( __('There is no messenger class for the given string (%s)', 'event_espresso'), $this->_m_name );
+		if ( ! class_exists($messenger)) {
+			$msg = sprintf(__('There is no messenger class for the given string (%s)', 'event_espresso'), $this->_m_name);
 		}
 
-		$a = new ReflectionClass( $messenger );
+		$a = new ReflectionClass($messenger);
 		$this->_MSGR = $a->newInstance();
 
 		//load message type
-		$message_type = ucwords( str_replace( '_', ' ', $this->_mt_name ) );
-		$message_type = str_replace( ' ', '_', $message_type );
-		$message_type = 'EE_' . $message_type . '_message_type';
+		$message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
+		$message_type = str_replace(' ', '_', $message_type);
+		$message_type = 'EE_'.$message_type.'_message_type';
 
-		if ( !class_exists( $message_type ) ) {
-			$msg = sprintf( __('There is no message type class for the given string (%s)', 'event_espresso'), $this->_mt_name );
+		if ( ! class_exists($message_type)) {
+			$msg = sprintf(__('There is no message type class for the given string (%s)', 'event_espresso'), $this->_mt_name);
 		}
 
-		$a = new ReflectionClass( $message_type );
+		$a = new ReflectionClass($message_type);
 		$this->_MSGTYP = $a->newInstance();
 
 	}
@@ -212,11 +212,11 @@ 
 		$shrtcode_grps = $mt_codes;
 		$groups_per_field = array();
 
-		foreach ( $msgr_validator as $field => $config ) {
-			if ( empty($config) || !isset($config['shortcodes']) )
-				continue;  //Nothing to see here.
-			$groups_per_field[$field] = array_intersect( $config['shortcodes'], $mt_codes );
-			$shrtcode_grps = array_merge( $config['shortcodes'], $shrtcode_grps );
+		foreach ($msgr_validator as $field => $config) {
+			if (empty($config) || ! isset($config['shortcodes']))
+				continue; //Nothing to see here.
+			$groups_per_field[$field] = array_intersect($config['shortcodes'], $mt_codes);
+			$shrtcode_grps = array_merge($config['shortcodes'], $shrtcode_grps);
 		}
 
 		$shrtcode_grps = array_unique($shrtcode_grps);
@@ -224,12 +224,12 @@ 
 		//okay now we've got our grps. Let's get the codes from the objects into an array indexed by group for easy retrieval later.
 		$codes_from_objs = array();
 
-		foreach ( $shrtcode_grps as $group ) {
-			$ref = ucwords( str_replace('_', ' ', $group ) );
-			$ref = str_replace( ' ', '_', $ref );
-			$classname = 'EE_' . $ref . '_Shortcodes';
-			if ( class_exists( $classname ) ) {
-				$a = new ReflectionClass( $classname );
+		foreach ($shrtcode_grps as $group) {
+			$ref = ucwords(str_replace('_', ' ', $group));
+			$ref = str_replace(' ', '_', $ref);
+			$classname = 'EE_'.$ref.'_Shortcodes';
+			if (class_exists($classname)) {
+				$a = new ReflectionClass($classname);
 				$obj = $a->newInstance();
 				$codes_from_objs[$group] = $obj->get_shortcodes();
 			}
@@ -238,58 +238,58 @@ 
 
 		//let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
 		$final_mt_codes = array();
-		foreach ( $mt_codes as $group ) {
-			$final_mt_codes = array_merge( $final_mt_codes, $codes_from_objs[$group] );
+		foreach ($mt_codes as $group) {
+			$final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[$group]);
 		}
 
 		$mt_codes = $final_mt_codes;
 
 
 		//k now in this next loop we're going to loop through $msgr_validator again and setup the _validators property from the data we've setup so far.
-		foreach ( $msgr_validator as $field => $config ) {
+		foreach ($msgr_validator as $field => $config) {
 			//if required shortcode is not in our list of codes for the given field, then we skip this field.
 			$required = isset($config['required']) ? array_intersect($config['required'], array_keys($mt_codes)) : true;
-			if ( empty($required) )
+			if (empty($required))
 				continue;
 
 			//If we have an override then we use it to indicate the codes we want.
-			if ( isset( $this->_valid_shortcodes_modifier[$context][$field] ) ) {
-				$this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group( $this->_valid_shortcodes_modifier[$context][$field], $codes_from_objs );
+			if (isset($this->_valid_shortcodes_modifier[$context][$field])) {
+				$this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group($this->_valid_shortcodes_modifier[$context][$field], $codes_from_objs);
 			}
 
 			//if we have specific shortcodes for a field then we need to use them
-			else if ( isset( $groups_per_field[$field] ) ) {
-				$this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group($groups_per_field[$field], $codes_from_objs );
+			else if (isset($groups_per_field[$field])) {
+				$this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group($groups_per_field[$field], $codes_from_objs);
 			}
 
 			//if empty config then we're assuming we're just going to use the shortcodes from the message type context
-			else if ( empty( $config ) ) {
+			else if (empty($config)) {
 				$this->_validators[$field]['shortcodes'] = $mt_codes;
 			}
 
 			//if we have specific shortcodes then we need to use them
-			else if ( isset($config['specific_shortcodes'] ) ) {
+			else if (isset($config['specific_shortcodes'])) {
 				$this->_validators[$field]['shortcodes'] = $config['specific_shortcodes'];
 			}
 
 			//otherwise the shortcodes are what is set by the messenger for that field
 			else {
-				foreach ( $config['shortcodes'] as $group ) {
-					$this->_validators[$field]['shortcodes'] = isset($this->_validators[$field]['shortcodes']) ? array_merge( $this->_validators[$field]['shortcodes'], $codes_from_objs[$group] ) : $codes_from_objs[$group];
+				foreach ($config['shortcodes'] as $group) {
+					$this->_validators[$field]['shortcodes'] = isset($this->_validators[$field]['shortcodes']) ? array_merge($this->_validators[$field]['shortcodes'], $codes_from_objs[$group]) : $codes_from_objs[$group];
 				}
 			}
 
 			//now let's just make sure that any excluded specific shortcodes are removed.
 			$specific_excludes = $this->get_specific_shortcode_excludes();
-			if ( isset( $specific_excludes[$field] ) ) {
-				foreach( $specific_excludes[$field] as $sex ) {
-					if ( isset( $this->_validators[$field]['shortcodes'][$sex] ) )
-						unset( $this->_validators[$field]['shortcodes'][$sex] );
+			if (isset($specific_excludes[$field])) {
+				foreach ($specific_excludes[$field] as $sex) {
+					if (isset($this->_validators[$field]['shortcodes'][$sex]))
+						unset($this->_validators[$field]['shortcodes'][$sex]);
 				}
 			}
 
 			//hey! don't forget to include the type if present!
-			$this->_validators[$field]['type'] = isset( $config['type'] ) ? $config['type'] : NULL;
+			$this->_validators[$field]['type'] = isset($config['type']) ? $config['type'] : NULL;
 		}
 	}
 
@@ -315,9 +315,9 @@ 
 	 */
 	public function get_specific_shortcode_excludes() {
 		//specific validator filter
-		$shortcode_excludes = apply_filters( 'FHEE__' . get_class( $this ) . '__get_specific_shortcode_excludes;', $this->_specific_shortcode_excludes, $this->_context );
+		$shortcode_excludes = apply_filters('FHEE__'.get_class($this).'__get_specific_shortcode_excludes;', $this->_specific_shortcode_excludes, $this->_context);
 		//global filter
-		return apply_filters( 'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes', $shortcode_excludes, $this->_context, $this );
+		return apply_filters('FHEE__EE_Messages_Validator__get_specific_shortcode_excludes', $shortcode_excludes, $this->_context, $this);
 	}
 
 
@@ -335,63 +335,63 @@ 
 		$invalid_shortcodes = '';
 		$template_fields = $this->_MSGR->get_template_fields();
 		//loop through the fields and check!
-		foreach ( $this->_fields as $field => $value ) {
+		foreach ($this->_fields as $field => $value) {
 			$this->_errors[$field] = array();
 			$err_msg = '';
 			$field_label = '';
 
 			//if field is not present in the _validators array then we continue
-			if ( !isset( $this->_validators[$field] ) ) {
-				unset( $this->_errors[$field] );
+			if ( ! isset($this->_validators[$field])) {
+				unset($this->_errors[$field]);
 				continue;
 			}
 
 			//get the translated field label!
 			//first check if it's in the main fields list
-			if ( isset( $template_fields[$field] ) ) {
-				if ( empty( $template_fields[$field] ) )
+			if (isset($template_fields[$field])) {
+				if (empty($template_fields[$field]))
 					$field_label = $field; //most likely the field is found in the 'extra' array.
 				else
 					$field_label = $template_fields[$field]['label'];
 			}
 
 			//if field label is empty OR is equal to the current field then we need to loop through the 'extra' fields in the template_fields config (if present)
-			if ( isset( $template_fields['extra'] ) && ( empty($field_label) ) || $field_label == $field ) {
-				foreach( $template_fields['extra'] as $main_field => $secondary_field ) {
-					foreach ( $secondary_field as $name => $values ) {
-						if ( $name == $field ) {
+			if (isset($template_fields['extra']) && (empty($field_label)) || $field_label == $field) {
+				foreach ($template_fields['extra'] as $main_field => $secondary_field) {
+					foreach ($secondary_field as $name => $values) {
+						if ($name == $field) {
 							$field_label = $values['label'];
 						}
 
 						//if we've got a 'main' secondary field, let's see if that matches what field we're on which means it contains the label for this field.
-						if ( $name == 'main' && $main_field == $field_label )
+						if ($name == 'main' && $main_field == $field_label)
 							$field_label = $values['label'];
 					}
 				}
 			}
 
 			//field is present. Let's validate shortcodes first (but only if shortcodes present).
-			if ( isset( $this->_validators[$field]['shortcodes'] ) && !empty( $this->_validators[$field]['shortcodes'] ) ) {
-				$invalid_shortcodes = $this->_invalid_shortcodes( $value, $this->_validators[$field]['shortcodes'] );
+			if (isset($this->_validators[$field]['shortcodes']) && ! empty($this->_validators[$field]['shortcodes'])) {
+				$invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[$field]['shortcodes']);
 				//if true then that means there is a returned error message that we'll need to add to the _errors array for this field.
-				if ( $invalid_shortcodes ) {
+				if ($invalid_shortcodes) {
 					$v_s = array_keys($this->_validators[$field]['shortcodes']);
-					$err_msg = sprintf( __('<p>The following shortcodes were found in the "%s" field that ARE not valid: %s</p>', 'event_espresso'), '<strong>' . $field_label . '</strong>', $invalid_shortcodes );
-					$err_msg .= sprintf( __('<p>Valid shortcodes for this field are: %s', 'event_espresso'), implode(', ', $v_s ) );
+					$err_msg = sprintf(__('<p>The following shortcodes were found in the "%s" field that ARE not valid: %s</p>', 'event_espresso'), '<strong>'.$field_label.'</strong>', $invalid_shortcodes);
+					$err_msg .= sprintf(__('<p>Valid shortcodes for this field are: %s', 'event_espresso'), implode(', ', $v_s));
 				}
 			}
 
 			//if there's a "type" to be validated then let's do that too.
-			if ( isset( $this->_validators[$field]['type'] ) && !empty( $this->_validators[$field]['type'] ) ) {
-				switch ( $this->_validators[$field]['type'] ) {
+			if (isset($this->_validators[$field]['type']) && ! empty($this->_validators[$field]['type'])) {
+				switch ($this->_validators[$field]['type']) {
 					case 'number' :
-						if ( !is_numeric($value) )
-							$err_msg .= sprintf( __('<p>The %s field is supposed to be a number. The value given (%s)  is not.  Please doublecheck and make sure the field contains a number</p>', 'event_espresso'), $field_label, $value );
+						if ( ! is_numeric($value))
+							$err_msg .= sprintf(__('<p>The %s field is supposed to be a number. The value given (%s)  is not.  Please doublecheck and make sure the field contains a number</p>', 'event_espresso'), $field_label, $value);
 						break;
 					case 'email' :
 						$valid_email = $this->_validate_email($value);
-						if ( !$valid_email )
-							$err_msg .= htmlentities( sprintf( __('The %s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.'), $field_label ) );
+						if ( ! $valid_email)
+							$err_msg .= htmlentities(sprintf(__('The %s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.'), $field_label));
 						break;
 					default :
 						break;
@@ -399,22 +399,22 @@ 
 			}
 
 			//if $err_msg isn't empty let's setup the _errors array for this field.
-			if ( !empty($err_msg ) ) {
+			if ( ! empty($err_msg)) {
 				$this->_errors[$field]['msg'] = $err_msg;
 			} else {
-				unset( $this->_errors[$field] );
+				unset($this->_errors[$field]);
 			}
 		}
 
 		//if we have ANY errors, then we want to make sure we return the values for ALL the fields so the user doesn't have to retype them all.
-		if ( !empty( $this->_errors ) ) {
-			foreach ( $this->_fields as $field => $value ) {
+		if ( ! empty($this->_errors)) {
+			foreach ($this->_fields as $field => $value) {
 				$this->_errors[$field]['value'] = stripslashes($value);
 			}
 		}
 
 		//return any errors or just TRUE if everything validates
-		return empty( $this->_errors ) ? TRUE : $this->_errors;
+		return empty($this->_errors) ? TRUE : $this->_errors;
 	}
 
 
@@ -425,10 +425,10 @@ 
 	 * @param  array  $codes_from_objs All the codes available.
 	 * @return array                   an array of actual shortcodes (that will be used for validation).
 	 */
-	private function _reassemble_valid_shortcodes_from_group( $groups, $codes_from_objs ) {
+	private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs) {
 		$shortcodes = array();
-		foreach ( $groups as $group ) {
-			$shortcodes = array_merge( $shortcodes, $codes_from_objs[$group] );
+		foreach ($groups as $group) {
+			$shortcodes = array_merge($shortcodes, $codes_from_objs[$group]);
 		}
 		return $shortcodes;
 	}
@@ -446,29 +446,29 @@ 
 	 */
 	protected function _invalid_shortcodes($value, $valid_shortcodes) {
 		//first we need to go through the string and get the shortcodes in the string
-		$sc = preg_match_all( '/(\[.+?\])/', $value, $matches );
+		$sc = preg_match_all('/(\[.+?\])/', $value, $matches);
 		$incoming_shortcodes = (array) $matches[0];
 
 		//get a diff of the shortcodes in the string vs the valid shortcodes
-		$diff = array_diff( $incoming_shortcodes, array_keys($valid_shortcodes) );
+		$diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
 
 		//we need to account for custom codes so let's loop through the diff and remove any of those type of codes
-		foreach ( $diff as $ind => $code ) {
-			if ( preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code ) ) {
+		foreach ($diff as $ind => $code) {
+			if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
 				//strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
 				$dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
 				//does this exist in the $valid_shortcodes?  If so then unset.
-				if ( isset( $valid_shortcodes[$dynamic_sc] ) ) {
-					unset( $diff[$ind] );
+				if (isset($valid_shortcodes[$dynamic_sc])) {
+					unset($diff[$ind]);
 				}
 			}
 		}
 
-		if ( empty( $diff ) ) return FALSE; //there is no diff, we have no invalid shortcodes, so return
+		if (empty($diff)) return FALSE; //there is no diff, we have no invalid shortcodes, so return
 
 		//made it here? then let's assemble the error message
-		$invalid_shortcodes = implode( '</strong>,<strong>', $diff );
-		$invalid_shortcodes = '<strong>' . $invalid_shortcodes . '</strong>';
+		$invalid_shortcodes = implode('</strong>,<strong>', $diff);
+		$invalid_shortcodes = '<strong>'.$invalid_shortcodes.'</strong>';
 		return $invalid_shortcodes;
 	}
 
@@ -480,13 +480,13 @@ 
 	 * @param  string $value incoming value to validate
 	 * @return bool        true if the string validates, false if it doesn't
 	 */
-	protected function _validate_email( $value ) {
+	protected function _validate_email($value) {
 		$validate = TRUE;
 		$fail = FALSE;
 		$or_val = $value;
 
 		//empty strings will validate because this is how a message template for a particula context can be "turned off" (if there is no email then no message)
-		if ( empty( $value ) )
+		if (empty($value))
 			return $validate;
 
 		//first determine if there ARE any shortcodes.  If there are shortcodes and then later we find that there were no other valid emails but the field isn't empty... that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
@@ -498,19 +498,19 @@ 
 		//if original value is not empty and new value is, then we've parsed out a shortcode and we now have an empty string which DOES validate. We also validate complete empty field for email because its possible that this message is being "turned off" for a particular context
 
 
-		if ( !empty($or_val) && empty($value) )
+		if ( ! empty($or_val) && empty($value))
 			return $validate;
 
 		//trim any commas from beginning and end of string ( after whitespace trimmed );
-		$value = trim( trim($value), ',' );
+		$value = trim(trim($value), ',');
 
 
 		//next we need to split up the string if its comma delimited.
 		$emails = explode(',', $value);
 		$empty = FALSE; //used to indicate that there is an empty comma.
 		//now let's loop through the emails and do our checks
-		foreach ( $emails as $email ) {
-			if ( empty($email) ) {
+		foreach ($emails as $email) {
+			if (empty($email)) {
 				$empty = TRUE;
 				continue;
 			}
@@ -518,20 +518,20 @@ 
 			//trim whitespace
 			$email = trim($email);
 			//either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
-			if(is_email($email)){
+			if (is_email($email)) {
 				continue;
-			}else{
+			} else {
 				$matches = array();
-				$validate = preg_match( '/(.*)<(.+)>/', $email, $matches ) ? TRUE : FALSE;
-				if( $validate && is_email($matches[2])){
+				$validate = preg_match('/(.*)<(.+)>/', $email, $matches) ? TRUE : FALSE;
+				if ($validate && is_email($matches[2])) {
 					continue;
-				}else{
+				} else {
 					return false;
 				}
 			}
 		}
 
-		$validate = $empty && !$has_shortcodes ? FALSE : $validate;
+		$validate = $empty && ! $has_shortcodes ? FALSE : $validate;
 
 		return $validate;
 

Braces +43 added lines, -26 removed lines

@@ -1,7 +1,8 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -125,8 +126,9 @@ 
 	 */
 	public function __construct( $fields, $context ) {
 		//check that _m_name and _mt_name have been set by child class otherwise we get out.
-		if ( empty($this->_m_name ) || empty( $this->_mt_name) )
-			throw new EE_Error( __('EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this', 'event_espresso') );
+		if ( empty($this->_m_name ) || empty( $this->_mt_name) ) {
+					throw new EE_Error( __('EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this', 'event_espresso') );
+		}
 
 		$this->_fields = $fields;
 		$this->_context = $context;
@@ -213,8 +215,10 @@ 
 		$groups_per_field = array();
 
 		foreach ( $msgr_validator as $field => $config ) {
-			if ( empty($config) || !isset($config['shortcodes']) )
-				continue;  //Nothing to see here.
+			if ( empty($config) || !isset($config['shortcodes']) ) {
+							continue;
+			}
+			//Nothing to see here.
 			$groups_per_field[$field] = array_intersect( $config['shortcodes'], $mt_codes );
 			$shrtcode_grps = array_merge( $config['shortcodes'], $shrtcode_grps );
 		}
@@ -249,8 +253,9 @@ 
 		foreach ( $msgr_validator as $field => $config ) {
 			//if required shortcode is not in our list of codes for the given field, then we skip this field.
 			$required = isset($config['required']) ? array_intersect($config['required'], array_keys($mt_codes)) : true;
-			if ( empty($required) )
-				continue;
+			if ( empty($required) ) {
+							continue;
+			}
 
 			//If we have an override then we use it to indicate the codes we want.
 			if ( isset( $this->_valid_shortcodes_modifier[$context][$field] ) ) {
@@ -283,8 +288,9 @@ 
 			$specific_excludes = $this->get_specific_shortcode_excludes();
 			if ( isset( $specific_excludes[$field] ) ) {
 				foreach( $specific_excludes[$field] as $sex ) {
-					if ( isset( $this->_validators[$field]['shortcodes'][$sex] ) )
-						unset( $this->_validators[$field]['shortcodes'][$sex] );
+					if ( isset( $this->_validators[$field]['shortcodes'][$sex] ) ) {
+											unset( $this->_validators[$field]['shortcodes'][$sex] );
+					}
 				}
 			}
 
@@ -349,10 +355,13 @@ 
 			//get the translated field label!
 			//first check if it's in the main fields list
 			if ( isset( $template_fields[$field] ) ) {
-				if ( empty( $template_fields[$field] ) )
-					$field_label = $field; //most likely the field is found in the 'extra' array.
-				else
-					$field_label = $template_fields[$field]['label'];
+				if ( empty( $template_fields[$field] ) ) {
+									$field_label = $field;
+				}
+				//most likely the field is found in the 'extra' array.
+				else {
+									$field_label = $template_fields[$field]['label'];
+				}
 			}
 
 			//if field label is empty OR is equal to the current field then we need to loop through the 'extra' fields in the template_fields config (if present)
@@ -364,8 +373,9 @@ 
 						}
 
 						//if we've got a 'main' secondary field, let's see if that matches what field we're on which means it contains the label for this field.
-						if ( $name == 'main' && $main_field == $field_label )
-							$field_label = $values['label'];
+						if ( $name == 'main' && $main_field == $field_label ) {
+													$field_label = $values['label'];
+						}
 					}
 				}
 			}
@@ -385,13 +395,15 @@ 
 			if ( isset( $this->_validators[$field]['type'] ) && !empty( $this->_validators[$field]['type'] ) ) {
 				switch ( $this->_validators[$field]['type'] ) {
 					case 'number' :
-						if ( !is_numeric($value) )
-							$err_msg .= sprintf( __('<p>The %s field is supposed to be a number. The value given (%s)  is not.  Please doublecheck and make sure the field contains a number</p>', 'event_espresso'), $field_label, $value );
+						if ( !is_numeric($value) ) {
+													$err_msg .= sprintf( __('<p>The %s field is supposed to be a number. The value given (%s)  is not.  Please doublecheck and make sure the field contains a number</p>', 'event_espresso'), $field_label, $value );
+						}
 						break;
 					case 'email' :
 						$valid_email = $this->_validate_email($value);
-						if ( !$valid_email )
-							$err_msg .= htmlentities( sprintf( __('The %s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.'), $field_label ) );
+						if ( !$valid_email ) {
+													$err_msg .= htmlentities( sprintf( __('The %s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.'), $field_label ) );
+						}
 						break;
 					default :
 						break;
@@ -464,7 +476,10 @@ 
 			}
 		}
 
-		if ( empty( $diff ) ) return FALSE; //there is no diff, we have no invalid shortcodes, so return
+		if ( empty( $diff ) ) {
+			return FALSE;
+		}
+		//there is no diff, we have no invalid shortcodes, so return
 
 		//made it here? then let's assemble the error message
 		$invalid_shortcodes = implode( '</strong>,<strong>', $diff );
@@ -486,8 +501,9 @@ 
 		$or_val = $value;
 
 		//empty strings will validate because this is how a message template for a particula context can be "turned off" (if there is no email then no message)
-		if ( empty( $value ) )
-			return $validate;
+		if ( empty( $value ) ) {
+					return $validate;
+		}
 
 		//first determine if there ARE any shortcodes.  If there are shortcodes and then later we find that there were no other valid emails but the field isn't empty... that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
 		$has_shortcodes = preg_match('/(\[.+?\])/', $value);
@@ -498,8 +514,9 @@ 
 		//if original value is not empty and new value is, then we've parsed out a shortcode and we now have an empty string which DOES validate. We also validate complete empty field for email because its possible that this message is being "turned off" for a particular context
 
 
-		if ( !empty($or_val) && empty($value) )
-			return $validate;
+		if ( !empty($or_val) && empty($value) ) {
+					return $validate;
+		}
 
 		//trim any commas from beginning and end of string ( after whitespace trimmed );
 		$value = trim( trim($value), ',' );
@@ -520,12 +537,12 @@ 
 			//either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
 			if(is_email($email)){
 				continue;
-			}else{
+			} else{
 				$matches = array();
 				$validate = preg_match( '/(.*)<(.+)>/', $email, $matches ) ? TRUE : FALSE;
 				if( $validate && is_email($matches[2])){
 					continue;
-				}else{
+				} else{
 					return false;
 				}
 			}

core/libraries/payment_methods/EE_PMT_Base.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -266,7 +266,7 @@
 	 *
 	 * @param \EE_Transaction $transaction
 	 * @param array $extra_args
-	 * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
+	 * @return EE_Billing_Info_Form
 	 */
 	public function billing_form( EE_Transaction $transaction = NULL, $extra_args = array() ){
 		// has billing form already been regenerated ? or overwrite cache?

Braces +5 added lines, -5 removed lines

@@ -442,7 +442,7 @@ 
 	protected function _get_billing_values_from_form( $billing_form ){
 		if($billing_form instanceof EE_Form_Section_Proper ){
 			return $billing_form->input_pretty_values( true );
-		}else{
+		} else{
 			return NULL;
 		}
 	}
@@ -550,7 +550,7 @@ 
 	public function supports_sending_refunds(){
 		if($this->_gateway && $this->_gateway instanceof EE_Gateway){
 			return $this->_gateway->supports_sending_refunds();
-		}else{
+		} else{
 			return false;
 		}
 	}
@@ -588,11 +588,11 @@ 
 	public function payment_occurs(){
 		if( ! $this->_gateway){
 			return EE_PMT_Base::offline;
-		}elseif($this->_gateway instanceof EE_Onsite_Gateway){
+		} elseif($this->_gateway instanceof EE_Onsite_Gateway){
 			return EE_PMT_Base::onsite;
-		}elseif($this->_gateway instanceof EE_Offsite_Gateway){
+		} elseif($this->_gateway instanceof EE_Offsite_Gateway){
 			return EE_PMT_Base::offsite;
-		}else{
+		} else{
 			throw new EE_Error(sprintf(__("Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those", "event_espresso"),get_class($this)));
 		}
 	}

Spacing +104 added lines, -104 removed lines

@@ -14,7 +14,7 @@ 
  * @since 				$VID:$
  *
  */
-abstract class EE_PMT_Base{
+abstract class EE_PMT_Base {
 
 	const onsite = 'on-site';
 	const offsite = 'off-site';
@@ -95,33 +95,33 @@ 
 	 * @return EE_PMT_Base
 	 */
 	function __construct($pm_instance = NULL) {
-		if ( $pm_instance instanceof EE_Payment_Method ){
+		if ($pm_instance instanceof EE_Payment_Method) {
 			$this->set_instance($pm_instance);
 		}
 		$this->_set_file_folder();
 		$this->_set_file_url();
-		if($this->_gateway){
-			$this->_gateway->set_payment_model( EEM_Payment::instance() );
-			$this->_gateway->set_payment_log( EEM_Change_Log::instance() );
-			$this->_gateway->set_template_helper( new EEH_Template() );
-			$this->_gateway->set_line_item_helper( new EEH_Line_Item() );
-			$this->_gateway->set_money_helper( new EEH_Money() );
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
 		}
-		if ( ! isset( $this->_has_billing_form ) ) {
+		if ( ! isset($this->_has_billing_form)) {
 			// by default, On Site gateways have a billing form
-			if ( $this->payment_occurs() == EE_PMT_Base::onsite ) {
-				$this->set_has_billing_form( true );
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
 			} else {
-				$this->set_has_billing_form( false );
+				$this->set_has_billing_form(false);
 			}
 		}
 
-		if( ! $this->_pretty_name){
+		if ( ! $this->_pretty_name) {
 			throw new EE_Error(sprintf(__("You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized", "event_espresso")));
 		}
 		//if the child didn't specify a default button, use the credit card one
-		if( $this->_default_button_url === NULL){
-			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
+		if ($this->_default_button_url === NULL) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL.'payment_methods'.DS.'pay-by-credit-card.png';
 		}
 	}
 
@@ -130,8 +130,8 @@ 
 	/**
 	 * @param boolean $has_billing_form
 	 */
-	public function set_has_billing_form( $has_billing_form ) {
-		$this->_has_billing_form = filter_var( $has_billing_form, FILTER_VALIDATE_BOOLEAN );
+	public function set_has_billing_form($has_billing_form) {
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
 	}
 
 
@@ -139,10 +139,10 @@ 
 	/**
 	 * sets the file_folder property
 	 */
-	protected function _set_file_folder(){
+	protected function _set_file_folder() {
 		$reflector = new ReflectionClass(get_class($this));
 		$fn = $reflector->getFileName();
-		$this->_file_folder =  dirname($fn).DS;
+		$this->_file_folder = dirname($fn).DS;
 	}
 
 
@@ -150,10 +150,10 @@ 
 	/**
 	 * sets the file URL with a trailing slash for this PMT
 	 */
-	protected function _set_file_url(){
-		$plugins_dir_fixed = str_replace('\\',DS,WP_PLUGIN_DIR);
-		$file_folder_fixed = str_replace('\\',DS,$this->file_folder());
-		$file_path = str_replace($plugins_dir_fixed,WP_PLUGIN_URL,$file_folder_fixed);
+	protected function _set_file_url() {
+		$plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', DS, $this->file_folder());
+		$file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
 		$this->_file_url = $file_path;
 	}
 
@@ -161,7 +161,7 @@ 
 	 * Gets the default description on all payment methods of this type
 	 * @return string
 	 */
-	public function default_description(){
+	public function default_description() {
 		return $this->_default_description;
 	}
 
@@ -171,7 +171,7 @@ 
 	 * Returns the folder containing the PMT child class, with a trailing slash
 	 * @return string
 	 */
-	public function file_folder(){
+	public function file_folder() {
 		return $this->_file_folder;
 	}
 
@@ -180,7 +180,7 @@ 
 	/**
 	 * @return string
 	 */
-	public function file_url(){
+	public function file_url() {
 		return $this->_file_url;
 	}
 
@@ -191,14 +191,14 @@ 
 	 * Its important teh payment method instance is set before
 	 * @param EE_Payment_Method $payment_method_instance
 	 */
-	function set_instance($payment_method_instance){
+	function set_instance($payment_method_instance) {
 		$this->_pm_instance = $payment_method_instance;
 		//if they have already requested the settings form, make sure its
 		//data matches this model object
-		if($this->_settings_form){
+		if ($this->_settings_form) {
 			$this->settings_form()->populate_model_obj($payment_method_instance);
 		}
-		if($this->_gateway && $this->_gateway instanceof EE_Gateway){
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
 			$this->_gateway->set_settings($payment_method_instance->settings_array());
 		}
 	}
@@ -209,14 +209,14 @@ 
 	 * Gets teh form for displaying to admins where they setup the payment method
 	 * @return EE_Payment_Method_Form
 	 */
-	function settings_form(){
-		if( ! $this->_settings_form){
+	function settings_form() {
+		if ( ! $this->_settings_form) {
 			$this->_settings_form = $this->generate_new_settings_form();
-			$this->_settings_form->set_payment_method_type( $this );
-			$this->_settings_form->_construct_finalize(NULL, NULL );
+			$this->_settings_form->set_payment_method_type($this);
+			$this->_settings_form->_construct_finalize(NULL, NULL);
 			//if we have already assigned a model object to this pmt, make
 			//sure its reflected in teh form we just generated
-			if($this->_pm_instance){
+			if ($this->_pm_instance) {
 				$this->_settings_form->populate_model_obj($this->_pm_instance);
 			}
 		}
@@ -242,7 +242,7 @@ 
 	 * this payment method type's settings form later in the request
 	 * @param EE_Payment_Method_Form $form
 	 */
-	public function set_settings_form($form){
+	public function set_settings_form($form) {
 		$this->_settings_form = $form;
 	}
 
@@ -265,10 +265,10 @@ 
 	 * @param array $extra_args
 	 * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
 	 */
-	public function billing_form( EE_Transaction $transaction = NULL, $extra_args = array() ){
+	public function billing_form(EE_Transaction $transaction = NULL, $extra_args = array()) {
 		// has billing form already been regenerated ? or overwrite cache?
-		if ( ! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form ){
-			$this->_billing_form = $this->generate_new_billing_form( $transaction, $extra_args );
+		if ( ! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
 		}
 		//if we know who the attendee is, and this is a billing form
 		//that uses attendee info, populate it
@@ -277,8 +277,8 @@ 
 			$transaction instanceof EE_Transaction &&
 			$transaction->primary_registration() instanceof EE_Registration &&
 			$transaction->primary_registration()->attendee() instanceof EE_Attendee
-		){
-			$this->_billing_form->populate_from_attendee( $transaction->primary_registration()->attendee() );
+		) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
 		}
 		return $this->_billing_form;
 	}
@@ -289,7 +289,7 @@ 
 	 * @param \EE_Transaction $transaction
 	 * @return \EE_Billing_Info_Form
 	 */
-	abstract function generate_new_billing_form( EE_Transaction $transaction = NULL );
+	abstract function generate_new_billing_form(EE_Transaction $transaction = NULL);
 
 
 
@@ -300,7 +300,7 @@ 
 	 * @param \EE_Billing_Info_Form $billing_form
 	 * @return \EE_Billing_Info_Form
 	 */
-	public function apply_billing_form_debug_settings( EE_Billing_Info_Form $billing_form ) {
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form) {
 		return $billing_form;
 	}
 
@@ -311,7 +311,7 @@ 
 	 * if you have form
 	 * @param EE_Payment_Method $form
 	 */
-	public function set_billing_form($form){
+	public function set_billing_form($form) {
 		$this->_billing_form = $form;
 	}
 
@@ -321,7 +321,7 @@ 
 	 * Returns whether or not this payment method requires HTTPS to be used
 	 * @return boolean
 	 */
-	function requires_https(){
+	function requires_https() {
 		return $this->_requires_https;
 	}
 
@@ -339,9 +339,9 @@ 
 	 * @return EE_Payment
 	 * @throws EE_Error
 	 */
-	function process_payment( EE_Transaction $transaction, $amount = null, $billing_info = null, $return_url = null,$fail_url = '', $method = 'CART', $by_admin = false ){
+	function process_payment(EE_Transaction $transaction, $amount = null, $billing_info = null, $return_url = null, $fail_url = '', $method = 'CART', $by_admin = false) {
 		// @todo: add surcharge for the payment method, if any
-		if ( $this->_gateway ) {
+		if ($this->_gateway) {
 			//there is a gateway, so we're going to make a payment object
 			//but wait! do they already have a payment in progress that we thought was failed?
 			$duplicate_properties = array(
@@ -352,10 +352,10 @@ 
 				'PAY_amount' 					=> $amount !== null ? $amount : $transaction->remaining(),
 				'PAY_gateway_response' 	=> null,
 			);
-			$payment = EEM_Payment::instance()->get_one( array( $duplicate_properties ));
+			$payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
 			//if we didn't already have a payment in progress for the same thing,
 			//then we actually want to make a new payment
-			if ( ! $payment instanceof EE_Payment ){
+			if ( ! $payment instanceof EE_Payment) {
 				$payment = EE_Payment::new_instance(
 					array_merge(
 						$duplicate_properties,
@@ -371,10 +371,10 @@ 
 			}
 			//make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
 			$payment->save();
-			$billing_values = $this->_get_billing_values_from_form( $billing_info );
+			$billing_values = $this->_get_billing_values_from_form($billing_info);
 
 			//  Offsite Gateway
-			if( $this->_gateway instanceof EE_Offsite_Gateway ){
+			if ($this->_gateway instanceof EE_Offsite_Gateway) {
 
 				$payment = $this->_gateway->set_redirection_info(
 					$payment,
@@ -390,17 +390,17 @@ 
 				);
 				$payment->save();
 			//  Onsite Gateway
-			} elseif ( $this->_gateway instanceof EE_Onsite_Gateway ) {
+			} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
 
-				$payment = $this->_gateway->do_direct_payment($payment,$billing_values);
+				$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
 				$payment->save();
 
 			} else {
 				throw new EE_Error(
 					sprintf(
-						__('Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)', 'event_espresso' ),
+						__('Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)', 'event_espresso'),
 						get_class($this),
-						gettype( $this->_gateway )
+						gettype($this->_gateway)
 					)
 				);
 			}
@@ -422,8 +422,8 @@ 
 		}
 
 		// if there is billing info, clean it and save it now
-		if( $billing_info instanceof EE_Billing_Attendee_Info_Form ){
-			$this->_save_billing_info_to_attendee( $billing_info, $transaction );
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
 		}
 
 		return $payment;
@@ -436,10 +436,10 @@ 
 	 * @param EE_Billing_Info_Form $billing_form
 	 * @return array
 	 */
-	protected function _get_billing_values_from_form( $billing_form ){
-		if($billing_form instanceof EE_Form_Section_Proper ){
-			return $billing_form->input_pretty_values( true );
-		}else{
+	protected function _get_billing_values_from_form($billing_form) {
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			return $billing_form->input_pretty_values(true);
+		} else {
 			return NULL;
 		}
 	}
@@ -453,13 +453,13 @@ 
 	 * @return EE_Payment
 	 * @throws EE_Error
 	 */
-	public function handle_ipn($req_data,$transaction){
+	public function handle_ipn($req_data, $transaction) {
 		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-		if( ! $this->_gateway instanceof EE_Offsite_Gateway){
-			throw new EE_Error(sprintf(__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"), print_r( $this->_gateway, TRUE )));
+		if ( ! $this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(sprintf(__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"), print_r($this->_gateway, TRUE)));
 
 		}
-		$payment = $this->_gateway->handle_payment_update( $req_data, $transaction );
+		$payment = $this->_gateway->handle_payment_update($req_data, $transaction);
 		return $payment;
 	}
 
@@ -472,22 +472,22 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean success
 	 */
-	protected function _save_billing_info_to_attendee($billing_form, $transaction){
-		if( ! $transaction || ! $transaction instanceof EE_Transaction){
+	protected function _save_billing_info_to_attendee($billing_form, $transaction) {
+		if ( ! $transaction || ! $transaction instanceof EE_Transaction) {
 			EE_Error::add_error(__("Cannot save billing info because no transaction was specified", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		$primary_reg = $transaction->primary_registration();
-		if( ! $primary_reg ){
+		if ( ! $primary_reg) {
 			EE_Error::add_error(__("Cannot save billing info because the transaction has no primary registration", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		$attendee = $primary_reg->attendee();
-		if( ! $attendee ){
+		if ( ! $attendee) {
 			EE_Error::add_error(__("Cannot save billing info because the transaction's primary registration has no attendee!", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method() );
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
 
 	}
 
@@ -500,7 +500,7 @@ 
 	 * @param array $req_data
 	 * @return EE_Payment
 	 */
-	protected function find_payment_for_ipn( EE_Transaction $transaction, $req_data = array() ){
+	protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array()) {
 		return $transaction->last_payment();
 	}
 
@@ -517,8 +517,8 @@ 
 	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
 	 * @throws EE_Error
 	 */
-	public function handle_unclaimed_ipn( $req_data = array() ){
-		throw new EE_Error(sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this) ));
+	public function handle_unclaimed_ipn($req_data = array()) {
+		throw new EE_Error(sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this)));
 	}
 
 
@@ -534,7 +534,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return EE_Payment
 	 */
-	public function finalize_payment_for($transaction){
+	public function finalize_payment_for($transaction) {
 		return $transaction->last_payment();
 	}
 
@@ -544,10 +544,10 @@ 
 	 * Whether or not this payment method's gateway supports sending refund requests
 	 * @return boolean
 	 */
-	public function supports_sending_refunds(){
-		if($this->_gateway && $this->_gateway instanceof EE_Gateway){
+	public function supports_sending_refunds() {
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
 			return $this->_gateway->supports_sending_refunds();
-		}else{
+		} else {
 			return false;
 		}
 	}
@@ -561,14 +561,14 @@ 
 	 * @throws EE_Error
 	 * @return EE_Payment
 	 */
-	public function process_refund( EE_Payment $payment, $refund_info = array()){
-		if ( $this->_gateway && $this->_gateway instanceof EE_Gateway ) {
-			return $this->_gateway->do_direct_refund( $payment, $refund_info );
+	public function process_refund(EE_Payment $payment, $refund_info = array()) {
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
 		} else {
 			throw new EE_Error(
 				sprintf(
-					__( 'Payment Method Type "%s" does not support sending refund requests', 'event_espresso' ),
-					get_class( $this )
+					__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
 				)
 			);
 		}
@@ -582,15 +582,15 @@ 
 	 * @return string
 	 * @throws EE_Error
 	 */
-	public function payment_occurs(){
-		if( ! $this->_gateway){
+	public function payment_occurs() {
+		if ( ! $this->_gateway) {
 			return EE_PMT_Base::offline;
-		}elseif($this->_gateway instanceof EE_Onsite_Gateway){
+		}elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
 			return EE_PMT_Base::onsite;
-		}elseif($this->_gateway instanceof EE_Offsite_Gateway){
+		}elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
 			return EE_PMT_Base::offsite;
-		}else{
-			throw new EE_Error(sprintf(__("Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those", "event_espresso"),get_class($this)));
+		} else {
+			throw new EE_Error(sprintf(__("Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those", "event_espresso"), get_class($this)));
 		}
 	}
 
@@ -603,8 +603,8 @@ 
 	 * @param EE_Payment $payment
 	 * @return string
 	 */
-	public function payment_overview_content(EE_Payment $payment){
-		return EEH_Template::display_template(EE_LIBRARIES.'payment_methods'.DS.'templates'.DS.'payment_details_content.template.php', array('payment_method'=>$this->_pm_instance,'payment'=>$payment) , true);
+	public function payment_overview_content(EE_Payment $payment) {
+		return EEH_Template::display_template(EE_LIBRARIES.'payment_methods'.DS.'templates'.DS.'payment_details_content.template.php', array('payment_method'=>$this->_pm_instance, 'payment'=>$payment), true);
 	}
 
 
@@ -617,7 +617,7 @@ 
 	 *	@type array $template_args any arguments you want passed to the template file while rendering.
 	 *				Keys will be variable names and values with be their values.
 	 */
-	public function help_tabs_config(){
+	public function help_tabs_config() {
 		return array();
 	}
 
@@ -628,9 +628,9 @@ 
 	 * the payment method's table's PMT_type column)
 	 * @return string
 	 */
-	public function system_name(){
+	public function system_name() {
 		$classname = get_class($this);
-		return str_replace("EE_PMT_",'',$classname);
+		return str_replace("EE_PMT_", '', $classname);
 	}
 
 
@@ -639,7 +639,7 @@ 
 	 * A pretty i18n version of the PMT name
 	 * @return string
 	 */
-	public function pretty_name(){
+	public function pretty_name() {
 		return $this->_pretty_name;
 	}
 
@@ -649,7 +649,7 @@ 
 	 * Gets the default absolute URL to the payment method type's button
 	 * @return string
 	 */
-	public function default_button_url(){
+	public function default_button_url() {
 		return $this->_default_button_url;
 	}
 
@@ -659,7 +659,7 @@ 
 	 * Gets the gateway used by this payment method (if any)
 	 * @return EE_Gateway
 	 */
-	public function get_gateway(){
+	public function get_gateway() {
 		return $this->_gateway;
 	}
 
@@ -668,8 +668,8 @@ 
 	/**
 	 * @return string html for the link to a help tab
 	 */
-	public function get_help_tab_link(){
-		return EEH_Template::get_help_tab_link( $this->get_help_tab_name() );
+	public function get_help_tab_link() {
+		return EEH_Template::get_help_tab_link($this->get_help_tab_name());
 	}
 
 
@@ -678,8 +678,8 @@ 
 	 * Returns the name of the help tab for this PMT
 	 * @return string
 	 */
-	public function get_help_tab_name(){
-		return 'ee_' . strtolower( $this->system_name() ) . '_help_tab';
+	public function get_help_tab_name() {
+		return 'ee_'.strtolower($this->system_name()).'_help_tab';
 	}
 
 	/**
@@ -687,8 +687,8 @@ 
 	 * this PMT by an admin
 	 * @return string
 	 */
-	public function cap_name(){
-		return 'ee_payment_method_' . strtolower( $this->system_name() );
+	public function cap_name() {
+		return 'ee_payment_method_'.strtolower($this->system_name());
 	}
 
 	/**
@@ -700,9 +700,9 @@ 
 	 * @param EE_Payment $payment
 	 * @return void
 	 */
-	public function update_txn_based_on_payment( $payment ){
-		if( $this->_gateway instanceof EE_Gateway ){
-			$this->_gateway->update_txn_based_on_payment( $payment );
+	public function update_txn_based_on_payment($payment) {
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
 		}
 	}