eventespresso / event-espresso-core

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

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');
+}
 
 /**
  * EE_Messages_Validator class
@@ -121,13 +122,14 @@ 
 	 */
 	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(
+		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;
 
@@ -228,8 +230,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 );
 			$shortcode_groups = array_merge( $config[ 'shortcodes'], $shortcode_groups );
 		}
@@ -268,8 +272,9 @@ 
 			$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] ) ) {
@@ -310,8 +315,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] );
+					}
 				}
 			}
 
@@ -385,10 +391,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
@@ -402,8 +411,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'];
+						}
 					}
 				}
 			}
@@ -439,8 +449,8 @@ 
 			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(
+						if ( !is_numeric($value) ) {
+													$err_msg .= sprintf(
 								__(
 									'%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
 									'event_espresso'
@@ -450,11 +460,12 @@ 
 								'<p>',
 								'</p >'
 							);
+						}
 						break;
 					case 'email' :
 						$valid_email = $this->_validate_email($value);
-						if ( !$valid_email )
-							$err_msg .= htmlentities(
+						if ( !$valid_email ) {
+													$err_msg .= htmlentities(
 								sprintf(
 									__(
 										'The %1$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.'
@@ -463,6 +474,7 @@ 
 
 								)
 							);
+						}
 						break;
 					default :
 						break;
@@ -539,7 +551,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 );
@@ -561,8 +576,9 @@ 
 
 		// empty strings will validate because this is how a message template
 		// for a particular 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
@@ -579,8 +595,9 @@ 
 		// 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), ',' );
@@ -601,12 +618,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;
 				}
 			}

Spacing +100 added lines, -100 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -119,9 +119,9 @@ 
 	 * @param       $context
 	 * @throws \EE_Error
 	 */
-	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) )
+		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',
@@ -167,14 +167,14 @@ 
 	 */
 	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 ) ) {
+		if ( ! class_exists($messenger)) {
 			throw new EE_Error(
 				sprintf(
-					__( 'There is no messenger class for the given string (%s)', 'event_espresso' ),
+					__('There is no messenger class for the given string (%s)', 'event_espresso'),
 					$this->_m_name
 				)
 			);
@@ -183,14 +183,14 @@ 
 		$this->_messenger = new $messenger();
 
 		//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 ) ) {
+		if ( ! class_exists($message_type)) {
 			throw new EE_Error(
 				sprintf(
-					__( 'There is no message type class for the given string (%s)', 'event_espresso' ),
+					__('There is no message type class for the given string (%s)', 'event_espresso'),
 					$this->_mt_name
 				)
 			);
@@ -227,25 +227,25 @@ 
 		$shortcode_groups = $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 );
-			$shortcode_groups = array_merge( $config[ 'shortcodes'], $shortcode_groups );
+		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);
+			$shortcode_groups = array_merge($config['shortcodes'], $shortcode_groups);
 		}
 
-		$shortcode_groups = array_unique( $shortcode_groups);
+		$shortcode_groups = array_unique($shortcode_groups);
 
 		// okay now we've got our groups.
 		// Let's get the codes from the objects into an array indexed by group for easy retrieval later.
 		$codes_from_objs = array();
 
-		foreach ( $shortcode_groups as $group ) {
-			$ref = ucwords( str_replace('_', ' ', $group ) );
-			$ref = str_replace( ' ', '_', $ref );
-			$classname = 'EE_' . $ref . '_Shortcodes';
-			if ( class_exists( $classname ) ) {
-				$a = new ReflectionClass( $classname );
+		foreach ($shortcode_groups 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();
 			}
@@ -254,8 +254,8 @@ 
 
 		//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;
@@ -263,60 +263,60 @@ 
 
 		// 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 ],
+			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 ],
+			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 ) {
+				foreach ($config['shortcodes'] as $group) {
 					$this->_validators[$field]['shortcodes'] = isset($this->_validators[$field]['shortcodes'])
-						? array_merge( $this->_validators[$field]['shortcodes'], $codes_from_objs[$group] )
+						? 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;
 		}
 	}
 
@@ -344,7 +344,7 @@ 
 	public function get_specific_shortcode_excludes() {
 		//specific validator filter
 		$shortcode_excludes = apply_filters(
-			'FHEE__' . get_class( $this ) . '__get_specific_shortcode_excludes;',
+			'FHEE__'.get_class($this).'__get_specific_shortcode_excludes;',
 			$this->_specific_shortcode_excludes,
 			$this->_context
 		);
@@ -372,20 +372,20 @@ 
 		//some defaults
 		$template_fields = $this->_messenger->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'];
@@ -393,16 +393,16 @@ 
 
 			// 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'];
 					}
 				}
