eventespresso / event-espresso-core

core/libraries/messages/EE_Messages_Base.lib.php

Spacing +9 added lines, -9 removed lines

@@ -196,11 +196,11 @@ 
             ! empty($messenger)
             && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
         ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+            $settings_to_use = $active_messengers[$messenger]['settings'][$messenger.'-message_types'];
         }
 
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
+        $this->_existing_admin_settings = isset($settings_to_use[$this->name]['settings'])
+            ? $settings_to_use[$this->name]['settings']
             : null;
     }
 
@@ -240,7 +240,7 @@ 
     public function get_valid_shortcodes()
     {
         $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+            'FHEE__'.get_class($this).'__get_valid_shortcodes',
             $this->_valid_shortcodes,
             $this
         );
@@ -283,19 +283,19 @@ 
     protected function _get_admin_page_content($page, $action, $extra, $actives)
     {
         // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
+        if ( ! empty($action)) {
+            $page = $page.'_'.$action;
         }
 
-        if (!isset($this->admin_registered_pages[ $page ])) {
+        if ( ! isset($this->admin_registered_pages[$page])) {
             // todo: a place to throw an exception?
             // We need to indicate there is no registered page so this function is not being called correctly.
             return false;
         }
         // k made it here so let's call the method
         $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
+            array($this, '_get_admin_content_'.$page),
+            array($actives, $extra)
         );
         if ($content === false) {
             // todo this needs to be an exception once we've got exceptions in place.

Indentation +265 added lines, -265 removed lines

@@ -13,44 +13,44 @@ 
  */
 abstract class EE_Messages_Base extends EE_Base
 {
-    /** DETAILS PROPERTIES **/
-    /**
-     * The following are used to hold details on the type for reference (i.e. on admin screens)
-     * and also used by the EE_message_type object to figure out where to get template data.
-     */
-    public $name;
-    public $description;
-    protected $_messages_item_type; // messenger OR message_type?
-
-
-    /**
-     * This is an array describing the ui facing labels
-     * that will be used whenever the messenger is referenced in the ui
-     *
-     * array(
-     *  'singular' => esc_html__('something'),
-     *  'plural' => esc_html__('somethings')
-     * )
-     *
-     * @var array
-     */
-    public $label;
-
-
-
-
-    /**
-     * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
-     * (and used to determine which callback method to call from the child class)
-     *
-     * structure should be
-     * array(
-     * 'page_action' => true
-     * )
-     *
+	/** DETAILS PROPERTIES **/
+	/**
+	 * The following are used to hold details on the type for reference (i.e. on admin screens)
+	 * and also used by the EE_message_type object to figure out where to get template data.
+	 */
+	public $name;
+	public $description;
+	protected $_messages_item_type; // messenger OR message_type?
+
+
+	/**
+	 * This is an array describing the ui facing labels
+	 * that will be used whenever the messenger is referenced in the ui
+	 *
+	 * array(
+	 *  'singular' => esc_html__('something'),
+	 *  'plural' => esc_html__('somethings')
+	 * )
+	 *
+	 * @var array
+	 */
+	public $label;
+
+
+
+
+	/**
+	 * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
+	 * (and used to determine which callback method to call from the child class)
+	 *
+	 * structure should be
+	 * array(
+	 * 'page_action' => true
+	 * )
+	 *
 *@var array
-     */
-    public $admin_registered_pages = array();
+	 */
+	public $admin_registered_pages = array();
 
 
 
@@ -59,265 +59,265 @@ 
 
 
 
-    /**
-     * this property holds any specific fields for holding any settings related to a messenger (if any needed)
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
+	/**
+	 * this property holds any specific fields for holding any settings related to a messenger (if any needed)
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
 
 
 
 
 
-    /**
-     * this property will hold any existing settings that may have been set in the admin.
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
+	/**
+	 * this property will hold any existing settings that may have been set in the admin.
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
 
 
 
 
 
-    /**
-     * this property will hold an array of valid shortcodes for this message type and messengers.
-     * #For Message Types:
-     * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
-     * For example:
-     * array( 'admin' => array('transaction', 'event', 'attendee') )
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the admin context;
-     *
-     *
-     * #For Messengers:
-     * For example:
-     * array('subject' => array('transaction', 'event', 'attendee'))
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the 'subject' field;
-     * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
-     * that field will inherit whatever are set as valid shortcodes by message_type.
-     * This is so messenger can set specific valid codes for fields and leave other
-     * valid shortcodes up to the message type matched with the messenger.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_valid_shortcodes = array();
+	/**
+	 * this property will hold an array of valid shortcodes for this message type and messengers.
+	 * #For Message Types:
+	 * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
+	 * For example:
+	 * array( 'admin' => array('transaction', 'event', 'attendee') )
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the admin context;
+	 *
+	 *
+	 * #For Messengers:
+	 * For example:
+	 * array('subject' => array('transaction', 'event', 'attendee'))
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the 'subject' field;
+	 * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
+	 * that field will inherit whatever are set as valid shortcodes by message_type.
+	 * This is so messenger can set specific valid codes for fields and leave other
+	 * valid shortcodes up to the message type matched with the messenger.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_valid_shortcodes = array();
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_set_admin_settings_fields();
-        $this->_set_valid_shortcodes();
-        $this->_set_admin_pages();
-    }
+	public function __construct()
+	{
+		$this->_set_admin_settings_fields();
+		$this->_set_valid_shortcodes();
+		$this->_set_admin_pages();
+	}
 
 
 
 
 
-    /**
-     * sets the _admin_settings_fields property which needs to be defined by child classes.
-     * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
-     * array(
-     *      {field_name - also used for setting index} => array(
-     *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
-     *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
-     *          'required' => {bool, required or not},
-     *          'validation' => {bool, true if we want validation, false if not},
-     *          'format' => {%d, or %s},
-     *          'label' => {label for the field, make sure it's localized},
-     *          'default' => {default value for the setting}
-     *      ),
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_settings_fields();
+	/**
+	 * sets the _admin_settings_fields property which needs to be defined by child classes.
+	 * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
+	 * array(
+	 *      {field_name - also used for setting index} => array(
+	 *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
+	 *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
+	 *          'required' => {bool, required or not},
+	 *          'validation' => {bool, true if we want validation, false if not},
+	 *          'format' => {%d, or %s},
+	 *          'label' => {label for the field, make sure it's localized},
+	 *          'default' => {default value for the setting}
+	 *      ),
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_settings_fields();
 
 
 
 
 
-    /**
-     * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
-     * Child classes have to define this method but don't necessarily have to set the flags
-     * as they will be set to false by default.
-     *
-     * Child classes use this method to set the `_admin_registered_page` property.
-     * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
-     * so Message Type/messenger fields/content is included on that admin page.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_pages();
+	/**
+	 * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
+	 * Child classes have to define this method but don't necessarily have to set the flags
+	 * as they will be set to false by default.
+	 *
+	 * Child classes use this method to set the `_admin_registered_page` property.
+	 * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
+	 * so Message Type/messenger fields/content is included on that admin page.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_pages();
 
 
 
 
 
-    /**
-     * Child classes must declare the $_valid_shortcodes property using this method.
-     * See comments for $_valid_shortcodes property for details on what it is used for.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_valid_shortcodes();
+	/**
+	 * Child classes must declare the $_valid_shortcodes property using this method.
+	 * See comments for $_valid_shortcodes property for details on what it is used for.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_valid_shortcodes();
 
 
 
-    /**
-     * sets the _existing_admin_settings property can be overridden by child classes.
-     * We do this so we only do database calls if needed.
-     *
-     * @access protected
-     * @param string $messenger
-     */
-    protected function _set_existing_admin_settings($messenger = '')
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers = $Message_Resource_Manager->get_active_messengers_option();
-        $settings_to_use = $active_messengers;
-
-        /**
-         * This determines what will be used for the getting the settings.
-         */
-        if (
-            ! empty($messenger)
-            && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
-        ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
-        }
-
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * get_existing_admin_settings
-     * (if needed) sets and returns the _existing_admin_settings property.
-     *
-     * @access public
-     * @param string $messenger
-     * @return array          settings
-     */
-    public function get_existing_admin_settings($messenger = '')
-    {
-        // if admin_settings property empty lets try setting it.
-        if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
-            $this->_set_existing_admin_settings($messenger);
-        }
-        return property_exists($this, '_existing_admin_settings')
-            ? $this->_existing_admin_settings
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
-     * @return array   an array of valid shortcodes.
-     */
-    public function get_valid_shortcodes()
-    {
-        $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
-            $this->_valid_shortcodes,
-            $this
-        );
-        // The below filter applies to ALL messengers and message types so use with care!
-        $valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
-        return $valid_shortcodes;
-    }
-
-
-
-
-    /**
-     * getter that returns the protected admin_settings_fields property
-     *
-     * @access public
-     * @return array admin settings fields
-     */
-    public function get_admin_settings_fields()
-    {
-        return $this->_admin_settings_fields;
-    }
-
-
-
-
-
-    /**
-     * 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 $actives an array of active message type (or 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 protected
-     * @return string $content for page.
-     */
-    protected function _get_admin_page_content($page, $action, $extra, $actives)
-    {
-        // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
-        }
-
-        if (!isset($this->admin_registered_pages[ $page ])) {
-            // todo: a place to throw an exception?
-            // We need to indicate there is no registered page so this function is not being called correctly.
-            return false;
-        }
-        // k made it here so let's call the method
-        $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
-        );
-        if ($content === false) {
-            // todo this needs to be an exception once we've got exceptions in place.
-            return false;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Allows a message type to specifically exclude template fields for the provided messenger.
-     * Filtered so this can be programmatically altered as well.
-     * @param string $messenger_name name of messenger
-     * @return array
-     */
-    public function excludedFieldsForMessenger($messenger_name)
-    {
-        return apply_filters(
-            'FHEE__EE_Messages_Base__excludedFieldForMessenger',
-            array(),
-            $messenger_name,
-            $this->name,
-            $this
-        );
-    }
+	/**
+	 * sets the _existing_admin_settings property can be overridden by child classes.
+	 * We do this so we only do database calls if needed.
+	 *
+	 * @access protected
+	 * @param string $messenger
+	 */
+	protected function _set_existing_admin_settings($messenger = '')
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers = $Message_Resource_Manager->get_active_messengers_option();
+		$settings_to_use = $active_messengers;
+
+		/**
+		 * This determines what will be used for the getting the settings.
+		 */
+		if (
+			! empty($messenger)
+			&& $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
+		) {
+			$settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+		}
+
+		$this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
+			? $settings_to_use[ $this->name ]['settings']
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * get_existing_admin_settings
+	 * (if needed) sets and returns the _existing_admin_settings property.
+	 *
+	 * @access public
+	 * @param string $messenger
+	 * @return array          settings
+	 */
+	public function get_existing_admin_settings($messenger = '')
+	{
+		// if admin_settings property empty lets try setting it.
+		if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
+			$this->_set_existing_admin_settings($messenger);
+		}
+		return property_exists($this, '_existing_admin_settings')
+			? $this->_existing_admin_settings
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
+	 * @return array   an array of valid shortcodes.
+	 */
+	public function get_valid_shortcodes()
+	{
+		$valid_shortcodes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+			$this->_valid_shortcodes,
+			$this
+		);
+		// The below filter applies to ALL messengers and message types so use with care!
+		$valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
+		return $valid_shortcodes;
+	}
+
+
+
+
+	/**
+	 * getter that returns the protected admin_settings_fields property
+	 *
+	 * @access public
+	 * @return array admin settings fields
+	 */
+	public function get_admin_settings_fields()
+	{
+		return $this->_admin_settings_fields;
+	}
+
+
+
+
+
+	/**
+	 * 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 $actives an array of active message type (or 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 protected
+	 * @return string $content for page.
+	 */
+	protected function _get_admin_page_content($page, $action, $extra, $actives)
+	{
+		// we can also further refine the context by action (if present).
+		if (!empty($action)) {
+			$page = $page . '_' . $action;
+		}
+
+		if (!isset($this->admin_registered_pages[ $page ])) {
+			// todo: a place to throw an exception?
+			// We need to indicate there is no registered page so this function is not being called correctly.
+			return false;
+		}
+		// k made it here so let's call the method
+		$content = call_user_func_array(
+			array( $this, '_get_admin_content_' . $page ),
+			array( $actives, $extra )
+		);
+		if ($content === false) {
+			// todo this needs to be an exception once we've got exceptions in place.
+			return false;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Allows a message type to specifically exclude template fields for the provided messenger.
+	 * Filtered so this can be programmatically altered as well.
+	 * @param string $messenger_name name of messenger
+	 * @return array
+	 */
+	public function excludedFieldsForMessenger($messenger_name)
+	{
+		return apply_filters(
+			'FHEE__EE_Messages_Base__excludedFieldForMessenger',
+			array(),
+			$messenger_name,
+			$this->name,
+			$this
+		);
+	}
 }

core/libraries/messages/EE_Messages_Scheduler.lib.php

Spacing +6 added lines, -6 removed lines

@@ -26,7 +26,7 @@ 
     public function __construct()
     {
         // register tasks (and make sure only registered once).
-        if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
+        if ( ! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
             add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
         }
 
@@ -77,7 +77,7 @@ 
         EE_Registry::instance()->load_helper('DTT_Helper');
         $tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
         $tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
+        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array(EEH_DTT_Helper::tomorrow(), 'daily');
         return $tasks;
     }
 
@@ -96,7 +96,7 @@ 
                 true
             )
         ) {
-            $request_url  = add_query_arg(
+            $request_url = add_query_arg(
                 array_merge(
                     array('ee' => 'msg_cron_trigger'),
                     EE_Messages_Scheduler::get_request_params($task)
@@ -109,7 +109,7 @@ 
                 'sslverify'   => false,
                 'redirection' => 10,
             );
-            $response     = wp_remote_get($request_url, $request_args);
+            $response = wp_remote_get($request_url, $request_args);
             if (is_wp_error($response)) {
                 trigger_error($response->get_error_message());
             }
@@ -129,7 +129,7 @@ 
     public static function get_request_params($task)
     {
         // transient is used for flood control on msg_cron_trigger requests
-        $transient_key = 'ee_trans_' . uniqid($task);
+        $transient_key = 'ee_trans_'.uniqid($task);
         set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
         return array(
             'type' => $task,
@@ -202,7 +202,7 @@ 
             'AHEE__EE_Messages_Scheduler__sending'    => 'ee_message_cron',
         );
         foreach ($message_crons_to_check as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
+            if ( ! wp_next_scheduled($hook_name)) {
                 wp_schedule_event(time(), $frequency, $hook_name);
             }
         }

Indentation +221 added lines, -221 removed lines

@@ -13,225 +13,225 @@
  */
 class EE_Messages_Scheduler extends EE_Base
 {
-    /**
-     * Number of seconds between batch sends/generates on the cron job.
-     * Defaults to 5 minutes in seconds.  If you want to change this interval, you can use the native WordPress
-     * `cron_schedules` filter and modify the existing custom `ee_message_cron` schedule interval added.
-     *
-     * @type int
-     */
-    const message_cron_schedule = 300;
-
-    /**
-     * Constructor
-     */
-    public function __construct()
-    {
-        // register tasks (and make sure only registered once).
-        if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
-            add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
-        }
-
-        // register callbacks for scheduled events (but make sure they are set only once).
-        if (
-            ! has_action(
-                'AHEE__EE_Messages_Scheduler__generation',
-                array('EE_Messages_Scheduler', 'batch_generation')
-            )
-        ) {
-            add_action('AHEE__EE_Messages_Scheduler__generation', array('EE_Messages_Scheduler', 'batch_generation'));
-            add_action('AHEE__EE_Messages_Scheduler__sending', array('EE_Messages_Scheduler', 'batch_sending'));
-            add_action('AHEE__EE_Messages_Scheduler__cleanup', array('EE_Messages_Scheduler', 'cleanup'));
-        }
-
-        // add custom schedules
-        add_filter('cron_schedules', array($this, 'custom_schedules'));
-    }
-
-
-    /**
-     * Add custom schedules for wp_cron
-     *
-     * @param $schedules
-     */
-    public function custom_schedules($schedules)
-    {
-        $schedules['ee_message_cron'] = array(
-            'interval' => self::message_cron_schedule,
-            'display'  => esc_html__(
-                'This is the cron time interval for EE Message schedules (defaults to once every 5 minutes)',
-                'event_espresso'
-            ),
-        );
-        return $schedules;
-    }
-
-
-    /**
-     * Callback for FHEE__EEH_Activation__get_cron_tasks that is used to retrieve scheduled Cron events to add and
-     * remove.
-     *
-     * @param array $tasks already existing scheduled tasks
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function register_scheduled_tasks($tasks)
-    {
-        EE_Registry::instance()->load_helper('DTT_Helper');
-        $tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
-        return $tasks;
-    }
-
-
-    /**
-     * This initiates a non-blocking separate request to execute on a scheduled task.
-     * Note: The EED_Messages module has the handlers for these requests.
-     *
-     * @param string $task The task the request is being generated for.
-     */
-    public static function initiate_scheduled_non_blocking_request($task)
-    {
-        if (
-            apply_filters(
-                'EE_Messages_Scheduler__initiate_scheduled_non_blocking_request__do_separate_request',
-                true
-            )
-        ) {
-            $request_url  = add_query_arg(
-                array_merge(
-                    array('ee' => 'msg_cron_trigger'),
-                    EE_Messages_Scheduler::get_request_params($task)
-                ),
-                site_url()
-            );
-            $request_args = array(
-                'timeout'     => 300,
-                'blocking'    => (defined('DOING_CRON') && DOING_CRON)
-                                 || (defined('DOING_AJAX') && DOING_AJAX),
-                'sslverify'   => false,
-                'redirection' => 10,
-            );
-            $response     = wp_remote_get($request_url, $request_args);
-            if (is_wp_error($response)) {
-                trigger_error($response->get_error_message());
-            }
-        } else {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron($task);
-        }
-    }
-
-
-    /**
-     * This returns
-     * the request params used for a scheduled message task request.
-     *
-     * @param string $task The task the request is for.
-     * @return array
-     */
-    public static function get_request_params($task)
-    {
-        // transient is used for flood control on msg_cron_trigger requests
-        $transient_key = 'ee_trans_' . uniqid($task);
-        set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
-        return array(
-            'type' => $task,
-            'key'  => $transient_key,
-        );
-    }
-
-
-    /**
-     * This is used to execute an immediate call to the run_cron task performed by EED_Messages
-     *
-     * @param string $task The task the request is being generated for.
-     */
-    public static function initiate_immediate_request_on_cron($task)
-    {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $request_args = EE_Messages_Scheduler::get_request_params($task);
-        // set those request args in the request so it gets picked up
-        foreach ($request_args as $request_key => $request_value) {
-            $request->setRequestParam($request_key, $request_value);
-        }
-        EED_Messages::instance()->run_cron();
-    }
-
-
-    /**
-     * Callback for scheduled AHEE__EE_Messages_Scheduler__generation wp cron event
-     */
-    public static function batch_generation()
-    {
-        /**
-         * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
-         */
-        if (
-            ! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron('generate');
-        }
-    }
-
-
-    /**
-     * Callback for scheduled AHEE__EE_Messages_Scheduler__sending
-     */
-    public static function batch_sending()
-    {
-        /**
-         * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
-         */
-        if (
-            ! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron('send');
-        }
-    }
-
-
-    /**
-     * This is the callback for the `AHEE__EE_Messages_Scheduler__cleanup` scheduled event action.
-     * This runs once a day and if cleanup is active (set via messages settings), it will (by default) delete
-     * permanently from the database messages that have a MSG_modified date older than 30 days.
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function cleanup()
-    {
-        // First, confirm that the generation and sending EE_Messages_Scheduler crons are
-        // set and reschedule them if they are not.
-        $message_crons_to_check = array(
-            'AHEE__EE_Messages_Scheduler__generation' => 'ee_message_cron',
-            'AHEE__EE_Messages_Scheduler__sending'    => 'ee_message_cron',
-        );
-        foreach ($message_crons_to_check as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
-                wp_schedule_event(time(), $frequency, $hook_name);
-            }
-        }
-
-        // check if user has cleanup turned on or if we're in maintenance mode.  If in maintenance mode we'll wait
-        // until the next scheduled event.
-        if (
-            ! EE_Registry::instance()->CFG->messages->delete_threshold
-            || ! EE_Maintenance_Mode::instance()->models_can_query()
-        ) {
-            return;
-        }
-
-        /**
-         * This filter switch allows other code (such as the EE_Worker_Queue add-on) to replace this with its own handling
-         * of deleting messages.
-         */
-        if (apply_filters('FHEE__EE_Messages_Scheduler__cleanup__handle_cleanup_on_cron', true)) {
-            EEM_Message::instance()->delete_old_messages(EE_Registry::instance()->CFG->messages->delete_threshold);
-        }
-    }
+	/**
+	 * Number of seconds between batch sends/generates on the cron job.
+	 * Defaults to 5 minutes in seconds.  If you want to change this interval, you can use the native WordPress
+	 * `cron_schedules` filter and modify the existing custom `ee_message_cron` schedule interval added.
+	 *
+	 * @type int
+	 */
+	const message_cron_schedule = 300;
+
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		// register tasks (and make sure only registered once).
+		if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
+			add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
+		}
+
+		// register callbacks for scheduled events (but make sure they are set only once).
+		if (
+			! has_action(
+				'AHEE__EE_Messages_Scheduler__generation',
+				array('EE_Messages_Scheduler', 'batch_generation')
+			)
+		) {
+			add_action('AHEE__EE_Messages_Scheduler__generation', array('EE_Messages_Scheduler', 'batch_generation'));
+			add_action('AHEE__EE_Messages_Scheduler__sending', array('EE_Messages_Scheduler', 'batch_sending'));
+			add_action('AHEE__EE_Messages_Scheduler__cleanup', array('EE_Messages_Scheduler', 'cleanup'));
+		}
+
+		// add custom schedules
+		add_filter('cron_schedules', array($this, 'custom_schedules'));
+	}
+
+
+	/**
+	 * Add custom schedules for wp_cron
+	 *
+	 * @param $schedules
+	 */
+	public function custom_schedules($schedules)
+	{
+		$schedules['ee_message_cron'] = array(
+			'interval' => self::message_cron_schedule,
+			'display'  => esc_html__(
+				'This is the cron time interval for EE Message schedules (defaults to once every 5 minutes)',
+				'event_espresso'
+			),
+		);
+		return $schedules;
+	}
+
+
+	/**
+	 * Callback for FHEE__EEH_Activation__get_cron_tasks that is used to retrieve scheduled Cron events to add and
+	 * remove.
+	 *
+	 * @param array $tasks already existing scheduled tasks
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function register_scheduled_tasks($tasks)
+	{
+		EE_Registry::instance()->load_helper('DTT_Helper');
+		$tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
+		$tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
+		$tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
+		return $tasks;
+	}
+
+
+	/**
+	 * This initiates a non-blocking separate request to execute on a scheduled task.
+	 * Note: The EED_Messages module has the handlers for these requests.
+	 *
+	 * @param string $task The task the request is being generated for.
+	 */
+	public static function initiate_scheduled_non_blocking_request($task)
+	{
+		if (
+			apply_filters(
+				'EE_Messages_Scheduler__initiate_scheduled_non_blocking_request__do_separate_request',
+				true
+			)
+		) {
+			$request_url  = add_query_arg(
+				array_merge(
+					array('ee' => 'msg_cron_trigger'),
+					EE_Messages_Scheduler::get_request_params($task)
+				),
+				site_url()
+			);
+			$request_args = array(
+				'timeout'     => 300,
+				'blocking'    => (defined('DOING_CRON') && DOING_CRON)
+								 || (defined('DOING_AJAX') && DOING_AJAX),
+				'sslverify'   => false,
+				'redirection' => 10,
+			);
+			$response     = wp_remote_get($request_url, $request_args);
+			if (is_wp_error($response)) {
+				trigger_error($response->get_error_message());
+			}
+		} else {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron($task);
+		}
+	}
+
+
+	/**
+	 * This returns
+	 * the request params used for a scheduled message task request.
+	 *
+	 * @param string $task The task the request is for.
+	 * @return array
+	 */
+	public static function get_request_params($task)
+	{
+		// transient is used for flood control on msg_cron_trigger requests
+		$transient_key = 'ee_trans_' . uniqid($task);
+		set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
+		return array(
+			'type' => $task,
+			'key'  => $transient_key,
+		);
+	}
+
+
+	/**
+	 * This is used to execute an immediate call to the run_cron task performed by EED_Messages
+	 *
+	 * @param string $task The task the request is being generated for.
+	 */
+	public static function initiate_immediate_request_on_cron($task)
+	{
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$request_args = EE_Messages_Scheduler::get_request_params($task);
+		// set those request args in the request so it gets picked up
+		foreach ($request_args as $request_key => $request_value) {
+			$request->setRequestParam($request_key, $request_value);
+		}
+		EED_Messages::instance()->run_cron();
+	}
+
+
+	/**
+	 * Callback for scheduled AHEE__EE_Messages_Scheduler__generation wp cron event
+	 */
+	public static function batch_generation()
+	{
+		/**
+		 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
+		 */
+		if (
+			! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron('generate');
+		}
+	}
+
+
+	/**
+	 * Callback for scheduled AHEE__EE_Messages_Scheduler__sending
+	 */
+	public static function batch_sending()
+	{
+		/**
+		 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
+		 */
+		if (
+			! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron('send');
+		}
+	}
+
+
+	/**
+	 * This is the callback for the `AHEE__EE_Messages_Scheduler__cleanup` scheduled event action.
+	 * This runs once a day and if cleanup is active (set via messages settings), it will (by default) delete
+	 * permanently from the database messages that have a MSG_modified date older than 30 days.
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function cleanup()
+	{
+		// First, confirm that the generation and sending EE_Messages_Scheduler crons are
+		// set and reschedule them if they are not.
+		$message_crons_to_check = array(
+			'AHEE__EE_Messages_Scheduler__generation' => 'ee_message_cron',
+			'AHEE__EE_Messages_Scheduler__sending'    => 'ee_message_cron',
+		);
+		foreach ($message_crons_to_check as $hook_name => $frequency) {
+			if (! wp_next_scheduled($hook_name)) {
+				wp_schedule_event(time(), $frequency, $hook_name);
+			}
+		}
+
+		// check if user has cleanup turned on or if we're in maintenance mode.  If in maintenance mode we'll wait
+		// until the next scheduled event.
+		if (
+			! EE_Registry::instance()->CFG->messages->delete_threshold
+			|| ! EE_Maintenance_Mode::instance()->models_can_query()
+		) {
+			return;
+		}
+
+		/**
+		 * This filter switch allows other code (such as the EE_Worker_Queue add-on) to replace this with its own handling
+		 * of deleting messages.
+		 */
+		if (apply_filters('FHEE__EE_Messages_Scheduler__cleanup__handle_cleanup_on_cron', true)) {
+			EEM_Message::instance()->delete_old_messages(EE_Registry::instance()->CFG->messages->delete_threshold);
+		}
+	}
 }

