eventespresso / event-espresso-core

public/Espresso_Arabica_2014/functions.php

Spacing +7 added lines, -7 removed lines

@@ -9,9 +9,9 @@ 
  * @ link			http://www.eventespresso.com
  * @ version		4+
  */
-define( 'EE_THEME_FUNCTIONS_LOADED', TRUE );
+define('EE_THEME_FUNCTIONS_LOADED', TRUE);
 
-if ( ! function_exists( 'espresso_pagination' ) ) {
+if ( ! function_exists('espresso_pagination')) {
 	/**
 	 *    espresso_pagination
 	 *
@@ -23,21 +23,21 @@ 
 		$big = 999999999; // need an unlikely integer
 		$pagination = paginate_links(
 			array(
-				'base'         => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
 				'format'       => '?paged=%#%',
-				'current'      => max( 1, get_query_var( 'paged' ) ),
+				'current'      => max(1, get_query_var('paged')),
 				'total'        => $wp_query->max_num_pages,
 				'show_all'     => true,
 				'end_size'     => 10,
 				'mid_size'     => 6,
 				'prev_next'    => true,
-				'prev_text'    => esc_html__( '‹ PREV', 'event_espresso' ),
-				'next_text'    => esc_html__( 'NEXT ›', 'event_espresso' ),
+				'prev_text'    => esc_html__('‹ PREV', 'event_espresso'),
+				'next_text'    => esc_html__('NEXT ›', 'event_espresso'),
 				'type'         => 'plain',
 				'add_args'     => false,
 				'add_fragment' => ''
 			)
 		);
-		echo ! empty( $pagination ) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
 	}
 }
\ No newline at end of file

core/libraries/messages/data_class/EE_Messages_REG_incoming_data.class.php

Spacing +6 added lines, -6 removed lines

@@ -31,14 +31,14 @@ 
     {
         $filtered_reg_status = null;
 
-        if (! is_array($data) && $data instanceof EE_Registration) {
+        if ( ! is_array($data) && $data instanceof EE_Registration) {
             $this->reg_obj = $data;
         } else {
             $this->reg_obj = is_array($data) && isset($data[0]) && $data[0] instanceof EE_Registration ? $data[0] : null;
             $filtered_reg_status = is_array($data) && ! empty($data[1]) ? $data[1] : null;
         }
 
-        if (! $this->reg_obj instanceof EE_Registration) {
+        if ( ! $this->reg_obj instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('%1$s requires the incoming data argument to be an instance of %2$s or an array where the first value is an instance of %2$s', 'event_espresso'),
@@ -66,16 +66,16 @@ 
     public static function convert_data_for_persistent_storage($data)
     {
         $prepped_data = array();
-        if (! is_array($data) && $data instanceof EE_Registration) {
+        if ( ! is_array($data) && $data instanceof EE_Registration) {
             $prepped_data['Registration'] = $data->ID();
             return $prepped_data;
-        } elseif (! is_array($data)) {
+        } elseif ( ! is_array($data)) {
             return array();
         } else {
             if ($data[0] instanceof EE_Registration) {
                 $prepped_data['Registration'] = $data[0];
             }
-            if (! empty($data[1])) {
+            if ( ! empty($data[1])) {
                 $prepped_data['filter'] = $data[1];
             }
         }
@@ -121,7 +121,7 @@ 
         $this->txn = $this->reg_obj->transaction();
         // possible session stuff?
         $session = $this->txn->session_data();
-        $session_data =  $session instanceof EE_Session ? $session->get_session_data() : array();
+        $session_data = $session instanceof EE_Session ? $session->get_session_data() : array();
 
         // other data from the session (if possible)
         $this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';

Indentation +133 added lines, -133 removed lines

@@ -15,137 +15,137 @@
  */
 class EE_Messages_REG_incoming_data extends EE_Messages_incoming_data
 {
-    /**
-     * For the constructor of this special preview class.
-     *
-     * The data is expected to be an array that came from the request data
-     * and should have at least one property from the list looked for.
-     *
-     * @param EE_Registration|array $data
-     * @throws \EE_Error
-     */
-    public function __construct($data)
-    {
-        $filtered_reg_status = null;
-
-        if (! is_array($data) && $data instanceof EE_Registration) {
-            $this->reg_obj = $data;
-        } else {
-            $this->reg_obj = is_array($data) && isset($data[0]) && $data[0] instanceof EE_Registration ? $data[0] : null;
-            $filtered_reg_status = is_array($data) && ! empty($data[1]) ? $data[1] : null;
-        }
-
-        if (! $this->reg_obj instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('%1$s requires the incoming data argument to be an instance of %2$s or an array where the first value is an instance of %2$s', 'event_espresso'),
-                    'EE_Messages_REG_incoming_data',
-                    'EE_Registration'
-                )
-            );
-        }
-
-        $data = array(
-            'reg_obj' => $this->reg_obj,
-            'filtered_reg_status' => $filtered_reg_status
-            );
-
-        parent::__construct($data);
-    }
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param mixed $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        $prepped_data = array();
-        if (! is_array($data) && $data instanceof EE_Registration) {
-            $prepped_data['Registration'] = $data->ID();
-            return $prepped_data;
-        } elseif (! is_array($data)) {
-            return array();
-        } else {
-            if ($data[0] instanceof EE_Registration) {
-                $prepped_data['Registration'] = $data[0];
-            }
-            if (! empty($data[1])) {
-                $prepped_data['filter'] = $data[1];
-            }
-        }
-
-        return $prepped_data;
-    }
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param $data
-     *
-     * @return mixed
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        $registration = null;
-        // $data['Registration'] could be either an ID (back compat) or a registration object (prepped using old system).
-        if (isset($data['Registration'])) {
-            $registration = $data['Registration'] instanceof EE_Registration
-                ? $data['Registration']
-                : EEM_Registration::instance()->get_one_by_ID($data['Registration']);
-        }
-        $prepped_data = array(
-            0 => $registration,
-            1 => isset($data['filter']) ? $data['filter'] : null
-        );
-        return $prepped_data;
-    }
-
-
-    /**
-     * This will just setup the _events property in the expected format.
-     * @return void
-     */
-    protected function _setup_data()
-    {
-
-        // now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
-        $this->filtered_reg_status = $this->_data['filtered_reg_status'];
-        // get txn
-        $this->txn = $this->reg_obj->transaction();
-        // possible session stuff?
-        $session = $this->txn->session_data();
-        $session_data =  $session instanceof EE_Session ? $session->get_session_data() : array();
-
-        // other data from the session (if possible)
-        $this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
-        $this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
-        $this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
-        $this->init_access = $this->last_access = '';
-
-        $this->payment = $this->txn->get_first_related('Payment');
-        // if there is no payments associated with the transaction
-        // then we just create a default payment object for potential parsing.
-        $this->payment = empty($this->payment)
-            ? EE_Payment::new_instance(
-                array(
-                    'STS_ID'               => EEM_Payment::status_id_pending,
-                    'PAY_timestamp'        => time(),
-                    'PMD_ID'               => $this->txn->payment_method_ID(),
-                    'PAY_gateway_response' => $this->txn->gateway_response_on_transaction(),
-                )
-            )
-            : $this->payment;
-
-
-        // get reg_objs for txn
-        $this->reg_objs = $this->txn->registrations();
-
-        // now we can set things up like we do for other handlers
-
-        $this->_assemble_data();
-    }
+	/**
+	 * For the constructor of this special preview class.
+	 *
+	 * The data is expected to be an array that came from the request data
+	 * and should have at least one property from the list looked for.
+	 *
+	 * @param EE_Registration|array $data
+	 * @throws \EE_Error
+	 */
+	public function __construct($data)
+	{
+		$filtered_reg_status = null;
+
+		if (! is_array($data) && $data instanceof EE_Registration) {
+			$this->reg_obj = $data;
+		} else {
+			$this->reg_obj = is_array($data) && isset($data[0]) && $data[0] instanceof EE_Registration ? $data[0] : null;
+			$filtered_reg_status = is_array($data) && ! empty($data[1]) ? $data[1] : null;
+		}
+
+		if (! $this->reg_obj instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('%1$s requires the incoming data argument to be an instance of %2$s or an array where the first value is an instance of %2$s', 'event_espresso'),
+					'EE_Messages_REG_incoming_data',
+					'EE_Registration'
+				)
+			);
+		}
+
+		$data = array(
+			'reg_obj' => $this->reg_obj,
+			'filtered_reg_status' => $filtered_reg_status
+			);
+
+		parent::__construct($data);
+	}
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param mixed $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		$prepped_data = array();
+		if (! is_array($data) && $data instanceof EE_Registration) {
+			$prepped_data['Registration'] = $data->ID();
+			return $prepped_data;
+		} elseif (! is_array($data)) {
+			return array();
+		} else {
+			if ($data[0] instanceof EE_Registration) {
+				$prepped_data['Registration'] = $data[0];
+			}
+			if (! empty($data[1])) {
+				$prepped_data['filter'] = $data[1];
+			}
+		}
+
+		return $prepped_data;
+	}
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param $data
+	 *
+	 * @return mixed
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		$registration = null;
+		// $data['Registration'] could be either an ID (back compat) or a registration object (prepped using old system).
+		if (isset($data['Registration'])) {
+			$registration = $data['Registration'] instanceof EE_Registration
+				? $data['Registration']
+				: EEM_Registration::instance()->get_one_by_ID($data['Registration']);
+		}
+		$prepped_data = array(
+			0 => $registration,
+			1 => isset($data['filter']) ? $data['filter'] : null
+		);
+		return $prepped_data;
+	}
+
+
+	/**
+	 * This will just setup the _events property in the expected format.
+	 * @return void
+	 */
+	protected function _setup_data()
+	{
+
+		// now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
+		$this->filtered_reg_status = $this->_data['filtered_reg_status'];
+		// get txn
+		$this->txn = $this->reg_obj->transaction();
+		// possible session stuff?
+		$session = $this->txn->session_data();
+		$session_data =  $session instanceof EE_Session ? $session->get_session_data() : array();
+
+		// other data from the session (if possible)
+		$this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
+		$this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
+		$this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
+		$this->init_access = $this->last_access = '';
+
+		$this->payment = $this->txn->get_first_related('Payment');
+		// if there is no payments associated with the transaction
+		// then we just create a default payment object for potential parsing.
+		$this->payment = empty($this->payment)
+			? EE_Payment::new_instance(
+				array(
+					'STS_ID'               => EEM_Payment::status_id_pending,
+					'PAY_timestamp'        => time(),
+					'PMD_ID'               => $this->txn->payment_method_ID(),
+					'PAY_gateway_response' => $this->txn->gateway_response_on_transaction(),
+				)
+			)
+			: $this->payment;
+
+
+		// get reg_objs for txn
+		$this->reg_objs = $this->txn->registrations();
+
+		// now we can set things up like we do for other handlers
+
+		$this->_assemble_data();
+	}
 }

core/libraries/messages/data_class/EE_Messages_Gateways_incoming_data.class.php

Spacing +3 added lines, -3 removed lines

@@ -32,7 +32,7 @@ 
     {
 
         // test for valid params
-        if (! ( $data[0] instanceof EE_Transaction )) {
+        if ( ! ($data[0] instanceof EE_Transaction)) {
             throw new EE_Error(esc_html__('Incoming data for the Gateways data handler must have an EE_Transaction object as the value for the first array index.', 'event_espresso'));
         }
 
@@ -40,7 +40,7 @@ 
             $pmt_obj = $this->_get_empty_payment_obj($data[0]);
         }
 
-        if (! empty($data[2])) {
+        if ( ! empty($data[2])) {
             $filtered_reg_status = $data[2];
         }
 
@@ -75,7 +75,7 @@ 
             $prepped_data['Payment'] = $data[1]->ID();
         }
 
-        if (! empty($data[2])) {
+        if ( ! empty($data[2])) {
             $prepped_data['filter'] = $data[2];
         }
 

Indentation +136 added lines, -136 removed lines

@@ -13,141 +13,141 @@
  */
 class EE_Messages_Gateways_incoming_data extends EE_Messages_incoming_data
 {
-    /**
-     * This holds the incoming payment object
-     * @var EE_Payment
-     */
-    public $payment;
-
-
-
-    /**
-     * incoming data is expected to be a EE_Transaction object and (possibly) EE_Payment object in an array.
-     *
-     * @param array $data
-     * @throws EE_Error
-     */
-    public function __construct($data)
-    {
-
-        // test for valid params
-        if (! ( $data[0] instanceof EE_Transaction )) {
-            throw new EE_Error(esc_html__('Incoming data for the Gateways data handler must have an EE_Transaction object as the value for the first array index.', 'event_espresso'));
-        }
-
-        if (empty($data[1]) || ! $data[1] instanceof  EE_Payment) {
-            $pmt_obj = $this->_get_empty_payment_obj($data[0]);
-        }
-
-        if (! empty($data[2])) {
-            $filtered_reg_status = $data[2];
-        }
+	/**
+	 * This holds the incoming payment object
+	 * @var EE_Payment
+	 */
+	public $payment;
+
+
+
+	/**
+	 * incoming data is expected to be a EE_Transaction object and (possibly) EE_Payment object in an array.
+	 *
+	 * @param array $data
+	 * @throws EE_Error
+	 */
+	public function __construct($data)
+	{
+
+		// test for valid params
+		if (! ( $data[0] instanceof EE_Transaction )) {
+			throw new EE_Error(esc_html__('Incoming data for the Gateways data handler must have an EE_Transaction object as the value for the first array index.', 'event_espresso'));
+		}
+
+		if (empty($data[1]) || ! $data[1] instanceof  EE_Payment) {
+			$pmt_obj = $this->_get_empty_payment_obj($data[0]);
+		}
+
+		if (! empty($data[2])) {
+			$filtered_reg_status = $data[2];
+		}
 
-        $data = array(
-            'txn_obj' => $data[0],
-            'pmt_obj' => isset($pmt_obj) ? $pmt_obj : $data[1],
-            'filtered_reg_status' => isset($filtered_reg_status) ? $filtered_reg_status : null
-            );
-        parent::__construct($data);
-    }
-
-
-
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        $prepped_data = array();
-
-        if ($data[0] instanceof EE_Transaction) {
-            $prepped_data['Transaction'] = $data[0]->ID();
-        }
-
-        if (isset($data[1]) && $data[1] instanceof EE_Payment) {
-            $prepped_data['Payment'] = $data[1]->ID();
-        }
-
-        if (! empty($data[2])) {
-            $prepped_data['filter'] = $data[2];
-        }
-
-        return $prepped_data;
-    }
-
-
-
-
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array  $data
-     *
-     * @return array
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        $prepped_data = array(
-            0 => isset($data['Transaction']) ? EEM_Transaction::instance()->get_one_by_ID($data['Transaction']) : null,
-            1 => isset($data['Payment']) ? EEM_Payment::instance()->get_one_by_ID($data['Payment']) : null,
-            2 => isset($data['filter']) ? $data['filter'] : null
-        );
-        return $prepped_data;
-    }
-
-
-    /**
-     * This sets up an empty EE_Payment object for the purpose of shortcode parsing.  Note that this doesn't actually get saved to the db.
-     * @param \EE_Transaction $txn
-     * @return \EE_Payment
-     */
-    private function _get_empty_payment_obj(EE_Transaction $txn)
-    {
-        $PMT = EE_Payment::new_instance(array(
-            'STS_ID' => EEM_Payment::status_id_pending,
-            'PAY_timestamp' => time(),
-            'PMD_ID' => $txn->payment_method_ID(),
-            'PAY_gateway_response' => $txn->gateway_response_on_transaction(),
-            ));
-        return $PMT;
-    }
-
-
-
-    /**
-     * _setup_data
-     *
-     * @throws EE_Error
-     */
-    protected function _setup_data()
-    {
-
-        $this->reg_info = array();
-
-        $this->txn = $this->_data['txn_obj'];
-        $this->payment = $this->_data['pmt_obj'];
-        $this->filtered_reg_status = $this->_data['filtered_reg_status'];
-        $this->incoming_data = $this->_data;
-
-        $session_data = $this->txn->session_data();
-
-
-        // other data from the session (if possible)
-        $this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
-        $this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
-        $this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
-        $this->init_access = $this->last_access = '';
-        // get all non-trashed registrations
-        $this->reg_objs = $this->txn->registrations(array(array('REG_deleted' => false)));
-        $this->_assemble_data();
-    }
+		$data = array(
+			'txn_obj' => $data[0],
+			'pmt_obj' => isset($pmt_obj) ? $pmt_obj : $data[1],
+			'filtered_reg_status' => isset($filtered_reg_status) ? $filtered_reg_status : null
+			);
+		parent::__construct($data);
+	}
+
+
+
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		$prepped_data = array();
+
+		if ($data[0] instanceof EE_Transaction) {
+			$prepped_data['Transaction'] = $data[0]->ID();
+		}
+
+		if (isset($data[1]) && $data[1] instanceof EE_Payment) {
+			$prepped_data['Payment'] = $data[1]->ID();
+		}
+
+		if (! empty($data[2])) {
+			$prepped_data['filter'] = $data[2];
+		}
+
+		return $prepped_data;
+	}
+
+
+
+
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array  $data
+	 *
+	 * @return array
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		$prepped_data = array(
+			0 => isset($data['Transaction']) ? EEM_Transaction::instance()->get_one_by_ID($data['Transaction']) : null,
+			1 => isset($data['Payment']) ? EEM_Payment::instance()->get_one_by_ID($data['Payment']) : null,
+			2 => isset($data['filter']) ? $data['filter'] : null
+		);
+		return $prepped_data;
+	}
+
+
+	/**
+	 * This sets up an empty EE_Payment object for the purpose of shortcode parsing.  Note that this doesn't actually get saved to the db.
+	 * @param \EE_Transaction $txn
+	 * @return \EE_Payment
+	 */
+	private function _get_empty_payment_obj(EE_Transaction $txn)
+	{
+		$PMT = EE_Payment::new_instance(array(
+			'STS_ID' => EEM_Payment::status_id_pending,
+			'PAY_timestamp' => time(),
+			'PMD_ID' => $txn->payment_method_ID(),
+			'PAY_gateway_response' => $txn->gateway_response_on_transaction(),
+			));
+		return $PMT;
+	}
+
+
+
+	/**
+	 * _setup_data
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _setup_data()
+	{
+
+		$this->reg_info = array();
+
+		$this->txn = $this->_data['txn_obj'];
+		$this->payment = $this->_data['pmt_obj'];
+		$this->filtered_reg_status = $this->_data['filtered_reg_status'];
+		$this->incoming_data = $this->_data;
+
+		$session_data = $this->txn->session_data();
+
+
+		// other data from the session (if possible)
+		$this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
+		$this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
+		$this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
+		$this->init_access = $this->last_access = '';
+		// get all non-trashed registrations
+		$this->reg_objs = $this->txn->registrations(array(array('REG_deleted' => false)));
+		$this->_assemble_data();
+	}
 }

core/libraries/messages/EE_Message_To_Generate_From_Request.php

Spacing +2 added lines, -2 removed lines

@@ -52,7 +52,7 @@ 
             [],
             $request->getRequestParam('context')
         );
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return;
         }
         $this->token              = $request->getRequestParam('token');
@@ -108,7 +108,7 @@ 
         /** @type EE_Registration $registration */
         $registration = EEM_Registration::instance()->get_one([['REG_url_link' => $this->token]]);
         // if no registration then bail early.
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new EE_Error(esc_html__('Unable to complete the request because the token is invalid.', 'event_espresso'));
         }
 