@@ -410,36 +410,36 @@ 
 
 			//field is present. Let's validate shortcodes first (but only if shortcodes present).
 			if (
-				isset( $this->_validators[ $field ][ 'shortcodes' ] )
-				&& ! empty( $this->_validators[ $field ][ 'shortcodes' ] )
+				isset($this->_validators[$field]['shortcodes'])
+				&& ! empty($this->_validators[$field]['shortcodes'])
 			) {
-				$invalid_shortcodes = $this->_invalid_shortcodes( $value, $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(
 						__(
 							'%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
 							'event_espresso'
 						),
-						'<strong>' . $field_label . '</strong>',
+						'<strong>'.$field_label.'</strong>',
 						$invalid_shortcodes,
 						'<p>',
 						'</p >'
 					);
 					$err_msg .= sprintf(
-						__( '%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso' ),
-						implode( ', ', $v_s )
+						__('%2$sValid shortcodes for this field are: %1$s%3$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) )
+						if ( ! is_numeric($value))
 							$err_msg .= sprintf(
 								__(
 									'%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
@@ -453,7 +453,7 @@ 
 						break;
 					case 'email' :
 						$valid_email = $this->_validate_email($value);
-						if ( !$valid_email )
+						if ( ! $valid_email)
 							$err_msg .= htmlentities(
 								sprintf(
 									__(
@@ -470,23 +470,23 @@ 
 			}
 
 			//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;
 	}
 
 
@@ -499,10 +499,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;
 	}
@@ -521,29 +521,29 @@ 
 	 */
 	protected function _invalid_shortcodes($value, $valid_shortcodes) {
 		//first we need to go through the string and get the shortcodes in the string
-		preg_match_all( '/(\[.+?\])/', $value, $matches );
+		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;
 	}
 
@@ -555,13 +555,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;
 		$or_val = $value;
 
 		// empty strings will validate because this is how a message template
 		// for a particular 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.
@@ -579,19 +579,19 @@ 
 		// 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;
 			}
@@ -599,20 +599,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;
 
@@ -628,7 +628,7 @@ 
 	 * @throws Exception
 	 * @return mixed
 	 */
-	public function __get( $property ) {
+	public function __get($property) {
 		$expected_properties_map = array(
 			/**
 			 * @deprecated 4.9.0
@@ -640,15 +640,15 @@ 
 			'_MSGTYP' => '_message_type'
 		);
 
-		if ( isset( $expected_properties_map[ $property ] ) ) {
-			return $this->{$expected_properties_map[ $property ]};
+		if (isset($expected_properties_map[$property])) {
+			return $this->{$expected_properties_map[$property]};
 		}
 
 		throw new Exception(
 			sprintf(
-				__( 'The property %1$s being requested on %2$s does not exist', 'event_espresso' ),
+				__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
 				$property,
-				get_class( $this )
+				get_class($this)
 			)
 		);
 	}

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?

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

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -55,34 +55,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;
 
@@ -91,10 +91,10 @@ 
 
 
 		//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();
@@ -127,71 +127,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 === EE_INF ? '&infin;' : $available;
@@ -207,10 +207,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;
 	}
 
 

core/libraries/shortcodes/EE_Primary_Registration_List_Shortcodes.lib.php

Doc Comments +6 added lines

@@ -109,6 +109,9 @@ 
 	}
 
 
+	/**
+	 * @param EE_Registration $reg
+	 */
 	private function _get_tickets_from_event( EE_Event $event, $reg = NULL ) {
 		$evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID()]['tkt_objs'] : array();
 
@@ -177,6 +180,9 @@ 
 
 
 
+	/**
+	 * @param EE_Registration $reg
+	 */
 	private function _get_datetimes_from_event( EE_Event $event, $reg = NULL ) {
 		$evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID()]['dtt_objs'] : array();
 

Spacing +40 added lines, -40 removed lines

@@ -43,15 +43,15 @@ 
 
 
 
-	protected function _parser( $shortcode ) {
-		switch ( $shortcode ) {
+	protected function _parser($shortcode) {
+		switch ($shortcode) {
 
 			case '[PRIMARY_REGISTRANT_TICKET_LIST]' :
-				return $this->_get_recipient_ticket_list( TRUE );
+				return $this->_get_recipient_ticket_list(TRUE);
 				break;
 
 			case '[PRIMARY_REGISTRANT_DATETIME_LIST]' :
-				return $this->_get_recipient_datetime_list( TRUE );
+				return $this->_get_recipient_datetime_list(TRUE);
 				break;
 		}
 		return '';
@@ -65,58 +65,58 @@ 
 	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
 	 * @return string
 	 */
-	private function _get_recipient_ticket_list( $primary = FALSE ) {
+	private function _get_recipient_ticket_list($primary = FALSE) {
 		$this->_validate_list_requirements();
 		$this->_set_shortcode_helper();
 
-		if ( $this->_data['data'] instanceof EE_Messages_Addressee )
-			return $this->_get_recipient_ticket_list_parsed( $this->_data['data'], $primary );
+		if ($this->_data['data'] instanceof EE_Messages_Addressee)
+			return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
 
-		else if ( $this->_extra_data['data'] instanceof EE_Messages_Addressee )
-			return $this->_get_recipient_ticket_list_parsed( $this->_extra_data['data'], $primary );
+		else if ($this->_extra_data['data'] instanceof EE_Messages_Addressee)
+			return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
 
 		else
 			return '';
 	}
 
 
-	private function _get_recipient_ticket_list_parsed( EE_Messages_Addressee $data, $primary = FALSE ) {
+	private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = FALSE) {
 		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-			if ( ! $registration instanceof EE_Registration ) return '';
+			if ( ! $registration instanceof EE_Registration) return '';
 		//setup valid shortcodes depending on what the status of the $this->_data property is
-		if ( $this->_data['data'] instanceof EE_Messages_Addressee ) {
-			$valid_shortcodes = array('ticket', 'event_list', 'attendee_list','datetime_list', 'registration_details', 'attendee');
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array('ticket', 'event_list', 'attendee_list', 'datetime_list', 'registration_details', 'attendee');
 			$template = $this->_data['template'];
 			$tkts = array($data->registrations[$registration->ID()]['tkt_obj']);
 			$data = $this->_data;
-		} elseif ( $this->_data['data'] instanceof EE_Event ) {
+		} elseif ($this->_data['data'] instanceof EE_Event) {
 			$valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
-			$template = is_array($this->_data['template'] ) && isset($this->_data['template']['ticket_list']) ? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list']) ? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
 			//let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
 			$template = str_replace('[EVENT_LIST]', '', $template);
 			//data will be tickets for this event for this recipient.
-			$tkts = $this->_get_tickets_from_event( $this->_data['data'], $registration );
+			$tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
 			$data = $this->_extra_data;
 		} else {
 			return '';
 		}
 
 		$tktparsed = '';
-		foreach ( $tkts as $ticket ) {
-			$tktparsed .= $this->_shortcode_helper->parse_ticket_list_template( $template, $ticket, $valid_shortcodes, $data );
+		foreach ($tkts as $ticket) {
+			$tktparsed .= $this->_shortcode_helper->parse_ticket_list_template($template, $ticket, $valid_shortcodes, $data);
 		}
 		return $tktparsed;
 	}
 
 
-	private function _get_tickets_from_event( EE_Event $event, $reg = NULL ) {
+	private function _get_tickets_from_event(EE_Event $event, $reg = NULL) {
 		$evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID()]['tkt_objs'] : array();
 
-		if ( $reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee ) {
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
 			$adj_tkts = array();
 			//return only tickets for the given attendee
-			foreach ( $evt_tkts as $tkt ) {
-				if ( isset( $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj'] ) && $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj']->ID() == $tkt->ID() )
+			foreach ($evt_tkts as $tkt) {
+				if (isset($this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj']) && $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj']->ID() == $tkt->ID())
 					$adj_tkts[] = $tkt;
 			}
 			$evt_tkts = $adj_tkts;
@@ -133,58 +133,58 @@ 
 	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
 	 * @return string
 	 */
-	private function _get_recipient_datetime_list( $primary = FALSE ) {
+	private function _get_recipient_datetime_list($primary = FALSE) {
 		$this->_validate_list_requirements();
 		$this->_set_shortcode_helper();
 
-		if ( $this->_data['data'] instanceof EE_Messages_Addressee )
-			return $this->_get_recipient_datetime_list_parsed( $this->_data['data'], $primary );
+		if ($this->_data['data'] instanceof EE_Messages_Addressee)
+			return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
 
-		else if ( $this->_extra_data['data'] instanceof EE_Messages_Addressee )
-			return $this->_get_recipient_datetime_list_parsed( $this->_extra_data['data'], $primary );
+		else if ($this->_extra_data['data'] instanceof EE_Messages_Addressee)
+			return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
 
 		else
 			return '';
 
-		return $this->_get_recipient_datetime_list_parsed( $this->_data['data'], $primary);
+		return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
 	}
 
 
-	private function _get_recipient_datetime_list_parsed( EE_Messages_Addressee $data, $primary = FALSE ) {
+	private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = FALSE) {
 		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-		if ( ! $registration instanceof EE_Registration ) return '';
+		if ( ! $registration instanceof EE_Registration) return '';
 		//setup valid shortcodes depending on what the status of the $this->_data property is
-		if ( $this->_data['data'] instanceof EE_Messages_Addressee ) {
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
 			$valid_shortcodes = array('datetime', 'attendee');
 			$template = $this->_data['template'];
 			$dtts = $data->registrations[$registration->ID()]['dtt_objs'];
 			$data = $this->_data;
-		} elseif ( $this->_data['data'] instanceof EE_Event ) {
+		} elseif ($this->_data['data'] instanceof EE_Event) {
 			$valid_shortcodes = array('datetime', 'attendee');
-			$template = is_array($this->_data['template'] ) && isset($this->_data['template']['datetime_list']) ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
-			$dtts = $this->_get_datetimes_from_event( $this->_data['data'], $registration );
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list']) ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
+			$dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
 			$data = $this->_extra_data;
 		} else {
 			return '';
 		}
 
 		$dtt_parsed = '';
-		foreach ( $dtts as $datetime ) {
-			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template( $template, $datetime, $valid_shortcodes, $this->_extra_data );
+		foreach ($dtts as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template($template, $datetime, $valid_shortcodes, $this->_extra_data);
 		}
 		return $dtt_parsed;
 	}
 
 
 
-	private function _get_datetimes_from_event( EE_Event $event, $reg = NULL ) {
+	private function _get_datetimes_from_event(EE_Event $event, $reg = NULL) {
 		$evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID()]['dtt_objs'] : array();
 
-		if ( $reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee ) {
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
 			$adj_dtts = array();
 			//return only dtts for the given attendee
-			foreach ( $evt_dtts as $dtt ) {
-				if ( isset( $this->_extra_data['data']->registrations[$reg->ID()]['dtt_objs'][$dtt->ID()] ) )
+			foreach ($evt_dtts as $dtt) {
+				if (isset($this->_extra_data['data']->registrations[$reg->ID()]['dtt_objs'][$dtt->ID()]))
 					$adj_dtts[] = $dtt;
 			}
 			$evt_dtts = $adj_dtts;

Braces +26 added lines, -22 removed lines

@@ -69,20 +69,21 @@ 
 		$this->_validate_list_requirements();
 		$this->_set_shortcode_helper();
 
-		if ( $this->_data['data'] instanceof EE_Messages_Addressee )
-			return $this->_get_recipient_ticket_list_parsed( $this->_data['data'], $primary );
-
-		else if ( $this->_extra_data['data'] instanceof EE_Messages_Addressee )
-			return $this->_get_recipient_ticket_list_parsed( $this->_extra_data['data'], $primary );
-
-		else
-			return '';
+		if ( $this->_data['data'] instanceof EE_Messages_Addressee ) {
+					return $this->_get_recipient_ticket_list_parsed( $this->_data['data'], $primary );
+		} else if ( $this->_extra_data['data'] instanceof EE_Messages_Addressee ) {
+					return $this->_get_recipient_ticket_list_parsed( $this->_extra_data['data'], $primary );
+		} else {
+					return '';
+		}
 	}
 
 
 	private function _get_recipient_ticket_list_parsed( EE_Messages_Addressee $data, $primary = FALSE ) {
 		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-			if ( ! $registration instanceof EE_Registration ) return '';
+			if ( ! $registration instanceof EE_Registration ) {
+				return '';
+			}
 		//setup valid shortcodes depending on what the status of the $this->_data property is
 		if ( $this->_data['data'] instanceof EE_Messages_Addressee ) {
 			$valid_shortcodes = array('ticket', 'event_list', 'attendee_list','datetime_list', 'registration_details', 'attendee');
@@ -116,8 +117,9 @@ 
 			$adj_tkts = array();
 			//return only tickets for the given attendee
 			foreach ( $evt_tkts as $tkt ) {
-				if ( isset( $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj'] ) && $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj']->ID() == $tkt->ID() )
-					$adj_tkts[] = $tkt;
+				if ( isset( $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj'] ) && $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj']->ID() == $tkt->ID() ) {
+									$adj_tkts[] = $tkt;
+				}
 			}
 			$evt_tkts = $adj_tkts;
 		}
@@ -137,14 +139,13 @@ 
 		$this->_validate_list_requirements();
 		$this->_set_shortcode_helper();
 
-		if ( $this->_data['data'] instanceof EE_Messages_Addressee )
-			return $this->_get_recipient_datetime_list_parsed( $this->_data['data'], $primary );
-
-		else if ( $this->_extra_data['data'] instanceof EE_Messages_Addressee )
-			return $this->_get_recipient_datetime_list_parsed( $this->_extra_data['data'], $primary );
-
-		else
-			return '';
+		if ( $this->_data['data'] instanceof EE_Messages_Addressee ) {
+					return $this->_get_recipient_datetime_list_parsed( $this->_data['data'], $primary );
+		} else if ( $this->_extra_data['data'] instanceof EE_Messages_Addressee ) {
+					return $this->_get_recipient_datetime_list_parsed( $this->_extra_data['data'], $primary );
+		} else {
+					return '';
+		}
 
 		return $this->_get_recipient_datetime_list_parsed( $this->_data['data'], $primary);
 	}
@@ -152,7 +153,9 @@ 
 
 	private function _get_recipient_datetime_list_parsed( EE_Messages_Addressee $data, $primary = FALSE ) {
 		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-		if ( ! $registration instanceof EE_Registration ) return '';
+		if ( ! $registration instanceof EE_Registration ) {
+			return '';
+		}
 		//setup valid shortcodes depending on what the status of the $this->_data property is
 		if ( $this->_data['data'] instanceof EE_Messages_Addressee ) {
 			$valid_shortcodes = array('datetime', 'attendee');
@@ -184,8 +187,9 @@ 
 			$adj_dtts = array();
 			//return only dtts for the given attendee
 			foreach ( $evt_dtts as $dtt ) {
-				if ( isset( $this->_extra_data['data']->registrations[$reg->ID()]['dtt_objs'][$dtt->ID()] ) )
-					$adj_dtts[] = $dtt;
+				if ( isset( $this->_extra_data['data']->registrations[$reg->ID()]['dtt_objs'][$dtt->ID()] ) ) {
+									$adj_dtts[] = $dtt;
+				}
 			}
 			$evt_dtts = $adj_dtts;
 		}

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Doc Comments +3 added lines

@@ -269,6 +269,9 @@
 
 
 
+	/**
+	 * @param EE_Transaction $transaction
+	 */
 	private function _get_payment_gateway( $transaction ) {
 		$pm = $this->_get_payment_method( $transaction );
 		return $pm instanceof EE_Payment_Method ? $pm->name() : '';

Braces +8 added lines, -6 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
@@ -92,8 +93,9 @@ 
 		$payment = ! $payment instanceof EE_Payment && is_array( $this->_extra_data ) &&  isset( $this->_extra_data['data'] ) && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment: $payment;
 
 
-		if ( ! $transaction instanceof EE_Transaction )
-			return '';
+		if ( ! $transaction instanceof EE_Transaction ) {
+					return '';
+		}
 
 		switch ( $shortcode ) {
 			case '[TXN_ID]' :
@@ -290,7 +292,7 @@ 
 		$pm = $this->_get_payment_method();
 		if ( $pm instanceof EE_Payment_Method ){
 			$invoice_logo_url = $pm->get_extra_meta( 'pdf_logo_image', TRUE );
-		}else{
+		} else{
 			$invoice_logo_url = NULL;
 		}
 		if( empty( $invoice_logo_url ) ){
@@ -311,7 +313,7 @@ 
 		//if image is wider than 200px, set the wideth to 200
 		if ( $image_size[0] > 300 ) {
 			$image_width = 300;
-		}else{
+		} else{
 			$image_width = $image_size[0];
 		}
 
@@ -349,7 +351,7 @@ 
 				return apply_filters( 'FHEE__EE_Transaction_Shortcodes__get_payment_method__default', EEM_Payment_Method::instance()->get_one_of_type('Invoice'));
 			}
 			return $payment_method;
-		}else{
+		} else{
 			//get the first payment method we can find
 			return apply_filters( 'FHEE__EE_Transaction_Shortcodes__get_payment_method__default', EEM_Payment_Method::instance()->get_one_of_type('Invoice'));
 		}

Spacing +140 added lines, -140 removed lines

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