eventespresso / event-espresso-core

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

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
 	/**
 	 * Applies all teh individual item validation strategies on each item in the array
 	 * @param array $normalized_value
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function validate($normalized_value) {
 		if( is_array($normalized_value)){

Spacing +9 added lines, -9 removed lines

@@ -11,14 +11,14 @@ 
  * @since 				4.6
  *
  */
-class EE_Many_Valued_Validation_Strategy extends EE_Validation_Strategy_Base{
+class EE_Many_Valued_Validation_Strategy extends EE_Validation_Strategy_Base {
 	protected $_individual_item_validation_strategies = array();
 	/**
 	 *
 	 * @param EE_Validation_Strategy_Base[] $individual_item_validation_strategies (or a single EE_Validation_Strategy_Base)
 	 */
 	public function __construct($individual_item_validation_strategies) {
-		if( ! is_array($individual_item_validation_strategies)){
+		if ( ! is_array($individual_item_validation_strategies)) {
 			$individual_item_validation_strategies = array($individual_item_validation_strategies);
 		}
 		$this->_individual_item_validation_strategies = $individual_item_validation_strategies;
@@ -30,14 +30,14 @@ 
 	 * @return boolean
 	 */
 	function validate($normalized_value) {
-		if( is_array($normalized_value)){
+		if (is_array($normalized_value)) {
 			$items_to_validate = $normalized_value;
-		}else{
+		} else {
 			$items_to_validate = array($normalized_value);
 		}
-		foreach($items_to_validate as $individual_item){
-			foreach($this->_individual_item_validation_strategies as $validation_strategy){
-				if ( $validation_strategy instanceof EE_Validation_Strategy_Base ) {
+		foreach ($items_to_validate as $individual_item) {
+			foreach ($this->_individual_item_validation_strategies as $validation_strategy) {
+				if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
 					$validation_strategy->validate($individual_item);
 				}
 			}
@@ -50,8 +50,8 @@ 
 	 */
 	function _construct_finalize(\EE_Form_Input_Base $form_input) {
 		parent::_construct_finalize($form_input);
-		foreach($this->_individual_item_validation_strategies as $item_validation_strategy){
-			if ( $item_validation_strategy instanceof EE_Validation_Strategy_Base ) {
+		foreach ($this->_individual_item_validation_strategies as $item_validation_strategy) {
+			if ($item_validation_strategy instanceof EE_Validation_Strategy_Base) {
 				$item_validation_strategy->_construct_finalize($form_input);
 			}
 		}

Braces +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 		//so in case teh IPN is arriving later, let's try to process an IPN!
 		if($_SERVER['REQUEST_METHOD'] == 'POST'){
 			return $this->handle_ipn($_POST, $transaction );
-		}else{
+		} else{
 			return parent::finalize_payment_for( $transaction );
 		}
 	}

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

Doc Comments +4 added lines

@@ -10,6 +10,10 @@
 class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base{
 
 	protected $_regex = null;
+
+	/**
+	 * @param string $regex
+	 */
 	public function __construct( $validation_error_message = NULL, $regex = null ) {
 		$this->_regex = $regex;
 		parent::__construct( $validation_error_message );

Indentation +7 added lines, -7 removed lines

@@ -1,12 +1,12 @@
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
 /**
- * EE_Text_Validation_Strategy
- * Optionally, a regular expression can be provided that will be used for validation.
- *
- * @package			Event Espresso
- * @subpackage	Expression package is undefined on line 19, column 19 in Templates/Scripting/PHPClass.php.
- * @author				Mike Nelson
- */
+	 * EE_Text_Validation_Strategy
+	 * Optionally, a regular expression can be provided that will be used for validation.
+	 *
+	 * @package			Event Espresso
+	 * @subpackage	Expression package is undefined on line 19, column 19 in Templates/Scripting/PHPClass.php.
+	 * @author				Mike Nelson
+	 */
 class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base{
 
 	protected $_regex = null;

Spacing +12 added lines, -12 removed lines

@@ -7,21 +7,21 @@ 
  * @subpackage	Expression package is undefined on line 19, column 19 in Templates/Scripting/PHPClass.php.
  * @author				Mike Nelson
  */
-class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base{
+class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base {
 
 	protected $_regex = null;
-	public function __construct( $validation_error_message = NULL, $regex = null ) {
+	public function __construct($validation_error_message = NULL, $regex = null) {
 		$this->_regex = $regex;
-		parent::__construct( $validation_error_message );
+		parent::__construct($validation_error_message);
 	}
 
 	/**
 	 * @param $normalized_value
 	 */
 	public function validate($normalized_value) {
-		if( $this->_regex && $normalized_value) {
-			if( ! preg_match( $this->_regex, $normalized_value ) ) {
-				throw new EE_Validation_Error( $this->get_validation_error_message(), 'regex' );
+		if ($this->_regex && $normalized_value) {
+			if ( ! preg_match($this->_regex, $normalized_value)) {
+				throw new EE_Validation_Error($this->get_validation_error_message(), 'regex');
 			}
 		}
 	}
@@ -29,10 +29,10 @@ 
 	/**
 	 * @return array
 	 */
-	function get_jquery_validation_rule_array(){
-		if( $this->_regex !== null ){
-			return array( 'regex'=> $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) );
-		}else{
+	function get_jquery_validation_rule_array() {
+		if ($this->_regex !== null) {
+			return array('regex'=> $this->regex_js(), 'messages' => array('regex' => $this->get_validation_error_message()));
+		} else {
 			return array();
 		}
 
@@ -46,8 +46,8 @@ 
 	function regex_js() {
 		//first character must be the delimiter
 		$delimeter = $this->_regex[0];
-		$last_occurence_of_delimieter = strrpos($this->_regex, $delimeter );
-		return substr( $this->_regex, 1, $last_occurence_of_delimieter - 1 );
+		$last_occurence_of_delimieter = strrpos($this->_regex, $delimeter);
+		return substr($this->_regex, 1, $last_occurence_of_delimieter - 1);
 	}
 }
 

Braces +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 		//so in case teh IPN is arriving later, let's try to process an IPN!
 		if($_SERVER['REQUEST_METHOD'] == 'POST'){
 			return $this->handle_ipn($_POST, $transaction );
-		}else{
+		} else{
 			return parent::finalize_payment_for( $transaction );
 		}
 	}

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) {

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,17 +30,17 @@ 
 	 * @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 ($normalized_value) {
+			if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false) {
+				throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url');
+			} else {
 				EE_Registry::instance()->load_helper('URL');
-				if( ! EEH_URL::remote_file_exists(
+				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")));
 				}
 			}
@@ -52,8 +52,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()));
 	}
 }
 

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,

core/libraries/line_item_display/EE_Default_Line_Item_Display_Strategy.strategy.php

Doc Comments +3 added lines, -3 removed lines

@@ -55,7 +55,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() ) {
 
@@ -135,7 +135,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
@@ -178,7 +178,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

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_Default_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- * @since		 	   $VID:$
- *
- */
+  *
+  * Class EE_Default_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  * @since		 	   $VID:$
+  *
+  */
 
 class EE_Default_Line_Item_Display_Strategy implements EEI_Line_Item_Display {
 

Spacing +39 added lines, -39 removed lines

@@ -57,32 +57,32 @@ 
 	 * @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()) {
 
-		EE_Registry::instance()->load_helper( 'Template' );
-		EE_Registry::instance()->load_helper( 'HTML' );
+		EE_Registry::instance()->load_helper('Template');
+		EE_Registry::instance()->load_helper('HTML');
 
 		$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:
 				// 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:
@@ -93,10 +93,10 @@ 
 				break;
 
 			case EEM_Line_Item::type_tax_sub_total:
-				foreach ( $line_item->children() as $child_line_item ) {
-					if ( $child_line_item->type() == EEM_Line_Item::type_tax ) {
+				foreach ($line_item->children() as $child_line_item) {
+					if ($child_line_item->type() == EEM_Line_Item::type_tax) {
 						// recursively feed children back into this method
-						$this->display_line_item( $child_line_item, $options );
+						$this->display_line_item($child_line_item, $options);
 					}
 				}
 				break;
@@ -104,20 +104,20 @@ 
 			case EEM_Line_Item::type_total:
 				// get all child line items
 				$children = $line_item->children();
-				if ( $options[ 'set_tax_rate' ] === true  ) {
+				if ($options['set_tax_rate'] === true) {
 					// loop thru tax child line items just to determine tax rate
-					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
-							$this->display_line_item( $child_line_item, $options );
+							$this->display_line_item($child_line_item, $options);
 						}
 					}
 				} else {
 					// now 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);
 						}
 					}
 				}
@@ -137,10 +137,10 @@ 
 	 * @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 );
+		$html = EEH_HTML::tr('', '', $row_class);
 		// name && desc
 		$name_and_desc = apply_filters(
 			'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__name',
@@ -149,22 +149,22 @@ 
 		);
 		$name_and_desc .= apply_filters(
 			'FHEE__EE_Default_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() ? '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">' . __( ' * taxable item', 'event_espresso' ) . '</span>' : '';
+		$name_and_desc .= $line_item->is_taxable() ? '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'.__(' * taxable item', 'event_espresso').'</span>' : '';
 		// name td
-		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '',  'item_l' );
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '', 'item_l' );
 		// quantity td
-		$html .= EEH_HTML::td( $line_item->quantity(), '',  'item_l jst-rght' );
-		$tax_rate = $line_item->is_taxable() ? 1 + ( $this->_tax_rate / 100 ) : 1;
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+		$tax_rate = $line_item->is_taxable() ? 1 + ($this->_tax_rate / 100) : 1;
 		// price td
-		$unit_price = EEH_Template::format_currency( $line_item->unit_price() * $tax_rate, false, false );
-		$html .= EEH_HTML::td( $unit_price, '',  'item_c jst-rght' );
+		$unit_price = EEH_Template::format_currency($line_item->unit_price() * $tax_rate, false, false);
+		$html .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
 		// total td
-		$total = EEH_Template::format_currency( $line_item->unit_price() * $line_item->quantity() * $tax_rate, false, false );
-		$html .= EEH_HTML::td( $total, '',  'item_r jst-rght' );
+		$total = EEH_Template::format_currency($line_item->unit_price() * $line_item->quantity() * $tax_rate, false, false);
+		$html .= EEH_HTML::td($total, '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 
@@ -180,22 +180,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;

core/libraries/line_item_display/EE_Invoice_Line_Item_Display_Strategy.strategy.php

Doc Comments +6 added lines, -6 removed lines

@@ -16,7 +16,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() ) {
 
@@ -94,7 +94,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
@@ -123,7 +123,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
@@ -153,7 +153,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
@@ -179,7 +179,7 @@ 
 	 * @param EE_Line_Item $line_item
 	 * @param string       $text
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _total_row( EE_Line_Item $line_item, $text = '', $options = array() ) {
 		// colspan
@@ -203,7 +203,7 @@ 
 	 * 	_separator_row
 	 *
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _separator_row( $options = array() ) {
 		// colspan

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_Invoice_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- * @since		 	   $VID:$
- *
- */
+  *
+  * Class EE_Invoice_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  * @since		 	   $VID:$
+  *
+  */
 class EE_Invoice_Line_Item_Display_Strategy implements EEI_Line_Item_Display {
 
 	/**

Spacing +49 added lines, -49 removed lines

@@ -18,9 +18,9 @@ 
 	 * @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()) {
 
-		EE_Registry::instance()->load_helper( 'HTML' );
+		EE_Registry::instance()->load_helper('HTML');
 
 		$html = '';
 		// set some default options and merge with incoming
@@ -28,58 +28,58 @@ 
 			'show_desc' => TRUE,
 			'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_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 );
+					$html .= $this->display_line_item($child_line_item, $options);
 				}
-				$html .= $this->_separator_row( $options );
-				$html .= $this->_total_row( $line_item, __('Total', 'event_espresso'), $options );
+				$html .= $this->_separator_row($options);
+				$html .= $this->_total_row($line_item, __('Total', 'event_espresso'), $options);
 				 break;
 
 
 			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 );
+					$html .= $this->display_line_item($child_line_item, $options);
 				}
-				$html .= $this->_total_row( $line_item, __('Sub-Total', 'event_espresso'), $options );
+				$html .= $this->_total_row($line_item, __('Sub-Total', 'event_espresso'), $options);
 				break;
 
 
 			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 );
+					$html .= $this->display_line_item($child_line_item, $options);
 				}
-				$html .= $this->_total_row( $line_item, __('Tax Total', 'event_espresso'), $options );
+				$html .= $this->_total_row($line_item, __('Tax Total', 'event_espresso'), $options);
 				break;
 
 
 			case EEM_Line_Item::type_line_item:
 				// 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_tax:
-				$html .= $this->_tax_row( $line_item, $options );
+				$html .= $this->_tax_row($line_item, $options);
 				break;
 
 		}
@@ -96,21 +96,21 @@ 
 	 * @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 );
+		$html = EEH_HTML::tr('', $row_class);
 		// name td
-		$html .= EEH_HTML::td( $line_item->name(), '',  'item_l' );
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l');
 		// desc td
-		$html .= $options['show_desc'] ? EEH_HTML::td( $line_item->desc(), '',  'item_l' ) : '';
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
 		// quantity td
-		$html .= EEH_HTML::td( $line_item->quantity(), '',  'item_l' );
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l');
 		// price td
-		$html .= EEH_HTML::td( $line_item->unit_price_no_code(), '',  'item_c' );
+		$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
 		// total td
-		$total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
-		$html .= EEH_HTML::td( $total, '',  'item_r' );
+		$total = $line_item->is_taxable() ? $line_item->total_no_code().'*' : $line_item->total_no_code();
+		$html .= EEH_HTML::td($total, '', 'item_r');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -125,22 +125,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 td
-		$html .= EEH_HTML::td( $line_item->name(), '',  'item_l sub-item' );
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
 		// desc td
-		$html .= $options['show_desc'] ? EEH_HTML::td( $line_item->desc(), '',  'item_l' ) : '';
-		$html .= EEH_HTML::td() . EEH_HTML::tdx();
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		$html .= EEH_HTML::td().EEH_HTML::tdx();
 		// 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' );
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
 		}
 		// total td
-		$html .= EEH_HTML::td( $line_item->total_no_code(), '',  'item_r' );
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -155,17 +155,17 @@ 
 	 * @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 td
-		$html .= EEH_HTML::td( $line_item->name(), '',  'item_l sub-item' );
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
 		// desc td
-		$html .= $options['show_desc'] ? EEH_HTML::td( $line_item->desc(), '',  'item_l' ) : '';
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
 		// percent td
-		$html .= EEH_HTML::td( $line_item->percent() . '%', '',  'item_c', '', ' colspan="2"' );
+		$html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c', '', ' colspan="2"');
 		// total td
-		$html .= EEH_HTML::td( $line_item->total_no_code(), '',  'item_r' );
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -181,17 +181,17 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _total_row( EE_Line_Item $line_item, $text = '', $options = array() ) {
+	private function _total_row(EE_Line_Item $line_item, $text = '', $options = array()) {
 		// colspan
 		$colspan = $options['show_desc'] ? ' colspan="2"' : '';
 		// start of row
-		$html = EEH_HTML::tr( '', '', 'total_tr odd' );
+		$html = EEH_HTML::tr('', '', 'total_tr odd');
 		// empty td
-		$html .= EEH_HTML::td( EEH_HTML::nbsp(), '',  '',  '',  $colspan );
+		$html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
 		// total td
-		$html .= EEH_HTML::td( $text, '',  'total_currency total',  '',  $colspan );
+		$html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
 		// total td
-		$html .= EEH_HTML::td( $line_item->total_no_code(), '',  'total' );
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'total');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -205,11 +205,11 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _separator_row( $options = array() ) {
+	private function _separator_row($options = array()) {
 		// colspan
 		$colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
 		// start of row
-		$html = EEH_HTML::tr( EEH_HTML::td( '<hr>', '',  '',  '',  $colspan ));
+		$html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
 //		// separator td
 //		$html .= EEH_HTML::td( '<hr>', '',  '',  '',  $colspan );
 //		// end of row

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 +8 added lines, -8 removed lines

@@ -33,9 +33,9 @@ 
 	 * @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()) {
 
-		EE_Registry::instance()->load_helper( 'HTML' );
+		EE_Registry::instance()->load_helper('HTML');
 
 		$html = '';
 		// set some default options and merge with incoming
@@ -43,12 +43,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 );
 				}
@@ -59,7 +59,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 );
 				}
@@ -69,7 +69,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 );
 				}
@@ -81,7 +81,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,104 +69,104 @@ 
 	 * @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()) {
 
-		EE_Registry::instance()->load_helper( 'Template' );
-		EE_Registry::instance()->load_helper( 'HTML' );
+		EE_Registry::instance()->load_helper('Template');
+		EE_Registry::instance()->load_helper('HTML');
 
 		$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;
@@ -175,25 +175,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;
 
 		}
@@ -208,11 +208,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;
@@ -227,10 +227,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',
@@ -239,23 +239,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;
@@ -270,38 +270,38 @@ 
 	 * @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 );
+		$html = EEH_HTML::tr('', '', $row_class);
 		// name && desc
 		$name_and_desc = apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-			$line_item->OBJ_type() . ': ' . $line_item->name(),
+			$line_item->OBJ_type().': '.$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();
-		$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;
@@ -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.
 	 */

Spacing +86 added lines, -86 removed lines

@@ -167,48 +167,48 @@ 
 	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));
 		}
 
 		//load template helper
-		EE_Registry::instance()->load_helper( 'Template' );
+		EE_Registry::instance()->load_helper('Template');
 
 	}
 
@@ -243,8 +243,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);
 	}
 
 
@@ -261,7 +261,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();
 
 		/**
@@ -280,28 +280,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;
@@ -319,22 +319,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:
@@ -348,28 +348,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);
 	}
 
 
@@ -384,8 +384,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);
 	}
 
 
@@ -400,11 +400,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);
 	}
 
 
@@ -420,25 +420,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;
 	}
 
 
@@ -459,39 +459,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);
 	}
 
 
@@ -506,19 +506,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);
 	}
 }

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)?
 				 */

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 +9 added lines, -9 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;
 	}
@@ -689,7 +689,7 @@ 
 			//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) {
-				    unset($this->_valid_shortcodes[$context][$key]);
+					unset($this->_valid_shortcodes[$context][$key]);
 				}
 			}
 		}
@@ -697,11 +697,11 @@ 
 		//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) {
-				    unset($this->_valid_shortcodes['admin'][$key]);
+					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) {
-				    unset($this->_valid_shortcodes['admin'][$key]);
+					unset($this->_valid_shortcodes['admin'][$key]);
 				}
 		}
 	}

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,10 +280,10 @@ 
 
 		//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' );
+		EE_Registry::instance()->load_helper('Parse_Shortcodes');
 		//get shortcode_replace instance- set when _get_messages is called in child...
 		$this->_shortcode_replace = new EEH_Parse_Shortcodes();
 
@@ -294,9 +294,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;
 			}
@@ -305,7 +305,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();
@@ -341,7 +341,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);
 
 
 
@@ -373,7 +373,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;
 	}
 
@@ -406,28 +406,28 @@ 
 	 *
 	 * @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)));
 		}
 
 		EE_Registry::instance()->load_helper('MSG_Template');