Indentation +96 added lines, -96 removed lines

@@ -18,113 +18,113 @@
  */
 class EE_Message_To_Generate_From_Request extends EE_Message_To_Generate implements EEI_Has_Sending_Messenger
 {
-    /**
-     * This messenger is used to send the generated message.
-     *
-     * @type EE_messenger
-     */
-    protected $_sending_messenger = '';
+	/**
+	 * This messenger is used to send the generated message.
+	 *
+	 * @type EE_messenger
+	 */
+	protected $_sending_messenger = '';
 
 
-    /**
-     * Holds the token from the request.
-     *
-     * @type string
-     */
-    public $token = '';
+	/**
+	 * Holds the token from the request.
+	 *
+	 * @type string
+	 */
+	public $token = '';
 
 
-    /**
-     * Constructor
-     * This instantiates the object using arguments from the given request and calling the parent constructor.
-     *
-     * @param EE_Message_Resource_Manager $message_resource_manager
-     * @param RequestInterface            $request
-     * @throws EE_Error
-     */
-    public function __construct(EE_Message_Resource_Manager $message_resource_manager, RequestInterface $request)
-    {
-        parent::__construct(
-            $request->getRequestParam('gen_msgr'),
-            $request->getRequestParam('message_type'),
-            [],
-            $request->getRequestParam('context')
-        );
-        if (! $this->valid()) {
-            return;
-        }
-        $this->token              = $request->getRequestParam('token');
-        $this->_sending_messenger = $message_resource_manager->get_active_messenger(
-            $request->getRequestParam('snd_msgr')
-        );
-        $this->_validate_request();
-        $this->_data = $this->_get_data_from_request($request->getRequestParam('id'));
-    }
+	/**
+	 * Constructor
+	 * This instantiates the object using arguments from the given request and calling the parent constructor.
+	 *
+	 * @param EE_Message_Resource_Manager $message_resource_manager
+	 * @param RequestInterface            $request
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Message_Resource_Manager $message_resource_manager, RequestInterface $request)
+	{
+		parent::__construct(
+			$request->getRequestParam('gen_msgr'),
+			$request->getRequestParam('message_type'),
+			[],
+			$request->getRequestParam('context')
+		);
+		if (! $this->valid()) {
+			return;
+		}
+		$this->token              = $request->getRequestParam('token');
+		$this->_sending_messenger = $message_resource_manager->get_active_messenger(
+			$request->getRequestParam('snd_msgr')
+		);
+		$this->_validate_request();
+		$this->_data = $this->_get_data_from_request($request->getRequestParam('id'));
+	}
 
 
-    /**
-     * @return EE_messenger
-     */
-    public function sending_messenger()
-    {
-        return $this->_sending_messenger;
-    }
+	/**
+	 * @return EE_messenger
+	 */
+	public function sending_messenger()
+	{
+		return $this->_sending_messenger;
+	}
 
 
-    /**
-     * This validates set properties from the incoming request.
-     *
-     * @throws EE_Error
-     */
-    protected function _validate_request()
-    {
-        if (
-            ! $this->_sending_messenger instanceof EE_messenger
-            || ! $this->_messenger instanceof EE_messenger
-            || ! $this->_message_type instanceof EE_message_type
-            || empty($this->_context)
-            || empty($this->token)
-        ) {
-            throw new EE_Error(esc_html__(
-                'The request for the "msg_url_trigger" route has a malformed url.',
-                'event_espresso'
-            ));
-        }
-    }
+	/**
+	 * This validates set properties from the incoming request.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _validate_request()
+	{
+		if (
+			! $this->_sending_messenger instanceof EE_messenger
+			|| ! $this->_messenger instanceof EE_messenger
+			|| ! $this->_message_type instanceof EE_message_type
+			|| empty($this->_context)
+			|| empty($this->token)
+		) {
+			throw new EE_Error(esc_html__(
+				'The request for the "msg_url_trigger" route has a malformed url.',
+				'event_espresso'
+			));
+		}
+	}
 
 
-    /**
-     * This returns the data property according to what is expected from the request.
-     *
-     * @param $id
-     * @return mixed (whatever the data is returned from the message type).
-     * @throws EE_Error
-     */
-    protected function _get_data_from_request($id)
-    {
-        // get the EE_Registration from the token
-        /** @type EE_Registration $registration */
-        $registration = EEM_Registration::instance()->get_one([['REG_url_link' => $this->token]]);
-        // if no registration then bail early.
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(esc_html__('Unable to complete the request because the token is invalid.', 'event_espresso'));
-        }
+	/**
+	 * This returns the data property according to what is expected from the request.
+	 *
+	 * @param $id
+	 * @return mixed (whatever the data is returned from the message type).
+	 * @throws EE_Error
+	 */
+	protected function _get_data_from_request($id)
+	{
+		// get the EE_Registration from the token
+		/** @type EE_Registration $registration */
+		$registration = EEM_Registration::instance()->get_one([['REG_url_link' => $this->token]]);
+		// if no registration then bail early.
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(esc_html__('Unable to complete the request because the token is invalid.', 'event_espresso'));
+		}
 
-        return $this->_get_data_to_use($registration, $id);
-    }
+		return $this->_get_data_to_use($registration, $id);
+	}
 
 
-    /**
-     * This uses the set message type to retrieve the data in the correct format as it came from the url.
-     *
-     * @param EE_Registration $registration
-     * @param int             $data_id This is sometimes used for secondary data a message type requires.
-     * @return mixed   Data prepared as needed for generating this message.
-     * @throws EE_Error
-     */
-    protected function _get_data_to_use($registration, $data_id)
-    {
-        // use incoming data from url to setup data for the message type requirements
-        return $this->_message_type->get_data_for_context($this->_context, $registration, $data_id);
-    }
+	/**
+	 * This uses the set message type to retrieve the data in the correct format as it came from the url.
+	 *
+	 * @param EE_Registration $registration
+	 * @param int             $data_id This is sometimes used for secondary data a message type requires.
+	 * @return mixed   Data prepared as needed for generating this message.
+	 * @throws EE_Error
+	 */
+	protected function _get_data_to_use($registration, $data_id)
+	{
+		// use incoming data from url to setup data for the message type requirements
+		return $this->_message_type->get_data_for_context($this->_context, $registration, $data_id);
+	}
 }

core/libraries/messages/EE_message_type.lib.php

Spacing +29 added lines, -29 removed lines

