eventespresso / event-espresso-core

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 +120 added lines, -120 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,41 +270,41 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _item_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _item_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
 		$row_class = $options['odd'] ? 'item odd' : 'item';
-		$html = EEH_HTML::tr( '', '', $row_class );
-		$obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type() . ': ' : '';
+		$html = EEH_HTML::tr('', '', $row_class);
+		$obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type().': ' : '';
 		// name && desc
 		$name_and_desc = apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-			 $obj_name . $line_item->name(),
+			 $obj_name.$line_item->name(),
 			$line_item
 		);
 		$name_and_desc .= apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-			( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
+			($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : ''),
 			$line_item,
 			$options
 		);
 		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
 		// name td
-		$html .= EEH_HTML::td( $name_and_desc, '',  'item_l' );
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l');
 		// price td
-		if ( $line_item->is_percent() ) {
-			$html .= EEH_HTML::td( $line_item->percent() . '%', '', 'item_c jst-rght' );
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c jst-rght');
 		} else {
-			$html .= EEH_HTML::td( $line_item->unit_price_no_code(), '', 'item_c jst-rght' );
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
 		}
 		// quantity td
-		$html .= EEH_HTML::td( $line_item->quantity(), '', 'item_l jst-rght' );
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
 		//$total = $line_item->total() * $line_item->quantity();
 		$total = $line_item->total();
-		if( isset( $options[ 'event_id' ] ) && isset( $this->_events[ $options[ 'event_id' ] ] ) ) {
-			$this->_events[ $options[ 'event_id' ] ] += $total;
+		if (isset($options['event_id']) && isset($this->_events[$options['event_id']])) {
+			$this->_events[$options['event_id']] += $total;
 		}
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $total, false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($total, false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -319,22 +319,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;
@@ -349,21 +349,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;
@@ -378,17 +378,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();
 		}
@@ -405,15 +405,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();
 		}
@@ -430,13 +430,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;
@@ -451,30 +451,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()
 							);
@@ -482,12 +482,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'
 						);
@@ -495,17 +495,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)?
 				 */

Indentation +5 added lines, -5 removed lines

@@ -1,10 +1,10 @@
 <?php
 /**
- * This file contains the EE_Messages_Template_ Pack abstract class.
- * @package      Event Espresso
- * @subpackage messages
- * @since           4.5.0
- */
+	 * This file contains the EE_Messages_Template_ Pack abstract class.
+	 * @package      Event Espresso
+	 * @subpackage messages
+	 * @since           4.5.0
+	 */
 if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
 
 /**

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

Doc Comments +1 added lines, -1 removed lines

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

Spacing +26 added lines, -26 removed lines

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

Braces +2 added lines, -1 removed lines

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

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

Doc Comments +1 added lines, -1 removed lines

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

Spacing +96 added lines, -96 removed lines

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

Braces +43 added lines, -26 removed lines

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

core/libraries/payment_methods/EE_Gateway.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -208,7 +208,7 @@
 
 	/**
 	 * @param $message
-	 * @param $payment
+	 * @param EEI_Payment $payment
 	 */
 	public function log($message,$payment){
 		if($payment instanceof EEI_Payment){

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 );
 		}
 	}

Spacing +31 added lines, -31 removed lines

@@ -30,7 +30,7 @@ 
  * needed helpers and models (see all the methods starting with "set_", eg seg_line_item_helper which should be passed an object
  * which implements EEHI_Line_Item_Helper; etc).
  */