-		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));
 	}
 
 
@@ -448,19 +448,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;
@@ -495,7 +495,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);
 	}
 
 
@@ -513,9 +513,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);
 	}
 
 
@@ -559,8 +559,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);
 	}
 
 
@@ -579,31 +579,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();
@@ -619,15 +619,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
 	}
@@ -662,8 +662,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'];
 		}
@@ -681,26 +681,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]);
 				}
 		}
@@ -713,8 +713,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;
 		}
 	}
@@ -734,7 +734,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;
@@ -746,14 +746,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;
@@ -773,7 +773,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;
 	}
 
@@ -792,34 +792,34 @@ 
 		//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 ) )
+			if (in_array($details['attendee_email'], $already_processed))
 				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;
 				}
 
@@ -834,8 +834,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;
@@ -860,46 +860,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;
@@ -915,8 +915,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');
 			}
 		}
@@ -931,11 +931,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;
@@ -959,22 +959,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;

Braces +24 added lines, -12 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 ) ) {
@@ -806,8 +816,9 @@ 
 				}
 			}
 
-			if ( in_array( $details['attendee_email'], $already_processed ) )
-				continue;
+			if ( in_array( $details['attendee_email'], $already_processed ) ) {
+							continue;
+			}
 
 			$already_processed[] = $details['attendee_email'];
 
@@ -959,8 +970,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