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/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/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 +200 added lines, -200 removed lines

@@ -18,204 +18,204 @@
  */
 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);
-
-            case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
-                return $this->_get_recipient_datetime_list(true);
-        }
-        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);
+
+			case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
+				return $this->_get_recipient_datetime_list(true);
+		}
+		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/form_sections/inputs/EE_Select_Reveal_Input.input.php

Spacing +5 added lines, -5 removed lines

@@ -45,12 +45,12 @@ 
             if (empty($sibling_section_name)) {
                 continue;
             }
-            $sibling_section = $this->find_section_from_path('../' . $sibling_section_name);
+            $sibling_section = $this->find_section_from_path('../'.$sibling_section_name);
             if (
                 $sibling_section instanceof EE_Form_Section_Base
                 && ! empty($sibling_section_name)
             ) {
-                $sibling_sections[ $sibling_section_name ] = $sibling_section;
+                $sibling_sections[$sibling_section_name] = $sibling_section;
             }
         }
         return $sibling_sections;
@@ -66,14 +66,14 @@ 
     public function get_other_js_data($form_other_js_data = array())
     {
         $form_other_js_data = parent::get_other_js_data($form_other_js_data);
-        if (! isset($form_other_js_data['select_reveal_inputs'])) {
+        if ( ! isset($form_other_js_data['select_reveal_inputs'])) {
             $form_other_js_data['select_reveal_inputs'] = array();
         }
         $sibling_input_to_html_id_map = array();
         foreach ($this->sibling_sections_controlled() as $sibling_section_path => $sibling_section) {
-            $sibling_input_to_html_id_map[ $sibling_section_path ] = $sibling_section->html_id();
+            $sibling_input_to_html_id_map[$sibling_section_path] = $sibling_section->html_id();
         }
-        $form_other_js_data['select_reveal_inputs'][ $this->html_id() ] = $sibling_input_to_html_id_map;
+        $form_other_js_data['select_reveal_inputs'][$this->html_id()] = $sibling_input_to_html_id_map;
         return $form_other_js_data;
     }
 }

Indentation +59 added lines, -59 removed lines