core/libraries/messages/data_class/EE_Messages_incoming_data.core.php

Spacing +47 added lines, -47 removed lines

@@ -332,7 +332,7 @@ 
         $answers            = $questions = $attendees = $line_items = $registrations = array();
         $total_ticket_count = 0;
 
-        if (! empty($this->reg_objs)) {
+        if ( ! empty($this->reg_objs)) {
             $event_attendee_count = array();
             /** @var EE_Registration $reg */
             foreach ($this->reg_objs as $reg) {
@@ -344,7 +344,7 @@ 
 
                 $evt_id = $reg->event_ID();
                 /** @type EE_Ticket $ticket */
-                $ticket          = $reg->get_first_related('Ticket');
+                $ticket = $reg->get_first_related('Ticket');
                 $attendee = $reg->attendee();
                 $event = $reg->event();
                 // if none of the following entities are available, then we can't setup other data reliably,
@@ -358,67 +358,67 @@ 
                 }
                 $relateddatetime = $ticket->datetimes();
                 $total_ticket_count++;
-                $tickets[ $ticket->ID() ]['ticket']                        = $ticket;
-                $tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
-                                                                           && isset($tickets[ $ticket->ID() ]['count'])
-                    ? $tickets[ $ticket->ID() ]['count'] + 1
+                $tickets[$ticket->ID()]['ticket']                        = $ticket;
+                $tickets[$ticket->ID()]['count']                         = is_array($tickets[$ticket->ID()])
+                                                                           && isset($tickets[$ticket->ID()]['count'])
+                    ? $tickets[$ticket->ID()]['count'] + 1
                     : 1;
-                $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
-                $tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
-                $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
-                $tickets[ $ticket->ID() ]['EE_Event']                      = $event;
-                $evtcache[ $evt_id ]                                       = $event;
-                $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
-                $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
-                $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
-                $event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
-                    ? $event_attendee_count[ $evt_id ] + 1
+                $tickets[$ticket->ID()]['att_objs'][$attendee->ID()] = $attendee;
+                $tickets[$ticket->ID()]['dtt_objs']                      = $relateddatetime;
+                $tickets[$ticket->ID()]['reg_objs'][$reg->ID()]          = $reg;
+                $tickets[$ticket->ID()]['EE_Event']                      = $event;
+                $evtcache[$evt_id]                                       = $event;
+                $eventsetup[$evt_id]['reg_objs'][$reg->ID()]             = $reg;
+                $eventsetup[$evt_id]['tkt_objs'][$ticket->ID()]          = $ticket;
+                $eventsetup[$evt_id]['att_objs'][$attendee->ID()] = $attendee;
+                $event_attendee_count[$evt_id]                           = isset($event_attendee_count[$evt_id])
+                    ? $event_attendee_count[$evt_id] + 1
                     : 0;
-                $attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
-                $attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
-                $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
+                $attendees[$reg->attendee_ID()]['line_ref'][]            = $evt_id;
+                $attendees[$reg->attendee_ID()]['att_obj']               = $attendee;
+                $attendees[$reg->attendee_ID()]['reg_objs'][$reg->ID()]  = $reg;
                 // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
-                $attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
-                $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
-                $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
+                $attendees[$reg->attendee_ID()]['attendee_email']          = $attendee->email();
+                $attendees[$reg->attendee_ID()]['tkt_objs'][$ticket->ID()] = $ticket;
+                $attendees[$reg->attendee_ID()]['evt_objs'][$evt_id]       = $event;
 
                 // registrations
-                $registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
-                $registrations[ $reg->ID() ]['evt_obj'] = $event;
-                $registrations[ $reg->ID() ]['reg_obj'] = $reg;
-                $registrations[ $reg->ID() ]['att_obj'] = $attendee;
+                $registrations[$reg->ID()]['tkt_obj'] = $ticket;
+                $registrations[$reg->ID()]['evt_obj'] = $event;
+                $registrations[$reg->ID()]['reg_obj'] = $reg;
+                $registrations[$reg->ID()]['att_obj'] = $attendee;
 
                 // set up answer objects
                 $rel_ans = $reg->get_many_related('Answer');
                 foreach ($rel_ans as $ansid => $answer) {
-                    if (! isset($questions[ $ansid ])) {
-                        $questions[ $ansid ] = $answer->get_first_related('Question');
+                    if ( ! isset($questions[$ansid])) {
+                        $questions[$ansid] = $answer->get_first_related('Question');
                     }
-                    $answers[ $ansid ]                               = $answer;
-                    $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
+                    $answers[$ansid] = $answer;
+                    $registrations[$reg->ID()]['ans_objs'][$ansid] = $answer;
                 }
                 /**
                  * @var int $dtt_id
                  * @var EE_Datetime $datetime
                  */
                 foreach ($relateddatetime as $dtt_id => $datetime) {
-                    $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
-                    $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
+                    $eventsetup[$evt_id]['dtt_objs'][$dtt_id]       = $datetime;
+                    $registrations[$reg->ID()]['dtt_objs'][$dtt_id] = $datetime;
 
-                    if (isset($datetimes[ $dtt_id ])) {
+                    if (isset($datetimes[$dtt_id])) {
                         continue; // already have this info in the datetimes array.
                     }
 
-                    $datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
-                    $datetimes[ $dtt_id ]['datetime']             = $datetime;
-                    $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
-                    $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
+                    $datetimes[$dtt_id]['tkt_objs'][]           = $ticket;
+                    $datetimes[$dtt_id]['datetime']             = $datetime;
+                    $datetimes[$dtt_id]['evt_objs'][$evt_id]    = $event;
+                    $datetimes[$dtt_id]['reg_objs'][$reg->ID()] = $reg;
                 }
             }
 
             // let's loop through the unique event=>reg items and setup data on them
 
-            if (! empty($eventsetup)) {
+            if ( ! empty($eventsetup)) {
                 foreach ($eventsetup as $evt_id => $items) {
                     $ticket_line_items_for_event = array();
                     if ($this->txn instanceof EE_Transaction) {
@@ -432,11 +432,11 @@ 
                             )
                         );
                     }
-                    $events[ $evt_id ] = array(
+                    $events[$evt_id] = array(
                         'ID'              => $evt_id,
-                        'event'           => $evtcache[ $evt_id ],
-                        'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
-                        'total_attendees' => $event_attendee_count[ $evt_id ],
+                        'event'           => $evtcache[$evt_id],
+                        'name'            => $evtcache[$evt_id] instanceof EE_Event ? $evtcache[$evt_id]->name() : '',
+                        'total_attendees' => $event_attendee_count[$evt_id],
                         'reg_objs'        => $items['reg_objs'],
                         'tkt_objs'        => $items['tkt_objs'],
                         'att_objs'        => $items['att_objs'],
@@ -447,11 +447,11 @@ 
                     // make sure the tickets have the line items setup for them.
                     foreach ($ticket_line_items_for_event as $line_id => $line_item) {
                         // only add the ticket line items if we already have this ticket in the $tickets array.
-                        if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
-                            $tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
-                            $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
-                            $line_items[ $line_item->ID() ]['children']              = $line_item->children();
-                            $line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
+                        if ($line_item instanceof EE_Line_Item && isset($tickets[$line_item->ticket()->ID()])) {
+                            $tickets[$line_item->ticket()->ID()]['line_item']      = $line_item;
+                            $tickets[$line_item->ticket()->ID()]['sub_line_items'] = $line_item->children();
+                            $line_items[$line_item->ID()]['children']              = $line_item->children();
+                            $line_items[$line_item->ID()]['EE_Ticket']             = $line_item->ticket();
                         }
                     }
                 }

Indentation +518 added lines, -518 removed lines

@@ -16,522 +16,522 @@
  */
 abstract class EE_Messages_incoming_data
 {
-    /**
-     * user id for logged in user when data collected
-     *
-     * @var string $user_id
-     */
-    public $user_id;
-
-    /**
-     * IP Address of browser used
-     *
-     * @var string $ip_address
-     */
-    public $ip_address;
-
-    /**
-     * browser
-     *
-     * @var string $user_agent
-     */
-    public $user_agent;
-
-    /**
-     * Unix timestamp
-     *
-     * @var string $init_access
-     */
-    public $init_access;
-
-    /**
-     * Unix timestamp
-     *
-     * @var string $last_access
-     */
-    public $last_access;
-
-    /**
-     * The registrations details from the cart
-     *
-     * @var array $reg_info
-     */
-    public $reg_info;
-
-    /**
-     * Some data handlers can set what reg status all the registrations are filtered by.
-     * The status should match a EEM_Registration status constant.
-     *
-     * @var string $filtered_reg_status
-     */
-    public $filtered_reg_status;
-
-    /**
-     * will hold an array of events assembled from $reg_info
-     *
-     * @var EE_Event[] $events
-     */
-    public $events;
-
-    /**
-     * holds an array of datetimes assembled from the incoming data.
-     *
-     * @var EE_Datetime[] $datetimes
-     */
-    public $datetimes;
-
-    /**
-     * holds an array of tickets assembled from the incoming data.
-     *
-     * @var EE_Ticket[] $tickets
-     */
-    public $tickets;
-
-    /**
-     * holds an array with a key of parent line item and values are an array of children of that line item.
-     *
-     * @since 4.5.0
-     * @var EE_Line_Item[] $line_items_with_children
-     */
-    public $line_items_with_children;
-
-    /**
-     * will hold an array of attendees assembled from the $reg_info
-     *
-     * @var EE_Attendee[] $attendees
-     */
-    public $attendees;
-
-    /**
-     * will hold an array of cached registration objects and info assembled from reg_info
-     *
-     * @var array $registrations
-     */
-    public $registrations;
-
-    /**
-     * will hold an array of answers assembled from the $reg_info
-     *
-     * @var EE_Answer[] $answers
-     */
-    public $answers;
-
-    /**
-     * will hold an array of questions assembled from the $reg_info (indexed by Answer ID);
-     *
-     * @var EE_Question[] $questions
-     */
-    public $questions;
-
-    /**
-     * Will hold billing data assembled from $billing_info (if present)
-     *
-     * @var mixed (array|null) $billing
-     */
-    public $billing;
-
-    /**
-     * The total amount of tax for the transaction
-     *
-     * @var float $taxes
-     */
-    public $taxes;
-
-    /**
-     * Holds the line items related to taxes
-     *
-     * @since 4.5.0
-     * @var EE_Line_Item[] $tax_line_items
-     */
-    public $tax_line_items;
-
-    /**
-     * Hold the line items which aren't taxes and don't relate
-     * to tickets. So: promotions and miscellaneous charges
-     *
-     * @since 4.5
-     * @var EE_Line_Item[] $additional_line_items
-     */
-    public $additional_line_items;
-
-    /**
-     * Holds the grand total EE_Line_Item
-     *
-     * @var EE_Line_Item $grand_total_line_item
-     */
-    public $grand_total_line_item;
-
-    /**
-     * holds the grand total price object
-     * currently not used.
-     *
-     * @var null $grand_total_price_object
-     */
-    public $grand_total_price_object;
-
-    /**
-     * total number of tickets
-     *
-     * @var int $total_ticket_count
-     */
-    public $total_ticket_count;
-
-    /**
-     * Will hold the final transaction object (EE_Transaction)
-     *
-     * @var EE_Transaction $txn
-     */
-    public $txn;
-
-    /**
-     * Holds the payments related to a transaction
-     *
-     * @since 4.5.0
-     * @var EE_Payment[] $payments
-     */
-    public $payments;
-
-    /**
-     * Holds the first related payment related for a transaction
-     *
-     * @since 4.5.0
-     * @var EE_Payment $payment
-     */
-    public $payment;
-
-    /**
-     * Will hold the label for the txn status
-     *
-     * @var string $txn_status
-     */
-    public $txn_status;
-
-    /**
-     * Will hold the final registration object (EE_Registration)
-     *
-     * @var EE_Registration[] $reg_objs
-     */
-    public $reg_objs;
-
-    /**
-     * Will hold an array of primary attendee data (if present)
-     *
-     * @var array $primary_attendee_data
-     */
-    public $primary_attendee_data;
-
-    /**
-     * This is just an internal object used for passing around the incoming data.
-     *
-     * @var mixed $_data
-     */
-    protected $_data;
-
-    /**
-     * This is just an internal object used for passing around the incoming data.
-     *
-     * @var mixed $incoming_data
-     */
-    public $incoming_data;
-
-    /**
-     * hold objects that might be created
-     *
-     * @type EE_Registration $reg_obj
-     */
-    public $reg_obj;
-
-
-    /**
-     * constructor
-     *
-     * @param mixed $data incoming data object|array.  Suggested that child classes use type hinting for expected
-     *                    data object.  But here parent will be generic because we don't know what's coming in.
-     */
-    public function __construct($data)
-    {
-        $this->_data = $data;
-        $this->_setup_data();
-    }
-
-
-    /**
-     * Every child class has to setup the data object !
-     *
-     * @return void
-     */
-    abstract protected function _setup_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 mixed   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        return $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)
-    {
-        return $data;
-    }
-
-
-    /**
-     * only purpose is to return the data
-     *
-     * @access public
-     * @return mixed the formatted data object!
-     */
-    public function data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * This helper method can be used by any incoming data handlers to setup the data correctly.  All that is required
-     * is that $this->reg_objs be set.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     */
-    protected function _assemble_data()
-    {
-        // verify that reg_objs is set
-        if (
-            ! is_array($this->reg_objs)
-            && ! reset($this->reg_objs) instanceof EE_Registration
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to assemble the data correctly, the "reg_objs" property must be an array of EE_Registration objects',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // get all attendee and events associated with the registrations in this transaction
-        $events             = $event_setup = $evtcache = $tickets = $datetimes = array();
-        $answers            = $questions = $attendees = $line_items = $registrations = array();
-        $total_ticket_count = 0;
-
-        if (! empty($this->reg_objs)) {
-            $event_attendee_count = array();
-            /** @var EE_Registration $reg */
-            foreach ($this->reg_objs as $reg) {
-                if (
-                    $this->_skip_registration_for_processing($reg)
-                ) {
-                    continue;
-                }
-
-                $evt_id = $reg->event_ID();
-                /** @type EE_Ticket $ticket */
-                $ticket          = $reg->get_first_related('Ticket');
-                $attendee = $reg->attendee();
-                $event = $reg->event();
-                // if none of the following entities are available, then we can't setup other data reliably,
-                // so let's just skip.
-                if (
-                    ! $ticket instanceof EE_Ticket
-                    || ! $attendee instanceof EE_Attendee
-                    || ! $event instanceof EE_Event
-                ) {
-                    continue;
-                }
-                $relateddatetime = $ticket->datetimes();
-                $total_ticket_count++;
-                $tickets[ $ticket->ID() ]['ticket']                        = $ticket;
-                $tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
-                                                                           && isset($tickets[ $ticket->ID() ]['count'])
-                    ? $tickets[ $ticket->ID() ]['count'] + 1
-                    : 1;
-                $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
-                $tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
-                $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
-                $tickets[ $ticket->ID() ]['EE_Event']                      = $event;
-                $evtcache[ $evt_id ]                                       = $event;
-                $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
-                $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
-                $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
-                $event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
-                    ? $event_attendee_count[ $evt_id ] + 1
-                    : 0;
-                $attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
-                $attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
-                $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
-                // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
-                $attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
-                $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
-                $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
-
-                // registrations
-                $registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
-                $registrations[ $reg->ID() ]['evt_obj'] = $event;
-                $registrations[ $reg->ID() ]['reg_obj'] = $reg;
-                $registrations[ $reg->ID() ]['att_obj'] = $attendee;
-
-                // set up answer objects
-                $rel_ans = $reg->get_many_related('Answer');
-                foreach ($rel_ans as $ansid => $answer) {
-                    if (! isset($questions[ $ansid ])) {
-                        $questions[ $ansid ] = $answer->get_first_related('Question');
-                    }
-                    $answers[ $ansid ]                               = $answer;
-                    $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
-                }
-                /**
-                 * @var int $dtt_id
-                 * @var EE_Datetime $datetime
-                 */
-                foreach ($relateddatetime as $dtt_id => $datetime) {
-                    $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
-                    $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
-
-                    if (isset($datetimes[ $dtt_id ])) {
-                        continue; // already have this info in the datetimes array.
-                    }
-
-                    $datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
-                    $datetimes[ $dtt_id ]['datetime']             = $datetime;
-                    $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
-                    $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
-                }
-            }
-
-            // let's loop through the unique event=>reg items and setup data on them
-
-            if (! empty($eventsetup)) {
-                foreach ($eventsetup as $evt_id => $items) {
-                    $ticket_line_items_for_event = array();
-                    if ($this->txn instanceof EE_Transaction) {
-                        $ticket_line_items_for_event = EEM_Line_Item::instance()->get_all(
-                            array(
-                                array(
-                                    'Ticket.Datetime.EVT_ID' => $evt_id,
-                                    'TXN_ID'                 => $this->txn->ID(),
-                                ),
-                                'default_where_conditions' => 'none',
-                            )
-                        );
-                    }
-                    $events[ $evt_id ] = array(
-                        'ID'              => $evt_id,
-                        'event'           => $evtcache[ $evt_id ],
-                        'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
-                        'total_attendees' => $event_attendee_count[ $evt_id ],
-                        'reg_objs'        => $items['reg_objs'],
-                        'tkt_objs'        => $items['tkt_objs'],
-                        'att_objs'        => $items['att_objs'],
-                        'dtt_objs'        => isset($items['dtt_objs']) ? $items['dtt_objs'] : array(),
-                        'line_items'      => $ticket_line_items_for_event,
-                    );
-
-                    // make sure the tickets have the line items setup for them.
-                    foreach ($ticket_line_items_for_event as $line_id => $line_item) {
-                        // only add the ticket line items if we already have this ticket in the $tickets array.
-                        if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
-                            $tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
-                            $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
-                            $line_items[ $line_item->ID() ]['children']              = $line_item->children();
-                            $line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
-                        }
-                    }
-                }
-            }
-
-            $this->grand_total_line_item = $this->txn instanceof EE_Transaction
-                ? $this->txn->total_line_item()
-                : null;
-        }
-
-        // lets set the attendees and events properties
-        $this->attendees                = $attendees;
-        $this->events                   = $events;
-        $this->tickets                  = $tickets;
-        $this->line_items_with_children = $line_items;
-        $this->datetimes                = $datetimes;
-        $this->questions                = $questions;
-        $this->answers                  = $answers;
-        $this->total_ticket_count       = $total_ticket_count;
-        $this->registrations            = $registrations;
-
-        if ($this->txn instanceof EE_Transaction) {
-            $this->tax_line_items        = $this->txn->tax_items();
-            $this->additional_line_items = $this->txn->non_ticket_line_items();
-            $this->payments              = $this->txn->payments();
-
-            // setup primary registration if we have a single transaction object to work with
-
-            // let's get just the primary_attendee_data!  First we get the primary registration object.
-            $primary_reg = $this->txn->primary_registration();
-            // verify
-            if ($primary_reg instanceof EE_Registration) {
-                // get attendee object
-                if ($primary_reg->attendee() instanceof EE_Attendee) {
-                    // now we can setup the primary_attendee_data array
-                    $this->primary_attendee_data = array(
-                        'registration_id' => $primary_reg->ID(),
-                        'att_obj'         => $primary_reg->attendee(),
-                        'reg_obj'         => $primary_reg,
-                        'primary_att_obj' => $primary_reg->attendee(),
-                        'primary_reg_obj' => $primary_reg,
-                    );
-                } else {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'Incoming data does not have a valid Attendee object for the primary registrant.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Incoming data does not have a valid Registration object for the primary registrant.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-    /**
-     * This simply considers whether the given registration should be processed or not based on comparison with the
-     * filtered_reg_status property.
-     *
-     * @param EE_Registration $registration
-     * @return bool  returning true means we DO want to skip processing.  returning false means we DON'T want to skip
-     *               processing
-     */
-    protected function _skip_registration_for_processing(EE_Registration $registration)
-    {
-        if (empty($this->filtered_reg_status)) {
-            return false;
-        }
-
-        // if we made it here then we just compare the filtered_reg_status with the registration status and return that
-        return $this->filtered_reg_status !== $registration->status_ID();
-    }
+	/**
+	 * user id for logged in user when data collected
+	 *
+	 * @var string $user_id
+	 */
+	public $user_id;
+
+	/**
+	 * IP Address of browser used
+	 *
+	 * @var string $ip_address
+	 */
+	public $ip_address;
+
+	/**
+	 * browser
+	 *
+	 * @var string $user_agent
+	 */
+	public $user_agent;
+
+	/**
+	 * Unix timestamp
+	 *
+	 * @var string $init_access
+	 */
+	public $init_access;
+
+	/**
+	 * Unix timestamp
+	 *
+	 * @var string $last_access
+	 */
+	public $last_access;
+
+	/**
+	 * The registrations details from the cart
+	 *
+	 * @var array $reg_info
+	 */
+	public $reg_info;
+
+	/**
+	 * Some data handlers can set what reg status all the registrations are filtered by.
+	 * The status should match a EEM_Registration status constant.
+	 *
+	 * @var string $filtered_reg_status
+	 */
+	public $filtered_reg_status;
+
+	/**
+	 * will hold an array of events assembled from $reg_info
+	 *
+	 * @var EE_Event[] $events
+	 */
+	public $events;
+
+	/**
+	 * holds an array of datetimes assembled from the incoming data.
+	 *
+	 * @var EE_Datetime[] $datetimes
+	 */
+	public $datetimes;
+
+	/**
+	 * holds an array of tickets assembled from the incoming data.
+	 *
+	 * @var EE_Ticket[] $tickets
+	 */
+	public $tickets;
+
+	/**
+	 * holds an array with a key of parent line item and values are an array of children of that line item.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Line_Item[] $line_items_with_children
+	 */
+	public $line_items_with_children;
+
+	/**
+	 * will hold an array of attendees assembled from the $reg_info
+	 *
+	 * @var EE_Attendee[] $attendees
+	 */
+	public $attendees;
+
+	/**
+	 * will hold an array of cached registration objects and info assembled from reg_info
+	 *
+	 * @var array $registrations
+	 */
+	public $registrations;
+
+	/**
+	 * will hold an array of answers assembled from the $reg_info
+	 *
+	 * @var EE_Answer[] $answers
+	 */
+	public $answers;
+
+	/**
+	 * will hold an array of questions assembled from the $reg_info (indexed by Answer ID);
+	 *
+	 * @var EE_Question[] $questions
+	 */
+	public $questions;
+
+	/**
+	 * Will hold billing data assembled from $billing_info (if present)
+	 *
+	 * @var mixed (array|null) $billing
+	 */
+	public $billing;
+
+	/**
+	 * The total amount of tax for the transaction
+	 *
+	 * @var float $taxes
+	 */
+	public $taxes;
+
+	/**
+	 * Holds the line items related to taxes
+	 *
+	 * @since 4.5.0
+	 * @var EE_Line_Item[] $tax_line_items
+	 */
+	public $tax_line_items;
+
+	/**
+	 * Hold the line items which aren't taxes and don't relate
+	 * to tickets. So: promotions and miscellaneous charges
+	 *
+	 * @since 4.5
+	 * @var EE_Line_Item[] $additional_line_items
+	 */
+	public $additional_line_items;
+
+	/**
+	 * Holds the grand total EE_Line_Item
+	 *
+	 * @var EE_Line_Item $grand_total_line_item
+	 */
+	public $grand_total_line_item;
+
+	/**
+	 * holds the grand total price object
+	 * currently not used.
+	 *
+	 * @var null $grand_total_price_object
+	 */
+	public $grand_total_price_object;
+
+	/**
+	 * total number of tickets
+	 *
+	 * @var int $total_ticket_count
+	 */
+	public $total_ticket_count;
+
+	/**
+	 * Will hold the final transaction object (EE_Transaction)
+	 *
+	 * @var EE_Transaction $txn
+	 */
+	public $txn;
+
+	/**
+	 * Holds the payments related to a transaction
+	 *
+	 * @since 4.5.0
+	 * @var EE_Payment[] $payments
+	 */
+	public $payments;
+
+	/**
+	 * Holds the first related payment related for a transaction
+	 *
+	 * @since 4.5.0
+	 * @var EE_Payment $payment
+	 */
+	public $payment;
+
+	/**
+	 * Will hold the label for the txn status
+	 *
+	 * @var string $txn_status
+	 */
+	public $txn_status;
+
+	/**
+	 * Will hold the final registration object (EE_Registration)
+	 *
+	 * @var EE_Registration[] $reg_objs
+	 */
+	public $reg_objs;
+
+	/**
+	 * Will hold an array of primary attendee data (if present)
+	 *
+	 * @var array $primary_attendee_data
+	 */
+	public $primary_attendee_data;
+
+	/**
+	 * This is just an internal object used for passing around the incoming data.
+	 *
+	 * @var mixed $_data
+	 */
+	protected $_data;
+
+	/**
+	 * This is just an internal object used for passing around the incoming data.
+	 *
+	 * @var mixed $incoming_data
+	 */
+	public $incoming_data;
+
+	/**
+	 * hold objects that might be created
+	 *
+	 * @type EE_Registration $reg_obj
+	 */
+	public $reg_obj;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param mixed $data incoming data object|array.  Suggested that child classes use type hinting for expected
+	 *                    data object.  But here parent will be generic because we don't know what's coming in.
+	 */
+	public function __construct($data)
+	{
+		$this->_data = $data;
+		$this->_setup_data();
+	}
+
+
+	/**
+	 * Every child class has to setup the data object !
+	 *
+	 * @return void
+	 */
+	abstract protected function _setup_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 mixed   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		return $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)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * only purpose is to return the data
+	 *
+	 * @access public
+	 * @return mixed the formatted data object!
+	 */
+	public function data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * This helper method can be used by any incoming data handlers to setup the data correctly.  All that is required
+	 * is that $this->reg_objs be set.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _assemble_data()
+	{
+		// verify that reg_objs is set
+		if (
+			! is_array($this->reg_objs)
+			&& ! reset($this->reg_objs) instanceof EE_Registration
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to assemble the data correctly, the "reg_objs" property must be an array of EE_Registration objects',
+					'event_espresso'
+				)
+			);
+		}
+
+		// get all attendee and events associated with the registrations in this transaction
+		$events             = $event_setup = $evtcache = $tickets = $datetimes = array();
+		$answers            = $questions = $attendees = $line_items = $registrations = array();
+		$total_ticket_count = 0;
+
+		if (! empty($this->reg_objs)) {
+			$event_attendee_count = array();
+			/** @var EE_Registration $reg */
+			foreach ($this->reg_objs as $reg) {
+				if (
+					$this->_skip_registration_for_processing($reg)
+				) {
+					continue;
+				}
+
+				$evt_id = $reg->event_ID();
+				/** @type EE_Ticket $ticket */
+				$ticket          = $reg->get_first_related('Ticket');
+				$attendee = $reg->attendee();
+				$event = $reg->event();
+				// if none of the following entities are available, then we can't setup other data reliably,
+				// so let's just skip.
+				if (
+					! $ticket instanceof EE_Ticket
+					|| ! $attendee instanceof EE_Attendee
+					|| ! $event instanceof EE_Event
+				) {
+					continue;
+				}
+				$relateddatetime = $ticket->datetimes();
+				$total_ticket_count++;
+				$tickets[ $ticket->ID() ]['ticket']                        = $ticket;
+				$tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
+																		   && isset($tickets[ $ticket->ID() ]['count'])
+					? $tickets[ $ticket->ID() ]['count'] + 1
+					: 1;
+				$tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
+				$tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
+				$tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
+				$tickets[ $ticket->ID() ]['EE_Event']                      = $event;
+				$evtcache[ $evt_id ]                                       = $event;
+				$eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
+				$eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
+				$eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
+				$event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
+					? $event_attendee_count[ $evt_id ] + 1
+					: 0;
+				$attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
+				$attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
+				$attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
+				// $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
+				$attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
+				$attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
+				$attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
+
+				// registrations
+				$registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
+				$registrations[ $reg->ID() ]['evt_obj'] = $event;
+				$registrations[ $reg->ID() ]['reg_obj'] = $reg;
+				$registrations[ $reg->ID() ]['att_obj'] = $attendee;
+
+				// set up answer objects
+				$rel_ans = $reg->get_many_related('Answer');
+				foreach ($rel_ans as $ansid => $answer) {
+					if (! isset($questions[ $ansid ])) {
+						$questions[ $ansid ] = $answer->get_first_related('Question');
+					}
+					$answers[ $ansid ]                               = $answer;
+					$registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
+				}
+				/**
+				 * @var int $dtt_id
+				 * @var EE_Datetime $datetime
+				 */
+				foreach ($relateddatetime as $dtt_id => $datetime) {
+					$eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
+					$registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
+
+					if (isset($datetimes[ $dtt_id ])) {
+						continue; // already have this info in the datetimes array.
+					}
+
+					$datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
+					$datetimes[ $dtt_id ]['datetime']             = $datetime;
+					$datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
+					$datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
+				}
+			}
+
+			// let's loop through the unique event=>reg items and setup data on them
+
+			if (! empty($eventsetup)) {
+				foreach ($eventsetup as $evt_id => $items) {
+					$ticket_line_items_for_event = array();
+					if ($this->txn instanceof EE_Transaction) {
+						$ticket_line_items_for_event = EEM_Line_Item::instance()->get_all(
+							array(
+								array(
+									'Ticket.Datetime.EVT_ID' => $evt_id,
+									'TXN_ID'                 => $this->txn->ID(),
+								),
+								'default_where_conditions' => 'none',
+							)
+						);
+					}
+					$events[ $evt_id ] = array(
+						'ID'              => $evt_id,
+						'event'           => $evtcache[ $evt_id ],
+						'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
+						'total_attendees' => $event_attendee_count[ $evt_id ],
+						'reg_objs'        => $items['reg_objs'],
+						'tkt_objs'        => $items['tkt_objs'],
+						'att_objs'        => $items['att_objs'],
+						'dtt_objs'        => isset($items['dtt_objs']) ? $items['dtt_objs'] : array(),
+						'line_items'      => $ticket_line_items_for_event,
+					);
+
+					// make sure the tickets have the line items setup for them.
+					foreach ($ticket_line_items_for_event as $line_id => $line_item) {
+						// only add the ticket line items if we already have this ticket in the $tickets array.
+						if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
+							$tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
+							$tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
+							$line_items[ $line_item->ID() ]['children']              = $line_item->children();
+							$line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
+						}
+					}
+				}
+			}
+
+			$this->grand_total_line_item = $this->txn instanceof EE_Transaction
+				? $this->txn->total_line_item()
+				: null;
+		}
+
+		// lets set the attendees and events properties
+		$this->attendees                = $attendees;
+		$this->events                   = $events;
+		$this->tickets                  = $tickets;
+		$this->line_items_with_children = $line_items;
+		$this->datetimes                = $datetimes;
+		$this->questions                = $questions;
+		$this->answers                  = $answers;
+		$this->total_ticket_count       = $total_ticket_count;
+		$this->registrations            = $registrations;
+
+		if ($this->txn instanceof EE_Transaction) {
+			$this->tax_line_items        = $this->txn->tax_items();
+			$this->additional_line_items = $this->txn->non_ticket_line_items();
+			$this->payments              = $this->txn->payments();
+
+			// setup primary registration if we have a single transaction object to work with
+
+			// let's get just the primary_attendee_data!  First we get the primary registration object.
+			$primary_reg = $this->txn->primary_registration();
+			// verify
+			if ($primary_reg instanceof EE_Registration) {
+				// get attendee object
+				if ($primary_reg->attendee() instanceof EE_Attendee) {
+					// now we can setup the primary_attendee_data array
+					$this->primary_attendee_data = array(
+						'registration_id' => $primary_reg->ID(),
+						'att_obj'         => $primary_reg->attendee(),
+						'reg_obj'         => $primary_reg,
+						'primary_att_obj' => $primary_reg->attendee(),
+						'primary_reg_obj' => $primary_reg,
+					);
+				} else {
+					EE_Error::add_error(
+						esc_html__(
+							'Incoming data does not have a valid Attendee object for the primary registrant.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'Incoming data does not have a valid Registration object for the primary registrant.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+	/**
+	 * This simply considers whether the given registration should be processed or not based on comparison with the
+	 * filtered_reg_status property.
+	 *
+	 * @param EE_Registration $registration
+	 * @return bool  returning true means we DO want to skip processing.  returning false means we DON'T want to skip
+	 *               processing
+	 */
+	protected function _skip_registration_for_processing(EE_Registration $registration)
+	{
+		if (empty($this->filtered_reg_status)) {
+			return false;
+		}
+
+		// if we made it here then we just compare the filtered_reg_status with the registration status and return that
+		return $this->filtered_reg_status !== $registration->status_ID();
+	}
 }

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Spacing +26 added lines, -26 removed lines

@@ -74,7 +74,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+        if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
             EE_Registry::instance()->load_lib('PMT_Base');
             self::$_instance = new self();
         }
@@ -105,7 +105,7 @@ 
      */
     public function maybe_register_payment_methods($force_recheck = false)
     {
-        if (! $this->_payment_method_types || $force_recheck) {
+        if ( ! $this->_payment_method_types || $force_recheck) {
             $this->_register_payment_methods();
         }
     }
@@ -119,7 +119,7 @@ 
     protected function _register_payment_methods()
     {
         // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+        $pm_to_register = glob(EE_PAYMENT_METHODS.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $pm_to_register = apply_filters(
             'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
@@ -159,9 +159,9 @@ 
         // create class name from module directory name
         $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
         // add class prefix
-        $module_class = 'EE_PMT_' . $module;
+        $module_class = 'EE_PMT_'.$module;
         // does the module exist ?
-        if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
+        if ( ! is_readable($payment_method_path.'/'.$module_class.$module_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %s payment method file could not be found or is not readable due to file permissions.',
@@ -169,22 +169,22 @@ 
                 ),
                 $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($payment_method_path . '/' . $module_class . $module_ext);
+        require_once($payment_method_path.'/'.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        if ( ! class_exists($module_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s module class does not exist.', 'event_espresso'),
                 $module_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
+        $this->_payment_method_types[$module] = $payment_method_path.'/'.$module_class.$module_ext;
         ksort($this->_payment_method_types);
         return true;
     }
@@ -202,12 +202,12 @@ 
         if (
             $force_recheck
             || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
+            || ! isset($this->_payment_method_types[$payment_method_name])
         ) {
             $this->maybe_register_payment_methods($force_recheck);
         }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
+        if (isset($this->_payment_method_types[$payment_method_name])) {
+            require_once($this->_payment_method_types[$payment_method_name]);
             return true;
         }
         return false;
@@ -249,8 +249,8 @@ 
         if ($force_recheck || empty($this->payment_method_objects)) {
             $this->maybe_register_payment_methods($force_recheck);
             foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname();
+                if ( ! isset($this->payment_method_objects[$classname])) {
+                    $this->payment_method_objects[$classname] = new $classname();
                 }
             }
         }
@@ -279,7 +279,7 @@ 
      */
     public function payment_method_class_from_type($type)
     {
-        return 'EE_PMT_' . $type;
+        return 'EE_PMT_'.$type;
     }
 
 
@@ -295,13 +295,13 @@ 
     {
         $this->maybe_register_payment_methods();
         $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
             if (class_exists($pm_type_class)) {
                 /** @var $pm_type_obj EE_PMT_Base */
                 $pm_type_obj = new $pm_type_class();
                 $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
+                if ( ! $payment_method) {
                     $payment_method = $this->create_payment_method_of_type($pm_type_obj);
                 }
                 $payment_method->set_type($payment_method_type);
@@ -338,7 +338,7 @@ 
                         'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+                    '<a href="'.admin_url('admin.php?page=espresso_messages&action=settings').'">',
                     '</a>'
                 ),
                 true
@@ -364,7 +364,7 @@ 
                 'PMD_type'       => $pm_type_obj->system_name(),
                 'PMD_name'       => $pm_type_obj->defaultFrontendName(),
                 'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+                'PMD_slug'       => $pm_type_obj->system_name(), // automatically converted to slug
                 'PMD_wp_user'    => $current_user->ID,
                 'PMD_order'      => EEM_Payment_Method::instance()->count(
                     array(array('PMD_type' => array('!=', 'Admin_Only')))
@@ -386,14 +386,14 @@ 
     {
         $pm_type_obj = $payment_method->type_obj();
         $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
+        if ( ! $payment_method->button_url()) {
             $payment_method->set_button_url($pm_type_obj->default_button_url());
         }
         // now add setup its default extra meta properties
         $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
+        if ( ! empty($extra_metas)) {
             // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
+            if ( ! $payment_method->ID()) {
                 $payment_method->save();
             }
             foreach ($extra_metas as $meta_name => $input) {
@@ -536,10 +536,10 @@ 
                 )
             );
         }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = array();
+        if ( ! isset($payment_method_caps[$role])) {
+            $payment_method_caps[$role] = array();
         }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+        $payment_method_caps[$role][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
                                           . strtolower($payment_method_name);
         return $payment_method_caps;
     }

Indentation +557 added lines, -557 removed lines

@@ -16,561 +16,561 @@
  */
 class EE_Payment_Method_Manager implements ResettableInterface
 {
-    /**
-     * prefix added to all payment method capabilities names
-     */
-    const   CAPABILITIES_PREFIX = 'ee_payment_method_';
-
-    /**
-     * @var EE_Payment_Method_Manager $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean
-     */
-    protected $payment_method_caps_initialized = false;
-
-    /**
-     * @var array keys are class names without 'EE_PMT_', values are their filepaths
-     */
-    protected $_payment_method_types = array();
-
-    /**
-     * @var EE_PMT_Base[]
-     */
-    protected $payment_method_objects = array();
-
-
-    /**
-     * EE_Payment_Method_Manager constructor.
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        // if in admin lets ensure caps are set.
-        if (is_admin()) {
-            $this->_register_payment_methods();
-            // set them immediately
-            $this->initializePaymentMethodCaps();
-            // plus any time they get reset
-            add_filter(
-                'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-                array($this, 'addPaymentMethodCapsDuringReset')
-            );
-        }
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Payment_Method_Manager instance
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
-            EE_Registry::instance()->load_lib('PMT_Base');
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the instance and returns a new one
-     *
-     * @return EE_Payment_Method_Manager
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * If necessary, re-register payment methods
-     *
-     * @param boolean $force_recheck whether to recheck for payment method types,
-     *                               or just re-use the PMTs we found last time we checked during this request (if
-     *                               we have not yet checked during this request, then we need to check anyways)
-     */
-    public function maybe_register_payment_methods($force_recheck = false)
-    {
-        if (! $this->_payment_method_types || $force_recheck) {
-            $this->_register_payment_methods();
-        }
-    }
-
-
-    /**
-     * register_payment_methods
-     *
-     * @return array
-     */
-    protected function _register_payment_methods()
-    {
-        // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $pm_to_register = apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            $pm_to_register
-        );
-        // remove any duplicates if that should happen for some reason
-        $pm_to_register = array_unique($pm_to_register);
-        // loop through folders
-        foreach ($pm_to_register as $pm_path) {
-            $this->register_payment_method($pm_path);
-        }
-        do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
-        // filter list of installed modules
-        // keep them organized alphabetically by the payment method type's name
-        ksort($this->_payment_method_types);
-        return apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
-            $this->_payment_method_types
-        );
-    }
-
-
-    /**
-     * register_payment_method- makes core aware of this payment method
-     *
-     * @param string $payment_method_path - full path up to and including payment method folder
-     * @return boolean
-     */
-    public function register_payment_method($payment_method_path = '')
-    {
-        do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
-        $module_ext = '.pm.php';
-        // make all separators match
-        $payment_method_path = rtrim(str_replace('/\\', '/', $payment_method_path), '/');
-        // grab and sanitize module name
-        $module_dir = basename($payment_method_path);
-        // create class name from module directory name
-        $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
-        // add class prefix
-        $module_class = 'EE_PMT_' . $module;
-        // does the module exist ?
-        if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s payment method file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($payment_method_path . '/' . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s module class does not exist.', 'event_espresso'),
-                $module_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
-        ksort($this->_payment_method_types);
-        return true;
-    }
-
-
-    /**
-     * Checks if a payment method has been registered, and if so includes it
-     *
-     * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
-     * @param boolean $force_recheck       whether to force re-checking for new payment method types
-     * @return boolean
-     */
-    public function payment_method_type_exists($payment_method_name, $force_recheck = false)
-    {
-        if (
-            $force_recheck
-            || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
-        ) {
-            $this->maybe_register_payment_methods($force_recheck);
-        }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns all the class names of the various payment method types
-     *
-     * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
-     *                               (what you'd find in wp_esp_payment_method.PMD_type)
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return array
-     */
-    public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        if ($with_prefixes) {
-            $classnames = array_keys($this->_payment_method_types);
-            $payment_methods = array();
-            foreach ($classnames as $classname) {
-                $payment_methods[] = $this->payment_method_class_from_type($classname);
-            }
-            return $payment_methods;
-        }
-        return array_keys($this->_payment_method_types);
-    }
-
-
-    /**
-     * Gets an object of each payment method type, none of which are bound to a
-     * payment method instance
-     *
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return EE_PMT_Base[]
-     */
-    public function payment_method_types($force_recheck = false)
-    {
-        if ($force_recheck || empty($this->payment_method_objects)) {
-            $this->maybe_register_payment_methods($force_recheck);
-            foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname();
-                }
-            }
-        }
-        return $this->payment_method_objects;
-    }
-
-
-    /**
-     * Changes the payment method's class name into the payment method type's name
-     * (as used on the payment method's table's PMD_type field)
-     *
-     * @param string $classname
-     * @return string
-     */
-    public function payment_method_type_sans_class_prefix($classname)
-    {
-        return str_replace('EE_PMT_', '', $classname);
-    }
-
-
-    /**
-     * Does the opposite of payment-method_type_sans_prefix
-     *
-     * @param string $type
-     * @return string
-     */
-    public function payment_method_class_from_type($type)
-    {
-        return 'EE_PMT_' . $type;
-    }
-
-
-    /**
-     * Activates a payment method of the given type.
-     *
-     * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
-     * @return EE_Payment_Method
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function activate_a_payment_method_of_type($payment_method_type)
-    {
-        $this->maybe_register_payment_methods();
-        $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
-            $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-            if (class_exists($pm_type_class)) {
-                /** @var $pm_type_obj EE_PMT_Base */
-                $pm_type_obj = new $pm_type_class();
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
-                    $payment_method = $this->create_payment_method_of_type($pm_type_obj);
-                }
-                $payment_method->set_type($payment_method_type);
-                $this->initialize_payment_method($payment_method);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is no payment method of type %1$s, so it could not be activated',
-                            'event_espresso'
-                        ),
-                        $pm_type_class
-                    )
-                );
-            }
-        }
-        $payment_method->set_active();
-        $payment_method->save();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        // if this was the invoice message type, make sure users can view their invoices
-        if (
-            $payment_method->type() === 'Invoice'
-            && (
-            ! EEH_MSG_Template::is_mt_active('invoice')
-            )
-        ) {
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            /** @type EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager->ensure_message_type_is_active('invoice', 'html');
-            new PersistentAdminNotice(
-                'invoice_pm_requirements_notice',
-                sprintf(
-                    esc_html__(
-                        'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
-                    '</a>'
-                ),
-                true
-            );
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Creates a payment method of the specified type. Does not save it.
-     *
-     * @global WP_User    $current_user
-     * @param EE_PMT_Base $pm_type_obj
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function create_payment_method_of_type($pm_type_obj)
-    {
-        global $current_user;
-        $payment_method = EE_Payment_Method::new_instance(
-            array(
-                'PMD_type'       => $pm_type_obj->system_name(),
-                'PMD_name'       => $pm_type_obj->defaultFrontendName(),
-                'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
-                'PMD_wp_user'    => $current_user->ID,
-                'PMD_order'      => EEM_Payment_Method::instance()->count(
-                    array(array('PMD_type' => array('!=', 'Admin_Only')))
-                ) * 10,
-            )
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Sets the initial payment method properties (including extra meta)
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function initialize_payment_method($payment_method)
-    {
-        $pm_type_obj = $payment_method->type_obj();
-        $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
-            $payment_method->set_button_url($pm_type_obj->default_button_url());
-        }
-        // now add setup its default extra meta properties
-        $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
-            // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
-                $payment_method->save();
-            }
-            foreach ($extra_metas as $meta_name => $input) {
-                $payment_method->update_extra_meta($meta_name, $input->raw_value());
-            }
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Makes sure the payment method is related to the specified payment method
-     *
-     * @deprecated in 4.9.40 because the currency payment method table is being deprecated
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function set_usable_currencies_on_payment_method($payment_method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
-            esc_html__(
-                'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
-                'event_espresso'
-            ),
-            '4.9.40'
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Deactivates a payment method of the given payment method slug.
-     *
-     * @param string $payment_method_slug The slug for the payment method to deactivate.
-     * @return int count of rows updated.
-     * @throws EE_Error
-     */
-    public function deactivate_payment_method($payment_method_slug)
-    {
-        EE_Log::instance()->log(
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Payment method with slug %1$s is being deactivated by site admin',
-                    'event_espresso'
-                ),
-                $payment_method_slug
-            ),
-            'payment_method_change'
-        );
-        $count_updated = EEM_Payment_Method::instance()->update(
-            array('PMD_scope' => array()),
-            array(array('PMD_slug' => $payment_method_slug))
-        );
-        do_action(
-            'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
-            $payment_method_slug,
-            $count_updated
-        );
-        return $count_updated;
-    }
-
-
-    /**
-     * initializes payment method access caps via EE_Capabilities::init_role_caps()
-     * upon EE_Payment_Method_Manager construction
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    protected function initializePaymentMethodCaps()
-    {
-        // don't do this twice
-        if ($this->payment_method_caps_initialized) {
-            return;
-        }
-        EE_Capabilities::instance()->addCaps(
-            $this->getPaymentMethodCaps()
-        );
-        $this->payment_method_caps_initialized = true;
-    }
-
-
-    /**
-     * array  of dynamic payment method access caps.
-     * at the time of writing, october 20 2014, these are the caps added:
-     *  ee_payment_method_admin_only
-     *  ee_payment_method_aim
-     *  ee_payment_method_bank
-     *  ee_payment_method_check
-     *  ee_payment_method_invoice
-     *  ee_payment_method_mijireh
-     *  ee_payment_method_paypal_pro
-     *  ee_payment_method_paypal_standard
-     * Any other payment methods added to core or via addons will also get
-     * their related capability automatically added too, so long as they are
-     * registered properly using EE_Register_Payment_Method::register()
-     *
-     * @return array
-     * @throws DomainException
-     */
-    protected function getPaymentMethodCaps()
-    {
-        $caps = array();
-        foreach ($this->payment_method_type_names() as $payment_method_name) {
-            $caps = $this->addPaymentMethodCap($payment_method_name, $caps);
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @param string $payment_method_name
-     * @param array  $payment_method_caps
-     * @param string $role
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCap($payment_method_name, array $payment_method_caps, $role = 'administrator')
-    {
-        if (empty($payment_method_name)) {
-            throw new DomainException(
-                esc_html__(
-                    'The name of a payment method must be specified to add capabilities.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (empty($role)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'No role was supplied while trying to add capabilities for the %1$s payment method.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = array();
-        }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
-                                          . strtolower($payment_method_name);
-        return $payment_method_caps;
-    }
-
-
-    /**
-     * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
-     * to add dynamic payment method access caps when capabilities are reset
-     * (or if that filter is called and PM caps are not already set)
-     *
-     * @param array $caps capabilities being filtered
-     * @param bool  $reset
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCapsDuringReset(array $caps, $reset = false)
-    {
-        if ($reset || ! $this->payment_method_caps_initialized) {
-            $this->payment_method_caps_initialized = true;
-            $caps = array_merge_recursive($caps, $this->getPaymentMethodCaps());
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @deprecated 4.9.42
-     * @param $caps
-     * @return mixed
-     */
-    public function add_payment_method_caps($caps)
-    {
-        return $caps;
-    }
+	/**
+	 * prefix added to all payment method capabilities names
+	 */
+	const   CAPABILITIES_PREFIX = 'ee_payment_method_';
+
+	/**
+	 * @var EE_Payment_Method_Manager $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean
+	 */
+	protected $payment_method_caps_initialized = false;
+
+	/**
+	 * @var array keys are class names without 'EE_PMT_', values are their filepaths
+	 */
+	protected $_payment_method_types = array();
+
+	/**
+	 * @var EE_PMT_Base[]
+	 */
+	protected $payment_method_objects = array();
+
+
+	/**
+	 * EE_Payment_Method_Manager constructor.
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		// if in admin lets ensure caps are set.
+		if (is_admin()) {
+			$this->_register_payment_methods();
+			// set them immediately
+			$this->initializePaymentMethodCaps();
+			// plus any time they get reset
+			add_filter(
+				'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+				array($this, 'addPaymentMethodCapsDuringReset')
+			);
+		}
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Payment_Method_Manager instance
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+			EE_Registry::instance()->load_lib('PMT_Base');
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the instance and returns a new one
+	 *
+	 * @return EE_Payment_Method_Manager
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * If necessary, re-register payment methods
+	 *
+	 * @param boolean $force_recheck whether to recheck for payment method types,
+	 *                               or just re-use the PMTs we found last time we checked during this request (if
+	 *                               we have not yet checked during this request, then we need to check anyways)
+	 */
+	public function maybe_register_payment_methods($force_recheck = false)
+	{
+		if (! $this->_payment_method_types || $force_recheck) {
+			$this->_register_payment_methods();
+		}
+	}
+
+
+	/**
+	 * register_payment_methods
+	 *
+	 * @return array
+	 */
+	protected function _register_payment_methods()
+	{
+		// grab list of installed modules
+		$pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$pm_to_register = apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			$pm_to_register
+		);
+		// remove any duplicates if that should happen for some reason
+		$pm_to_register = array_unique($pm_to_register);
+		// loop through folders
+		foreach ($pm_to_register as $pm_path) {
+			$this->register_payment_method($pm_path);
+		}
+		do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
+		// filter list of installed modules
+		// keep them organized alphabetically by the payment method type's name
+		ksort($this->_payment_method_types);
+		return apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
+			$this->_payment_method_types
+		);
+	}
+
+
+	/**
+	 * register_payment_method- makes core aware of this payment method
+	 *
+	 * @param string $payment_method_path - full path up to and including payment method folder
+	 * @return boolean
+	 */
+	public function register_payment_method($payment_method_path = '')
+	{
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
+		$module_ext = '.pm.php';
+		// make all separators match
+		$payment_method_path = rtrim(str_replace('/\\', '/', $payment_method_path), '/');
+		// grab and sanitize module name
+		$module_dir = basename($payment_method_path);
+		// create class name from module directory name
+		$module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
+		// add class prefix
+		$module_class = 'EE_PMT_' . $module;
+		// does the module exist ?
+		if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s payment method file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($payment_method_path . '/' . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s module class does not exist.', 'event_espresso'),
+				$module_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		$this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
+		ksort($this->_payment_method_types);
+		return true;
+	}
+
+
+	/**
+	 * Checks if a payment method has been registered, and if so includes it
+	 *
+	 * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
+	 * @param boolean $force_recheck       whether to force re-checking for new payment method types
+	 * @return boolean
+	 */
+	public function payment_method_type_exists($payment_method_name, $force_recheck = false)
+	{
+		if (
+			$force_recheck
+			|| ! is_array($this->_payment_method_types)
+			|| ! isset($this->_payment_method_types[ $payment_method_name ])
+		) {
+			$this->maybe_register_payment_methods($force_recheck);
+		}
+		if (isset($this->_payment_method_types[ $payment_method_name ])) {
+			require_once($this->_payment_method_types[ $payment_method_name ]);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns all the class names of the various payment method types
+	 *
+	 * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
+	 *                               (what you'd find in wp_esp_payment_method.PMD_type)
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return array
+	 */
+	public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		if ($with_prefixes) {
+			$classnames = array_keys($this->_payment_method_types);
+			$payment_methods = array();
+			foreach ($classnames as $classname) {
+				$payment_methods[] = $this->payment_method_class_from_type($classname);
+			}
+			return $payment_methods;
+		}
+		return array_keys($this->_payment_method_types);
+	}
+
+
+	/**
+	 * Gets an object of each payment method type, none of which are bound to a
+	 * payment method instance
+	 *
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return EE_PMT_Base[]
+	 */
+	public function payment_method_types($force_recheck = false)
+	{
+		if ($force_recheck || empty($this->payment_method_objects)) {
+			$this->maybe_register_payment_methods($force_recheck);
+			foreach ($this->payment_method_type_names(true) as $classname) {
+				if (! isset($this->payment_method_objects[ $classname ])) {
+					$this->payment_method_objects[ $classname ] = new $classname();
+				}
+			}
+		}
+		return $this->payment_method_objects;
+	}
+
+
+	/**
+	 * Changes the payment method's class name into the payment method type's name
+	 * (as used on the payment method's table's PMD_type field)
+	 *
+	 * @param string $classname
+	 * @return string
+	 */
+	public function payment_method_type_sans_class_prefix($classname)
+	{
+		return str_replace('EE_PMT_', '', $classname);
+	}
+
+
+	/**
+	 * Does the opposite of payment-method_type_sans_prefix
+	 *
+	 * @param string $type
+	 * @return string
+	 */
+	public function payment_method_class_from_type($type)
+	{
+		return 'EE_PMT_' . $type;
+	}
+
+
+	/**
+	 * Activates a payment method of the given type.
+	 *
+	 * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
+	 * @return EE_Payment_Method
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function activate_a_payment_method_of_type($payment_method_type)
+	{
+		$this->maybe_register_payment_methods();
+		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
+		if (! $payment_method instanceof EE_Payment_Method) {
+			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
+			if (class_exists($pm_type_class)) {
+				/** @var $pm_type_obj EE_PMT_Base */
+				$pm_type_obj = new $pm_type_class();
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
+				if (! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
+				}
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is no payment method of type %1$s, so it could not be activated',
+							'event_espresso'
+						),
+						$pm_type_class
+					)
+				);
+			}
+		}
+		$payment_method->set_active();
+		$payment_method->save();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		// if this was the invoice message type, make sure users can view their invoices
+		if (
+			$payment_method->type() === 'Invoice'
+			&& (
+			! EEH_MSG_Template::is_mt_active('invoice')
+			)
+		) {
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			/** @type EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager->ensure_message_type_is_active('invoice', 'html');
+			new PersistentAdminNotice(
+				'invoice_pm_requirements_notice',
+				sprintf(
+					esc_html__(
+						'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+					'</a>'
+				),
+				true
+			);
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Creates a payment method of the specified type. Does not save it.
+	 *
+	 * @global WP_User    $current_user
+	 * @param EE_PMT_Base $pm_type_obj
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function create_payment_method_of_type($pm_type_obj)
+	{
+		global $current_user;
+		$payment_method = EE_Payment_Method::new_instance(
+			array(
+				'PMD_type'       => $pm_type_obj->system_name(),
+				'PMD_name'       => $pm_type_obj->defaultFrontendName(),
+				'PMD_admin_name' => $pm_type_obj->pretty_name(),
+				'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+				'PMD_wp_user'    => $current_user->ID,
+				'PMD_order'      => EEM_Payment_Method::instance()->count(
+					array(array('PMD_type' => array('!=', 'Admin_Only')))
+				) * 10,
+			)
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Sets the initial payment method properties (including extra meta)
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function initialize_payment_method($payment_method)
+	{
+		$pm_type_obj = $payment_method->type_obj();
+		$payment_method->set_description($pm_type_obj->default_description());
+		if (! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
+		}
+		// now add setup its default extra meta properties
+		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
+		if (! empty($extra_metas)) {
+			// verify the payment method has an ID before adding extra meta
+			if (! $payment_method->ID()) {
+				$payment_method->save();
+			}
+			foreach ($extra_metas as $meta_name => $input) {
+				$payment_method->update_extra_meta($meta_name, $input->raw_value());
+			}
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Makes sure the payment method is related to the specified payment method
+	 *
+	 * @deprecated in 4.9.40 because the currency payment method table is being deprecated
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function set_usable_currencies_on_payment_method($payment_method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
+			esc_html__(
+				'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
+				'event_espresso'
+			),
+			'4.9.40'
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Deactivates a payment method of the given payment method slug.
+	 *
+	 * @param string $payment_method_slug The slug for the payment method to deactivate.
+	 * @return int count of rows updated.
+	 * @throws EE_Error
+	 */
+	public function deactivate_payment_method($payment_method_slug)
+	{
+		EE_Log::instance()->log(
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Payment method with slug %1$s is being deactivated by site admin',
+					'event_espresso'
+				),
+				$payment_method_slug
+			),
+			'payment_method_change'
+		);
+		$count_updated = EEM_Payment_Method::instance()->update(
+			array('PMD_scope' => array()),
+			array(array('PMD_slug' => $payment_method_slug))
+		);
+		do_action(
+			'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
+			$payment_method_slug,
+			$count_updated
+		);
+		return $count_updated;
+	}
+
+
+	/**
+	 * initializes payment method access caps via EE_Capabilities::init_role_caps()
+	 * upon EE_Payment_Method_Manager construction
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	protected function initializePaymentMethodCaps()
+	{
+		// don't do this twice
+		if ($this->payment_method_caps_initialized) {
+			return;
+		}
+		EE_Capabilities::instance()->addCaps(
+			$this->getPaymentMethodCaps()
+		);
+		$this->payment_method_caps_initialized = true;
+	}
+
+
+	/**
+	 * array  of dynamic payment method access caps.
+	 * at the time of writing, october 20 2014, these are the caps added:
+	 *  ee_payment_method_admin_only
+	 *  ee_payment_method_aim
+	 *  ee_payment_method_bank
+	 *  ee_payment_method_check
+	 *  ee_payment_method_invoice
+	 *  ee_payment_method_mijireh
+	 *  ee_payment_method_paypal_pro
+	 *  ee_payment_method_paypal_standard
+	 * Any other payment methods added to core or via addons will also get
+	 * their related capability automatically added too, so long as they are
+	 * registered properly using EE_Register_Payment_Method::register()
+	 *
+	 * @return array
+	 * @throws DomainException
+	 */
+	protected function getPaymentMethodCaps()
+	{
+		$caps = array();
+		foreach ($this->payment_method_type_names() as $payment_method_name) {
+			$caps = $this->addPaymentMethodCap($payment_method_name, $caps);
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @param string $payment_method_name
+	 * @param array  $payment_method_caps
+	 * @param string $role
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCap($payment_method_name, array $payment_method_caps, $role = 'administrator')
+	{
+		if (empty($payment_method_name)) {
+			throw new DomainException(
+				esc_html__(
+					'The name of a payment method must be specified to add capabilities.',
+					'event_espresso'
+				)
+			);
+		}
+		if (empty($role)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'No role was supplied while trying to add capabilities for the %1$s payment method.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+		if (! isset($payment_method_caps[ $role ])) {
+			$payment_method_caps[ $role ] = array();
+		}
+		$payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+										  . strtolower($payment_method_name);
+		return $payment_method_caps;
+	}
+
+
+	/**
+	 * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
+	 * to add dynamic payment method access caps when capabilities are reset
+	 * (or if that filter is called and PM caps are not already set)
+	 *
+	 * @param array $caps capabilities being filtered
+	 * @param bool  $reset
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCapsDuringReset(array $caps, $reset = false)
+	{
+		if ($reset || ! $this->payment_method_caps_initialized) {
+			$this->payment_method_caps_initialized = true;
+			$caps = array_merge_recursive($caps, $this->getPaymentMethodCaps());
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @deprecated 4.9.42
+	 * @param $caps
+	 * @return mixed
+	 */
+	public function add_payment_method_caps($caps)
+	{
+		return $caps;
+	}
 }

core/libraries/shortcodes/EE_Recipient_Details_Shortcodes.lib.php

Spacing +9 added lines, -9 removed lines

@@ -116,17 +116,17 @@ 
             ? $this->_extra_data['data']
             : $this->_recipient;
 
-        if (! $this->_recipient instanceof EE_Messages_Addressee) {
+        if ( ! $this->_recipient instanceof EE_Messages_Addressee) {
             return '';
         }
 
         $attendee = $this->_recipient->att_obj;
-        if (! $attendee instanceof EE_Attendee) {
+        if ( ! $attendee instanceof EE_Attendee) {
             return '';
         }
 
-        $this->_registrations_for_recipient = isset($this->_recipient->attendees[ $attendee->ID() ]['reg_objs'])
-            ? $this->_recipient->attendees[ $attendee->ID() ]['reg_objs']
+        $this->_registrations_for_recipient = isset($this->_recipient->attendees[$attendee->ID()]['reg_objs'])
+            ? $this->_recipient->attendees[$attendee->ID()]['reg_objs']
             : array();
 
         switch ($shortcode) {
@@ -143,21 +143,21 @@ 
                 break;
 
             case '[RECIPIENT_REGISTRATION_ID]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+                if ( ! $this->_recipient->reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $this->_get_reg_id();
                 break;
 
             case '[RECIPIENT_REGISTRATION_CODE]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+                if ( ! $this->_recipient->reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $this->_get_reg_code();
                 break;
 
             case '[RECIPIENT_EDIT_REGISTRATION_LINK]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+                if ( ! $this->_recipient->reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $this->_recipient->reg_obj->edit_attendee_information_url();
@@ -213,9 +213,9 @@ 
                 if (
                     $question instanceof EE_Question
                     && trim($question->display_text()) === trim($shortcode)
-                    && isset($this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ])
+                    && isset($this->_recipient->registrations[$this->_recipient->reg_obj->ID()]['ans_objs'][$ansid])
                 ) {
-                    $recipient_ansid = $this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ];
+                    $recipient_ansid = $this->_recipient->registrations[$this->_recipient->reg_obj->ID()]['ans_objs'][$ansid];
 
                     // what we show for the answer depends on the question type!
                     switch ($question->get('QST_type')) {

Indentation +351 added lines, -351 removed lines

@@ -18,355 +18,355 @@
  */
 class EE_Recipient_Details_Shortcodes extends EE_Shortcodes
 {
-    protected $_recipient;
-
-    protected $_registrations_for_recipient;
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Recipient Details Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to recipient registration data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[RECIPIENT_FNAME]'                  => esc_html__(
-                'Parses to the first name of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_LNAME]'                  => esc_html__(
-                'Parses to the last name of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_EMAIL]'                  => esc_html__(
-                'Parses to the email address of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_REGISTRATION_ID]'        => esc_html__(
-                'Parses to the registration ID of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_REGISTRATION_CODE]'      => esc_html__(
-                'Parses to the registration code of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_EDIT_REGISTRATION_LINK]' => esc_html__(
-                'Parses to a link for frontend editing of the registration for the recipient.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_PHONE_NUMBER]'           => esc_html__(
-                'The Phone Number for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ADDRESS]'                => esc_html__(
-                'The Address for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ADDRESS2]'               => esc_html__(
-                'Whatever was in the address 2 field for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_CITY]'                   => esc_html__(
-                'The city for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ZIP_PC]'                 => esc_html__(
-                'The ZIP (or Postal) Code for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ADDRESS_STATE]'          => esc_html__(
-                'The state/province for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_COUNTRY]'                => esc_html__(
-                'The country for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ANSWER_*]'               => esc_html__(
-                'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this recipient, then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_TOTAL_AMOUNT_PAID]'      => esc_html__(
-                'If a single registration related to the recipient is available, that is used to retrieve the total amount that has been paid for this recipient.  Otherwise the value of 0 is printed.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    /**
-     * @access protected
-     * @param  string $shortcode the shortcode to be parsed.
-     * @return string parsed shortcode
-     */
-    protected function _parser($shortcode)
-    {
-
-        // make sure we end up with a copy of the EE_Messages_Addressee object
-        $this->_recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
-                            && is_array($this->_data)
-                            && isset($this->_data['data'])
-                            && $this->_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_data['data']
-            :
-            $this->_recipient;
-        $this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
-                            && ! empty($this->_extra_data['data'])
-                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']
-            : $this->_recipient;
-
-        if (! $this->_recipient instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        $attendee = $this->_recipient->att_obj;
-        if (! $attendee instanceof EE_Attendee) {
-            return '';
-        }
-
-        $this->_registrations_for_recipient = isset($this->_recipient->attendees[ $attendee->ID() ]['reg_objs'])
-            ? $this->_recipient->attendees[ $attendee->ID() ]['reg_objs']
-            : array();
-
-        switch ($shortcode) {
-            case '[RECIPIENT_FNAME]':
-                return $attendee->fname();
-                break;
-
-            case '[RECIPIENT_LNAME]':
-                return $attendee->lname();
-                break;
-
-            case '[RECIPIENT_EMAIL]':
-                return $attendee->email();
-                break;
-
-            case '[RECIPIENT_REGISTRATION_ID]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $this->_get_reg_id();
-                break;
-
-            case '[RECIPIENT_REGISTRATION_CODE]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $this->_get_reg_code();
-                break;
-
-            case '[RECIPIENT_EDIT_REGISTRATION_LINK]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $this->_recipient->reg_obj->edit_attendee_information_url();
-                break;
-
-            case '[RECIPIENT_PHONE_NUMBER]':
-                return $attendee->phone();
-                break;
-
-            case '[RECIPIENT_ADDRESS]':
-                return $attendee->address();
-                break;
-
-            case '[RECIPIENT_ADDRESS2]':
-                return $attendee->address2();
-                break;
-
-            case '[RECIPIENT_CITY]':
-                return $attendee->city();
-                break;
-
-            case '[RECIPIENT_ZIP_PC]':
-                return $attendee->zip();
-                break;
-
-            case '[RECIPIENT_ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-                break;
-
-            case '[RECIPIENT_COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-                break;
-            case '[RECIPIENT_TOTAL_AMOUNT_PAID]':
-                return $this->_recipient->reg_obj instanceof EE_Registration
-                    ? $this->_recipient->reg_obj->pretty_paid()
-                    : 0;
-                break;
-        }
-
-        if (strpos($shortcode, '[RECIPIENT_ANSWER_*') !== false) {
-            $shortcode = str_replace('[RECIPIENT_ANSWER_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-
-            // now let's figure out what question has this text
-            if (empty($this->_recipient->questions) || ! $this->_recipient->reg_obj instanceof EE_Registration) {
-                return '';
-            }
-
-            foreach ($this->_recipient->questions as $ansid => $question) {
-                if (
-                    $question instanceof EE_Question
-                    && trim($question->display_text()) === trim($shortcode)
-                    && isset($this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ])
-                ) {
-                    $recipient_ansid = $this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ];
-
-                    // what we show for the answer depends on the question type!
-                    switch ($question->get('QST_type')) {
-                        case EEM_Question::QST_type_state:
-                            $state = EEM_State::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
-                            $answer = $state instanceof EE_State ? $state->name() : '';
-                            break;
-
-                        case EEM_Question::QST_type_country:
-                            $country = EEM_Country::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
-                            $answer = $country instanceof EE_Country ? $country->name() : '';
-                            break;
-
-                        default:
-                            $answer = $recipient_ansid->get_pretty('ANS_value', 'no_wpautop');
-                            break;
-                    }
-
-                    return $answer;
-                    break;
-                }
-            }
-        }
-
-        return '';
-    }
-
-
-    /**
-     * Returns the EE_Messages_Addressee object for the recipient.
-     *
-     * @since 4.5.0
-     *
-     * @return EE_Messages_Addressee
-     */
-    public function get_recipient()
-    {
-        return $this->_recipient;
-    }
-
-
-    /**
-     * returns the reg code for the recipient depending on the context and whether the recipient has multiple
-     * registrations or not.
-     *
-     * @return string
-     */
-    protected function _get_reg_code()
-    {
-
-        // if only one related registration for the recipient then just return that reg code.
-        if (count($this->_registrations_for_recipient) <= 1) {
-            return $this->_recipient->reg_obj->reg_code();
-        }
-
-        // k more than one registration so let's see if we can get specific to context
-        // are we parsing event_list?
-        if ($this->_data instanceof EE_Event) {
-            $reg_code = array();
-            // loop through registrations for recipient and see if there is a match for this event
-            foreach ($this->_registrations_for_recipient as $reg) {
-                if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
-                    $reg_code[] = $reg->reg_code();
-                }
-            }
-            return implode(', ', $reg_code);
-        }
-
-        // are we parsing ticket list?
-        if ($this->_data instanceof EE_Ticket) {
-            $reg_code = array();
-            // loop through each registration for recipient and see if there is a match for this ticket
-            foreach ($this->_registrations_for_recipient as $reg) {
-                if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
-                    $reg_code = $reg->reg_code();
-                }
-            }
-            return implode(', ', $reg_code);
-        }
-
-        // do we have a specific reg_obj?  Let's use it
-        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
-            return $this->_data->reg_obj->reg_code();
-        }
-
-        // do we have a specific reg_obj?  Let's use it
-        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
-            return $this->_data->reg_obj->reg_code();
-        }
-
-        // not able to determine the single reg code so let's return a comma delimited list of reg codes.
-        $reg_code = array();
-        foreach ($this->_registrations_for_recipient as $reg) {
-            if ($reg instanceof EE_Registration) {
-                $reg_code[] = $reg->reg_code();
-            }
-        }
-        return implode(', ', $reg_code);
-    }
-
-
-    /**
-     * returns the reg ID for the recipient depending on the context and whether the recipient has multiple
-     * registrations or not.
-     *
-     * @return int|string
-     */
-    protected function _get_reg_id()
-    {
-
-        // if only one related registration for the recipient then just return that reg code.
-        if (count($this->_registrations_for_recipient) <= 1) {
-            return $this->_recipient->reg_obj->ID();
-        }
-
-        // k more than one registration so let's see if we can get specific to context
-        // are we parsing event_list?
-        if ($this->_data instanceof EE_Event) {
-            $registration_ids = array();
-            // loop through registrations for recipient and see if there is a match for this event
-            foreach ($this->_registrations_for_recipient as $reg) {
-                if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
-                    $registration_ids[] = $reg->ID();
-                }
-            }
-            return implode(', ', $registration_ids);
-        }
-
-        // are we parsing ticket list?
-        if ($this->_data instanceof EE_Ticket) {
-            $registration_ids = array();
-            // loop through each registration for recipient and see if there is a match for this ticket
-            foreach ($this->_registrations_for_recipient as $reg) {
-                if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
-                    $registration_ids = $reg->ID();
-                }
-            }
-            return implode(', ', $registration_ids);
-        }
-
-        // do we have a specific reg_obj?  Let's use it
-        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
-            return $this->_data->reg_obj->ID();
-        }
-
-        // not able to determine the single reg code so let's return a comma delimited list of reg codes.
-        $registration_ids = array();
-        foreach ($this->_registrations_for_recipient as $reg) {
-            if ($reg instanceof EE_Registration) {
-                $registration_ids[] = $reg->ID();
-            }
-        }
-        return implode(', ', $registration_ids);
-    }
+	protected $_recipient;
+
+	protected $_registrations_for_recipient;
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Recipient Details Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to recipient registration data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[RECIPIENT_FNAME]'                  => esc_html__(
+				'Parses to the first name of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_LNAME]'                  => esc_html__(
+				'Parses to the last name of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_EMAIL]'                  => esc_html__(
+				'Parses to the email address of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_REGISTRATION_ID]'        => esc_html__(
+				'Parses to the registration ID of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_REGISTRATION_CODE]'      => esc_html__(
+				'Parses to the registration code of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_EDIT_REGISTRATION_LINK]' => esc_html__(
+				'Parses to a link for frontend editing of the registration for the recipient.',
+				'event_espresso'
+			),
+			'[RECIPIENT_PHONE_NUMBER]'           => esc_html__(
+				'The Phone Number for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ADDRESS]'                => esc_html__(
+				'The Address for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ADDRESS2]'               => esc_html__(
+				'Whatever was in the address 2 field for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_CITY]'                   => esc_html__(
+				'The city for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ZIP_PC]'                 => esc_html__(
+				'The ZIP (or Postal) Code for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ADDRESS_STATE]'          => esc_html__(
+				'The state/province for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_COUNTRY]'                => esc_html__(
+				'The country for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ANSWER_*]'               => esc_html__(
+				'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this recipient, then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+			'[RECIPIENT_TOTAL_AMOUNT_PAID]'      => esc_html__(
+				'If a single registration related to the recipient is available, that is used to retrieve the total amount that has been paid for this recipient.  Otherwise the value of 0 is printed.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	/**
+	 * @access protected
+	 * @param  string $shortcode the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 */
+	protected function _parser($shortcode)
+	{
+
+		// make sure we end up with a copy of the EE_Messages_Addressee object
+		$this->_recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
+							&& is_array($this->_data)
+							&& isset($this->_data['data'])
+							&& $this->_data['data'] instanceof EE_Messages_Addressee
+			? $this->_data['data']
+			:
+			$this->_recipient;
+		$this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
+							&& ! empty($this->_extra_data['data'])
+							&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']
+			: $this->_recipient;
+
+		if (! $this->_recipient instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		$attendee = $this->_recipient->att_obj;
+		if (! $attendee instanceof EE_Attendee) {
+			return '';
+		}
+
+		$this->_registrations_for_recipient = isset($this->_recipient->attendees[ $attendee->ID() ]['reg_objs'])
+			? $this->_recipient->attendees[ $attendee->ID() ]['reg_objs']
+			: array();
+
+		switch ($shortcode) {
+			case '[RECIPIENT_FNAME]':
+				return $attendee->fname();
+				break;
+
+			case '[RECIPIENT_LNAME]':
+				return $attendee->lname();
+				break;
+
+			case '[RECIPIENT_EMAIL]':
+				return $attendee->email();
+				break;
+
+			case '[RECIPIENT_REGISTRATION_ID]':
+				if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $this->_get_reg_id();
+				break;
+
+			case '[RECIPIENT_REGISTRATION_CODE]':
+				if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $this->_get_reg_code();
+				break;
+
+			case '[RECIPIENT_EDIT_REGISTRATION_LINK]':
+				if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $this->_recipient->reg_obj->edit_attendee_information_url();
+				break;
+
+			case '[RECIPIENT_PHONE_NUMBER]':
+				return $attendee->phone();
+				break;
+
+			case '[RECIPIENT_ADDRESS]':
+				return $attendee->address();
+				break;
+
+			case '[RECIPIENT_ADDRESS2]':
+				return $attendee->address2();
+				break;
+
+			case '[RECIPIENT_CITY]':
+				return $attendee->city();
+				break;
+
+			case '[RECIPIENT_ZIP_PC]':
+				return $attendee->zip();
+				break;
+
+			case '[RECIPIENT_ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+				break;
+
+			case '[RECIPIENT_COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+				break;
+			case '[RECIPIENT_TOTAL_AMOUNT_PAID]':
+				return $this->_recipient->reg_obj instanceof EE_Registration
+					? $this->_recipient->reg_obj->pretty_paid()
+					: 0;
+				break;
+		}
+
+		if (strpos($shortcode, '[RECIPIENT_ANSWER_*') !== false) {
+			$shortcode = str_replace('[RECIPIENT_ANSWER_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+
+			// now let's figure out what question has this text
+			if (empty($this->_recipient->questions) || ! $this->_recipient->reg_obj instanceof EE_Registration) {
+				return '';
+			}
+
+			foreach ($this->_recipient->questions as $ansid => $question) {
+				if (
+					$question instanceof EE_Question
+					&& trim($question->display_text()) === trim($shortcode)
+					&& isset($this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ])
+				) {
+					$recipient_ansid = $this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ];
+
+					// what we show for the answer depends on the question type!
+					switch ($question->get('QST_type')) {
+						case EEM_Question::QST_type_state:
+							$state = EEM_State::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
+							$answer = $state instanceof EE_State ? $state->name() : '';
+							break;
+
+						case EEM_Question::QST_type_country:
+							$country = EEM_Country::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
+							$answer = $country instanceof EE_Country ? $country->name() : '';
+							break;
+
+						default:
+							$answer = $recipient_ansid->get_pretty('ANS_value', 'no_wpautop');
+							break;
+					}
+
+					return $answer;
+					break;
+				}
+			}
+		}
+
+		return '';
+	}
+
+
+	/**
+	 * Returns the EE_Messages_Addressee object for the recipient.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return EE_Messages_Addressee
+	 */
+	public function get_recipient()
+	{
+		return $this->_recipient;
+	}
+
+
+	/**
+	 * returns the reg code for the recipient depending on the context and whether the recipient has multiple
+	 * registrations or not.
+	 *
+	 * @return string
+	 */
+	protected function _get_reg_code()
+	{
+
+		// if only one related registration for the recipient then just return that reg code.
+		if (count($this->_registrations_for_recipient) <= 1) {
+			return $this->_recipient->reg_obj->reg_code();
+		}
+
+		// k more than one registration so let's see if we can get specific to context
+		// are we parsing event_list?
+		if ($this->_data instanceof EE_Event) {
+			$reg_code = array();
+			// loop through registrations for recipient and see if there is a match for this event
+			foreach ($this->_registrations_for_recipient as $reg) {
+				if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
+					$reg_code[] = $reg->reg_code();
+				}
+			}
+			return implode(', ', $reg_code);
+		}
+
+		// are we parsing ticket list?
+		if ($this->_data instanceof EE_Ticket) {
+			$reg_code = array();
+			// loop through each registration for recipient and see if there is a match for this ticket
+			foreach ($this->_registrations_for_recipient as $reg) {
+				if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
+					$reg_code = $reg->reg_code();
+				}
+			}
+			return implode(', ', $reg_code);
+		}
+
+		// do we have a specific reg_obj?  Let's use it
+		if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
+			return $this->_data->reg_obj->reg_code();
+		}
+
+		// do we have a specific reg_obj?  Let's use it
+		if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
+			return $this->_data->reg_obj->reg_code();
+		}
+
+		// not able to determine the single reg code so let's return a comma delimited list of reg codes.
+		$reg_code = array();
+		foreach ($this->_registrations_for_recipient as $reg) {
+			if ($reg instanceof EE_Registration) {
+				$reg_code[] = $reg->reg_code();
+			}
+		}
+		return implode(', ', $reg_code);
+	}
+
+
+	/**
+	 * returns the reg ID for the recipient depending on the context and whether the recipient has multiple
+	 * registrations or not.
+	 *
+	 * @return int|string
+	 */
+	protected function _get_reg_id()
+	{
+
+		// if only one related registration for the recipient then just return that reg code.
+		if (count($this->_registrations_for_recipient) <= 1) {
+			return $this->_recipient->reg_obj->ID();
+		}
+
+		// k more than one registration so let's see if we can get specific to context
+		// are we parsing event_list?
+		if ($this->_data instanceof EE_Event) {
+			$registration_ids = array();
+			// loop through registrations for recipient and see if there is a match for this event
+			foreach ($this->_registrations_for_recipient as $reg) {
+				if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
+					$registration_ids[] = $reg->ID();
+				}
+			}
+			return implode(', ', $registration_ids);
+		}
+
+		// are we parsing ticket list?
+		if ($this->_data instanceof EE_Ticket) {
+			$registration_ids = array();
+			// loop through each registration for recipient and see if there is a match for this ticket
+			foreach ($this->_registrations_for_recipient as $reg) {
+				if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
+					$registration_ids = $reg->ID();
+				}
+			}
+			return implode(', ', $registration_ids);
+		}
+
+		// do we have a specific reg_obj?  Let's use it
+		if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
+			return $this->_data->reg_obj->ID();
+		}
+
+		// not able to determine the single reg code so let's return a comma delimited list of reg codes.
+		$registration_ids = array();
+		foreach ($this->_registrations_for_recipient as $reg) {
+			if ($reg instanceof EE_Registration) {
+				$registration_ids[] = $reg->ID();
+			}
+		}
+		return implode(', ', $registration_ids);
+	}
 }

core/libraries/shortcodes/EE_Event_Shortcodes.lib.php

Spacing +10 added lines, -10 removed lines

@@ -134,7 +134,7 @@ 
 
 
         // If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
+        if ( ! $this->_event instanceof EE_Event) {
             return '';
         }
 
@@ -187,11 +187,11 @@ 
                 $image = $this->_event->feature_image_url(array(600, 300));
                 // @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
                 return ! empty($image)
-                    ? '<img src="' . $image . '" alt="'
+                    ? '<img src="'.$image.'" alt="'
                       . sprintf(
                           esc_attr__('%s Feature Image', 'event_espresso'),
                           $this->_event->get('EVT_name')
-                      ) . '" />'
+                      ).'" />'
                     : '';
                 break;
 
@@ -253,7 +253,7 @@ 
             // Check if a do_shortcode attribute was set to true and if so run $event_meta through that function.
             if (
                 apply_filters('FHEE__EventEspresso_core_libraries_shortcodes_EE_Event_Shortcodes___parser__event_meta_do_shortcode', false)
-                || !empty($attrs['do_shortcode']) && filter_var($attrs['do_shortcode'], FILTER_VALIDATE_BOOLEAN)
+                || ! empty($attrs['do_shortcode']) && filter_var($attrs['do_shortcode'], FILTER_VALIDATE_BOOLEAN)
             ) {
                 return do_shortcode($event_meta);
             }
@@ -271,11 +271,11 @@ 
 
         if (strpos($shortcode, '[EVENT_IMAGE_*') !== false) {
             $attrs = $this->_get_shortcode_attrs($shortcode);
-            $width = empty($attrs['width']) ? '' : ' width="' . $attrs['width'] . '"';
-            $height = empty($attrs['height']) ? '' : ' height="' . $attrs['height'] . '"';
+            $width = empty($attrs['width']) ? '' : ' width="'.$attrs['width'].'"';
+            $height = empty($attrs['height']) ? '' : ' height="'.$attrs['height'].'"';
 
             // Size may be set to a string such as 'tumbnail' or "width, height" eg - '200,200'
-            if (! empty($attrs['size'])) {
+            if ( ! empty($attrs['size'])) {
                 $size = explode(',', $attrs['size']);
                 if (count($size) === 1) {
                     $size = $size[0];
@@ -287,11 +287,11 @@ 
             $image = $this->_event->feature_image_url($size);
 
             return ! empty($image)
-                ? '<img src="' . $image . '" alt="'
+                ? '<img src="'.$image.'" alt="'
                   . sprintf(
                       esc_attr__('%s Feature Image', 'event_espresso'),
                       $this->_event->get('EVT_name')
-                  ) . '"' . $width . $height . '/>'
+                  ).'"'.$width.$height.'/>'
                 : '';
         }
 
@@ -310,6 +310,6 @@ 
     {
         $url = get_permalink($event->ID());
 
-        return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
+        return $full_link ? '<a href="'.$url.'">'.$event->get('EVT_name').'</a>' : $url;
     }
 }

Indentation +293 added lines, -293 removed lines

@@ -17,297 +17,297 @@
  */
 class EE_Event_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Event Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to event related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[EVENT_ID]'                              => esc_html__(
-                'Will be replaced by the event ID of an event',
-                'event_espresso'
-            ),
-            '[EVENT]'                                 => esc_html__('The name of the event', 'event_espresso'),
-            '[EVENT_NAME]'                            => esc_html__(
-                "This also can be used for the name of the event",
-                'event_espresso'
-            ),
-            '[EVENT_PHONE]'                           => esc_html__(
-                'The phone number for the event (usually an info number)',
-                'event_espresso'
-            ),
-            '[EVENT_DESCRIPTION]'                     => esc_html__('The description of the event', 'event_espresso'),
-            '[EVENT_EXCERPT]'                         => esc_html__(
-                'This gets parsed to the value for the excerpt field in the event or blank if there is no excerpt.',
-                'event_espresso'
-            ),
-            '[EVENT_LINK]'                            => esc_html__('A link associated with the event', 'event_espresso'),
-            '[EVENT_URL]'                             => esc_html__(
-                'A link to the event set up on the host site.',
-                'event_espresso'
-            ),
-            '[VIRTUAL_URL]'                           => esc_html__(
-                'What was used for the "URL of Event" field in the Venue settings',
-                'event_espresso'
-            ),
-            '[VIRTUAL_PHONE]'                         => esc_html__(
-                'An alternate phone number for the event. Typically used as a "call-in" number',
-                'event_espresso'
-            ),
-            '[EVENT_IMAGE]'                           => esc_html__(
-                'This will parse to the Feature image for the event.',
-                'event_espresso'
-            ),
-            '[EVENT_IMAGE_*]'                         => sprintf(
-                esc_html__(
-                    'This will parse to the Feature image for the event, %1$ssize%2$s can be set to determine the size of the image loaded by the shortcode. The %1$swidth%2$s and/or %1$sheight%2$s can also be set to determine the width and height of the image when output. By default the shortcode will load the %1$sthumbnail%2$s image size.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[EVENT_TOTAL_AVAILABLE_SPACES_*]'        => sprintf(
-                esc_html__(
-                    'This will parse to the total available spaces for an event. Calculating total spaces is approximate because it is dependent on the complexity of limits on your event.  There are two methods of calculation (which can be indicated by the %1$smethod%2$s param on the shortcode).  %1$scurrent%2$s which will do a more accurate calculation of total available spaces based on current sales, and %1$sfull%2$s which will be the maximum total available spaces that is on the event in optimal conditions. The shortcode will default to current.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[EVENT_TOTAL_SPOTS_TAKEN]'               => esc_html__(
-                'This shortcode will parse to the output the total approved registrations for this event',
-                'event_espresso'
-            ),
-            '[EVENT_FACEBOOK_URL]'                    => esc_html__(
-                'This will return the Facebook URL for the event if you have it set via custom field in your event, otherwise it will use the Facebook URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_facebook</code> and the value as your facebook url.',
-                'event_espresso'
-            ),
-            '[EVENT_TWITTER_URL]'                     => esc_html__(
-                'This will return the Twitter URL for the event if you have it set via custom field in your event, otherwise it will use the Twitter URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_twitter</code> and the value as your facebook url',
-                'event_espresso'
-            ),
-            '[EVENT_META_*]'                          => sprintf(
-                esc_html__(
-                    'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the event then it will be output in place of this shortcode. If you use shortcodes within your custom fields set %1$sdo_shortcode=true%2$s at the end of the shortcode to run the value through the do_shortcode function. ',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' => esc_html__(
-                'This parses to the url for the registration list table filtered by registrations for this event.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
-        if (empty($this->_event)) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->event() : null;
-        }
-
-
-        // If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[EVENT_ID]':
-                return $this->_event->ID();
-                break;
-
-            case '[EVENT]':
-            case '[EVENT_NAME]':
-                return $this->_event->get('EVT_name');
-                break;
-
-            case '[EVENT_PHONE]':
-                return $this->_event->get('EVT_phone');
-                break;
-
-            case '[EVENT_DESCRIPTION]':
-                return $this->_event->get('EVT_desc');
-                break;
-
-            case '[EVENT_EXCERPT]':
-                return $this->_event->get('EVT_short_desc');
-                break;
-
-            case '[EVENT_LINK]':
-                return $this->_get_event_link($this->_event);
-                break;
-
-            case '[EVENT_URL]':
-                return $this->_get_event_link($this->_event, false);
-                break;
-
-            case '[VIRTUAL_URL]':
-                $venue = $this->_event->get_first_related('Venue');
-                if (empty($venue)) {
-                    return '';
-                }
-                return $venue->get('VNU_virtual_url');
-
-            case '[VIRTUAL_PHONE]':
-                $venue = $this->_event->get_first_related('Venue');
-                if (empty($venue)) {
-                    return '';
-                }
-                return $venue->get('VNU_virtual_phone');
-                break;
-
-            case '[EVENT_IMAGE]':
-                $image = $this->_event->feature_image_url(array(600, 300));
-                // @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
-                return ! empty($image)
-                    ? '<img src="' . $image . '" alt="'
-                      . sprintf(
-                          esc_attr__('%s Feature Image', 'event_espresso'),
-                          $this->_event->get('EVT_name')
-                      ) . '" />'
-                    : '';
-                break;
-
-            case '[EVENT_FACEBOOK_URL]':
-                $facebook_url = $this->_event->get_post_meta('event_facebook', true);
-                return empty($facebook_url) ? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
-                    : $facebook_url;
-                break;
-
-            case '[EVENT_TWITTER_URL]':
-                $twitter_url = $this->_event->get_post_meta('event_twitter', true);
-                return empty($twitter_url) ? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
-                    : $twitter_url;
-                break;
-
-            case '[EVENT_AUTHOR_EMAIL]':
-                $author_id = $this->_event->get('EVT_wp_user');
-                $user_data = get_userdata((int) $author_id);
-                return $user_data->user_email;
-                break;
-
-            case '[EVENT_TOTAL_SPOTS_TAKEN]':
-                return EEM_Registration::instance()->count(
-                    array(array('EVT_ID' => $this->_event->ID(), 'STS_ID' => EEM_Registration::status_id_approved)),
-                    'REG_ID',
-                    true
-                );
-                break;
-
-            case '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]':
-                return EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'event_id' => $this->_event->ID(),
-                        'page'     => 'espresso_registrations',
-                        'action'   => 'default',
-                    ),
-                    admin_url('admin.php'),
-                    true
-                );
-                break;
-        }
-
-        if (strpos($shortcode, '[EVENT_META_*') !== false) {
-            // Strip the shortcode itself from $shortcode leaving any attributes set.
-            // Removing the * is correct here as _* is used to indiciate a dynamic shortcode.
-            $shortcode = str_replace('[EVENT_META_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-            // Get any attributes set on this shortcode.
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            // The meta_key set on the shortcode should always be the first value in the array.
-            $meta_key = $attrs[0];
-            // Pull the meta value from the event post.
-            $event_meta = $this->_event->get_post_meta($meta_key, true);
-            // If we have no event_meta, just return an empty string.
-            if (empty($event_meta)) {
-                return '';
-            }
-            // Add a filter to allow all instances of EVENT_META_* to run through do_shortcode, default to false.
-            // Check if a do_shortcode attribute was set to true and if so run $event_meta through that function.
-            if (
-                apply_filters('FHEE__EventEspresso_core_libraries_shortcodes_EE_Event_Shortcodes___parser__event_meta_do_shortcode', false)
-                || !empty($attrs['do_shortcode']) && filter_var($attrs['do_shortcode'], FILTER_VALIDATE_BOOLEAN)
-            ) {
-                return do_shortcode($event_meta);
-            }
-            // Still here? We just need to return the event_meta value as is.
-            return $event_meta;
-        }
-
-        if (strpos($shortcode, '[EVENT_TOTAL_AVAILABLE_SPACES_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            $method = empty($attrs['method']) ? 'current' : $attrs['method'];
-            $method = $method === 'current';
-            $available = $this->_event->total_available_spaces($method);
-            return $available === EE_INF ? '&infin;' : $available;
-        }
-
-        if (strpos($shortcode, '[EVENT_IMAGE_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            $width = empty($attrs['width']) ? '' : ' width="' . $attrs['width'] . '"';
-            $height = empty($attrs['height']) ? '' : ' height="' . $attrs['height'] . '"';
-
-            // Size may be set to a string such as 'tumbnail' or "width, height" eg - '200,200'
-            if (! empty($attrs['size'])) {
-                $size = explode(',', $attrs['size']);
-                if (count($size) === 1) {
-                    $size = $size[0];
-                }
-            } else {
-                $size = 'thumbnail';
-            }
-
-            $image = $this->_event->feature_image_url($size);
-
-            return ! empty($image)
-                ? '<img src="' . $image . '" alt="'
-                  . sprintf(
-                      esc_attr__('%s Feature Image', 'event_espresso'),
-                      $this->_event->get('EVT_name')
-                  ) . '"' . $width . $height . '/>'
-                : '';
-        }
-
-        return '';
-    }
-
-
-    /**
-     * returns the link to the event
-     *
-     * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.
-     *                            Otherwise we just return the url of the event.
-     * @return string
-     */
-    private function _get_event_link($event, $full_link = true)
-    {
-        $url = get_permalink($event->ID());
-
-        return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Event Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to event related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[EVENT_ID]'                              => esc_html__(
+				'Will be replaced by the event ID of an event',
+				'event_espresso'
+			),
+			'[EVENT]'                                 => esc_html__('The name of the event', 'event_espresso'),
+			'[EVENT_NAME]'                            => esc_html__(
+				"This also can be used for the name of the event",
+				'event_espresso'
+			),
+			'[EVENT_PHONE]'                           => esc_html__(
+				'The phone number for the event (usually an info number)',
+				'event_espresso'
+			),
+			'[EVENT_DESCRIPTION]'                     => esc_html__('The description of the event', 'event_espresso'),
+			'[EVENT_EXCERPT]'                         => esc_html__(
+				'This gets parsed to the value for the excerpt field in the event or blank if there is no excerpt.',
+				'event_espresso'
+			),
+			'[EVENT_LINK]'                            => esc_html__('A link associated with the event', 'event_espresso'),
+			'[EVENT_URL]'                             => esc_html__(
+				'A link to the event set up on the host site.',
+				'event_espresso'
+			),
+			'[VIRTUAL_URL]'                           => esc_html__(
+				'What was used for the "URL of Event" field in the Venue settings',
+				'event_espresso'
+			),
+			'[VIRTUAL_PHONE]'                         => esc_html__(
+				'An alternate phone number for the event. Typically used as a "call-in" number',
+				'event_espresso'
+			),
+			'[EVENT_IMAGE]'                           => esc_html__(
+				'This will parse to the Feature image for the event.',
+				'event_espresso'
+			),
+			'[EVENT_IMAGE_*]'                         => sprintf(
+				esc_html__(
+					'This will parse to the Feature image for the event, %1$ssize%2$s can be set to determine the size of the image loaded by the shortcode. The %1$swidth%2$s and/or %1$sheight%2$s can also be set to determine the width and height of the image when output. By default the shortcode will load the %1$sthumbnail%2$s image size.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[EVENT_TOTAL_AVAILABLE_SPACES_*]'        => sprintf(
+				esc_html__(
+					'This will parse to the total available spaces for an event. Calculating total spaces is approximate because it is dependent on the complexity of limits on your event.  There are two methods of calculation (which can be indicated by the %1$smethod%2$s param on the shortcode).  %1$scurrent%2$s which will do a more accurate calculation of total available spaces based on current sales, and %1$sfull%2$s which will be the maximum total available spaces that is on the event in optimal conditions. The shortcode will default to current.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[EVENT_TOTAL_SPOTS_TAKEN]'               => esc_html__(
+				'This shortcode will parse to the output the total approved registrations for this event',
+				'event_espresso'
+			),
+			'[EVENT_FACEBOOK_URL]'                    => esc_html__(
+				'This will return the Facebook URL for the event if you have it set via custom field in your event, otherwise it will use the Facebook URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_facebook</code> and the value as your facebook url.',
+				'event_espresso'
+			),
+			'[EVENT_TWITTER_URL]'                     => esc_html__(
+				'This will return the Twitter URL for the event if you have it set via custom field in your event, otherwise it will use the Twitter URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_twitter</code> and the value as your facebook url',
+				'event_espresso'
+			),
+			'[EVENT_META_*]'                          => sprintf(
+				esc_html__(
+					'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the event then it will be output in place of this shortcode. If you use shortcodes within your custom fields set %1$sdo_shortcode=true%2$s at the end of the shortcode to run the value through the do_shortcode function. ',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' => esc_html__(
+				'This parses to the url for the registration list table filtered by registrations for this event.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		// if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
+		if (empty($this->_event)) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->event() : null;
+		}
+
+
+		// If there is no event objecdt by now then get out.
+		if (! $this->_event instanceof EE_Event) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[EVENT_ID]':
+				return $this->_event->ID();
+				break;
+
+			case '[EVENT]':
+			case '[EVENT_NAME]':
+				return $this->_event->get('EVT_name');
+				break;
+
+			case '[EVENT_PHONE]':
+				return $this->_event->get('EVT_phone');
+				break;
+
+			case '[EVENT_DESCRIPTION]':
+				return $this->_event->get('EVT_desc');
+				break;
+
+			case '[EVENT_EXCERPT]':
+				return $this->_event->get('EVT_short_desc');
+				break;
+
+			case '[EVENT_LINK]':
+				return $this->_get_event_link($this->_event);
+				break;
+
+			case '[EVENT_URL]':
+				return $this->_get_event_link($this->_event, false);
+				break;
+
+			case '[VIRTUAL_URL]':
+				$venue = $this->_event->get_first_related('Venue');
+				if (empty($venue)) {
+					return '';
+				}
+				return $venue->get('VNU_virtual_url');
+
+			case '[VIRTUAL_PHONE]':
+				$venue = $this->_event->get_first_related('Venue');
+				if (empty($venue)) {
+					return '';
+				}
+				return $venue->get('VNU_virtual_phone');
+				break;
+
+			case '[EVENT_IMAGE]':
+				$image = $this->_event->feature_image_url(array(600, 300));
+				// @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
+				return ! empty($image)
+					? '<img src="' . $image . '" alt="'
+					  . sprintf(
+						  esc_attr__('%s Feature Image', 'event_espresso'),
+						  $this->_event->get('EVT_name')
+					  ) . '" />'
+					: '';
+				break;
+
+			case '[EVENT_FACEBOOK_URL]':
+				$facebook_url = $this->_event->get_post_meta('event_facebook', true);
+				return empty($facebook_url) ? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
+					: $facebook_url;
+				break;
+
+			case '[EVENT_TWITTER_URL]':
+				$twitter_url = $this->_event->get_post_meta('event_twitter', true);
+				return empty($twitter_url) ? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
+					: $twitter_url;
+				break;
+
+			case '[EVENT_AUTHOR_EMAIL]':
+				$author_id = $this->_event->get('EVT_wp_user');
+				$user_data = get_userdata((int) $author_id);
+				return $user_data->user_email;
+				break;
+
+			case '[EVENT_TOTAL_SPOTS_TAKEN]':
+				return EEM_Registration::instance()->count(
+					array(array('EVT_ID' => $this->_event->ID(), 'STS_ID' => EEM_Registration::status_id_approved)),
+					'REG_ID',
+					true
+				);
+				break;
+
+			case '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]':
+				return EEH_URL::add_query_args_and_nonce(
+					array(
+						'event_id' => $this->_event->ID(),
+						'page'     => 'espresso_registrations',
+						'action'   => 'default',
+					),
+					admin_url('admin.php'),
+					true
+				);
+				break;
+		}
+
+		if (strpos($shortcode, '[EVENT_META_*') !== false) {
+			// Strip the shortcode itself from $shortcode leaving any attributes set.
+			// Removing the * is correct here as _* is used to indiciate a dynamic shortcode.
+			$shortcode = str_replace('[EVENT_META_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+			// Get any attributes set on this shortcode.
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			// The meta_key set on the shortcode should always be the first value in the array.
+			$meta_key = $attrs[0];
+			// Pull the meta value from the event post.
+			$event_meta = $this->_event->get_post_meta($meta_key, true);
+			// If we have no event_meta, just return an empty string.
+			if (empty($event_meta)) {
+				return '';
+			}
+			// Add a filter to allow all instances of EVENT_META_* to run through do_shortcode, default to false.
+			// Check if a do_shortcode attribute was set to true and if so run $event_meta through that function.
+			if (
+				apply_filters('FHEE__EventEspresso_core_libraries_shortcodes_EE_Event_Shortcodes___parser__event_meta_do_shortcode', false)
+				|| !empty($attrs['do_shortcode']) && filter_var($attrs['do_shortcode'], FILTER_VALIDATE_BOOLEAN)
+			) {
+				return do_shortcode($event_meta);
+			}
+			// Still here? We just need to return the event_meta value as is.
+			return $event_meta;
+		}
+
+		if (strpos($shortcode, '[EVENT_TOTAL_AVAILABLE_SPACES_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			$method = empty($attrs['method']) ? 'current' : $attrs['method'];
+			$method = $method === 'current';
+			$available = $this->_event->total_available_spaces($method);
+			return $available === EE_INF ? '&infin;' : $available;
+		}
+
+		if (strpos($shortcode, '[EVENT_IMAGE_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			$width = empty($attrs['width']) ? '' : ' width="' . $attrs['width'] . '"';
+			$height = empty($attrs['height']) ? '' : ' height="' . $attrs['height'] . '"';
+
+			// Size may be set to a string such as 'tumbnail' or "width, height" eg - '200,200'
+			if (! empty($attrs['size'])) {
+				$size = explode(',', $attrs['size']);
+				if (count($size) === 1) {
+					$size = $size[0];
+				}
+			} else {
+				$size = 'thumbnail';
+			}
+
+			$image = $this->_event->feature_image_url($size);
+
+			return ! empty($image)
+				? '<img src="' . $image . '" alt="'
+				  . sprintf(
+					  esc_attr__('%s Feature Image', 'event_espresso'),
+					  $this->_event->get('EVT_name')
+				  ) . '"' . $width . $height . '/>'
+				: '';
+		}
+
+		return '';
+	}
+
+
+	/**
+	 * returns the link to the event
+	 *
+	 * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.
+	 *                            Otherwise we just return the url of the event.
+	 * @return string
+	 */
+	private function _get_event_link($event, $full_link = true)
+	{
+		$url = get_permalink($event->ID());
+
+		return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
+	}
 }

core/libraries/shortcodes/EE_Primary_Registration_List_Shortcodes.lib.php

Spacing +11 added lines, -11 removed lines

@@ -83,7 +83,7 @@ 
     private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
     {
         $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             return '';
         }
         // setup valid shortcodes depending on what the status of the $this->_data property is
@@ -97,7 +97,7 @@ 
                 'attendee',
             );
             $template = $this->_data['template'];
-            $tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
+            $tkts = array($data->registrations[$registration->ID()]['tkt_obj']);
             $data = $this->_data;
         } elseif ($this->_data['data'] instanceof EE_Event) {
             $valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
@@ -127,16 +127,16 @@ 
 
     private function _get_tickets_from_event(EE_Event $event, $reg = null)
     {
-        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['tkt_objs'] : array();
+        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID(
+        )]['tkt_objs'] : array();
 
         if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
             $adj_tkts = array();
             // return only tickets for the given attendee
             foreach ($evt_tkts as $tkt) {
                 if (
-                    isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
-                    && $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
+                    isset($this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj'])
+                    && $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj']->ID() == $tkt->ID()
                 ) {
                     $adj_tkts[] = $tkt;
                 }
@@ -172,14 +172,14 @@ 
     private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
     {
         $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             return '';
         }
         // setup valid shortcodes depending on what the status of the $this->_data property is
         if ($this->_data['data'] instanceof EE_Messages_Addressee) {
             $valid_shortcodes = array('datetime', 'attendee');
             $template = $this->_data['template'];
-            $dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
+            $dtts = $data->registrations[$registration->ID()]['dtt_objs'];
             $data = $this->_data;
         } elseif ($this->_data['data'] instanceof EE_Event) {
             $valid_shortcodes = array('datetime', 'attendee');
@@ -206,14 +206,14 @@ 
 
     private function _get_datetimes_from_event(EE_Event $event, $reg = null)
     {
-        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['dtt_objs'] : array();
+        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID(
+        )]['dtt_objs'] : array();
 
         if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
             $adj_dtts = array();
             // return only dtts for the given attendee
             foreach ($evt_dtts as $dtt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
+                if (isset($this->_extra_data['data']->registrations[$reg->ID()]['dtt_objs'][$dtt->ID()])) {
                     $adj_dtts[] = $dtt;
                 }
             }

Indentation +202 added lines, -202 removed lines

@@ -18,206 +18,206 @@
  */
 class EE_Primary_Registration_List_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Primary Registrant List Shortcodes', 'event_espresso');
-        $this->description = esc_html__(
-            'All shortcodes specific primary registrant recipients list type data.',
-            'event_espresso'
-        );
-        $this->_shortcodes = array(
-            '[PRIMARY_REGISTRANT_TICKET_LIST]' => esc_html__(
-                'Will output a list of tickets that the primary registration received.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_DATETIME_LIST]' => esc_html__(
-                'Will output a list of datetimes that the primary registrant for the transaction has been registered for.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_TICKET_LIST]':
-                return $this->_get_recipient_ticket_list(true);
-                break;
-
-            case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
-                return $this->_get_recipient_datetime_list(true);
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value
-     *
-     * @param  boolean $primary whether we're getting the primary registrant ticket_list.
-     * @return string
-     */
-    private function _get_recipient_ticket_list($primary = false)
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
-        } elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
-        } else {
-            return '';
-        }
-    }
-
-
-    private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
-    {
-        $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
-            return '';
-        }
-        // setup valid shortcodes depending on what the status of the $this->_data property is
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            $valid_shortcodes = array(
-                'ticket',
-                'event_list',
-                'attendee_list',
-                'datetime_list',
-                'registration_details',
-                'attendee',
-            );
-            $template = $this->_data['template'];
-            $tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
-            $data = $this->_data;
-        } elseif ($this->_data['data'] instanceof EE_Event) {
-            $valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
-            $template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
-                ? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
-            // let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
-            $template = str_replace('[EVENT_LIST]', '', $template);
-            // data will be tickets for this event for this recipient.
-            $tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
-            $data = $this->_extra_data;
-        } else {
-            return '';
-        }
-
-        $tktparsed = '';
-        foreach ($tkts as $ticket) {
-            $tktparsed .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket,
-                $valid_shortcodes,
-                $data
-            );
-        }
-        return $tktparsed;
-    }
-
-
-    private function _get_tickets_from_event(EE_Event $event, $reg = null)
-    {
-        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['tkt_objs'] : array();
-
-        if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            $adj_tkts = array();
-            // return only tickets for the given attendee
-            foreach ($evt_tkts as $tkt) {
-                if (
-                    isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
-                    && $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
-                ) {
-                    $adj_tkts[] = $tkt;
-                }
-            }
-            $evt_tkts = $adj_tkts;
-        }
-        return $evt_tkts;
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value
-     *
-     * @param  boolean $primary whether we're getting the primary registrant ticket_list.
-     * @return string
-     */
-    private function _get_recipient_datetime_list($primary = false)
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
-        } elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
-        } else {
-            return '';
-        }
-
-        return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
-    }
-
-
-    private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
-    {
-        $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
-            return '';
-        }
-        // setup valid shortcodes depending on what the status of the $this->_data property is
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            $valid_shortcodes = array('datetime', 'attendee');
-            $template = $this->_data['template'];
-            $dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
-            $data = $this->_data;
-        } elseif ($this->_data['data'] instanceof EE_Event) {
-            $valid_shortcodes = array('datetime', 'attendee');
-            $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
-                ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
-            $dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
-            $data = $this->_extra_data;
-        } else {
-            return '';
-        }
-
-        $dtt_parsed = '';
-        foreach ($dtts as $datetime) {
-            $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
-                $template,
-                $datetime,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-        return $dtt_parsed;
-    }
-
-
-    private function _get_datetimes_from_event(EE_Event $event, $reg = null)
-    {
-        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['dtt_objs'] : array();
-
-        if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            $adj_dtts = array();
-            // return only dtts for the given attendee
-            foreach ($evt_dtts as $dtt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
-                    $adj_dtts[] = $dtt;
-                }
-            }
-            $evt_dtts = $adj_dtts;
-        }
-        return $evt_dtts;
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Primary Registrant List Shortcodes', 'event_espresso');
+		$this->description = esc_html__(
+			'All shortcodes specific primary registrant recipients list type data.',
+			'event_espresso'
+		);
+		$this->_shortcodes = array(
+			'[PRIMARY_REGISTRANT_TICKET_LIST]' => esc_html__(
+				'Will output a list of tickets that the primary registration received.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_DATETIME_LIST]' => esc_html__(
+				'Will output a list of datetimes that the primary registrant for the transaction has been registered for.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_TICKET_LIST]':
+				return $this->_get_recipient_ticket_list(true);
+				break;
+
+			case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
+				return $this->_get_recipient_datetime_list(true);
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value
+	 *
+	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
+	 * @return string
+	 */
+	private function _get_recipient_ticket_list($primary = false)
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
+		} elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
+		} else {
+			return '';
+		}
+	}
+
+
+	private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
+	{
+		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
+		if (! $registration instanceof EE_Registration) {
+			return '';
+		}
+		// setup valid shortcodes depending on what the status of the $this->_data property is
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array(
+				'ticket',
+				'event_list',
+				'attendee_list',
+				'datetime_list',
+				'registration_details',
+				'attendee',
+			);
+			$template = $this->_data['template'];
+			$tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
+			$data = $this->_data;
+		} elseif ($this->_data['data'] instanceof EE_Event) {
+			$valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
+				? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
+			// let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
+			$template = str_replace('[EVENT_LIST]', '', $template);
+			// data will be tickets for this event for this recipient.
+			$tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
+			$data = $this->_extra_data;
+		} else {
+			return '';
+		}
+
+		$tktparsed = '';
+		foreach ($tkts as $ticket) {
+			$tktparsed .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket,
+				$valid_shortcodes,
+				$data
+			);
+		}
+		return $tktparsed;
+	}
+
+
+	private function _get_tickets_from_event(EE_Event $event, $reg = null)
+	{
+		$evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
+		) ]['tkt_objs'] : array();
+
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			$adj_tkts = array();
+			// return only tickets for the given attendee
+			foreach ($evt_tkts as $tkt) {
+				if (
+					isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
+					&& $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
+				) {
+					$adj_tkts[] = $tkt;
+				}
+			}
+			$evt_tkts = $adj_tkts;
+		}
+		return $evt_tkts;
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value
+	 *
+	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
+	 * @return string
+	 */
+	private function _get_recipient_datetime_list($primary = false)
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
+		} elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
+		} else {
+			return '';
+		}
+
+		return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
+	}
+
+
+	private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
+	{
+		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
+		if (! $registration instanceof EE_Registration) {
+			return '';
+		}
+		// setup valid shortcodes depending on what the status of the $this->_data property is
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array('datetime', 'attendee');
+			$template = $this->_data['template'];
+			$dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
+			$data = $this->_data;
+		} elseif ($this->_data['data'] instanceof EE_Event) {
+			$valid_shortcodes = array('datetime', 'attendee');
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
+				? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
+			$dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
+			$data = $this->_extra_data;
+		} else {
+			return '';
+		}
+
+		$dtt_parsed = '';
+		foreach ($dtts as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
+				$template,
+				$datetime,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+		return $dtt_parsed;
+	}
+
+
+	private function _get_datetimes_from_event(EE_Event $event, $reg = null)
+	{
+		$evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
+		) ]['dtt_objs'] : array();
+
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			$adj_dtts = array();
+			// return only dtts for the given attendee
+			foreach ($evt_dtts as $dtt) {
+				if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
+					$adj_dtts[] = $dtt;
+				}
+			}
+			$evt_dtts = $adj_dtts;
+		}
+		return $evt_dtts;
+	}
 }

core/libraries/shortcodes/EE_Primary_Registration_Details_Shortcodes.lib.php

Spacing +5 added lines, -5 removed lines

@@ -99,14 +99,14 @@ 
         $primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
             ? $this->_extra_data['data'] : $primary_registration;
 
-        if (! $primary_registration instanceof EE_Messages_Addressee) {
+        if ( ! $primary_registration instanceof EE_Messages_Addressee) {
             return '';
         }
 
         $attendee = $primary_registration->primary_att_obj;
         $primary_reg = $primary_registration->primary_reg_obj;
 
-        if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
+        if ( ! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
             return '';
         }
 
@@ -162,7 +162,7 @@ 
                 break;
 
             case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
-                if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
+                if ( ! $primary_registration->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
@@ -187,9 +187,9 @@ 
                 if (
                     $question instanceof EE_Question
                     && trim($question->get('QST_display_text')) === trim($shortcode)
-                    && isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
+                    && isset($primary_registration->registrations[$primary_reg->ID()]['ans_objs'][$ansid])
                 ) {
-                    $primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
+                    $primary_reg_ansid = $primary_registration->registrations[$primary_reg->ID()]['ans_objs'][$ansid];
 
                     // what we show for the answer depends on the question type!
                     switch ($question->get('QST_type')) {

Indentation +197 added lines, -197 removed lines

@@ -17,201 +17,201 @@
  */
 class EE_Primary_Registration_Details_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Primary_Registration Details Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific primary registrant data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[PRIMARY_REGISTRANT_FNAME]'                  => esc_html__(
-                'Parses to the first name of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_LNAME]'                  => esc_html__(
-                'Parses to the last name of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_EMAIL]'                  => esc_html__(
-                'Parses to the email address of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_ID]'        => esc_html__(
-                'Parses to the registration ID of the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_CODE]'      => esc_html__(
-                'Parses to the registration code of the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_PHONE_NUMBER]'           => esc_html__(
-                'The Phone Number for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS]'                => esc_html__(
-                'The Address for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS2]'               => esc_html__(
-                'Whatever was in the address 2 field for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_CITY]'                   => esc_html__(
-                'The city for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ZIP_PC]'                 => esc_html__(
-                'The ZIP (or Postal) Code for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS_STATE]'          => esc_html__(
-                'The state/province for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_COUNTRY]'                => esc_html__(
-                'The country for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_DATE]'      => esc_html__(
-                'The date the registration occured for the primary registration.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]' => esc_html__(
-                'Generates a link for the given registration to edit this registration details on the frontend.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ANSWER_*]'               => esc_html__(
-                'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this primary registrant, then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        // make sure we end up with a copy of the EE_Messages_Addressee object
-        $primary_registration = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && is_array(
-            $this->_data
-        ) && isset($this->_data['data']) && $this->_data['data'] instanceof EE_Messages_Addressee ? $this->_data['data']
-            : $primary_registration;
-        $primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data'] : $primary_registration;
-
-        if (! $primary_registration instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        $attendee = $primary_registration->primary_att_obj;
-        $primary_reg = $primary_registration->primary_reg_obj;
-
-        if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_FNAME]':
-                return $attendee->fname();
-                break;
-
-            case '[PRIMARY_REGISTRANT_LNAME]':
-                return $attendee->lname();
-                break;
-
-            case '[PRIMARY_REGISTRANT_EMAIL]':
-                return $attendee->email();
-                break;
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_ID]':
-                return $primary_reg->ID();
-                break;
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_CODE]':
-                return $primary_reg->reg_code();
-                break;
-
-            case '[PRIMARY_REGISTRANT_PHONE_NUMBER]':
-                return $attendee->phone();
-                break;
-
-            case '[PRIMARY_REGISTRANT_ADDRESS]':
-                return $attendee->address();
-                break;
-
-            case '[PRIMARY_REGISTRANT_ADDRESS2]':
-                return $attendee->address2();
-                break;
-
-            case '[PRIMARY_REGISTRANT_CITY]':
-                return $attendee->city();
-                break;
-
-            case '[PRIMARY_REGISTRANT_ZIP_PC]':
-                return $attendee->zip();
-                break;
-
-            case '[PRIMARY_REGISTRANT_ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-                break;
-
-            case '[PRIMARY_REGISTRANT_COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-                break;
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
-                if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
-                break;
-
-            case '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]':
-                return $primary_reg->edit_attendee_information_url();
-                break;
-        }
-
-        if (strpos($shortcode, '[PRIMARY_REGISTRANT_ANSWER_*') !== false) {
-            $shortcode = str_replace('[PRIMARY_REGISTRANT_ANSWER_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-
-            // now let's figure out what question has this text
-            if (empty($primary_registration->questions)) {
-                return '';
-            }
-
-            foreach ($primary_registration->questions as $ansid => $question) {
-                if (
-                    $question instanceof EE_Question
-                    && trim($question->get('QST_display_text')) === trim($shortcode)
-                    && isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
-                ) {
-                    $primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
-
-                    // what we show for the answer depends on the question type!
-                    switch ($question->get('QST_type')) {
-                        case EEM_Question::QST_type_state:
-                            $state = EEM_State::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
-                            $answer = $state instanceof EE_State ? $state->name() : '';
-                            break;
-
-                        case EEM_Question::QST_type_country:
-                            $country = EEM_Country::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
-                            $answer = $country instanceof EE_Country ? $country->name() : '';
-                            break;
-
-                        default:
-                            $answer = $primary_reg_ansid->get_pretty('ANS_value', 'no_wpautop');
-                            break;
-                    }
-
-                    return $answer;
-                    break;
-                }
-            }
-        }
-
-        return '';
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Primary_Registration Details Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific primary registrant data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[PRIMARY_REGISTRANT_FNAME]'                  => esc_html__(
+				'Parses to the first name of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_LNAME]'                  => esc_html__(
+				'Parses to the last name of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_EMAIL]'                  => esc_html__(
+				'Parses to the email address of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_ID]'        => esc_html__(
+				'Parses to the registration ID of the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_CODE]'      => esc_html__(
+				'Parses to the registration code of the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_PHONE_NUMBER]'           => esc_html__(
+				'The Phone Number for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS]'                => esc_html__(
+				'The Address for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS2]'               => esc_html__(
+				'Whatever was in the address 2 field for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_CITY]'                   => esc_html__(
+				'The city for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ZIP_PC]'                 => esc_html__(
+				'The ZIP (or Postal) Code for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS_STATE]'          => esc_html__(
+				'The state/province for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_COUNTRY]'                => esc_html__(
+				'The country for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_DATE]'      => esc_html__(
+				'The date the registration occured for the primary registration.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]' => esc_html__(
+				'Generates a link for the given registration to edit this registration details on the frontend.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ANSWER_*]'               => esc_html__(
+				'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this primary registrant, then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		// make sure we end up with a copy of the EE_Messages_Addressee object
+		$primary_registration = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && is_array(
+			$this->_data
+		) && isset($this->_data['data']) && $this->_data['data'] instanceof EE_Messages_Addressee ? $this->_data['data']
+			: $primary_registration;
+		$primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data'] : $primary_registration;
+
+		if (! $primary_registration instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		$attendee = $primary_registration->primary_att_obj;
+		$primary_reg = $primary_registration->primary_reg_obj;
+
+		if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_FNAME]':
+				return $attendee->fname();
+				break;
+
+			case '[PRIMARY_REGISTRANT_LNAME]':
+				return $attendee->lname();
+				break;
+
+			case '[PRIMARY_REGISTRANT_EMAIL]':
+				return $attendee->email();
+				break;
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_ID]':
+				return $primary_reg->ID();
+				break;
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_CODE]':
+				return $primary_reg->reg_code();
+				break;
+
+			case '[PRIMARY_REGISTRANT_PHONE_NUMBER]':
+				return $attendee->phone();
+				break;
+
+			case '[PRIMARY_REGISTRANT_ADDRESS]':
+				return $attendee->address();
+				break;
+
+			case '[PRIMARY_REGISTRANT_ADDRESS2]':
+				return $attendee->address2();
+				break;
+
+			case '[PRIMARY_REGISTRANT_CITY]':
+				return $attendee->city();
+				break;
+
+			case '[PRIMARY_REGISTRANT_ZIP_PC]':
+				return $attendee->zip();
+				break;
+
+			case '[PRIMARY_REGISTRANT_ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+				break;
+
+			case '[PRIMARY_REGISTRANT_COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+				break;
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
+				if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
+				break;
+
+			case '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]':
+				return $primary_reg->edit_attendee_information_url();
+				break;
+		}
+
+		if (strpos($shortcode, '[PRIMARY_REGISTRANT_ANSWER_*') !== false) {
+			$shortcode = str_replace('[PRIMARY_REGISTRANT_ANSWER_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+
+			// now let's figure out what question has this text
+			if (empty($primary_registration->questions)) {
+				return '';
+			}
+
+			foreach ($primary_registration->questions as $ansid => $question) {
+				if (
+					$question instanceof EE_Question
+					&& trim($question->get('QST_display_text')) === trim($shortcode)
+					&& isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
+				) {
+					$primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
+
+					// what we show for the answer depends on the question type!
+					switch ($question->get('QST_type')) {
+						case EEM_Question::QST_type_state:
+							$state = EEM_State::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
+							$answer = $state instanceof EE_State ? $state->name() : '';
+							break;
+
+						case EEM_Question::QST_type_country:
+							$country = EEM_Country::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
+							$answer = $country instanceof EE_Country ? $country->name() : '';
+							break;
+
+						default:
+							$answer = $primary_reg_ansid->get_pretty('ANS_value', 'no_wpautop');
+							break;
+					}
+
+					return $answer;
+					break;
+				}
+			}
+		}
+
+		return '';
+	}
 }

core/libraries/form_sections/inputs/EE_Currency_Input.input.php

Spacing +2 added lines, -2 removed lines

@@ -21,13 +21,13 @@
     {
         $query_params = array('order_by' => array('CNT_name' => 'asc'));
         if ($only_specific_currency_codes) {
-            $query_params[0]['CNT_cur_code'] = array('IN',$only_specific_currency_codes);
+            $query_params[0]['CNT_cur_code'] = array('IN', $only_specific_currency_codes);
         }
         $all_countries = EEM_Country::instance()->get_all($query_params);
         $country_options = array();
         foreach ($all_countries as $country) {
             /* @var $country EE_Country */
-            $country_options[ $country->currency_code() ] = $country->name() . ": " . $country->currency_name_single() . " (" . $country->currency_sign() . ")";
+            $country_options[$country->currency_code()] = $country->name().": ".$country->currency_name_single()." (".$country->currency_sign().")";
         }
         parent::__construct($country_options, 'int', $input_settings);
     }

Indentation +19 added lines, -19 removed lines

@@ -11,23 +11,23 @@
  */
 class EE_Currency_Input extends EE_Select_Input
 {
-    /**
-     *
-     * @param array $only_specific_currency_codes numerically-indexed array of allowed currency codes. By default, all are allowed
-     * @param array $input_settings
-     */
-    public function __construct($only_specific_currency_codes = array(), $input_settings = array())
-    {
-        $query_params = array('order_by' => array('CNT_name' => 'asc'));
-        if ($only_specific_currency_codes) {
-            $query_params[0]['CNT_cur_code'] = array('IN',$only_specific_currency_codes);
-        }
-        $all_countries = EEM_Country::instance()->get_all($query_params);
-        $country_options = array();
-        foreach ($all_countries as $country) {
-            /* @var $country EE_Country */
-            $country_options[ $country->currency_code() ] = $country->name() . ": " . $country->currency_name_single() . " (" . $country->currency_sign() . ")";
-        }
-        parent::__construct($country_options, 'int', $input_settings);
-    }
+	/**
+	 *
+	 * @param array $only_specific_currency_codes numerically-indexed array of allowed currency codes. By default, all are allowed
+	 * @param array $input_settings
+	 */
+	public function __construct($only_specific_currency_codes = array(), $input_settings = array())
+	{
+		$query_params = array('order_by' => array('CNT_name' => 'asc'));
+		if ($only_specific_currency_codes) {
+			$query_params[0]['CNT_cur_code'] = array('IN',$only_specific_currency_codes);
+		}
+		$all_countries = EEM_Country::instance()->get_all($query_params);
+		$country_options = array();
+		foreach ($all_countries as $country) {
+			/* @var $country EE_Country */
+			$country_options[ $country->currency_code() ] = $country->name() . ": " . $country->currency_name_single() . " (" . $country->currency_sign() . ")";
+		}
+		parent::__construct($country_options, 'int', $input_settings);
+	}
 }