eventespresso / event-espresso-core

caffeinated/EE_Caf_Messages.class.php

Indentation +714 added lines, -714 removed lines

@@ -7,7 +7,7 @@ 
  * @since           4.3.2
  */
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -22,735 +22,735 @@ 
 {
     
     
-    /**
-     * constructor.
-     */
-    public function __construct()
-    {
-        $this->_caf_hooks();
-    }
-    
-    
-    /**
-     * Contains all the hooks filters for setting up caffeinated messages functionality.
-     *
-     * @since 4.3.2
-     *
-     * @return void
-     */
-    private function _caf_hooks()
-    {
-        add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
-        add_filter('FHEE__EE_Email_messenger__get_validator_config', array($this, 'email_messenger_validator_config'),
-            5, 2);
-        add_filter('FHEE__EE_Email_messenger__get_template_fields', array($this, 'email_messenger_template_fields'), 5,
-            2);
-        add_filter('FHEE__EE_Html_messenger__get_template_fields', array($this, 'html_messenger_template_fields'), 5,
-            2);
-        add_filter('FHEE__EE_Html_messenger__get_validator_config', array($this, 'html_messenger_validator_config'), 5,
-            2);
-        add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
-        add_filter('FHEE__EE_Pdf_messenger__get_validator_config', array($this, 'pdf_messenger_validator_config'), 5,
-            2);
-        add_filter('FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
-            array($this, 'new_default_templates'), 5, 7);
-        add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', array($this, 'message_types_valid_shortcodes'), 5,
-            2);
-        
-        //shortcode parsers
-        add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
-        add_filter('FHEE__EE_Recipient_List_Shortcodes__shortcodes',
-            array($this, 'additional_recipient_details_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Recipient_List_Shortcodes__parser_after',
-            array($this, 'additional_recipient_details_parser'), 5, 5);
-        add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
-            array($this, 'additional_primary_registration_details_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
-            array($this, 'additional_primary_registration_details_parser'), 5, 5);
-        
-        /**
-         * @since 4.2.0
-         */
-        add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
-        add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
-        
-        /**
-         * @since 4.3.0
-         */
-        //eat our own dog food!
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
-        do_action('EE_Brewing_Regular___messages_caf');
-    }
-    
-    
-    /**
-     * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
-     * messages system.
-     *
-     * @param  array $dir_ref original array of paths
-     *
-     * @return array           appended paths
-     */
-    public function messages_autoload_paths($dir_ref)
-    {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
-        
-        return $dir_ref;
-    }
-    
-    
-    public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function new_default_templates(
-        $contents,
-        $actual_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $field,
-        $context,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        
-        //we're only modifying templates for the default template pack
-        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $contents;
-        }
-        
-        //the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
-        
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
-        
-        if ($messenger->name == 'email' && $message_type->name == 'registration') {
+	/**
+	 * constructor.
+	 */
+	public function __construct()
+	{
+		$this->_caf_hooks();
+	}
+    
+    
+	/**
+	 * Contains all the hooks filters for setting up caffeinated messages functionality.
+	 *
+	 * @since 4.3.2
+	 *
+	 * @return void
+	 */
+	private function _caf_hooks()
+	{
+		add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
+		add_filter('FHEE__EE_Email_messenger__get_validator_config', array($this, 'email_messenger_validator_config'),
+			5, 2);
+		add_filter('FHEE__EE_Email_messenger__get_template_fields', array($this, 'email_messenger_template_fields'), 5,
+			2);
+		add_filter('FHEE__EE_Html_messenger__get_template_fields', array($this, 'html_messenger_template_fields'), 5,
+			2);
+		add_filter('FHEE__EE_Html_messenger__get_validator_config', array($this, 'html_messenger_validator_config'), 5,
+			2);
+		add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
+		add_filter('FHEE__EE_Pdf_messenger__get_validator_config', array($this, 'pdf_messenger_validator_config'), 5,
+			2);
+		add_filter('FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
+			array($this, 'new_default_templates'), 5, 7);
+		add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', array($this, 'message_types_valid_shortcodes'), 5,
+			2);
+        
+		//shortcode parsers
+		add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
+		add_filter('FHEE__EE_Recipient_List_Shortcodes__shortcodes',
+			array($this, 'additional_recipient_details_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Recipient_List_Shortcodes__parser_after',
+			array($this, 'additional_recipient_details_parser'), 5, 5);
+		add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
+			array($this, 'additional_primary_registration_details_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
+			array($this, 'additional_primary_registration_details_parser'), 5, 5);
+        
+		/**
+		 * @since 4.2.0
+		 */
+		add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
+		add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
+        
+		/**
+		 * @since 4.3.0
+		 */
+		//eat our own dog food!
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
+		do_action('EE_Brewing_Regular___messages_caf');
+	}
+    
+    
+	/**
+	 * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
+	 * messages system.
+	 *
+	 * @param  array $dir_ref original array of paths
+	 *
+	 * @return array           appended paths
+	 */
+	public function messages_autoload_paths($dir_ref)
+	{
+		$dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        
+		return $dir_ref;
+	}
+    
+    
+	public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function new_default_templates(
+		$contents,
+		$actual_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$field,
+		$context,
+		EE_Messages_Template_Pack $template_pack
+	) {
+        
+		//we're only modifying templates for the default template pack
+		if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $contents;
+		}
+        
+		//the template file name we're replacing contents for.
+		$template_file_prefix = $field . '_' . $context;
+		$msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
+        
+		$base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        
+		if ($messenger->name == 'email' && $message_type->name == 'registration') {
             
-            switch ($template_file_prefix) {
+			switch ($template_file_prefix) {
                 
-                case 'question_list_admin' :
-                case 'question_list_attendee' :
-                case 'question_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'question_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'question_list_admin' :
+				case 'question_list_attendee' :
+				case 'question_list_primary_attendee' :
+					$path     = $base_path . $msg_prefix . 'question_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'attendee_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'attendee_list_primary_attendee' :
+					$path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'attendee_list_admin' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
-                    $contents = EEH_Template::display_template($path,
-                        array(), true);
-                    break;
+				case 'attendee_list_admin' :
+					$path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+					$contents = EEH_Template::display_template($path,
+						array(), true);
+					break;
                 
-                case 'attendee_list_attendee' :
-                    $contents = '';
-                    break;
+				case 'attendee_list_attendee' :
+					$contents = '';
+					break;
                 
-                case 'event_list_attendee' :
-                    $path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
-            switch ($template_file_prefix) {
+				case 'event_list_attendee' :
+					$path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
+			switch ($template_file_prefix) {
                 
-                case 'content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'content_attendee' :
+					$path     = $base_path . $msg_prefix . 'content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'newsletter_content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'newsletter_content_attendee' :
+					$path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'newsletter_subject_attendee' :
-                    $path     = $base_path . $msg_prefix . 'subject.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
-            switch ($template_file_prefix) {
-                case 'attendee_list_purchaser' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        }
-        
-        return $contents;
-        
-    }
-    
-    
-    public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
-    {
-        //make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
-        $include_with = array(
-            'registration',
-            'cancelled_registration',
-            'declined_registration',
-            'not_approved_registration',
-            'payment_declined',
-            'payment_failed',
-            'payment_cancelled',
-            'payment',
-            'payment_reminder',
-            'pending_approval',
-            'registration_summary',
-            'invoice',
-            'receipt'
-        );
-        if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
-            $contexts = array_keys($msg->get_contexts());
-            foreach ($contexts as $context) {
-                $valid_shortcodes[$context][] = 'question_list';
-                $valid_shortcodes[$context][] = 'question';
-            }
-        }
-        
-        return $valid_shortcodes;
-    }
-    
-    
-    public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[ANSWER_*]'] = __('This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if (strpos($shortcode,
-                '[ANSWER_*') === false || ! isset($extra_data['data']->questions) || ! isset($extra_data['data']->registrations)
-        ) {
-            return $parsed;
-        }
-        
-        //let's get the question from the code.
-        $shortcode = str_replace('[ANSWER_*', '', $shortcode);
-        $shortcode = trim(str_replace(']', '', $shortcode));
-        
-        $registration = $data instanceof EE_Registration ? $data : null;
-        $registration = ! $registration instanceof EE_Registration && is_array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
-        
-        $aee = $data instanceof EE_Messages_Addressee ? $data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee && is_array($extra_data) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
-        
-        if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        //now let's figure out which question has this text.
-        foreach ($aee->questions as $ansid => $question) {
-            if (
-                $question instanceof EE_Question
-                && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
-            ) {
-                return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty('ANS_value',
-                    'no_wpautop');
-            }
-        }
-        
-        //nothing!
-        return $parsed;
-    }
-    
-    
-    /**
-     * Callback for additional shortcodes filter for adding additional datetime shortcodes.
-     *
-     * @since  4.2
-     *
-     * @param  array                  $shortcodes         array of shortcodes and
-     *                                                    descriptions
-     * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
-     *
-     * @return array                                        array of shortcodes and
-     *                                                        descriptions
-     */
-    public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[DTT_NAME]']          = __('This will be parsed to the Title given for a Datetime',
-            'event_espresso');
-        $shortcodes['[DTT_DESCRIPTION]']   = __('This will be parsed to the description for a Datetime',
-            'event_espresso');
-        $shortcodes['[DTT_NAME_OR_DATES]'] = __('When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for additional shortcodes parser filter used for adding parser for new
-     * Datetime shortcodes
-     *
-     * @since  4.2
-     *
-     * @param  string                 $parsed     The finished parsed string for the given shortcode.
-     * @param  string                 $shortcode  The shortcode being parsed.
-     * @param  object                 $data       The incoming data object for the Shortcode Parser.
-     * @param  object                 $extra_data The incoming extra date object for the Shortcode
-     *                                            Parser.
-     * @param  EE_Datetime_Shortcodes $shortcode_parser
-     *
-     * @return string                   The new parsed string.
-     */
-    public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if ( ! $data instanceof EE_Datetime) {
-            return ''; //get out because we can only parse with the datetime object.
-        }
-        
-        switch ($shortcode) {
-            case '[DTT_NAME]' :
-                return $data->name();
-                break;
-            case '[DTT_DESCRIPTION]' :
-                return $data->description();
-                break;
-            case '[DTT_NAME_OR_DATES]' :
-                return $data->get_dtt_display_name(true);
-                break;
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __('This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-        
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-        
-        if ( ! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        switch ($shortcode) {
-            case '[RECIPIENT_QUESTION_LIST]' :
-                $att                       = $recipient->att_obj;
-                $registrations_on_attendee = $att instanceof EE_Attendee ? $recipient->attendees[$att->ID()]['reg_objs'] : array();
-                $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
-                $answers                   = array();
+				case 'newsletter_subject_attendee' :
+					$path     = $base_path . $msg_prefix . 'subject.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
+			switch ($template_file_prefix) {
+				case 'attendee_list_purchaser' :
+					$path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		}
+        
+		return $contents;
+        
+	}
+    
+    
+	public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
+	{
+		//make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
+		$include_with = array(
+			'registration',
+			'cancelled_registration',
+			'declined_registration',
+			'not_approved_registration',
+			'payment_declined',
+			'payment_failed',
+			'payment_cancelled',
+			'payment',
+			'payment_reminder',
+			'pending_approval',
+			'registration_summary',
+			'invoice',
+			'receipt'
+		);
+		if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
+			$contexts = array_keys($msg->get_contexts());
+			foreach ($contexts as $context) {
+				$valid_shortcodes[$context][] = 'question_list';
+				$valid_shortcodes[$context][] = 'question';
+			}
+		}
+        
+		return $valid_shortcodes;
+	}
+    
+    
+	public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[ANSWER_*]'] = __('This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if (strpos($shortcode,
+				'[ANSWER_*') === false || ! isset($extra_data['data']->questions) || ! isset($extra_data['data']->registrations)
+		) {
+			return $parsed;
+		}
+        
+		//let's get the question from the code.
+		$shortcode = str_replace('[ANSWER_*', '', $shortcode);
+		$shortcode = trim(str_replace(']', '', $shortcode));
+        
+		$registration = $data instanceof EE_Registration ? $data : null;
+		$registration = ! $registration instanceof EE_Registration && is_array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
+        
+		$aee = $data instanceof EE_Messages_Addressee ? $data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee && is_array($extra_data) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
+        
+		if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		//now let's figure out which question has this text.
+		foreach ($aee->questions as $ansid => $question) {
+			if (
+				$question instanceof EE_Question
+				&& trim($question->display_text()) == trim($shortcode)
+				&& isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
+			) {
+				return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty('ANS_value',
+					'no_wpautop');
+			}
+		}
+        
+		//nothing!
+		return $parsed;
+	}
+    
+    
+	/**
+	 * Callback for additional shortcodes filter for adding additional datetime shortcodes.
+	 *
+	 * @since  4.2
+	 *
+	 * @param  array                  $shortcodes         array of shortcodes and
+	 *                                                    descriptions
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
+	 *
+	 * @return array                                        array of shortcodes and
+	 *                                                        descriptions
+	 */
+	public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[DTT_NAME]']          = __('This will be parsed to the Title given for a Datetime',
+			'event_espresso');
+		$shortcodes['[DTT_DESCRIPTION]']   = __('This will be parsed to the description for a Datetime',
+			'event_espresso');
+		$shortcodes['[DTT_NAME_OR_DATES]'] = __('When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for additional shortcodes parser filter used for adding parser for new
+	 * Datetime shortcodes
+	 *
+	 * @since  4.2
+	 *
+	 * @param  string                 $parsed     The finished parsed string for the given shortcode.
+	 * @param  string                 $shortcode  The shortcode being parsed.
+	 * @param  object                 $data       The incoming data object for the Shortcode Parser.
+	 * @param  object                 $extra_data The incoming extra date object for the Shortcode
+	 *                                            Parser.
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser
+	 *
+	 * @return string                   The new parsed string.
+	 */
+	public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if ( ! $data instanceof EE_Datetime) {
+			return ''; //get out because we can only parse with the datetime object.
+		}
+        
+		switch ($shortcode) {
+			case '[DTT_NAME]' :
+				return $data->name();
+				break;
+			case '[DTT_DESCRIPTION]' :
+				return $data->description();
+				break;
+			case '[DTT_NAME_OR_DATES]' :
+				return $data->get_dtt_display_name(true);
+				break;
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[RECIPIENT_QUESTION_LIST]'] = __('This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+        
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+        
+		if ( ! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		switch ($shortcode) {
+			case '[RECIPIENT_QUESTION_LIST]' :
+				$att                       = $recipient->att_obj;
+				$registrations_on_attendee = $att instanceof EE_Attendee ? $recipient->attendees[$att->ID()]['reg_objs'] : array();
+				$registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
+				$answers                   = array();
                 
-                $template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
+				$template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
                 
-                //if the context is main_content then get all answers for all registrations on this attendee
-                if ($data['data'] instanceof EE_Messages_Addressee) {
+				//if the context is main_content then get all answers for all registrations on this attendee
+				if ($data['data'] instanceof EE_Messages_Addressee) {
                     
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[$ans->ID()] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[$ans->ID()] = $ans;
+								}
+							}
+						}
+					}
+				}
                 
-                //if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
-                if ($data['data'] instanceof EE_Event) {
-                    $event = $data['data'];
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[$ans->ID()] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
+				//if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
+				if ($data['data'] instanceof EE_Event) {
+					$event = $data['data'];
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
+							$anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[$ans->ID()] = $ans;
+								}
+							}
+						}
+					}
+				}
                 
-                $questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
+				$questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
                 
-                //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                //object on it.
-                if ( ! isset( $extra_data['data'] ) ) {
-                    $extra_data['data'] = $recipient;
-                }
+				//if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				//object on it.
+				if ( ! isset( $extra_data['data'] ) ) {
+					$extra_data['data'] = $recipient;
+				}
                 
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
             
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __('This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_primary_registration_details_parser(
-        $parsed,
-        $shortcode,
-        $data,
-        $extra_data,
-        $shortcode_parser
-    ) {
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-        
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-        
-        if ( ! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_QUESTION_LIST]' :
-                if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                $registration     = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
-                    ? $recipient->registrations[$registration->ID()]['ans_objs']
-                    : array();
-                if (empty($answers)) {
-                    return '';
-                }
-                $template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-                $answers          = $recipient->registrations[$registration->ID()]['ans_objs'];
-                $questions = isset($recipient->questions) ? $recipient->questions : array();
-                //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                //object on it.
-                if ( ! isset( $extra_data['data'] ) ){
-                    $extra_data['data'] = $recipient;
-                }
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __('This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_primary_registration_details_parser(
+		$parsed,
+		$shortcode,
+		$data,
+		$extra_data,
+		$shortcode_parser
+	) {
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+        
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+        
+		if ( ! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_QUESTION_LIST]' :
+				if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				$registration     = $recipient->primary_reg_obj;
+				$answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
+					? $recipient->registrations[$registration->ID()]['ans_objs']
+					: array();
+				if (empty($answers)) {
+					return '';
+				}
+				$template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+				$answers          = $recipient->registrations[$registration->ID()]['ans_objs'];
+				$questions = isset($recipient->questions) ? $recipient->questions : array();
+				//if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				//object on it.
+				if ( ! isset( $extra_data['data'] ) ){
+					$extra_data['data'] = $recipient;
+				}
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
             
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    /**
-     * Takes care of registering the  message types that are only available in caffeinated EE.
-     *
-     * @since   4.3.2
-     *
-     * @return  void
-     */
-    public function register_caf_message_types()
-    {
-        //register newsletter message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
-            'autoloadpaths'               => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
-            ),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('newsletter', $setup_args);
-        
-        //register payment reminder message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_reminder', $setup_args);
-        
-        //register payment declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_declined', $setup_args);
-        
-        //register registration declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('declined_registration', $setup_args);
-        
-        //register registration cancelled message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('cancelled_registration', $setup_args);
-        
-        
-        //register payment failed message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_failed', $setup_args);
-        
-        //register payment declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_cancelled', $setup_args);
-    }
-    
-    
-    /**
-     * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
-     *
-     * @since   4.3.2
-     *
-     * @return void
-     */
-    public function register_caf_shortcodes()
-    {
-        $setup_args = array(
-            'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/'
-            ),
-            'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
-            'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
-            'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]')
-        );
-        EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
-    }
-    
-    
-    /**
-     * Parses a question list shortcode using given data and template
-     *
-     * @param \EE_Shortcodes $shortcode_parser
-     * @param EE_Question[]  $questions        An array of questions indexed by answer id.
-     * @param EE_Answer[]    $answers          An array of answer objects
-     * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
-     * @param array          $extra_data       Extra data that might be used when parsing the template.
-     */
-    protected function _parse_question_list_for_primary_or_recipient_registration(
-        $shortcode_parser,
-        $questions,
-        $answers,
-        $template,
-        $valid_shortcodes,
-        $extra_data
-    ) {
-        $question_list = '';
-        /** @var EEH_Parse_Shortcodes $shortcode_helper */
-        $shortcode_helper = $shortcode_parser->get_shortcode_helper();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                //first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
-                $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (
-                    ! $question instanceof EE_Question
-                    || (
-                        $question instanceof EE_Question
-                        && $question->admin_only()
-                    )
-                ) {
-                    continue;
-                }
-                $question_list .= $shortcode_helper->parse_question_list_template(
-                    $template,
-                    $answer,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-            }
-        }
-        
-        return $question_list;
-    }
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	/**
+	 * Takes care of registering the  message types that are only available in caffeinated EE.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return  void
+	 */
+	public function register_caf_message_types()
+	{
+		//register newsletter message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
+			'autoloadpaths'               => array(
+				EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
+			),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('newsletter', $setup_args);
+        
+		//register payment reminder message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_reminder', $setup_args);
+        
+		//register payment declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_declined', $setup_args);
+        
+		//register registration declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('declined_registration', $setup_args);
+        
+		//register registration cancelled message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('cancelled_registration', $setup_args);
+        
+        
+		//register payment failed message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_failed', $setup_args);
+        
+		//register payment declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_cancelled', $setup_args);
+	}
+    
+    
+	/**
+	 * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return void
+	 */
+	public function register_caf_shortcodes()
+	{
+		$setup_args = array(
+			'autoloadpaths'                 => array(
+				EE_CAF_LIBRARIES . 'shortcodes/'
+			),
+			'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
+			'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
+			'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]')
+		);
+		EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
+	}
+    
+    
+	/**
+	 * Parses a question list shortcode using given data and template
+	 *
+	 * @param \EE_Shortcodes $shortcode_parser
+	 * @param EE_Question[]  $questions        An array of questions indexed by answer id.
+	 * @param EE_Answer[]    $answers          An array of answer objects
+	 * @param string         $template         Template content to be parsed.
+	 * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+	 * @param array          $extra_data       Extra data that might be used when parsing the template.
+	 */
+	protected function _parse_question_list_for_primary_or_recipient_registration(
+		$shortcode_parser,
+		$questions,
+		$answers,
+		$template,
+		$valid_shortcodes,
+		$extra_data
+	) {
+		$question_list = '';
+		/** @var EEH_Parse_Shortcodes $shortcode_helper */
+		$shortcode_helper = $shortcode_parser->get_shortcode_helper();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				//first see if the question is in our $questions array. If not then try to get from answer object.
+				$question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
+				$question = ! $question instanceof EE_Question ? $answer->question() : $question;
+				if (
+					! $question instanceof EE_Question
+					|| (
+						$question instanceof EE_Question
+						&& $question->admin_only()
+					)
+				) {
+					continue;
+				}
+				$question_list .= $shortcode_helper->parse_question_list_template(
+					$template,
+					$answer,
+					$valid_shortcodes,
+					$extra_data
+				);
+			}
+		}
+        
+		return $question_list;
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -95,7 +95,7 @@ 
      */
     public function messages_autoload_paths($dir_ref)
     {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/';
         
         return $dir_ref;
     }
