eventespresso / event-espresso-core

core/libraries/messages/EE_Messages_Queue.lib.php

Spacing +92 added lines, -92 removed lines

@@ -71,8 +71,8 @@ 
 	 *
 	 * @param \EE_Message_Repository       $message_repository
 	 */
-	public function __construct( EE_Message_Repository $message_repository ) {
-		$this->_batch_count        = apply_filters( 'FHEE__EE_Messages_Queue___batch_count', 50 );
+	public function __construct(EE_Message_Repository $message_repository) {
+		$this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
 		$this->_rate_limit         = $this->get_rate_limit();
 		$this->_message_repository = $message_repository;
 	}
@@ -91,10 +91,10 @@ 
 	 *                                 use the messenger send method but typically is based on preview data.
 	 * @return bool          Whether the message was successfully added to the repository or not.
 	 */
-	public function add( EE_Message $message, $data = array(), $preview = false, $test_send = false ) {
+	public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false) {
 		$data['preview'] = $preview;
 		$data['test_send'] = $test_send;
-		return $this->_message_repository->add( $message, $data );
+		return $this->_message_repository->add($message, $data);
 	}
 
 
@@ -106,13 +106,13 @@ 
 	 * @param bool          $persist    This flag indicates whether to attempt to delete the object from the db as well.
 	 * @return bool
 	 */
-	public function remove( EE_Message $message, $persist = false ) {
-		if ( $persist && $this->_message_repository->current() !== $message ) {
+	public function remove(EE_Message $message, $persist = false) {
+		if ($persist && $this->_message_repository->current() !== $message) {
 			//get pointer on right message
-			if ( $this->_message_repository->has( $message ) ) {
+			if ($this->_message_repository->has($message)) {
 				$this->_message_repository->rewind();
-				while( $this->_message_repository->valid() ) {
-					if ( $this->_message_repository->current() === $message ) {
+				while ($this->_message_repository->valid()) {
+					if ($this->_message_repository->current() === $message) {
 						break;
 					}
 					$this->_message_repository->next();
@@ -121,7 +121,7 @@ 
 				return false;
 			}
 		}
-		return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove( $message );
+		return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
 	}
 
 
@@ -161,29 +161,29 @@ 
 	 * @return bool  true if successfully retrieved batch, false no batch ready.
 	 */
 	public function get_batch_to_generate() {
-		if ( $this->is_locked( EE_Messages_Queue::action_generating ) ) {
+		if ($this->is_locked(EE_Messages_Queue::action_generating)) {
 			return false;
 		}
 
 		//lock batch generation to prevent race conditions.
-		$this->lock_queue( EE_Messages_Queue::action_generating );
+		$this->lock_queue(EE_Messages_Queue::action_generating);
 
 		$query_args = array(
 			// key 0 = where conditions
-			0 => array( 'STS_ID' => EEM_Message::status_incomplete ),
+			0 => array('STS_ID' => EEM_Message::status_incomplete),
 			'order_by' => $this->_get_priority_orderby(),
 			'limit' => $this->_batch_count
 		);
-		$messages = EEM_Message::instance()->get_all( $query_args );
+		$messages = EEM_Message::instance()->get_all($query_args);
 
-		if ( ! $messages ) {
+		if ( ! $messages) {
 			return false; //nothing to generate
 		}
 
-		foreach ( $messages as $message ) {
-			if ( $message instanceof EE_Message ) {
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
 				$data = $message->all_extra_meta_array();
-				$this->add( $message, $data );
+				$this->add($message, $data);
 			}
 		}
 		return true;
@@ -206,34 +206,34 @@ 
 	 *               to assist with notifying user.
 	 */
 	public function get_to_send_batch_and_send() {
-		if ( $this->is_locked( EE_Messages_Queue::action_sending ) || $this->_rate_limit < 1 ) {
+		if ($this->is_locked(EE_Messages_Queue::action_sending) || $this->_rate_limit < 1) {
 			return false;
 		}
 
-		$this->lock_queue( EE_Messages_Queue::action_sending );
+		$this->lock_queue(EE_Messages_Queue::action_sending);
 
 		$batch = $this->_batch_count < $this->_rate_limit ? $this->_batch_count : $this->_rate_limit;
 
 		$query_args = array(
 			// key 0 = where conditions
-			0 => array( 'STS_ID' => array( 'IN', EEM_Message::instance()->stati_indicating_to_send() ) ),
+			0 => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
 			'order_by' => $this->_get_priority_orderby(),
 			'limit' => $batch
 		);
 
-		$messages_to_send = EEM_Message::instance()->get_all( $query_args );
+		$messages_to_send = EEM_Message::instance()->get_all($query_args);
 
 
 		//any to send?
-		if ( ! $messages_to_send ) {
-			$this->unlock_queue( EE_Messages_Queue::action_sending );
+		if ( ! $messages_to_send) {
+			$this->unlock_queue(EE_Messages_Queue::action_sending);
 			return false;
 		}
 
 		//add to queue.
-		foreach ( $messages_to_send as $message ) {
-			if ( $message instanceof EE_Message ) {
-				$this->add( $message );
+		foreach ($messages_to_send as $message) {
+			if ($message instanceof EE_Message) {
+				$this->add($message);
 			}
 		}
 
@@ -241,7 +241,7 @@ 
 		$this->execute();
 
 		//release lock
-		$this->unlock_queue( EE_Messages_Queue::action_sending );
+		$this->unlock_queue(EE_Messages_Queue::action_sending);
 		return true;
 	}
 
@@ -253,8 +253,8 @@ 
 	 *
 	 * @param   string  $type   The type of queue being locked.
 	 */
-	public function lock_queue( $type = EE_Messages_Queue::action_generating ) {
-		set_transient( $this->_get_lock_key( $type ), 1, $this->_get_lock_expiry( $type ) );
+	public function lock_queue($type = EE_Messages_Queue::action_generating) {
+		set_transient($this->_get_lock_key($type), 1, $this->_get_lock_expiry($type));
 	}
 
 
@@ -265,8 +265,8 @@ 
 	 *
 	 * @param   string  $type   The type of queue being unlocked.
 	 */
-	public function unlock_queue( $type = EE_Messages_Queue::action_generating ) {
-		delete_transient( $this->_get_lock_key( $type ) );
+	public function unlock_queue($type = EE_Messages_Queue::action_generating) {
+		delete_transient($this->_get_lock_key($type));
 	}
 
 
@@ -277,8 +277,8 @@ 
 	 * @param string $type  The type of lock.
 	 * @return string
 	 */
-	protected function _get_lock_key( $type = EE_Messages_Queue::action_generating ) {
-		return '_ee_lock_' . $type;
+	protected function _get_lock_key($type = EE_Messages_Queue::action_generating) {
+		return '_ee_lock_'.$type;
 	}
 
 
@@ -289,8 +289,8 @@ 
 	 * @param string $type  The type of lock
 	 * @return int   time to expiry in seconds.
 	 */
-	protected function _get_lock_expiry( $type = EE_Messages_Queue::action_generating ) {
-		return (int) apply_filters( 'FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type );
+	protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating) {
+		return (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
 	}
 
 
@@ -308,7 +308,7 @@ 
 	 * @return int
 	 */
 	protected function _get_rate_limit_expiry() {
-		return (int) apply_filters( 'FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS );
+		return (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
 	}
 
 
@@ -319,7 +319,7 @@ 
 	 * @return int
 	 */
 	protected function _default_rate_limit() {
-		return (int) apply_filters( 'FHEE__EE_Messages_Queue___rate_limit', 200 );
+		return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
 	}
 
 
@@ -345,11 +345,11 @@ 
 	 * @param  string $type The type of lock being checked for.
 	 * @return bool
 	 */
-	public function is_locked( $type = EE_Messages_Queue::action_generating ) {
+	public function is_locked($type = EE_Messages_Queue::action_generating) {
 		return filter_var(
 			apply_filters(
 				'FHEE__EE_Messages_Queue__is_locked',
-				get_transient( $this->_get_lock_key( $type ) ),
+				get_transient($this->_get_lock_key($type)),
 				$this
 			),
 			FILTER_VALIDATE_BOOLEAN
@@ -368,9 +368,9 @@ 
 	 * @return int
 	 */
 	public function get_rate_limit() {
-		if ( ! $rate_limit = get_transient( $this->_get_rate_limit_key() ) ) {
+		if ( ! $rate_limit = get_transient($this->_get_rate_limit_key())) {
 			$rate_limit = $this->_default_rate_limit();
-			set_transient( $this->_get_rate_limit_key(), $rate_limit, $this->_get_rate_limit_key() );
+			set_transient($this->_get_rate_limit_key(), $rate_limit, $this->_get_rate_limit_key());
 		}
 		return $rate_limit;
 	}
@@ -382,12 +382,12 @@ 
 	 * This updates existing rate limit with the new limit which is the old minus the batch.
 	 * @param int $batch_completed  This sets the new rate limit based on the given batch that was completed.
 	 */
-	public function set_rate_limit( $batch_completed ) {
+	public function set_rate_limit($batch_completed) {
 		//first get the most up to date rate limit (in case its expired and reset)
 		$rate_limit = $this->get_rate_limit();
 		$new_limit = $rate_limit - $batch_completed;
 		//updating the transient option directly to avoid resetting the expiry.
-		update_option( '_transient_' . $this->_get_rate_limit_key(), $new_limit );
+		update_option('_transient_'.$this->_get_rate_limit_key(), $new_limit);
 	}
 
 
@@ -400,7 +400,7 @@ 
 	 * @param string $task This indicates what type of request is going to be initiated.
 	 * @param int    $priority  This indicates the priority that triggers initiating the request.
 	 */
-	public function initiate_request_by_priority( $task = 'generate', $priority = EEM_Message::priority_high ) {
+	public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high) {
 		//determine what status is matched with the priority as part of the trigger conditions.
 		$status = $task == 'generate'
 			? EEM_Message::status_incomplete
@@ -408,8 +408,8 @@ 
 		// always make sure we save because either this will get executed immediately on a separate request
 		// or remains in the queue for the regularly scheduled queue batch.
 		$this->save();
-		if ( $this->_message_repository->count_by_priority_and_status( $priority, $status ) ) {
-			EE_Messages_Scheduler::initiate_scheduled_non_blocking_request( $task );
+		if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
+			EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
 		}
 	}
 
@@ -434,53 +434,53 @@ 
 	 *                    Also, if the messenger is an request type messenger (or a preview),
 	 * 					  its entirely possible that the messenger will exit before
 	 */
-	public function execute( $save = true, $sending_messenger = null, $by_priority = false ) {
+	public function execute($save = true, $sending_messenger = null, $by_priority = false) {
 		$messages_sent = 0;
 		$this->_did_hook = array();
 		$this->_message_repository->rewind();
 
-		while ( $this->_message_repository->valid() ) {
+		while ($this->_message_repository->valid()) {
 			$error_messages = array();
 			/** @type EE_Message $message */
 			$message = $this->_message_repository->current();
 			//if the message in the queue has a sent status, then skip
-			if ( in_array( $message->STS_ID(), EEM_Message::instance()->stati_indicating_sent() ) ) {
+			if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_sent())) {
 				$this->_message_repository->next();
 				continue;
 			}
 			//if $by_priority is set and does not match then continue;
-			if ( $by_priority && $by_priority != $message->priority() ) {
+			if ($by_priority && $by_priority != $message->priority()) {
 				$this->_message_repository->next();
 				continue;
 			}
 			//error checking
-			if ( ! $message->valid_messenger() ) {
+			if ( ! $message->valid_messenger()) {
 				$error_messages[] = sprintf(
-					__( 'The %s messenger is not active at time of sending.', 'event_espresso' ),
+					__('The %s messenger is not active at time of sending.', 'event_espresso'),
 					$message->messenger()
 				);
 			}
-			if ( ! $message->valid_message_type() ) {
+			if ( ! $message->valid_message_type()) {
 				$error_messages[] = sprintf(
-					__( 'The %s message type is not active at the time of sending.', 'event_espresso' ),
+					__('The %s message type is not active at the time of sending.', 'event_espresso'),
 					$message->message_type()
 				);
 			}
 			// if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
 			// then it will instead be an EE_Error object, so let's check for that
-			if ( $sending_messenger instanceof EE_Error ) {
+			if ($sending_messenger instanceof EE_Error) {
 				$error_messages[] = $sending_messenger->getMessage();
 			}
 			// if there are no errors, then let's process the message
-			if ( empty( $error_messages ) && $this->_process_message( $message, $sending_messenger ) ) {
+			if (empty($error_messages) && $this->_process_message($message, $sending_messenger)) {
 				$messages_sent++;
 			}
-			$this->_set_error_message( $message, $error_messages );
+			$this->_set_error_message($message, $error_messages);
 			//add modified time
-			$message->set_modified( time() );
+			$message->set_modified(time());
 			$this->_message_repository->next();
 		}
-		if ( $save ) {
+		if ($save) {
 			$this->save();
 		}
 		return $messages_sent;
@@ -495,7 +495,7 @@ 
 	 * @param mixed 	 $sending_messenger (optional)
 	 * @return bool
 	 */
-	protected function _process_message( EE_Message $message, $sending_messenger = null ) {
+	protected function _process_message(EE_Message $message, $sending_messenger = null) {
 		// these *should* have been validated in the execute() method above
 		$messenger = $message->messenger_object();
 		$message_type = $message->message_type_object();
@@ -505,20 +505,20 @@ 
 			&& $messenger instanceof EE_messenger
 			&& $sending_messenger->name != $messenger->name
 		) {
-			$messenger->do_secondary_messenger_hooks( $sending_messenger->name );
+			$messenger->do_secondary_messenger_hooks($sending_messenger->name);
 			$messenger = $sending_messenger;
 		}
 		// send using messenger, but double check objects
-		if ( $messenger instanceof EE_messenger && $message_type instanceof EE_message_type ) {
+		if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
 			//set hook for message type (but only if not using another messenger to send).
-			if ( ! isset( $this->_did_hook[ $message_type->name ] ) ) {
-				$message_type->do_messenger_hooks( $messenger );
-				$this->_did_hook[ $message_type->name ] = 1;
+			if ( ! isset($this->_did_hook[$message_type->name])) {
+				$message_type->do_messenger_hooks($messenger);
+				$this->_did_hook[$message_type->name] = 1;
 			}
 			//if preview then use preview method
 			return $this->_message_repository->is_preview()
-				? $this->_do_preview( $message, $messenger, $message_type, $this->_message_repository->is_test_send() )
-				: $this->_do_send( $message, $messenger, $message_type );
+				? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
+				: $this->_do_send($message, $messenger, $message_type);
 		}
 		return false;
 	}
@@ -536,12 +536,12 @@ 
 	 * @param array $status  Stati to check for in queue
 	 * @return int  Count of EE_Message's matching the given status.
 	 */
-	public function count_STS_in_queue( $status ) {
+	public function count_STS_in_queue($status) {
 		$count = 0;
-		$status = is_array( $status ) ? $status : array( $status );
+		$status = is_array($status) ? $status : array($status);
 		$this->_message_repository->rewind();
-		foreach( $this->_message_repository as $message ) {
-			if ( in_array( $message->STS_ID(), $status ) ) {
+		foreach ($this->_message_repository as $message) {
+			if (in_array($message->STS_ID(), $status)) {
 				$count++;
 			}
 		}
@@ -558,15 +558,15 @@ 
 	 * @param $test_send
 	 * @return bool   true means all went well, false means, not so much.
 	 */
-	protected function _do_preview( EE_Message $message, EE_messenger $messenger, EE_message_type $message_type, $test_send ) {
-		if ( $preview = $messenger->get_preview( $message, $message_type, $test_send ) ) {
-			if ( ! $test_send ) {
-				$message->set_content( $preview );
+	protected function _do_preview(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type, $test_send) {
+		if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
+			if ( ! $test_send) {
+				$message->set_content($preview);
 			}
-			$message->set_STS_ID( EEM_Message::status_sent );
+			$message->set_STS_ID(EEM_Message::status_sent);
 			return true;
 		} else {
-			$message->set_STS_ID( EEM_Message::status_failed );
+			$message->set_STS_ID(EEM_Message::status_failed);
 			return false;
 		}
 	}
@@ -582,12 +582,12 @@ 
 	 * @param EE_message_type $message_type
 	 * @return bool true means all went well, false means, not so much.
 	 */
-	protected function _do_send( EE_Message $message, EE_messenger $messenger, EE_message_type $message_type ) {
-		if ( $messenger->send_message( $message, $message_type ) ) {
-			$message->set_STS_ID( EEM_Message::status_sent );
+	protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type) {
+		if ($messenger->send_message($message, $message_type)) {
+			$message->set_STS_ID(EEM_Message::status_sent);
 			return true;
 		} else {
-			$message->set_STS_ID( EEM_Message::status_retry );
+			$message->set_STS_ID(EEM_Message::status_retry);
 			return false;
 		}
 	}
@@ -601,21 +601,21 @@ 
 	 * @param EE_Message $message
 	 * @param array      $error_messages the response from the messenger.
 	 */
-	protected function _set_error_message( EE_Message $message, $error_messages ) {
+	protected function _set_error_message(EE_Message $message, $error_messages) {
 		$error_messages = (array) $error_messages;
-		if ( in_array( $message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending() ) ) {
+		if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
 			$notices = EE_Error::has_notices();
-			$error_messages[] = __( 'Messenger and Message Type were valid and active, but the messenger send method failed.', 'event_espresso' );
-			if ( $notices === 1 ) {
+			$error_messages[] = __('Messenger and Message Type were valid and active, but the messenger send method failed.', 'event_espresso');
+			if ($notices === 1) {
 				$notices = EE_Error::get_vanilla_notices();
-				$notices['errors'] = isset( $notices['errors'] ) ? $notices['errors'] : array();
-				$error_messages[] = implode( "\n", $notices['errors'] );
+				$notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
+				$error_messages[] = implode("\n", $notices['errors']);
 			}
 		}
-		if ( count( $error_messages ) > 0 ) {
-			$msg = __( 'Message was not executed successfully.', 'event_espresso' );
-			$msg = $msg . "\n" . implode( "\n", $error_messages );
-			$message->set_error_message( $msg );
+		if (count($error_messages) > 0) {
+			$msg = __('Message was not executed successfully.', 'event_espresso');
+			$msg = $msg."\n".implode("\n", $error_messages);
+			$message->set_error_message($msg);
 		}
 	}
 

core/libraries/messages/EE_messenger.lib.php

Spacing +97 added lines, -97 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -289,7 +289,7 @@ 
 	 * @return void
 	 */
 	public function enqueue_scripts_styles() {
-		do_action( 'AHEE__EE_messenger__enqueue_scripts_styles');
+		do_action('AHEE__EE_messenger__enqueue_scripts_styles');
 	}
 
 
@@ -359,7 +359,7 @@ 
 
 		$this->_supports_labels->template_variation_description = __('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.');
 
-		$this->_supports_labels = apply_filters( 'FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this );
+		$this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
 	}
 
 
@@ -374,10 +374,10 @@ 
 	 * @return stdClass
 	 */
 	public function get_supports_labels() {
-		if ( empty( $this->_supports_labels->template_pack ) || empty( $this->_supports_labels->template_variation) ) {
+		if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
 			$this->_set_supports_labels_defaults();
 		}
-		return apply_filters( 'FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this );
+		return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
 	}
 
 
@@ -397,10 +397,10 @@ 
 	 *
 	 * @return string                    path or url for the requested variation.
 	 */
-	public function get_variation( EE_Messages_Template_Pack $pack, $message_type_name, $url = FALSE, $type = 'main', $variation = 'default', $skip_filters = FALSE ) {
+	public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = FALSE, $type = 'main', $variation = 'default', $skip_filters = FALSE) {
 		$this->_tmp_pack = $pack;
-		$variation_path = apply_filters( 'EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters );
-		$variation_path = empty( $variation_path ) ? $this->_tmp_pack->get_variation( $this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters ) : $variation_path;
+		$variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
+		$variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
 		return $variation_path;
 
 	}
@@ -418,13 +418,13 @@ 
 	 * @return array
 	 */
 	public function get_default_message_types() {
-		$class = get_class( $this );
+		$class = get_class($this);
 
 		//messenger specific filter
-		$default_types = apply_filters( 'FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this );
+		$default_types = apply_filters('FHEE__'.$class.'__get_default_message_types__default_types', $this->_default_message_types, $this);
 
 		//all messengers filter
-		$default_types = apply_filters( 'FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this );
+		$default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
 		return $default_types;
 	}
 
@@ -439,14 +439,14 @@ 
 	 * @return array
 	 */
 	public function get_valid_message_types() {
-		$class = get_class( $this );
+		$class = get_class($this);
 
 		//messenger specific filter
 		//messenger specific filter
-		$valid_types = apply_filters( 'FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this );
+		$valid_types = apply_filters('FHEE__'.$class.'__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
 
 		//all messengers filter
-		$valid_types = apply_filters( 'FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this );
+		$valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
 		return $valid_types;
 	}
 
@@ -460,7 +460,7 @@ 
 	 * @access public
 	 * @param array $new_config Whatever is put in here will reset the _validator_config property
 	 */
-	public function set_validator_config( $new_config ) {
+	public function set_validator_config($new_config) {
 		$this->_validator_config = $new_config;
 	}
 
@@ -476,8 +476,8 @@ 
 	public function get_validator_config() {
 		$class = get_class($this);
 
-		$config = apply_filters( 'FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this );
-		$config = apply_filters( 'FHEE__EE_messenger__get_validator_config', $config, $this );
+		$config = apply_filters('FHEE__'.$class.'__get_validator_config', $this->_validator_config, $this);
+		$config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
 		return $config;
 	}
 
@@ -494,8 +494,8 @@ 
 	 * @access public
 	 * @return string content for page
 	 */
-	public function get_messenger_admin_page_content( $page, $action = null, $extra = array(), $message_types = array() ) {
-		return $this->_get_admin_page_content( $page, $action, $extra, $message_types );
+	public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array()) {
+		return $this->_get_admin_page_content($page, $action, $extra, $message_types);
 	}
 
 
@@ -505,20 +505,20 @@ 
 	 * @param array $extra
 	 * @return mixed|string
 	 */
-	protected function _get_admin_content_events_edit( $message_types, $extra ) {
+	protected function _get_admin_content_events_edit($message_types, $extra) {
 		//defaults
 		$template_args = array();
 		$selector_rows = '';
 
 		//we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
-		$event_id = isset( $extra['event'] ) ? $extra['event'] : NULL;
+		$event_id = isset($extra['event']) ? $extra['event'] : NULL;
 
-		$template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-		$template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+		$template_wrapper_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+		$template_row_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_row.template.php';
 
 		//array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
 		$global_templates = EEM_Message_Template_Group::instance()->get_all(
-			array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+			array(array('MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true))
 		);
 		$templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
 			$event_id,
@@ -527,55 +527,55 @@ 
 				'MTP_is_active' => true
 			)
 		);
-		$templates_for_event = !empty( $templates_for_event ) ? $templates_for_event : array();
+		$templates_for_event = ! empty($templates_for_event) ? $templates_for_event : array();
 
 		//so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
-		foreach ( $global_templates as $mtpgID => $mtpg ) {
-			if ( $mtpg instanceof EE_Message_Template_Group ) {
+		foreach ($global_templates as $mtpgID => $mtpg) {
+			if ($mtpg instanceof EE_Message_Template_Group) {
 				//verify this message type is supposed to show on this page
 				$mtp_obj = $mtpg->message_type_obj();
-				if ( ! $mtp_obj instanceof EE_message_type ) {
+				if ( ! $mtp_obj instanceof EE_message_type) {
 					continue;
 				}
-				$mtp_obj->admin_registered_pages = (array)$mtp_obj->admin_registered_pages;
-				if ( ! in_array( 'events_edit', $mtp_obj->admin_registered_pages ) ) {
+				$mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
+				if ( ! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
 					continue;
 				}
 				$select_values = array();
-				$select_values[ $mtpgID ] = __( 'Global', 'event_espresso' );
-				$default_value = array_key_exists( $mtpgID, $templates_for_event ) && ! $mtpg->get( 'MTP_is_override' ) ? $mtpgID : null;
+				$select_values[$mtpgID] = __('Global', 'event_espresso');
+				$default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
 				//if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-				if ( ! $mtpg->get( 'MTP_is_override' ) ) {
+				if ( ! $mtpg->get('MTP_is_override')) {
 					//any custom templates for this message type?
-					$custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt( $this->name, $mtpg->message_type() );
-					foreach ( $custom_templates as $cmtpgID => $cmtpg ) {
-						$select_values[ $cmtpgID ] = $cmtpg->name();
-						$default_value = array_key_exists( $cmtpgID, $templates_for_event ) ? $cmtpgID : $default_value;
+					$custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
+					foreach ($custom_templates as $cmtpgID => $cmtpg) {
+						$select_values[$cmtpgID] = $cmtpg->name();
+						$default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
 					}
 				}
 				//if there is no $default_value then we set it as the global
-				$default_value = empty( $default_value ) ? $mtpgID : $default_value;
-				$edit_url = EEH_URL::add_query_args_and_nonce( array( 'page' => 'espresso_messages', 'action' => 'edit_message_template', 'id' => $default_value ), admin_url( 'admin.php' ) );
-				$create_url = EEH_URL::add_query_args_and_nonce( array( 'page' => 'espresso_messages', 'action' => 'add_new_message_template', 'GRP_ID' => $default_value ), admin_url( 'admin.php' ) );
-				$st_args[ 'mt_name' ] = ucwords( $mtp_obj->label[ 'singular' ] );
-				$st_args[ 'mt_slug' ] = $mtpg->message_type();
-				$st_args[ 'messenger_slug' ] = $this->name;
-				$st_args[ 'selector' ] = EEH_Form_Fields::select_input( 'event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector' );
+				$default_value = empty($default_value) ? $mtpgID : $default_value;
+				$edit_url = EEH_URL::add_query_args_and_nonce(array('page' => 'espresso_messages', 'action' => 'edit_message_template', 'id' => $default_value), admin_url('admin.php'));
+				$create_url = EEH_URL::add_query_args_and_nonce(array('page' => 'espresso_messages', 'action' => 'add_new_message_template', 'GRP_ID' => $default_value), admin_url('admin.php'));
+				$st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
+				$st_args['mt_slug'] = $mtpg->message_type();
+				$st_args['messenger_slug'] = $this->name;
+				$st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation['.$mtpgID.']', $select_values, $default_value, 'data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'"', 'message-template-selector');
 				//note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-				$st_args[ 'create_button' ] = $mtpg->get( 'MTP_is_override' ) ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . __( 'Create New Custom', 'event_espresso' ) . '</a>';
-				$st_args[ 'create_button' ] = EE_Registry::instance()->CAP->current_user_can( 'ee_edit_messages', 'espresso_messages_add_new_message_template' ) ? $st_args[ 'create_button' ] : '';
-				$st_args[ 'edit_button' ] = EE_Registry::instance()->CAP->current_user_can( 'ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID ) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . __( 'Edit', 'event_espresso' ) . '</a>' : '';
-				$selector_rows .= EEH_Template::display_template( $template_row_path, $st_args, true );
+				$st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$create_url.'" class="button button-small create-mtpg-button">'.__('Create New Custom', 'event_espresso').'</a>';
+				$st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
+				$st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$edit_url.'" class="button button-small edit-mtpg-button">'.__('Edit', 'event_espresso').'</a>' : '';
+				$selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
 			}
 		}
 
 		//if no selectors present then get out.
-		if ( empty( $selector_rows ) ) {
+		if (empty($selector_rows)) {
 			return '';
 		}
 
 		$template_args['selector_rows'] = $selector_rows;
-		return EEH_Template::display_template( $template_wrapper_path, $template_args, TRUE );
+		return EEH_Template::display_template($template_wrapper_path, $template_args, TRUE);
 	}
 
 
@@ -590,8 +590,8 @@ 
 	 * @return array $this->_template_fields
 	 */
 	public function get_template_fields() {
-		$template_fields = apply_filters( 'FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this );
-		$template_fields = apply_filters( 'FHEE__EE_messenger__get_template_fields', $template_fields, $this );
+		$template_fields = apply_filters('FHEE__'.get_class($this).'__get_template_fields', $this->_template_fields, $this);
+		$template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
 		return $template_fields;
 	}
 
@@ -605,9 +605,9 @@ 
 	 * @param mixed $value
 	 */
 	protected function _set_template_value($item, $value) {
-		if ( array_key_exists($item, $this->_template_fields) ) {
-			$prop = '_' . $item;
-			$this->{$prop}= $value;
+		if (array_key_exists($item, $this->_template_fields)) {
+			$prop = '_'.$item;
+			$this->{$prop} = $value;
 		}
 	}
 
@@ -618,8 +618,8 @@ 
 	 * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
 	 *              added to EE_Error.
 	 */
-	public function send_message( $message, EE_message_type $message_type ) {
-		$this->_validate_and_setup( $message );
+	public function send_message($message, EE_message_type $message_type) {
+		$this->_validate_and_setup($message);
 		$this->_incoming_message_type = $message_type;
 		return $this->_send_message();
 	}
@@ -633,28 +633,28 @@ 
 	 * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
 	 * @return string          return the message html content
 	 */
-	public function get_preview( EE_Message $message, EE_message_type $message_type, $send = false ) {
-		$this->_validate_and_setup( $message );
+	public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false) {
+		$this->_validate_and_setup($message);
 
 		$this->_incoming_message_type = $message_type;
 
-		if ( $send ) {
+		if ($send) {
 			//are we overriding any existing template fields?
 			$settings = $this->get_existing_test_settings();
-			if ( ! empty( $settings ) ) {
-				foreach ( $settings as $field => $value ) {
-					$this->_set_template_value( $field, $value );
+			if ( ! empty($settings)) {
+				foreach ($settings as $field => $value) {
+					$this->_set_template_value($field, $value);
 				}
 			}
 		}
 
 		//enqueue preview js so that any links/buttons on the page are disabled.
-		if ( ! $send ) {
+		if ( ! $send) {
 			// the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
 			// it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-			add_action( 'admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10 );
-			add_action( 'wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10 );
-			add_action( 'AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10 );
+			add_action('admin_enqueue_scripts', array($this, 'add_preview_script'), 10);
+			add_action('wp_enqueue_scripts', array($this, 'add_preview_script'), 10);
+			add_action('AHEE__EE_messenger__enqueue_scripts_styles', array($this, 'add_preview_script'), 10);
 		}
 
 		return $send ? $this->_send_message() : $this->_preview();
@@ -672,10 +672,10 @@ 
 	 */
 	public function add_preview_script() {
 		//error message
-		EE_Registry::$i18n_js_strings[ 'links_disabled' ] = __( 'All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso' );
-		wp_register_script( 'ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true );
-		wp_localize_script( 'ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings );
-		wp_enqueue_script( 'ee-messages-preview-js' );
+		EE_Registry::$i18n_js_strings['links_disabled'] = __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso');
+		wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL.'messages/messenger/assets/js/ee-messages-preview.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
+		wp_enqueue_script('ee-messages-preview-js');
 	}
 
 
@@ -686,13 +686,13 @@ 
 	 * @param  EE_Message $message
 	 * @throws EE_Error
 	 */
-	protected function _validate_and_setup( EE_Message $message ) {
+	protected function _validate_and_setup(EE_Message $message) {
 		$template_pack = $message->get_template_pack();
 		$variation = $message->get_template_pack_variation();
 
 		//verify we have the required template pack value on the $message object.
-		if ( ! $template_pack instanceof EE_Messages_Template_Pack ) {
-			throw new EE_Error( __('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso' ) );
+		if ( ! $template_pack instanceof EE_Messages_Template_Pack) {
+			throw new EE_Error(__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
 		}
 
 		$this->_tmp_pack = $template_pack;
@@ -701,11 +701,11 @@ 
 
 		$template_fields = $this->get_template_fields();
 
-		foreach ( $template_fields as $template => $value ) {
-			if ( $template !== 'extra' ) {
-				$column_value = $message->get_field_or_extra_meta( 'MSG_' . $template );
+		foreach ($template_fields as $template => $value) {
+			if ($template !== 'extra') {
+				$column_value = $message->get_field_or_extra_meta('MSG_'.$template);
 				$message_template_value = $column_value ? $column_value : null;
-				$this->_set_template_value( $template, $message_template_value );
+				$this->_set_template_value($template, $message_template_value);
 			}
 		}
 	}
@@ -720,19 +720,19 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	protected function _get_main_template( $preview = FALSE ) {
+	protected function _get_main_template($preview = FALSE) {
 		$type = $preview ? 'preview' : 'main';
 
-		$wrapper_template = $this->_tmp_pack->get_wrapper( $this->name, $type );
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
 
 		//check file exists and is readable
-		if ( !is_readable( $wrapper_template ) )
-			throw new EE_Error( sprintf( __('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso' ), ucwords($this->label['singular']) , $wrapper_template ) );
+		if ( ! is_readable($wrapper_template))
+			throw new EE_Error(sprintf(__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
 
 		//add message type to template args
 		$this->_template_args['message_type'] = $this->_incoming_message_type;
 
-		return EEH_Template::display_template( $wrapper_template, $this->_template_args, TRUE );
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
 	}
 
 
@@ -768,9 +768,9 @@ 
 	 */
 	public function get_existing_test_settings() {
 		/** @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');
 		$settings = $Message_Resource_Manager->get_active_messengers_option();
-		return isset( $settings[ $this->name ]['test_settings'] ) ? $settings[ $this->name ]['test_settings'] : array();
+		return isset($settings[$this->name]['test_settings']) ? $settings[$this->name]['test_settings'] : array();
 	}
 
 
@@ -782,12 +782,12 @@ 
 	 * @param $settings
 	 * @return bool success/fail
 	 */
-	public function set_existing_test_settings( $settings ) {
+	public function set_existing_test_settings($settings) {
 		/** @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');
 		$existing = $Message_Resource_Manager->get_active_messengers_option();
-		$existing[ $this->name ]['test_settings'] = $settings;
-		return $Message_Resource_Manager->update_active_messengers_option( $existing );
+		$existing[$this->name]['test_settings'] = $settings;
+		return $Message_Resource_Manager->update_active_messengers_option($existing);
 	}
 
 
@@ -800,21 +800,21 @@ 
 	 * @param string $field The field to retrieve the label for
 	 * @return string        	  The label
 	 */
-	public function get_field_label( $field ) {
+	public function get_field_label($field) {
 		//first let's see if the field requests is in the top level array.
-		if ( isset( $this->_template_fields[$field] ) && !empty( $this->_template_fields[$field]['label'] ) )
+		if (isset($this->_template_fields[$field]) && ! empty($this->_template_fields[$field]['label']))
 			return $this->_template[$field]['label'];
 
 		//nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-		if ( isset( $this->_template_fields['extra'] ) && !empty( $this->_template_fields['extra'][$field] ) && !empty( $this->_template_fields['extra'][$field]['main']['label'] )  )
+		if (isset($this->_template_fields['extra']) && ! empty($this->_template_fields['extra'][$field]) && ! empty($this->_template_fields['extra'][$field]['main']['label']))
 			return $this->_template_fields['extra'][$field]['main']['label'];
 
 		//now it's possible this field may just be existing in any of the extra array items.
-		if ( !empty( $this->_template_fields['extra'] ) && is_array( $this->_template_fields['extra'] ) ) {
-			foreach ( $this->_template_fields['extra'] as $main_field => $subfields ) {
-				if ( !is_array( $subfields ) )
+		if ( ! empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+			foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
+				if ( ! is_array($subfields))
 					continue;
-				if ( isset( $subfields[$field] ) && !empty( $subfields[$field]['label'] ) )
+				if (isset($subfields[$field]) && ! empty($subfields[$field]['label']))
 					return $subfields[$field]['label'];
 			}
 		}
@@ -835,7 +835,7 @@ 
 	 *
 	 * @return void
 	 */
-	public function do_secondary_messenger_hooks( $sending_messenger_name ) {
+	public function do_secondary_messenger_hooks($sending_messenger_name) {
 		return;
 	}
 

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

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,27 +410,27 @@ 
 
 			//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),
 						'<strong>',
 						'</strong>'
 					);
@@ -438,10 +438,10 @@ 
 			}
 
 			//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',
@@ -455,7 +455,7 @@ 
 						break;
 					case 'email' :
 						$valid_email = $this->_validate_email($value);
-						if ( !$valid_email )
+						if ( ! $valid_email)
 							$err_msg .= htmlentities(
 								sprintf(
 									__(
@@ -472,23 +472,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;
 	}
 
 
@@ -501,10 +501,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;
 	}
@@ -523,29 +523,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;
 	}
 
@@ -557,13 +557,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.
@@ -581,19 +581,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;
 			}
@@ -601,20 +601,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;
 
@@ -630,7 +630,7 @@ 
 	 * @throws Exception
 	 * @return mixed
 	 */
-	public function __get( $property ) {
+	public function __get($property) {
 		$expected_properties_map = array(
 			/**
 			 * @deprecated 4.9.0
@@ -642,15 +642,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/messages/EE_Messages_Generator.lib.php

Indentation +5 added lines, -5 removed lines

@@ -458,8 +458,8 @@ 
 		//if the 'to' field is empty (messages will ALWAYS have a "to" field, then we get out because that means this
 		//context is turned off) EXCEPT if we're previewing
 		if ( empty( $templates['to'][ $context ] )
-		     && ! $this->_generation_queue->get_message_repository()->is_preview()
-		     && ! $this->_current_messenger->allow_empty_to_field() ) {
+			 && ! $this->_generation_queue->get_message_repository()->is_preview()
+			 && ! $this->_current_messenger->allow_empty_to_field() ) {
 			//we silently exit here and do NOT record a fail because the message is "turned off" by having no "to" field.
 			return false;
 		}
@@ -575,9 +575,9 @@ 
 		 * Check if there is any generation data, but only if this is not for a preview.
 		 */
 		if ( ! $this->_generation_queue->get_message_repository()->get_generation_data()
-		     && (
-			     ! $this->_generation_queue->get_message_repository()->is_preview()
-			     && $this->_generation_queue->get_message_repository()->get_data_handler() !== 'EE_Messages_Preview_incoming_data' )
+			 && (
+				 ! $this->_generation_queue->get_message_repository()->is_preview()
+				 && $this->_generation_queue->get_message_repository()->get_data_handler() !== 'EE_Messages_Preview_incoming_data' )
 		) {
 			$this->_error_msg[] = __( 'There is no generation data for this message. Unable to generate.' );
 		}

Spacing +113 added lines, -113 removed lines

@@ -1,4 +1,4 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' )) { exit( 'No direct script access allowed' ); }
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
 
 /**
  * This class is used for generating EE_Message objects with given info.
@@ -116,17 +116,17 @@ 
 	 *
 	 * @return EE_Messages_Queue  The new queue for holding generated EE_Message objects.
 	 */
-	public function generate( $save = true ) {
+	public function generate($save = true) {
 		//iterate through the messages in the queue, generate, and add to new queue.
 		$this->_generation_queue->get_message_repository()->rewind();
-		while ( $this->_generation_queue->get_message_repository()->valid() ) {
+		while ($this->_generation_queue->get_message_repository()->valid()) {
 			//reset "current" properties
 			$this->_reset_current_properties();
 
 			/** @type EE_Message $msg */
 			$msg = $this->_generation_queue->get_message_repository()->current();
 
-			if ( $this->_verify() ) {
+			if ($this->_verify()) {
 				//let's get generating!
 				$this->_generate();
 			}
@@ -138,26 +138,26 @@ 
 			$this->_generation_queue->get_message_repository()->next();
 			$next_msg = $this->_generation_queue->get_message_repository()->current();
 			//restore pointer to current item
-			$this->_generation_queue->get_message_repository()->set_current( $msg );
+			$this->_generation_queue->get_message_repository()->set_current($msg);
 
 			//if there are error messages then let's set the status and the error message.
-			if ( $this->_error_msg ) {
+			if ($this->_error_msg) {
 				//if the status is already debug only, then let's leave it at that.
-				if ( $msg->STS_ID() !== EEM_Message::status_debug_only ) {
-					$msg->set_STS_ID( EEM_Message::status_failed );
+				if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
+					$msg->set_STS_ID(EEM_Message::status_failed);
 				}
 				$msg->set_error_message(
-					__( 'Message failed to generate for the following reasons: ' )
+					__('Message failed to generate for the following reasons: ')
 					. "\n"
-					. implode( "\n", $this->_error_msg )
+					. implode("\n", $this->_error_msg)
 				);
-				$msg->set_modified( time() );
+				$msg->set_modified(time());
 			} else {
 				//remove from db
 				$this->_generation_queue->get_message_repository()->delete();
 			}
 			//next item
-			$this->_generation_queue->get_message_repository()->set_current( $next_msg );
+			$this->_generation_queue->get_message_repository()->set_current($next_msg);
 		}
 
 		//generation queue is ALWAYS saved to record any errors in the generation process.
@@ -170,7 +170,7 @@ 
 		 * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
 		 * irrelevant.
 		 */
-		if ( $save ) {
+		if ($save) {
 			$this->_ready_queue->save();
 		}
 
@@ -188,7 +188,7 @@ 
 	protected function _reset_current_properties() {
 		$this->_verified = false;
 		//make sure any _data value in the current message type is reset
-		if ( $this->_current_message_type instanceof EE_message_type ) {
+		if ($this->_current_message_type instanceof EE_message_type) {
 			$this->_current_message_type->reset_data();
 		}
 		$this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
@@ -207,7 +207,7 @@ 
 	 */
 	protected function _generate() {
 		//double check verification has run and that everything is ready to work with (saves us having to validate everything again).
-		if ( ! $this->_verified ) {
+		if ( ! $this->_verified) {
 			return false; //get out because we don't have a valid setup to work with.
 		}
 
@@ -217,34 +217,34 @@ 
 				$this->_current_data_handler,
 				$this->_generation_queue->get_message_repository()->current()->context()
 			);
-		} catch ( EE_Error $e ) {
+		} catch (EE_Error $e) {
 			$this->_error_msg[] = $e->getMessage();
 			return false;
 		}
 
 
 		//if no addressees then get out because there is nothing to generation (possible bad data).
-		if ( ! $this->_valid_addressees( $addressees ) ) {
-			$this->_generation_queue->get_message_repository()->current()->set_STS_ID( EEM_Message::status_debug_only );
-			$this->_error_msg[] = __( 'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler.
-			  Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.', 'event_espresso' );
+		if ( ! $this->_valid_addressees($addressees)) {
+			$this->_generation_queue->get_message_repository()->current()->set_STS_ID(EEM_Message::status_debug_only);
+			$this->_error_msg[] = __('This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler.
+			  Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.', 'event_espresso');
 			return false;
 		}
 
 		$message_template_group = $this->_get_message_template_group();
 
 		//in the unlikely event there is no EE_Message_Template_Group available, get out!
-		if ( ! $message_template_group instanceof EE_Message_Template_Group ) {
-			$this->_error_msg[] = __( 'Unable to get the Message Templates for the Message being generated.  No message template group accessible.', 'event_espresso' );
+		if ( ! $message_template_group instanceof EE_Message_Template_Group) {
+			$this->_error_msg[] = __('Unable to get the Message Templates for the Message being generated.  No message template group accessible.', 'event_espresso');
 			return false;
 		}
 
 		//get formatted templates for using to parse and setup EE_Message objects.
-		$templates = $this->_get_templates( $message_template_group );
+		$templates = $this->_get_templates($message_template_group);
 
 
 		//setup new EE_Message objects (and add to _ready_queue)
-		return $this->_assemble_messages( $addressees, $templates, $message_template_group );
+		return $this->_assemble_messages($addressees, $templates, $message_template_group);
 	}
 
 
@@ -262,17 +262,17 @@ 
 		//so let's use that.
 		$GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
 
-		if ( $GRP_ID ) {
+		if ($GRP_ID) {
 			//attempt to retrieve from repo first
-			$GRP = $this->_template_collection->get_by_ID( $GRP_ID );
-			if ( $GRP instanceof EE_Message_Template_Group ) {
-				return $GRP;  //got it!
+			$GRP = $this->_template_collection->get_by_ID($GRP_ID);
+			if ($GRP instanceof EE_Message_Template_Group) {
+				return $GRP; //got it!
 			}
 
 			//nope don't have it yet.  Get from DB then add to repo
-			$GRP = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
-			if ( $GRP instanceof EE_Message_Template_Group ) {
-				$this->_template_collection->add( $GRP );
+			$GRP = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+			if ($GRP instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add($GRP);
 			}
 			return $GRP;
 		}
@@ -291,41 +291,41 @@ 
 		//in vanilla EE we're assuming there's only one event.
 		//However, if there are multiple events then we'll just use the default templates instead of different
 		// templates per event (which could create problems).
-		if ( count( $this->_current_data_handler->events ) === 1 ) {
-			foreach ( $this->_current_data_handler->events as $event ) {
+		if (count($this->_current_data_handler->events) === 1) {
+			foreach ($this->_current_data_handler->events as $event) {
 				$EVT_ID = $event['ID'];
 			}
 		}
 
 		//before going any further, let's see if its in the queue
-		$GRP = $this->_template_collection->get_by_key( $this->_template_collection->get_key( $this->_current_messenger->name, $this->_current_message_type->name, $EVT_ID ) );
+		$GRP = $this->_template_collection->get_by_key($this->_template_collection->get_key($this->_current_messenger->name, $this->_current_message_type->name, $EVT_ID));
 
-		if ( $GRP instanceof EE_Message_Template_Group ) {
+		if ($GRP instanceof EE_Message_Template_Group) {
 			return $GRP;
 		}
 
 		//nope still no GRP?
 		//first we get the global template in case it has an override set.
-		$global_template_qa = array_merge( array( 'MTP_is_global' => true ), $template_qa );
-		$global_GRP = EEM_Message_Template_Group::instance()->get_one( array( $global_template_qa ) );
+		$global_template_qa = array_merge(array('MTP_is_global' => true), $template_qa);
+		$global_GRP = EEM_Message_Template_Group::instance()->get_one(array($global_template_qa));
 
 		//if this is an override, then we just return it.
-		if ( $global_GRP instanceof EE_Message_Template_Group && $global_GRP->get( 'MTP_is_override' ) ) {
-			$this->_template_collection->add( $global_GRP, $EVT_ID );
+		if ($global_GRP instanceof EE_Message_Template_Group && $global_GRP->get('MTP_is_override')) {
+			$this->_template_collection->add($global_GRP, $EVT_ID);
 			return $global_GRP;
 		}
 
 		//STILL here? Okay that means we want to see if there is event specific group and if there is we return it,
 		//otherwise we return the global group we retrieved.
-		if ( $EVT_ID ) {
+		if ($EVT_ID) {
 			$template_qa['Event.EVT_ID'] = $EVT_ID;
 		}
 
-		$GRP = EEM_Message_Template_Group::instance()->get_one( array( $template_qa ) );
+		$GRP = EEM_Message_Template_Group::instance()->get_one(array($template_qa));
 		$GRP = $GRP instanceof EE_Message_Template_Group ? $GRP : $global_GRP;
 
-		if ( $GRP instanceof EE_Message_Template_Group ) {
-			$this->_template_collection->add( $GRP, $EVT_ID );
+		if ($GRP instanceof EE_Message_Template_Group) {
+			$this->_template_collection->add($GRP, $EVT_ID);
 			return $GRP;
 		}
 
@@ -349,15 +349,15 @@ 
 	 *                      )
 	 *                  )
 	 */
-	protected function _get_templates( EE_Message_Template_Group $message_template_group ) {
+	protected function _get_templates(EE_Message_Template_Group $message_template_group) {
 		$templates = array();
 		$context_templates = $message_template_group->context_templates();
-		foreach ( $context_templates as $context => $template_fields ) {
-			foreach ( $template_fields as $template_field => $template_obj ) {
-				if ( ! $template_obj instanceof EE_Message_Template ) {
+		foreach ($context_templates as $context => $template_fields) {
+			foreach ($template_fields as $template_field => $template_obj) {
+				if ( ! $template_obj instanceof EE_Message_Template) {
 					continue;
 				}
-				$templates[ $template_field ][ $context ] = $template_obj->get( 'MTP_content' );
+				$templates[$template_field][$context] = $template_obj->get('MTP_content');
 			}
 		}
 		return $templates;
@@ -379,20 +379,20 @@ 
 	 *                get added to the queue with EEM_Message::status_idle, unsuccessfully generated messages will get added
 	 *                to the queue as EEM_Message::status_failed.  Very rarely should "false" be returned from this method.
 	 */
-	protected function _assemble_messages( $addressees, $templates, EE_Message_Template_Group $message_template_group ) {
+	protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group) {
 
 		//if templates are empty then get out because we can't generate anything.
-		if ( ! $templates ) {
+		if ( ! $templates) {
 			return false;
 		}
 
 		//We use this as the counter for generated messages because don't forget we may be executing this inside of a
 		//generation_queue.  So _ready_queue may have generated EE_Message objects already.
 		$generated_count = 0;
-		foreach ( $addressees as $context => $recipients ) {
-			foreach ( $recipients as $recipient ) {
-				$message = $this->_setup_message_object( $context, $recipient, $templates, $message_template_group );
-				if ( $message instanceof EE_Message ) {
+		foreach ($addressees as $context => $recipients) {
+			foreach ($recipients as $recipient) {
+				$message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
+				if ($message instanceof EE_Message) {
 					$this->_ready_queue->add(
 						$message,
 						array(),
@@ -403,7 +403,7 @@ 
 				}
 
 				//if the current MSG being generated is for a test send then we'll only use ONE message in the generation.
-				if ( $this->_generation_queue->get_message_repository()->is_test_send() ) {
+				if ($this->_generation_queue->get_message_repository()->is_test_send()) {
 					break 2;
 				}
 			}
@@ -432,7 +432,7 @@ 
 	) {
 		//stuff we already know
 		$transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
-		$transaction_id = empty( $transaction_id ) && $this->_current_data_handler->txn instanceof EE_Transaction
+		$transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
 			? $this->_current_data_handler->txn->ID()
 			: $transaction_id;
 		$message_fields = array(
@@ -445,7 +445,7 @@ 
 
 		//recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab the
 		//info from the att_obj found in the EE_Messages_Addressee object.
-		if ( empty( $recipient->recipient_id ) || empty( $recipient->recipient_type ) ) {
+		if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
 			$message_fields['MSG_recipient_ID'] = $recipient->att_obj instanceof EE_Attendee
 				? $recipient->att_obj->ID()
 				: 0;
@@ -454,7 +454,7 @@ 
 			$message_fields['MSG_recipient_ID'] = $recipient->recipient_id;
 			$message_fields['MSG_recipient_type'] = $recipient->recipient_type;
 		}
-		$message = EE_Message_Factory::create( $message_fields );
+		$message = EE_Message_Factory::create($message_fields);
 
 		//grab valid shortcodes for shortcode parser
 		$mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
@@ -462,43 +462,43 @@ 
 
 		//if the 'to' field is empty (messages will ALWAYS have a "to" field, then we get out because that means this
 		//context is turned off) EXCEPT if we're previewing
-		if ( empty( $templates['to'][ $context ] )
+		if (empty($templates['to'][$context])
 		     && ! $this->_generation_queue->get_message_repository()->is_preview()
-		     && ! $this->_current_messenger->allow_empty_to_field() ) {
+		     && ! $this->_current_messenger->allow_empty_to_field()) {
 			//we silently exit here and do NOT record a fail because the message is "turned off" by having no "to" field.
 			return false;
 		}
 		$error_msg = array();
-		foreach ( $templates as $field => $field_context ) {
+		foreach ($templates as $field => $field_context) {
 			$error_msg = array();
 			//let's setup the valid shortcodes for the incoming context.
-			$valid_shortcodes = $mt_shortcodes[ $context ];
+			$valid_shortcodes = $mt_shortcodes[$context];
 			//merge in valid shortcodes for the field.
-			$shortcodes = isset($m_shortcodes[ $field ]) ? $m_shortcodes[ $field ] : $valid_shortcodes;
-			if ( isset( $templates[ $field ][ $context ] ) ) {
+			$shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
+			if (isset($templates[$field][$context])) {
 				//prefix field.
-				$column_name = 'MSG_' . $field;
+				$column_name = 'MSG_'.$field;
 				try {
 					$content = $this->_shortcode_parser->parse_message_template(
-						$templates[ $field ][ $context ],
+						$templates[$field][$context],
 						$recipient,
 						$shortcodes,
 						$this->_current_message_type,
 						$this->_current_messenger,
 						$message );
-					$message->set_field_or_extra_meta( $column_name, $content );
-				} catch ( EE_Error $e ) {
-					$error_msg[] = sprintf( __( 'There was a problem generating the content for the field %s: %s', 'event_espresso' ), $field, $e->getMessage() );
-					$message->set_STS_ID( EEM_Message::status_failed );
+					$message->set_field_or_extra_meta($column_name, $content);
+				} catch (EE_Error $e) {
+					$error_msg[] = sprintf(__('There was a problem generating the content for the field %s: %s', 'event_espresso'), $field, $e->getMessage());
+					$message->set_STS_ID(EEM_Message::status_failed);
 				}
 			}
 		}
 
-		if ( $message->STS_ID() === EEM_Message::status_failed ) {
-			$error_msg = __( 'There were problems generating this message:', 'event_espresso' ) . "\n" . implode( "\n", $error_msg );
-			$message->set_error_message( $error_msg );
+		if ($message->STS_ID() === EEM_Message::status_failed) {
+			$error_msg = __('There were problems generating this message:', 'event_espresso')."\n".implode("\n", $error_msg);
+			$message->set_error_message($error_msg);
 		} else {
-			$message->set_STS_ID( EEM_Message::status_idle );
+			$message->set_STS_ID(EEM_Message::status_idle);
 		}
 		return $message;
 	}
@@ -532,14 +532,14 @@ 
 	 * @param array $addressees  Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
 	 * @return bool
 	 */
-	protected function _valid_addressees( $addressees ) {
-		if ( ! $addressees || ! is_array( $addressees ) ) {
+	protected function _valid_addressees($addressees) {
+		if ( ! $addressees || ! is_array($addressees)) {
 			return false;
 		}
 
-		foreach( $addressees as $addressee_array ) {
-			foreach ( $addressee_array as $addressee ) {
-				if ( ! $addressee instanceof EE_Messages_Addressee ) {
+		foreach ($addressees as $addressee_array) {
+			foreach ($addressee_array as $addressee) {
+				if ( ! $addressee instanceof EE_Messages_Addressee) {
 					return false;
 				}
 			}
@@ -560,19 +560,19 @@ 
 	protected function _validate_messenger_and_message_type() {
 
 		//first are there any existing error messages?  If so then return.
-		if ( $this->_error_msg ) {
+		if ($this->_error_msg) {
 			return false;
 		}
 		/** @type EE_Message $message */
 		$message = $this->_generation_queue->get_message_repository()->current();
 		try {
-			$this->_current_messenger = $message->valid_messenger( true ) ? $message->messenger_object() : null;
-		} catch ( Exception $e ) {
+			$this->_current_messenger = $message->valid_messenger(true) ? $message->messenger_object() : null;
+		} catch (Exception $e) {
 			$this->_error_msg[] = $e->getMessage();
 		}
 		try {
-			$this->_current_message_type = $message->valid_message_type( true ) ? $message->message_type_object() : null;
-		} catch ( Exception $e ) {
+			$this->_current_message_type = $message->valid_message_type(true) ? $message->message_type_object() : null;
+		} catch (Exception $e) {
 			$this->_error_msg[] = $e->getMessage();
 		}
 
@@ -584,10 +584,10 @@ 
 			     ! $this->_generation_queue->get_message_repository()->is_preview()
 			     && $this->_generation_queue->get_message_repository()->get_data_handler() !== 'EE_Messages_Preview_incoming_data' )
 		) {
-			$this->_error_msg[] = __( 'There is no generation data for this message. Unable to generate.' );
+			$this->_error_msg[] = __('There is no generation data for this message. Unable to generate.');
 		}
 
-		return empty( $this->_error_msg );
+		return empty($this->_error_msg);
 	}
 
 
@@ -604,7 +604,7 @@ 
 
 		//First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
 		//be used anyways.
-		if ( $this->_error_msg ) {
+		if ($this->_error_msg) {
 			return false;
 		}
 
@@ -613,29 +613,29 @@ 
 		/** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
 		$data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
 			? $this->_generation_queue->get_message_repository()->get_data_handler()
-			: 'EE_Messages_' .  $this->_current_message_type->get_data_handler( $generation_data ) . '_incoming_data';
+			: 'EE_Messages_'.$this->_current_message_type->get_data_handler($generation_data).'_incoming_data';
 
 		//If this EE_Message is for a preview, then let's switch out to the preview data handler.
-		if ( $this->_generation_queue->get_message_repository()->is_preview() ) {
-			$data_handler_class_name  = 'EE_Messages_Preview_incoming_data';
+		if ($this->_generation_queue->get_message_repository()->is_preview()) {
+			$data_handler_class_name = 'EE_Messages_Preview_incoming_data';
 		}
 
 		//First get the class name for the data handler (and also verifies it exists.
-		if ( ! class_exists( $data_handler_class_name ) ) {
+		if ( ! class_exists($data_handler_class_name)) {
 			$this->_error_msg[] = sprintf(
-				__( 'The included data handler class name does not match any valid, accessible, "EE_Messages_incoming_data" classes.  Looking for %s.', 'event_espresso' ),
+				__('The included data handler class name does not match any valid, accessible, "EE_Messages_incoming_data" classes.  Looking for %s.', 'event_espresso'),
 				$data_handler_class_name
 			);
 			return false;
 		}
 
 		//convert generation_data for data_handler_instantiation.
-		$generation_data = $data_handler_class_name::convert_data_from_persistent_storage( $generation_data );
+		$generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
 
 		//note, this may set error messages as well.
-		$this->_set_data_handler( $generation_data, $data_handler_class_name );
+		$this->_set_data_handler($generation_data, $data_handler_class_name);
 
-		return empty( $this->_error_msg );
+		return empty($this->_error_msg);
 	}
 
 
@@ -652,16 +652,16 @@ 
 	 *
 	 * @return void.
 	 */
-	protected function _set_data_handler( $generating_data, $data_handler_class_name ) {
+	protected function _set_data_handler($generating_data, $data_handler_class_name) {
 		//valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
 		//is already a ready data handler in the repository.
-		$this->_current_data_handler = $this->_data_handler_collection->get_by_key( $this->_data_handler_collection->get_key( $data_handler_class_name, $generating_data ) );
-		if ( ! $this->_current_data_handler instanceof EE_messages_incoming_data ) {
+		$this->_current_data_handler = $this->_data_handler_collection->get_by_key($this->_data_handler_collection->get_key($data_handler_class_name, $generating_data));
+		if ( ! $this->_current_data_handler instanceof EE_messages_incoming_data) {
 			//no saved data_handler in the repo so let's set one up and add it to the repo.
 			try {
-				$this->_current_data_handler = new $data_handler_class_name( $generating_data );
-				$this->_data_handler_collection->add( $this->_current_data_handler, $generating_data );
-			} catch( EE_Error $e ) {
+				$this->_current_data_handler = new $data_handler_class_name($generating_data);
+				$this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
+			} catch (EE_Error $e) {
 				$this->_error_msg[] = $e->get_error();
 			}
 		}
@@ -681,13 +681,13 @@ 
 	 * @param bool                   $preview Indicate whether this is being used for a preview or not.
 	 * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
 	 */
-	protected function _prepare_data_for_queue( EE_Message_To_Generate $message_to_generate, $preview ) {
+	protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview) {
 		/** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
-		$data_handler = $message_to_generate->get_data_handler_class_name( $preview );
-		if ( ! $message_to_generate->valid() ) {
+		$data_handler = $message_to_generate->get_data_handler_class_name($preview);
+		if ( ! $message_to_generate->valid()) {
 			return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
 		}
-		return $data_handler::convert_data_for_persistent_storage( $message_to_generate->data() );
+		return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
 	}
 
 
@@ -700,26 +700,26 @@ 
 	 * @param EE_Message_To_Generate $message_to_generate
 	 * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
 	 */
-	public function create_and_add_message_to_queue( EE_Message_To_Generate $message_to_generate, $test_send = false ) {
+	public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false) {
 		//prep data
-		$data = $this->_prepare_data_for_queue( $message_to_generate, $message_to_generate->preview() );
+		$data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
 
 		$message = $message_to_generate->get_EE_Message();
 
 		//is there a GRP_ID in the request?
-		if ( $GRP_ID = EE_Registry::instance()->REQ->get( 'GRP_ID' ) ) {
-			$message->set_GRP_ID( $GRP_ID );
+		if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
+			$message->set_GRP_ID($GRP_ID);
 		}
 
-		if ( $data === false ) {
-			$message->set_STS_ID( EEM_Message::status_failed );
-			$message->set_error_message( __( 'Unable to prepare data for persistence to the database.', 'event_espresso' ) );
+		if ($data === false) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(__('Unable to prepare data for persistence to the database.', 'event_espresso'));
 		} else {
 			//make sure that the data handler is cached on the message as well
 			$data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
 		}
 
-		$this->_generation_queue->add( $message, $data, $message_to_generate->preview(), $test_send );
+		$this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
 	}
 
 

core/db_classes/EE_Message_Template_Group.class.php

Spacing +51 added lines, -51 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * EE_Message_Template_Group class
@@ -18,9 +18,9 @@ 
 	 * @param string $timezone
 	 * @return EE_Message_Template_Group|mixed
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = '' ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone );
-		return $has_object ? $has_object : new self( $props_n_values, FALSE, $timezone );
+	public static function new_instance($props_n_values = array(), $timezone = '') {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, FALSE, $timezone);
 	}
 
 
@@ -30,8 +30,8 @@ 
 	 * @param string $timezone
 	 * @return EE_Message_Template_Group
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = '' ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '') {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -40,11 +40,11 @@ 
 	 * @param bool $message_type
 	 * @throws EE_Error
 	 */
-	public function set_message_type( $message_type = FALSE ) {
-		if ( ! $message_type ) {
-			throw new EE_Error( __( 'Missing required value for the message_type parameter', 'event_espresso' ) );
+	public function set_message_type($message_type = FALSE) {
+		if ( ! $message_type) {
+			throw new EE_Error(__('Missing required value for the message_type parameter', 'event_espresso'));
 		}
-		$this->set( 'MTP_message_type', $message_type );
+		$this->set('MTP_message_type', $message_type);
 	}
 
 
@@ -53,11 +53,11 @@ 
 	 * @param bool $messenger
 	 * @throws EE_Error
 	 */
-	public function set_messenger( $messenger = FALSE ) {
-		if ( ! $messenger ) {
-			throw new EE_Error( __( 'Missing required value for the messenger parameter', 'event_espresso' ) );
+	public function set_messenger($messenger = FALSE) {
+		if ( ! $messenger) {
+			throw new EE_Error(__('Missing required value for the messenger parameter', 'event_espresso'));
 		}
-		$this->set( 'MTP_messenger', $messenger );
+		$this->set('MTP_messenger', $messenger);
 	}
 
 
@@ -66,11 +66,11 @@ 
 	 * @param bool $GRP_ID
 	 * @throws EE_Error
 	 */
-	public function set_group_template_id( $GRP_ID = FALSE ) {
-		if ( ! $GRP_ID ) {
-			throw new EE_Error( __( 'Missing required value for the message template group id', 'event_espresso' ) );
+	public function set_group_template_id($GRP_ID = FALSE) {
+		if ( ! $GRP_ID) {
+			throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
 		}
-		$this->set( 'GRP_ID', $GRP_ID );
+		$this->set('GRP_ID', $GRP_ID);
 	}
 
 
@@ -81,7 +81,7 @@ 
 	 * @return int
 	 */
 	public function GRP_ID() {
-		return $this->get( 'GRP_ID' );
+		return $this->get('GRP_ID');
 	}
 
 
@@ -92,8 +92,8 @@ 
 	 * @return int
 	 */
 	public function user() {
-		$user_id = $this->get( 'MTP_user_id' );
-		return empty( $user_id ) ? get_current_user_id() : $user_id;
+		$user_id = $this->get('MTP_user_id');
+		return empty($user_id) ? get_current_user_id() : $user_id;
 	}
 
 
@@ -116,7 +116,7 @@ 
 	 * @return int
 	 */
 	public function count_events() {
-		return $this->count_related( 'Event' );
+		return $this->count_related('Event');
 	}
 
 
@@ -126,7 +126,7 @@ 
 	 * @return string
 	 */
 	public function name() {
-		return $this->get( 'MTP_name' );
+		return $this->get('MTP_name');
 	}
 
 
@@ -136,7 +136,7 @@ 
 	 * @return string
 	 */
 	public function description() {
-		return $this->get( 'MTP_description' );
+		return $this->get('MTP_description');
 	}
 
 
@@ -146,8 +146,8 @@ 
 	 * @param  array $query_params like EEM_Base::get_all()
 	 * @return EE_Message_Template[]
 	 */
-	public function message_templates( $query_params = array() ) {
-		return $this->get_many_related( 'Message_Template', $query_params );
+	public function message_templates($query_params = array()) {
+		return $this->get_many_related('Message_Template', $query_params);
 	}
 
 
@@ -158,7 +158,7 @@ 
 	 * @return string
 	 */
 	public function messenger() {
-		return $this->get( 'MTP_messenger' );
+		return $this->get('MTP_messenger');
 	}
 
 
@@ -175,10 +175,10 @@ 
 	public function messenger_obj() {
 		$messenger = $this->messenger();
 		try {
-			$messenger = EEH_MSG_Template::messenger_obj( $messenger );
-		} catch( EE_Error $e ) {
+			$messenger = EEH_MSG_Template::messenger_obj($messenger);
+		} catch (EE_Error $e) {
 			//if an exception was thrown then let's deactivate this message template group because it means there is no class for this messenger in this group.
-			$this->set( 'MTP_is_active', false );
+			$this->set('MTP_is_active', false);
 			$this->save();
 			return null;
 		}
@@ -194,7 +194,7 @@ 
 	 * @return string
 	 */
 	public function message_type() {
-		return $this->get( 'MTP_message_type' );
+		return $this->get('MTP_message_type');
 	}
 
 
@@ -212,10 +212,10 @@ 
 	public function message_type_obj() {
 		$message_type = $this->message_type();
 		try {
-			$message_type = EEH_MSG_Template::message_type_obj( $message_type );
-		} catch(EE_Error $e) {
+			$message_type = EEH_MSG_Template::message_type_obj($message_type);
+		} catch (EE_Error $e) {
 			//if an exception was thrown then let's deactivate this message template group because it means there is no class for the message type in this group.
-			$this->set( 'MTP_is_active', false );
+			$this->set('MTP_is_active', false);
 			$this->save();
 			return null;
 		}
@@ -252,13 +252,13 @@ 
 	 */
 	public function context_templates() {
 		$mtps_arr = array();
-		$mtps = $this->get_many_related( 'Message_Template' );
-		if ( empty( $mtps ) ) {
+		$mtps = $this->get_many_related('Message_Template');
+		if (empty($mtps)) {
 			return array();
 		}
 		//note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
-		foreach ( $mtps as $mtp ) {
-			$mtps_arr[ $mtp->get( 'MTP_context' ) ][ $mtp->get( 'MTP_template_field' ) ] = $mtp;
+		foreach ($mtps as $mtp) {
+			$mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
 		}
 		return $mtps_arr;
 	}
@@ -270,7 +270,7 @@ 
 	 * @return boolean true if it is, false if it isn't
 	 */
 	public function is_global() {
-		return $this->get( 'MTP_is_global' );
+		return $this->get('MTP_is_global');
 	}
 
 
@@ -280,7 +280,7 @@ 
 	 * @return boolean true if it is, false if it isn't
 	 */
 	public function is_active() {
-		return $this->get( 'MTP_is_active' );
+		return $this->get('MTP_is_active');
 	}
 
 
@@ -296,10 +296,10 @@ 
 	 * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the unique shortcodes for all the given (or all) fields.
 	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no shortcodes found.
 	 */
-	public function get_shortcodes( $context, $fields = array(), $merged = FALSE ) {
+	public function get_shortcodes($context, $fields = array(), $merged = FALSE) {
 		$messenger = $this->messenger();
 		$message_type = $this->message_type();
-		return EEH_MSG_Template::get_shortcodes( $message_type, $messenger, $fields, $context, $merged );
+		return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
 	}
 
 
@@ -340,7 +340,7 @@ 
 	 * @return string
 	 */
 	public function get_template_pack_name() {
-		return $this->get_extra_meta( 'MTP_template_pack', true, 'default' );
+		return $this->get_extra_meta('MTP_template_pack', true, 'default');
 	}
 
 
@@ -355,8 +355,8 @@ 
 	 */
 	public function get_template_pack() {
 		$pack_name = $this->get_template_pack_name();
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::get_template_pack( $pack_name );
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($pack_name);
 	}
 
 
@@ -369,7 +369,7 @@ 
 	 * @return string
 	 */
 	public function get_template_pack_variation() {
-		return $this->get_extra_meta( 'MTP_variation', TRUE, 'default' );
+		return $this->get_extra_meta('MTP_variation', TRUE, 'default');
 	}
 
 
@@ -381,8 +381,8 @@ 
 	 * @param string $template_pack_name What message template pack is assigned.
 	 * @return int
 	 */
-	public function set_template_pack_name( $template_pack_name ) {
-		return $this->update_extra_meta( 'MTP_template_pack', $template_pack_name );
+	public function set_template_pack_name($template_pack_name) {
+		return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
 	}
 
 
@@ -394,8 +394,8 @@ 
 	 * @param string $variation What variation is being set on the message template group.
 	 * @return int
 	 */
-	public function set_template_pack_variation( $variation ) {
-		return $this->update_extra_meta( 'MTP_variation', $variation );
+	public function set_template_pack_variation($variation) {
+		return $this->update_extra_meta('MTP_variation', $variation);
 	}
 }
 //end EE_Message_Template_Group class

modules/messages/EED_Messages.module.php

Spacing +182 added lines, -182 removed lines

@@ -69,7 +69,7 @@ 
 	 * @return EED_Module
 	 */
 	public static function instance() {
-		return parent::get_instance( __CLASS__ );
+		return parent::get_instance(__CLASS__);
 	}
 
 
@@ -84,11 +84,11 @@ 
 	 */
 	public static function set_hooks() {
 		//actions
-		add_action( 'AHEE__EE_Payment_Processor__update_txn_based_on_payment', array( 'EED_Messages', 'payment' ), 10, 2 );
-		add_action( 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', array( 'EED_Messages', 'maybe_registration' ), 10, 2 );
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications', array('EED_Messages', 'maybe_registration'), 10, 2);
 		//filters
-		add_filter( 'FHEE__EE_Registration__receipt_url__receipt_url', array( 'EED_Messages', 'registration_message_trigger_url' ), 10, 4 );
-		add_filter( 'FHEE__EE_Registration__invoice_url__invoice_url', array( 'EED_Messages', 'registration_message_trigger_url' ), 10, 4 );
+		add_filter('FHEE__EE_Registration__receipt_url__receipt_url', array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
+		add_filter('FHEE__EE_Registration__invoice_url__invoice_url', array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
 		//register routes
 		self::_register_routes();
 	}
@@ -101,16 +101,16 @@ 
 	 */
 	public static function set_hooks_admin() {
 		//actions
-		add_action( 'AHEE__EE_Payment_Processor__update_txn_based_on_payment', array( 'EED_Messages', 'payment' ), 10, 2 );
-		add_action( 'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder', array( 'EED_Messages', 'payment_reminder' ), 10 );
-		add_action( 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', array( 'EED_Messages', 'maybe_registration' ), 10, 3 );
-		add_action( 'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations', array( 'EED_Messages', 'send_newsletter_message' ), 10, 2 );
-		add_action( 'AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', array( 'EED_Messages', 'cancelled_registration' ), 10 );
-		add_action( 'AHEE__EE_Admin_Page___process_admin_payment_notification', array( 'EED_Messages', 'process_admin_payment' ), 10, 1 );
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action('AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder', array('EED_Messages', 'payment_reminder'), 10);
+		add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications', array('EED_Messages', 'maybe_registration'), 10, 3);
+		add_action('AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations', array('EED_Messages', 'send_newsletter_message'), 10, 2);
+		add_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', array('EED_Messages', 'cancelled_registration'), 10);
+		add_action('AHEE__EE_Admin_Page___process_admin_payment_notification', array('EED_Messages', 'process_admin_payment'), 10, 1);
 		//filters
-		add_filter( 'FHEE__EE_Admin_Page___process_resend_registration__success', array( 'EED_Messages', 'process_resend' ), 10, 2 );
-		add_filter( 'FHEE__EE_Registration__receipt_url__receipt_url', array( 'EED_Messages', 'registration_message_trigger_url' ), 10, 4 );
-		add_filter( 'FHEE__EE_Registration__invoice_url__invoice_url', array( 'EED_Messages', 'registration_message_trigger_url' ), 10, 4 );
+		add_filter('FHEE__EE_Admin_Page___process_resend_registration__success', array('EED_Messages', 'process_resend'), 10, 2);
+		add_filter('FHEE__EE_Registration__receipt_url__receipt_url', array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
+		add_filter('FHEE__EE_Registration__invoice_url__invoice_url', array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
 	}
 
 
@@ -124,11 +124,11 @@ 
 	 * @return void
 	 */
 	protected static function _register_routes() {
-		EE_Config::register_route( 'msg_url_trigger', 'Messages', 'run' );
-		EE_Config::register_route( 'msg_cron_trigger', 'Messages', 'execute_batch_request' );
-		EE_Config::register_route( 'msg_browser_trigger', 'Messages', 'browser_trigger' );
-		EE_Config::register_route( 'msg_browser_error_trigger', 'Messages', 'browser_error_trigger' );
-		do_action( 'AHEE__EED_Messages___register_routes' );
+		EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
+		EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
+		EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
+		EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
+		do_action('AHEE__EED_Messages___register_routes');
 	}
 
 
@@ -139,18 +139,18 @@ 
 	 * @since 4.9.0
 	 * @param WP $WP
 	 */
-	public function browser_trigger( $WP ) {
+	public function browser_trigger($WP) {
 		//ensure controller is loaded
 		self::_load_controller();
-		$token = EE_Registry::instance()->REQ->get( 'token' );
+		$token = EE_Registry::instance()->REQ->get('token');
 		try {
-			$mtg = new EE_Message_Generated_From_Token( $token, 'html', self::$_message_resource_manager );
-			self::$_MSG_PROCESSOR->generate_and_send_now( $mtg );
-		} catch( EE_Error $e ) {
-			$error_msg = __( 'Please note that a system message failed to send due to a technical issue.', 'event_espresso' );
+			$mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
+			self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
+		} catch (EE_Error $e) {
+			$error_msg = __('Please note that a system message failed to send due to a technical issue.', 'event_espresso');
 			// add specific message for developers if WP_DEBUG in on
-			$error_msg .= '||' . $e->getMessage();
-			EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ );
+			$error_msg .= '||'.$e->getMessage();
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
 		}
 	}
 
@@ -166,20 +166,20 @@ 
 	 * @since 4.9.0
 	 * @param $WP
 	 */
-	public function browser_error_trigger( $WP ) {
-		$token = EE_Registry::instance()->REQ->get( 'token' );
-		if ( $token ) {
-			$message = EEM_Message::instance()->get_one_by_token( $token );
-			if ( $message instanceof EE_Message ) {
-				header( 'HTTP/1.1 200 OK' );
-				$error_msg = nl2br( $message->error_message() );
+	public function browser_error_trigger($WP) {
+		$token = EE_Registry::instance()->REQ->get('token');
+		if ($token) {
+			$message = EEM_Message::instance()->get_one_by_token($token);
+			if ($message instanceof EE_Message) {
+				header('HTTP/1.1 200 OK');
+				$error_msg = nl2br($message->error_message());
 				?>
 				<!DOCTYPE html>
 				<html>
 					<head></head>
 					<body>
-						<?php echo empty( $error_msg )
-						? esc_html__( 'Unfortunately, we were unable to capture the error message for this message.', 'event_espresso' )
+						<?php echo empty($error_msg)
+						? esc_html__('Unfortunately, we were unable to capture the error message for this message.', 'event_espresso')
 						: wp_kses(
 							$error_msg,
 							array(
@@ -214,19 +214,19 @@ 
 	 * @throws EE_Error
 	 * @return    void
 	 */
-	public function run( $WP ) {
+	public function run($WP) {
 		//ensure controller is loaded
 		self::_load_controller();
 		// attempt to process message
 		try {
 			/** @type EE_Message_To_Generate_From_Request $message_to_generate */
-			$message_to_generate = EE_Registry::instance()->load_lib( 'Message_To_Generate_From_Request' );
-			self::$_MSG_PROCESSOR->generate_and_send_now( $message_to_generate );
-		} catch ( EE_Error $e ) {
-			$error_msg = __( 'Please note that a system message failed to send due to a technical issue.', 'event_espresso' );
+			$message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+			self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
+		} catch (EE_Error $e) {
+			$error_msg = __('Please note that a system message failed to send due to a technical issue.', 'event_espresso');
 			// add specific message for developers if WP_DEBUG in on
-			$error_msg .= '||' . $e->getMessage();
-			EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ );
+			$error_msg .= '||'.$e->getMessage();
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
 		}
 	}
 
@@ -235,9 +235,9 @@ 
 	 * This is triggered by the 'msg_cron_trigger' route.
 	 * @param WP $WP
 	 */
-	public function execute_batch_request( $WP ) {
+	public function execute_batch_request($WP) {
 		$this->run_cron();
-		header( 'HTTP/1.1 200 OK' );
+		header('HTTP/1.1 200 OK');
 		exit();
 	}
 
@@ -251,35 +251,35 @@ 
 	public function run_cron() {
 		self::_load_controller();
 		//get required vars
-		$cron_type = EE_Registry::instance()->REQ->get( 'type' );
-		$transient_key = EE_Registry::instance()->REQ->get( 'key' );
+		$cron_type = EE_Registry::instance()->REQ->get('type');
+		$transient_key = EE_Registry::instance()->REQ->get('key');
 
 		//now let's verify transient, if not valid exit immediately
-		if ( ! get_transient( $transient_key ) ) {
+		if ( ! get_transient($transient_key)) {
 			/**
 			 * trigger error so this gets in the error logs.  This is important because it happens on a non-user request.
 			 */
-			trigger_error( esc_attr__( 'Invalid Request (Transient does not exist)', 'event_espresso' ) );
+			trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
 		}
 
 		//if made it here, lets' delete the transient to keep the db clean
-		delete_transient( $transient_key );
+		delete_transient($transient_key);
 
-		if ( apply_filters( 'FHEE__EED_Messages__run_cron__use_wp_cron', true ) ) {
+		if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
 
-			$method = 'batch_' . $cron_type . '_from_queue';
-			if ( method_exists( self::$_MSG_PROCESSOR, $method ) ) {
+			$method = 'batch_'.$cron_type.'_from_queue';
+			if (method_exists(self::$_MSG_PROCESSOR, $method)) {
 				self::$_MSG_PROCESSOR->$method();
 			} else {
 				//no matching task
 				/**
 				 * trigger error so this gets in the error logs.  This is important because it happens on a non user request.
 				 */
-				trigger_error( esc_attr( sprintf( __( 'There is no task corresponding to this route %s', 'event_espresso' ), $cron_type ) ) );
+				trigger_error(esc_attr(sprintf(__('There is no task corresponding to this route %s', 'event_espresso'), $cron_type)));
 			}
 		}
 
-		do_action( 'FHEE__EED_Messages__run_cron__end' );
+		do_action('FHEE__EED_Messages__run_cron__end');
 	}
 
 
@@ -295,9 +295,9 @@ 
 	 *
 	 * @return EE_Messages_Template_Pack
 	 */
-	public static function get_template_pack( $template_pack_name ) {
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::get_template_pack( $template_pack_name );
+	public static function get_template_pack($template_pack_name) {
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($template_pack_name);
 	}
 
 
@@ -311,14 +311,14 @@ 
 	 * @return EE_Messages_Template_Pack[]
 	 */
 	public static function get_template_packs() {
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
+		EE_Registry::instance()->load_helper('MSG_Template');
 
 		//for backward compat, let's make sure this returns in the same format as originally.
 		$template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
 		$template_pack_collection->rewind();
 		$template_packs = array();
-		while ( $template_pack_collection->valid() ) {
-			$template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
+		while ($template_pack_collection->valid()) {
+			$template_packs[$template_pack_collection->current()->dbref] = $template_pack_collection->current();
 			$template_pack_collection->next();
 		}
 		return $template_packs;
@@ -334,14 +334,14 @@ 
 	 * @return void
 	 */
 	public static function set_autoloaders() {
-		if ( empty( self::$_MSG_PATHS ) ) {
+		if (empty(self::$_MSG_PATHS)) {
 			self::_set_messages_paths();
-			foreach ( self::$_MSG_PATHS as $path ) {
-				EEH_Autoloader::register_autoloaders_for_each_file_in_folder( $path );
+			foreach (self::$_MSG_PATHS as $path) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
 			}
 			// add aliases
-			EEH_Autoloader::add_alias( 'EE_messages', 'EE_messages' );
-			EEH_Autoloader::add_alias( 'EE_messenger', 'EE_messenger' );
+			EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
+			EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
 		}
 	}
 
@@ -369,10 +369,10 @@ 
 			'shortcodes',
 			);
 		$paths = array();
-		foreach ( $dir_ref as $index => $dir ) {
-			$paths[ $index ] = EE_LIBRARIES . $dir;
+		foreach ($dir_ref as $index => $dir) {
+			$paths[$index] = EE_LIBRARIES.$dir;
 		}
-		self::$_MSG_PATHS = apply_filters( 'FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths );
+		self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
 	}
 
 
@@ -383,12 +383,12 @@ 
 	 * @return void
 	 */
 	protected static function _load_controller() {
-		if ( ! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor ) {
-			EE_Registry::instance()->load_core( 'Request_Handler' );
+		if ( ! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
+			EE_Registry::instance()->load_core('Request_Handler');
 			self::set_autoloaders();
-			self::$_EEMSG = EE_Registry::instance()->load_lib( 'messages' );
-			self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib( 'Messages_Processor' );
-			self::$_message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+			self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
+			self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib('Messages_Processor');
+			self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		}
 	}
 
@@ -397,10 +397,10 @@ 
 	/**
 	 * @param EE_Transaction $transaction
 	 */
-	public static function payment_reminder( EE_Transaction $transaction ) {
+	public static function payment_reminder(EE_Transaction $transaction) {
 		self::_load_controller();
-		$data = array( $transaction, null );
-		self::$_MSG_PROCESSOR->generate_for_all_active_messengers( 'payment_reminder', $data );
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
 	}
 
 
@@ -411,14 +411,14 @@ 
 	 * @param  EE_Payment object
 	 * @return void
 	 */
-	public static function payment( EE_Transaction $transaction, EE_Payment $payment ) {
+	public static function payment(EE_Transaction $transaction, EE_Payment $payment) {
 		self::_load_controller();
-		$data = array( $transaction, $payment );
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		$message_type = EEH_MSG_Template::convert_payment_status_to_message_type( $payment->STS_ID() );
+		$data = array($transaction, $payment);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
 		//if payment amount is less than 0 then switch to payment_refund message type.
 		$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-		self::$_MSG_PROCESSOR->generate_for_all_active_messengers( $message_type, $data );
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
 	}
 
 
@@ -426,10 +426,10 @@ 
 	/**
 	 * @param EE_Transaction $transaction
 	 */
-	public static function cancelled_registration( EE_Transaction $transaction ) {
+	public static function cancelled_registration(EE_Transaction $transaction) {
 		self::_load_controller();
-		$data = array( $transaction, null );
-		self::$_MSG_PROCESSOR->generate_for_all_active_messengers( 'cancelled_registration', $data );
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
 	}
 
 
@@ -442,9 +442,9 @@ 
 	 * @param array $extra_details
 	 * @return void
 	 */
-	public static function maybe_registration( EE_Registration $registration, $extra_details = array() ) {
+	public static function maybe_registration(EE_Registration $registration, $extra_details = array()) {
 
-		if ( ! self::_verify_registration_notification_send( $registration, $extra_details ) ) {
+		if ( ! self::_verify_registration_notification_send($registration, $extra_details)) {
 			//no messages please
 			return;
 		}
@@ -459,22 +459,22 @@ 
 		$mtgs = array();
 
 		//loop through registrations and trigger messages once per status.
-		foreach ( $all_registrations as $reg ) {
+		foreach ($all_registrations as $reg) {
 
 			//already triggered?
-			if ( in_array( $reg->status_ID(), $statuses_sent ) ) {
+			if (in_array($reg->status_ID(), $statuses_sent)) {
 				continue;
 			}
 
-			$message_type = EEH_MSG_Template::convert_reg_status_to_message_type( $reg->status_ID() );
-			$mtgs = $mtgs + self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers( $message_type, array( $registration->transaction(), null, $reg->status_ID() ) );
+			$message_type = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
+			$mtgs = $mtgs + self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers($message_type, array($registration->transaction(), null, $reg->status_ID()));
 			$statuses_sent[] = $reg->status_ID();
 		}
 
-		$mtgs = $mtgs + self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers( 'registration_summary', array( $registration->transaction(), null ) );
+		$mtgs = $mtgs + self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers('registration_summary', array($registration->transaction(), null));
 
 		//batch queue and initiate request
-		self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist( $mtgs );
+		self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
 		self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
 	}
 
@@ -489,39 +489,39 @@ 
 	 *
 	 * @return bool          true = send away, false = nope halt the presses.
 	 */
-	protected static function _verify_registration_notification_send( EE_Registration $registration, $extra_details = array() ) {
+	protected static function _verify_registration_notification_send(EE_Registration $registration, $extra_details = array()) {
 		 //self::log(
 		 //	__CLASS__, __FUNCTION__, __LINE__,
 		 //	$registration->transaction(),
 		 //	array( '$extra_details' => $extra_details )
 		 //);
 		// currently only using this to send messages for the primary registrant
-		if ( ! $registration->is_primary_registrant() ) {
+		if ( ! $registration->is_primary_registrant()) {
 			return false;
 		}
 		// first we check if we're in admin and not doing front ajax
-		if ( is_admin() && ! EE_FRONT_AJAX ) {
+		if (is_admin() && ! EE_FRONT_AJAX) {
 			//make sure appropriate admin params are set for sending messages
-			if ( empty( $_REQUEST['txn_reg_status_change']['send_notifications'] ) || ! absint( $_REQUEST['txn_reg_status_change']['send_notifications'] ) ) {
+			if (empty($_REQUEST['txn_reg_status_change']['send_notifications']) || ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])) {
 				//no messages sent please.
 				return false;
 			}
 		} else {
 			// frontend request (either regular or via AJAX)
 			// TXN is NOT finalized ?
-			if ( ! isset( $extra_details['finalized'] ) || $extra_details['finalized'] === false ) {
+			if ( ! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
 				return false;
 			}
 			// return visit but nothing changed ???
 			if (
-				isset( $extra_details['revisit'], $extra_details['status_updates'] ) &&
+				isset($extra_details['revisit'], $extra_details['status_updates']) &&
 				$extra_details['revisit'] && ! $extra_details['status_updates']
 			) {
 				return false;
 			}
 			// NOT sending messages && reg status is something other than "Not-Approved"
 			if (
-				! apply_filters( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', false ) &&
+				! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
 				$registration->status_ID() !== EEM_Registration::status_id_not_approved
 			) {
 				return false;
@@ -543,10 +543,10 @@ 
 	 *
 	 * @return array
 	 */
-	protected static function _get_reg_status_array( $reg_status = '' ) {
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::convert_reg_status_to_message_type( $reg_status )
-			? EEH_MSG_Template::convert_reg_status_to_message_type( $reg_status )
+	protected static function _get_reg_status_array($reg_status = '') {
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
 			: EEH_MSG_Template::reg_status_to_message_type_array();
 	}
 
@@ -562,10 +562,10 @@ 
 	 *
 	 * @return string|bool The payment message type slug matching the status or false if no match.
 	 */
-	protected static function _get_payment_message_type( $payment_status ) {
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::convert_payment_status_to_message_type( $payment_status )
-			? EEH_MSG_Template::convert_payment_status_to_message_type( $payment_status )
+	protected static function _get_payment_message_type($payment_status) {
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
 			: false;
 	}
 
@@ -579,33 +579,33 @@ 
 	 * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
 	 * @return bool          success/fail
 	 */
-	public static function process_resend( $req_data ) {
+	public static function process_resend($req_data) {
 		self::_load_controller();
 
 		//if $msgID in this request then skip to the new resend_message
-		if ( EE_Registry::instance()->REQ->get( 'MSG_ID' ) ) {
+		if (EE_Registry::instance()->REQ->get('MSG_ID')) {
 			return self::resend_message();
 		}
 
 		//make sure any incoming request data is set on the REQ so that it gets picked up later.
 		$req_data = (array) $req_data;
-		foreach( $req_data as $request_key => $request_value ) {
-			EE_Registry::instance()->REQ->set( $request_key, $request_value );
+		foreach ($req_data as $request_key => $request_value) {
+			EE_Registry::instance()->REQ->set($request_key, $request_value);
 		}
 
-		if ( ! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request() ) {
+		if ( ! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request()) {
 			return false;
 		}
 
 		try {
-			self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist( $messages_to_send );
+			self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
 			self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-		} catch( EE_Error $e ) {
-			EE_Error::add_error( $e->getMessage(), __FILE__, __FUNCTION__, __LINE__ );
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		EE_Error::add_success(
-			__( 'Messages have been successfully queued for generation and sending.', 'event_espresso' )
+			__('Messages have been successfully queued for generation and sending.', 'event_espresso')
 		);
 		return true; //everything got queued.
 	}
@@ -618,17 +618,17 @@ 
 	public static function resend_message() {
 		self::_load_controller();
 
-		$msgID = EE_Registry::instance()->REQ->get( 'MSG_ID' );
-		if ( ! $msgID ) {
-			EE_Error::add_error( __( 'Something went wrong because there is no "MSG_ID" value in the request', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		$msgID = EE_Registry::instance()->REQ->get('MSG_ID');
+		if ( ! $msgID) {
+			EE_Error::add_error(__('Something went wrong because there is no "MSG_ID" value in the request', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 
-		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send( (array) $msgID );
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array) $msgID);
 
 		//setup success message.
-		$count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue( EEM_Message::status_resend );
-		EE_Error::add_success( sprintf(
+		$count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+		EE_Error::add_success(sprintf(
 			_n(
 				'There was %d message queued for resending.',
 				'There were %d messages queued for resending.',
@@ -636,7 +636,7 @@ 
 				'event_espresso'
 			),
 			$count_ready_for_resend
-		) );
+		));
 		return true;
 	}
 
@@ -649,13 +649,13 @@ 
 	 * @param  EE_Payment $payment EE_payment object
 	 * @return bool              success/fail
 	 */
-	public static function process_admin_payment( EE_Payment $payment ) {
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
+	public static function process_admin_payment(EE_Payment $payment) {
+		EE_Registry::instance()->load_helper('MSG_Template');
 		//we need to get the transaction object
 		$transaction = $payment->transaction();
-		if ( $transaction instanceof EE_Transaction ) {
-			$data = array( $transaction, $payment );
-			$message_type = EEH_MSG_Template::convert_payment_status_to_message_type( $payment->STS_ID() );
+		if ($transaction instanceof EE_Transaction) {
+			$data = array($transaction, $payment);
+			$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
 
 			//if payment amount is less than 0 then switch to payment_refund message type.
 			$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
@@ -665,22 +665,22 @@ 
 
 			self::_load_controller();
 
-			self::$_MSG_PROCESSOR->generate_for_all_active_messengers( $message_type, $data );
+			self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
 
 			//get count of queued for generation
-			$count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue( array( EEM_Message::status_incomplete, EEM_Message::status_idle ) );
+			$count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(array(EEM_Message::status_incomplete, EEM_Message::status_idle));
 
-			if ( $count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0 ) {
-				add_filter( 'FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true' );
+			if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
+				add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
 				return true;
 			} else {
-				$count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue( EEM_Message::instance()->stati_indicating_failed_sending() );
+				$count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::instance()->stati_indicating_failed_sending());
 				/**
 				 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
 				 * IMMEDIATE generation.
 				 */
-				if ( $count_failed > 0 ) {
-					EE_Error::add_error( sprintf(
+				if ($count_failed > 0) {
+					EE_Error::add_error(sprintf(
 						_n(
 							'The payment notification generation failed.',
 							'%d payment notifications failed being sent.',
@@ -688,11 +688,11 @@ 
 							'event_espresso'
 						),
 						$count_failed
-					), __FILE__, __FUNCTION__, __LINE__ );
+					), __FILE__, __FUNCTION__, __LINE__);
 
 					return false;
 				} else {
-					add_filter( 'FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true' );
+					add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
 					return true;
 				}
 			}
@@ -716,11 +716,11 @@ 
 	 * @param  int      	      $grp_id     a specific message template group id.
 	 * @return void
 	 */
-	public static function send_newsletter_message( $registrations, $grp_id ) {
+	public static function send_newsletter_message($registrations, $grp_id) {
 		//make sure mtp is id and set it in the EE_Request Handler later messages setup.
-		EE_Registry::instance()->REQ->set( 'GRP_ID', (int) $grp_id );
+		EE_Registry::instance()->REQ->set('GRP_ID', (int) $grp_id);
 		self::_load_controller();
-		self::$_MSG_PROCESSOR->generate_for_all_active_messengers( 'newsletter', $registrations );
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
 	}
 
 
@@ -735,9 +735,9 @@ 
 	 * @param string 	$message_type
 	 * @return 	string
 	 */
-	public static function registration_message_trigger_url( $registration_message_trigger_url, EE_Registration $registration, $messenger = 'html', $message_type = 'invoice' ) {
+	public static function registration_message_trigger_url($registration_message_trigger_url, EE_Registration $registration, $messenger = 'html', $message_type = 'invoice') {
 		// whitelist $messenger
-		switch ( $messenger ) {
+		switch ($messenger) {
 			case 'pdf' :
 				$sending_messenger = 'pdf';
 				$generating_messenger = 'html';
@@ -749,7 +749,7 @@ 
 				break;
 		}
 		// whitelist $message_type
-		switch ( $message_type ) {
+		switch ($message_type) {
 			case 'receipt' :
 				$message_type = 'receipt';
 				break;
@@ -759,7 +759,7 @@ 
 				break;
 		}
 		// verify that both the messenger AND the message type are active
-		if ( EEH_MSG_Template::is_messenger_active( $sending_messenger ) && EEH_MSG_Template::is_mt_active( $message_type ) ) {
+		if (EEH_MSG_Template::is_messenger_active($sending_messenger) && EEH_MSG_Template::is_mt_active($message_type)) {
 			//need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
 			$template_query_params = array(
 				'MTP_is_active' => true,
@@ -768,16 +768,16 @@ 
 				'Event.EVT_ID' => $registration->event_ID()
 			);
 			//get the message template group.
-			$msg_template_group = EEM_Message_Template_Group::instance()->get_one( array( $template_query_params ) );
+			$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
 			//if we don't have an EE_Message_Template_Group then return
-			if ( ! $msg_template_group instanceof EE_Message_Template_Group ) {
+			if ( ! $msg_template_group instanceof EE_Message_Template_Group) {
 				// remove EVT_ID from query params so that global templates get picked up
-				unset( $template_query_params['Event.EVT_ID'] );
+				unset($template_query_params['Event.EVT_ID']);
 				//get global template as the fallback
-				$msg_template_group = EEM_Message_Template_Group::instance()->get_one( array( $template_query_params ) );
+				$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
 			}
 			//if we don't have an EE_Message_Template_Group then return
-			if ( ! $msg_template_group instanceof EE_Message_Template_Group ) {
+			if ( ! $msg_template_group instanceof EE_Message_Template_Group) {
 				return '';
 			}
 			// generate the URL
@@ -806,7 +806,7 @@ 
 	 * @param bool 	  $send true we will do a test send using the messenger delivery, false we just do a regular preview
 	 * @return string|bool          The body of the message or if send is requested, sends.
 	 */
-	public static function preview_message( $type, $context, $messenger, $send = false ) {
+	public static function preview_message($type, $context, $messenger, $send = false) {
 		self::_load_controller();
 		$mtg = new EE_Message_To_Generate(
 			$messenger,
@@ -815,8 +815,8 @@ 
 			$context,
 			true
 		);
-		$generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview( $mtg, $send );
-		if ( $generated_preview_queue instanceof EE_Messages_Queue ) {
+		$generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
+		if ($generated_preview_queue instanceof EE_Messages_Queue) {
 			return $generated_preview_queue->get_message_repository()->current()->content();
 		} else {
 			return $generated_preview_queue;
@@ -843,7 +843,7 @@ 
 	 *
 	 * @return bool          success or fail.
 	 */
-	public static function send_message_with_messenger_only( $messenger, $message_type, EE_Messages_Queue $queue, $custom_subject = '' ) {
+	public static function send_message_with_messenger_only($messenger, $message_type, EE_Messages_Queue $queue, $custom_subject = '') {
 		self::_load_controller();
 		/** @type EE_Message_To_Generate_From_Queue $message_to_generate */
 		$message_to_generate = EE_Registry::instance()->load_lib(
@@ -855,7 +855,7 @@ 
 				$custom_subject,
 			)
 		);
-		return self::$_MSG_PROCESSOR->queue_for_sending( $message_to_generate );
+		return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
 	}
 
 
@@ -868,22 +868,22 @@ 
 	 * @param array     $message_ids An array of message ids
 	 * @return bool | EE_Messages_Queue     false if nothing was generated, EE_Messages_Queue containing generated messages.
 	 */
-	public static function generate_now( $message_ids ) {
+	public static function generate_now($message_ids) {
 		self::_load_controller();
 		$messages = EEM_Message::instance()->get_all(
 			array(
 				0 => array(
-					'MSG_ID' => array( 'IN', $message_ids ),
+					'MSG_ID' => array('IN', $message_ids),
 					'STS_ID' => EEM_Message::status_incomplete,
 				)
 			)
 		);
 
-		$generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue( $messages );
+		$generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
 
-		if ( ! $generated_queue instanceof EE_Messages_Queue ) {
+		if ( ! $generated_queue instanceof EE_Messages_Queue) {
 			EE_Error::add_error(
-				__( 'The messages were not generated.  This is usually because there is already a batch being generated on a separate request.  You can wait a minute or two and try again.', 'event_espresso' ),
+				__('The messages were not generated.  This is usually because there is already a batch being generated on a separate request.  You can wait a minute or two and try again.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 		}
@@ -902,28 +902,28 @@ 
 	 *
 	 * @return bool | EE_Messages_Queue  false if no messages sent.
 	 */
-	public static function send_now( $message_ids ) {
+	public static function send_now($message_ids) {
 		self::_load_controller();
 		$messages = EEM_Message::instance()->get_all(
 			array(
 				0 => array(
-					'MSG_ID' => array( 'IN', $message_ids ),
-					'STS_ID' => array( 'IN', array( EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry ) )
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => array('IN', array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry))
 				)
 			)
 		);
 
-		$sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue( $messages );
+		$sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
 
-		if ( ! $sent_queue instanceof EE_Messages_Queue ) {
+		if ( ! $sent_queue instanceof EE_Messages_Queue) {
 			EE_Error::add_error(
-				__( 'The messages were not sent.  This is usually because there is already a batch being sent on a separate request.  You can wait a minute or two and try again.', 'event_espresso' ),
+				__('The messages were not sent.  This is usually because there is already a batch being sent on a separate request.  You can wait a minute or two and try again.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 		} else {
 			//can count how many sent by using the messages in the queue
-			$sent_count = $sent_queue->count_STS_in_queue( EEM_Message::instance()->stati_indicating_sent() );
-			if ( $sent_count > 0 ) {
+			$sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
+			if ($sent_count > 0) {
 				EE_Error::add_success(
 					sprintf(
 						_n(
@@ -938,8 +938,8 @@ 
 			} else {
 				EE_Error::overwrite_errors();
 				EE_Error::add_error(
-					__( 'No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
-					If there was an error, you can look at the messages in the message activity list table for any error messages.', 'event_espresso' ),
+					__('No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
+					If there was an error, you can look at the messages in the message activity list table for any error messages.', 'event_espresso'),
 					__FILE__, __FUNCTION__, __LINE__
 				);
 			}
@@ -960,13 +960,13 @@ 
 	 *
 	 * @return bool  true means messages were successfully queued for resending, false means none were queued for resending.
 	 */
-	public static function queue_for_resending( $message_ids ) {
+	public static function queue_for_resending($message_ids) {
 		self::_load_controller();
-		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send( $message_ids );
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
 
 		//get queue and count
-		$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue( EEM_Message::status_resend );
-		if ( $queue_count > 0 ) {
+		$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+		if ($queue_count > 0) {
 			EE_Error::add_success(
 				sprintf(
 					_n(
@@ -980,7 +980,7 @@ 
 			);
 		} else {
 			EE_Error::add_error(
-				__( 'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.', 'event_espresso' ),
+				__('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 		}
@@ -1002,16 +1002,16 @@ 
 	 * @param array $info
 	 * @param bool $display_request
 	 */
-	protected static function log( $class = '', $func = '', $line = '', EE_Transaction $transaction, $info = array(), $display_request = false ) {
-		if ( WP_DEBUG && false ) {
-			if ( $transaction instanceof EE_Transaction ) {
+	protected static function log($class = '', $func = '', $line = '', EE_Transaction $transaction, $info = array(), $display_request = false) {
+		if (WP_DEBUG && false) {
+			if ($transaction instanceof EE_Transaction) {
 				// don't serialize objects
-				$info = EEH_Debug_Tools::strip_objects( $info );
+				$info = EEH_Debug_Tools::strip_objects($info);
 				$info['TXN_status'] = $transaction->status_ID();
 				$info['TXN_reg_steps'] = $transaction->reg_steps();
-				if ( $transaction->ID() ) {
-					$index = 'EE_Transaction: ' . $transaction->ID();
-					EEH_Debug_Tools::log( $class, $func, $line, $info, $display_request, $index );
+				if ($transaction->ID()) {
+					$index = 'EE_Transaction: '.$transaction->ID();
+					EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
 				}
 			}
 		}

core/libraries/form_sections/strategies/display/EE_Checkbox_Display_Strategy.strategy.php

Spacing +20 added lines, -20 removed lines

@@ -18,42 +18,42 @@
 	 * @throws EE_Error
 	 * @return string of html to display the field
 	 */
-	public function display(){
+	public function display() {
 		$input = $this->get_input();
 		//d( $input );
-		$multi = count( $input->options() ) > 1 ? TRUE : FALSE;
+		$multi = count($input->options()) > 1 ? TRUE : FALSE;
 		$input->set_label_sizes();
 		$label_size_class = $input->get_label_size_class();
 		$html = '';
-		if ( ! is_array( $input->raw_value() ) && $input->raw_value() !== NULL ) {
+		if ( ! is_array($input->raw_value()) && $input->raw_value() !== NULL) {
 			EE_Error::doing_it_wrong(
 				'EE_Checkbox_Display_Strategy::display()',
 				sprintf(
-					__( 'Input values for checkboxes should be an array of values, but the value for input "%1$s" is "%2$s". Please verify that the input name is exactly "%3$s"', 'event_espresso'),
+					__('Input values for checkboxes should be an array of values, but the value for input "%1$s" is "%2$s". Please verify that the input name is exactly "%3$s"', 'event_espresso'),
 					$input->html_id(),
-					var_export( $input->raw_value(), true),
-					$input->html_name() . '[]'
+					var_export($input->raw_value(), true),
+					$input->html_name().'[]'
 				),
 				'4.8.1'
 			);
 		}
-		$input_raw_value = (array)$input->raw_value();
-		foreach( $input->options() as $value => $display_text ){
-			$value = $input->get_normalization_strategy()->unnormalize_one( $value );
-			$html_id = $multi ? $this->get_sub_input_id( $value ) : $input->html_id();
-			$html .= EEH_HTML::nl( 0, 'checkbox' );
-			$html .= '<label for="' . $html_id . '" id="' . $html_id . '-lbl" class="ee-checkbox-label-after' . $label_size_class . '">';
-			$html .= EEH_HTML::nl( 1, 'checkbox' );
+		$input_raw_value = (array) $input->raw_value();
+		foreach ($input->options() as $value => $display_text) {
+			$value = $input->get_normalization_strategy()->unnormalize_one($value);
+			$html_id = $multi ? $this->get_sub_input_id($value) : $input->html_id();
+			$html .= EEH_HTML::nl(0, 'checkbox');
+			$html .= '<label for="'.$html_id.'" id="'.$html_id.'-lbl" class="ee-checkbox-label-after'.$label_size_class.'">';
+			$html .= EEH_HTML::nl(1, 'checkbox');
 			$html .= '<input type="checkbox"';
-			$html .= ' name="' . $input->html_name() . '[]"';
-			$html .= ' id="' . $html_id . '"';
-			$html .= ' class="' . $input->html_class() . '"';
-			$html .= ' style="' . $input->html_style() . '"';
-			$html .= ' value="' . esc_attr( $value ) . '"';
-			$html .= ! empty( $input_raw_value ) && in_array( $value, $input_raw_value ) ? ' checked="checked"' : '';
+			$html .= ' name="'.$input->html_name().'[]"';
+			$html .= ' id="'.$html_id.'"';
+			$html .= ' class="'.$input->html_class().'"';
+			$html .= ' style="'.$input->html_style().'"';
+			$html .= ' value="'.esc_attr($value).'"';
+			$html .= ! empty($input_raw_value) && in_array($value, $input_raw_value) ? ' checked="checked"' : '';
 			$html .= '>&nbsp;';
 			$html .= $display_text;
-			$html .= EEH_HTML::nl( -1, 'checkbox' ) . '</label>';
+			$html .= EEH_HTML::nl( -1, 'checkbox' ).'</label>';
 		}
 		return $html;
 	}

core/libraries/form_sections/strategies/display/EE_Select2_Display_Strategy.strategy.php

Spacing +9 added lines, -9 removed lines

@@ -12,7 +12,7 @@ 
  * @since 				$VID:$
  *
  */
-class EE_Select2_Display_Strategy extends EE_Select_Display_Strategy{
+class EE_Select2_Display_Strategy extends EE_Select_Display_Strategy {
 	
 	/**
 	 * Arguments that will be passed into the select2 javascript constructor
@@ -25,7 +25,7 @@ 
 	 * @param array $select2_js_args pass in the EXACT array of JS arguments you want
 	 * to pass into the select2 js/html input. See https://select2.github.io
 	 */
-	public function __construct( $select2_js_args = array() ) {
+	public function __construct($select2_js_args = array()) {
 		$this->_select2_js_args = $select2_js_args;
 		parent::__construct();
 	}
@@ -35,8 +35,8 @@ 
 	 * the select2 css
 	 */
 	public function enqueue_js() {
-		wp_enqueue_script( 'form_section_select2_init', EE_GLOBAL_ASSETS_URL . 'scripts/form_section_select2_init.js', array( 'select2' ), '1.0.0', true );
-		wp_enqueue_style( 'select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all' );
+		wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL.'scripts/form_section_select2_init.js', array('select2'), '1.0.0', true);
+		wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL.'css/select2.min.css', array(), '4.0.2', 'all');
 	}
 	
 	/**
@@ -51,7 +51,7 @@ 
 	 * Sets the exact js args which will be passed into the select2 js/html input
 	 * @param array $js_args
 	 */
-	public function set_js_args( $js_args ) {
+	public function set_js_args($js_args) {
 		$this->_select2_js_args = $js_args;
 	}
 	
@@ -60,12 +60,12 @@ 
 	 * @param array $other_js_data
 	 * @return array
 	 */
-	public function get_other_js_data( $other_js_data = array() ) {
-		$other_js_data = parent::get_other_js_data( $other_js_data );
-		if( ! isset( $other_js_data[ 'select2s' ] ) ) {
+	public function get_other_js_data($other_js_data = array()) {
+		$other_js_data = parent::get_other_js_data($other_js_data);
+		if ( ! isset($other_js_data['select2s'])) {
 			$other_js_data['select2s'] = array();
 		}
-		$other_js_data[ 'select2s' ][ $this->_input->html_id() ] = $this->get_js_args();
+		$other_js_data['select2s'][$this->_input->html_id()] = $this->get_js_args();
 		return $other_js_data;
 	}
 }
\ No newline at end of file

core/libraries/form_sections/base/EE_Form_Section_Proper.form.php

Spacing +181 added lines, -181 removed lines

@@ -7,7 +7,7 @@ 
  * before the hook wp_enqueue_scripts is called (so that the form section can enqueue its needed scripts).
  * However, you may output the form (usually by calling get_html) anywhere you like.
  */
-class EE_Form_Section_Proper extends EE_Form_Section_Validatable{
+class EE_Form_Section_Proper extends EE_Form_Section_Validatable {
 
 	/**
 	 * Subsections
@@ -69,49 +69,49 @@ 
 	 *                               } @see EE_Form_Section_Validatable::__construct()
 	 * @throws \EE_Error
 	 */
-	public function __construct( $options_array = array() ){
-		$options_array = (array) apply_filters( 'FHEE__EE_Form_Section_Proper___construct__options_array', $options_array, $this );
+	public function __construct($options_array = array()) {
+		$options_array = (array) apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_array, $this);
 		//call parent first, as it may be setting the name
 		parent::__construct($options_array);
 		//if they've included subsections in the constructor, add them now
-		if( isset( $options_array['include'] )){
+		if (isset($options_array['include'])) {
 			//we are going to make sure we ONLY have those subsections to include
 			//AND we are going to make sure they're in that specified order
 			$reordered_subsections = array();
-			foreach($options_array['include'] as $input_name){
-				if(isset($this->_subsections[$input_name])){
+			foreach ($options_array['include'] as $input_name) {
+				if (isset($this->_subsections[$input_name])) {
 					$reordered_subsections[$input_name] = $this->_subsections[$input_name];
 				}
 			}
 			$this->_subsections = $reordered_subsections;
 		}
-		if(isset($options_array['exclude'])){
+		if (isset($options_array['exclude'])) {
 			$exclude = $options_array['exclude'];
 			$this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
 		}
-		if(isset($options_array['layout_strategy'])){
+		if (isset($options_array['layout_strategy'])) {
 			$this->_layout_strategy = $options_array['layout_strategy'];
 		}
-		if( ! $this->_layout_strategy){
+		if ( ! $this->_layout_strategy) {
 			$this->_layout_strategy = new EE_Two_Column_Layout();
 		}
 		$this->_layout_strategy->_construct_finalize($this);
 
 		//ok so we are definitely going to want the forms JS,
 		//so enqueue it or remember to enqueue it during wp_enqueue_scripts
-		if( did_action( 'wp_enqueue_scripts' )
-			|| did_action( 'admin_enqueue_scripts' ) ) {
+		if (did_action('wp_enqueue_scripts')
+			|| did_action('admin_enqueue_scripts')) {
 			//ok so they've constructed this object after when they should have.
 			//just enqueue the generic form scripts and initialize the form immediately in the JS
-			\EE_Form_Section_Proper::wp_enqueue_scripts( true );
+			\EE_Form_Section_Proper::wp_enqueue_scripts(true);
 		} else {
-			add_action( 'wp_enqueue_scripts', array( 'EE_Form_Section_Proper', 'wp_enqueue_scripts' ));
-			add_action( 'admin_enqueue_scripts', array( 'EE_Form_Section_Proper', 'wp_enqueue_scripts' ));
+			add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+			add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
 		}
-		add_action( 'wp_footer', array( $this, 'ensure_scripts_localized' ), 1 );
+		add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
 
-		if( isset( $options_array[ 'name' ] ) ) {
-			$this->_construct_finalize( null, $options_array[ 'name' ] );
+		if (isset($options_array['name'])) {
+			$this->_construct_finalize(null, $options_array['name']);
 		}
 	}
 
@@ -124,25 +124,25 @@ 
 	 * @param string                 $name
 	 * @throws \EE_Error
 	 */
-	public function _construct_finalize( $parent_form_section, $name ) {
+	public function _construct_finalize($parent_form_section, $name) {
 		parent::_construct_finalize($parent_form_section, $name);
 		$this->_set_default_name_if_empty();
 		$this->_set_default_html_id_if_empty();
-		foreach( $this->_subsections as $subsection_name => $subsection ){
-			if ( $subsection instanceof EE_Form_Section_Base ) {
-				$subsection->_construct_finalize( $this, $subsection_name );
+		foreach ($this->_subsections as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Base) {
+				$subsection->_construct_finalize($this, $subsection_name);
 			} else {
 				throw new EE_Error(
 					sprintf(
-						__( 'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"', 'event_espresso' ),
+						__('Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"', 'event_espresso'),
 						$subsection_name,
 						get_class($this),
-						$subsection ? get_class($subsection) : __( 'NULL', 'event_espresso' )
+						$subsection ? get_class($subsection) : __('NULL', 'event_espresso')
 					)
 				);
 			}
 		}
-		do_action( 'AHEE__EE_Form_Section_Proper___construct_finalize__end', $this, $parent_form_section, $name );
+		do_action('AHEE__EE_Form_Section_Proper___construct_finalize__end', $this, $parent_form_section, $name);
 	}
 
 
@@ -151,7 +151,7 @@ 
 	 * Gets the layout strategy for this form section
 	 * @return EE_Form_Section_Layout_Base
 	 */
-	public function get_layout_strategy(){
+	public function get_layout_strategy() {
 		return $this->_layout_strategy;
 	}
 
@@ -163,7 +163,7 @@ 
 	 * @param EE_Form_Input_Base $input
 	 * @return string
 	 */
-	public function get_html_for_input($input){
+	public function get_html_for_input($input) {
 		return $this->_layout_strategy->layout_input($input);
 	}
 
@@ -176,7 +176,7 @@ 
 	 * @param null $form_data
 	 * @return boolean
 	 */
-	public function was_submitted($form_data = NULL){
+	public function was_submitted($form_data = NULL) {
 		return $this->form_data_present_in($form_data);
 	}
 
@@ -201,17 +201,17 @@ 
 	 *                          (eg you validated the data then stored it in the DB) you may want to skip this step.
 	 * @return void
 	 */
-	public function receive_form_submission($req_data = NULL, $validate = TRUE){
-		$req_data = apply_filters( 'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this, $validate );
-		if( $req_data === NULL){
-			$req_data = array_merge( $_GET, $_POST );
+	public function receive_form_submission($req_data = NULL, $validate = TRUE) {
+		$req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this, $validate);
+		if ($req_data === NULL) {
+			$req_data = array_merge($_GET, $_POST);
 		}
-		$req_data = apply_filters( 'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', $req_data, $this );
+		$req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', $req_data, $this);
 		$this->_normalize($req_data);
-		if( $validate ){
+		if ($validate) {
 			$this->_validate();
 		}
-		do_action( 'AHEE__EE_Form_Section_Proper__receive_form_submission__end', $req_data, $this, $validate );
+		do_action('AHEE__EE_Form_Section_Proper__receive_form_submission__end', $req_data, $this, $validate);
 	}
 
 
@@ -224,12 +224,12 @@ 
 	 * the value being an array formatted in teh same way
 	 * @param array $default_data
 	 */
-	public function populate_defaults($default_data){
-		foreach($this->subsections() as $subsection_name => $subsection){
-			if(isset($default_data[$subsection_name])){
-				if($subsection instanceof EE_Form_Input_Base){
+	public function populate_defaults($default_data) {
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if (isset($default_data[$subsection_name])) {
+				if ($subsection instanceof EE_Form_Input_Base) {
 					$subsection->set_default($default_data[$subsection_name]);
-				}elseif($subsection instanceof EE_Form_Section_Proper){
+				}elseif ($subsection instanceof EE_Form_Section_Proper) {
 					$subsection->populate_defaults($default_data[$subsection_name]);
 				}
 			}
@@ -251,8 +251,8 @@ 
 	 * @return EE_Form_Section_Base
 	 * @throws \EE_Error
 	 */
-	public function get_subsection($name, $require_construction_to_be_finalized = TRUE ){
-		if( $require_construction_to_be_finalized ){
+	public function get_subsection($name, $require_construction_to_be_finalized = TRUE) {
+		if ($require_construction_to_be_finalized) {
 			$this->ensure_construct_finalized_called();
 		}
 		return isset($this->_subsections[$name]) ? $this->_subsections[$name] : NULL;
@@ -264,10 +264,10 @@ 
 	 * Gets all the validatable subsections of this form section
 	 * @return EE_Form_Section_Validatable[]
 	 */
-	public function get_validatable_subsections(){
+	public function get_validatable_subsections() {
 		$validatable_subsections = array();
-		foreach($this->subsections() as $name=>$obj){
-			if($obj instanceof EE_Form_Section_Validatable){
+		foreach ($this->subsections() as $name=>$obj) {
+			if ($obj instanceof EE_Form_Section_Validatable) {
 				$validatable_subsections[$name] = $obj;
 			}
 		}
@@ -287,10 +287,10 @@ 
 	 * @return EE_Form_Input_Base
 	 * @throws EE_Error
 	 */
-	public function get_input($name, $require_construction_to_be_finalized = TRUE ){
+	public function get_input($name, $require_construction_to_be_finalized = TRUE) {
 		$subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
-		if( ! $subsection instanceof EE_Form_Input_Base){
-			throw new EE_Error(sprintf(__("Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'", 'event_espresso'),$name, get_class($this),$subsection ? get_class($subsection) : __("NULL", 'event_espresso')));
+		if ( ! $subsection instanceof EE_Form_Input_Base) {
+			throw new EE_Error(sprintf(__("Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'", 'event_espresso'), $name, get_class($this), $subsection ? get_class($subsection) : __("NULL", 'event_espresso')));
 		}
 		return $subsection;
 	}
@@ -308,10 +308,10 @@ 
 	 * @return EE_Form_Section_Proper
 	 * @throws EE_Error
 	 */
-	public function get_proper_subsection($name, $require_construction_to_be_finalized = TRUE ){
-		$subsection = $this->get_subsection( $name, $require_construction_to_be_finalized );
-		if( ! $subsection instanceof EE_Form_Section_Proper){
-			throw new EE_Error(sprintf(__("Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso'),$name, get_class($this)));
+	public function get_proper_subsection($name, $require_construction_to_be_finalized = TRUE) {
+		$subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
+		if ( ! $subsection instanceof EE_Form_Section_Proper) {
+			throw new EE_Error(sprintf(__("Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso'), $name, get_class($this)));
 		}
 		return $subsection;
 	}
@@ -326,7 +326,7 @@ 
 	 * @return mixed depending on the input's type and its normalization strategy
 	 * @throws \EE_Error
 	 */
-	public function get_input_value($name){
+	public function get_input_value($name) {
 		$input = $this->get_input($name);
 		return $input->normalized_value();
 	}
@@ -339,16 +339,16 @@ 
 	 * @return boolean
 	 */
 	public function is_valid() {
-		if( ! $this->has_received_submission()){
+		if ( ! $this->has_received_submission()) {
 			throw new EE_Error(sprintf(__("You cannot check if a form is valid before receiving the form submission using receive_form_submission", "event_espresso")));
 		}
-		if( ! parent::is_valid()){
+		if ( ! parent::is_valid()) {
 			return false;
 		}
 		//ok so no errors general to this entire form section. so let's check the subsections
-		foreach( $this->get_validatable_subsections() as $subsection ){
-			if( ! $subsection->is_valid() || $subsection->get_validation_error_string() !== '' ){
-				$this->set_submission_error_message( $subsection->get_validation_error_string() );
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ( ! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
+				$this->set_submission_error_message($subsection->get_validation_error_string());
 				return false;
 			}
 		}
@@ -361,11 +361,11 @@ 
 	 * gets teh default name of this form section if none is specified
 	 * @return string
 	 */
-	protected function _set_default_name_if_empty(){
-		if( ! $this->_name ){
+	protected function _set_default_name_if_empty() {
+		if ( ! $this->_name) {
 			$classname = get_class($this);
 			$default_name = str_replace("EE_", "", $classname);
-			$this->_name =  $default_name;
+			$this->_name = $default_name;
 		}
 	}
 
@@ -380,7 +380,7 @@ 
 	 *             and get_html when you are about to display the form.
 	 * @throws \EE_Error
 	 */
-	public function get_html_and_js(){
+	public function get_html_and_js() {
 		//no doing_it_wrong yet because we ourselves are still doing it wrong...
 		//and theoretically this CAN be used properly, provided its used during "wp_enqueue_scripts"
 		$this->enqueue_js();
@@ -395,7 +395,7 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function get_html(){
+	public function get_html() {
 		$this->ensure_construct_finalized_called();
 		return $this->_layout_strategy->layout_form();
 	}
@@ -408,9 +408,9 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function enqueue_js(){
+	public function enqueue_js() {
 		$this->_enqueue_and_localize_form_js();
-		foreach( $this->subsections() as $subsection ) {
+		foreach ($this->subsections() as $subsection) {
 			$subsection->enqueue_js();
 		}
 	}
@@ -427,10 +427,10 @@ 
 	 * @param boolean $init_form_validation_automatically whether or not we want the form validation to be triggered automatically or not
 	 * @return void
 	 */
-	public static function wp_enqueue_scripts( $init_form_validation_automatically = true ){
-		add_filter( 'FHEE_load_jquery_validate', '__return_true' );
-		wp_register_script( 'ee_form_section_validation', EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js', array( 'jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods' ), EVENT_ESPRESSO_VERSION, TRUE );
-		wp_localize_script( 'ee_form_section_validation', 'ee_form_section_validation_init', array( 'init' => $init_form_validation_automatically ? true : false ) );
+	public static function wp_enqueue_scripts($init_form_validation_automatically = true) {
+		add_filter('FHEE_load_jquery_validate', '__return_true');
+		wp_register_script('ee_form_section_validation', EE_GLOBAL_ASSETS_URL.'scripts'.DS.'form_section_validation.js', array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'), EVENT_ESPRESSO_VERSION, TRUE);
+		wp_localize_script('ee_form_section_validation', 'ee_form_section_validation_init', array('init' => $init_form_validation_automatically ? true : false));
 	}
 
 
@@ -442,14 +442,14 @@ 
 	 *
 	 * @throws \EE_Error
 	 */
-	public function _enqueue_and_localize_form_js(){
+	public function _enqueue_and_localize_form_js() {
 		$this->ensure_construct_finalized_called();
 		//actually, we don't want to localize just yet. There may be other forms on the page.
 		//so we need to add our form section data to a static variable accessible by all form sections
 		//and localize it just before the footer
 		$this->localize_validation_rules();
-		add_action( 'wp_footer', array( 'EE_Form_Section_Proper', 'localize_script_for_all_forms' ), 2 );
-		add_action( 'admin_footer', array( 'EE_Form_Section_Proper', 'localize_script_for_all_forms' ) );
+		add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
+		add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
 	}
 
 
@@ -461,11 +461,11 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function localize_validation_rules( $return_for_subsection = FALSE ){
+	public function localize_validation_rules($return_for_subsection = FALSE) {
 		// we only want to localize vars ONCE for the entire form, so if the form section doesn't have a parent, then it must be the top dog
-		if ( $return_for_subsection || ! $this->parent_section() ) {
-			EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
-				'form_section_id'=> $this->html_id( TRUE ),
+		if ($return_for_subsection || ! $this->parent_section()) {
+			EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
+				'form_section_id'=> $this->html_id(TRUE),
 				'validation_rules'=> $this->get_jquery_validation_rules(),
 				'other_data' => $this->get_other_js_data(),
 				'errors'=> $this->subsection_validation_errors_by_html_name()
@@ -481,9 +481,9 @@ 
 	 * @param array $form_other_js_data
 	 * @return array
 	 */
-	public function get_other_js_data( $form_other_js_data = array() ) {
-		foreach( $this->subsections() as $subsection ) {
-			$form_other_js_data = $subsection->get_other_js_data( $form_other_js_data );
+	public function get_other_js_data($form_other_js_data = array()) {
+		foreach ($this->subsections() as $subsection) {
+			$form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
 		}
 		return $form_other_js_data;
 	}
@@ -494,12 +494,12 @@ 
 	 * Keys are their form names, and values are the inputs themselves
 	 * @return EE_Form_Input_Base
 	 */
-	public function inputs_in_subsections(){
+	public function inputs_in_subsections() {
 		$inputs = array();
-		foreach($this->subsections() as $subsection){
-			if( $subsection instanceof EE_Form_Input_Base ){
-				$inputs[ $subsection->html_name() ] = $subsection;
-			}elseif($subsection instanceof EE_Form_Section_Proper ){
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[$subsection->html_name()] = $subsection;
+			}elseif ($subsection instanceof EE_Form_Section_Proper) {
 				$inputs += $subsection->inputs_in_subsections();
 			}
 		}
@@ -512,12 +512,12 @@ 
 	 * and values are a string of all their validation errors
 	 * @return string[]
 	 */
-	public function subsection_validation_errors_by_html_name(){
+	public function subsection_validation_errors_by_html_name() {
 		$inputs = $this->inputs();
 		$errors = array();
-		foreach( $inputs as $form_input ){
-			if ( $form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors() ){
-				$errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+		foreach ($inputs as $form_input) {
+			if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
+				$errors[$form_input->html_name()] = $form_input->get_validation_error_string();
 			}
 		}
 		return $errors;
@@ -529,16 +529,16 @@ 
 	 * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
 	 * Should be setup by each form during the _enqueues_and_localize_form_js
 	 */
-	public static function localize_script_for_all_forms(){
+	public static function localize_script_for_all_forms() {
 		//allow inputs and stuff to hook in their JS and stuff here
 		do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
 		EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
-		$email_validation_level = isset( EE_Registry::instance()->CFG->registration->email_validation_level )
+		$email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
 			? EE_Registry::instance()->CFG->registration->email_validation_level
 			: 'wp_default';
 		EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
-		wp_enqueue_script( 'ee_form_section_validation' );
-		wp_localize_script( 'ee_form_section_validation', 'ee_form_section_vars', EE_Form_Section_Proper::$_js_localization );
+		wp_enqueue_script('ee_form_section_validation');
+		wp_localize_script('ee_form_section_validation', 'ee_form_section_vars', EE_Form_Section_Proper::$_js_localization);
 	}
 
 
@@ -546,8 +546,8 @@ 
 	/**
 	 * ensure_scripts_localized
 	 */
-	public function ensure_scripts_localized(){
-		if ( ! EE_Form_Section_Proper::$_scripts_localized ) {
+	public function ensure_scripts_localized() {
+		if ( ! EE_Form_Section_Proper::$_scripts_localized) {
 			$this->_enqueue_and_localize_form_js();
 		}
 	}
@@ -559,10 +559,10 @@ 
 	 * is that the key here should be the same as the custom validation rule put in the JS file
 	 * @return array keys are custom validation rules, and values are internationalized strings
 	 */
-	private static function _get_localized_error_messages(){
+	private static function _get_localized_error_messages() {
 		return array(
 			'validUrl'=>  __("This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg", "event_espresso"),
-			'regex' => __( 'Please check your input', 'event_espresso' ),
+			'regex' => __('Please check your input', 'event_espresso'),
 		);
 	}
 
@@ -590,10 +590,10 @@ 
 	 * Gets the JS to put inside the jquery validation rules for subsection of this form section. See parent function for more...
 	 * @return array
 	 */
-	public function get_jquery_validation_rules(){
+	public function get_jquery_validation_rules() {
 		$jquery_validation_rules = array();
-		foreach($this->get_validatable_subsections() as $subsection){
-			$jquery_validation_rules = array_merge( $jquery_validation_rules,  $subsection->get_jquery_validation_rules() );
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$jquery_validation_rules = array_merge($jquery_validation_rules, $subsection->get_jquery_validation_rules());
 		}
 		return $jquery_validation_rules;
 	}
@@ -608,11 +608,11 @@ 
 	protected function _normalize($req_data) {
 		$this->_received_submission = TRUE;
 		$this->_validation_errors = array();
-		foreach($this->get_validatable_subsections() as $subsection){
-			try{
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			try {
 				$subsection->_normalize($req_data);
-			}catch( EE_Validation_Error $e ){
-				$subsection->add_validation_error( $e );
+			} catch (EE_Validation_Error $e) {
+				$subsection->add_validation_error($e);
 			}
 		}
 	}
@@ -626,9 +626,9 @@ 
 	 * calling parent::_validate() first.
 	 */
 	protected function _validate() {
-		foreach($this->get_validatable_subsections() as $subsection_name => $subsection){
-			if(method_exists($this,'_validate_'.$subsection_name)){
-				call_user_func_array(array($this,'_validate_'.$subsection_name), array($subsection));
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if (method_exists($this, '_validate_'.$subsection_name)) {
+				call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
 			}
 			$subsection->_validate();
 		}
@@ -640,13 +640,13 @@ 
 	 * Gets all the validated inputs for the form section
 	 * @return array
 	 */
-	public function valid_data(){
+	public function valid_data() {
 		$inputs = array();
-		foreach( $this->subsections() as $subsection_name =>$subsection ){
-			if ( $subsection instanceof EE_Form_Section_Proper ) {
-				$inputs[ $subsection_name ] = $subsection->valid_data();
-			} else if ( $subsection instanceof EE_Form_Input_Base ){
-				$inputs[ $subsection_name ] = $subsection->normalized_value();
+		foreach ($this->subsections() as $subsection_name =>$subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs[$subsection_name] = $subsection->valid_data();
+			} else if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[$subsection_name] = $subsection->normalized_value();
 			}
 		}
 		return $inputs;
@@ -658,11 +658,11 @@ 
 	 * Gets all the inputs on this form section
 	 * @return EE_Form_Input_Base[]
 	 */
-	public function inputs(){
+	public function inputs() {
 		$inputs = array();
-		foreach( $this->subsections() as $subsection_name =>$subsection ){
-			if ( $subsection instanceof EE_Form_Input_Base ){
-				$inputs[ $subsection_name ] = $subsection;
+		foreach ($this->subsections() as $subsection_name =>$subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[$subsection_name] = $subsection;
 			}
 		}
 		return $inputs;
@@ -674,10 +674,10 @@ 
 	 * Gets all the subsections which are a proper form
 	 * @return EE_Form_Section_Proper[]
 	 */
-	public function subforms(){
+	public function subforms() {
 		$form_sections = array();
-		foreach($this->subsections() as $name=>$obj){
-			if($obj instanceof EE_Form_Section_Proper){
+		foreach ($this->subsections() as $name=>$obj) {
+			if ($obj instanceof EE_Form_Section_Proper) {
 				$form_sections[$name] = $obj;
 			}
 		}
@@ -692,7 +692,7 @@ 
 	 * if you only want form inputs or proper form sections.
 	 * @return EE_Form_Section_Proper[]
 	 */
-	public function subsections(){
+	public function subsections() {
 		$this->ensure_construct_finalized_called();
 		return $this->_subsections;
 	}
@@ -710,8 +710,8 @@ 
 	 * it can be a multidimensional array where keys are always subsection names and values are either the
 	 * input's normalized value, or an array like the top-level array
 	 */
-	public function input_values( $include_subform_inputs = false, $flatten = false ){
-		return $this->_input_values( false, $include_subform_inputs, $flatten );
+	public function input_values($include_subform_inputs = false, $flatten = false) {
+		return $this->_input_values(false, $include_subform_inputs, $flatten);
 	}
 
 	/**
@@ -727,8 +727,8 @@ 
 	 * it can be a multidimensional array where keys are always subsection names and values are either the
 	 * input's normalized value, or an array like the top-level array
 	 */
-	public function input_pretty_values(  $include_subform_inputs = false, $flatten = false ){
-		return $this->_input_values( true, $include_subform_inputs, $flatten );
+	public function input_pretty_values($include_subform_inputs = false, $flatten = false) {
+		return $this->_input_values(true, $include_subform_inputs, $flatten);
 	}
 
 	/**
@@ -741,17 +741,17 @@ 
 	 * it can be a multidimensional array where keys are always subsection names and values are either the
 	 * input's normalized value, or an array like the top-level array
 	 */
-	public function _input_values( $pretty = false, $include_subform_inputs = false, $flatten = false ) {
+	public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false) {
 		$input_values = array();
-		foreach( $this->subsections() as $subsection_name => $subsection ) {
-			if( $subsection instanceof EE_Form_Input_Base ) {
-				$input_values[ $subsection_name ] = $pretty ? $subsection->pretty_value() : $subsection->normalized_value();
-			} else if( $subsection instanceof EE_Form_Section_Proper && $include_subform_inputs ) {
-				$subform_input_values = $subsection->_input_values( $pretty, $include_subform_inputs, $flatten );
-				if( $flatten ) {
-					$input_values = array_merge( $input_values, $subform_input_values );
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$input_values[$subsection_name] = $pretty ? $subsection->pretty_value() : $subsection->normalized_value();
+			} else if ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
+				$subform_input_values = $subsection->_input_values($pretty, $include_subform_inputs, $flatten);
+				if ($flatten) {
+					$input_values = array_merge($input_values, $subform_input_values);
 				} else {
-					$input_values[ $subsection_name ] = $subform_input_values;
+					$input_values[$subsection_name] = $subform_input_values;
 				}
 			}
 		}
@@ -767,7 +767,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function has_received_submission(){
+	public function has_received_submission() {
 		$this->ensure_construct_finalized_called();
 		return $this->_received_submission;
 	}
@@ -780,8 +780,8 @@ 
 	 * @param array $inputs_to_exclude values are the input names
 	 * @return void
 	 */
-	public function exclude($inputs_to_exclude = array()){
-		foreach($inputs_to_exclude as $input_to_exclude_name){
+	public function exclude($inputs_to_exclude = array()) {
+		foreach ($inputs_to_exclude as $input_to_exclude_name) {
 			unset($this->_subsections[$input_to_exclude_name]);
 		}
 	}
@@ -792,8 +792,8 @@ 
 	 * @param array $inputs_to_hide
 	 * @throws \EE_Error
 	 */
-	public function hide($inputs_to_hide= array()){
-		foreach($inputs_to_hide as $input_to_hide){
+	public function hide($inputs_to_hide = array()) {
+		foreach ($inputs_to_hide as $input_to_hide) {
 			$input = $this->get_input($input_to_hide);
 
 			$input->set_display_strategy(new EE_Hidden_Display_Strategy());
@@ -818,13 +818,13 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function add_subsections( $new_subsections, $subsection_name_to_target = NULL, $add_before = true ){
-		foreach($new_subsections as $subsection_name => $subsection){
-			if( ! $subsection instanceof EE_Form_Section_Base){
+	public function add_subsections($new_subsections, $subsection_name_to_target = NULL, $add_before = true) {
+		foreach ($new_subsections as $subsection_name => $subsection) {
+			if ( ! $subsection instanceof EE_Form_Section_Base) {
 				EE_Error::add_error(
 					sprintf(
 						__("Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.", "event_espresso"),
-						get_class( $subsection ),
+						get_class($subsection),
 						$subsection_name,
 						$this->name()
 					)
@@ -833,7 +833,7 @@ 
 			}
 		}
 
-		$this->_subsections = EEH_Array::insert_into_array( $this->_subsections, $new_subsections, $subsection_name_to_target, $add_before );
+		$this->_subsections = EEH_Array::insert_into_array($this->_subsections, $new_subsections, $subsection_name_to_target, $add_before);
 
 		/*$subsections_before = array();
 		if( $subsection_name_to_target ){
@@ -864,8 +864,8 @@ 
 				$this->_subsections = $new_subsections;
 			}
 		}*/
-		if( $this->_construction_finalized ){
-			foreach($this->_subsections as $name => $subsection){
+		if ($this->_construction_finalized) {
+			foreach ($this->_subsections as $name => $subsection) {
 				$subsection->_construct_finalize($this, $name);
 			}
 		}
@@ -876,8 +876,8 @@ 
 	/**
 	 * Just gets all validatable subsections to clean their sensitive data
 	 */
-	public function clean_sensitive_data(){
-		foreach($this->get_validatable_subsections() as $subsection){
+	public function clean_sensitive_data() {
+		foreach ($this->get_validatable_subsections() as $subsection) {
 			$subsection->clean_sensitive_data();
 		}
 	}
@@ -887,8 +887,8 @@ 
 	/**
 	 * @param string $form_submission_error_message
 	 */
-	public function set_submission_error_message( $form_submission_error_message = '' ) {
-		$this->_form_submission_error_message .= ! empty( $form_submission_error_message ) ? $form_submission_error_message : __( 'Form submission failed due to errors', 'event_espresso' );
+	public function set_submission_error_message($form_submission_error_message = '') {
+		$this->_form_submission_error_message .= ! empty($form_submission_error_message) ? $form_submission_error_message : __('Form submission failed due to errors', 'event_espresso');
 	}
 
 
@@ -905,8 +905,8 @@ 
 	/**
 	 * @param string $form_submission_success_message
 	 */
-	public function set_submission_success_message( $form_submission_success_message ) {
-		$this->_form_submission_success_message .= ! empty( $form_submission_success_message ) ? $form_submission_success_message : __( 'Form submitted successfully', 'event_espresso' );
+	public function set_submission_success_message($form_submission_success_message) {
+		$this->_form_submission_success_message .= ! empty($form_submission_success_message) ? $form_submission_success_message : __('Form submitted successfully', 'event_espresso');
 	}
 
 
@@ -929,10 +929,10 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function html_name_prefix(){
-		if( $this->parent_section() instanceof EE_Form_Section_Proper ){
-			return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
-		}else{
+	public function html_name_prefix() {
+		if ($this->parent_section() instanceof EE_Form_Section_Proper) {
+			return $this->parent_section()->html_name_prefix().'['.$this->name().']';
+		} else {
 			return $this->name();
 		}
 	}
@@ -947,7 +947,7 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function name(){
+	public function name() {
 		$this->ensure_construct_finalized_called();
 		return parent::name();
 	}
@@ -958,7 +958,7 @@ 
 	 * @return EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	public function parent_section(){
+	public function parent_section() {
 		$this->ensure_construct_finalized_called();
 		return parent::parent_section();
 	}
@@ -971,9 +971,9 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function ensure_construct_finalized_called(){
-		if( ! $this->_construction_finalized ){
-			$this->_construct_finalize($this->_parent_section, $this->_name );
+	public function ensure_construct_finalized_called() {
+		if ( ! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
 		}
 	}
 
@@ -985,17 +985,17 @@ 
 	 * @param array $req_data
 	 * @return boolean
 	 */
-	public function form_data_present_in( $req_data = NULL ) {
-		if( $req_data === NULL){
+	public function form_data_present_in($req_data = NULL) {
+		if ($req_data === NULL) {
 			$req_data = $_POST;
 		}
-		foreach( $this->subsections() as $subsection ) {
-			if($subsection instanceof EE_Form_Input_Base ) {
-				if( $subsection->form_data_present_in( $req_data ) ) {
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($subsection->form_data_present_in($req_data)) {
 					return TRUE;
 				}
-			}elseif( $subsection instanceof EE_Form_Section_Proper ) {
-				if( $subsection->form_data_present_in( $req_data ) ) {
+			}elseif ($subsection instanceof EE_Form_Section_Proper) {
+				if ($subsection->form_data_present_in($req_data)) {
 					return TRUE;
 				}
 			}
@@ -1012,14 +1012,14 @@ 
 	 */
 	public function get_validation_errors_accumulated() {
 		$validation_errors = $this->get_validation_errors();
-		foreach($this->get_validatable_subsections() as $subsection ) {
-			if( $subsection instanceof EE_Form_Section_Proper ) {
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
 				$validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
 			} else {
-				$validation_errors_on_this_subsection =  $subsection->get_validation_errors();
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors();
 			}
-			if( $validation_errors_on_this_subsection ){
-				$validation_errors = array_merge( $validation_errors, $validation_errors_on_this_subsection );
+			if ($validation_errors_on_this_subsection) {
+				$validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
 			}
 		}
 		return $validation_errors;
@@ -1041,24 +1041,24 @@ 
 	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
 	 * @return EE_Form_Section_Base
 	 */
-	public function find_section_from_path( $form_section_path ) {
+	public function find_section_from_path($form_section_path) {
 		//check if we can find the input from purely going straight up the tree
-		$input = parent::find_section_from_path( $form_section_path );
-		if( $input instanceof EE_Form_Section_Base ) {
+		$input = parent::find_section_from_path($form_section_path);
+		if ($input instanceof EE_Form_Section_Base) {
 			return $input;
 		}
 
-		$next_slash_pos = strpos( $form_section_path, '/' );
-		if( $next_slash_pos !== false ) {
-			$child_section_name = substr( $form_section_path, 0, $next_slash_pos );
-			$subpath = substr( $form_section_path, $next_slash_pos + 1 );
+		$next_slash_pos = strpos($form_section_path, '/');
+		if ($next_slash_pos !== false) {
+			$child_section_name = substr($form_section_path, 0, $next_slash_pos);
+			$subpath = substr($form_section_path, $next_slash_pos + 1);
 		} else {
 			$child_section_name = $form_section_path;
 			$subpath = '';
 		}
-		$child_section =  $this->get_subsection( $child_section_name );
-		if ( $child_section instanceof EE_Form_Section_Base ) {
-			return $child_section->find_section_from_path( $subpath );
+		$child_section = $this->get_subsection($child_section_name);
+		if ($child_section instanceof EE_Form_Section_Base) {
+			return $child_section->find_section_from_path($subpath);
 		} else {
 			return null;
 		}

Doc Comments +1 added lines, -1 removed lines

@@ -248,7 +248,7 @@
 	 *                                                      with construction finalize being called later
 	 *                                                      (realizing that the subsections' html names
 	 *                                                      might not be set yet, etc.)
-	 * @return EE_Form_Section_Base
+	 * @return EE_Form_Section_Validatable|null
 	 * @throws \EE_Error
 	 */
 	public function get_subsection($name, $require_construction_to_be_finalized = TRUE ){