@@ -408,7 +408,7 @@ 
     {
         // validate context
         // valid context?
-        if (! isset($this->_contexts[ $context ])) {
+        if ( ! isset($this->_contexts[$context])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -464,7 +464,7 @@ 
     public function get_data_for_context($context, EE_Registration $registration, $id = 0)
     {
         // valid context?
-        if (! isset($this->_contexts[ $context ])) {
+        if ( ! isset($this->_contexts[$context])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -479,7 +479,7 @@ 
             $this->_get_data_for_context($context, $registration, $id),
             $this
         );
-        $data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
+        $data = apply_filters('FHEE__'.get_class($this).'__get_data_for_context__data', $data, $this);
         // if empty then something went wrong!
         if (empty($data)) {
             throw new EE_Error(
@@ -539,7 +539,7 @@ 
     public function with_messengers()
     {
         return apply_filters(
-            'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
+            'FHEE__EE_message_type__get_with_messengers__with_messengers__'.get_class($this),
             $this->_with_messengers
         );
     }
@@ -600,7 +600,7 @@ 
     {
         // first class specific filter then filter that by the global filter.
         $master_templates = apply_filters(
-            'FHEE__' . get_class($this) . '__get_master_templates',
+            'FHEE__'.get_class($this).'__get_master_templates',
             $this->_master_templates
         );
         return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
@@ -624,11 +624,11 @@ 
         $addressees        = array();
         $original_contexts = $this->_contexts;
         // if incoming context then limit to that context
-        if (! empty($context)) {
-            $cntxt = ! empty($this->_contexts[ $context ]) ? $this->_contexts[ $context ] : '';
-            if (! empty($cntxt)) {
-                $this->_contexts           = array();
-                $this->_contexts[ $context ] = $cntxt;
+        if ( ! empty($context)) {
+            $cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
+            if ( ! empty($cntxt)) {
+                $this->_contexts = array();
+                $this->_contexts[$context] = $cntxt;
             }
         }
         $this->_set_default_addressee_data();
@@ -653,13 +653,13 @@ 
     {
         // at a minimum, we NEED EE_Attendee objects.
         if (empty($this->_data->attendees)) {
-            return false;  // there's no data to process!
+            return false; // there's no data to process!
         }
         // process addressees for each context.  Child classes will have to have methods for
         // each context defined to handle the processing of the data object within them
         foreach ($this->_contexts as $context => $details) {
-            $xpctd_method = '_' . $context . '_addressees';
-            if (! method_exists($this, $xpctd_method)) {
+            $xpctd_method = '_'.$context.'_addressees';
+            if ( ! method_exists($this, $xpctd_method)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -671,7 +671,7 @@ 
                     )
                 );
             }
-            $this->_addressees[ $context ] = call_user_func(array($this, $xpctd_method));
+            $this->_addressees[$context] = call_user_func(array($this, $xpctd_method));
         }
         return true; // data was processed successfully.
     }
@@ -707,7 +707,7 @@ 
             'total_ticket_count'       => $this->_data->total_ticket_count,
         );
         if (is_array($this->_data->primary_attendee_data)) {
-            $this->_default_addressee_data                    = array_merge(
+            $this->_default_addressee_data = array_merge(
                 $this->_default_addressee_data,
                 $this->_data->primary_attendee_data
             );
@@ -750,25 +750,25 @@ 
             'email',
             'messenger',
         );
-        $contexts       = $this->get_contexts();
+        $contexts = $this->get_contexts();
         foreach ($contexts as $context => $details) {
-            $this->_valid_shortcodes[ $context ] = $all_shortcodes;
+            $this->_valid_shortcodes[$context] = $all_shortcodes;
             // make sure non admin context does not include the event_author shortcodes
             if ($context != 'admin') {
-                if (($key = array_search('event_author', $this->_valid_shortcodes[ $context ])) !== false) {
-                    unset($this->_valid_shortcodes[ $context ][ $key ]);
+                if (($key = array_search('event_author', $this->_valid_shortcodes[$context])) !== false) {
+                    unset($this->_valid_shortcodes[$context][$key]);
                 }
             }
         }
         // make sure admin context does not include the recipient_details shortcodes
         // IF we have admin context hooked in message types might not have that context.
-        if (! empty($this->_valid_shortcodes['admin'])) {
+        if ( ! empty($this->_valid_shortcodes['admin'])) {
             if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][ $key ]);
+                unset($this->_valid_shortcodes['admin'][$key]);
             }
             // make sure admin context does not include the recipient_details shortcodes
             if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][ $key ]);
+                unset($this->_valid_shortcodes['admin'][$key]);
             }
         }
     }
@@ -783,7 +783,7 @@ 
     public function reset_valid_shortcodes_config($new_config)
     {
         foreach ($new_config as $context => $shortcodes) {
-            $this->_valid_shortcodes[ $context ] = $shortcodes;
+            $this->_valid_shortcodes[$context] = $shortcodes;
         }
     }
 
@@ -807,11 +807,11 @@ 
         foreach ($this->_data->events as $line_ref => $event) {
             $admin_id = $this->_get_event_admin_id($event['ID']);
             // make sure we are just including the events that belong to this admin!
-            $admin_events[ $admin_id ][ $line_ref ] = $event;
+            $admin_events[$admin_id][$line_ref] = $event;
         }
         // k now we can loop through the event_admins and setup the addressee data.
         foreach ($admin_events as $admin_id => $event_details) {
-            $aee          = array(
+            $aee = array(
                 'user_id'        => $admin_id,
                 'events'         => $event_details,
                 'attendees'      => $this->_data->attendees,
@@ -869,7 +869,7 @@ 
             }
             // is $this->_regs_for_sending present?
             // If so, let's make sure we ONLY generate addressee for registrations in that array.
-            if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+            if ( ! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
                 $regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
                 if (empty($regs_allowed)) {
                     continue;
@@ -888,10 +888,10 @@ 
             }
             $already_processed[] = $att_id;
             foreach ($details as $item => $value) {
-                $aee[ $item ] = $value;
+                $aee[$item] = $value;
                 if ($item === 'line_ref') {
                     foreach ($value as $event_id) {
-                        $aee['events'][ $event_id ] = $this->_data->events[ $event_id ];
+                        $aee['events'][$event_id] = $this->_data->events[$event_id];
                     }
                 }
                 if ($item === 'attendee_email') {
@@ -903,7 +903,7 @@ 
             }
             // note the FIRST reg object in this array is the one
             // we'll use for this attendee as the primary registration for this attendee.
-            $aee['reg_obj']        = reset($this->_data->attendees[ $att_id ]['reg_objs']);
+            $aee['reg_obj']        = reset($this->_data->attendees[$att_id]['reg_objs']);
             $aee['attendees']      = $this->_data->attendees;
             $aee['recipient_id']   = $att_id;
             $aee['recipient_type'] = 'Attendee';

Indentation +905 added lines, -905 removed lines

@@ -15,915 +15,915 @@
  */
 abstract class EE_message_type extends EE_Messages_Base
 {
-    /**
-     * message type child classes will set what contexts are associated with the message type via this array.
-     * format:
-     * array(
-     * 'context' => array(
-     *        'label' => esc_html__('Context Label', 'event_espresso'),
-     *        'description' => esc_html__('Context description (for help popups)', 'event_espresso')
-     *    ));
-     *
-     * @var array
-     */
-    protected $_contexts = array();
-
-
-    /**
-     * This property is used to define what the display label will be for contexts (eg. "Recipients", "Themes" etc.)
-     * Format:
-     * array( 'label' => 'something', 'plural' => 'somethings', 'description' => 'something' );
-     *
-     * @var array
-     */
-    protected $_context_label;
-
-
-    /** MESSAGE ASSEMBLING PROPERTIES **/
-    /**
-     * This parameter simply holds all the message objects for retrieval by the controller and sending to the messenger.
-     *
-     * @var array of message objects.
-     */
-    public $messages = array();
-
-    /**
-     * The following holds the templates that will be used to assemble the message object for the messenger.
-     *
-     * @var array
-     */
-    protected $_templates;
-
-
-    /**
-     * If a specific template is being parsed, this will hold the message template group GRP_ID for that template.
-     *
-     * @var int.
-     */
-    protected $_GRP_ID;
-
-
-    /** OTHER INFO PROPERTIES **/
-    /**
-     * This will hold the count of the message objects in the messages array. This could be used for determining if
-     * batching/queueing is needed.
-     *
-     * @var int
-     */
-    public $count = 0;
-
-
-    /**
-     * This is set via the `do_messenger_hooks` method and contains the messenger being used to send the message of
-     * this message type at time of sending.
-     *
-     * @var EE_messenger
-     */
-    protected $_active_messenger;
-
-
-    /**
-     * This will hold the shortcode_replace instance for handling replacement of shortcodes in the various templates
-     *
-     * @var object
-     */
-    protected $_shortcode_replace;
-
-
-    /**
-     * The purpose for this property is to simply allow message types to indicate if the message generated is intended
-     * for only single context.  Child message types should redefine this variable (if necessary) in the
-     * _set_data_Handler() method.
-     *
-     * @var boolean
-     */
-    protected $_single_message = false;
-
-
-    /**
-     * This will hold an array of specific reg_ids that are receiving messages.
-     *
-     * @since 4.7.x
-     * @var array
-     */
-    protected $_regs_for_sending = array();
-
-
-    /**
-     * This holds the data passed to this class from the controller and also the final processed data.
-     *
-     * @var object
-     */
-    protected $_data;
-
-
-    /**
-     * this is just a flag indicating whether we're in preview mode or not.
-     *
-     * @var bool
-     */
-    protected $_preview = false;
-
-
-    /**
-     * This just holds defaults for addressee data that children merge with their data array setup
-     *
-     * @var array
-     */
-    protected $_default_addressee_data;
-
-
-    /**
-     * Child classes declare through this property what handler they want to use for the incoming data and this string
-     * is used to instantiate the EE_Messages_incoming_data child class for that handler.
-     *
-     * @var string
-     */
-    protected $_data_handler;
-
-
-    /**
-     * This holds any specific fields for holding any settings related to a message type (if any needed)
-     *
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
-
-    /**
-     * this property will hold any existing setting that may have been set in the admin.
-     *
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
-
-
-    /**
-     * This is used to designate the generating and alternative sending messengers for a message type.  It is set via
-     * set_with_messengers() on construct. Note, generating messenger also acts as a sending messenger for this message
-     * type.  However ONLY the generating messengers are used for creating templates for this message type. Should be
-     * in this format:
-     * {
-     *
-     * @type string $generating_messenger the name of the generating messenger.  Generating
-     *                                          messengers are used for generating templates,
-     *                                          doing validation and defining valid shortcodes.
-     *      {
-     * @type string $sending_messenger    values are the name(s) for the sending
-     *                                              messengers.  sending messengers are
-     *                                              just valid delivery vehicles that will utilize
-     *                                              the templates (and generated EE_message
-     *                                              objects from the generating messengers).
-     *      }
-     * }
-     * @since                             4.5.0
-     * @var array
-     */
-    protected $_with_messengers = array();
-
-
-    /**
-     * This holds the addressees in an array indexed by context for later retrieval when assembling the message objects.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_addressees = array();
-
-
-    /**
-     * This allows each message type to set what alternate messenger&message type combination can be used for fallback
-     * default templates if there are no specific ones defined for this messenger and message type.  Should be in the
-     * format:
-     * array(
-     *      'messenger' => 'message_type',
-     *      'another_messenger' => another_message_type
-     * );
-     * This is set in the message type constructor.
-     *
-     * @var array
-     */
-    protected $_master_templates = array();
-
-
-    /**
-     * This holds whatever the set template pack is for a message template group when generating messages.
-     *
-     * @since 4.5.0
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-
-
-    /**
-     * This holds whatever the set variation is for a message template group when generating messages.
-     *
-     * @since 4.5.0
-     * @var string
-     */
-    protected $_variation;
-
-
-    /**
-     * EE_message_type constructor.
-     */
-    public function __construct()
-    {
-        $this->_messages_item_type = 'message_type';
-        $this->_set_contexts();
-        $this->_set_with_messengers();
-        parent::__construct();
-    }
-
-
-    /**
-     * This sets the data handler for the message type.  It must be used to define the _data_handler property.  It is
-     * called when messages are setup.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_data_handler();
-
-
-    /**
-     * This method should return a EE_Base_Class object (or array of EE_Base_Class objects) for the given context and
-     * ID (which should be the primary key id for the base class).  Client code doesn't have to know what a message
-     * type's data handler is.
-     *
-     * @since 4.5.0
-     * @param string          $context      This should be a string matching a valid context for the message type.
-     * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
-     *                                      guessing a url).
-     * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
-     *                                      EE_Base_Class_Object
-     * @return mixed ( EE_Base_Class||EE_Base_Class[] )
-     */
-    abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
-
-
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @abstract
-     * @access  protected
-     * @return  void
-     */
-    abstract protected function _set_contexts();
-
-
-    /**
-     * This is used to get the "id" value fo the msg_trigger_url generated by get_url_trigger().
-     * In most cases, child classes don't need anything, (hence the default of 0), however if there is a specific
-     * EE_Base_Class that is required in generating a message for a message type recipient then the message
-     * type should override this method and use the given params to generate the correct ID.
-     *
-     * @param string          $context      The message type context.
-     * @param EE_Registration $registration Registration object
-     * @deprecated 4.9.0
-     * @return int
-     */
-    protected function _get_id_for_msg_url($context, EE_Registration $registration)
-    {
-        return 0;
-    }
-
-
-    /**
-     * This sets up any action/filter hooks this message type puts in place for a specific messenger.  Note that by
-     * default this does nothing.  Child classes will need to override if they want to add specific hooks for a
-     * messenger.
-     *
-     * @since 1.0.0
-     * @return void
-     */
-    protected function _do_messenger_hooks()
-    {
-        return;
-    }
-
-
-    /**
-     * This is a public wrapper for the protected _do_messenger_hooks() method.
-     * For backward compat reasons, this was done rather than making the protected method public.
-     *
-     * @param   EE_messenger $messenger This is used to set the $_active_messenger property, so message types are able
-     *                                  to know what messenger is being used to send the message at the time of
-     *                                  sending.
-     * @since 4.9.0
-     */
-    public function do_messenger_hooks($messenger = null)
-    {
-        $this->_active_messenger = $messenger;
-        $this->_do_messenger_hooks();
-    }
-
-
-    /**
-     * This method returns whether this message type should always generate a new copy
-     * when requested, or if links can be to the already generated copy.
-     * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
-     * Child classes should override this if different from the default of false.
-     *
-     * @return bool     false means can link to generated EE_Message.  true must regenerate.
-     */
-    public function always_generate()
-    {
-        return false;
-    }
-
-
-    /**
-     * Returns the priority for the message type.
-     * Priorities are defined as constants on EEM_Message.  Currently there are three priorities:
-     * - EEM_Message::priority_high
-     * - EEM_Message::priority_medium
-     * - EEM_Message::priority_low
-     * Priority is used to determine the weight the message type is given when queuing for generation and/or sending.
-     *
-     * @see    EEM_Message for more phpdocs on priority.
-     *         The default priority for all message_types is EEM_Message::priority_low.  Message Types wanting to give
-     *         a higher priority must override this method. Also note, messengers are able to override priorities
-     *         queuing instructions if their "send_now" flag is set to true. An example of this is the HTML messenger
-     *         which displays things in the browser.
-     * @since  4.9.0
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_low;
-    }
-
-
-    /**
-     * This runs the _set_data_handler() method for message types and then returns what got set.
-     *
-     * @param mixed $data This sets the data property for the message type with the incoming data used for generating.
-     * @return string (the reference for the data handler) (will be an empty string if could not be determined).
-     */
-    public function get_data_handler($data)
-    {
-        $this->_data = $data;
-        $this->_set_data_handler();
-        return apply_filters('FHEE__EE_message_type__get_data_handler', $this->_data_handler, $this);
-    }
-
-
-    /**
-     * This is called externally to reset the value of the $_data property for the message type.
-     * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
-     * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called
-     * (and for back compat reasons). This particular method is used in
-     * EE_Messages_Generator::_reset_current_properties to ensure that the internal _data on the message type is
-     * cleaned before subsequent EE_Message generation in the same request.
-     *
-     * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
-     *            ensure that there is no manipulation of the _data property during run time so there's a clear
-     *            expectation of what it is.  Likely we need to ensure that _data is not persisted IN the message type
-     *            at all.
-     * @internal  Plugin authors, do not implement this method, it is subject to change.
-     * @since     4.9
-     */
-    public function reset_data()
-    {
-        $this->_data = null;
-    }
-
-
-    /**
-     * This does some validation of incoming params gets the url trigger from the defined method in the specific child
-     * class and then filters the results.
-     *
-     * @param string          $context           The message type context
-     * @param string          $sending_messenger The sending messenger
-     * @param EE_Registration $registration      Registration object
-     * @throws EE_Error
-     * @deprecated  4.9.0  Likely 4.9.10 or 4.10.0 will remove this method completely
-     * @return string          generated url
-     */
-    public function get_url_trigger($context, $sending_messenger, EE_Registration $registration)
-    {
-        // validate context
-        // valid context?
-        if (! isset($this->_contexts[ $context ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $context,
-                    get_class($this)
-                )
-            );
-        }
-        // valid sending_messenger?
-        $not_valid_msgr = false;
-        foreach ($this->_with_messengers as $generating => $sendings) {
-            if (empty($sendings) || array_search($sending_messenger, $sendings) === false) {
-                $not_valid_msgr = true;
-            }
-        }
-        if ($not_valid_msgr) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
-                        'event_espresso'
-                    ),
-                    $sending_messenger,
-                    get_class($this)
-                )
-            );
-        }
-        return EEH_MSG_Template::generate_url_trigger(
-            $sending_messenger,
-            $this->_active_messenger->name,
-            $context,
-            $this->name,
-            $registration,
-            $this->_GRP_ID,
-            $this->_get_id_for_msg_url($context, $registration)
-        );
-    }
-
-
-    /**
-     * Wrapper for _get_data_for_context() that handles some validation before calling the main class and also allows
-     * for filtering. This is (currently) called by the EED_Messages module.
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     * @param string          $context      This should be a string matching a valid context for the message type.
-     * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
-     *                                      guessing a url).
-     * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
-     *                                      EE_Base_Class_Object
-     * @return mixed (EE_Base_Class||EE_Base_Class[])
-     */
-    public function get_data_for_context($context, EE_Registration $registration, $id = 0)
-    {
-        // valid context?
-        if (! isset($this->_contexts[ $context ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $context,
-                    get_class($this)
-                )
-            );
-        }
-        // get data and apply global and class specific filters on it.
-        $data = apply_filters(
-            'FHEE__EE_message_type__get_data_for_context__data',
-            $this->_get_data_for_context($context, $registration, $id),
-            $this
-        );
-        $data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
-        // if empty then something went wrong!
-        if (empty($data)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.',
-                        'event_espresso'
-                    ),
-                    $id,
-                    $this->name
-                )
-            );
-        }
-        return $data;
-    }
-
-
-    /**
-     * This returns the contents of the _data property.
-     * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
-     * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called.
-     *
-     * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
-     *            ensure that there is no manipulation of the _data property during run time so there's a clear
-     *            expectation of what it is.
-     * @internal  Plugin authors, do not implement this method, it is subject to change.
-     * @return mixed
-     */
-    public function get_data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * used to set the $_with_messengers property. (this is a default, child classes SHOULD override)
-     *
-     * @see   property definition for description of setup.
-     * @since 4.5.0
-     * @abstract
-     * @return void
-     */
-    protected function _set_with_messengers()
-    {
-        $this->_with_messengers = array(
-            'email' => array('html'),
-        );
-    }
-
-
-    /**
-     * Return the value of the _with_messengers property
-     *
-     * @since 4.5.0
-     * @return array
-     */
-    public function with_messengers()
-    {
-        return apply_filters(
-            'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
-            $this->_with_messengers
-        );
-    }
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class
-     * callback function if that page is registered via the `_admin_registered_page` property set by the child class.
-     * *
-     *
-     * @param string $page       the slug of the EE admin page
-     * @param array  $messengers an array of active messenger objects
-     * @param string $action     the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array  $extra      This is just an extra argument that can be used to pass additional data for setting up
-     *                           page content.
-     * @access public
-     * @return string
-     */
-    public function get_message_type_admin_page_content(
-        $page,
-        $action = null,
-        $extra = array(),
-        $messengers = array()
-    ) {
-        // we can also further refine the context by action (if present).
-        return $this->_get_admin_page_content($page, $action, $extra, $messengers);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_contexts()
-    {
-        return $this->_contexts;
-    }
-
-
-    /**
-     * This just returns the context label for a given context (as set in $_context_label property)
-     *
-     * @access public
-     * @return array
-     */
-    public function get_context_label()
-    {
-        return $this->_context_label;
-    }
-
-
-    /**
-     * This just returns the (filtered) _master_templates property.
-     *
-     * @see property definition for documentation.
-     * @return array
-     */
-    public function get_master_templates()
-    {
-        // first class specific filter then filter that by the global filter.
-        $master_templates = apply_filters(
-            'FHEE__' . get_class($this) . '__get_master_templates',
-            $this->_master_templates
-        );
-        return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
-    }
-
-
-    /**
-     * Accepts an incoming data handler which contains data for processing, and returns an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param EE_Messages_incoming_data $data
-     * @param string                    $context Limit addressees to specific context.
-     * @return array An array indexed by context where each context is an array of EE_Messages_Addressee objects for
-     *                                           that context
-     * @throws EE_Error
-     */
-    public function get_addressees(EE_Messages_incoming_data $data, $context = '')
-    {
-        // override _data
-        $this->_data       = $data;
-        $addressees        = array();
-        $original_contexts = $this->_contexts;
-        // if incoming context then limit to that context
-        if (! empty($context)) {
-            $cntxt = ! empty($this->_contexts[ $context ]) ? $this->_contexts[ $context ] : '';
-            if (! empty($cntxt)) {
-                $this->_contexts           = array();
-                $this->_contexts[ $context ] = $cntxt;
-            }
-        }
-        $this->_set_default_addressee_data();
-        if ($this->_process_data()) {
-            $addressees = $this->_addressees;
-        }
-
-        // reset contexts and addressees
-        $this->_contexts   = $original_contexts;
-        $this->_addressees = array();
-        return $addressees;
-    }
-
-
-    /**
-     * processes the data object so we get
-     *
-     * @throws EE_Error
-     * @return bool  true means data was processed successfully, false means not.
-     */
-    protected function _process_data()
-    {
-        // at a minimum, we NEED EE_Attendee objects.
-        if (empty($this->_data->attendees)) {
-            return false;  // there's no data to process!
-        }
-        // process addressees for each context.  Child classes will have to have methods for
-        // each context defined to handle the processing of the data object within them
-        foreach ($this->_contexts as $context => $details) {
-            $xpctd_method = '_' . $context . '_addressees';
-            if (! method_exists($this, $xpctd_method)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present',
-                            'event_espresso'
-                        ),
-                        $this->label['singular'],
-                        $xpctd_method
-                    )
-                );
-            }
-            $this->_addressees[ $context ] = call_user_func(array($this, $xpctd_method));
-        }
-        return true; // data was processed successfully.
-    }
-
-
-    /**
-     * sets the default_addressee_data property,
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_default_addressee_data()
-    {
-        $this->_default_addressee_data = array(
-            'billing'                  => $this->_data->billing,
-            'taxes'                    => $this->_data->taxes,
-            'tax_line_items'           => $this->_data->tax_line_items,
-            'additional_line_items'    => $this->_data->additional_line_items,
-            'grand_total_line_item'    => $this->_data->grand_total_line_item,
-            'txn'                      => $this->_data->txn,
-            'payments'                 => $this->_data->payments,
-            'payment'                  => isset($this->_data->payment) && $this->_data->payment instanceof EE_Payment
-                ? $this->_data->payment
-                : null,
-            'reg_objs'                 => $this->_data->reg_objs,
-            'registrations'            => $this->_data->registrations,
-            'datetimes'                => $this->_data->datetimes,
-            'tickets'                  => $this->_data->tickets,
-            'line_items_with_children' => $this->_data->line_items_with_children,
-            'questions'                => $this->_data->questions,
-            'answers'                  => $this->_data->answers,
-            'txn_status'               => $this->_data->txn_status,
-            'total_ticket_count'       => $this->_data->total_ticket_count,
-        );
-        if (is_array($this->_data->primary_attendee_data)) {
-            $this->_default_addressee_data                    = array_merge(
-                $this->_default_addressee_data,
-                $this->_data->primary_attendee_data
-            );
-            $this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
-            $this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
-        }
-    }
-
-
-
-    /********************
+	/**
+	 * message type child classes will set what contexts are associated with the message type via this array.
+	 * format:
+	 * array(
+	 * 'context' => array(
+	 *        'label' => esc_html__('Context Label', 'event_espresso'),
+	 *        'description' => esc_html__('Context description (for help popups)', 'event_espresso')
+	 *    ));
+	 *
+	 * @var array
+	 */
+	protected $_contexts = array();
+
+
+	/**
+	 * This property is used to define what the display label will be for contexts (eg. "Recipients", "Themes" etc.)
+	 * Format:
+	 * array( 'label' => 'something', 'plural' => 'somethings', 'description' => 'something' );
+	 *
+	 * @var array
+	 */
+	protected $_context_label;
+
+
+	/** MESSAGE ASSEMBLING PROPERTIES **/
+	/**
+	 * This parameter simply holds all the message objects for retrieval by the controller and sending to the messenger.
+	 *
+	 * @var array of message objects.
+	 */
+	public $messages = array();
+
+	/**
+	 * The following holds the templates that will be used to assemble the message object for the messenger.
+	 *
+	 * @var array
+	 */
+	protected $_templates;
+
+
+	/**
+	 * If a specific template is being parsed, this will hold the message template group GRP_ID for that template.
+	 *
+	 * @var int.
+	 */
+	protected $_GRP_ID;
+
+
+	/** OTHER INFO PROPERTIES **/
+	/**
+	 * This will hold the count of the message objects in the messages array. This could be used for determining if
+	 * batching/queueing is needed.
+	 *
+	 * @var int
+	 */
+	public $count = 0;
+
+
+	/**
+	 * This is set via the `do_messenger_hooks` method and contains the messenger being used to send the message of
+	 * this message type at time of sending.
+	 *
+	 * @var EE_messenger
+	 */
+	protected $_active_messenger;
+
+
+	/**
+	 * This will hold the shortcode_replace instance for handling replacement of shortcodes in the various templates
+	 *
+	 * @var object
+	 */
+	protected $_shortcode_replace;
+
+
+	/**
+	 * The purpose for this property is to simply allow message types to indicate if the message generated is intended
+	 * for only single context.  Child message types should redefine this variable (if necessary) in the
+	 * _set_data_Handler() method.
+	 *
+	 * @var boolean
+	 */
+	protected $_single_message = false;
+
+
+	/**
+	 * This will hold an array of specific reg_ids that are receiving messages.
+	 *
+	 * @since 4.7.x
+	 * @var array
+	 */
+	protected $_regs_for_sending = array();
+
+
+	/**
+	 * This holds the data passed to this class from the controller and also the final processed data.
+	 *
+	 * @var object
+	 */
+	protected $_data;
+
+
+	/**
+	 * this is just a flag indicating whether we're in preview mode or not.
+	 *
+	 * @var bool
+	 */
+	protected $_preview = false;
+
+
+	/**
+	 * This just holds defaults for addressee data that children merge with their data array setup
+	 *
+	 * @var array
+	 */
+	protected $_default_addressee_data;
+
+
+	/**
+	 * Child classes declare through this property what handler they want to use for the incoming data and this string
+	 * is used to instantiate the EE_Messages_incoming_data child class for that handler.
+	 *
+	 * @var string
+	 */
+	protected $_data_handler;
+
+
+	/**
+	 * This holds any specific fields for holding any settings related to a message type (if any needed)
+	 *
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
+
+	/**
+	 * this property will hold any existing setting that may have been set in the admin.
+	 *
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
+
+
+	/**
+	 * This is used to designate the generating and alternative sending messengers for a message type.  It is set via
+	 * set_with_messengers() on construct. Note, generating messenger also acts as a sending messenger for this message
+	 * type.  However ONLY the generating messengers are used for creating templates for this message type. Should be
+	 * in this format:
+	 * {
+	 *
+	 * @type string $generating_messenger the name of the generating messenger.  Generating
+	 *                                          messengers are used for generating templates,
+	 *                                          doing validation and defining valid shortcodes.
+	 *      {
+	 * @type string $sending_messenger    values are the name(s) for the sending
+	 *                                              messengers.  sending messengers are
+	 *                                              just valid delivery vehicles that will utilize
+	 *                                              the templates (and generated EE_message
+	 *                                              objects from the generating messengers).
+	 *      }
+	 * }
+	 * @since                             4.5.0
+	 * @var array
+	 */
+	protected $_with_messengers = array();
+
+
+	/**
+	 * This holds the addressees in an array indexed by context for later retrieval when assembling the message objects.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_addressees = array();
+
+
+	/**
+	 * This allows each message type to set what alternate messenger&message type combination can be used for fallback
+	 * default templates if there are no specific ones defined for this messenger and message type.  Should be in the
+	 * format:
+	 * array(
+	 *      'messenger' => 'message_type',
+	 *      'another_messenger' => another_message_type
+	 * );
+	 * This is set in the message type constructor.
+	 *
+	 * @var array
+	 */
+	protected $_master_templates = array();
+
+
+	/**
+	 * This holds whatever the set template pack is for a message template group when generating messages.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+
+
+	/**
+	 * This holds whatever the set variation is for a message template group when generating messages.
+	 *
+	 * @since 4.5.0
+	 * @var string
+	 */
+	protected $_variation;
+
+
+	/**
+	 * EE_message_type constructor.
+	 */
+	public function __construct()
+	{
+		$this->_messages_item_type = 'message_type';
+		$this->_set_contexts();
+		$this->_set_with_messengers();
+		parent::__construct();
+	}
+
+
+	/**
+	 * This sets the data handler for the message type.  It must be used to define the _data_handler property.  It is
+	 * called when messages are setup.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_data_handler();
+
+
+	/**
+	 * This method should return a EE_Base_Class object (or array of EE_Base_Class objects) for the given context and
+	 * ID (which should be the primary key id for the base class).  Client code doesn't have to know what a message
+	 * type's data handler is.
+	 *
+	 * @since 4.5.0
+	 * @param string          $context      This should be a string matching a valid context for the message type.
+	 * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
+	 *                                      guessing a url).
+	 * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
+	 *                                      EE_Base_Class_Object
+	 * @return mixed ( EE_Base_Class||EE_Base_Class[] )
+	 */
+	abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
+
+
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @abstract
+	 * @access  protected
+	 * @return  void
+	 */
+	abstract protected function _set_contexts();
+
+
+	/**
+	 * This is used to get the "id" value fo the msg_trigger_url generated by get_url_trigger().
+	 * In most cases, child classes don't need anything, (hence the default of 0), however if there is a specific
+	 * EE_Base_Class that is required in generating a message for a message type recipient then the message
+	 * type should override this method and use the given params to generate the correct ID.
+	 *
+	 * @param string          $context      The message type context.
+	 * @param EE_Registration $registration Registration object
+	 * @deprecated 4.9.0
+	 * @return int
+	 */
+	protected function _get_id_for_msg_url($context, EE_Registration $registration)
+	{
+		return 0;
+	}
+
+
+	/**
+	 * This sets up any action/filter hooks this message type puts in place for a specific messenger.  Note that by
+	 * default this does nothing.  Child classes will need to override if they want to add specific hooks for a
+	 * messenger.
+	 *
+	 * @since 1.0.0
+	 * @return void
+	 */
+	protected function _do_messenger_hooks()
+	{
+		return;
+	}
+
+
+	/**
+	 * This is a public wrapper for the protected _do_messenger_hooks() method.
+	 * For backward compat reasons, this was done rather than making the protected method public.
+	 *
+	 * @param   EE_messenger $messenger This is used to set the $_active_messenger property, so message types are able
+	 *                                  to know what messenger is being used to send the message at the time of
+	 *                                  sending.
+	 * @since 4.9.0
+	 */
+	public function do_messenger_hooks($messenger = null)
+	{
+		$this->_active_messenger = $messenger;
+		$this->_do_messenger_hooks();
+	}
+
+
+	/**
+	 * This method returns whether this message type should always generate a new copy
+	 * when requested, or if links can be to the already generated copy.
+	 * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
+	 * Child classes should override this if different from the default of false.
+	 *
+	 * @return bool     false means can link to generated EE_Message.  true must regenerate.
+	 */
+	public function always_generate()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Returns the priority for the message type.
+	 * Priorities are defined as constants on EEM_Message.  Currently there are three priorities:
+	 * - EEM_Message::priority_high
+	 * - EEM_Message::priority_medium
+	 * - EEM_Message::priority_low
+	 * Priority is used to determine the weight the message type is given when queuing for generation and/or sending.
+	 *
+	 * @see    EEM_Message for more phpdocs on priority.
+	 *         The default priority for all message_types is EEM_Message::priority_low.  Message Types wanting to give
+	 *         a higher priority must override this method. Also note, messengers are able to override priorities
+	 *         queuing instructions if their "send_now" flag is set to true. An example of this is the HTML messenger
+	 *         which displays things in the browser.
+	 * @since  4.9.0
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_low;
+	}
+
+
+	/**
+	 * This runs the _set_data_handler() method for message types and then returns what got set.
+	 *
+	 * @param mixed $data This sets the data property for the message type with the incoming data used for generating.
+	 * @return string (the reference for the data handler) (will be an empty string if could not be determined).
+	 */
+	public function get_data_handler($data)
+	{
+		$this->_data = $data;
+		$this->_set_data_handler();
+		return apply_filters('FHEE__EE_message_type__get_data_handler', $this->_data_handler, $this);
+	}
+
+
+	/**
+	 * This is called externally to reset the value of the $_data property for the message type.
+	 * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
+	 * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called
+	 * (and for back compat reasons). This particular method is used in
+	 * EE_Messages_Generator::_reset_current_properties to ensure that the internal _data on the message type is
+	 * cleaned before subsequent EE_Message generation in the same request.
+	 *
+	 * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
+	 *            ensure that there is no manipulation of the _data property during run time so there's a clear
+	 *            expectation of what it is.  Likely we need to ensure that _data is not persisted IN the message type
+	 *            at all.
+	 * @internal  Plugin authors, do not implement this method, it is subject to change.
+	 * @since     4.9
+	 */
+	public function reset_data()
+	{
+		$this->_data = null;
+	}
+
+
+	/**
+	 * This does some validation of incoming params gets the url trigger from the defined method in the specific child
+	 * class and then filters the results.
+	 *
+	 * @param string          $context           The message type context
+	 * @param string          $sending_messenger The sending messenger
+	 * @param EE_Registration $registration      Registration object
+	 * @throws EE_Error
+	 * @deprecated  4.9.0  Likely 4.9.10 or 4.10.0 will remove this method completely
+	 * @return string          generated url
+	 */
+	public function get_url_trigger($context, $sending_messenger, EE_Registration $registration)
+	{
+		// validate context
+		// valid context?
+		if (! isset($this->_contexts[ $context ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$context,
+					get_class($this)
+				)
+			);
+		}
+		// valid sending_messenger?
+		$not_valid_msgr = false;
+		foreach ($this->_with_messengers as $generating => $sendings) {
+			if (empty($sendings) || array_search($sending_messenger, $sendings) === false) {
+				$not_valid_msgr = true;
+			}
+		}
+		if ($not_valid_msgr) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
+						'event_espresso'
+					),
+					$sending_messenger,
+					get_class($this)
+				)
+			);
+		}
+		return EEH_MSG_Template::generate_url_trigger(
+			$sending_messenger,
+			$this->_active_messenger->name,
+			$context,
+			$this->name,
+			$registration,
+			$this->_GRP_ID,
+			$this->_get_id_for_msg_url($context, $registration)
+		);
+	}
+
+
+	/**
+	 * Wrapper for _get_data_for_context() that handles some validation before calling the main class and also allows
+	 * for filtering. This is (currently) called by the EED_Messages module.
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 * @param string          $context      This should be a string matching a valid context for the message type.
+	 * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
+	 *                                      guessing a url).
+	 * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
+	 *                                      EE_Base_Class_Object
+	 * @return mixed (EE_Base_Class||EE_Base_Class[])
+	 */
+	public function get_data_for_context($context, EE_Registration $registration, $id = 0)
+	{
+		// valid context?
+		if (! isset($this->_contexts[ $context ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$context,
+					get_class($this)
+				)
+			);
+		}
+		// get data and apply global and class specific filters on it.
+		$data = apply_filters(
+			'FHEE__EE_message_type__get_data_for_context__data',
+			$this->_get_data_for_context($context, $registration, $id),
+			$this
+		);
+		$data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
+		// if empty then something went wrong!
+		if (empty($data)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.',
+						'event_espresso'
+					),
+					$id,
+					$this->name
+				)
+			);
+		}
+		return $data;
+	}
+
+
+	/**
+	 * This returns the contents of the _data property.
+	 * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
+	 * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called.
+	 *
+	 * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
+	 *            ensure that there is no manipulation of the _data property during run time so there's a clear
+	 *            expectation of what it is.
+	 * @internal  Plugin authors, do not implement this method, it is subject to change.
+	 * @return mixed
+	 */
+	public function get_data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * used to set the $_with_messengers property. (this is a default, child classes SHOULD override)
+	 *
+	 * @see   property definition for description of setup.
+	 * @since 4.5.0
+	 * @abstract
+	 * @return void
+	 */
+	protected function _set_with_messengers()
+	{
+		$this->_with_messengers = array(
+			'email' => array('html'),
+		);
+	}
+
+
+	/**
+	 * Return the value of the _with_messengers property
+	 *
+	 * @since 4.5.0
+	 * @return array
+	 */
+	public function with_messengers()
+	{
+		return apply_filters(
+			'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
+			$this->_with_messengers
+		);
+	}
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class
+	 * callback function if that page is registered via the `_admin_registered_page` property set by the child class.
+	 * *
+	 *
+	 * @param string $page       the slug of the EE admin page
+	 * @param array  $messengers an array of active messenger objects
+	 * @param string $action     the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array  $extra      This is just an extra argument that can be used to pass additional data for setting up
+	 *                           page content.
+	 * @access public
+	 * @return string
+	 */
+	public function get_message_type_admin_page_content(
+		$page,
+		$action = null,
+		$extra = array(),
+		$messengers = array()
+	) {
+		// we can also further refine the context by action (if present).
+		return $this->_get_admin_page_content($page, $action, $extra, $messengers);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_contexts()
+	{
+		return $this->_contexts;
+	}
+
+
+	/**
+	 * This just returns the context label for a given context (as set in $_context_label property)
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_context_label()
+	{
+		return $this->_context_label;
+	}
+
+
+	/**
+	 * This just returns the (filtered) _master_templates property.
+	 *
+	 * @see property definition for documentation.
+	 * @return array
+	 */
+	public function get_master_templates()
+	{
+		// first class specific filter then filter that by the global filter.
+		$master_templates = apply_filters(
+			'FHEE__' . get_class($this) . '__get_master_templates',
+			$this->_master_templates
+		);
+		return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
+	}
+
+
+	/**
+	 * Accepts an incoming data handler which contains data for processing, and returns an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param EE_Messages_incoming_data $data
+	 * @param string                    $context Limit addressees to specific context.
+	 * @return array An array indexed by context where each context is an array of EE_Messages_Addressee objects for
+	 *                                           that context
+	 * @throws EE_Error
+	 */
+	public function get_addressees(EE_Messages_incoming_data $data, $context = '')
+	{
+		// override _data
+		$this->_data       = $data;
+		$addressees        = array();
+		$original_contexts = $this->_contexts;
+		// if incoming context then limit to that context
+		if (! empty($context)) {
+			$cntxt = ! empty($this->_contexts[ $context ]) ? $this->_contexts[ $context ] : '';
+			if (! empty($cntxt)) {
+				$this->_contexts           = array();
+				$this->_contexts[ $context ] = $cntxt;
+			}
+		}
+		$this->_set_default_addressee_data();
+		if ($this->_process_data()) {
+			$addressees = $this->_addressees;
+		}
+
+		// reset contexts and addressees
+		$this->_contexts   = $original_contexts;
+		$this->_addressees = array();
+		return $addressees;
+	}
+
+
+	/**
+	 * processes the data object so we get
+	 *
+	 * @throws EE_Error
+	 * @return bool  true means data was processed successfully, false means not.
+	 */
+	protected function _process_data()
+	{
+		// at a minimum, we NEED EE_Attendee objects.
+		if (empty($this->_data->attendees)) {
+			return false;  // there's no data to process!
+		}
+		// process addressees for each context.  Child classes will have to have methods for
+		// each context defined to handle the processing of the data object within them
+		foreach ($this->_contexts as $context => $details) {
+			$xpctd_method = '_' . $context . '_addressees';
+			if (! method_exists($this, $xpctd_method)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present',
+							'event_espresso'
+						),
+						$this->label['singular'],
+						$xpctd_method
+					)
+				);
+			}
+			$this->_addressees[ $context ] = call_user_func(array($this, $xpctd_method));
+		}
+		return true; // data was processed successfully.
+	}
+
+
+	/**
+	 * sets the default_addressee_data property,
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_default_addressee_data()
+	{
+		$this->_default_addressee_data = array(
+			'billing'                  => $this->_data->billing,
+			'taxes'                    => $this->_data->taxes,
+			'tax_line_items'           => $this->_data->tax_line_items,
+			'additional_line_items'    => $this->_data->additional_line_items,
+			'grand_total_line_item'    => $this->_data->grand_total_line_item,
+			'txn'                      => $this->_data->txn,
+			'payments'                 => $this->_data->payments,
+			'payment'                  => isset($this->_data->payment) && $this->_data->payment instanceof EE_Payment
+				? $this->_data->payment
+				: null,
+			'reg_objs'                 => $this->_data->reg_objs,
+			'registrations'            => $this->_data->registrations,
+			'datetimes'                => $this->_data->datetimes,
+			'tickets'                  => $this->_data->tickets,
+			'line_items_with_children' => $this->_data->line_items_with_children,
+			'questions'                => $this->_data->questions,
+			'answers'                  => $this->_data->answers,
+			'txn_status'               => $this->_data->txn_status,
+			'total_ticket_count'       => $this->_data->total_ticket_count,
+		);
+		if (is_array($this->_data->primary_attendee_data)) {
+			$this->_default_addressee_data                    = array_merge(
+				$this->_default_addressee_data,
+				$this->_data->primary_attendee_data
+			);
+			$this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
+			$this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
+		}
+	}
+
+
+
+	/********************
      * setup default shared addressee object/contexts
      * These can be utilized simply by defining the context in the child message type.
      * They can also be overridden if a specific message type needs to do something different for that context.
      ****************/
