eventespresso / event-espresso-core

core/helpers/EEH_MSG_Template.helper.php

Spacing +197 added lines, -197 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -59,24 +59,24 @@ 
 	 *                was not a new generated template but just reactivated (which only happens for global templates that
 	 *                already exist in the database.
 	 */
-	public static function generate_new_templates( $messenger, $message_types, $GRP_ID = 0, $global = false ) {
+	public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false) {
 		//make sure message_type is an array.
 		$message_types = (array) $message_types;
 		$templates = array();
 
-		if ( empty( $messenger ) ) {
-			throw new EE_Error( __('We need a messenger to generate templates!', 'event_espresso') );
+		if (empty($messenger)) {
+			throw new EE_Error(__('We need a messenger to generate templates!', 'event_espresso'));
 		}
 
 		//if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
-		if ( empty( $message_types ) ) {
-			throw new EE_Error( __('We need at least one message type to generate templates!', 'event_espresso') );
+		if (empty($message_types)) {
+			throw new EE_Error(__('We need at least one message type to generate templates!', 'event_espresso'));
 		}
 
 		EEH_MSG_Template::_set_autoloader();
-		foreach ( $message_types as $message_type ) {
+		foreach ($message_types as $message_type) {
 			//if global then let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
-			if ( $global && empty( $GRP_ID ) ) {
+			if ($global && empty($GRP_ID)) {
 				$GRP_ID = EEM_Message_Template_Group::instance()->get_one(
 					array(
 						array(
@@ -91,7 +91,7 @@ 
 			// if this is global template generation.
 			// First let's determine if we already HAVE global templates for this messenger and message_type combination.
 			//  If we do then NO generation!!
-			if ( $global && EEH_MSG_Template::already_generated( $messenger, $message_type, $GRP_ID ) ) {
+			if ($global && EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
 				$templates[] = array(
 					'GRP_ID' => $GRP_ID,
 					'MTP_context' => '',
@@ -99,9 +99,9 @@ 
 				//we already have generated templates for this so let's go to the next message type.
 				continue;
 			}
-			$new_message_template_group = EEH_MSG_Template::create_new_templates( $messenger, $message_type, $GRP_ID, $global );
+			$new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
 
-			if ( ! $new_message_template_group ) {
+			if ( ! $new_message_template_group) {
 				continue;
 			}
 			$templates[] = $new_message_template_group;
@@ -118,10 +118,10 @@ 
 	 * @param  int $GRP_ID        GRP ID ( if a custom template) (if not provided then we're just doing global template check)
 	 * @return bool                true = generated, false = hasn't been generated.
 	 */
-	public static function already_generated( $messenger, $message_type, $GRP_ID = 0 ) {
+	public static function already_generated($messenger, $message_type, $GRP_ID = 0) {
 		EEH_MSG_Template::_set_autoloader();
 		//what method we use depends on whether we have an GRP_ID or not
-		$count = empty( $GRP_ID )
+		$count = empty($GRP_ID)
 			? EEM_Message_Template::instance()->count(
 				array(
 					array(
@@ -131,7 +131,7 @@ 
 					)
 				)
 			)
-			: EEM_Message_Template::instance()->count( array( array( 'GRP_ID' => $GRP_ID ) ) );
+			: EEM_Message_Template::instance()->count(array(array('GRP_ID' => $GRP_ID)));
 
 		return $count > 0;
 	}
@@ -147,15 +147,15 @@ 
 	 * @param  array  $message_type_names  Message type slug
 	 * @return  int 						count of updated records.
 	 */
-	public static function update_to_active( $messenger_names, $message_type_names ) {
-		$messenger_names = is_array( $messenger_names ) ? $messenger_names : array( $messenger_names );
-		$message_type_names = is_array( $message_type_names ) ? $message_type_names : array( $message_type_names );
+	public static function update_to_active($messenger_names, $message_type_names) {
+		$messenger_names = is_array($messenger_names) ? $messenger_names : array($messenger_names);
+		$message_type_names = is_array($message_type_names) ? $message_type_names : array($message_type_names);
 		return EEM_Message_Template_Group::instance()->update(
-			array( 'MTP_is_active' => 1 ),
+			array('MTP_is_active' => 1),
 			array(
 				array(
-					'MTP_messenger' 	=> array( 'IN', $messenger_names ),
-					'MTP_message_type'  => array( 'IN', $message_type_names )
+					'MTP_messenger' 	=> array('IN', $messenger_names),
+					'MTP_message_type'  => array('IN', $message_type_names)
 				)
 			)
 		);
@@ -176,7 +176,7 @@ 
 	 *
 	 * @return int  count of updated records.
 	 */
-	public static function update_to_inactive( $messenger_names = array(), $message_type_names = array() ) {
+	public static function update_to_inactive($messenger_names = array(), $message_type_names = array()) {
 		return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
 			$messenger_names,
 			$message_type_names
@@ -193,9 +193,9 @@ 
 	 * @param string $type
 	 * @return array array consisting of installed messenger objects and installed message type objects.
 	 */
-	public static function get_installed_message_objects( $type = 'all' ) {
+	public static function get_installed_message_objects($type = 'all') {
 		self::_set_autoloader();
-		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		return array(
 			'messenger' => $message_resource_manager->installed_messengers(),
 			'message_type' => $message_resource_manager->installed_message_types()
@@ -231,74 +231,74 @@ 
 		$context = 'admin',
 		$merged = false
 	) {
-		$messenger_name = str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $messenger ) ) );
-		$mt_name = str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $message_type ) ) );
+		$messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
+		$mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
 		/** @var EE_Message_Resource_Manager $message_resource_manager */
-		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		//convert slug to object
-		$messenger = $message_resource_manager->get_messenger( $messenger );
+		$messenger = $message_resource_manager->get_messenger($messenger);
 
 		//if messenger isn't a EE_messenger resource then bail.
-		if ( ! $messenger instanceof EE_messenger ) {
+		if ( ! $messenger instanceof EE_messenger) {
 			return array();
 		}
 
 		//validate class for getting our list of shortcodes
-		$classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
-		if ( ! class_exists( $classname ) ) {
-			$msg[] = __( 'The Validator class was unable to load', 'event_espresso' );
+		$classname = 'EE_Messages_'.$messenger_name.'_'.$mt_name.'_Validator';
+		if ( ! class_exists($classname)) {
+			$msg[] = __('The Validator class was unable to load', 'event_espresso');
 			$msg[] = sprintf(
-				__( 'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso' ),
+				__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
 				$classname
 			);
-			throw new EE_Error( implode( '||', $msg ) );
+			throw new EE_Error(implode('||', $msg));
 		}
 
 		/** @type EE_Messages_Validator $_VLD */
-		$_VLD = new $classname( array(), $context );
+		$_VLD = new $classname(array(), $context);
 		$valid_shortcodes = $_VLD->get_validators();
 
 		//let's make sure we're only getting the shortcode part of the validators
 		$shortcodes = array();
-		foreach ( $valid_shortcodes as $field => $validators ) {
-			$shortcodes[ $field ] = $validators['shortcodes'];
+		foreach ($valid_shortcodes as $field => $validators) {
+			$shortcodes[$field] = $validators['shortcodes'];
 		}
 		$valid_shortcodes = $shortcodes;
 
 		//if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
-		if ( ! empty( $fields ) ) {
+		if ( ! empty($fields)) {
 			$specified_shortcodes = array();
-			foreach ( $fields as $field ) {
-				if ( isset( $valid_shortcodes[ $field ] ) ) {
-					$specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
+			foreach ($fields as $field) {
+				if (isset($valid_shortcodes[$field])) {
+					$specified_shortcodes[$field] = $valid_shortcodes[$field];
 				}
 			}
 			$valid_shortcodes = $specified_shortcodes;
 		}
 
 		//if not merged then let's replace the fields with the localized fields
-		if ( ! $merged ) {
+		if ( ! $merged) {
 			//let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
 			$field_settings = $messenger->get_template_fields();
 			$localized = array();
-			foreach ( $valid_shortcodes as $field => $shortcodes ) {
+			foreach ($valid_shortcodes as $field => $shortcodes) {
 				//get localized field label
-				if ( isset( $field_settings[ $field ] ) ) {
+				if (isset($field_settings[$field])) {
 					//possible that this is used as a main field.
-					if ( empty( $field_settings[ $field ] ) ) {
-						if ( isset( $field_settings['extra'][ $field ] ) ) {
-							$_field = $field_settings['extra'][ $field ]['main']['label'];
+					if (empty($field_settings[$field])) {
+						if (isset($field_settings['extra'][$field])) {
+							$_field = $field_settings['extra'][$field]['main']['label'];
 						} else {
 							$_field = $field;
 						}
 					} else {
-						$_field = $field_settings[ $field ]['label'];
+						$_field = $field_settings[$field]['label'];
 					}
-				} else if ( isset( $field_settings['extra'] ) ) {
+				} else if (isset($field_settings['extra'])) {
 					//loop through extra "main fields" and see if any of their children have our field
-					foreach ( $field_settings['extra'] as $main_field => $fields ) {
-						if ( isset( $fields[ $field ] ) ) {
-							$_field = $fields[ $field ]['label'];
+					foreach ($field_settings['extra'] as $main_field => $fields) {
+						if (isset($fields[$field])) {
+							$_field = $fields[$field]['label'];
 						} else {
 							$_field = $field;
 						}
@@ -306,22 +306,22 @@ 
 				} else {
 					$_field = $field;
 				}
-				if ( isset( $_field ) ) {
-					$localized[ $_field ] = $shortcodes;
+				if (isset($_field)) {
+					$localized[$_field] = $shortcodes;
 				}
 			}
 			$valid_shortcodes = $localized;
 		}
 
 		//if $merged then let's merge all the shortcodes into one list NOT indexed by field.
-		if ( $merged ) {
+		if ($merged) {
 			$merged_codes = array();
-			foreach ( $valid_shortcodes as $field => $shortcode ) {
-				foreach ( $shortcode as $code => $label ) {
-					if ( isset( $merged_codes[ $code ] ) ) {
+			foreach ($valid_shortcodes as $field => $shortcode) {
+				foreach ($shortcode as $code => $label) {
+					if (isset($merged_codes[$code])) {
 						continue;
 					} else {
-						$merged_codes[ $code ] = $label;
+						$merged_codes[$code] = $label;
 					}
 				}
 			}
@@ -341,10 +341,10 @@ 
 	 * @throws \EE_Error
 	 * @return EE_messenger
 	 */
-	public static function messenger_obj( $messenger ) {
+	public static function messenger_obj($messenger) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		return $Message_Resource_Manager->get_messenger( $messenger );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_messenger($messenger);
 	}
 
 
@@ -357,10 +357,10 @@ 
 	 * @throws \EE_Error
 	 * @return EE_message_type
 	 */
-	public static function message_type_obj( $message_type ) {
+	public static function message_type_obj($message_type) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		return $Message_Resource_Manager->get_message_type( $message_type );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_message_type($message_type);
 	}
 
 
@@ -374,11 +374,11 @@ 
 	 * @param  string   $message_type message type to check for.
 	 * @return boolean
 	 */
-	public static function is_mt_active( $message_type ) {
+	public static function is_mt_active($message_type) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		$active_mts = $Message_Resource_Manager->list_of_active_message_types();
-		return in_array( $message_type, $active_mts );
+		return in_array($message_type, $active_mts);
 	}
 
 
@@ -391,10 +391,10 @@ 
 	 * @param  string  $messenger slug for messenger to check.
 	 * @return boolean
 	 */
-	public static function is_messenger_active( $messenger ) {
+	public static function is_messenger_active($messenger) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		$active_messenger = $Message_Resource_Manager->get_active_messenger( $messenger );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
 		return $active_messenger instanceof EE_messenger ? true : false;
 	}
 
@@ -412,11 +412,11 @@ 
 	public static function get_active_messengers_in_db() {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
-			__( 'Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso' ),
+			__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
 			'4.9.0'
 		);
 		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		return $Message_Resource_Manager->get_active_messengers_option();
 	}
 
@@ -433,15 +433,15 @@ 
 	 *
 	 * @return bool FALSE if not updated, TRUE if updated.
 	 */
-	public static function update_active_messengers_in_db( $data_to_save ) {
+	public static function update_active_messengers_in_db($data_to_save) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
-			__( 'Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso' ),
+			__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
 			'4.9.0'
 		);
 		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		return $Message_Resource_Manager->update_active_messengers_option( $data_to_save );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
 	}
 
 
@@ -465,34 +465,34 @@ 
 		$sending_messenger = ''
 	) {
 		//first determine if the url can be to the EE_Message object.
-		if ( ! $message_type->always_generate() ) {
-			return EEH_MSG_Template::generate_browser_trigger( $message );
+		if ( ! $message_type->always_generate()) {
+			return EEH_MSG_Template::generate_browser_trigger($message);
 		}
 
 		//if $registration object is not valid then exit early because there's nothing that can be generated.
-		if ( ! $registration instanceof EE_Registration ) {
+		if ( ! $registration instanceof EE_Registration) {
 			throw new EE_Error(
-				__( 'Incoming value for registration is not a valid EE_Registration object.', 'event_espresso' )
+				__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
 			);
 		}
 
 		//validate given context
 		$contexts = $message_type->get_contexts();
-		if ( $message->context() !== '' && ! isset( $contexts[$message->context()] ) ) {
+		if ($message->context() !== '' && ! isset($contexts[$message->context()])) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The context %s is not a valid context for %s.', 'event_espresso' ),
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
 					$message->context(),
-					get_class( $message_type )
+					get_class($message_type)
 				)
 			);
 		}
 
 		//valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
-		if ( ! empty( $sending_messenger ) ) {
+		if ( ! empty($sending_messenger)) {
 			$with_messengers = $message_type->with_messengers();
-			if ( ! isset( $with_messengers[$message->messenger()] )
-			     || ! in_array( $sending_messenger, $with_messengers[$message->messenger()] ) ) {
+			if ( ! isset($with_messengers[$message->messenger()])
+			     || ! in_array($sending_messenger, $with_messengers[$message->messenger()])) {
 				throw new EE_Error(
 					sprintf(
 						__(
@@ -500,7 +500,7 @@ 
 							'event_espresso'
 						),
 						$sending_messenger,
-						get_class( $message_type )
+						get_class($message_type)
 					)
 				);
 			}
@@ -523,14 +523,14 @@ 
 	 * @param EE_Message $message
 	 * @return string.
 	 */
-	public static function generate_browser_trigger( EE_Message $message ) {
+	public static function generate_browser_trigger(EE_Message $message) {
 		$query_args = array(
 			'ee' => 'msg_browser_trigger',
 			'token' => $message->MSG_token()
 		);
 		return apply_filters(
 			'FHEE__EEH_MSG_Template__generate_browser_trigger',
-			add_query_arg( $query_args, site_url() ),
+			add_query_arg($query_args, site_url()),
 			$message
 		);
 	}
@@ -545,7 +545,7 @@ 
 	 * @param EE_Message $message
 	 * @return string
 	 */
-	public static function generate_error_display_trigger( EE_Message $message ) {
+	public static function generate_error_display_trigger(EE_Message $message) {
 		return apply_filters(
 			'FHEE__EEH_MSG_Template__generate_error_display_trigger',
 			add_query_arg(
@@ -595,7 +595,7 @@ 
 			'GRP_ID' => $message_template_group,
 			'id' => $data_id
 			);
-		$url = add_query_arg( $query_args, get_site_url() );
+		$url = add_query_arg($query_args, get_site_url());
 
 		//made it here so now we can just get the url and filter it.  Filtered globally and by message type.
 		$url = apply_filters(
@@ -623,9 +623,9 @@ 
 	 * @param string $type  What action to return.
 	 * @return string
 	 */
-	public static function get_message_action_icon( $type ) {
+	public static function get_message_action_icon($type) {
 		$action_icons = self::get_message_action_icons();
-		return isset( $action_icons[ $type ] ) ? $action_icons[ $type ] : '';
+		return isset($action_icons[$type]) ? $action_icons[$type] : '';
 	}
 
 
@@ -637,34 +637,34 @@ 
 	 * @return array
 	 */
 	public static function get_message_action_icons() {
-		return apply_filters( 'FHEE__EEH_MSG_Template__message_action_icons',
+		return apply_filters('FHEE__EEH_MSG_Template__message_action_icons',
 			array(
 				'view' => array(
-					'label' => __( 'View Message', 'event_espresso' ),
+					'label' => __('View Message', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-welcome-view-site',
 				),
 				'error' => array(
-					'label' => __( 'View Error Message', 'event_espresso' ),
+					'label' => __('View Error Message', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-info',
 				),
 				'see_notifications_for' => array(
-					'label' => __( 'View Related Messages', 'event_espresso' ),
+					'label' => __('View Related Messages', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-megaphone',
 				),
 				'generate_now' => array(
-					'label' => __( 'Generate the message now.', 'event_espresso' ),
+					'label' => __('Generate the message now.', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-admin-tools',
 				),
 				'send_now' => array(
-					'label' => __( 'Send Immediately', 'event_espresso' ),
+					'label' => __('Send Immediately', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-controls-forward',
 				),
 				'queue_for_resending' => array(
-					'label' => __( 'Queue for Resending', 'event_espresso' ),
+					'label' => __('Queue for Resending', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-controls-repeat',
 				),
 				'view_transaction' => array(
-					'label' => __( 'View related Transaction', 'event_espresso' ),
+					'label' => __('View related Transaction', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-cart',
 				)
 			)
@@ -683,9 +683,9 @@ 
 	 *
 	 * @return string
 	 */
-	public static function get_message_action_url( $type, EE_Message $message = null, $query_params = array() ) {
-		$action_urls = self::get_message_action_urls( $message, $query_params );
-		return isset( $action_urls[ $type ] )  ? $action_urls[ $type ] : '';
+	public static function get_message_action_url($type, EE_Message $message = null, $query_params = array()) {
+		$action_urls = self::get_message_action_urls($message, $query_params);
+		return isset($action_urls[$type]) ? $action_urls[$type] : '';
 	}
 
 
@@ -700,15 +700,15 @@ 
 	 *
 	 * @return array
 	 */
-	public static function get_message_action_urls( EE_Message $message = null, $query_params = array() ) {
-		EE_Registry::instance()->load_helper( 'URL' );
+	public static function get_message_action_urls(EE_Message $message = null, $query_params = array()) {
+		EE_Registry::instance()->load_helper('URL');
 		//if $message is not an instance of EE_Message then let's just do a dummy.
-		$message = empty( $message ) ? EE_Message_Factory::create() : $message;
-		$action_urls =  apply_filters(
+		$message = empty($message) ? EE_Message_Factory::create() : $message;
+		$action_urls = apply_filters(
 			'FHEE__EEH_MSG_Template__get_message_action_url',
 			array(
-				'view' => EEH_MSG_Template::generate_browser_trigger( $message ),
-				'error' => EEH_MSG_Template::generate_error_display_trigger( $message ),
+				'view' => EEH_MSG_Template::generate_browser_trigger($message),
+				'error' => EEH_MSG_Template::generate_error_display_trigger($message),
 				'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
 					array_merge(
 						array(
@@ -718,7 +718,7 @@ 
 						),
 						$query_params
 					),
-					admin_url( 'admin.php' )
+					admin_url('admin.php')
 				),
 				'generate_now' => EEH_URL::add_query_args_and_nonce(
 					array(
@@ -726,7 +726,7 @@ 
 						'action' => 'generate_now',
 						'MSG_ID' => $message->ID()
 					),
-					admin_url( 'admin.php' )
+					admin_url('admin.php')
 				),
 				'send_now' => EEH_URL::add_query_args_and_nonce(
 					array(
@@ -734,7 +734,7 @@ 
 						'action' => 'send_now',
 						'MSG_ID' => $message->ID()
 					),
-					admin_url( 'admin.php' )
+					admin_url('admin.php')
 				),
 				'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
 					array(
@@ -742,7 +742,7 @@ 
 						'action' => 'queue_for_resending',
 						'MSG_ID' => $message->ID()
 					),
-					admin_url( 'admin.php' )
+					admin_url('admin.php')
 				),
 			)
 		);
@@ -760,7 +760,7 @@ 
 					'action' => 'view_transaction',
 					'TXN_ID' => $message->TXN_ID()
 				),
-				admin_url( 'admin.php' )
+				admin_url('admin.php')
 			);
 		} else {
 			$action_urls['view_transaction'] = '';
@@ -781,26 +781,26 @@ 
 	 *
 	 * @return string
 	 */
-	public static function get_message_action_link( $type, EE_Message $message = null, $query_params = array() ) {
-		$url = EEH_MSG_Template::get_message_action_url( $type, $message, $query_params );
-		$icon_css = EEH_MSG_Template::get_message_action_icon( $type );
-		$title = isset( $icon_css['label'] ) ? 'title="' . $icon_css['label'] . '"' : '';
+	public static function get_message_action_link($type, EE_Message $message = null, $query_params = array()) {
+		$url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
+		$icon_css = EEH_MSG_Template::get_message_action_icon($type);
+		$title = isset($icon_css['label']) ? 'title="'.$icon_css['label'].'"' : '';
 
-		if ( empty( $url ) || empty( $icon_css ) || ! isset( $icon_css['css_class'] ) ) {
+		if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
 			return '';
 		}
 
 		$icon_css['css_class'] .= esc_attr(
 			apply_filters(
 				'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
-				' js-ee-message-action-link ee-message-action-link-' . $type,
+				' js-ee-message-action-link ee-message-action-link-'.$type,
 				$type,
 				$message,
 				$query_params
 			)
 		);
 
-		return '<a href="' . $url . '"' . $title . '><span class="' . esc_attr( $icon_css['css_class'] ) . '"></span></a>';
+		return '<a href="'.$url.'"'.$title.'><span class="'.esc_attr($icon_css['css_class']).'"></span></a>';
 
 	}
 
@@ -838,9 +838,9 @@ 
 	 * @param $reg_status
 	 * @return string
 	 */
-	public static function convert_reg_status_to_message_type( $reg_status ) {
+	public static function convert_reg_status_to_message_type($reg_status) {
 		$reg_status_array = self::reg_status_to_message_type_array();
-		return isset( $reg_status_array[$reg_status] ) ? $reg_status_array[$reg_status] : '';
+		return isset($reg_status_array[$reg_status]) ? $reg_status_array[$reg_status] : '';
 	}
 
 
@@ -874,9 +874,9 @@ 
 	 * @param $payment_status
 	 * @return string
 	 */
-	public static function convert_payment_status_to_message_type( $payment_status ) {
+	public static function convert_payment_status_to_message_type($payment_status) {
 		$payment_status_array = self::payment_status_to_message_type_array();
-		return isset( $payment_status_array[$payment_status] ) ? $payment_status_array[$payment_status] : '';
+		return isset($payment_status_array[$payment_status]) ? $payment_status_array[$payment_status] : '';
 	}
 
 
@@ -887,32 +887,32 @@ 
 	 *
 	 * @return EE_Messages_Template_Pack
 	 */
-	public static function get_template_pack( $template_pack_name ) {
-		if ( ! self::$_template_pack_collection instanceof EE_Object_Collection ) {
+	public static function get_template_pack($template_pack_name) {
+		if ( ! self::$_template_pack_collection instanceof EE_Object_Collection) {
 			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
 		}
 
 		//first see if in collection already
-		$template_pack = self::$_template_pack_collection->get_by_name( $template_pack_name );
+		$template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
 
-		if ( $template_pack instanceof EE_Messages_Template_Pack ) {
+		if ($template_pack instanceof EE_Messages_Template_Pack) {
 			return $template_pack;
 		}
 
 		//nope...let's get it.
 		//not set yet so let's attempt to get it.
-		$pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+		$pack_class_name = 'EE_Messages_Template_Pack_'.str_replace(
 				' ',
 				'_',
 				ucwords(
-					str_replace( '_', ' ', $template_pack_name )
+					str_replace('_', ' ', $template_pack_name)
 				)
 			);
-		if ( ! class_exists( $pack_class_name ) && $template_pack_name !== 'default' ) {
-			return self::get_template_pack( 'default' );
+		if ( ! class_exists($pack_class_name) && $template_pack_name !== 'default') {
+			return self::get_template_pack('default');
 		} else {
 			$template_pack = new $pack_class_name;
-			self::$_template_pack_collection->add( $template_pack );
+			self::$_template_pack_collection->add($template_pack);
 			return $template_pack;
 		}
 	}
@@ -930,26 +930,26 @@ 
 	 */
 	public static function get_template_pack_collection() {
 		$new_collection = false;
-		if ( ! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection ) {
+		if ( ! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
 			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
 			$new_collection = true;
 		}
 
 		//glob the defaults directory for messages
-		$templates = glob( EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR );
-		foreach( $templates as $template_path ) {
+		$templates = glob(EE_LIBRARIES.'messages/defaults/*', GLOB_ONLYDIR);
+		foreach ($templates as $template_path) {
 			//grab folder name
-			$template = basename( $template_path );
+			$template = basename($template_path);
 
-			if ( ! $new_collection ) {
+			if ( ! $new_collection) {
 				//already have it?
-				if ( self::$_template_pack_collection->get_by_name( $template ) instanceof EE_Messages_Template_Pack ) {
+				if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
 					continue;
 				}
 			}
 
 			//setup classname.
-			$template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+			$template_pack_class_name = 'EE_Messages_Template_Pack_'.str_replace(
 					' ',
 					'_',
 					ucwords(
@@ -960,20 +960,20 @@ 
 						)
 					)
 				);
-			if ( ! class_exists( $template_pack_class_name ) ) {
+			if ( ! class_exists($template_pack_class_name)) {
 				continue;
 			}
-			self::$_template_pack_collection->add( new $template_pack_class_name );
+			self::$_template_pack_collection->add(new $template_pack_class_name);
 		}
 
 		/**
 		 * Filter for plugins to add in any additional template packs
 		 * Note the filter name here is for backward compat, this used to be found in EED_Messages.
 		 */
-		$additional_template_packs = apply_filters( 'FHEE__EED_Messages__get_template_packs__template_packs', array() );
-		foreach ( (array) $additional_template_packs as $template_pack ) {
-			if ( ! self::$_template_pack_collection->contains($template_pack ) ) {
-				self::$_template_pack_collection->add( $template_pack );
+		$additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
+		foreach ((array) $additional_template_packs as $template_pack) {
+			if ( ! self::$_template_pack_collection->contains($template_pack)) {
+				self::$_template_pack_collection->add($template_pack);
 			}
 		}
 		return self::$_template_pack_collection;
@@ -991,16 +991,16 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-	public static function create_new_templates( $messenger_name, $message_type_name, $GRP_ID = 0, $global = false ) {
+	public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		$messenger = $Message_Resource_Manager->valid_messenger( $messenger_name );
-		$message_type = $Message_Resource_Manager->valid_message_type( $message_type_name );
-		if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger( $messenger, $message_type, $global ) ) {
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
 			return array();
 		}
 		//whew made it this far!  Okay, let's go ahead and create the templates then
-		return EEH_MSG_Template::_create_new_templates( $messenger, $message_type, $GRP_ID, $global );
+		return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
 	}
 
 
@@ -1012,15 +1012,15 @@ 
 	 * @param                  $global
 	 * @return array|mixed
 	 */
-	protected static function _create_new_templates( EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global ) {
+	protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global) {
 		//if we're creating a custom template then we don't need to use the defaults class
-		if ( ! $global ) {
-			return EEH_MSG_Template::_create_custom_template_group( $messenger, $message_type, $GRP_ID );
+		if ( ! $global) {
+			return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
 		}
 		/** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
 		$Message_Template_Defaults = EE_Registry::factory(
 			'EE_Messages_Template_Defaults',
-			array( $messenger, $message_type, $GRP_ID )
+			array($messenger, $message_type, $GRP_ID)
 		);
 		//generate templates
 		$success = $Message_Template_Defaults->create_new_templates();
@@ -1028,10 +1028,10 @@ 
 		//if creating the template failed.  Then we should deactivate the related message_type for the messenger because
 		//its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
 		//attempts.
-		if ( ! $success ) {
+		if ( ! $success) {
 			/** @var EE_Message_Resource_Manager $message_resource_manager */
-			$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-			$message_resource_manager->deactivate_message_type_for_messenger( $message_type->name, $messenger->name );
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
 		}
 
 		/**
@@ -1059,11 +1059,11 @@ 
 	 * 										)
 	 * @access private
 	 */
-	private static function _create_custom_template_group( EE_messenger $messenger, EE_message_type $message_type, $GRP_ID ) {
+	private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID) {
 		//defaults
-		$success = array( 'GRP_ID' => null, 'MTP_context' => '' );
+		$success = array('GRP_ID' => null, 'MTP_context' => '');
 		//get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
-		$Message_Template_Group = empty( $GRP_ID )
+		$Message_Template_Group = empty($GRP_ID)
 			? EEM_Message_Template_Group::instance()->get_one(
 				array(
 					array(
@@ -1073,9 +1073,9 @@ 
 					)
 				)
 			)
-			: EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+			: EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
 		//if we don't have a mtg at this point then we need to bail.
-		if ( ! $Message_Template_Group instanceof EE_Message_Template_Group ) {
+		if ( ! $Message_Template_Group instanceof EE_Message_Template_Group) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1094,42 +1094,42 @@ 
 		$message_templates = $Message_Template_Group->message_templates();
 		//now we have what we need to setup the new template
 		$new_mtg = clone $Message_Template_Group;
-		$new_mtg->set( 'GRP_ID', 0 );
-		$new_mtg->set( 'MTP_is_global', false );
-		$template_name = defined( 'DOING_AJAX' ) && ! empty( $_POST[ 'templateName' ] )
-			? $_POST[ 'templateName' ]
+		$new_mtg->set('GRP_ID', 0);
+		$new_mtg->set('MTP_is_global', false);
+		$template_name = defined('DOING_AJAX') && ! empty($_POST['templateName'])
+			? $_POST['templateName']
 			: __(
 				'New Custom Template',
 				'event_espresso'
 			);
-		$template_description = defined( "DOING_AJAX" ) && ! empty( $_POST[ 'templateDescription' ] )
-			? $_POST[ 'templateDescription' ]
+		$template_description = defined("DOING_AJAX") && ! empty($_POST['templateDescription'])
+			? $_POST['templateDescription']
 			: sprintf(
 				__(
 					'This is a custom template that was created for the %s messenger and %s message type.',
 					'event_espresso'
 				),
-				$new_mtg->messenger_obj()->label[ 'singular' ],
-				$new_mtg->message_type_obj()->label[ 'singular' ]
+				$new_mtg->messenger_obj()->label['singular'],
+				$new_mtg->message_type_obj()->label['singular']
 			);
-		$new_mtg->set( 'MTP_name', $template_name );
-		$new_mtg->set( 'MTP_description', $template_description );
+		$new_mtg->set('MTP_name', $template_name);
+		$new_mtg->set('MTP_description', $template_description);
 		//remove ALL relations on this template group so they don't get saved!
-		$new_mtg->_remove_relations( 'Message_Template' );
+		$new_mtg->_remove_relations('Message_Template');
 		$new_mtg->save();
-		$success[ 'GRP_ID' ] = $new_mtg->ID();
-		$success[ 'template_name' ] = $template_name;
+		$success['GRP_ID'] = $new_mtg->ID();
+		$success['template_name'] = $template_name;
 		//add new message templates and add relation to.
-		foreach ( $message_templates as $message_template ) {
-			if ( ! $message_template instanceof EE_Message_Template ) {
+		foreach ($message_templates as $message_template) {
+			if ( ! $message_template instanceof EE_Message_Template) {
 				continue;
 			}
 			$new_message_template = clone $message_template;
-			$new_message_template->set( 'MTP_ID', 0 );
-			$new_message_template->set( 'GRP_ID', $new_mtg->ID() ); //relation
+			$new_message_template->set('MTP_ID', 0);
+			$new_message_template->set('GRP_ID', $new_mtg->ID()); //relation
 			$new_message_template->save();
-			if ( empty( $success[ 'MTP_context' ] ) ) {
-				$success[ 'MTP_context' ] = $new_message_template->get( 'MTP_context' );
+			if (empty($success['MTP_context'])) {
+				$success['MTP_context'] = $new_message_template->get('MTP_context');
 			}
 		}
 		return $success;
@@ -1151,7 +1151,7 @@ 
 		$global = false
 	) {
 		//is given message_type valid for given messenger (if this is not a global save)
-		if ( $global ) {
+		if ($global) {
 			return true;
 		}
 		$active_templates = EEM_Message_Template_Group::instance()->count(
@@ -1163,7 +1163,7 @@ 
 				)
 			)
 		);
-		if ( $active_templates > 0 ) {
+		if ($active_templates > 0) {
 			return true;
 		}
 		EE_Error::add_error(
@@ -1192,24 +1192,24 @@ 
 	 * @param  string $message_type_name name of EE_message_type
 	 * @return array
 	 */
-	public static function get_fields( $messenger_name, $message_type_name ) {
+	public static function get_fields($messenger_name, $message_type_name) {
 		$template_fields = array();
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		$messenger = $Message_Resource_Manager->valid_messenger( $messenger_name );
-		$message_type = $Message_Resource_Manager->valid_message_type( $message_type_name );
-		if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger( $messenger, $message_type ) ) {
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
 			return array();
 		}
 		//okay now let's assemble an array with the messenger template fields added to the message_type contexts.
-		foreach ( $message_type->get_contexts() as $context => $details ) {
-			foreach ( $messenger->get_template_fields() as $field => $value ) {
-				$template_fields[ $context ][ $field ] = $value;
+		foreach ($message_type->get_contexts() as $context => $details) {
+			foreach ($messenger->get_template_fields() as $field => $value) {
+				$template_fields[$context][$field] = $value;
 			}
 		}
-		if ( empty( $template_fields ) ) {
+		if (empty($template_fields)) {
 			EE_Error::add_error(
-				__( 'Something went wrong and we couldn\'t get any templates assembled', 'event_espresso' ),
+				__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__

Doc Comments +4 added lines, -3 removed lines

@@ -143,7 +143,7 @@ 
 	 * Updates all message templates matching the incoming messengers and message types to active status.
 	 *
 	 * @static
-	 * @param  array  $messenger_names     Messenger slug
+	 * @param  string[]  $messenger_names     Messenger slug
 	 * @param  array  $message_type_names  Message type slug
 	 * @return  int 						count of updated records.
 	 */
@@ -454,6 +454,7 @@ 
 	 * @param EE_Registration | null $registration  The registration object must be included if this
 	 *                                              is going to be a registration trigger url.
 	 * @param string $sending_messenger             The (optional) sending messenger for the url.
+	 * @param EE_Registration $registration
 	 *
 	 * @return string
 	 * @throws EE_Error
@@ -1008,8 +1009,8 @@ 
 	/**
 	 * @param \EE_messenger    $messenger
 	 * @param \EE_message_type $message_type
-	 * @param                  $GRP_ID
-	 * @param                  $global
+	 * @param                  integer $GRP_ID
+	 * @param                  boolean $global
 	 * @return array|mixed
 	 */
 	protected static function _create_new_templates( EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global ) {

Indentation +1 added lines, -1 removed lines

@@ -492,7 +492,7 @@
 		if ( ! empty( $sending_messenger ) ) {
 			$with_messengers = $message_type->with_messengers();
 			if ( ! isset( $with_messengers[$message->messenger()] )
-			     || ! in_array( $sending_messenger, $with_messengers[$message->messenger()] ) ) {
+				 || ! in_array( $sending_messenger, $with_messengers[$message->messenger()] ) ) {
 				throw new EE_Error(
 					sprintf(
 						__(

Braces +2 added lines, -1 removed lines

@@ -1,6 +1,7 @@
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso

core/libraries/messages/EE_Message_Factory.lib.php

Spacing +33 added lines, -33 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -53,10 +53,10 @@ 
 	 * @param \EE_Message_Resource_Manager $Message_Resource_Manager
 	 * @return \EE_Message_Factory instance
 	 */
-	public static function instance( EE_Message_Resource_Manager $Message_Resource_Manager ) {
+	public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager) {
 		// check if class object is instantiated, and instantiated properly
-		if ( ! self::$_instance instanceof EE_Message_Factory ) {
-			self::$_instance = new EE_Message_Factory( $Message_Resource_Manager );
+		if ( ! self::$_instance instanceof EE_Message_Factory) {
+			self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
 		}
 		return self::$_instance;
 	}
@@ -68,10 +68,10 @@ 
 	 * @param  array $props_n_values
 	 * @return mixed
 	 */
-	public static function create( $props_n_values = array() ) {
+	public static function create($props_n_values = array()) {
 		/** @type EE_Message_Factory $Message_Factory */
-		$Message_Factory = EE_Registry::instance()->load_lib( 'Message_Factory' );
-		return $Message_Factory->_create( $props_n_values );
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_create($props_n_values);
 	}
 
 
@@ -82,10 +82,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	public static function set_messenger_and_message_type( EE_Message $message ) {
+	public static function set_messenger_and_message_type(EE_Message $message) {
 		/** @type EE_Message_Factory $Message_Factory */
-		$Message_Factory = EE_Registry::instance()->load_lib( 'Message_Factory' );
-		return $Message_Factory->_set_messenger_and_message_type( $message );
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger_and_message_type($message);
 	}
 
 
@@ -96,10 +96,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	public static function set_messenger( EE_Message $message ) {
+	public static function set_messenger(EE_Message $message) {
 		/** @type EE_Message_Factory $Message_Factory */
-		$Message_Factory = EE_Registry::instance()->load_lib( 'Message_Factory' );
-		return $Message_Factory->_set_messenger( $message );
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger($message);
 	}
 
 
@@ -110,10 +110,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	public static function set_message_type( EE_Message $message ) {
+	public static function set_message_type(EE_Message $message) {
 		/** @type EE_Message_Factory $Message_Factory */
-		$Message_Factory = EE_Registry::instance()->load_lib( 'Message_Factory' );
-		return $Message_Factory->_set_message_type( $message );
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_message_type($message);
 	}
 
 
@@ -124,15 +124,15 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _create( $props_n_values = array() ) {
+	protected function _create($props_n_values = array()) {
 		$new_instance = false;
-		if ( ! empty( $props_n_values['MSG_ID'] ) ) {
-			$message = EE_Message::new_instance_from_db( $props_n_values );
+		if ( ! empty($props_n_values['MSG_ID'])) {
+			$message = EE_Message::new_instance_from_db($props_n_values);
 		} else {
-			$message = EE_Message::new_instance( $props_n_values );
+			$message = EE_Message::new_instance($props_n_values);
 			$new_instance = true;
 		}
-		return $this->_set_messenger_and_message_type( $message, $new_instance );
+		return $this->_set_messenger_and_message_type($message, $new_instance);
 	}
 
 
@@ -144,9 +144,9 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _set_messenger_and_message_type( EE_Message $message, $new_instance = false ) {
-		$message = $this->_set_messenger( $message );
-		$message = $this->_set_message_type( $message, $new_instance );
+	protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false) {
+		$message = $this->_set_messenger($message);
+		$message = $this->_set_message_type($message, $new_instance);
 		return $message;
 	}
 
@@ -158,10 +158,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _set_messenger( EE_Message $message ) {
-		$messenger = $this->_message_resource_manager->get_messenger( $message->messenger() );
-		if ( $messenger instanceof EE_messenger ) {
-			$message->set_messenger_object( $messenger );
+	protected function _set_messenger(EE_Message $message) {
+		$messenger = $this->_message_resource_manager->get_messenger($message->messenger());
+		if ($messenger instanceof EE_messenger) {
+			$message->set_messenger_object($messenger);
 		}
 		return $message;
 	}
@@ -175,10 +175,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _set_message_type( EE_Message $message, $new_instance = false ) {
-		$message_type = $this->_message_resource_manager->get_message_type( $message->message_type() );
-		if ( $message_type instanceof EE_message_type ) {
-			$message->set_message_type_object( $message_type, $new_instance );
+	protected function _set_message_type(EE_Message $message, $new_instance = false) {
+		$message_type = $this->_message_resource_manager->get_message_type($message->message_type());
+		if ($message_type instanceof EE_message_type) {
+			$message->set_message_type_object($message_type, $new_instance);
 		}
 		return $message;
 	}

core/libraries/messages/EE_Message_Generated_From_Token.php

Spacing +12 added lines, -12 removed lines

@@ -36,9 +36,9 @@ 
 	 *                                                This is then used to populate the properties in here.
 	 * @param   EE_Message_Resource_Manager $message_resource_manager
 	 */
-	public function __construct( $token, $sending_messenger_slug = 'html', EE_Message_Resource_Manager $message_resource_manager ) {
+	public function __construct($token, $sending_messenger_slug = 'html', EE_Message_Resource_Manager $message_resource_manager) {
 		$this->token = $token;
-		$this->_sending_messenger = $this->_set_sending_messenger( $sending_messenger_slug, $message_resource_manager );
+		$this->_sending_messenger = $this->_set_sending_messenger($sending_messenger_slug, $message_resource_manager);
 		$this->_message = $this->_generate_message();
 		//set params for parent from the message object
 		parent::__construct(
@@ -61,7 +61,7 @@ 
 		$sending_messenger_slug,
 		EE_Message_Resource_Manager $message_resource_manager
 	) {
-		$sending_messenger = $message_resource_manager->get_active_messenger( $sending_messenger_slug );
+		$sending_messenger = $message_resource_manager->get_active_messenger($sending_messenger_slug);
 		return $sending_messenger instanceof EE_messenger ? $sending_messenger : $sending_messenger_slug;
 	}
 
@@ -83,27 +83,27 @@ 
 	 * @return EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _generate_message( $properties = array() ) {
+	protected function _generate_message($properties = array()) {
 		// a message was generated immediately but the parent class will call this again
-		if ( $this->_message instanceof EE_Message ) {
+		if ($this->_message instanceof EE_Message) {
 			return $this->_message;
 		}
-		$message = EEM_Message::instance()->get_one_by_token( $this->token );
-		if ( ! $message instanceof EE_Message ) {
+		$message = EEM_Message::instance()->get_one_by_token($this->token);
+		if ( ! $message instanceof EE_Message) {
 			throw new EE_Error(
 				sprintf(
-					__( 'Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso' ),
+					__('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
 					$this->token
 				)
 			);
 		}
-		$message->set_STS_ID( EEM_Message::status_idle );
+		$message->set_STS_ID(EEM_Message::status_idle);
 
-		if ( ! $this->_sending_messenger instanceof EE_messenger ) {
-			$message->set_STS_ID( EEM_Message::status_failed );
+		if ( ! $this->_sending_messenger instanceof EE_messenger) {
+			$message->set_STS_ID(EEM_Message::status_failed);
 			$message->set_error_message(
 				sprintf(
-					__( 'Unable to send message because the "%1$s" messenger is not active or not installed', 'event_espresso' ),
+					__('Unable to send message because the "%1$s" messenger is not active or not installed', 'event_espresso'),
 					$this->_sending_messenger
 				)
 			);

core/libraries/messages/EE_Message_Template_Group_Collection.lib.php

Spacing +14 added lines, -14 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -28,14 +28,14 @@ 
 	 *                       indexing the template by key.
 	 * @return bool
 	 */
-	public function add( $message_template_group, $EVT_ID = null ) {
-		if ( $message_template_group instanceof $this->interface ) {
-			$data[ 'key' ] = $this->get_key(
+	public function add($message_template_group, $EVT_ID = null) {
+		if ($message_template_group instanceof $this->interface) {
+			$data['key'] = $this->get_key(
 				$message_template_group->messenger(),
 				$message_template_group->message_type(),
 				$EVT_ID
 			);
-			return parent::add( $message_template_group, $data );
+			return parent::add($message_template_group, $data);
 		}
 		return false;
 	}
@@ -48,10 +48,10 @@ 
 	 * @param $GRP_ID
 	 * @return EE_Message_Template_Group | null
 	 */
-	public function get_by_ID( $GRP_ID ) {
+	public function get_by_ID($GRP_ID) {
 		$this->rewind();
-		while ( $this->valid() ) {
-			if ( $this->current()->ID() === $GRP_ID ) {
+		while ($this->valid()) {
+			if ($this->current()->ID() === $GRP_ID) {
 				$grp = $this->current();
 				$this->rewind();
 				return $grp;
@@ -73,8 +73,8 @@ 
 	 *
 	 * @return string
 	 */
-	public function get_key( $messenger, $message_type, $EVT_ID = 0 ) {
-		return md5( $messenger.$message_type.$EVT_ID );
+	public function get_key($messenger, $message_type, $EVT_ID = 0) {
+		return md5($messenger.$message_type.$EVT_ID);
 	}
 
 
@@ -86,11 +86,11 @@ 
 	 *
 	 * @return null|EE_Message_Template_Group
 	 */
-	public function get_by_key( $key ) {
+	public function get_by_key($key) {
 		$this->rewind();
-		while ( $this->valid() ) {
+		while ($this->valid()) {
 			$data = $this->getInfo();
-			if ( isset( $data['key'] ) && $data['key'] === $key ) {
+			if (isset($data['key']) && $data['key'] === $key) {
 				$handler = $this->current();
 				$this->rewind();
 				return $handler;

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
 
 	/**
 	 * This retrieves any EE_Message_Template_Group in the repo by its ID.
-	 * @param $GRP_ID
+	 * @param integer $GRP_ID
 	 * @return EE_Message_Template_Group | null
 	 */
 	public function get_by_ID( $GRP_ID ) {

core/libraries/messages/EE_Message_Type_Collection_Loader.lib.php

Spacing +19 added lines, -19 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -31,8 +31,8 @@ 
 	 *
 	 * @param EE_Message_Type_Collection $message_types
 	 */
-	public function __construct( EE_Message_Type_Collection $message_types ) {
-		$this->set_message_type_collection( $message_types );
+	public function __construct(EE_Message_Type_Collection $message_types) {
+		$this->set_message_type_collection($message_types);
 	}
 
 
@@ -49,7 +49,7 @@ 
 	/**
 	 * @param mixed $message_types
 	 */
-	public function set_message_type_collection( EE_Message_Type_Collection $message_types ) {
+	public function set_message_type_collection(EE_Message_Type_Collection $message_types) {
 		$this->_message_type_collection = $message_types;
 	}
 
@@ -62,41 +62,41 @@ 
 	 * @param  string $folder
 	 * @throws \EE_Error
 	 */
-	public function load_message_types_from_folder( $folder = '' ) {
+	public function load_message_types_from_folder($folder = '') {
 		//make sure autoloaders are set (fail-safe)
 		EED_Messages::set_autoloaders();
-		$folder = ! empty( $folder ) ? $folder : EE_LIBRARIES . 'messages' . DS . 'message_type';
-		$folder .= $folder[ strlen( $folder ) - 1 ] != DS ? DS : '';
+		$folder = ! empty($folder) ? $folder : EE_LIBRARIES.'messages'.DS.'message_type';
+		$folder .= $folder[strlen($folder) - 1] != DS ? DS : '';
 		// get all the files in that folder that end in ".class.php
 		$filepaths = apply_filters(
 			'FHEE__EE_messages__get_installed__messagetype_files',
-			glob( $folder . '*.class.php' )
+			glob($folder.'*.class.php')
 		);
-		if ( empty( $filepaths ) ) {
+		if (empty($filepaths)) {
 			return;
 		}
-		foreach ( (array) $filepaths as $file_path ) {
+		foreach ((array) $filepaths as $file_path) {
 			// extract filename from path
-			$file_path = basename( $file_path );
+			$file_path = basename($file_path);
 			// now remove any file extensions
-			$message_type_class_name = substr( $file_path, 0, strpos( $file_path, '.' ) );
+			$message_type_class_name = substr($file_path, 0, strpos($file_path, '.'));
 
 			//if this class name doesn't represent a message type class, then we just skip.
-			if ( strpos( strtolower( $message_type_class_name ), 'message_type' ) === false ) {
+			if (strpos(strtolower($message_type_class_name), 'message_type') === false) {
 				continue;
 			}
 
-			if ( ! class_exists( $message_type_class_name ) ) {
+			if ( ! class_exists($message_type_class_name)) {
 				throw new EE_Error(
 					sprintf(
-						__( 'The "%1$s" message type class can\'t be loaded from %2$s. Likely there is a typo in the class name or the file name.', 'event_espresso' ),
+						__('The "%1$s" message type class can\'t be loaded from %2$s. Likely there is a typo in the class name or the file name.', 'event_espresso'),
 						$message_type_class_name,
 						$file_path
 					)
 				);
 			}
 
-			$this->_load_message_type( new $message_type_class_name );
+			$this->_load_message_type(new $message_type_class_name);
 		}
 	}
 
@@ -106,8 +106,8 @@ 
 	 * @param EE_message_type $message_type
 	 * @return bool
 	 */
-	protected function _load_message_type( EE_message_type $message_type ) {
-		if ( $this->message_type_collection()->has_by_name( $message_type->name ) ) {
+	protected function _load_message_type(EE_message_type $message_type) {
+		if ($this->message_type_collection()->has_by_name($message_type->name)) {
 			return true;
 		}
 		return $this->message_type_collection()->add(

core/libraries/messages/EE_Messages_Base.lib.php

Spacing +21 added lines, -21 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -184,9 +184,9 @@ 
 	 * @access protected
 	 * @param string $messenger
 	 */
-	protected function _set_existing_admin_settings( $messenger = '' ) {
+	protected function _set_existing_admin_settings($messenger = '') {
 		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		$active_messengers = $Message_Resource_Manager->get_active_messengers_option();
 		$settings_to_use = $active_messengers;
 
@@ -194,14 +194,14 @@ 
 		 * This determines what will be used for the getting the settings.
 		 */
 		if (
-			! empty( $messenger )
-			&& $Message_Resource_Manager->is_message_type_active_for_messenger( $messenger, $this->name )
+			! empty($messenger)
+			&& $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
 		) {
-			$settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+			$settings_to_use = $active_messengers[$messenger]['settings'][$messenger.'-message_types'];
 		}
 
-		$this->_existing_admin_settings = isset( $settings_to_use[ $this->name ]['settings'] )
-			? $settings_to_use[ $this->name ]['settings']
+		$this->_existing_admin_settings = isset($settings_to_use[$this->name]['settings'])
+			? $settings_to_use[$this->name]['settings']
 			: null;
 	}
 
@@ -218,12 +218,12 @@ 
 	 * @param string $messenger
 	 * @return array          settings
 	 */
-	public function get_existing_admin_settings( $messenger = '' ) {
+	public function get_existing_admin_settings($messenger = '') {
 		// if admin_settings property empty lets try setting it.
-		if ( method_exists($this, '_set_existing_admin_settings') && empty( $this->_existing_admin_settings ) ) {
-			$this->_set_existing_admin_settings( $messenger );
+		if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
+			$this->_set_existing_admin_settings($messenger);
 		}
-		return property_exists( $this, '_existing_admin_settings' )
+		return property_exists($this, '_existing_admin_settings')
 			? $this->_existing_admin_settings
 			: null;
 	}
@@ -239,12 +239,12 @@ 
 	 */
 	public function get_valid_shortcodes() {
 		$valid_shortcodes = apply_filters(
-			'FHEE__' . get_class( $this ) . '__get_valid_shortcodes',
+			'FHEE__'.get_class($this).'__get_valid_shortcodes',
 			$this->_valid_shortcodes,
 			$this
 		);
 		//The below filter applies to ALL messengers and message types so use with care!
-		$valid_shortcodes = apply_filters( 'FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this );
+		$valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
 		return $valid_shortcodes;
 	}
 
@@ -278,23 +278,23 @@ 
 	 * @access protected
 	 * @return string $content for page.
 	 */
-	protected function _get_admin_page_content( $page, $action, $extra, $actives ) {
+	protected function _get_admin_page_content($page, $action, $extra, $actives) {
 		//we can also further refine the context by action (if present).
-		if ( !empty($action) ) {
-			$page = $page . '_' . $action;
+		if ( ! empty($action)) {
+			$page = $page.'_'.$action;
 		}
 
-		if ( !isset( $this->admin_registered_pages[$page]) ){
+		if ( ! isset($this->admin_registered_pages[$page])) {
 			// todo: a place to throw an exception?
 			// We need to indicate there is no registered page so this function is not being called correctly.
 			return false;
 		}
 		//k made it here so let's call the method
 		$content = call_user_func_array(
-			array( $this, '_get_admin_content_' . $page ),
-			array( $actives, $extra )
+			array($this, '_get_admin_content_'.$page),
+			array($actives, $extra)
 		);
-		if ( $content === false ) {
+		if ($content === false) {
 			// todo this needs to be an exception once we've got exceptions in place.
 			return false;
 		}

Braces +2 added lines, -1 removed lines

@@ -1,6 +1,7 @@
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * EE_Messages_Base class

core/libraries/messages/EE_Messages_Data_Handler_Collection.lib.php

Spacing +9 added lines, -9 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('No direct script access allowed');
 
 
@@ -26,10 +26,10 @@ 
 	 *                                                   classname to create an alternative index for retrieving data_handlers.
 	 * @return bool
 	 */
-	public function add( $data_handler, $data = null) {
+	public function add($data_handler, $data = null) {
 		$data = $data === null ? array() : (array) $data;
-		$info['key'] = $this->get_key( get_class( $data_handler ), $data );
-		return parent::add( $data_handler, $info );
+		$info['key'] = $this->get_key(get_class($data_handler), $data);
+		return parent::add($data_handler, $info);
 	}
 	
 
@@ -44,8 +44,8 @@ 
 	 *
 	 * @return  string      md5 hash using provided info.
 	 */
-	public function get_key( $classname, $data ) {
-		return md5( $classname . print_r( $data, true ) );
+	public function get_key($classname, $data) {
+		return md5($classname.print_r($data, true));
 	}
 
 
@@ -61,11 +61,11 @@ 
 	 *
 	 * @return null|EE_Messages_incoming_data
 	 */
-	public function get_by_key( $key ) {
+	public function get_by_key($key) {
 		$this->rewind();
-		while( $this->valid() ) {
+		while ($this->valid()) {
 			$data = $this->getInfo();
-			if ( isset( $data['key'] ) && $data['key'] === $key ) {
+			if (isset($data['key']) && $data['key'] === $key) {
 				$handler = $this->current();
 				$this->rewind();
 				return $handler;

Braces +2 added lines, -1 removed lines

@@ -1,6 +1,7 @@
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if (!defined('EVENT_ESPRESSO_VERSION')) {
 	exit('No direct script access allowed');
+}
 
 
 /**

core/libraries/messages/EE_Messages_Template_Pack_Collection.lib.php

Spacing +4 added lines, -4 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('No direct script access allowed');
 
 
@@ -17,10 +17,10 @@ 
 		$this->interface = 'EE_Messages_Template_Pack';
 	}
 
-	public function get_by_name( $template_pack_name ) {
+	public function get_by_name($template_pack_name) {
 		$this->rewind();
-		while ( $this->valid() ) {
-			if ( $this->current()->dbref == $template_pack_name ) {
+		while ($this->valid()) {
+			if ($this->current()->dbref == $template_pack_name) {
 				return $this->current();
 			}
 			$this->next();

Braces +2 added lines, -1 removed lines

@@ -1,6 +1,7 @@
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if (!defined('EVENT_ESPRESSO_VERSION')) {
 	exit('No direct script access allowed');
+}
 
 
 /**

core/libraries/messages/EE_Messenger_Collection_Loader.lib.php

Spacing +22 added lines, -22 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -32,8 +32,8 @@ 
 	 *
 	 * @param EE_Messenger_Collection $messengers
 	 */
-	public function __construct( EE_Messenger_Collection $messengers ) {
-		$this->set_messenger_collection( $messengers );
+	public function __construct(EE_Messenger_Collection $messengers) {
+		$this->set_messenger_collection($messengers);
 	}
 
 
@@ -50,7 +50,7 @@ 
 	/**
 	 * @param mixed $messengers
 	 */
-	public function set_messenger_collection( EE_Messenger_Collection $messengers ) {
+	public function set_messenger_collection(EE_Messenger_Collection $messengers) {
 		$this->_messenger_collection = $messengers;
 	}
 
@@ -63,41 +63,41 @@ 
 	 * @param  string $folder
 	 * @throws \EE_Error
 	 */
-	public function load_messengers_from_folder( $folder = '' ) {
+	public function load_messengers_from_folder($folder = '') {
 		//make sure autoloaders are set (fail-safe)
 		EED_Messages::set_autoloaders();
-		$folder = ! empty( $folder ) ? $folder : EE_LIBRARIES . 'messages' . DS . 'messenger';
-		$folder .= $folder[ strlen( $folder ) - 1 ] != DS ? DS : '';
+		$folder = ! empty($folder) ? $folder : EE_LIBRARIES.'messages'.DS.'messenger';
+		$folder .= $folder[strlen($folder) - 1] != DS ? DS : '';
 		// get all the files in that folder that end in ".class.php
 		$filepaths = apply_filters(
 			'FHEE__EE_messages__get_installed__messenger_files',
-			glob( $folder . '*.class.php' )
+			glob($folder.'*.class.php')
 		);
-		if ( empty( $filepaths ) ) {
+		if (empty($filepaths)) {
 			return;
 		}
-		foreach ( (array) $filepaths as $file_path ) {
+		foreach ((array) $filepaths as $file_path) {
 			// extract filename from path
-			$file_path = basename( $file_path );
+			$file_path = basename($file_path);
 			// now remove any file extensions
-			$messenger_class_name = substr( $file_path, 0, strpos( $file_path, '.' ) );
+			$messenger_class_name = substr($file_path, 0, strpos($file_path, '.'));
 
 			//first check to see if the class name represents an actual messenger class.
-			if ( strpos( strtolower( $messenger_class_name ), 'messenger' ) === false ) {
+			if (strpos(strtolower($messenger_class_name), 'messenger') === false) {
 				continue;
 			}
 
-			if ( ! class_exists( $messenger_class_name ) ) {
+			if ( ! class_exists($messenger_class_name)) {
 				throw new EE_Error(
 					sprintf(
-						__( 'The "%1$s" messenger class can\'t be loaded from %2$s.  Likely there is a typo in the class name or the file name.', 'event_espresso' ),
+						__('The "%1$s" messenger class can\'t be loaded from %2$s.  Likely there is a typo in the class name or the file name.', 'event_espresso'),
 						$messenger_class_name,
 						$file_path
 					)
 				);
 			}
 
-			$this->_load_messenger( new $messenger_class_name() );
+			$this->_load_messenger(new $messenger_class_name());
 		}
 	}
 
@@ -113,10 +113,10 @@ 
 		EED_Messages::set_autoloaders();
 		$active_messengers = apply_filters(
 			'FHEE__EEH_MSG_Template__get_active_messengers_in_db',
-			get_option( 'ee_active_messengers', array() )
+			get_option('ee_active_messengers', array())
 		);
-		foreach ( (array) $active_messengers as $active_messenger_classname => $active_messenger ) {
-			$this->_load_messenger( $active_messenger );
+		foreach ((array) $active_messengers as $active_messenger_classname => $active_messenger) {
+			$this->_load_messenger($active_messenger);
 		}
 	}
 
@@ -128,8 +128,8 @@ 
 	 * @param \EE_messenger $messenger
 	 * @return bool
 	 */
-	protected function _load_messenger( EE_messenger $messenger ) {
-		if ( $this->messenger_collection()->has_by_name( $messenger->name ) ) {
+	protected function _load_messenger(EE_messenger $messenger) {
+		if ($this->messenger_collection()->has_by_name($messenger->name)) {
 			return true;
 		}
 		return $this->messenger_collection()->add(