@@ -216,10 +216,10 @@ 
         }
         
         //the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
+        $template_file_prefix = $field.'_'.$context;
+        $msg_prefix           = $messenger->name.'_'.$message_type->name.'_';
         
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/';
         
         if ($messenger->name == 'email' && $message_type->name == 'registration') {
             
@@ -228,17 +228,17 @@ 
                 case 'question_list_admin' :
                 case 'question_list_attendee' :
                 case 'question_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'question_list.template.php';
+                    $path     = $base_path.$msg_prefix.'question_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'attendee_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'attendee_list_admin' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list_admin.template.php';
                     $contents = EEH_Template::display_template($path,
                         array(), true);
                     break;
@@ -248,7 +248,7 @@ 
                     break;
                 
                 case 'event_list_attendee' :
-                    $path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+                    $path     = $base_path.$msg_prefix.'event_list_attendee.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -256,24 +256,24 @@ 
             switch ($template_file_prefix) {
                 
                 case 'content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'content.template.php';
+                    $path     = $base_path.$msg_prefix.'content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'newsletter_content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
+                    $path     = $base_path.$msg_prefix.'newsletter_content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'newsletter_subject_attendee' :
-                    $path     = $base_path . $msg_prefix . 'subject.template.php';
+                    $path     = $base_path.$msg_prefix.'subject.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
             switch ($template_file_prefix) {
                 case 'attendee_list_purchaser' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -505,7 +505,7 @@ 
                 
                 //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 //object on it.
-                if ( ! isset( $extra_data['data'] ) ) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 
@@ -569,7 +569,7 @@ 
                 if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
-                $registration     = $recipient->primary_reg_obj;
+                $registration = $recipient->primary_reg_obj;
                 $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
                     ? $recipient->registrations[$registration->ID()]['ans_objs']
                     : array();
@@ -582,7 +582,7 @@ 
                 $questions = isset($recipient->questions) ? $recipient->questions : array();
                 //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 //object on it.
-                if ( ! isset( $extra_data['data'] ) ){
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 return $this->_parse_question_list_for_primary_or_recipient_registration(
@@ -615,7 +615,7 @@ 
         $setup_args = array(
             'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
             'autoloadpaths'               => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
+                EE_CAF_LIBRARIES.'messages/message_type/newsletter/'
             ),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
@@ -626,7 +626,7 @@ 
         //register payment reminder message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -636,7 +636,7 @@ 
         //register payment declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -646,7 +646,7 @@ 
         //register registration declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -656,7 +656,7 @@ 
         //register registration cancelled message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -667,7 +667,7 @@ 
         //register payment failed message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -677,7 +677,7 @@ 
         //register payment declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -697,7 +697,7 @@ 
     {
         $setup_args = array(
             'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/'
+                EE_CAF_LIBRARIES.'shortcodes/'
             ),
             'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
             'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),