-    /**
-     * see abstract declaration in parent class for details, children message types can
-     * override these valid shortcodes if desired (we include all for all contexts by default).
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $all_shortcodes = array(
-            'attendee_list',
-            'attendee',
-            'datetime_list',
-            'datetime',
-            'event_list',
-            'event_meta',
-            'event',
-            'organization',
-            'recipient_details',
-            'recipient_list',
-            'ticket_list',
-            'ticket',
-            'transaction',
-            'venue',
-            'primary_registration_details',
-            'primary_registration_list',
-            'event_author',
-            'email',
-            'messenger',
-        );
-        $contexts       = $this->get_contexts();
-        foreach ($contexts as $context => $details) {
-            $this->_valid_shortcodes[ $context ] = $all_shortcodes;
-            // make sure non admin context does not include the event_author shortcodes
-            if ($context != 'admin') {
-                if (($key = array_search('event_author', $this->_valid_shortcodes[ $context ])) !== false) {
-                    unset($this->_valid_shortcodes[ $context ][ $key ]);
-                }
-            }
-        }
-        // make sure admin context does not include the recipient_details shortcodes
-        // IF we have admin context hooked in message types might not have that context.
-        if (! empty($this->_valid_shortcodes['admin'])) {
-            if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][ $key ]);
-            }
-            // make sure admin context does not include the recipient_details shortcodes
-            if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][ $key ]);
-            }
-        }
-    }
-
-
-    /**
-     * Used by Validators to modify the valid shortcodes.
-     *
-     * @param  array $new_config array of valid shortcodes (by context)
-     * @return void               sets valid_shortcodes property
-     */
-    public function reset_valid_shortcodes_config($new_config)
-    {
-        foreach ($new_config as $context => $shortcodes) {
-            $this->_valid_shortcodes[ $context ] = $shortcodes;
-        }
-    }
-
-
-    /**
-     * returns an array of addressee objects for event_admins
-     *
-     * @access protected
-     * @return array array of EE_Messages_Addressee objects
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _admin_addressees()
-    {
-        $admin_events = array();
-        $addressees   = array();
-        // first we need to get the event admin user id for all the events
-        // and setup an addressee object for each unique admin user.
-        foreach ($this->_data->events as $line_ref => $event) {
-            $admin_id = $this->_get_event_admin_id($event['ID']);
-            // make sure we are just including the events that belong to this admin!
-            $admin_events[ $admin_id ][ $line_ref ] = $event;
-        }
-        // k now we can loop through the event_admins and setup the addressee data.
-        foreach ($admin_events as $admin_id => $event_details) {
-            $aee          = array(
-                'user_id'        => $admin_id,
-                'events'         => $event_details,
-                'attendees'      => $this->_data->attendees,
-                'recipient_id'   => $admin_id,
-                'recipient_type' => 'WP_User',
-            );
-            $aee          = array_merge($this->_default_addressee_data, $aee);
-            $addressees[] = new EE_Messages_Addressee($aee);
-        }
-        return $addressees;
-    }
-
-
-    /**
-     * Takes care of setting up the addressee object(s) for the primary attendee.
-     *
-     * @access protected
-     * @return array of EE_Addressee objects
-     * @throws EE_Error
-     */
-    protected function _primary_attendee_addressees()
-    {
-        $aee                   = $this->_default_addressee_data;
-        $aee['events']         = $this->_data->events;
-        $aee['attendees']      = $this->_data->attendees;
-        $aee['recipient_id']   = $aee['primary_att_obj'] instanceof EE_Attendee ? $aee['primary_att_obj']->ID() : 0;
-        $aee['recipient_type'] = 'Attendee';
-        // great now we can instantiate the $addressee object and return (as an array);
-        $add[] = new EE_Messages_Addressee($aee);
-        return $add;
-    }
-
-
-    /**
-     * Takes care of setting up the addressee object(s) for the registered attendees
-     *
-     * @access protected
-     * @return array of EE_Addressee objects
-     */
-    protected function _attendee_addressees()
-    {
-        $add = array();
-        // we just have to loop through the attendees.  We'll also set the attached events for each attendee.
-        // use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
-        $already_processed = array();
-        foreach ($this->_data->attendees as $att_id => $details) {
-            // set the attendee array to blank on each loop;
-            $aee = array();
-            if (
-                isset($this->_data->reg_obj)
-                && ($this->_data->reg_obj->attendee_ID() != $att_id)
-                && $this->_single_message
-            ) {
-                continue;
-            }
-            // is $this->_regs_for_sending present?
-            // If so, let's make sure we ONLY generate addressee for registrations in that array.
-            if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
-                $regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
-                if (empty($regs_allowed)) {
-                    continue;
-                }
-            }
-            if (
-                apply_filters(
-                    'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends',
-                    true,
-                    $this->_data,
-                    $this
-                )
-                && in_array($att_id, $already_processed, true)
-            ) {
-                continue;
-            }
-            $already_processed[] = $att_id;
-            foreach ($details as $item => $value) {
-                $aee[ $item ] = $value;
-                if ($item === 'line_ref') {
-                    foreach ($value as $event_id) {
-                        $aee['events'][ $event_id ] = $this->_data->events[ $event_id ];
-                    }
-                }
-                if ($item === 'attendee_email') {
-                    $aee['attendee_email'] = $value;
-                }
-                /*if ( $item == 'registration_id' ) {
+	/**
+	 * see abstract declaration in parent class for details, children message types can
+	 * override these valid shortcodes if desired (we include all for all contexts by default).
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$all_shortcodes = array(
+			'attendee_list',
+			'attendee',
+			'datetime_list',
+			'datetime',
+			'event_list',
+			'event_meta',
+			'event',
+			'organization',
+			'recipient_details',
+			'recipient_list',
+			'ticket_list',
+			'ticket',
+			'transaction',
+			'venue',
+			'primary_registration_details',
+			'primary_registration_list',
+			'event_author',
+			'email',
+			'messenger',
+		);
+		$contexts       = $this->get_contexts();
+		foreach ($contexts as $context => $details) {
+			$this->_valid_shortcodes[ $context ] = $all_shortcodes;
+			// make sure non admin context does not include the event_author shortcodes
+			if ($context != 'admin') {
+				if (($key = array_search('event_author', $this->_valid_shortcodes[ $context ])) !== false) {
+					unset($this->_valid_shortcodes[ $context ][ $key ]);
+				}
+			}
+		}
+		// make sure admin context does not include the recipient_details shortcodes
+		// IF we have admin context hooked in message types might not have that context.
+		if (! empty($this->_valid_shortcodes['admin'])) {
+			if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
+				unset($this->_valid_shortcodes['admin'][ $key ]);
+			}
+			// make sure admin context does not include the recipient_details shortcodes
+			if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
+				unset($this->_valid_shortcodes['admin'][ $key ]);
+			}
+		}
+	}
+
+
+	/**
+	 * Used by Validators to modify the valid shortcodes.
+	 *
+	 * @param  array $new_config array of valid shortcodes (by context)
+	 * @return void               sets valid_shortcodes property
+	 */
+	public function reset_valid_shortcodes_config($new_config)
+	{
+		foreach ($new_config as $context => $shortcodes) {
+			$this->_valid_shortcodes[ $context ] = $shortcodes;
+		}
+	}
+
+
+	/**
+	 * returns an array of addressee objects for event_admins
+	 *
+	 * @access protected
+	 * @return array array of EE_Messages_Addressee objects
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _admin_addressees()
+	{
+		$admin_events = array();
+		$addressees   = array();
+		// first we need to get the event admin user id for all the events
+		// and setup an addressee object for each unique admin user.
+		foreach ($this->_data->events as $line_ref => $event) {
+			$admin_id = $this->_get_event_admin_id($event['ID']);
+			// make sure we are just including the events that belong to this admin!
+			$admin_events[ $admin_id ][ $line_ref ] = $event;
+		}
+		// k now we can loop through the event_admins and setup the addressee data.
+		foreach ($admin_events as $admin_id => $event_details) {
+			$aee          = array(
+				'user_id'        => $admin_id,
+				'events'         => $event_details,
+				'attendees'      => $this->_data->attendees,
+				'recipient_id'   => $admin_id,
+				'recipient_type' => 'WP_User',
+			);
+			$aee          = array_merge($this->_default_addressee_data, $aee);
+			$addressees[] = new EE_Messages_Addressee($aee);
+		}
+		return $addressees;
+	}
+
+
+	/**
+	 * Takes care of setting up the addressee object(s) for the primary attendee.
+	 *
+	 * @access protected
+	 * @return array of EE_Addressee objects
+	 * @throws EE_Error
+	 */
+	protected function _primary_attendee_addressees()
+	{
+		$aee                   = $this->_default_addressee_data;
+		$aee['events']         = $this->_data->events;
+		$aee['attendees']      = $this->_data->attendees;
+		$aee['recipient_id']   = $aee['primary_att_obj'] instanceof EE_Attendee ? $aee['primary_att_obj']->ID() : 0;
+		$aee['recipient_type'] = 'Attendee';
+		// great now we can instantiate the $addressee object and return (as an array);
+		$add[] = new EE_Messages_Addressee($aee);
+		return $add;
+	}
+
+
+	/**
+	 * Takes care of setting up the addressee object(s) for the registered attendees
+	 *
+	 * @access protected
+	 * @return array of EE_Addressee objects
+	 */
+	protected function _attendee_addressees()
+	{
+		$add = array();
+		// we just have to loop through the attendees.  We'll also set the attached events for each attendee.
+		// use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
+		$already_processed = array();
+		foreach ($this->_data->attendees as $att_id => $details) {
+			// set the attendee array to blank on each loop;
+			$aee = array();
+			if (
+				isset($this->_data->reg_obj)
+				&& ($this->_data->reg_obj->attendee_ID() != $att_id)
+				&& $this->_single_message
+			) {
+				continue;
+			}
+			// is $this->_regs_for_sending present?
+			// If so, let's make sure we ONLY generate addressee for registrations in that array.
+			if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+				$regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
+				if (empty($regs_allowed)) {
+					continue;
+				}
+			}
+			if (
+				apply_filters(
+					'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends',
+					true,
+					$this->_data,
+					$this
+				)
+				&& in_array($att_id, $already_processed, true)
+			) {
+				continue;
+			}
+			$already_processed[] = $att_id;
+			foreach ($details as $item => $value) {
+				$aee[ $item ] = $value;
+				if ($item === 'line_ref') {
+					foreach ($value as $event_id) {
+						$aee['events'][ $event_id ] = $this->_data->events[ $event_id ];
+					}
+				}
+				if ($item === 'attendee_email') {
+					$aee['attendee_email'] = $value;
+				}
+				/*if ( $item == 'registration_id' ) {
                     $aee['attendee_registration_id'] = $value;
                 }/**/
-            }
-            // note the FIRST reg object in this array is the one
-            // we'll use for this attendee as the primary registration for this attendee.
-            $aee['reg_obj']        = reset($this->_data->attendees[ $att_id ]['reg_objs']);
-            $aee['attendees']      = $this->_data->attendees;
-            $aee['recipient_id']   = $att_id;
-            $aee['recipient_type'] = 'Attendee';
-            // merge in the primary attendee data
-            $aee   = array_merge($this->_default_addressee_data, $aee);
-            $add[] = new EE_Messages_Addressee($aee);
-        }
-        return $add;
-    }
-
-
-    /**
-     * @param $event_id
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_event_admin_id($event_id)
-    {
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        return $event instanceof EE_Event ? $event->wp_user() : 0;
-    }
+			}
+			// note the FIRST reg object in this array is the one
+			// we'll use for this attendee as the primary registration for this attendee.
+			$aee['reg_obj']        = reset($this->_data->attendees[ $att_id ]['reg_objs']);
+			$aee['attendees']      = $this->_data->attendees;
+			$aee['recipient_id']   = $att_id;
+			$aee['recipient_type'] = 'Attendee';
+			// merge in the primary attendee data
+			$aee   = array_merge($this->_default_addressee_data, $aee);
+			$add[] = new EE_Messages_Addressee($aee);
+		}
+		return $add;
+	}
+
+
+	/**
+	 * @param $event_id
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_event_admin_id($event_id)
+	{
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		return $event instanceof EE_Event ? $event->wp_user() : 0;
+	}
 }

core/libraries/messages/EE_Message_Type_Collection_Loader.lib.php

Spacing +4 added lines, -4 removed lines

@@ -65,12 +65,12 @@ 
     {
         // make sure autoloaders are set (fail-safe)
         EED_Messages::set_autoloaders();
-        $folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/message_type';
-        $folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
+        $folder = ! empty($folder) ? $folder : EE_LIBRARIES.'messages/message_type';
+        $folder .= $folder[strlen($folder) - 1] != '/' ? '/' : '';
         // get all the files in that folder that end in ".class.php
         $filepaths = apply_filters(
             'FHEE__EE_messages__get_installed__messagetype_files',
-            glob($folder . '*.class.php')
+            glob($folder.'*.class.php')
         );
         if (empty($filepaths)) {
             return;
@@ -86,7 +86,7 @@ 
                 continue;
             }
 
-            if (! class_exists($message_type_class_name)) {
+            if ( ! class_exists($message_type_class_name)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__('The "%1$s" message type class can\'t be loaded from %2$s. Likely there is a typo in the class name or the file name.', 'event_espresso'),

Indentation +101 added lines, -101 removed lines

@@ -13,105 +13,105 @@
  */
 class EE_Message_Type_Collection_Loader
 {
-    /**
-     * @type EE_Message_Type_Collection $_message_type_collection
-     */
-    protected $_message_type_collection = null;
-
-
-
-    /**
-     * EE_Message_Type_Collection_Loader constructor.
-     *
-     * @param EE_Message_Type_Collection $message_types
-     */
-    public function __construct(EE_Message_Type_Collection $message_types)
-    {
-        $this->set_message_type_collection($message_types);
-    }
-
-
-
-    /**
-     * @return EE_Message_Type_Collection
-     */
-    public function message_type_collection()
-    {
-        return $this->_message_type_collection;
-    }
-
-
-
-    /**
-     * @param mixed $message_types
-     */
-    public function set_message_type_collection(EE_Message_Type_Collection $message_types)
-    {
-        $this->_message_type_collection = $message_types;
-    }
-
-
-
-    /**
-     * load_message_types
-     * globs the supplied filepath and adds any found
-     *
-     * @param  string $folder
-     * @throws \EE_Error
-     */
-    public function load_message_types_from_folder($folder = '')
-    {
-        // make sure autoloaders are set (fail-safe)
-        EED_Messages::set_autoloaders();
-        $folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/message_type';
-        $folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
-        // get all the files in that folder that end in ".class.php
-        $filepaths = apply_filters(
-            'FHEE__EE_messages__get_installed__messagetype_files',
-            glob($folder . '*.class.php')
-        );
-        if (empty($filepaths)) {
-            return;
-        }
-        foreach ((array) $filepaths as $file_path) {
-            // extract filename from path
-            $file_path = basename($file_path);
-            // now remove any file extensions
-            $message_type_class_name = substr($file_path, 0, strpos($file_path, '.'));
-
-            // if this class name doesn't represent a message type class, then we just skip.
-            if (strpos(strtolower($message_type_class_name), 'message_type') === false) {
-                continue;
-            }
-
-            if (! class_exists($message_type_class_name)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('The "%1$s" message type class can\'t be loaded from %2$s. Likely there is a typo in the class name or the file name.', 'event_espresso'),
-                        $message_type_class_name,
-                        $file_path
-                    )
-                );
-            }
-
-            $this->_load_message_type(new $message_type_class_name());
-        }
-    }
-
-
-    /**
-     * Loads the given message type into the message type collection if it doesn't already exist.
-     * @param EE_message_type $message_type
-     * @return bool
-     */
-    protected function _load_message_type(EE_message_type $message_type)
-    {
-        if ($this->message_type_collection()->has_by_name($message_type->name)) {
-            return true;
-        }
-        return $this->message_type_collection()->add(
-            $message_type,
-            $message_type->name
-        );
-    }
+	/**
+	 * @type EE_Message_Type_Collection $_message_type_collection
+	 */
+	protected $_message_type_collection = null;
+
+
+
+	/**
+	 * EE_Message_Type_Collection_Loader constructor.
+	 *
+	 * @param EE_Message_Type_Collection $message_types
+	 */
+	public function __construct(EE_Message_Type_Collection $message_types)
+	{
+		$this->set_message_type_collection($message_types);
+	}
+
+
+
+	/**
+	 * @return EE_Message_Type_Collection
+	 */
+	public function message_type_collection()
+	{
+		return $this->_message_type_collection;
+	}
+
+
+
+	/**
+	 * @param mixed $message_types
+	 */
+	public function set_message_type_collection(EE_Message_Type_Collection $message_types)
+	{
+		$this->_message_type_collection = $message_types;
+	}
+
+
+
+	/**
+	 * load_message_types
+	 * globs the supplied filepath and adds any found
+	 *
+	 * @param  string $folder
+	 * @throws \EE_Error
+	 */
+	public function load_message_types_from_folder($folder = '')
+	{
+		// make sure autoloaders are set (fail-safe)
+		EED_Messages::set_autoloaders();
+		$folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/message_type';
+		$folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
+		// get all the files in that folder that end in ".class.php
+		$filepaths = apply_filters(
+			'FHEE__EE_messages__get_installed__messagetype_files',
+			glob($folder . '*.class.php')
+		);
+		if (empty($filepaths)) {
+			return;
+		}
+		foreach ((array) $filepaths as $file_path) {
+			// extract filename from path
+			$file_path = basename($file_path);
+			// now remove any file extensions
+			$message_type_class_name = substr($file_path, 0, strpos($file_path, '.'));
+
+			// if this class name doesn't represent a message type class, then we just skip.
+			if (strpos(strtolower($message_type_class_name), 'message_type') === false) {
+				continue;
+			}
+
+			if (! class_exists($message_type_class_name)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('The "%1$s" message type class can\'t be loaded from %2$s. Likely there is a typo in the class name or the file name.', 'event_espresso'),
+						$message_type_class_name,
+						$file_path
+					)
+				);
+			}
+
+			$this->_load_message_type(new $message_type_class_name());
+		}
+	}
+
+
+	/**
+	 * Loads the given message type into the message type collection if it doesn't already exist.
+	 * @param EE_message_type $message_type
+	 * @return bool
+	 */
+	protected function _load_message_type(EE_message_type $message_type)
+	{
+		if ($this->message_type_collection()->has_by_name($message_type->name)) {
+			return true;
+		}
+		return $this->message_type_collection()->add(
+			$message_type,
+			$message_type->name
+		);
+	}
 }