-abstract class EE_Gateway{
+abstract class EE_Gateway {
 	/**
 	 * a constant used as a possible value for $_currencies_supported to indicate
 	 * that ALL currencies are supported by this gateway
@@ -108,7 +108,7 @@ 
 	/**
 	 * @return EE_Gateway
 	 */
-	public function __construct(){
+	public function __construct() {
 	}
 
 	/**
@@ -120,10 +120,10 @@ 
 	 * beginning again)
 	 * @return array
 	 */
-	public function __sleep(){
+	public function __sleep() {
 		$properties = get_object_vars($this);
-		unset( $properties[ '_pay_model' ] );
-		unset( $properties[ '_pay_log' ] );
+		unset($properties['_pay_model']);
+		unset($properties['_pay_log']);
 		return array_keys($properties);
 	}
 	/**
@@ -131,7 +131,7 @@ 
 	 * see $_supports_sending_refunds
 	 * @return boolean
 	 */
-	public function supports_sending_refunds(){
+	public function supports_sending_refunds() {
 		return $this->_supports_sending_refunds;
 	}
 	/**
@@ -139,7 +139,7 @@ 
 	 * see $_supports_receiving_refunds
 	 * @return boolean
 	 */
-	public function supports_receiving_refunds(){
+	public function supports_receiving_refunds() {
 		return $this->_supports_receiving_refunds;
 	}
 
@@ -154,7 +154,7 @@ 
 	 * @return EE_Payment for the refund
 	 * @throws EE_Error
 	 */
-	public function do_direct_refund( EE_Payment $payment, $refund_info = null ) {
+	public function do_direct_refund(EE_Payment $payment, $refund_info = null) {
 		return NULL;
 	}
 
@@ -165,8 +165,8 @@ 
 	 * etc
 	 * @param array $settings_array
 	 */
-	public function set_settings($settings_array){
-		foreach($settings_array as $name => $value){
+	public function set_settings($settings_array) {
+		foreach ($settings_array as $name => $value) {
 			$property_name = "_".$name;
 			$this->$property_name = $value;
 		}
@@ -175,14 +175,14 @@ 
 	 * See this class description
 	 * @param EEMI_Payment $payment_model
 	 */
-	public function set_payment_model($payment_model){
+	public function set_payment_model($payment_model) {
 		$this->_pay_model = $payment_model;
 	}
 	/**
 	 * See this class description
 	 * @param EEMI_Payment_Log $payment_log_model
 	 */
-	public function set_payment_log($payment_log_model){
+	public function set_payment_log($payment_log_model) {
 		$this->_pay_log = $payment_log_model;
 	}
 
@@ -190,7 +190,7 @@ 
 	 * See this class description
 	 * @param EEHI_Template $template_helper
 	 */
-	public function set_template_helper($template_helper){
+	public function set_template_helper($template_helper) {
 		$this->_template = $template_helper;
 	}
 
@@ -198,7 +198,7 @@ 
 	 * See this class description
 	 * @param EEHI_Line_Item $line_item_helper
 	 */
-	public function set_line_item_helper( $line_item_helper ){
+	public function set_line_item_helper($line_item_helper) {
 		$this->_line_item = $line_item_helper;
 	}
 
@@ -206,7 +206,7 @@ 
 	 * See this class description
 	 * @param EEHI_Money $money_helper
 	 */
-	public function set_money_helper( $money_helper ){
+	public function set_money_helper($money_helper) {
 		$this->_money = $money_helper;
 	}
 
@@ -215,23 +215,23 @@ 
 	 * @param $message
 	 * @param $payment
 	 */
-	public function log($message,$payment){
-		if($payment instanceof EEI_Payment){
-			$type='Payment';
+	public function log($message, $payment) {
+		if ($payment instanceof EEI_Payment) {
+			$type = 'Payment';
 			$id = $payment->ID();
-		}else{
+		} else {
 			$type = 'Payment_Method';
 			$id = $this->_ID;
 		}
-		$this->_pay_log->gateway_log($message,$id,$type);
+		$this->_pay_log->gateway_log($message, $id, $type);
 	}
 	/**
 	 * Formats the amount so it can generally be sent to gateways
 	 * @param float $amount
 	 * @return string
 	 */
-	public function format_currency($amount){
-		return number_format( $amount, 2, '.', '' );
+	public function format_currency($amount) {
+		return number_format($amount, 2, '.', '');
 //		return $this->_template->format_currency($amount, true);
 	}
 
@@ -240,7 +240,7 @@ 
 	 * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
 	 * @return mixed array or string
 	 */
-	public function currencies_supported(){
+	public function currencies_supported() {
 		return $this->_currencies_supported;
 	}
 
@@ -252,14 +252,14 @@ 
 	 * @param EE_Transaction  $transaction
 	 * @return float
 	 */
-	protected function _sum_items_and_taxes( EE_Transaction  $transaction){
+	protected function _sum_items_and_taxes(EE_Transaction  $transaction) {
 		$total_line_item = $transaction->total_line_item();
 		$total = 0;
-		foreach($total_line_item->get_items() as $item_line_item ){
-			$total += max( $item_line_item->total(), 0 );
+		foreach ($total_line_item->get_items() as $item_line_item) {
+			$total += max($item_line_item->total(), 0);
 		}
-		foreach($total_line_item->tax_descendants() as $tax_line_item ){
-			$total += max( $tax_line_item->total(), 0 );
+		foreach ($total_line_item->tax_descendants() as $tax_line_item) {
+			$total += max($tax_line_item->total(), 0);
 		}
 		return $total;
 	}
@@ -270,9 +270,9 @@ 
 	 * @param EEI_Payment $payment
 	 * @return boolean
 	 */
-	protected function _can_easily_itemize_transaction_for( EEI_Payment $payment ){
+	protected function _can_easily_itemize_transaction_for(EEI_Payment $payment) {
 		return  $this->_money->compare_floats(
-					$this->_sum_items_and_taxes( $payment->transaction() ),
+					$this->_sum_items_and_taxes($payment->transaction()),
 					$payment->transaction()->total() ) &&
 				$this->_money->compare_floats(
 					$payment->amount(),
@@ -290,7 +290,7 @@ 
 	 * @param EE_Payment $payment
 	 * @return void
 	 */
-	public function update_txn_based_on_payment( $payment ){
+	public function update_txn_based_on_payment($payment) {
 		//maybe update the transaction or line items or registrations
 		//but most gateways don't need to do this, because they only update the payment
 	}

core/libraries/payment_methods/EE_PMT_Base.lib.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +11 added lines, -11 removed lines

@@ -3,17 +3,17 @@
 EE_Registry::instance()->load_lib('Onsite_Gateway');
 EE_Registry::instance()->load_lib('Offsite_Gateway');
 /**
- *
- * Class EE_PMT_Base
- *
- * Description
- *
- * @package 			Event Espresso
- * @subpackage 	core
- * @author 				Mike Nelson
- * @since 				$VID:$
- *
- */
+	 *
+	 * Class EE_PMT_Base
+	 *
+	 * Description
+	 *
+	 * @package 			Event Espresso
+	 * @subpackage 	core
+	 * @author 				Mike Nelson
+	 * @since 				$VID:$
+	 *
+	 */
 abstract class EE_PMT_Base{
 
 	const onsite = 'on-site';

Spacing +108 added lines, -108 removed lines

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

Braces +5 added lines, -5 removed lines

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

core/libraries/plugin_api/EE_Register_Addon.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -378,7 +378,7 @@
 	/**
 	 * Loads and instantiates the EE_Addon class and adds it onto the registry
 	 * @param string $addon_name
-	 * @return EE_Addon
+	 * @return boolean
 	 */
 	private static function _load_and_init_addon_class($addon_name){
 		$addon = EE_Registry::instance()->load_addon( dirname( self::$_settings[ $addon_name ]['main_file_path'] ), self::$_settings[ $addon_name ]['class_name'] );

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 );
 		}
 	}

Spacing +170 added lines, -170 removed lines

@@ -66,23 +66,23 @@ 
 	 * @param string $min_core_version
 	 * @return string always like '4.3.0.rc.000'
 	 */
-	protected static function _effective_version( $min_core_version ) {
+	protected static function _effective_version($min_core_version) {
 		// versions: 4 . 3 . 1 . p . 123
 		// offsets:    0 . 1 . 2 . 3 . 4
-		$version_parts = explode( '.', $min_core_version );
+		$version_parts = explode('.', $min_core_version);
 		//check they specified the micro version (after 2nd period)
-		if( ! isset( $version_parts[ 2 ] ) ) {
-			$version_parts[ 2] = '0';
+		if ( ! isset($version_parts[2])) {
+			$version_parts[2] = '0';
 		}
 		//if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
 		//soon we can assume that's 'rc', but this current version is 'alpha'
-		if( ! isset( $version_parts[ 3 ] ) ) {
-			$version_parts[ 3 ] = 'dev';
+		if ( ! isset($version_parts[3])) {
+			$version_parts[3] = 'dev';
 		}
-		if( ! isset( $version_parts[ 4 ] ) ) {
-			$version_parts[ 4 ] = '000';
+		if ( ! isset($version_parts[4])) {
+			$version_parts[4] = '000';
 		}
-		return implode( '.', $version_parts );
+		return implode('.', $version_parts);
 
 	}
 
@@ -92,8 +92,8 @@ 
 	 * @param string $actual_core_version the actual core version, optional
 	 * @return boolean
 	 */
-	public static  function _meets_min_core_version_requirement( $min_core_version, $actual_core_version = EVENT_ESPRESSO_VERSION ) {
-		return version_compare( self::_effective_version( $actual_core_version ), self::_effective_version( $min_core_version ), '>=' );
+	public static  function _meets_min_core_version_requirement($min_core_version, $actual_core_version = EVENT_ESPRESSO_VERSION) {
+		return version_compare(self::_effective_version($actual_core_version), self::_effective_version($min_core_version), '>=');
 	}
 
 
@@ -155,235 +155,235 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	public static function register( $addon_name = '', $setup_args = array()  ) {
+	public static function register($addon_name = '', $setup_args = array()) {
 		// required fields MUST be present, so let's make sure they are.
-		if ( empty( $addon_name ) || ! is_array( $setup_args )) {
-			throw new EE_Error( __( 'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.', 'event_espresso' ));
+		if (empty($addon_name) || ! is_array($setup_args)) {
+			throw new EE_Error(__('In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.', 'event_espresso'));
 		}
-		if ( ! isset($setup_args[ 'main_file_path' ]) || empty( $setup_args[ 'main_file_path' ] ) ){
-			throw new EE_Error( sprintf( __( 'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s', 'event_espresso' ), implode(",", array_keys( $setup_args ) ) ) );
+		if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+			throw new EE_Error(sprintf(__('When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s', 'event_espresso'), implode(",", array_keys($setup_args))));
 		}
 		// check that addon has not already been registered with that name
-		if ( isset( self::$_settings[ $addon_name ] ) && ! did_action( 'activate_plugin' ) ) {
-			throw new EE_Error( sprintf( __( 'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.', 'event_espresso' ), $addon_name ));
+		if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(sprintf(__('An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.', 'event_espresso'), $addon_name));
 		}
 
 
 		// no class name for addon?
-		if ( empty( $setup_args['class_name'] )) {
+		if (empty($setup_args['class_name'])) {
 			// generate one by first separating name with spaces
-			$class_name = str_replace( array( '-', '_' ), ' ', trim( $addon_name ));
+			$class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
 			//capitalize, then replace spaces with underscores
-			$class_name = str_replace( ' ', '_', ucwords( $class_name ));
+			$class_name = str_replace(' ', '_', ucwords($class_name));
 		} else {
 			$class_name = $setup_args['class_name'];
 		}
-		$class_name = strpos( $class_name, 'EE_' ) === 0 ? $class_name : 'EE_' . $class_name;
+		$class_name = strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_'.$class_name;
 		//setup $_settings array from incoming values.
 		$addon_settings = array(
 			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
 			'class_name' 						=> $class_name,
 			// the addon slug for use in URLs, etc
-			'plugin_slug' 						=> isset( $setup_args['plugin_slug'] ) ? (string)$setup_args['plugin_slug'] : '',
+			'plugin_slug' 						=> isset($setup_args['plugin_slug']) ? (string) $setup_args['plugin_slug'] : '',
 			// page slug to be used when generating the "Settings" link on the WP plugin page
-			'plugin_action_slug' 			=> isset( $setup_args[ 'plugin_action_slug' ] ) ? (string)$setup_args[ 'plugin_action_slug' ] : '',
+			'plugin_action_slug' 			=> isset($setup_args['plugin_action_slug']) ? (string) $setup_args['plugin_action_slug'] : '',
 			// the "software" version for the addon
-			'version' 								=> isset( $setup_args['version'] ) ? (string)$setup_args['version'] : '',
+			'version' 								=> isset($setup_args['version']) ? (string) $setup_args['version'] : '',
 			// the minimum version of EE Core that the addon will work with
-			'min_core_version' 			=> isset( $setup_args['min_core_version'] ) ? (string)$setup_args['min_core_version'] : '',
+			'min_core_version' 			=> isset($setup_args['min_core_version']) ? (string) $setup_args['min_core_version'] : '',
 			// full server path to main file (file loaded directly by WP)
-			'main_file_path' 					=> isset( $setup_args['main_file_path'] ) ? (string)$setup_args['main_file_path'] : '',
+			'main_file_path' 					=> isset($setup_args['main_file_path']) ? (string) $setup_args['main_file_path'] : '',
 			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-			'admin_path' 						=> isset( $setup_args['admin_path'] ) ? (string)$setup_args['admin_path'] : '',
+			'admin_path' 						=> isset($setup_args['admin_path']) ? (string) $setup_args['admin_path'] : '',
 			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-			'admin_callback' 				=> isset( $setup_args['admin_callback'] ) ? (string)$setup_args['admin_callback'] : '',
+			'admin_callback' 				=> isset($setup_args['admin_callback']) ? (string) $setup_args['admin_callback'] : '',
 			// the section name for this addon's configuration settings section (defaults to "addons")
-			'config_section' 					=> isset( $setup_args['config_section'] ) ? (string)$setup_args['config_section'] : 'addons',
+			'config_section' 					=> isset($setup_args['config_section']) ? (string) $setup_args['config_section'] : 'addons',
 			// the class name for this addon's configuration settings object
-			'config_class' 						=> isset( $setup_args['config_class'] ) ? (string)$setup_args['config_class'] : '',
+			'config_class' 						=> isset($setup_args['config_class']) ? (string) $setup_args['config_class'] : '',
 			//the name given to the config for this addons' configuration settings object (optional)
-			'config_name' 					=> isset( $setup_args['config_name'] ) ? (string) $setup_args['config_name']: '',
+			'config_name' 					=> isset($setup_args['config_name']) ? (string) $setup_args['config_name'] : '',
 			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-			'autoloader_paths' 			=> isset( $setup_args['autoloader_paths'] ) ? (array)$setup_args['autoloader_paths'] : array(),
+			'autoloader_paths' 			=> isset($setup_args['autoloader_paths']) ? (array) $setup_args['autoloader_paths'] : array(),
 			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-			'autoloader_folders' 			=> isset( $setup_args['autoloader_folders'] ) ? (array)$setup_args['autoloader_folders'] : array(),
+			'autoloader_folders' 			=> isset($setup_args['autoloader_folders']) ? (array) $setup_args['autoloader_folders'] : array(),
 			// array of full server paths to any EE_DMS data migration scripts used by the addon
-			'dms_paths' 						=> isset( $setup_args['dms_paths'] ) ? (array)$setup_args['dms_paths'] : array(),
+			'dms_paths' 						=> isset($setup_args['dms_paths']) ? (array) $setup_args['dms_paths'] : array(),
 			// array of full server paths to any EED_Modules used by the addon
-			'module_paths' 					=> isset( $setup_args['module_paths'] ) ? (array)$setup_args['module_paths'] : array(),
+			'module_paths' 					=> isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : array(),
 			// array of full server paths to any EES_Shortcodes used by the addon
-			'shortcode_paths'			 	=> isset( $setup_args['shortcode_paths'] ) ? (array)$setup_args['shortcode_paths'] : array(),
+			'shortcode_paths'			 	=> isset($setup_args['shortcode_paths']) ? (array) $setup_args['shortcode_paths'] : array(),
 			// array of full server paths to any WP_Widgets used by the addon
-			'widget_paths' 					=> isset( $setup_args['widget_paths'] ) ? (array)$setup_args['widget_paths'] : array(),
+			'widget_paths' 					=> isset($setup_args['widget_paths']) ? (array) $setup_args['widget_paths'] : array(),
 			// array of PUE options used by the addon
-			'pue_options' 						=> isset( $setup_args['pue_options'] ) ? (array)$setup_args['pue_options'] : array(),
-			'message_types' 				=> isset( $setup_args['message_types'] ) ? (array) $setup_args['message_types'] : array(),
-			'capabilities' 						=> isset( $setup_args['capabilities'] ) ? (array) $setup_args['capabilities'] : array(),
-			'capability_maps' 				=> isset( $setup_args['capability_maps'] ) ? (array) $setup_args['capability_maps'] : array(),
-			'model_paths' 					=> isset( $setup_args['model_paths'] ) ? (array) $setup_args['model_paths'] : array(),
-			'class_paths' 						=> isset( $setup_args['class_paths'] ) ? (array) $setup_args['class_paths'] : array(),
-			'model_extension_paths' 	=> isset( $setup_args['model_extension_paths'] ) ? (array) $setup_args['model_extension_paths'] : array(),
-			'class_extension_paths' 		=> isset( $setup_args['class_extension_paths'] ) ? (array) $setup_args['class_extension_paths'] : array(),
-			'custom_post_types' 			=> isset( $setup_args['custom_post_types'] ) ? (array) $setup_args['custom_post_types'] : array(),
-			'custom_taxonomies' 		=> isset( $setup_args['custom_taxonomies'] ) ? (array) $setup_args['custom_taxonomies'] : array(),
-			'payment_method_paths'	=> isset( $setup_args[ 'payment_method_paths' ] ) ? (array) $setup_args[ 'payment_method_paths' ] : array(),
-			'default_terms' 					=> isset( $setup_args['default_terms'] ) ? (array) $setup_args['default_terms'] : array(),
+			'pue_options' 						=> isset($setup_args['pue_options']) ? (array) $setup_args['pue_options'] : array(),
+			'message_types' 				=> isset($setup_args['message_types']) ? (array) $setup_args['message_types'] : array(),
+			'capabilities' 						=> isset($setup_args['capabilities']) ? (array) $setup_args['capabilities'] : array(),
+			'capability_maps' 				=> isset($setup_args['capability_maps']) ? (array) $setup_args['capability_maps'] : array(),
+			'model_paths' 					=> isset($setup_args['model_paths']) ? (array) $setup_args['model_paths'] : array(),
+			'class_paths' 						=> isset($setup_args['class_paths']) ? (array) $setup_args['class_paths'] : array(),
+			'model_extension_paths' 	=> isset($setup_args['model_extension_paths']) ? (array) $setup_args['model_extension_paths'] : array(),
+			'class_extension_paths' 		=> isset($setup_args['class_extension_paths']) ? (array) $setup_args['class_extension_paths'] : array(),
+			'custom_post_types' 			=> isset($setup_args['custom_post_types']) ? (array) $setup_args['custom_post_types'] : array(),
+			'custom_taxonomies' 		=> isset($setup_args['custom_taxonomies']) ? (array) $setup_args['custom_taxonomies'] : array(),
+			'payment_method_paths'	=> isset($setup_args['payment_method_paths']) ? (array) $setup_args['payment_method_paths'] : array(),
+			'default_terms' 					=> isset($setup_args['default_terms']) ? (array) $setup_args['default_terms'] : array(),
 			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page that can be used for adding upgrading/marketing info
-			'plugins_page_row' 			=> isset( $setup_args['plugins_page_row'] ) ? $setup_args['plugins_page_row'] : '',
+			'plugins_page_row' 			=> isset($setup_args['plugins_page_row']) ? $setup_args['plugins_page_row'] : '',
 		);
 
 		// if plugin_action_slug is NOT set, but an admin page path IS set, then let's just use the plugin_slug since that will be used for linking to the admin page
-		$addon_settings[ 'plugin_action_slug' ] = empty( $addon_settings[ 'plugin_action_slug' ] ) && ! empty( $addon_settings[ 'admin_path' ] ) ? $addon_settings[ 'plugin_slug' ] : $addon_settings[ 'plugin_action_slug' ];
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug']) && ! empty($addon_settings['admin_path']) ? $addon_settings['plugin_slug'] : $addon_settings['plugin_action_slug'];
 		// full server path to main file (file loaded directly by WP)
-		$addon_settings['plugin_basename'] = plugin_basename( $addon_settings[ 'main_file_path' ] );
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
 
 		//check whether this addon version is compatible with EE core
-		if ( isset( EE_Register_Addon::$_incompatible_addons[ $addon_name ] ) &&
-				! self::_meets_min_core_version_requirement( EE_Register_Addon::$_incompatible_addons[ $addon_name ], $addon_settings[ 'version' ] ) ) {
+		if (isset(EE_Register_Addon::$_incompatible_addons[$addon_name]) &&
+				! self::_meets_min_core_version_requirement(EE_Register_Addon::$_incompatible_addons[$addon_name], $addon_settings['version'])) {
 			$incompatibility_message = sprintf(
-				__( 'The Event Espresso "%1$s" addon was deactivated because it is incompatible with this version of core.%2$s Only version %3$s or higher of "%1$s" can run with this version of core. This can happen when attempting to run beta versions or release candidates with older versions of core, or running old versions of addons with a newer version of core.%2$sPlease upgrade Event Espresso Core and the "%1$s" addon, then re-attempt activating it.', 'event_espresso' ),
+				__('The Event Espresso "%1$s" addon was deactivated because it is incompatible with this version of core.%2$s Only version %3$s or higher of "%1$s" can run with this version of core. This can happen when attempting to run beta versions or release candidates with older versions of core, or running old versions of addons with a newer version of core.%2$sPlease upgrade Event Espresso Core and the "%1$s" addon, then re-attempt activating it.', 'event_espresso'),
 				$addon_name,
 				'<br />',
-				EE_Register_Addon::$_incompatible_addons[ $addon_name ]
+				EE_Register_Addon::$_incompatible_addons[$addon_name]
 			);
-		} else if ( ! self::_meets_min_core_version_requirement( $setup_args[ 'min_core_version' ], espresso_version() ) ) {
+		} else if ( ! self::_meets_min_core_version_requirement($setup_args['min_core_version'], espresso_version())) {
 			$incompatibility_message = sprintf(
-				__( 'The Event Espresso "%1$s" addon could not be activated because it requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-attempt activating "%1$s".', 'event_espresso' ),
+				__('The Event Espresso "%1$s" addon could not be activated because it requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-attempt activating "%1$s".', 'event_espresso'),
 				$addon_name,
-				self::_effective_version( $setup_args[ 'min_core_version' ] ),
-				self::_effective_version( espresso_version() ),
+				self::_effective_version($setup_args['min_core_version']),
+				self::_effective_version(espresso_version()),
 				'<br />'
 			);
 		} else {
 			$incompatibility_message = '';
 		}
-		if ( ! empty( $incompatibility_message ) ) {
+		if ( ! empty($incompatibility_message)) {
 			//remove 'activate' from the REQUEST so WP doesn't erroneously tell the user the
 			//plugin activated fine when it didn't
-			if( isset( $_GET[ 'activate' ]) ) {
-				unset( $_GET[ 'activate' ] );
+			if (isset($_GET['activate'])) {
+				unset($_GET['activate']);
 			}
-			if( isset( $_REQUEST[ 'activate' ] ) ){
-				unset( $_REQUEST[ 'activate' ] );
+			if (isset($_REQUEST['activate'])) {
+				unset($_REQUEST['activate']);
 			}
 			//and show an error message indicating the plugin didn't activate properly
-			EE_Error::add_error( $incompatibility_message, __FILE__, __FUNCTION__, __LINE__ );
-			if ( current_user_can( 'activate_plugins' )) {
-				require_once( ABSPATH.'wp-admin/includes/plugin.php' );
-				deactivate_plugins( plugin_basename( $addon_settings[ 'main_file_path' ] ), TRUE );
+			EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			if (current_user_can('activate_plugins')) {
+				require_once(ABSPATH.'wp-admin/includes/plugin.php');
+				deactivate_plugins(plugin_basename($addon_settings['main_file_path']), TRUE);
 			}
 			return;
 		}
 		//this is an activation request
-		if( did_action( 'activate_plugin' ) ){
+		if (did_action('activate_plugin')) {
 			//to find if THIS is the addon that was activated,
 			//just check if we have already registered it or not
 			//(as the newly-activated addon wasn't around the first time addons were registered)
-			if( ! isset( self::$_settings[ $addon_name ] ) ){
-				self::$_settings[ $addon_name ] = $addon_settings;
+			if ( ! isset(self::$_settings[$addon_name])) {
+				self::$_settings[$addon_name] = $addon_settings;
 				$addon = self::_load_and_init_addon_class($addon_name);
 				$addon->set_activation_indicator_option();
 				//dont bother setting up the rest of the addon.
 				//we know it was just activated and the request will end soon
 			}
 			return;
-		}else{
+		} else {
 			// make sure this was called in the right place!
-			if ( ! did_action( 'AHEE__EE_System__load_espresso_addons' ) || did_action( 'AHEE__EE_System___detect_if_activation_or_upgrade__begin' )) {
+			if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
 				EE_Error::doing_it_wrong(
 					__METHOD__,
 					sprintf(
-						__( 'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.','event_espresso'),
+						__('An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.', 'event_espresso'),
 						$addon_name
 					),
 					'4.3.0'
 				);
 			}
-			self::$_settings[ $addon_name ] = $addon_settings;
+			self::$_settings[$addon_name] = $addon_settings;
 		}
 		// we need cars
-		if ( ! empty( self::$_settings[ $addon_name ]['autoloader_paths'] )) {
+		if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
 			// setup autoloader for single file
-			EEH_Autoloader::instance()->register_autoloader( self::$_settings[ $addon_name ]['autoloader_paths'] );
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
 		}
 		// setup autoloaders for folders
-		if ( ! empty( self::$_settings[ $addon_name ]['autoloader_folders'] )) {
-			foreach ( self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder ) {
-				EEH_Autoloader::register_autoloaders_for_each_file_in_folder( $autoloader_folder );
+		if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+			foreach (self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
 			}
 		}
 		// register new models
-		if ( ! empty( self::$_settings[ $addon_name ]['model_paths'] ) || ! empty( self::$_settings[ $addon_name ]['class_paths'] )) {
-			EE_Register_Model::register( $addon_name, array( 'model_paths' => self::$_settings[ $addon_name ]['model_paths'] , 'class_paths' => self::$_settings[ $addon_name ]['class_paths']));
+		if ( ! empty(self::$_settings[$addon_name]['model_paths']) || ! empty(self::$_settings[$addon_name]['class_paths'])) {
+			EE_Register_Model::register($addon_name, array('model_paths' => self::$_settings[$addon_name]['model_paths'], 'class_paths' => self::$_settings[$addon_name]['class_paths']));
 		}
 		// register model extensions
-		if ( ! empty( self::$_settings[ $addon_name ]['model_extension_paths'] ) || ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] )) {
-			EE_Register_Model_Extensions::register( $addon_name, array( 'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'] , 'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths']));
+		if ( ! empty(self::$_settings[$addon_name]['model_extension_paths']) || ! empty(self::$_settings[$addon_name]['class_extension_paths'])) {
+			EE_Register_Model_Extensions::register($addon_name, array('model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'], 'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths']));
 		}
 		// setup DMS
-		if ( ! empty( self::$_settings[ $addon_name ]['dms_paths'] )) {
-			EE_Register_Data_Migration_Scripts::register( $addon_name, array( 'dms_paths' => self::$_settings[ $addon_name ]['dms_paths'] ));
+		if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register($addon_name, array('dms_paths' => self::$_settings[$addon_name]['dms_paths']));
 		}
 		// if config_class is present let's register config.
-		if ( ! empty( self::$_settings[ $addon_name ]['config_class'] )) {
+		if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
 			EE_Register_Config::register(
-				self::$_settings[ $addon_name ]['config_class'],
+				self::$_settings[$addon_name]['config_class'],
 				array(
-					'config_section' => self::$_settings[ $addon_name ]['config_section'],
-					'config_name' => self::$_settings[ $addon_name ]['config_name']
+					'config_section' => self::$_settings[$addon_name]['config_section'],
+					'config_name' => self::$_settings[$addon_name]['config_name']
 				)
 			);
 		}
 		// register admin page
-		if ( ! empty( self::$_settings[ $addon_name ]['admin_path'] )) {
-			EE_Register_Admin_Page::register( $addon_name, array( 'page_path' => self::$_settings[ $addon_name ]['admin_path'] ));
+		if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
+			EE_Register_Admin_Page::register($addon_name, array('page_path' => self::$_settings[$addon_name]['admin_path']));
 
 		}
 		// add to list of modules to be registered
-		if ( ! empty( self::$_settings[ $addon_name ]['module_paths'] )) {
-			EE_Register_Module::register( $addon_name, array( 'module_paths' => self::$_settings[ $addon_name ]['module_paths'] ));
+		if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
+			EE_Register_Module::register($addon_name, array('module_paths' => self::$_settings[$addon_name]['module_paths']));
 		}
 		// add to list of shortcodes to be registered
-		if ( ! empty( self::$_settings[ $addon_name ]['shortcode_paths'] )) {
-			EE_Register_Shortcode::register( $addon_name, array( 'shortcode_paths' => self::$_settings[ $addon_name ]['shortcode_paths'] ));
+		if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
+			EE_Register_Shortcode::register($addon_name, array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths']));
 		}
 		// add to list of widgets to be registered
-		if ( ! empty( self::$_settings[ $addon_name ]['widget_paths'] )) {
-			EE_Register_Widget::register( $addon_name, array( 'widget_paths' => self::$_settings[ $addon_name ]['widget_paths'] ));
+		if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
+			EE_Register_Widget::register($addon_name, array('widget_paths' => self::$_settings[$addon_name]['widget_paths']));
 		}
 
 		//register capability related stuff.
-		if ( ! empty( self::$_settings[ $addon_name ]['capabilities'] ) ) {
-			EE_Register_Capabilities::register( $addon_name , array( 'capabilities' => self::$_settings[$addon_name]['capabilities'], 'capability_maps' => self::$_settings[$addon_name]['capability_maps'] ) );
+		if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
+			EE_Register_Capabilities::register($addon_name, array('capabilities' => self::$_settings[$addon_name]['capabilities'], 'capability_maps' => self::$_settings[$addon_name]['capability_maps']));
 		}
 		//any message type to register?
-		if (  !empty( self::$_settings[$addon_name]['message_types'] ) ) {
-				add_action( 'EE_Brewing_Regular___messages_caf', array( 'EE_Register_Addon', 'register_message_types' ) );
+		if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+				add_action('EE_Brewing_Regular___messages_caf', array('EE_Register_Addon', 'register_message_types'));
 		}
 
 		// if plugin update engine is being used for auto-updates (not needed if PUE is not being used)
-		if ( ! empty( $setup_args['pue_options'] )) {
-			self::$_settings[ $addon_name ]['pue_options'] = array(
-				'pue_plugin_slug' 	=> isset( $setup_args['pue_options']['pue_plugin_slug'] ) ? (string)$setup_args['pue_options']['pue_plugin_slug'] : 'espresso_' . strtolower( $class_name ),
-				'plugin_basename' => isset( $setup_args['pue_options']['plugin_basename'] ) ? (string)$setup_args['pue_options']['plugin_basename'] : plugin_basename( self::$_settings[ $addon_name ]['main_file_path'] ),
-				'checkPeriod' 			=> isset( $setup_args['pue_options']['checkPeriod'] ) ? (string)$setup_args['pue_options']['checkPeriod'] : '24',
-				'use_wp_update'		=> isset( $setup_args['pue_options']['use_wp_update'] ) ? (string)$setup_args['pue_options']['use_wp_update'] : FALSE
+		if ( ! empty($setup_args['pue_options'])) {
+			self::$_settings[$addon_name]['pue_options'] = array(
+				'pue_plugin_slug' 	=> isset($setup_args['pue_options']['pue_plugin_slug']) ? (string) $setup_args['pue_options']['pue_plugin_slug'] : 'espresso_'.strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename']) ? (string) $setup_args['pue_options']['plugin_basename'] : plugin_basename(self::$_settings[$addon_name]['main_file_path']),
+				'checkPeriod' 			=> isset($setup_args['pue_options']['checkPeriod']) ? (string) $setup_args['pue_options']['checkPeriod'] : '24',
+				'use_wp_update'		=> isset($setup_args['pue_options']['use_wp_update']) ? (string) $setup_args['pue_options']['use_wp_update'] : FALSE
 			);
-			add_action( 'AHEE__EE_System__brew_espresso__after_pue_init', array( 'EE_Register_Addon', 'load_pue_update' ));
+			add_action('AHEE__EE_System__brew_espresso__after_pue_init', array('EE_Register_Addon', 'load_pue_update'));
 		}
 
 		//any custom post type/ custom capabilities or default terms to register
-		if ( !empty( self::$_settings[$addon_name]['custom_post_types'] ) || !empty( self::$_settings[$addon_name]['custom_taxonomies'] ) ) {
-			EE_Register_CPT::register( $addon_name, array( 'cpts' => self::$_settings[$addon_name]['custom_post_types'] , 'cts' => self::$_settings[$addon_name]['custom_taxonomies'], 'default_terms' => self::$_settings[$addon_name]['default_terms'] ) );
+		if ( ! empty(self::$_settings[$addon_name]['custom_post_types']) || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])) {
+			EE_Register_CPT::register($addon_name, array('cpts' => self::$_settings[$addon_name]['custom_post_types'], 'cts' => self::$_settings[$addon_name]['custom_taxonomies'], 'default_terms' => self::$_settings[$addon_name]['default_terms']));
 		}
-		if( ! empty( self::$_settings[ $addon_name ][ 'payment_method_paths' ] ) ){
-			EE_Register_Payment_Method::register($addon_name, array( 'payment_method_paths' => self::$_settings[ $addon_name ][ 'payment_method_paths' ] ) );
+		if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register($addon_name, array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths']));
 		}
 		// load and instantiate main addon class
 		$addon = self::_load_and_init_addon_class($addon_name);
 		// call any additional admin_callback functions during load_admin_controller hook
-		if ( ! empty( self::$_settings[ $addon_name ]['admin_callback'] )) {
-			add_action( 'AHEE__EE_System__load_controllers__load_admin_controllers', array( $addon, self::$_settings[ $addon_name ]['admin_callback'] ));
+		if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
+			add_action('AHEE__EE_System__load_controllers__load_admin_controllers', array($addon, self::$_settings[$addon_name]['admin_callback']));
 		}
 	}
 
@@ -394,22 +394,22 @@ 
 	 * @param string $addon_name
 	 * @return EE_Addon
 	 */
-	private static function _load_and_init_addon_class($addon_name){
-		$addon = EE_Registry::instance()->load_addon( dirname( self::$_settings[ $addon_name ]['main_file_path'] ), self::$_settings[ $addon_name ]['class_name'] );
-		$addon->set_name( $addon_name );
-		$addon->set_plugin_slug( self::$_settings[ $addon_name ][ 'plugin_slug' ] );
-		$addon->set_plugin_basename( self::$_settings[ $addon_name ][ 'plugin_basename' ] );
-		$addon->set_main_plugin_file( self::$_settings[ $addon_name ]['main_file_path'] );
-		$addon->set_plugin_action_slug( self::$_settings[ $addon_name ][ 'plugin_action_slug' ] );
-		$addon->set_plugins_page_row( self::$_settings[ $addon_name ][ 'plugins_page_row' ] );
-		$addon->set_version( self::$_settings[ $addon_name ]['version'] );
-		$addon->set_min_core_version( self::_effective_version( self::$_settings[ $addon_name ]['min_core_version'] ) );
-		$addon->set_config_section( self::$_settings[ $addon_name ]['config_section'] );
-		$addon->set_config_class( self::$_settings[ $addon_name ]['config_class'] );
-		$addon->set_config_name( self::$_settings[ $addon_name ]['config_name'] );
+	private static function _load_and_init_addon_class($addon_name) {
+		$addon = EE_Registry::instance()->load_addon(dirname(self::$_settings[$addon_name]['main_file_path']), self::$_settings[$addon_name]['class_name']);
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+		$addon->set_version(self::$_settings[$addon_name]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+		$addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+		$addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+		$addon->set_config_name(self::$_settings[$addon_name]['config_name']);
 		//unfortunately this can't be hooked in upon construction, because we don't have
 		//the plugin mainfile's path upon construction.
-		register_deactivation_hook($addon->get_main_plugin_file(), array($addon,'deactivation'));
+		register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
 		return $addon;
 	}
 
@@ -422,18 +422,18 @@ 
 	 */
 	public static function load_pue_update() {
 		// load PUE client
-		require_once  EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+		require_once  EE_THIRD_PARTY.'pue'.DS.'pue-client.php';
 		// cycle thru settings
-		foreach ( self::$_settings as $settings ) {
-			if ( ! empty( $settings['pue_options'] )) {
+		foreach (self::$_settings as $settings) {
+			if ( ! empty($settings['pue_options'])) {
 				// initiate the class and start the plugin update engine!
 				new PluginUpdateEngineChecker(
 				// host file URL
 					'http://eventespresso.com',
 					// plugin slug(s)
 					array(
-						'premium' => array( 'p' => $settings['pue_options']['pue_plugin_slug'] ),
-						'prerelease' => array( 'beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr' )
+						'premium' => array('p' => $settings['pue_options']['pue_plugin_slug']),
+						'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr')
 					),
 					// options
 					array(
@@ -461,9 +461,9 @@ 
 	 * @return void
 	 */
 	public static function register_message_types() {
-		foreach ( self::$_settings as $settings ) {
-			foreach( $settings['message_types'] as $message_type => $message_type_settings ) {
-				EE_Register_Message_Type::register( $message_type, $message_type_settings );
+		foreach (self::$_settings as $settings) {
+			foreach ($settings['message_types'] as $message_type => $message_type_settings) {
+				EE_Register_Message_Type::register($message_type, $message_type_settings);
 			}
 		}
 	}
@@ -479,60 +479,60 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	public static function deregister( $addon_name = NULL ) {
-		if ( isset( self::$_settings[ $addon_name ] )) {
-			$class_name = self::$_settings[ $addon_name ]['class_name'];
-			if ( ! empty( self::$_settings[ $addon_name ]['dms_paths'] )) {
+	public static function deregister($addon_name = NULL) {
+		if (isset(self::$_settings[$addon_name])) {
+			$class_name = self::$_settings[$addon_name]['class_name'];
+			if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
 				// setup DMS
-				EE_Register_Data_Migration_Scripts::deregister( $addon_name );
+				EE_Register_Data_Migration_Scripts::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['admin_path'] )) {
+			if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
 				// register admin page
-				EE_Register_Admin_Page::deregister( $addon_name );
+				EE_Register_Admin_Page::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['module_paths'] )) {
+			if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
 				// add to list of modules to be registered
-				EE_Register_Module::deregister( $addon_name );
+				EE_Register_Module::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['shortcode_paths'] )) {
+			if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
 				// add to list of shortcodes to be registered
-				EE_Register_Shortcode::deregister( $addon_name );
+				EE_Register_Shortcode::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['config_class'] )) {
+			if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
 				// if config_class present let's register config.
-				EE_Register_Config::deregister( self::$_settings[ $addon_name ]['config_class']);
+				EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['widget_paths'] )) {
+			if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
 				// add to list of widgets to be registered
-				EE_Register_Widget::deregister( $addon_name );
+				EE_Register_Widget::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['model_paths'] ) ||
-					! empty( self::$_settings[ $addon_name ]['class_paths'] )) {
+			if ( ! empty(self::$_settings[$addon_name]['model_paths']) ||
+					! empty(self::$_settings[$addon_name]['class_paths'])) {
 				// add to list of shortcodes to be registered
-				EE_Register_Model::deregister( $addon_name );
+				EE_Register_Model::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['model_extension_paths'] ) ||
-					! empty( self::$_settings[ $addon_name ]['class_extension_paths'] )) {
+			if ( ! empty(self::$_settings[$addon_name]['model_extension_paths']) ||
+					! empty(self::$_settings[$addon_name]['class_extension_paths'])) {
 				// add to list of shortcodes to be registered
-				EE_Register_Model_Extensions::deregister( $addon_name );
+				EE_Register_Model_Extensions::deregister($addon_name);
 				}
-			if (  !empty( self::$_settings[$addon_name]['message_types'] ) ) {
-				foreach( self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings ) {
-					EE_Register_Message_Type::deregister( $message_type );
+			if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+				foreach (self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::deregister($message_type);
 				}
 			}
 			//deregister capabilities for addon
-			if ( ! empty( self::$_settings[$addon_name]['capabilities'] ) || ! empty( self::$_settings[$addon_name]['capability_maps']) ) {
-				EE_Register_Capabilities::deregister( $addon_name );
+			if ( ! empty(self::$_settings[$addon_name]['capabilities']) || ! empty(self::$_settings[$addon_name]['capability_maps'])) {
+				EE_Register_Capabilities::deregister($addon_name);
 			}
 			//deregister custom_post_types for addon
-			if ( ! empty( self::$_settings[$addon_name]['custom_post_types'] ) ) {
-				EE_Register_CPT::deregister( $addon_name );
+			if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
+				EE_Register_CPT::deregister($addon_name);
 			}
-			remove_action('deactivate_'.EE_Registry::instance()->addons->$class_name->get_main_plugin_file_basename(),  array( EE_Registry::instance()->addons->$class_name, 'deactivation' ) );
-			remove_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( EE_Registry::instance()->addons->$class_name, 'initialize_db_if_no_migrations_required' ) );
+			remove_action('deactivate_'.EE_Registry::instance()->addons->$class_name->get_main_plugin_file_basename(), array(EE_Registry::instance()->addons->$class_name, 'deactivation'));
+			remove_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array(EE_Registry::instance()->addons->$class_name, 'initialize_db_if_no_migrations_required'));
 			unset(EE_Registry::instance()->addons->$class_name);
-			unset( self::$_settings[ $addon_name ] );
+			unset(self::$_settings[$addon_name]);
 		}
 	}
 

Indentation +4 added lines, -4 removed lines

@@ -138,10 +138,10 @@
 	 *       		 An array of message types with the key as the message type name and the values as below:
 	 *        		@type string $mtfilename The filename of the message type being registered.  This will be the main
 	 *                                       EE_{Messagetype_Name}_message_type class. (eg. EE_Declined_Registration_message_type.class.php). Required.
-	*               @type array $autoloadpaths An array of paths to add to the messages autoloader for the new message type. Required.
-	*               @type array $messengers_to_activate_with An array of messengers that this message
-	*                           type should activate with. Each value in the array should match the name property of a EE_messenger. Optional.
-	*               @type array $messengers_to_validate_with An array of messengers that this message
+	 *               @type array $autoloadpaths An array of paths to add to the messages autoloader for the new message type. Required.
+	 *               @type array $messengers_to_activate_with An array of messengers that this message
+	 *                           type should activate with. Each value in the array should match the name property of a EE_messenger. Optional.
+	 *               @type array $messengers_to_validate_with An array of messengers that this message
 	 *                          type should validate with. Each value in the array should match the name property of an EE_messenger. Optional.
 	 *       	}
 	 *			@type array $custom_post_types

core/libraries/qtips/EE_Qtip_Config.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -200,7 +200,7 @@
 	 * return the _qtips property contents
 	 *
 	 * @access public
-	 * @return EE_Qtip[]
+	 * @return EE_Qtip
 	 */
 	public function get_tips() {
 		return $this->_qtips;

Spacing +10 added lines, -10 removed lines

@@ -142,7 +142,7 @@ 
 				'event' => 'mouseleave', //similar as what you do for show.event.
 				'target' => false, //Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
 				'delay' => 0, //set time in milliseconds for delaying the hide of the tooltip
-				'inactive' => false,  //if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
+				'inactive' => false, //if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
 				'fixed' => false, //when set to true, the tooltip will not hide if moused over.
 				'leave' => 'window', //specify whether the tooltip will hide when leaving the window it's conained within.
 				'distance' => false, //if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
@@ -175,21 +175,21 @@ 
 	 * @return void
 	 */
 	protected function _construct_tips() {
-		foreach ( $this->_qtipsa as $qt ) {
+		foreach ($this->_qtipsa as $qt) {
 			//make sure we have what we need.
-			if ( !isset( $qt['content_id'] ) || !isset( $qt['target'] ) || !isset( $qt['content'] ) )
-				throw new EE_Error( sprintf( __('There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.', 'event_espresso'), get_class($this), var_export($qt, true) ) );
+			if ( ! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content']))
+				throw new EE_Error(sprintf(__('There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.', 'event_espresso'), get_class($this), var_export($qt, true)));
 
 			//make sure the options include defaults and just override via set config.
-			$options_override = isset( $qt['options'] ) ? (array) $qt['options'] : array();
-			$options = array_merge( $this->_default_options, $options_override );
+			$options_override = isset($qt['options']) ? (array) $qt['options'] : array();
+			$options = array_merge($this->_default_options, $options_override);
 			$setup = array(
 				'content_id' => $qt['content_id'],
 				'options' => $options,
 				'target' => $qt['target'],
 				'content' => $qt['content']
 				);
-			$this->_qtips[] = new EE_Qtip( $setup );
+			$this->_qtips[] = new EE_Qtip($setup);
 		}
 	}
 
@@ -264,9 +264,9 @@ 
 	public $target;
 	public $content;
 
-	public function __construct( $setup_array ) {
-		foreach ( $setup_array as $prop => $value ) {
-			if ( EEH_Class_Tools::has_property( $this, $prop ) )
+	public function __construct($setup_array) {
+		foreach ($setup_array as $prop => $value) {
+			if (EEH_Class_Tools::has_property($this, $prop))
 				$this->$prop = $value;
 		}
 	}

Braces +6 added lines, -4 removed lines

@@ -177,8 +177,9 @@ 
 	protected function _construct_tips() {
 		foreach ( $this->_qtipsa as $qt ) {
 			//make sure we have what we need.
-			if ( !isset( $qt['content_id'] ) || !isset( $qt['target'] ) || !isset( $qt['content'] ) )
-				throw new EE_Error( sprintf( __('There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.', 'event_espresso'), get_class($this), var_export($qt, true) ) );
+			if ( !isset( $qt['content_id'] ) || !isset( $qt['target'] ) || !isset( $qt['content'] ) ) {
+							throw new EE_Error( sprintf( __('There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.', 'event_espresso'), get_class($this), var_export($qt, true) ) );
+			}
 
 			//make sure the options include defaults and just override via set config.
 			$options_override = isset( $qt['options'] ) ? (array) $qt['options'] : array();
@@ -266,8 +267,9 @@ 
 
 	public function __construct( $setup_array ) {
 		foreach ( $setup_array as $prop => $value ) {
-			if ( EEH_Class_Tools::has_property( $this, $prop ) )
-				$this->$prop = $value;
+			if ( EEH_Class_Tools::has_property( $this, $prop ) ) {
+							$this->$prop = $value;
+			}
 		}
 	}
 }
\ No newline at end of file

core/libraries/shortcodes/EE_Event_Shortcodes.lib.php

Doc Comments +1 added lines

@@ -179,6 +179,7 @@
 	/**
 	 * returns the link to the event
 	 * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.  Otherwise we just return the url of the event.
+	 * @param EE_Event $event
 	 * @return string
 	 */
 	private function _get_event_link( $event, $full_link = TRUE ) {

Braces +11 added lines, -7 removed lines

@@ -1,7 +1,8 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -85,8 +86,9 @@ 
 
 
 		//If there is no event objecdt by now then get out.
-		if ( ! $this->_event instanceof EE_Event )
-			return '';
+		if ( ! $this->_event instanceof EE_Event ) {
+					return '';
+		}
 
 		switch ( $shortcode ) {
 
@@ -125,14 +127,16 @@ 
 
 			case '[VIRTUAL_URL]' :
 				$venue = $this->_event->get_first_related('Venue');
-				if ( empty( $venue ) )
-					return '';
+				if ( empty( $venue ) ) {
+									return '';
+				}
 				return $venue->get('VNU_virtual_url');
 
 			case '[VIRTUAL_PHONE]' :
 				$venue = $this->_event->get_first_related('Venue');
-				if ( empty( $venue ) )
-					return '';
+				if ( empty( $venue ) ) {
+									return '';
+				}
 				return $venue->get('VNU_virtual_phone');
 				break;
 

Spacing +32 added lines, -32 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -56,34 +56,34 @@ 
 			'[EVENT_NAME]' => __("This also can be used for the name of the event", 'event_espresso'),
 			'[EVENT_PHONE]' => __('The phone number for the event (usually an info number)', 'event_espresso'),
 			'[EVENT_DESCRIPTION]' => __('The description of the event', 'event_espresso'),
-			'[EVENT_EXCERPT]' => __( 'This gets parsed to the value for the excerpt field in the event or blank if there is no excerpt.', 'event_espresso' ),
+			'[EVENT_EXCERPT]' => __('This gets parsed to the value for the excerpt field in the event or blank if there is no excerpt.', 'event_espresso'),
 			'[EVENT_LINK]' => __('A link associated with the event', 'event_espresso'),
 			'[EVENT_URL]' => __('A link to the event set up on the host site.', 'event_espresso'),
 			'[VIRTUAL_URL]' => __('What was used for the "URL of Event" field in the Venue settings', 'event_espresso'),
 			'[VIRTUAL_PHONE]' => __('An alternate phone number for the event. Typically used as a "call-in" number', 'event_espresso'),
 			'[EVENT_IMAGE]' => __('This will parse to the Feature image for the event.', 'event_espresso'),
 			'[EVENT_TOTAL_AVAILABLE_SPACES_*]' => sprintf(
-				__( 'This will parse to the total available spaces for an event. Calculating total spaces is approximate because it is dependent on the complexity of limits on your event.  There are two methods of calculation (which can be indicated by the %1$smethod%2$s param on the shortcode).  %1$scurrent%2$s which will do a more accurate calculation of total available spaces based on current sales, and %1$sfull%2$s which will be the maximum total available spaces that is on the event in optimal conditions. The shortcode will default to current.', 'event_espresso' ),
+				__('This will parse to the total available spaces for an event. Calculating total spaces is approximate because it is dependent on the complexity of limits on your event.  There are two methods of calculation (which can be indicated by the %1$smethod%2$s param on the shortcode).  %1$scurrent%2$s which will do a more accurate calculation of total available spaces based on current sales, and %1$sfull%2$s which will be the maximum total available spaces that is on the event in optimal conditions. The shortcode will default to current.', 'event_espresso'),
 				'<code>',
 				'</code>'
 				),
-			'[EVENT_TOTAL_SPOTS_TAKEN]' => __( 'This shortcode will parse to the output the total approved registrations for this event', 'event_espresso' ),
+			'[EVENT_TOTAL_SPOTS_TAKEN]' => __('This shortcode will parse to the output the total approved registrations for this event', 'event_espresso'),
 			'[EVENT_FACEBOOK_URL]' => __('This will return the Facebook URL for the event if you have it set via custom field in your event, otherwise it will use the Facebook URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_facebook</code> and the value as your facebook url.', 'event_espresso'),
 			'[EVENT_TWITTER_URL]' => __('This will return the Twitter URL for the event if you have it set via custom field in your event, otherwise it will use the Twitter URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_twitter</code> and the value as your facebook url', 'event_espresso'),
 			'[EVENT_META_*]' => __('This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the event then it will be output in place of this shortcode.', 'event_espresso'),
-			'[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' => __( 'This parses to the url for the registration list table filtered by registrations for this event.', 'event_espresso' ),
+			'[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' => __('This parses to the url for the registration list table filtered by registrations for this event.', 'event_espresso'),
 			);
 	}
 
 
-	protected function _parser( $shortcode ) {
+	protected function _parser($shortcode) {
 
-		EE_Registry::instance()->load_helper( 'Formatter' );
+		EE_Registry::instance()->load_helper('Formatter');
 
 		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
 
 		//if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
-		if ( empty( $this->_event ) ) {
+		if (empty($this->_event)) {
 			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : NULL;
 			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
 
@@ -92,17 +92,17 @@ 
 
 
 		//If there is no event objecdt by now then get out.
-		if ( ! $this->_event instanceof EE_Event )
+		if ( ! $this->_event instanceof EE_Event)
 			return '';
 
-		switch ( $shortcode ) {
+		switch ($shortcode) {
 
 			case '[EVENT_ID]' :
 				return $this->_event->ID();
 				break;
 
 			case '[EVENT_IDENTIFIER]' :
-				return isset($this->_data['line_ref']) ? $this->_data['line_ref']: '';
+				return isset($this->_data['line_ref']) ? $this->_data['line_ref'] : '';
 				break;
 
 			case '[EVENT]' :
@@ -132,71 +132,71 @@ 
 
 			case '[VIRTUAL_URL]' :
 				$venue = $this->_event->get_first_related('Venue');
-				if ( empty( $venue ) )
+				if (empty($venue))
 					return '';
 				return $venue->get('VNU_virtual_url');
 
 			case '[VIRTUAL_PHONE]' :
 				$venue = $this->_event->get_first_related('Venue');
-				if ( empty( $venue ) )
+				if (empty($venue))
 					return '';
 				return $venue->get('VNU_virtual_phone');
 				break;
 
 			case '[EVENT_IMAGE]' :
-				$image = $this->_event->feature_image_url(array(600,300) );
+				$image = $this->_event->feature_image_url(array(600, 300));
 				// @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
-				return !empty( $image ) ? '<img src="' . $image . '" alt="' . sprintf( esc_attr__( '%s Feature Image', 'event_espresso'), $this->_event->get('EVT_name') ) . '" />' : '';
+				return ! empty($image) ? '<img src="'.$image.'" alt="'.sprintf(esc_attr__('%s Feature Image', 'event_espresso'), $this->_event->get('EVT_name')).'" />' : '';
 				break;
 
 			case '[EVENT_FACEBOOK_URL]' :
-				$facebook_url = $this->_event->get_post_meta('event_facebook', true );
-				return empty( $facebook_url ) ? EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' ) : $facebook_url;
+				$facebook_url = $this->_event->get_post_meta('event_facebook', true);
+				return empty($facebook_url) ? EE_Registry::instance()->CFG->organization->get_pretty('facebook') : $facebook_url;
 				break;
 
 			case '[EVENT_TWITTER_URL]' :
 				$twitter_url = $this->_event->get_post_meta('event_twitter', true);
-				return empty( $twitter_url ) ? EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' ) : $twitter_url;
+				return empty($twitter_url) ? EE_Registry::instance()->CFG->organization->get_pretty('twitter') : $twitter_url;
 				break;
 
 			case '[EVENT_AUTHOR_EMAIL]' :
 				$author_id = $this->_event->get('EVT_wp_user');
-				$user_data = get_userdata( (int) $author_id );
+				$user_data = get_userdata((int) $author_id);
 				return $user_data->user_email;
 				break;
 
 			case '[EVENT_TOTAL_SPOTS_TAKEN]' :
-				return EEM_Registration::instance()->count( array( array( 'EVT_ID' => $this->_event->ID(), 'STS_ID' => EEM_Registration::status_id_approved ) ), 'REG_ID', true );
+				return EEM_Registration::instance()->count(array(array('EVT_ID' => $this->_event->ID(), 'STS_ID' => EEM_Registration::status_id_approved)), 'REG_ID', true);
 				break;
 
 			case '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' :
-				EE_Registry::instance()->load_helper( 'URL' );
+				EE_Registry::instance()->load_helper('URL');
 				return EEH_URL::add_query_args_and_nonce(
 					array(
 						'event_id' => $this->_event->ID(),
 						'page' => 'espresso_registrations',
 						'action' => 'default'
 					),
-					admin_url( 'admin.php' ),
+					admin_url('admin.php'),
 					true
 				);
 				break;
 		}
 
-		if ( strpos( $shortcode, '[EVENT_META_*' ) !== false ) {
-			$shortcode = str_replace( '[EVENT_META_*', '', $shortcode );
-			$shortcode = trim( str_replace( ']', '', $shortcode ) );
+		if (strpos($shortcode, '[EVENT_META_*') !== false) {
+			$shortcode = str_replace('[EVENT_META_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
 
 			//pull the meta value from the event post
-			$event_meta = $this->_event->get_post_meta( $shortcode, true );
+			$event_meta = $this->_event->get_post_meta($shortcode, true);
 
-			return !empty( $event_meta ) ? $this->_event->get_post_meta( $shortcode, true ) : '';
+			return ! empty($event_meta) ? $this->_event->get_post_meta($shortcode, true) : '';
 
 		}
 
-		if ( strpos( $shortcode, '[EVENT_TOTAL_AVAILABLE_SPACES_*' ) !== false ) {
-			$attrs = $this->_get_shortcode_attrs( $shortcode );
-			$method = empty( $attrs['method'] ) ? 'current' : $attrs['method'];
+		if (strpos($shortcode, '[EVENT_TOTAL_AVAILABLE_SPACES_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			$method = empty($attrs['method']) ? 'current' : $attrs['method'];
 			$method = $method === 'current';
 			$available = $this->_event->total_available_spaces($method);
 			return $available === INF ? '&infin;' : $available;
@@ -212,10 +212,10 @@ 
 	 * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.  Otherwise we just return the url of the event.
 	 * @return string
 	 */
-	private function _get_event_link( $event, $full_link = TRUE ) {
+	private function _get_event_link($event, $full_link = TRUE) {
 		$url = get_permalink($event->ID());
 
-		return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
+		return $full_link ? '<a href="'.$url.'">'.$event->get('EVT_name').'</a>' : $url;
 	}