@@ -14,65 +14,65 @@
  */
 class EE_Select_Reveal_Input extends EE_Select_Input
 {
-    /**
-     * @param array $answer_options Array keys which match a sibling section's name
-     *              will show/unhide that sibling subsection. Otherwise, siblings whose names
-     *              match array keys of $answer_options are hidden.
-     *              Note: internally each array key is considered a relative form input path
-     *              (see EE_Form_Section_Base::find_section_from_path) but relative
-     *              to THIS INPUT's PARENT section, not this input itself. ie,
-     *              a '../' is automatically added onto each each array key, to produce
-     *              the relative form input path.
-     *              Note however: array keys which are an EMPTY STRING are left as-is
-     *
-     * @param array $input_settings
-     */
-    public function __construct($answer_options, $input_settings = array())
-    {
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array $answer_options Array keys which match a sibling section's name
+	 *              will show/unhide that sibling subsection. Otherwise, siblings whose names
+	 *              match array keys of $answer_options are hidden.
+	 *              Note: internally each array key is considered a relative form input path
+	 *              (see EE_Form_Section_Base::find_section_from_path) but relative
+	 *              to THIS INPUT's PARENT section, not this input itself. ie,
+	 *              a '../' is automatically added onto each each array key, to produce
+	 *              the relative form input path.
+	 *              Note however: array keys which are an EMPTY STRING are left as-is
+	 *
+	 * @param array $input_settings
+	 */
+	public function __construct($answer_options, $input_settings = array())
+	{
+		parent::__construct($answer_options, $input_settings);
+	}
 
-    /**
-     * Gets all the sibling sections controlled by this reveal select input
-     * @return \EE_Form_Section_Base[] keys are their form section paths
-     */
-    public function sibling_sections_controlled()
-    {
-        $sibling_sections = array();
-        foreach ($this->options() as $sibling_section_name => $sibling_section) {
-            // if it's an empty string just leave it alone
-            if (empty($sibling_section_name)) {
-                continue;
-            }
-            $sibling_section = $this->find_section_from_path('../' . $sibling_section_name);
-            if (
-                $sibling_section instanceof EE_Form_Section_Base
-                && ! empty($sibling_section_name)
-            ) {
-                $sibling_sections[ $sibling_section_name ] = $sibling_section;
-            }
-        }
-        return $sibling_sections;
-    }
+	/**
+	 * Gets all the sibling sections controlled by this reveal select input
+	 * @return \EE_Form_Section_Base[] keys are their form section paths
+	 */
+	public function sibling_sections_controlled()
+	{
+		$sibling_sections = array();
+		foreach ($this->options() as $sibling_section_name => $sibling_section) {
+			// if it's an empty string just leave it alone
+			if (empty($sibling_section_name)) {
+				continue;
+			}
+			$sibling_section = $this->find_section_from_path('../' . $sibling_section_name);
+			if (
+				$sibling_section instanceof EE_Form_Section_Base
+				&& ! empty($sibling_section_name)
+			) {
+				$sibling_sections[ $sibling_section_name ] = $sibling_section;
+			}
+		}
+		return $sibling_sections;
+	}
 
-    /**
-     * Adds an entry of 'select_reveal_inputs' to the js data, which is an array
-     * whose top-level keys are select reveal input html ids; values are arrays
-     * whose keys are select option values and values are the sections they reveal
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        $form_other_js_data = parent::get_other_js_data($form_other_js_data);
-        if (! isset($form_other_js_data['select_reveal_inputs'])) {
-            $form_other_js_data['select_reveal_inputs'] = array();
-        }
-        $sibling_input_to_html_id_map = array();
-        foreach ($this->sibling_sections_controlled() as $sibling_section_path => $sibling_section) {
-            $sibling_input_to_html_id_map[ $sibling_section_path ] = $sibling_section->html_id();
-        }
-        $form_other_js_data['select_reveal_inputs'][ $this->html_id() ] = $sibling_input_to_html_id_map;
-        return $form_other_js_data;
-    }
+	/**
+	 * Adds an entry of 'select_reveal_inputs' to the js data, which is an array
+	 * whose top-level keys are select reveal input html ids; values are arrays
+	 * whose keys are select option values and values are the sections they reveal
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		$form_other_js_data = parent::get_other_js_data($form_other_js_data);
+		if (! isset($form_other_js_data['select_reveal_inputs'])) {
+			$form_other_js_data['select_reveal_inputs'] = array();
+		}
+		$sibling_input_to_html_id_map = array();
+		foreach ($this->sibling_sections_controlled() as $sibling_section_path => $sibling_section) {
+			$sibling_input_to_html_id_map[ $sibling_section_path ] = $sibling_section->html_id();
+		}
+		$form_other_js_data['select_reveal_inputs'][ $this->html_id() ] = $sibling_input_to_html_id_map;
+		return $form_other_js_data;
+	}
 }

core/libraries/form_sections/strategies/sensitive_data_removal/EE_CCV_Sensitive_Data_Removal.strategy.php

Indentation +14 added lines, -14 removed lines

@@ -11,18 +11,18 @@
  */
 class EE_CCV_Sensitive_Data_Removal extends EE_Sensitive_Data_Removal_Base
 {
-    public function remove_sensitive_data($normalized_value)
-    {
-        // Get the ccv Length
-        $ccv_lenght = strlen($normalized_value);
-        // Replace all characters of credit card except the last four and dashes
-        for ($i = 0; $i < $ccv_lenght; $i++) {
-            if ($normalized_value[ $i ] == '-') {
-                continue;
-            }
-            $normalized_value[ $i ] = 'X';
-        }
-        // Return the masked Credit Card #
-        return $normalized_value;
-    }
+	public function remove_sensitive_data($normalized_value)
+	{
+		// Get the ccv Length
+		$ccv_lenght = strlen($normalized_value);
+		// Replace all characters of credit card except the last four and dashes
+		for ($i = 0; $i < $ccv_lenght; $i++) {
+			if ($normalized_value[ $i ] == '-') {
+				continue;
+			}
+			$normalized_value[ $i ] = 'X';
+		}
+		// Return the masked Credit Card #
+		return $normalized_value;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -17,10 +17,10 @@
         $ccv_lenght = strlen($normalized_value);
         // Replace all characters of credit card except the last four and dashes
         for ($i = 0; $i < $ccv_lenght; $i++) {
-            if ($normalized_value[ $i ] == '-') {
+            if ($normalized_value[$i] == '-') {
                 continue;
             }
-            $normalized_value[ $i ] = 'X';
+            $normalized_value[$i] = 'X';
         }
         // Return the masked Credit Card #
         return $normalized_value;

core/libraries/form_sections/strategies/sensitive_data_removal/EE_Credit_Card_Sensitive_Data_Removal.strategy.php

Indentation +14 added lines, -14 removed lines

@@ -11,18 +11,18 @@
  */
 class EE_Credit_Card_Sensitive_Data_Removal extends EE_Sensitive_Data_Removal_Base
 {
-    public function remove_sensitive_data($normalized_value)
-    {
-        // Get the cc Length
-        $cc_length = strlen($normalized_value);
-        // Replace all characters of credit card except the last four and dashes
-        for ($i = 0; $i < $cc_length - 4; $i++) {
-            if ($normalized_value[ $i ] == '-') {
-                continue;
-            }
-            $normalized_value[ $i ] = 'X';
-        }
-        // Return the masked Credit Card #
-        return $normalized_value;
-    }
+	public function remove_sensitive_data($normalized_value)
+	{
+		// Get the cc Length
+		$cc_length = strlen($normalized_value);
+		// Replace all characters of credit card except the last four and dashes
+		for ($i = 0; $i < $cc_length - 4; $i++) {
+			if ($normalized_value[ $i ] == '-') {
+				continue;
+			}
+			$normalized_value[ $i ] = 'X';
+		}
+		// Return the masked Credit Card #
+		return $normalized_value;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -17,10 +17,10 @@
         $cc_length = strlen($normalized_value);
         // Replace all characters of credit card except the last four and dashes
         for ($i = 0; $i < $cc_length - 4; $i++) {
-            if ($normalized_value[ $i ] == '-') {
+            if ($normalized_value[$i] == '-') {
                 continue;
             }
-            $normalized_value[ $i ] = 'X';
+            $normalized_value[$i] = 'X';
         }
         // Return the masked Credit Card #
         return $normalized_value;

core/libraries/form_sections/strategies/validation/EE_Max_Length_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     public function get_jquery_validation_rule_array()
     {
         if ($this->_max_length !== EE_INF) {
-            return array( 'maxlength' => $this->_max_length, 'messages' => array( 'maxlength' => $this->get_validation_error_message() ) );
+            return array('maxlength' => $this->_max_length, 'messages' => array('maxlength' => $this->get_validation_error_message()));
         } else {
             return array();
         }

Indentation +34 added lines, -34 removed lines

@@ -11,41 +11,41 @@
  */
 class EE_Max_Length_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    protected $_max_length;
+	protected $_max_length;
 
-    public function __construct($validation_error_message = null, $max_length = EE_INF)
-    {
-        $this->_max_length = $max_length;
-        if ($validation_error_message === null) {
-            $validation_error_message = sprintf(esc_html__('Input is too long. Maximum number of characters is %1$s', 'event_espresso'), $max_length);
-        }
-        parent::__construct($validation_error_message);
-    }
+	public function __construct($validation_error_message = null, $max_length = EE_INF)
+	{
+		$this->_max_length = $max_length;
+		if ($validation_error_message === null) {
+			$validation_error_message = sprintf(esc_html__('Input is too long. Maximum number of characters is %1$s', 'event_espresso'), $max_length);
+		}
+		parent::__construct($validation_error_message);
+	}
 
-    /**
-     * @param $normalized_value
-     */
-    public function validate($normalized_value)
-    {
-        if (
-            $this->_max_length !== EE_INF &&
-                $normalized_value &&
-                is_string($normalized_value) &&
-                 strlen($normalized_value) > $this->_max_length
-        ) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'maxlength');
-        }
-    }
+	/**
+	 * @param $normalized_value
+	 */
+	public function validate($normalized_value)
+	{
+		if (
+			$this->_max_length !== EE_INF &&
+				$normalized_value &&
+				is_string($normalized_value) &&
+				 strlen($normalized_value) > $this->_max_length
+		) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'maxlength');
+		}
+	}
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        if ($this->_max_length !== EE_INF) {
-            return array( 'maxlength' => $this->_max_length, 'messages' => array( 'maxlength' => $this->get_validation_error_message() ) );
-        } else {
-            return array();
-        }
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		if ($this->_max_length !== EE_INF) {
+			return array( 'maxlength' => $this->_max_length, 'messages' => array( 'maxlength' => $this->get_validation_error_message() ) );
+		} else {
+			return array();
+		}
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Min_Length_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -40,6 +40,6 @@
      */
     public function get_jquery_validation_rule_array()
     {
-        return array( 'minlength' => $this->_min_length, 'messages' => array( 'minlength' => $this->get_validation_error_message() ) );
+        return array('minlength' => $this->_min_length, 'messages' => array('minlength' => $this->get_validation_error_message()));
     }
 }

Indentation +27 added lines, -27 removed lines

@@ -11,34 +11,34 @@
  */
 class EE_Min_Length_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    protected $_min_length;
+	protected $_min_length;
 
-    public function __construct($validation_error_message = null, $min_length = 0)
-    {
-        $this->_min_length = $min_length;
-        parent::__construct($validation_error_message);
-    }
+	public function __construct($validation_error_message = null, $min_length = 0)
+	{
+		$this->_min_length = $min_length;
+		parent::__construct($validation_error_message);
+	}
 
-    /**
-     * @param $normalized_value
-     */
-    public function validate($normalized_value)
-    {
-        if (
-            $this->_min_length > 0 &&
-                $normalized_value &&
-                is_string($normalized_value) &&
-                strlen($normalized_value) < $this->_min_length
-        ) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'minlength');
-        }
-    }
+	/**
+	 * @param $normalized_value
+	 */
+	public function validate($normalized_value)
+	{
+		if (
+			$this->_min_length > 0 &&
+				$normalized_value &&
+				is_string($normalized_value) &&
+				strlen($normalized_value) < $this->_min_length
+		) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'minlength');
+		}
+	}
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array( 'minlength' => $this->_min_length, 'messages' => array( 'minlength' => $this->get_validation_error_message() ) );
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array( 'minlength' => $this->_min_length, 'messages' => array( 'minlength' => $this->get_validation_error_message() ) );
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Text_Validation_Strategy.strategy.php