core/libraries/messages/EE_Messenger_Collection_Loader.lib.php

Spacing +4 added lines, -4 removed lines

@@ -66,12 +66,12 @@ 
     {
         // make sure autoloaders are set (fail-safe)
         EED_Messages::set_autoloaders();
-        $folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/messenger';
-        $folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
+        $folder = ! empty($folder) ? $folder : EE_LIBRARIES.'messages/messenger';
+        $folder .= $folder[strlen($folder) - 1] != '/' ? '/' : '';
         // get all the files in that folder that end in ".class.php
         $filepaths = apply_filters(
             'FHEE__EE_messages__get_installed__messenger_files',
-            glob($folder . '*.class.php')
+            glob($folder.'*.class.php')
         );
         if (empty($filepaths)) {
             return;
@@ -87,7 +87,7 @@ 
                 continue;
             }
 
-            if (! class_exists($messenger_class_name)) {
+            if ( ! class_exists($messenger_class_name)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__('The "%1$s" messenger class can\'t be loaded from %2$s.  Likely there is a typo in the class name or the file name.', 'event_espresso'),

Indentation +123 added lines, -123 removed lines

@@ -13,127 +13,127 @@
  */
 class EE_Messenger_Collection_Loader
 {
-    /**
-     * @type EE_Messenger_Collection $_messenger_collection
-     */
-    protected $_messenger_collection = null;
-
-
-
-    /**
-     * EE_Messenger_Collection_Loader constructor.
-     *
-     * @param EE_Messenger_Collection $messengers
-     */
-    public function __construct(EE_Messenger_Collection $messengers)
-    {
-        $this->set_messenger_collection($messengers);
-    }
-
-
-
-    /**
-     * @return EE_Messenger_Collection
-     */
-    public function messenger_collection()
-    {
-        return $this->_messenger_collection;
-    }
-
-
-
-    /**
-     * @param mixed $messengers
-     */
-    public function set_messenger_collection(EE_Messenger_Collection $messengers)
-    {
-        $this->_messenger_collection = $messengers;
-    }
-
-
-
-    /**
-     * load_messengers
-     * globs the supplied filepath and adds any found
-     *
-     * @param  string $folder
-     * @throws \EE_Error
-     */
-    public function load_messengers_from_folder($folder = '')
-    {
-        // make sure autoloaders are set (fail-safe)
-        EED_Messages::set_autoloaders();
-        $folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/messenger';
-        $folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
-        // get all the files in that folder that end in ".class.php
-        $filepaths = apply_filters(
-            'FHEE__EE_messages__get_installed__messenger_files',
-            glob($folder . '*.class.php')
-        );
-        if (empty($filepaths)) {
-            return;
-        }
-        foreach ((array) $filepaths as $file_path) {
-            // extract filename from path
-            $file_path = basename($file_path);
-            // now remove any file extensions
-            $messenger_class_name = substr($file_path, 0, strpos($file_path, '.'));
-
-            // first check to see if the class name represents an actual messenger class.
-            if (strpos(strtolower($messenger_class_name), 'messenger') === false) {
-                continue;
-            }
-
-            if (! class_exists($messenger_class_name)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('The "%1$s" messenger class can\'t be loaded from %2$s.  Likely there is a typo in the class name or the file name.', 'event_espresso'),
-                        $messenger_class_name,
-                        $file_path
-                    )
-                );
-            }
-
-            $this->_load_messenger(new $messenger_class_name());
-        }
-    }
-
-
-    /**
-     * load_messengers
-     * globs the supplied filepath and adds any found
-     *
-     * @return array
-     */
-    public function load_active_messengers_from_db()
-    {
-        // make sure autoloaders are set (fail-safe)
-        EED_Messages::set_autoloaders();
-        $active_messengers = apply_filters(
-            'FHEE__EEH_MSG_Template__get_active_messengers_in_db',
-            get_option('ee_active_messengers', array())
-        );
-        foreach ((array) $active_messengers as $active_messenger_classname => $active_messenger) {
-            $this->_load_messenger($active_messenger);
-        }
-    }
-
-
-
-    /**
-     * load_messenger
-     *
-     * @param \EE_messenger $messenger
-     * @return bool
-     */
-    protected function _load_messenger(EE_messenger $messenger)
-    {
-        if ($this->messenger_collection()->has_by_name($messenger->name)) {
-            return true;
-        }
-        return $this->messenger_collection()->add(
-            $messenger,
-            $messenger->name
-        );
-    }
+	/**
+	 * @type EE_Messenger_Collection $_messenger_collection
+	 */
+	protected $_messenger_collection = null;
+
+
+
+	/**
+	 * EE_Messenger_Collection_Loader constructor.
+	 *
+	 * @param EE_Messenger_Collection $messengers
+	 */
+	public function __construct(EE_Messenger_Collection $messengers)
+	{
+		$this->set_messenger_collection($messengers);
+	}
+
+
+
+	/**
+	 * @return EE_Messenger_Collection
+	 */
+	public function messenger_collection()
+	{
+		return $this->_messenger_collection;
+	}
+
+
+
+	/**
+	 * @param mixed $messengers
+	 */
+	public function set_messenger_collection(EE_Messenger_Collection $messengers)
+	{
+		$this->_messenger_collection = $messengers;
+	}
+
+
+
+	/**
+	 * load_messengers
+	 * globs the supplied filepath and adds any found
+	 *
+	 * @param  string $folder
+	 * @throws \EE_Error
+	 */
+	public function load_messengers_from_folder($folder = '')
+	{
+		// make sure autoloaders are set (fail-safe)
+		EED_Messages::set_autoloaders();
+		$folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/messenger';
+		$folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
+		// get all the files in that folder that end in ".class.php
+		$filepaths = apply_filters(
+			'FHEE__EE_messages__get_installed__messenger_files',
+			glob($folder . '*.class.php')
+		);
+		if (empty($filepaths)) {
+			return;
+		}
+		foreach ((array) $filepaths as $file_path) {
+			// extract filename from path
+			$file_path = basename($file_path);
+			// now remove any file extensions
+			$messenger_class_name = substr($file_path, 0, strpos($file_path, '.'));
+
+			// first check to see if the class name represents an actual messenger class.
+			if (strpos(strtolower($messenger_class_name), 'messenger') === false) {
+				continue;
+			}
+
+			if (! class_exists($messenger_class_name)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('The "%1$s" messenger class can\'t be loaded from %2$s.  Likely there is a typo in the class name or the file name.', 'event_espresso'),
+						$messenger_class_name,
+						$file_path
+					)
+				);
+			}
+
+			$this->_load_messenger(new $messenger_class_name());
+		}
+	}
+
+
+	/**
+	 * load_messengers
+	 * globs the supplied filepath and adds any found
+	 *
+	 * @return array
+	 */
+	public function load_active_messengers_from_db()
+	{
+		// make sure autoloaders are set (fail-safe)
+		EED_Messages::set_autoloaders();
+		$active_messengers = apply_filters(
+			'FHEE__EEH_MSG_Template__get_active_messengers_in_db',
+			get_option('ee_active_messengers', array())
+		);
+		foreach ((array) $active_messengers as $active_messenger_classname => $active_messenger) {
+			$this->_load_messenger($active_messenger);
+		}
+	}
+
+
+
+	/**
+	 * load_messenger
+	 *
+	 * @param \EE_messenger $messenger
+	 * @return bool
+	 */
+	protected function _load_messenger(EE_messenger $messenger)
+	{
+		if ($this->messenger_collection()->has_by_name($messenger->name)) {
+			return true;
+		}
+		return $this->messenger_collection()->add(
+			$messenger,
+			$messenger->name
+		);
+	}
 }

core/libraries/messages/defaults/default/html_receipt_ticket_line_item_pms.template.php

Spacing +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
 <tr class="item">
     <td>[LINE_ITEM_NAME][LINE_ITEM_TAXABLE_*]</td>
     <td colspan="2">[LINE_ITEM_DESCRIPTION]
-        <p class="ticket-note"><?php echo sprintf(esc_html__('This ticket can be used once at %s of the dates/times below.', 'event_espresso'), '[TKT_USES_* schema=' . esc_html__('any', 'event_espresso') . ']'); ?></p>
+        <p class="ticket-note"><?php echo sprintf(esc_html__('This ticket can be used once at %s of the dates/times below.', 'event_espresso'), '[TKT_USES_* schema='.esc_html__('any', 'event_espresso').']'); ?></p>
     </td>
     <td class="item_c">[LINE_ITEM_QUANTITY]</td>
     <td class="item_c">[LINE_ITEM_AMOUNT]</td>

core/libraries/messages/defaults/EE_Messages_Template_Pack.core.php

Spacing +35 added lines, -35 removed lines

@@ -166,20 +166,20 @@ 
         // make sure required props have been set
 
         // if label is empty then throw an error because we should have it defined by now.
-        if (! isset($this->label)) {
+        if ( ! isset($this->label)) {
             throw new EE_Error(sprintf(esc_html__('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
         }
 
 
         // the reference for this template pack
-        if (! isset($this->dbref)) {
+        if ( ! isset($this->dbref)) {
             throw new EE_Error(sprintf(esc_html__('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
         }
 
         // make sure dbref is safe
         $this->dbref = str_replace('-', '_', sanitize_key($this->dbref));
 
-        $should_be = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
+        $should_be = 'EE_Messages_Template_Pack_'.str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
 
         if ($should_be !== $classname) {
             throw new EE_Error(sprintf(esc_html__('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be));
@@ -236,7 +236,7 @@ 
      */
     public function get_templates(EE_messenger $messenger, EE_message_type $message_type)
     {
-        return isset($this->_templates[ $messenger->name ][ $message_type->name ]) ? $this->_templates[ $messenger->name ][ $message_type->name ] : $this->_get_templates($messenger, $message_type);
+        return isset($this->_templates[$messenger->name][$message_type->name]) ? $this->_templates[$messenger->name][$message_type->name] : $this->_get_templates($messenger, $message_type);
     }
 
 
@@ -286,18 +286,18 @@ 
                         foreach ($sub_fields as $sub_field => $sub_field_details) {
                             // make sure that the template_field_ref matches what the main template field is for this template group.
                             $template_field_ref = $sub_field == 'main' ? $main_field : $sub_field;
-                            $templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
+                            $templates[$context][$main_field][$sub_field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
                         }
                     }
                 } else {
-                    $templates[ $context ][ $field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
+                    $templates[$context][$field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
                 }
             }
         }
 
         $templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this);
 
-        $this->_templates[ $messenger->name ][ $message_type->name ] = $templates;
+        $this->_templates[$messenger->name][$message_type->name] = $templates;
          return $templates;
     }
 
@@ -323,13 +323,13 @@ 
         $filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this);
 
         $master_templates = $message_type->get_master_templates();
-        $master_templates_mt = isset($master_templates[ $messenger->name ]) ? $master_templates[ $messenger->name ] : $message_type->name;
-        $full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php';
-        $fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php';
-        $mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-        $mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
-        $base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-        $base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
+        $master_templates_mt = isset($master_templates[$messenger->name]) ? $master_templates[$messenger->name] : $message_type->name;
+        $full_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'_'.$context.'.template.php';
+        $fallback_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'.template.php';
+        $mt_defined_full_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php';
+        $mt_defined_fallback_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php';
+        $base_defined_full_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php';
+        $base_defined_fallback_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php';
 
         /**
          * Template checks are done hierarchically in the following order:
@@ -359,7 +359,7 @@ 
             $actual_path = '';
         }
         if (empty($actual_path)) {
-            $contents = isset($default_templates[ $context ][ $field ]) ? $default_templates[ $context ][ $field ] : '';
+            $contents = isset($default_templates[$context][$field]) ? $default_templates[$context][$field] : '';
         } else {
             $contents = EEH_Template::display_template($actual_path, array(), true);
         }
@@ -380,7 +380,7 @@ 
      */
     public function get_supports()
     {
-        $supports = apply_filters('FHEE__' . get_class($this) . '__get_supports', $this->_supports);
+        $supports = apply_filters('FHEE__'.get_class($this).'__get_supports', $this->_supports);
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this);
     }
 
@@ -399,7 +399,7 @@ 
     public function get_default_variation_labels($messenger = '')
     {
         $label = empty($messenger) ? $this->_default_variation_labels : array();
-        $label = empty($label) && ! empty($this->_default_variation_labels[ $messenger ]) ? $this->_default_variation_labels[ $messenger ] : esc_html__('Default', 'event_espresso');
+        $label = empty($label) && ! empty($this->_default_variation_labels[$messenger]) ? $this->_default_variation_labels[$messenger] : esc_html__('Default', 'event_espresso');
 
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
     }
@@ -419,24 +419,24 @@ 
      */
     public function get_variations($messenger = '', $message_type = '')
     {
-        $messenger_variations = ! empty($messenger) && isset($this->_variations[ $messenger ]) ? $this->_variations[ $messenger ] : array();
+        $messenger_variations = ! empty($messenger) && isset($this->_variations[$messenger]) ? $this->_variations[$messenger] : array();
 
         // message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
-        $variations = !empty($messenger) && !empty($message_type) && isset($messenger_variations[ $message_type ]) ? $messenger_variations[ $message_type ] : array();
+        $variations = ! empty($messenger) && ! empty($message_type) && isset($messenger_variations[$message_type]) ? $messenger_variations[$message_type] : array();
 
         // now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
-        $variations = empty($variations) && !empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
+        $variations = empty($variations) && ! empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
 
         // filter per template pack and globally.
-        $variations = apply_filters('FHEE__' . get_class($this) . '__get_variations', $variations, $messenger, $message_type);
+        $variations = apply_filters('FHEE__'.get_class($this).'__get_variations', $variations, $messenger, $message_type);
         $variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
 
         // prepend the _default_variation, but ONLY if we're returning the fully validated array.
-        if (!empty($messenger) && !empty($message_type) && ! empty($variations)) {
-            $variations = array( 'default' => $this->get_default_variation_labels($messenger) ) + $variations;
+        if ( ! empty($messenger) && ! empty($message_type) && ! empty($variations)) {
+            $variations = array('default' => $this->get_default_variation_labels($messenger)) + $variations;
         }
 
-        return empty($variations) ? array( 'default' => $this->get_default_variation_labels('dft') ) : $variations;
+        return empty($variations) ? array('default' => $this->get_default_variation_labels('dft')) : $variations;
     }
 
 
@@ -463,23 +463,23 @@ 
         $base = $url ? $this->_base_url : $this->_base_path;
         $base_path = $this->_base_path;
 
-        if (! $skip_filters) {
-            $base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
+        if ( ! $skip_filters) {
+            $base = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
             $base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
         }
 
         $default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
 
         // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
+        $path_string = 'variations/'.$messenger.'_'.$message_type.'_'.$type.'_'.$variation.$file_extension;
+        $default_path_string = 'variations/'.$messenger.'_'.$type.'_'.$variation.$file_extension;
 
         // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
+        if (is_readable($base_path.$path_string)) {
+            $variation_path = $base.$path_string;
         // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
+        } elseif (is_readable($base_path.$default_path_string)) {
+            $variation_path = $base.$default_path_string;
         } else {
             $variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
         }
@@ -489,7 +489,7 @@ 
         }
 
         // filter result
-        $variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
+        $variation_path = apply_filters('FHEE__'.get_class($this).'__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
     }
 
@@ -509,7 +509,7 @@ 
     {
         $default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
 
-        $path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
+        $path_string = $this->_base_path.$messenger.'_'.$type.'_wrapper.template.php';
 
         if (is_readable($path_string)) {
             $template = $path_string;
@@ -518,7 +518,7 @@ 
         }
 
         // filter
-        $template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
+        $template = apply_filters('FHEE__'.get_class($this).'__get_wrapper', $template, $messenger, $type);
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
     }
 }

Indentation +469 added lines, -469 removed lines

@@ -12,511 +12,511 @@
  */
 abstract class EE_Messages_Template_Pack
 {
-    /**
-     * This defines the base_path where the templates are located.
-     *
-     * @since            4.5.0
-     *
-     * @var string
-     */
-    protected $_base_path;
+	/**
+	 * This defines the base_path where the templates are located.
+	 *
+	 * @since            4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_base_path;
 
 
 
 
-    /**
-     * This defines the base_url where things are found for this template pack (possibly variations).
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_base_url;
+	/**
+	 * This defines the base_url where things are found for this template pack (possibly variations).
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_base_url;
 
 
 
-    /**
-     * localized label for this template pack
-     *
-     * @since            4.5.0
-     *
-     * @var string
-     */
-    public $label;
+	/**
+	 * localized label for this template pack
+	 *
+	 * @since            4.5.0
+	 *
+	 * @var string
+	 */
+	public $label;
 
 
 
 
-    /**
-     * used to contain a description for the template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    public $description;
+	/**
+	 * used to contain a description for the template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	public $description;
 
 
 
 
-    /**
-     * How this template is referenced in the db
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    public $dbref;
+	/**
+	 * How this template is referenced in the db
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	public $dbref;
 
 
 
 
-    /**
-     * This is an array indexed by messenger and with an array of message types as values that indicate what messenger and message type this template pack supports by default.  It is possible for this to be modified by plugins via filters, but out of the box, this is what the template pack supports.
-     *
-     * @since 4.5.0
-     *
-     * @var array.
-     */
-    protected $_supports = array();
+	/**
+	 * This is an array indexed by messenger and with an array of message types as values that indicate what messenger and message type this template pack supports by default.  It is possible for this to be modified by plugins via filters, but out of the box, this is what the template pack supports.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array.
+	 */
+	protected $_supports = array();
 
 
 
 
 
-    /**
-     * Holds the retrieved default templates for this template pack in a multidimensional array indexed by context and field, for a given messenger and message type.  Example format:
-     *
-     * $templates = array(
-     *  'email' => array(
-     *      'registration' => array(
-     *          'admin' => array(
-     *              'to' => 'contents',
-     *              'from' => 'contents',
-     *              'subject' => 'contents',
-     *              'content' => 'contents',
-     *              'event_list' => 'contents',
-     *              'attendee_list' => 'contents'
-     *          ),
-     *          'attendee' => array(
-     *              'to' => 'contents',
-     *              'from' => 'contents',
-     *              'subject' => 'contents',
-     *              'content' => 'contents',
-     *              'event_list' => 'contents',
-     *              'attendee_list' => 'contents',
-     *          ),
-     *      )
-     *  )
-     * )
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected $_templates = array();
+	/**
+	 * Holds the retrieved default templates for this template pack in a multidimensional array indexed by context and field, for a given messenger and message type.  Example format:
+	 *
+	 * $templates = array(
+	 *  'email' => array(
+	 *      'registration' => array(
+	 *          'admin' => array(
+	 *              'to' => 'contents',
+	 *              'from' => 'contents',
+	 *              'subject' => 'contents',
+	 *              'content' => 'contents',
+	 *              'event_list' => 'contents',
+	 *              'attendee_list' => 'contents'
+	 *          ),
+	 *          'attendee' => array(
+	 *              'to' => 'contents',
+	 *              'from' => 'contents',
+	 *              'subject' => 'contents',
+	 *              'content' => 'contents',
+	 *              'event_list' => 'contents',
+	 *              'attendee_list' => 'contents',
+	 *          ),
+	 *      )
+	 *  )
+	 * )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected $_templates = array();
 
 
 
 
 
 
-    /**
-     * Template Packs must ALWAYS have a default variation defined.  This property allow one to override the default variation labels per messenger.
-     * example:
-     * $this->_default_variation_labels = array( 'email' =>  esc_html__('Default', 'event_espresso' ) );
-     *
-     * @var array
-     */
-    protected $_default_variation_labels = array();
+	/**
+	 * Template Packs must ALWAYS have a default variation defined.  This property allow one to override the default variation labels per messenger.
+	 * example:
+	 * $this->_default_variation_labels = array( 'email' =>  esc_html__('Default', 'event_espresso' ) );
+	 *
+	 * @var array
+	 */
+	protected $_default_variation_labels = array();
 
 
 
 
-    /**
-     * This is an array of extra css variations for message templates indexed by messenger with the values as an array or message types the variations apply to as the key  and then values are an array with variation slugs as the key and label as the value. Note the default variation is not included in this array.  So the structure is:
-     * array(
-     *  'email' => array(
-     *  )
-     * )
-     *
-     * Keep in mind that this property is used both for indicating valid variations for a given message type and messenger but the variation files themselves are ONLY unique to the messenger.  So if you have a variation for the html messenger referenced by the slug "sunset_red" Then the variation file for the main type will be html_main_sunset_red.css.  All the array in this property allows you to do, is indicate that with certain message types the sunset_red variation is available but for other message types its not.  But you could NOT have a sunset_red variation file for one messenger/message_type and a different one for another messenger/message_type.  If you want different css looks then you can define a different structural layout for the template , messenger, message type combination and in the same sunset_red.css variation file just add css specific to that layout.
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    public $_variations = array();
-
-
-
-
-    /**
-     * Template pack constructor
-     *
-     * @since 4.5.0
-     */
-    public function __construct()
-    {
-        $this->_set_props();
-        // make sure classname is correct
-        $classname = get_class($this);
-        // make sure required props have been set
-
-        // if label is empty then throw an error because we should have it defined by now.
-        if (! isset($this->label)) {
-            throw new EE_Error(sprintf(esc_html__('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-
-
-        // the reference for this template pack
-        if (! isset($this->dbref)) {
-            throw new EE_Error(sprintf(esc_html__('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-
-        // make sure dbref is safe
-        $this->dbref = str_replace('-', '_', sanitize_key($this->dbref));
-
-        $should_be = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
-
-        if ($should_be !== $classname) {
-            throw new EE_Error(sprintf(esc_html__('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be));
-        }
-
-        // if _base_path is not set then throw an error because a base path string is needed.
-        if (empty($this->_base_path)) {
-            throw new EE_Error(sprintf(esc_html__('The _base_path property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-
-
-        // if _base_url is not set then throw an error because a  string is needed for variations.
-        if (empty($this->_base_url)) {
-            throw new EE_Error(sprintf(esc_html__('The _base_url property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-
-
-        // if $supports is not set then throw an error because that effectively means this template_pack does not have any templates!
-        if (empty($this->_supports)) {
-            throw new EE_Error(sprintf(esc_html__('The supports property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-    }
-
-
-
-    /**
-     * This method should be used to define the following properties:
-     * - label
-     * - dbref
-     * - description
-     * - _base_path
-     * - _base_url
-     * - supports
-     * - variations
-     *
-     * @since 4.5.0
-     * @return void.
-     * @abstract
-     */
-    abstract protected function _set_props();
-
-
-
-
-    /**
-     * Wrapper for get_templates() ( @see get_templates() for documentation)
-     *
-     * @since 4.5.0
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     *
-     * @return array
-     */
-    public function get_templates(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        return isset($this->_templates[ $messenger->name ][ $message_type->name ]) ? $this->_templates[ $messenger->name ][ $message_type->name ] : $this->_get_templates($messenger, $message_type);
-    }
-
-
-
-
-    /**
-     * This takes the incoming messenger and message type objects, uses them to get the set fields and contexts, then attempts to retrieve the templates matching those for this given template pack.
-     *
-     * @since 4.5.0
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     *
-     * @return array          Returns an multi-level associative array indexed by template context and field in the format:
-     *                                array( 'context' => array( 'field' => 'value', 'another-field', 'value' ) );
-     */
-    protected function _get_templates(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        $templates = array();
-
-        /**
-         * Retrieving the default pack for later usage of default templates for template packs that
-         * are NOT the default pack ( or an extension of the default pack ).
-         * We ONLY set this variable to be the default pack IF the loaded class is NOT the default
-         * pack.  This prevents recursion in _get_specific_template().  The intention is that for
-         * template packs that are NOT default packs, we use the default template pack to provide
-         * the final fallback templates if there aren't any defined for the called template pack.
-         *
-         * @type EE_Messages_Template_Pack_Default | null $default_pack
-         */
-        $default_pack = ! $this instanceof EE_Messages_Template_Pack_Default ? new EE_Messages_Template_Pack_Default() : null;
-
-        $fields = $messenger->get_template_fields();
-        $contexts = $message_type->get_contexts();
-
-
-        foreach ($contexts as $context => $details) {
-            foreach ($fields as $field => $field_details) {
-                if (empty($field_details)) {
-                    continue;
-                }
-                /**
-                 * is this a field array (linked to a main field)?
-                 */
-                if ($field == 'extra') {
-                    foreach ($field_details as $main_field => $sub_fields) {
-                        foreach ($sub_fields as $sub_field => $sub_field_details) {
-                            // make sure that the template_field_ref matches what the main template field is for this template group.
-                            $template_field_ref = $sub_field == 'main' ? $main_field : $sub_field;
-                            $templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
-                        }
-                    }
-                } else {
-                    $templates[ $context ][ $field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
-                }
-            }
-        }
-
-        $templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this);
-
-        $this->_templates[ $messenger->name ][ $message_type->name ] = $templates;
-         return $templates;
-    }
-
-
-    /**
-     * Utility method for retrieving a specific template matching the given parameters
-     *
-     * @param null | EE_Messages_Template_Pack_Default $default_pack
-     * @param EE_messenger                             $messenger
-     * @param EE_message_type                          $message_type
-     * @param string                                   $field          The field reference for the specific template being looked up.
-     * @param string                                   $context      The context reference for the specific template being looked up
-     *
-     * @return string          The template contents.
-     */
-    protected function _get_specific_template($default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context)
-    {
-
-        // default templates
-        $default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates($messenger, $message_type) : array();
-
-        // first we allow for the $_base_path to be filtered.  However, we assign this to a new variable so that we have the original base_path as a fallback.
-        $filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this);
-
-        $master_templates = $message_type->get_master_templates();
-        $master_templates_mt = isset($master_templates[ $messenger->name ]) ? $master_templates[ $messenger->name ] : $message_type->name;
-        $full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php';
-        $fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php';
-        $mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-        $mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
-        $base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-        $base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
-
-        /**
-         * Template checks are done hierarchically in the following order:
-         *
-         * - a match for the full messenger name, message type, context and field in the full path for the given template pack.
-         * - a match for the full messenger name, message type, field in the full path for the given template pack.
-         * - a match for the full messenger name, message type, field, context in the path grabbed for the related message type defined in the _master_templates property for the message type (i.e. all registration message types share the same template as the main registration message type).
-         * - match for the full messenger name, message type, field for the related message type defined in the _master templates property for the message type
-         * - a match for a default template matching the messenger, name, context, field (as set by the default template packs).
-         * - empty string.
-         */
-
-
-        if (is_readable($full_path)) {
-            $actual_path = $full_path;
-        } elseif (is_readable($fallback_path)) {
-            $actual_path = $fallback_path;
-        } elseif (is_readable($mt_defined_full_path)) {
-            $actual_path = $mt_defined_full_path;
-        } elseif (is_readable($mt_defined_fallback_path)) {
-            $actual_path = $mt_defined_fallback_path;
-        } elseif (is_readable($base_defined_full_path)) {
-            $actual_path = $base_defined_full_path;
-        } elseif (is_readable($base_defined_fallback_path)) {
-            $actual_path = $base_defined_fallback_path;
-        } else {
-            $actual_path = '';
-        }
-        if (empty($actual_path)) {
-            $contents = isset($default_templates[ $context ][ $field ]) ? $default_templates[ $context ][ $field ] : '';
-        } else {
-            $contents = EEH_Template::display_template($actual_path, array(), true);
-        }
-
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this);
-    }
-
-
-
-
-
-    /**
-     * Return filtered _supports property.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    public function get_supports()
-    {
-        $supports = apply_filters('FHEE__' . get_class($this) . '__get_supports', $this->_supports);
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this);
-    }
-
-
-
-
-    /**
-     * This simply returns the $_default_variation_labels property value.
-     *
-     * @since 4.5.0
-     *
-     * @param string $messenger if the messenger slug is returned then the default label for the specific messenger is retrieved.  If it doesn't exist then the esc_html__('Default', 'event_espresso') is returned.  If NO value is provided then whatever is set on the _default_variation_labels property is returned.
-     *
-     * @return array|string
-     */
-    public function get_default_variation_labels($messenger = '')
-    {
-        $label = empty($messenger) ? $this->_default_variation_labels : array();
-        $label = empty($label) && ! empty($this->_default_variation_labels[ $messenger ]) ? $this->_default_variation_labels[ $messenger ] : esc_html__('Default', 'event_espresso');
-
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
-    }
-
-
-
-
-
-    /**
-     * This simply returns the _variations property.
-     *
-     * @since 4.5.0
-     *
-     * @param string $messenger if included then css variations matching the messenger are returned.  Otherwise, just the default variation is included.  If both message type AND messenger are empty then all variations are returned.
-     * @param string $message_type if included then css variations matching the message_type are returned (must have $messenger set).  Otherwise the array of variations per message type are returned.  If message_type is provided but NOT the messenger, then just all variations for all messengers are returned.
-     * @return array
-     */
-    public function get_variations($messenger = '', $message_type = '')
-    {
-        $messenger_variations = ! empty($messenger) && isset($this->_variations[ $messenger ]) ? $this->_variations[ $messenger ] : array();
-
-        // message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
-        $variations = !empty($messenger) && !empty($message_type) && isset($messenger_variations[ $message_type ]) ? $messenger_variations[ $message_type ] : array();
-
-        // now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
-        $variations = empty($variations) && !empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
-
-        // filter per template pack and globally.
-        $variations = apply_filters('FHEE__' . get_class($this) . '__get_variations', $variations, $messenger, $message_type);
-        $variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
-
-        // prepend the _default_variation, but ONLY if we're returning the fully validated array.
-        if (!empty($messenger) && !empty($message_type) && ! empty($variations)) {
-            $variations = array( 'default' => $this->get_default_variation_labels($messenger) ) + $variations;
-        }
-
-        return empty($variations) ? array( 'default' => $this->get_default_variation_labels('dft') ) : $variations;
-    }
-
-
-
-
-    /**
-     * This is typically called by EE_messenger objects to get the specific css variation defined for the messenger, message_type and type (i.e. inline, wpeditor, preview etc.)
-     *
-     * @since 4.5.0
-     *
-     * @param string $messenger messenger slug
-     * @param string $message_type message_type slug
-     * @param string $type           variation type (i.e. inline, base, wpeditor, preview etc. //this varies per messenger).
-     * @param string $variation    this should match one of the defined variations in the _variations property on this class.
-     * @param string $file_extension  What type of file the variation file is (defaults to css)
-     * @param bool   $url          if true then return the url otherwise path.
-     * @param bool   $skip_filters This should not be set directly, its used internally to skip filters when the default template pack is called internally as the fallback.
-     *
-     * @return string The variation path or url (typically css reference)
-     */
-    public function get_variation($messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = false)
-    {
+	/**
+	 * This is an array of extra css variations for message templates indexed by messenger with the values as an array or message types the variations apply to as the key  and then values are an array with variation slugs as the key and label as the value. Note the default variation is not included in this array.  So the structure is:
+	 * array(
+	 *  'email' => array(
+	 *  )
+	 * )
+	 *
+	 * Keep in mind that this property is used both for indicating valid variations for a given message type and messenger but the variation files themselves are ONLY unique to the messenger.  So if you have a variation for the html messenger referenced by the slug "sunset_red" Then the variation file for the main type will be html_main_sunset_red.css.  All the array in this property allows you to do, is indicate that with certain message types the sunset_red variation is available but for other message types its not.  But you could NOT have a sunset_red variation file for one messenger/message_type and a different one for another messenger/message_type.  If you want different css looks then you can define a different structural layout for the template , messenger, message type combination and in the same sunset_red.css variation file just add css specific to that layout.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	public $_variations = array();
+
+
+
+
+	/**
+	 * Template pack constructor
+	 *
+	 * @since 4.5.0
+	 */
+	public function __construct()
+	{
+		$this->_set_props();
+		// make sure classname is correct
+		$classname = get_class($this);
+		// make sure required props have been set
+
+		// if label is empty then throw an error because we should have it defined by now.
+		if (! isset($this->label)) {
+			throw new EE_Error(sprintf(esc_html__('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+
+
+		// the reference for this template pack
+		if (! isset($this->dbref)) {
+			throw new EE_Error(sprintf(esc_html__('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+
+		// make sure dbref is safe
+		$this->dbref = str_replace('-', '_', sanitize_key($this->dbref));
+
+		$should_be = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
+
+		if ($should_be !== $classname) {
+			throw new EE_Error(sprintf(esc_html__('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be));
+		}
+
+		// if _base_path is not set then throw an error because a base path string is needed.
+		if (empty($this->_base_path)) {
+			throw new EE_Error(sprintf(esc_html__('The _base_path property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+
+
+		// if _base_url is not set then throw an error because a  string is needed for variations.
+		if (empty($this->_base_url)) {
+			throw new EE_Error(sprintf(esc_html__('The _base_url property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+
+
+		// if $supports is not set then throw an error because that effectively means this template_pack does not have any templates!
+		if (empty($this->_supports)) {
+			throw new EE_Error(sprintf(esc_html__('The supports property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+	}
+
+
+
+	/**
+	 * This method should be used to define the following properties:
+	 * - label
+	 * - dbref
+	 * - description
+	 * - _base_path
+	 * - _base_url
+	 * - supports
+	 * - variations
+	 *
+	 * @since 4.5.0
+	 * @return void.
+	 * @abstract
+	 */
+	abstract protected function _set_props();
+
+
+
+
+	/**
+	 * Wrapper for get_templates() ( @see get_templates() for documentation)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 *
+	 * @return array
+	 */
+	public function get_templates(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		return isset($this->_templates[ $messenger->name ][ $message_type->name ]) ? $this->_templates[ $messenger->name ][ $message_type->name ] : $this->_get_templates($messenger, $message_type);
+	}
+
+
+
+
+	/**
+	 * This takes the incoming messenger and message type objects, uses them to get the set fields and contexts, then attempts to retrieve the templates matching those for this given template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 *
+	 * @return array          Returns an multi-level associative array indexed by template context and field in the format:
+	 *                                array( 'context' => array( 'field' => 'value', 'another-field', 'value' ) );
+	 */
+	protected function _get_templates(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		$templates = array();
+
+		/**
+		 * Retrieving the default pack for later usage of default templates for template packs that
+		 * are NOT the default pack ( or an extension of the default pack ).
+		 * We ONLY set this variable to be the default pack IF the loaded class is NOT the default
+		 * pack.  This prevents recursion in _get_specific_template().  The intention is that for
+		 * template packs that are NOT default packs, we use the default template pack to provide
+		 * the final fallback templates if there aren't any defined for the called template pack.
+		 *
+		 * @type EE_Messages_Template_Pack_Default | null $default_pack
+		 */
+		$default_pack = ! $this instanceof EE_Messages_Template_Pack_Default ? new EE_Messages_Template_Pack_Default() : null;
+
+		$fields = $messenger->get_template_fields();
+		$contexts = $message_type->get_contexts();
+
+
+		foreach ($contexts as $context => $details) {
+			foreach ($fields as $field => $field_details) {
+				if (empty($field_details)) {
+					continue;
+				}
+				/**
+				 * is this a field array (linked to a main field)?
+				 */
+				if ($field == 'extra') {
+					foreach ($field_details as $main_field => $sub_fields) {
+						foreach ($sub_fields as $sub_field => $sub_field_details) {
+							// make sure that the template_field_ref matches what the main template field is for this template group.
+							$template_field_ref = $sub_field == 'main' ? $main_field : $sub_field;
+							$templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
+						}
+					}
+				} else {
+					$templates[ $context ][ $field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
+				}
+			}
+		}
+
+		$templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this);
+
+		$this->_templates[ $messenger->name ][ $message_type->name ] = $templates;
+		 return $templates;
+	}
+
+
+	/**
+	 * Utility method for retrieving a specific template matching the given parameters
+	 *
+	 * @param null | EE_Messages_Template_Pack_Default $default_pack
+	 * @param EE_messenger                             $messenger
+	 * @param EE_message_type                          $message_type
+	 * @param string                                   $field          The field reference for the specific template being looked up.
+	 * @param string                                   $context      The context reference for the specific template being looked up
+	 *
+	 * @return string          The template contents.
+	 */
+	protected function _get_specific_template($default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context)
+	{
+
+		// default templates
+		$default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates($messenger, $message_type) : array();
+
+		// first we allow for the $_base_path to be filtered.  However, we assign this to a new variable so that we have the original base_path as a fallback.
+		$filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this);
+
+		$master_templates = $message_type->get_master_templates();
+		$master_templates_mt = isset($master_templates[ $messenger->name ]) ? $master_templates[ $messenger->name ] : $message_type->name;
+		$full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php';
+		$fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php';
+		$mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
+		$mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
+		$base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
+		$base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
+
+		/**
+		 * Template checks are done hierarchically in the following order:
+		 *
+		 * - a match for the full messenger name, message type, context and field in the full path for the given template pack.
+		 * - a match for the full messenger name, message type, field in the full path for the given template pack.
+		 * - a match for the full messenger name, message type, field, context in the path grabbed for the related message type defined in the _master_templates property for the message type (i.e. all registration message types share the same template as the main registration message type).
+		 * - match for the full messenger name, message type, field for the related message type defined in the _master templates property for the message type
+		 * - a match for a default template matching the messenger, name, context, field (as set by the default template packs).
+		 * - empty string.
+		 */
+
+
+		if (is_readable($full_path)) {
+			$actual_path = $full_path;
+		} elseif (is_readable($fallback_path)) {
+			$actual_path = $fallback_path;
+		} elseif (is_readable($mt_defined_full_path)) {
+			$actual_path = $mt_defined_full_path;
+		} elseif (is_readable($mt_defined_fallback_path)) {
+			$actual_path = $mt_defined_fallback_path;
+		} elseif (is_readable($base_defined_full_path)) {
+			$actual_path = $base_defined_full_path;
+		} elseif (is_readable($base_defined_fallback_path)) {
+			$actual_path = $base_defined_fallback_path;
+		} else {
+			$actual_path = '';
+		}
+		if (empty($actual_path)) {
+			$contents = isset($default_templates[ $context ][ $field ]) ? $default_templates[ $context ][ $field ] : '';
+		} else {
+			$contents = EEH_Template::display_template($actual_path, array(), true);
+		}
+
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this);
+	}
+
+
+
+
+
+	/**
+	 * Return filtered _supports property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	public function get_supports()
+	{
+		$supports = apply_filters('FHEE__' . get_class($this) . '__get_supports', $this->_supports);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this);
+	}
+
+
+
+
+	/**
+	 * This simply returns the $_default_variation_labels property value.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $messenger if the messenger slug is returned then the default label for the specific messenger is retrieved.  If it doesn't exist then the esc_html__('Default', 'event_espresso') is returned.  If NO value is provided then whatever is set on the _default_variation_labels property is returned.
+	 *
+	 * @return array|string
+	 */
+	public function get_default_variation_labels($messenger = '')
+	{
+		$label = empty($messenger) ? $this->_default_variation_labels : array();
+		$label = empty($label) && ! empty($this->_default_variation_labels[ $messenger ]) ? $this->_default_variation_labels[ $messenger ] : esc_html__('Default', 'event_espresso');
+
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
+	}
+
+
+
+
+
+	/**
+	 * This simply returns the _variations property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $messenger if included then css variations matching the messenger are returned.  Otherwise, just the default variation is included.  If both message type AND messenger are empty then all variations are returned.
+	 * @param string $message_type if included then css variations matching the message_type are returned (must have $messenger set).  Otherwise the array of variations per message type are returned.  If message_type is provided but NOT the messenger, then just all variations for all messengers are returned.
+	 * @return array
+	 */
+	public function get_variations($messenger = '', $message_type = '')
+	{
+		$messenger_variations = ! empty($messenger) && isset($this->_variations[ $messenger ]) ? $this->_variations[ $messenger ] : array();
+
+		// message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
+		$variations = !empty($messenger) && !empty($message_type) && isset($messenger_variations[ $message_type ]) ? $messenger_variations[ $message_type ] : array();
+
+		// now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
+		$variations = empty($variations) && !empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
+
+		// filter per template pack and globally.
+		$variations = apply_filters('FHEE__' . get_class($this) . '__get_variations', $variations, $messenger, $message_type);
+		$variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
+
+		// prepend the _default_variation, but ONLY if we're returning the fully validated array.
+		if (!empty($messenger) && !empty($message_type) && ! empty($variations)) {
+			$variations = array( 'default' => $this->get_default_variation_labels($messenger) ) + $variations;
+		}
+
+		return empty($variations) ? array( 'default' => $this->get_default_variation_labels('dft') ) : $variations;
+	}
+
+
+
+
+	/**
+	 * This is typically called by EE_messenger objects to get the specific css variation defined for the messenger, message_type and type (i.e. inline, wpeditor, preview etc.)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $messenger messenger slug
+	 * @param string $message_type message_type slug
+	 * @param string $type           variation type (i.e. inline, base, wpeditor, preview etc. //this varies per messenger).
+	 * @param string $variation    this should match one of the defined variations in the _variations property on this class.
+	 * @param string $file_extension  What type of file the variation file is (defaults to css)
+	 * @param bool   $url          if true then return the url otherwise path.
+	 * @param bool   $skip_filters This should not be set directly, its used internally to skip filters when the default template pack is called internally as the fallback.
+	 *
+	 * @return string The variation path or url (typically css reference)
+	 */
+	public function get_variation($messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = false)
+	{
 
-        $base = $url ? $this->_base_url : $this->_base_path;
-        $base_path = $this->_base_path;
+		$base = $url ? $this->_base_url : $this->_base_path;
+		$base_path = $this->_base_path;
 
-        if (! $skip_filters) {
-            $base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
-            $base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
-        }
+		if (! $skip_filters) {
+			$base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
+			$base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
+		}
 
-        $default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
-
-        // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
-
-        // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
-        // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
-        } else {
-            $variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
-        }
+		$default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
+
+		// possible variation paths considering whether message type is present or not in the file name.
+		$path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
+		$default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
+
+		// first see if fully validated file exists.
+		if (is_readable($base_path . $path_string)) {
+			$variation_path = $base . $path_string;
+		// otherwise see if default exists.
+		} elseif (is_readable($base_path . $default_path_string)) {
+			$variation_path = $base . $default_path_string;
+		} else {
+			$variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
+		}
 
-        if ($skip_filters) {
-            return $variation_path;
-        }
-
-        // filter result
-        $variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
-    }
-
-
-
-
-
-    /**
-     * This method is used to return the wrapper template for the given template pack.  If the given template pack does not include any wrapper templates then the default is used.
-     *
-     * @param string $messenger What messenger the wrapper is for.
-     * @param string $type           What type of wrapper is being returned ( for messengers that may have more than one wrapper )
-     *
-     * @return string returns the path for the requested wrapper template.
-     */
-    public function get_wrapper($messenger, $type = 'main')
-    {
-        $default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
-
-        $path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
-
-        if (is_readable($path_string)) {
-            $template = $path_string;
-        } else {
-            $template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : '';
-        }
-
-        // filter
-        $template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
-    }
+		if ($skip_filters) {
+			return $variation_path;
+		}
+
+		// filter result
+		$variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
+	}
+
+
+
+
+
+	/**
+	 * This method is used to return the wrapper template for the given template pack.  If the given template pack does not include any wrapper templates then the default is used.
+	 *
+	 * @param string $messenger What messenger the wrapper is for.
+	 * @param string $type           What type of wrapper is being returned ( for messengers that may have more than one wrapper )
+	 *
+	 * @return string returns the path for the requested wrapper template.
+	 */
+	public function get_wrapper($messenger, $type = 'main')
+	{
+		$default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
+
+		$path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
+
+		if (is_readable($path_string)) {
+			$template = $path_string;
+		} else {
+			$template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : '';
+		}
+
+		// filter
+		$template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
+	}
 }