Spacing +3 added lines, -3 removed lines

@@ -29,8 +29,8 @@ 
     public function validate($normalized_value)
     {
         $string_normalized_value = (string) $normalized_value;
-        if ($this->_regex &&  $string_normalized_value) {
-            if (! preg_match($this->_regex, $string_normalized_value)) {
+        if ($this->_regex && $string_normalized_value) {
+            if ( ! preg_match($this->_regex, $string_normalized_value)) {
                 throw new EE_Validation_Error($this->get_validation_error_message(), 'regex');
             }
         }
@@ -42,7 +42,7 @@ 
     public function get_jquery_validation_rule_array()
     {
         if ($this->_regex !== null) {
-            return array( 'regex' => $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) );
+            return array('regex' => $this->regex_js(), 'messages' => array('regex' => $this->get_validation_error_message()));
         } else {
             return array();
         }

Indentation +41 added lines, -41 removed lines

@@ -10,53 +10,53 @@
  */
 class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    protected $_regex = null;
-    /**
-     *
-     * @param string $validation_error_message
-     * @param string $regex a PHP regex; the javascript regex will be derived from this
-     */
-    public function __construct($validation_error_message = null, $regex = null)
-    {
-        $this->_regex = $regex;
-        parent::__construct($validation_error_message);
-    }
+	protected $_regex = null;
+	/**
+	 *
+	 * @param string $validation_error_message
+	 * @param string $regex a PHP regex; the javascript regex will be derived from this
+	 */
+	public function __construct($validation_error_message = null, $regex = null)
+	{
+		$this->_regex = $regex;
+		parent::__construct($validation_error_message);
+	}
 
-    /**
-     * @param $normalized_value
-     */
-    public function validate($normalized_value)
-    {
-        $string_normalized_value = (string) $normalized_value;
-        if ($this->_regex &&  $string_normalized_value) {
-            if (! preg_match($this->_regex, $string_normalized_value)) {
-                throw new EE_Validation_Error($this->get_validation_error_message(), 'regex');
-            }
-        }
-    }
+	/**
+	 * @param $normalized_value
+	 */
+	public function validate($normalized_value)
+	{
+		$string_normalized_value = (string) $normalized_value;
+		if ($this->_regex &&  $string_normalized_value) {
+			if (! preg_match($this->_regex, $string_normalized_value)) {
+				throw new EE_Validation_Error($this->get_validation_error_message(), 'regex');
+			}
+		}
+	}
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        if ($this->_regex !== null) {
-            return array( 'regex' => $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) );
-        } else {
-            return array();
-        }
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		if ($this->_regex !== null) {
+			return array( 'regex' => $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) );
+		} else {
+			return array();
+		}
+	}
 
 /**
  * Translates a PHP regex into a javscript regex (eg, PHP needs separate delimieters, whereas
  * javscript does not
  * @return string
  */
-    public function regex_js()
-    {
-        // first character must be the delimiter
-        $delimeter = $this->_regex[0];
-        $last_occurence_of_delimieter = strrpos($this->_regex, $delimeter);
-        return substr($this->_regex, 1, $last_occurence_of_delimieter - 1);
-    }
+	public function regex_js()
+	{
+		// first character must be the delimiter
+		$delimeter = $this->_regex[0];
+		$last_occurence_of_delimieter = strrpos($this->_regex, $delimeter);
+		return substr($this->_regex, 1, $last_occurence_of_delimieter - 1);
+	}
 }