eventespresso / event-espresso-core

core/db_classes/EE_Checkin.class.php

Indentation +84 added lines, -84 removed lines

@@ -13,88 +13,88 @@
 {
 
 
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @type int
-     */
-    const status_checked_out = 0;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @type int
-     */
-    const status_checked_in = 1;
-
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @type int
-     */
-    const status_checked_never = 2;
-
-
-
-    /**
-     *
-     * @param array  $props_n_values    incoming values
-     * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats      incoming date_formats in an array
-     *                                  where the first value is the date_format
-     *                                  and the second value is the time format
-     * @return EE_Checkin
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Checkin
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    public function ID()
-    {
-        return $this->get('CHK_ID');
-    }
-
-
-    public function registration_id()
-    {
-        return $this->get('REG_ID');
-    }
-
-
-    public function datetime_id()
-    {
-        return $this->get('DTT_ID');
-    }
-
-
-    public function status()
-    {
-        return $this->get('CHK_in');
-    }
-
-
-    public function timestamp()
-    {
-        return $this->get('CHK_timestamp');
-    }
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @type int
+	 */
+	const status_checked_out = 0;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @type int
+	 */
+	const status_checked_in = 1;
+
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @type int
+	 */
+	const status_checked_never = 2;
+
+
+
+	/**
+	 *
+	 * @param array  $props_n_values    incoming values
+	 * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats      incoming date_formats in an array
+	 *                                  where the first value is the date_format
+	 *                                  and the second value is the time format
+	 * @return EE_Checkin
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Checkin
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	public function ID()
+	{
+		return $this->get('CHK_ID');
+	}
+
+
+	public function registration_id()
+	{
+		return $this->get('REG_ID');
+	}
+
+
+	public function datetime_id()
+	{
+		return $this->get('DTT_ID');
+	}
+
+
+	public function status()
+	{
+		return $this->get('CHK_in');
+	}
+
+
+	public function timestamp()
+	{
+		return $this->get('CHK_timestamp');
+	}
 }

core/db_classes/EE_Line_Item.class.php

Indentation +1490 added lines, -1490 removed lines

@@ -18,1496 +18,1496 @@
 class EE_Line_Item extends EE_Base_Class implements EEI_Line_Item
 {
 
-    /**
-     * for children line items (currently not a normal relation)
-     *
-     * @type EE_Line_Item[]
-     */
-    protected $_children = array();
-
-    /**
-     * for the parent line item
-     *
-     * @var EE_Line_Item
-     */
-    protected $_parent;
-
-
-
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Line_Item
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone);
-    }
-
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Line_Item
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-
-    /**
-     * Adds some defaults if they're not specified
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
-    {
-        parent::__construct($fieldValues, $bydb, $timezone);
-        if (! $this->get('LIN_code')) {
-            $this->set_code($this->generate_code());
-        }
-    }
-
-
-
-    /**
-     * Gets ID
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function ID()
-    {
-        return $this->get('LIN_ID');
-    }
-
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     * @throws EE_Error
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        $name = $this->get('LIN_name');
-        if (! $name) {
-            $name = ucwords(str_replace('-', ' ', $this->type()));
-        }
-        return $name;
-    }
-
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('LIN_name', $name);
-    }
-
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function desc()
-    {
-        return $this->get('LIN_desc');
-    }
-
-
-
-    /**
-     * Sets desc
-     *
-     * @param string $desc
-     * @throws EE_Error
-     */
-    public function set_desc($desc)
-    {
-        $this->set('LIN_desc', $desc);
-    }
-
-
-
-    /**
-     * Gets quantity
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function quantity()
-    {
-        return $this->get('LIN_quantity');
-    }
-
-
-
-    /**
-     * Sets quantity
-     *
-     * @param int $quantity
-     * @throws EE_Error
-     */
-    public function set_quantity($quantity)
-    {
-        $this->set('LIN_quantity', max($quantity, 0));
-    }
-
-
-
-    /**
-     * Gets item_id
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function OBJ_ID()
-    {
-        return $this->get('OBJ_ID');
-    }
-
-
-
-    /**
-     * Sets item_id
-     *
-     * @param string $item_id
-     * @throws EE_Error
-     */
-    public function set_OBJ_ID($item_id)
-    {
-        $this->set('OBJ_ID', $item_id);
-    }
-
-
-
-    /**
-     * Gets item_type
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function OBJ_type()
-    {
-        return $this->get('OBJ_type');
-    }
-
-
-
-    /**
-     * Gets item_type
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function OBJ_type_i18n()
-    {
-        $obj_type = $this->OBJ_type();
-        switch ($obj_type) {
-            case 'Event':
-                $obj_type = __('Event', 'event_espresso');
-                break;
-            case 'Price':
-                $obj_type = __('Price', 'event_espresso');
-                break;
-            case 'Promotion':
-                $obj_type = __('Promotion', 'event_espresso');
-                break;
-            case 'Ticket':
-                $obj_type = __('Ticket', 'event_espresso');
-                break;
-            case 'Transaction':
-                $obj_type = __('Transaction', 'event_espresso');
-                break;
-        }
-        return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
-    }
-
-
-
-    /**
-     * Sets item_type
-     *
-     * @param string $OBJ_type
-     * @throws EE_Error
-     */
-    public function set_OBJ_type($OBJ_type)
-    {
-        $this->set('OBJ_type', $OBJ_type);
-    }
-
-
-
-    /**
-     * Gets unit_price
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function unit_price()
-    {
-        return $this->get('LIN_unit_price');
-    }
-
-
-
-    /**
-     * Sets unit_price
-     *
-     * @param float $unit_price
-     * @throws EE_Error
-     */
-    public function set_unit_price($unit_price)
-    {
-        $this->set('LIN_unit_price', $unit_price);
-    }
-
-
-
-    /**
-     * Checks if this item is a percentage modifier or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_percent()
-    {
-        if ($this->is_tax_sub_total()) {
-            //tax subtotals HAVE a percent on them, that percentage only applies
-            //to taxable items, so its' an exception. Treat it like a flat line item
-            return false;
-        }
-        $unit_price = abs($this->get('LIN_unit_price'));
-        $percent = abs($this->get('LIN_percent'));
-        if ($unit_price < .001 && $percent) {
-            return true;
-        }
-        if ($unit_price >= .001 && ! $percent) {
-            return false;
-        }
-        if ($unit_price >= .001 && $percent) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('A Line Item can not have a unit price of (%s) AND a percent (%s)!', 'event_espresso'),
-                    $unit_price, $percent
-                )
-            );
-        }
-        // if they're both 0, assume its not a percent item
-        return false;
-    }
-
-
-
-    /**
-     * Gets percent (between 100-.001)
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function percent()
-    {
-        return $this->get('LIN_percent');
-    }
-
-
-
-    /**
-     * Sets percent (between 100-0.01)
-     *
-     * @param float $percent
-     * @throws EE_Error
-     */
-    public function set_percent($percent)
-    {
-        $this->set('LIN_percent', $percent);
-    }
-
-
-
-    /**
-     * Gets total
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function total()
-    {
-        return $this->get('LIN_total');
-    }
-
-
-
-    /**
-     * Sets total
-     *
-     * @param float $total
-     * @throws EE_Error
-     */
-    public function set_total($total)
-    {
-        $this->set('LIN_total', $total);
-    }
-
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('LIN_order');
-    }
-
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('LIN_order', $order);
-    }
-
-
-
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function parent_ID()
-    {
-        return $this->get('LIN_parent');
-    }
-
-
-
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @throws EE_Error
-     */
-    public function set_parent_ID($parent)
-    {
-        $this->set('LIN_parent', $parent);
-    }
-
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function type()
-    {
-        return $this->get('LIN_type');
-    }
-
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     */
-    public function set_type($type)
-    {
-        $this->set('LIN_type', $type);
-    }
-
-
-
-    /**
-     * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\
-     * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB
-     * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()`
-     * or indirectly by `EE_Line_item::add_child_line_item()`)
-     *
-     * @return EE_Base_Class|EE_Line_Item
-     * @throws EE_Error
-     */
-    public function parent()
-    {
-        return $this->ID()
-            ? $this->get_model()->get_one_by_ID($this->parent_ID())
-            : $this->_parent;
-    }
-
-
-
-    /**
-     * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
-     *
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function children()
-    {
-        if ($this->ID()) {
-            return $this->get_model()->get_all(
-                array(
-                    array('LIN_parent' => $this->ID()),
-                    'order_by' => array('LIN_order' => 'ASC'),
-                )
-            );
-        }
-        if (! is_array($this->_children)) {
-            $this->_children = array();
-        }
-        return $this->_children;
-    }
-
-
-
-    /**
-     * Gets code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function code()
-    {
-        return $this->get('LIN_code');
-    }
-
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @throws EE_Error
-     */
-    public function set_code($code)
-    {
-        $this->set('LIN_code', $code);
-    }
-
-
-
-    /**
-     * Gets is_taxable
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_taxable()
-    {
-        return $this->get('LIN_is_taxable');
-    }
-
-
-
-    /**
-     * Sets is_taxable
-     *
-     * @param boolean $is_taxable
-     * @throws EE_Error
-     */
-    public function set_is_taxable($is_taxable)
-    {
-        $this->set('LIN_is_taxable', $is_taxable);
-    }
-
-
-
-    /**
-     * Gets the object that this model-joins-to.
-     * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on
-     * EEM_Promotion_Object
-     *
-     *        Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object
-     *
-     * @return EE_Base_Class | NULL
-     * @throws EE_Error
-     */
-    public function get_object()
-    {
-        $model_name_of_related_obj = $this->OBJ_type();
-        return $this->get_model()->has_relation($model_name_of_related_obj)
-            ? $this->get_first_related($model_name_of_related_obj)
-            : null;
-    }
-
-
-
-    /**
-     * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket.
-     * (IE, if this line item is for a price or something else, will return NULL)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class|EE_Ticket
-     * @throws EE_Error
-     */
-    public function ticket($query_params = array())
-    {
-        //we're going to assume that when this method is called we always want to receive the attached ticket EVEN if that ticket is archived.  This can be overridden via the incoming $query_params argument
-        $remove_defaults = array('default_where_conditions' => 'none');
-        $query_params = array_merge($remove_defaults, $query_params);
-        return $this->get_first_related('Ticket', $query_params);
-    }
-
-
-
-    /**
-     * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket
-     *
-     * @return EE_Datetime | NULL
-     * @throws EE_Error
-     */
-    public function get_ticket_datetime()
-    {
-        if ($this->OBJ_type() === 'Ticket') {
-            $ticket = $this->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                $datetime = $ticket->first_datetime();
-                if ($datetime instanceof EE_Datetime) {
-                    return $datetime;
-                }
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the event's name that's related to the ticket, if this is for
-     * a ticket
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function ticket_event_name()
-    {
-        $event_name = esc_html__('Unknown', 'event_espresso');
-        $event = $this->ticket_event();
-        if ($event instanceof EE_Event) {
-            $event_name = $event->name();
-        }
-        return $event_name;
-    }
-
-
-    /**
-     * Gets the event that's related to the ticket, if this line item represents a ticket.
-     *
-     * @return EE_Event|null
-     * @throws EE_Error
-     */
-    public function ticket_event()
-    {
-        $event = null;
-        $ticket = $this->ticket();
-        if ($ticket instanceof EE_Ticket) {
-            $datetime = $ticket->first_datetime();
-            if ($datetime instanceof EE_Datetime) {
-                $event = $datetime->event();
-            }
-        }
-        return $event;
-    }
-
-
-
-    /**
-     * Gets the first datetime for this lien item, assuming it's for a ticket
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error
-     */
-    public function ticket_datetime_start($date_format = '', $time_format = '')
-    {
-        $first_datetime_string = esc_html__('Unknown', 'event_espresso');
-        $datetime = $this->get_ticket_datetime();
-        if ($datetime) {
-            $first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
-        }
-        return $first_datetime_string;
-    }
-
-
-
-    /**
-     * Adds the line item as a child to this line item. If there is another child line
-     * item with the same LIN_code, it is overwritten by this new one
-     *
-     * @param EEI_Line_Item $line_item
-     * @param bool          $set_order
-     * @return bool success
-     * @throws EE_Error
-     */
-    public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true)
-    {
-        // should we calculate the LIN_order for this line item ?
-        if ($set_order || $line_item->order() === null) {
-            $line_item->set_order(count($this->children()));
-        }
-        if ($this->ID()) {
-            //check for any duplicate line items (with the same code), if so, this replaces it
-            $line_item_with_same_code = $this->get_child_line_item($line_item->code());
-            if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
-                $this->delete_child_line_item($line_item_with_same_code->code());
-            }
-            $line_item->set_parent_ID($this->ID());
-            if ($this->TXN_ID()) {
-                $line_item->set_TXN_ID($this->TXN_ID());
-            }
-            return $line_item->save();
-        }
-        $this->_children[$line_item->code()] = $line_item;
-        if ($line_item->parent() !== $this) {
-            $line_item->set_parent($this);
-        }
-        return true;
-    }
-
-
-    /**
-     * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation.
-     * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save()
-     * However, if this line item is NOT saved to the DB, this just caches the parent on
-     * the EE_Line_Item::_parent property.
-     *
-     * @param EE_Line_Item $line_item
-     * @throws EE_Error
-     */
-    public function set_parent($line_item)
-    {
-        if ($this->ID()) {
-            if (! $line_item->ID()) {
-                $line_item->save();
-            }
-            $this->set_parent_ID($line_item->ID());
-            $this->save();
-        } else {
-            $this->_parent = $line_item;
-            $this->set_parent_ID($line_item->ID());
-        }
-    }
-
-
-
-    /**
-     * Gets the child line item as specified by its code. Because this returns an object (by reference)
-     * you can modify this child line item and the parent (this object) can know about them
-     * because it also has a reference to that line item
-     *
-     * @param string $code
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_child_line_item($code)
-    {
-        if ($this->ID()) {
-            return $this->get_model()->get_one(
-                array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code))
-            );
-        }
-        return isset($this->_children[$code])
-            ? $this->_children[$code]
-            : null;
-    }
-
-
-
-    /**
-     * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD
-     * cached on it)
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function delete_children_line_items()
-    {
-        if ($this->ID()) {
-            return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
-        }
-        $count = count($this->_children);
-        $this->_children = array();
-        return $count;
-    }
-
-
-
-    /**
-     * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
-     * HAS NOT been saved to the DB, removes the child line item with index $code.
-     * Also searches through the child's children for a matching line item. However, once a line item has been found
-     * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be
-     * deleted)
-     *
-     * @param string $code
-     * @param bool   $stop_search_once_found
-     * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to
-     *             the DB yet)
-     * @throws EE_Error
-     */
-    public function delete_child_line_item($code, $stop_search_once_found = true)
-    {
-        if ($this->ID()) {
-            $items_deleted = 0;
-            if ($this->code() === $code) {
-                $items_deleted += EEH_Line_Item::delete_all_child_items($this);
-                $items_deleted += (int)$this->delete();
-                if ($stop_search_once_found) {
-                    return $items_deleted;
-                }
-            }
-            foreach ($this->children() as $child_line_item) {
-                $items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
-            }
-            return $items_deleted;
-        }
-        if (isset($this->_children[$code])) {
-            unset($this->_children[$code]);
-            return 1;
-        }
-        return 0;
-    }
-
-
-    /**
-     * If this line item is in the database, is of the type subtotal, and
-     * has no children, why do we have it? It should be deleted so this function
-     * does that
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function delete_if_childless_subtotal()
-    {
-        if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
-            return $this->delete();
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Creates a code and returns a string. doesn't assign the code to this model object
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function generate_code()
-    {
-        // each line item in the cart requires a unique identifier
-        return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_tax()
-    {
-        return $this->type() === EEM_Line_Item::type_tax;
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_tax_sub_total()
-    {
-        return $this->type() === EEM_Line_Item::type_tax_sub_total;
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_line_item()
-    {
-        return $this->type() === EEM_Line_Item::type_line_item;
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_sub_line_item()
-    {
-        return $this->type() === EEM_Line_Item::type_sub_line_item;
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_sub_total()
-    {
-        return $this->type() === EEM_Line_Item::type_sub_total;
-    }
-
-
-
-    /**
-     * Whether or not this line item is a cancellation line item
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_cancellation()
-    {
-        return EEM_Line_Item::type_cancellation === $this->type();
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_total()
-    {
-        return $this->type() === EEM_Line_Item::type_total;
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_cancelled()
-    {
-        return $this->type() === EEM_Line_Item::type_cancellation;
-    }
-
-
-
-    /**
-     * @return string like '2, 004.00', formatted according to the localized currency
-     * @throws EE_Error
-     */
-    public function unit_price_no_code()
-    {
-        return $this->get_pretty('LIN_unit_price', 'no_currency_code');
-    }
-
-
-
-    /**
-     * @return string like '2, 004.00', formatted according to the localized currency
-     * @throws EE_Error
-     */
-    public function total_no_code()
-    {
-        return $this->get_pretty('LIN_total', 'no_currency_code');
-    }
-
-
-
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total (provided this line item is allowed to persist, otherwise we don't
-     * want to change a persistable transaction with info from a non-persistent line item)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function recalculate_total_including_taxes()
-    {
-        $pre_tax_total = $this->recalculate_pre_tax_total();
-        $tax_total = $this->recalculate_taxes_and_tax_total();
-        $total = $pre_tax_total + $tax_total;
-        // no negative totals plz
-        $total = max($total, 0);
-        $this->set_total($total);
-        //only update the related transaction's total
-        //if we intend to save this line item and its a grand total
-        if (
-            $this->allow_persist() && $this->type() === EEM_Line_Item::type_total
-            && $this->transaction()
-               instanceof
-               EE_Transaction
-        ) {
-            $this->transaction()->set_total($total);
-            if ($this->transaction()->ID()) {
-                $this->transaction()->save();
-            }
-        }
-        $this->maybe_save();
-        return $total;
-    }
-
-
-    /**
-     * Recursively goes through all the children and recalculates sub-totals EXCEPT for
-     * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
-     * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
-     * when this is called on the grand total
-     *
-     * @return float
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function recalculate_pre_tax_total()
-    {
-        $total = 0;
-        $my_children = $this->children();
-        $has_children = ! empty($my_children);
-        if ($has_children && $this->is_line_item()) {
-            $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
-        } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
-            $total = $this->unit_price() * $this->quantity();
-        } elseif ($this->is_sub_total() || $this->is_total()) {
-            $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
-        } elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
-            // completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
-            return 0;
-        }
-        // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
-        if (
-            ! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation()
-        ) {
-            if ($this->OBJ_type() !== 'Event') {
-                $this->set_quantity(1);
-            }
-            if (! $this->is_percent()) {
-                $this->set_unit_price($total);
-            }
-        }
-        //we don't want to bother saving grand totals, because that needs to factor in taxes anyways
-        //so it ought to be
-        if (! $this->is_total()) {
-            $this->set_total($total);
-            //if not a percent line item, make sure we keep the unit price in sync
-            if (
-                $has_children
-                && $this->is_line_item()
-                && ! $this->is_percent()
-            ) {
-                if ($this->quantity() === 0) {
-                    $new_unit_price = 0;
-                } else {
-                    $new_unit_price = $this->total() / $this->quantity();
-                }
-                $this->set_unit_price($new_unit_price);
-            }
-            $this->maybe_save();
-        }
-        return $total;
-    }
-
-
-
-    /**
-     * Calculates the pretax total when this line item is a subtotal or total line item.
-     * Basically does a sum-then-round approach (ie, any percent line item that are children
-     * will calculate their total based on the un-rounded total we're working with so far, and
-     * THEN round the result; instead of rounding as we go like with sub-line-items)
-     *
-     * @param float          $calculated_total_so_far
-     * @param EE_Line_Item[] $my_children
-     * @return float
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null)
-    {
-        if ($my_children === null) {
-            $my_children = $this->children();
-        }
-        //get the total of all its children
-        foreach ($my_children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
-                // percentage line items are based on total so far
-                if ($child_line_item->is_percent()) {
-                    //round as we go so that the line items add up ok
-                    $percent_total = round(
-                        $calculated_total_so_far * $child_line_item->percent() / 100,
-                        EE_Registry::instance()->CFG->currency->dec_plc
-                    );
-                    $child_line_item->set_total($percent_total);
-                    //so far all percent line items should have a quantity of 1
-                    //(ie, no double percent discounts. Although that might be requested someday)
-                    $child_line_item->set_quantity(1);
-                    $child_line_item->maybe_save();
-                    $calculated_total_so_far += $percent_total;
-                } else {
-                    //verify flat sub-line-item quantities match their parent
-                    if ($child_line_item->is_sub_line_item()) {
-                        $child_line_item->set_quantity($this->quantity());
-                    }
-                    $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
-                }
-            }
-        }
-        if ($this->is_sub_total()) {
-            // no negative totals plz
-            $calculated_total_so_far = max($calculated_total_so_far, 0);
-        }
-        return $calculated_total_so_far;
-    }
-
-
-
-    /**
-     * Calculates the pretax total for a normal line item, in a round-then-sum approach
-     * (where each sub-line-item is applied to the base price for the line item
-     * and the result is immediately rounded, rather than summing all the sub-line-items
-     * then rounding, like we do when recalculating pretax totals on totals and subtotals).
-     *
-     * @param float          $calculated_total_so_far
-     * @param EE_Line_Item[] $my_children
-     * @return float
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null)
-    {
-        if ($my_children === null) {
-            $my_children = $this->children();
-        }
-        //we need to keep track of the running total for a single item,
-        //because we need to round as we go
-        $unit_price_for_total = 0;
-        $quantity_for_total = 1;
-        //get the total of all its children
-        foreach ($my_children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
-                if ($child_line_item->is_percent()) {
-                    //it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
-                    //not total multiplied by percent, because that ignores rounding along-the-way
-                    $percent_unit_price = round(
-                        $unit_price_for_total * $child_line_item->percent() / 100,
-                        EE_Registry::instance()->CFG->currency->dec_plc
-                    );
-                    $percent_total = $percent_unit_price * $quantity_for_total;
-                    $child_line_item->set_total($percent_total);
-                    //so far all percent line items should have a quantity of 1
-                    //(ie, no double percent discounts. Although that might be requested someday)
-                    $child_line_item->set_quantity(1);
-                    $child_line_item->maybe_save();
-                    $calculated_total_so_far += $percent_total;
-                    $unit_price_for_total += $percent_unit_price;
-                } else {
-                    //verify flat sub-line-item quantities match their parent
-                    if ($child_line_item->is_sub_line_item()) {
-                        $child_line_item->set_quantity($this->quantity());
-                    }
-                    $quantity_for_total = $child_line_item->quantity();
-                    $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
-                    $unit_price_for_total += $child_line_item->unit_price();
-                }
-            }
-        }
-        return $calculated_total_so_far;
-    }
-
-
-
-    /**
-     * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
-     * the totals on each tax calculated, and returns the final tax total
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function recalculate_taxes_and_tax_total()
-    {
-        //get all taxes
-        $taxes = $this->tax_descendants();
-        //calculate the pretax total
-        $taxable_total = $this->taxable_total();
-        $tax_total = 0;
-        foreach ($taxes as $tax) {
-            $total_on_this_tax = $taxable_total * $tax->percent() / 100;
-            //remember the total on this line item
-            $tax->set_total($total_on_this_tax);
-            $tax_total += $tax->total();
-        }
-        $this->_recalculate_tax_sub_total();
-        return $tax_total;
-    }
-
-
-
-    /**
-     * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    private function _recalculate_tax_sub_total()
-    {
-        if ($this->is_tax_sub_total()) {
-            $total = 0;
-            $total_percent = 0;
-            //simply loop through all its children (which should be taxes) and sum their total
-            foreach ($this->children() as $child_tax) {
-                if ($child_tax instanceof EE_Line_Item) {
-                    $total += $child_tax->total();
-                    $total_percent += $child_tax->percent();
-                }
-            }
-            $this->set_total($total);
-            $this->set_percent($total_percent);
-        } elseif ($this->is_total()) {
-            foreach ($this->children() as $maybe_tax_subtotal) {
-                if ($maybe_tax_subtotal instanceof EE_Line_Item) {
-                    $maybe_tax_subtotal->_recalculate_tax_sub_total();
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Gets the total tax on this line item. Assumes taxes have already been calculated using
-     * recalculate_taxes_and_total
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function get_total_tax()
-    {
-        $this->_recalculate_tax_sub_total();
-        $total = 0;
-        foreach ($this->tax_descendants() as $tax_line_item) {
-            if ($tax_line_item instanceof EE_Line_Item) {
-                $total += $tax_line_item->total();
-            }
-        }
-        return $total;
-    }
-
-
-    /**
-     * Gets the total for all the items purchased only
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function get_items_total()
-    {
-        //by default, let's make sure we're consistent with the existing line item
-        if ($this->is_total()) {
-            $pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
-            if ($pretax_subtotal_li instanceof EE_Line_Item) {
-                return $pretax_subtotal_li->total();
-            }
-        }
-        $total = 0;
-        foreach ($this->get_items() as $item) {
-            if ($item instanceof EE_Line_Item) {
-                $total += $item->total();
-            }
-        }
-        return $total;
-    }
-
-
-
-    /**
-     * Gets all the descendants (ie, children or children of children etc) that
-     * are of the type 'tax'
-     *
-     * @return EE_Line_Item[]
-     */
-    public function tax_descendants()
-    {
-        return EEH_Line_Item::get_tax_descendants($this);
-    }
-
-
-
-    /**
-     * Gets all the real items purchased which are children of this item
-     *
-     * @return EE_Line_Item[]
-     */
-    public function get_items()
-    {
-        return EEH_Line_Item::get_line_item_descendants($this);
-    }
-
-
-
-    /**
-     * Returns the amount taxable among this line item's children (or if it has no children,
-     * how much of it is taxable). Does not recalculate totals or subtotals.
-     * If the taxable total is negative, (eg, if none of the tickets were taxable,
-     * but there is a "Taxable" discount), returns 0.
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function taxable_total()
-    {
-        $total = 0;
-        if ($this->children()) {
-            foreach ($this->children() as $child_line_item) {
-                if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
-                    //if it's a percent item, only take into account the percent
-                    //that's taxable too (the taxable total so far)
-                    if ($child_line_item->is_percent()) {
-                        $total += ($total * $child_line_item->percent() / 100);
-                    } else {
-                        $total += $child_line_item->total();
-                    }
-                } elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
-                    $total += $child_line_item->taxable_total();
-                }
-            }
-        }
-        return max($total, 0);
-    }
-
-
-
-    /**
-     * Gets the transaction for this line item
-     *
-     * @return EE_Base_Class|EE_Transaction
-     * @throws EE_Error
-     */
-    public function transaction()
-    {
-        return $this->get_first_related('Transaction');
-    }
-
-
-
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     * Because there currently is no proper parent-child relation on the model,
-     * save_this_and_cached() will NOT save the descendants.
-     * Also sets the transaction on this line item and all its descendants before saving
-     *
-     * @param int $txn_id if none is provided, assumes $this->TXN_ID()
-     * @return int count of items saved
-     * @throws EE_Error
-     */
-    public function save_this_and_descendants_to_txn($txn_id = null)
-    {
-        $count = 0;
-        if (! $txn_id) {
-            $txn_id = $this->TXN_ID();
-        }
-        $this->set_TXN_ID($txn_id);
-        $children = $this->children();
-        $count += $this->save()
-            ? 1
-            : 0;
-        foreach ($children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $child_line_item->set_parent_ID($this->ID());
-                $count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
-            }
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     *
-     * @return int count of items saved
-     * @throws EE_Error
-     */
-    public function save_this_and_descendants()
-    {
-        $count = 0;
-        $children = $this->children();
-        $count += $this->save()
-            ? 1
-            : 0;
-        foreach ($children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $child_line_item->set_parent_ID($this->ID());
-                $count += $child_line_item->save_this_and_descendants();
-            }
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * returns the cancellation line item if this item was cancelled
-     *
-     * @return EE_Line_Item[]
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function get_cancellations()
-    {
-        EE_Registry::instance()->load_helper('Line_Item');
-        return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
-    }
-
-
-
-    /**
-     * If this item has an ID, then this saves it again to update the db
-     *
-     * @return int count of items saved
-     * @throws EE_Error
-     */
-    public function maybe_save()
-    {
-        if ($this->ID()) {
-            return $this->save();
-        }
-        return false;
-    }
-
-
-    /**
-     * clears the cached children and parent from the line item
-     *
-     * @return void
-     */
-    public function clear_related_line_item_cache()
-    {
-        $this->_children = array();
-        $this->_parent = null;
-    }
-
-
-
-    /**
-     * @param bool $raw
-     * @return int
-     * @throws EE_Error
-     */
-    public function timestamp($raw = false)
-    {
-        return $raw
-            ? $this->get_raw('LIN_timestamp')
-            : $this->get('LIN_timestamp');
-    }
-
-
-
-
-    /************************* DEPRECATED *************************/
-    /**
-     * @deprecated 4.6.0
-     * @param string $type one of the constants on EEM_Line_Item
-     * @return EE_Line_Item[]
-     */
-    protected function _get_descendants_of_type($type)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Line_Item::_get_descendants_of_type()',
-            __('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0'
-        );
-        return EEH_Line_Item::get_descendants_of_type($this, $type);
-    }
-
-
-
-    /**
-     * @deprecated 4.6.0
-     * @param string $type like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     */
-    public function get_nearest_descendant_of_type($type)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Line_Item::get_nearest_descendant_of_type()',
-            __('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0'
-        );
-        return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
-    }
+	/**
+	 * for children line items (currently not a normal relation)
+	 *
+	 * @type EE_Line_Item[]
+	 */
+	protected $_children = array();
+
+	/**
+	 * for the parent line item
+	 *
+	 * @var EE_Line_Item
+	 */
+	protected $_parent;
+
+
+
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone);
+	}
+
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+
+	/**
+	 * Adds some defaults if they're not specified
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
+	{
+		parent::__construct($fieldValues, $bydb, $timezone);
+		if (! $this->get('LIN_code')) {
+			$this->set_code($this->generate_code());
+		}
+	}
+
+
+
+	/**
+	 * Gets ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function ID()
+	{
+		return $this->get('LIN_ID');
+	}
+
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 * @throws EE_Error
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		$name = $this->get('LIN_name');
+		if (! $name) {
+			$name = ucwords(str_replace('-', ' ', $this->type()));
+		}
+		return $name;
+	}
+
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('LIN_name', $name);
+	}
+
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function desc()
+	{
+		return $this->get('LIN_desc');
+	}
+
+
+
+	/**
+	 * Sets desc
+	 *
+	 * @param string $desc
+	 * @throws EE_Error
+	 */
+	public function set_desc($desc)
+	{
+		$this->set('LIN_desc', $desc);
+	}
+
+
+
+	/**
+	 * Gets quantity
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function quantity()
+	{
+		return $this->get('LIN_quantity');
+	}
+
+
+
+	/**
+	 * Sets quantity
+	 *
+	 * @param int $quantity
+	 * @throws EE_Error
+	 */
+	public function set_quantity($quantity)
+	{
+		$this->set('LIN_quantity', max($quantity, 0));
+	}
+
+
+
+	/**
+	 * Gets item_id
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function OBJ_ID()
+	{
+		return $this->get('OBJ_ID');
+	}
+
+
+
+	/**
+	 * Sets item_id
+	 *
+	 * @param string $item_id
+	 * @throws EE_Error
+	 */
+	public function set_OBJ_ID($item_id)
+	{
+		$this->set('OBJ_ID', $item_id);
+	}
+
+
+
+	/**
+	 * Gets item_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function OBJ_type()
+	{
+		return $this->get('OBJ_type');
+	}
+
+
+
+	/**
+	 * Gets item_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function OBJ_type_i18n()
+	{
+		$obj_type = $this->OBJ_type();
+		switch ($obj_type) {
+			case 'Event':
+				$obj_type = __('Event', 'event_espresso');
+				break;
+			case 'Price':
+				$obj_type = __('Price', 'event_espresso');
+				break;
+			case 'Promotion':
+				$obj_type = __('Promotion', 'event_espresso');
+				break;
+			case 'Ticket':
+				$obj_type = __('Ticket', 'event_espresso');
+				break;
+			case 'Transaction':
+				$obj_type = __('Transaction', 'event_espresso');
+				break;
+		}
+		return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
+	}
+
+
+
+	/**
+	 * Sets item_type
+	 *
+	 * @param string $OBJ_type
+	 * @throws EE_Error
+	 */
+	public function set_OBJ_type($OBJ_type)
+	{
+		$this->set('OBJ_type', $OBJ_type);
+	}
+
+
+
+	/**
+	 * Gets unit_price
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function unit_price()
+	{
+		return $this->get('LIN_unit_price');
+	}
+
+
+
+	/**
+	 * Sets unit_price
+	 *
+	 * @param float $unit_price
+	 * @throws EE_Error
+	 */
+	public function set_unit_price($unit_price)
+	{
+		$this->set('LIN_unit_price', $unit_price);
+	}
+
+
+
+	/**
+	 * Checks if this item is a percentage modifier or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_percent()
+	{
+		if ($this->is_tax_sub_total()) {
+			//tax subtotals HAVE a percent on them, that percentage only applies
+			//to taxable items, so its' an exception. Treat it like a flat line item
+			return false;
+		}
+		$unit_price = abs($this->get('LIN_unit_price'));
+		$percent = abs($this->get('LIN_percent'));
+		if ($unit_price < .001 && $percent) {
+			return true;
+		}
+		if ($unit_price >= .001 && ! $percent) {
+			return false;
+		}
+		if ($unit_price >= .001 && $percent) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('A Line Item can not have a unit price of (%s) AND a percent (%s)!', 'event_espresso'),
+					$unit_price, $percent
+				)
+			);
+		}
+		// if they're both 0, assume its not a percent item
+		return false;
+	}
+
+
+
+	/**
+	 * Gets percent (between 100-.001)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function percent()
+	{
+		return $this->get('LIN_percent');
+	}
+
+
+
+	/**
+	 * Sets percent (between 100-0.01)
+	 *
+	 * @param float $percent
+	 * @throws EE_Error
+	 */
+	public function set_percent($percent)
+	{
+		$this->set('LIN_percent', $percent);
+	}
+
+
+
+	/**
+	 * Gets total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function total()
+	{
+		return $this->get('LIN_total');
+	}
+
+
+
+	/**
+	 * Sets total
+	 *
+	 * @param float $total
+	 * @throws EE_Error
+	 */
+	public function set_total($total)
+	{
+		$this->set('LIN_total', $total);
+	}
+
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('LIN_order');
+	}
+
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('LIN_order', $order);
+	}
+
+
+
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function parent_ID()
+	{
+		return $this->get('LIN_parent');
+	}
+
+
+
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @throws EE_Error
+	 */
+	public function set_parent_ID($parent)
+	{
+		$this->set('LIN_parent', $parent);
+	}
+
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function type()
+	{
+		return $this->get('LIN_type');
+	}
+
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 */
+	public function set_type($type)
+	{
+		$this->set('LIN_type', $type);
+	}
+
+
+
+	/**
+	 * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\
+	 * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB
+	 * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()`
+	 * or indirectly by `EE_Line_item::add_child_line_item()`)
+	 *
+	 * @return EE_Base_Class|EE_Line_Item
+	 * @throws EE_Error
+	 */
+	public function parent()
+	{
+		return $this->ID()
+			? $this->get_model()->get_one_by_ID($this->parent_ID())
+			: $this->_parent;
+	}
+
+
+
+	/**
+	 * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
+	 *
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function children()
+	{
+		if ($this->ID()) {
+			return $this->get_model()->get_all(
+				array(
+					array('LIN_parent' => $this->ID()),
+					'order_by' => array('LIN_order' => 'ASC'),
+				)
+			);
+		}
+		if (! is_array($this->_children)) {
+			$this->_children = array();
+		}
+		return $this->_children;
+	}
+
+
+
+	/**
+	 * Gets code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function code()
+	{
+		return $this->get('LIN_code');
+	}
+
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @throws EE_Error
+	 */
+	public function set_code($code)
+	{
+		$this->set('LIN_code', $code);
+	}
+
+
+
+	/**
+	 * Gets is_taxable
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_taxable()
+	{
+		return $this->get('LIN_is_taxable');
+	}
+
+
+
+	/**
+	 * Sets is_taxable
+	 *
+	 * @param boolean $is_taxable
+	 * @throws EE_Error
+	 */
+	public function set_is_taxable($is_taxable)
+	{
+		$this->set('LIN_is_taxable', $is_taxable);
+	}
+
+
+
+	/**
+	 * Gets the object that this model-joins-to.
+	 * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on
+	 * EEM_Promotion_Object
+	 *
+	 *        Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object
+	 *
+	 * @return EE_Base_Class | NULL
+	 * @throws EE_Error
+	 */
+	public function get_object()
+	{
+		$model_name_of_related_obj = $this->OBJ_type();
+		return $this->get_model()->has_relation($model_name_of_related_obj)
+			? $this->get_first_related($model_name_of_related_obj)
+			: null;
+	}
+
+
+
+	/**
+	 * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket.
+	 * (IE, if this line item is for a price or something else, will return NULL)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class|EE_Ticket
+	 * @throws EE_Error
+	 */
+	public function ticket($query_params = array())
+	{
+		//we're going to assume that when this method is called we always want to receive the attached ticket EVEN if that ticket is archived.  This can be overridden via the incoming $query_params argument
+		$remove_defaults = array('default_where_conditions' => 'none');
+		$query_params = array_merge($remove_defaults, $query_params);
+		return $this->get_first_related('Ticket', $query_params);
+	}
+
+
+
+	/**
+	 * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket
+	 *
+	 * @return EE_Datetime | NULL
+	 * @throws EE_Error
+	 */
+	public function get_ticket_datetime()
+	{
+		if ($this->OBJ_type() === 'Ticket') {
+			$ticket = $this->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				$datetime = $ticket->first_datetime();
+				if ($datetime instanceof EE_Datetime) {
+					return $datetime;
+				}
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the event's name that's related to the ticket, if this is for
+	 * a ticket
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function ticket_event_name()
+	{
+		$event_name = esc_html__('Unknown', 'event_espresso');
+		$event = $this->ticket_event();
+		if ($event instanceof EE_Event) {
+			$event_name = $event->name();
+		}
+		return $event_name;
+	}
+
+
+	/**
+	 * Gets the event that's related to the ticket, if this line item represents a ticket.
+	 *
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 */
+	public function ticket_event()
+	{
+		$event = null;
+		$ticket = $this->ticket();
+		if ($ticket instanceof EE_Ticket) {
+			$datetime = $ticket->first_datetime();
+			if ($datetime instanceof EE_Datetime) {
+				$event = $datetime->event();
+			}
+		}
+		return $event;
+	}
+
+
+
+	/**
+	 * Gets the first datetime for this lien item, assuming it's for a ticket
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function ticket_datetime_start($date_format = '', $time_format = '')
+	{
+		$first_datetime_string = esc_html__('Unknown', 'event_espresso');
+		$datetime = $this->get_ticket_datetime();
+		if ($datetime) {
+			$first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
+		}
+		return $first_datetime_string;
+	}
+
+
+
+	/**
+	 * Adds the line item as a child to this line item. If there is another child line
+	 * item with the same LIN_code, it is overwritten by this new one
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @param bool          $set_order
+	 * @return bool success
+	 * @throws EE_Error
+	 */
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true)
+	{
+		// should we calculate the LIN_order for this line item ?
+		if ($set_order || $line_item->order() === null) {
+			$line_item->set_order(count($this->children()));
+		}
+		if ($this->ID()) {
+			//check for any duplicate line items (with the same code), if so, this replaces it
+			$line_item_with_same_code = $this->get_child_line_item($line_item->code());
+			if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
+				$this->delete_child_line_item($line_item_with_same_code->code());
+			}
+			$line_item->set_parent_ID($this->ID());
+			if ($this->TXN_ID()) {
+				$line_item->set_TXN_ID($this->TXN_ID());
+			}
+			return $line_item->save();
+		}
+		$this->_children[$line_item->code()] = $line_item;
+		if ($line_item->parent() !== $this) {
+			$line_item->set_parent($this);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation.
+	 * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save()
+	 * However, if this line item is NOT saved to the DB, this just caches the parent on
+	 * the EE_Line_Item::_parent property.
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @throws EE_Error
+	 */
+	public function set_parent($line_item)
+	{
+		if ($this->ID()) {
+			if (! $line_item->ID()) {
+				$line_item->save();
+			}
+			$this->set_parent_ID($line_item->ID());
+			$this->save();
+		} else {
+			$this->_parent = $line_item;
+			$this->set_parent_ID($line_item->ID());
+		}
+	}
+
+
+
+	/**
+	 * Gets the child line item as specified by its code. Because this returns an object (by reference)
+	 * you can modify this child line item and the parent (this object) can know about them
+	 * because it also has a reference to that line item
+	 *
+	 * @param string $code
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_child_line_item($code)
+	{
+		if ($this->ID()) {
+			return $this->get_model()->get_one(
+				array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code))
+			);
+		}
+		return isset($this->_children[$code])
+			? $this->_children[$code]
+			: null;
+	}
+
+
+
+	/**
+	 * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD
+	 * cached on it)
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function delete_children_line_items()
+	{
+		if ($this->ID()) {
+			return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
+		}
+		$count = count($this->_children);
+		$this->_children = array();
+		return $count;
+	}
+
+
+
+	/**
+	 * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
+	 * HAS NOT been saved to the DB, removes the child line item with index $code.
+	 * Also searches through the child's children for a matching line item. However, once a line item has been found
+	 * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be
+	 * deleted)
+	 *
+	 * @param string $code
+	 * @param bool   $stop_search_once_found
+	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to
+	 *             the DB yet)
+	 * @throws EE_Error
+	 */
+	public function delete_child_line_item($code, $stop_search_once_found = true)
+	{
+		if ($this->ID()) {
+			$items_deleted = 0;
+			if ($this->code() === $code) {
+				$items_deleted += EEH_Line_Item::delete_all_child_items($this);
+				$items_deleted += (int)$this->delete();
+				if ($stop_search_once_found) {
+					return $items_deleted;
+				}
+			}
+			foreach ($this->children() as $child_line_item) {
+				$items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
+			}
+			return $items_deleted;
+		}
+		if (isset($this->_children[$code])) {
+			unset($this->_children[$code]);
+			return 1;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * If this line item is in the database, is of the type subtotal, and
+	 * has no children, why do we have it? It should be deleted so this function
+	 * does that
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function delete_if_childless_subtotal()
+	{
+		if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
+			return $this->delete();
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Creates a code and returns a string. doesn't assign the code to this model object
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function generate_code()
+	{
+		// each line item in the cart requires a unique identifier
+		return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_tax()
+	{
+		return $this->type() === EEM_Line_Item::type_tax;
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_tax_sub_total()
+	{
+		return $this->type() === EEM_Line_Item::type_tax_sub_total;
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_line_item()
+	{
+		return $this->type() === EEM_Line_Item::type_line_item;
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_sub_line_item()
+	{
+		return $this->type() === EEM_Line_Item::type_sub_line_item;
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_sub_total()
+	{
+		return $this->type() === EEM_Line_Item::type_sub_total;
+	}
+
+
+
+	/**
+	 * Whether or not this line item is a cancellation line item
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_cancellation()
+	{
+		return EEM_Line_Item::type_cancellation === $this->type();
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_total()
+	{
+		return $this->type() === EEM_Line_Item::type_total;
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_cancelled()
+	{
+		return $this->type() === EEM_Line_Item::type_cancellation;
+	}
+
+
+
+	/**
+	 * @return string like '2, 004.00', formatted according to the localized currency
+	 * @throws EE_Error
+	 */
+	public function unit_price_no_code()
+	{
+		return $this->get_pretty('LIN_unit_price', 'no_currency_code');
+	}
+
+
+
+	/**
+	 * @return string like '2, 004.00', formatted according to the localized currency
+	 * @throws EE_Error
+	 */
+	public function total_no_code()
+	{
+		return $this->get_pretty('LIN_total', 'no_currency_code');
+	}
+
+
+
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total (provided this line item is allowed to persist, otherwise we don't
+	 * want to change a persistable transaction with info from a non-persistent line item)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function recalculate_total_including_taxes()
+	{
+		$pre_tax_total = $this->recalculate_pre_tax_total();
+		$tax_total = $this->recalculate_taxes_and_tax_total();
+		$total = $pre_tax_total + $tax_total;
+		// no negative totals plz
+		$total = max($total, 0);
+		$this->set_total($total);
+		//only update the related transaction's total
+		//if we intend to save this line item and its a grand total
+		if (
+			$this->allow_persist() && $this->type() === EEM_Line_Item::type_total
+			&& $this->transaction()
+			   instanceof
+			   EE_Transaction
+		) {
+			$this->transaction()->set_total($total);
+			if ($this->transaction()->ID()) {
+				$this->transaction()->save();
+			}
+		}
+		$this->maybe_save();
+		return $total;
+	}
+
+
+	/**
+	 * Recursively goes through all the children and recalculates sub-totals EXCEPT for
+	 * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
+	 * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
+	 * when this is called on the grand total
+	 *
+	 * @return float
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function recalculate_pre_tax_total()
+	{
+		$total = 0;
+		$my_children = $this->children();
+		$has_children = ! empty($my_children);
+		if ($has_children && $this->is_line_item()) {
+			$total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
+		} elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
+			$total = $this->unit_price() * $this->quantity();
+		} elseif ($this->is_sub_total() || $this->is_total()) {
+			$total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
+		} elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
+			// completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
+			return 0;
+		}
+		// ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
+		if (
+			! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation()
+		) {
+			if ($this->OBJ_type() !== 'Event') {
+				$this->set_quantity(1);
+			}
+			if (! $this->is_percent()) {
+				$this->set_unit_price($total);
+			}
+		}
+		//we don't want to bother saving grand totals, because that needs to factor in taxes anyways
+		//so it ought to be
+		if (! $this->is_total()) {
+			$this->set_total($total);
+			//if not a percent line item, make sure we keep the unit price in sync
+			if (
+				$has_children
+				&& $this->is_line_item()
+				&& ! $this->is_percent()
+			) {
+				if ($this->quantity() === 0) {
+					$new_unit_price = 0;
+				} else {
+					$new_unit_price = $this->total() / $this->quantity();
+				}
+				$this->set_unit_price($new_unit_price);
+			}
+			$this->maybe_save();
+		}
+		return $total;
+	}
+
+
+
+	/**
+	 * Calculates the pretax total when this line item is a subtotal or total line item.
+	 * Basically does a sum-then-round approach (ie, any percent line item that are children
+	 * will calculate their total based on the un-rounded total we're working with so far, and
+	 * THEN round the result; instead of rounding as we go like with sub-line-items)
+	 *
+	 * @param float          $calculated_total_so_far
+	 * @param EE_Line_Item[] $my_children
+	 * @return float
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null)
+	{
+		if ($my_children === null) {
+			$my_children = $this->children();
+		}
+		//get the total of all its children
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
+				// percentage line items are based on total so far
+				if ($child_line_item->is_percent()) {
+					//round as we go so that the line items add up ok
+					$percent_total = round(
+						$calculated_total_so_far * $child_line_item->percent() / 100,
+						EE_Registry::instance()->CFG->currency->dec_plc
+					);
+					$child_line_item->set_total($percent_total);
+					//so far all percent line items should have a quantity of 1
+					//(ie, no double percent discounts. Although that might be requested someday)
+					$child_line_item->set_quantity(1);
+					$child_line_item->maybe_save();
+					$calculated_total_so_far += $percent_total;
+				} else {
+					//verify flat sub-line-item quantities match their parent
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
+					}
+					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
+				}
+			}
+		}
+		if ($this->is_sub_total()) {
+			// no negative totals plz
+			$calculated_total_so_far = max($calculated_total_so_far, 0);
+		}
+		return $calculated_total_so_far;
+	}
+
+
+
+	/**
+	 * Calculates the pretax total for a normal line item, in a round-then-sum approach
+	 * (where each sub-line-item is applied to the base price for the line item
+	 * and the result is immediately rounded, rather than summing all the sub-line-items
+	 * then rounding, like we do when recalculating pretax totals on totals and subtotals).
+	 *
+	 * @param float          $calculated_total_so_far
+	 * @param EE_Line_Item[] $my_children
+	 * @return float
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null)
+	{
+		if ($my_children === null) {
+			$my_children = $this->children();
+		}
+		//we need to keep track of the running total for a single item,
+		//because we need to round as we go
+		$unit_price_for_total = 0;
+		$quantity_for_total = 1;
+		//get the total of all its children
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
+				if ($child_line_item->is_percent()) {
+					//it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
+					//not total multiplied by percent, because that ignores rounding along-the-way
+					$percent_unit_price = round(
+						$unit_price_for_total * $child_line_item->percent() / 100,
+						EE_Registry::instance()->CFG->currency->dec_plc
+					);
+					$percent_total = $percent_unit_price * $quantity_for_total;
+					$child_line_item->set_total($percent_total);
+					//so far all percent line items should have a quantity of 1
+					//(ie, no double percent discounts. Although that might be requested someday)
+					$child_line_item->set_quantity(1);
+					$child_line_item->maybe_save();
+					$calculated_total_so_far += $percent_total;
+					$unit_price_for_total += $percent_unit_price;
+				} else {
+					//verify flat sub-line-item quantities match their parent
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
+					}
+					$quantity_for_total = $child_line_item->quantity();
+					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
+					$unit_price_for_total += $child_line_item->unit_price();
+				}
+			}
+		}
+		return $calculated_total_so_far;
+	}
+
+
+
+	/**
+	 * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
+	 * the totals on each tax calculated, and returns the final tax total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function recalculate_taxes_and_tax_total()
+	{
+		//get all taxes
+		$taxes = $this->tax_descendants();
+		//calculate the pretax total
+		$taxable_total = $this->taxable_total();
+		$tax_total = 0;
+		foreach ($taxes as $tax) {
+			$total_on_this_tax = $taxable_total * $tax->percent() / 100;
+			//remember the total on this line item
+			$tax->set_total($total_on_this_tax);
+			$tax_total += $tax->total();
+		}
+		$this->_recalculate_tax_sub_total();
+		return $tax_total;
+	}
+
+
+
+	/**
+	 * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _recalculate_tax_sub_total()
+	{
+		if ($this->is_tax_sub_total()) {
+			$total = 0;
+			$total_percent = 0;
+			//simply loop through all its children (which should be taxes) and sum their total
+			foreach ($this->children() as $child_tax) {
+				if ($child_tax instanceof EE_Line_Item) {
+					$total += $child_tax->total();
+					$total_percent += $child_tax->percent();
+				}
+			}
+			$this->set_total($total);
+			$this->set_percent($total_percent);
+		} elseif ($this->is_total()) {
+			foreach ($this->children() as $maybe_tax_subtotal) {
+				if ($maybe_tax_subtotal instanceof EE_Line_Item) {
+					$maybe_tax_subtotal->_recalculate_tax_sub_total();
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Gets the total tax on this line item. Assumes taxes have already been calculated using
+	 * recalculate_taxes_and_total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function get_total_tax()
+	{
+		$this->_recalculate_tax_sub_total();
+		$total = 0;
+		foreach ($this->tax_descendants() as $tax_line_item) {
+			if ($tax_line_item instanceof EE_Line_Item) {
+				$total += $tax_line_item->total();
+			}
+		}
+		return $total;
+	}
+
+
+	/**
+	 * Gets the total for all the items purchased only
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function get_items_total()
+	{
+		//by default, let's make sure we're consistent with the existing line item
+		if ($this->is_total()) {
+			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
+			if ($pretax_subtotal_li instanceof EE_Line_Item) {
+				return $pretax_subtotal_li->total();
+			}
+		}
+		$total = 0;
+		foreach ($this->get_items() as $item) {
+			if ($item instanceof EE_Line_Item) {
+				$total += $item->total();
+			}
+		}
+		return $total;
+	}
+
+
+
+	/**
+	 * Gets all the descendants (ie, children or children of children etc) that
+	 * are of the type 'tax'
+	 *
+	 * @return EE_Line_Item[]
+	 */
+	public function tax_descendants()
+	{
+		return EEH_Line_Item::get_tax_descendants($this);
+	}
+
+
+
+	/**
+	 * Gets all the real items purchased which are children of this item
+	 *
+	 * @return EE_Line_Item[]
+	 */
+	public function get_items()
+	{
+		return EEH_Line_Item::get_line_item_descendants($this);
+	}
+
+
+
+	/**
+	 * Returns the amount taxable among this line item's children (or if it has no children,
+	 * how much of it is taxable). Does not recalculate totals or subtotals.
+	 * If the taxable total is negative, (eg, if none of the tickets were taxable,
+	 * but there is a "Taxable" discount), returns 0.
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function taxable_total()
+	{
+		$total = 0;
+		if ($this->children()) {
+			foreach ($this->children() as $child_line_item) {
+				if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
+					//if it's a percent item, only take into account the percent
+					//that's taxable too (the taxable total so far)
+					if ($child_line_item->is_percent()) {
+						$total += ($total * $child_line_item->percent() / 100);
+					} else {
+						$total += $child_line_item->total();
+					}
+				} elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
+					$total += $child_line_item->taxable_total();
+				}
+			}
+		}
+		return max($total, 0);
+	}
+
+
+
+	/**
+	 * Gets the transaction for this line item
+	 *
+	 * @return EE_Base_Class|EE_Transaction
+	 * @throws EE_Error
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related('Transaction');
+	}
+
+
+
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 * Because there currently is no proper parent-child relation on the model,
+	 * save_this_and_cached() will NOT save the descendants.
+	 * Also sets the transaction on this line item and all its descendants before saving
+	 *
+	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 */
+	public function save_this_and_descendants_to_txn($txn_id = null)
+	{
+		$count = 0;
+		if (! $txn_id) {
+			$txn_id = $this->TXN_ID();
+		}
+		$this->set_TXN_ID($txn_id);
+		$children = $this->children();
+		$count += $this->save()
+			? 1
+			: 0;
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
+			}
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 *
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 */
+	public function save_this_and_descendants()
+	{
+		$count = 0;
+		$children = $this->children();
+		$count += $this->save()
+			? 1
+			: 0;
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants();
+			}
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * returns the cancellation line item if this item was cancelled
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function get_cancellations()
+	{
+		EE_Registry::instance()->load_helper('Line_Item');
+		return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
+	}
+
+
+
+	/**
+	 * If this item has an ID, then this saves it again to update the db
+	 *
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 */
+	public function maybe_save()
+	{
+		if ($this->ID()) {
+			return $this->save();
+		}
+		return false;
+	}
+
+
+	/**
+	 * clears the cached children and parent from the line item
+	 *
+	 * @return void
+	 */
+	public function clear_related_line_item_cache()
+	{
+		$this->_children = array();
+		$this->_parent = null;
+	}
+
+
+
+	/**
+	 * @param bool $raw
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function timestamp($raw = false)
+	{
+		return $raw
+			? $this->get_raw('LIN_timestamp')
+			: $this->get('LIN_timestamp');
+	}
+
+
+
+
+	/************************* DEPRECATED *************************/
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type one of the constants on EEM_Line_Item
+	 * @return EE_Line_Item[]
+	 */
+	protected function _get_descendants_of_type($type)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Line_Item::_get_descendants_of_type()',
+			__('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0'
+		);
+		return EEH_Line_Item::get_descendants_of_type($this, $type);
+	}
+
+
+
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 */
+	public function get_nearest_descendant_of_type($type)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Line_Item::get_nearest_descendant_of_type()',
+			__('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0'
+		);
+		return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
+	}
 
 
 

Spacing +10 added lines, -10 removed lines

@@ -79,7 +79,7 @@ 
     protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
     {
         parent::__construct($fieldValues, $bydb, $timezone);
-        if (! $this->get('LIN_code')) {
+        if ( ! $this->get('LIN_code')) {
             $this->set_code($this->generate_code());
         }
     }
@@ -134,7 +134,7 @@ 
     public function name()
     {
         $name = $this->get('LIN_name');
-        if (! $name) {
+        if ( ! $name) {
             $name = ucwords(str_replace('-', ' ', $this->type()));
         }
         return $name;
@@ -515,7 +515,7 @@ 
                 )
             );
         }
-        if (! is_array($this->_children)) {
+        if ( ! is_array($this->_children)) {
             $this->_children = array();
         }
         return $this->_children;
@@ -741,7 +741,7 @@ 
     public function set_parent($line_item)
     {
         if ($this->ID()) {
-            if (! $line_item->ID()) {
+            if ( ! $line_item->ID()) {
                 $line_item->save();
             }
             $this->set_parent_ID($line_item->ID());
@@ -815,7 +815,7 @@ 
             $items_deleted = 0;
             if ($this->code() === $code) {
                 $items_deleted += EEH_Line_Item::delete_all_child_items($this);
-                $items_deleted += (int)$this->delete();
+                $items_deleted += (int) $this->delete();
                 if ($stop_search_once_found) {
                     return $items_deleted;
                 }
@@ -860,7 +860,7 @@ 
     public function generate_code()
     {
         // each line item in the cart requires a unique identifier
-        return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
+        return md5($this->get('OBJ_type').$this->get('OBJ_ID').microtime());
     }
 
 
@@ -1035,7 +1035,7 @@ 
         $has_children = ! empty($my_children);
         if ($has_children && $this->is_line_item()) {
             $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
-        } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
+        } elseif ( ! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
             $total = $this->unit_price() * $this->quantity();
         } elseif ($this->is_sub_total() || $this->is_total()) {
             $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
@@ -1050,13 +1050,13 @@ 
             if ($this->OBJ_type() !== 'Event') {
                 $this->set_quantity(1);
             }
-            if (! $this->is_percent()) {
+            if ( ! $this->is_percent()) {
                 $this->set_unit_price($total);
             }
         }
         //we don't want to bother saving grand totals, because that needs to factor in taxes anyways
         //so it ought to be
-        if (! $this->is_total()) {
+        if ( ! $this->is_total()) {
             $this->set_total($total);
             //if not a percent line item, make sure we keep the unit price in sync
             if (
@@ -1374,7 +1374,7 @@ 
     public function save_this_and_descendants_to_txn($txn_id = null)
     {
         $count = 0;
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             $txn_id = $this->TXN_ID();
         }
         $this->set_TXN_ID($txn_id);

caffeinated/admin/extend/registrations/Extend_Registrations_Admin_Page.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -863,7 +863,7 @@
      * handles toggling the checkin status for the registration,
      *
      * @access protected
-     * @return int|void
+     * @return integer
      */
     protected function _toggle_checkin_status()
     {

Spacing +40 added lines, -40 removed lines

@@ -38,9 +38,9 @@ 
     {
         parent::__construct($routing);
         if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'registrations/templates/');
+            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'registrations/assets/');
+            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registrations/assets/');
         }
     }
 
@@ -48,7 +48,7 @@ 
 
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'registrations';
         $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
             ? $this->_req_data['_REG_ID']
             : 0;
@@ -181,14 +181,14 @@ 
             //enqueue newsletter js
             wp_enqueue_script(
                 'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.js',
                 array('ee-dialog'),
                 EVENT_ESPRESSO_VERSION,
                 true
             );
             wp_enqueue_style(
                 'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.css',
                 array(),
                 EVENT_ESPRESSO_VERSION
             );
@@ -207,7 +207,7 @@ 
     {
         wp_register_script(
             'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+            REG_CAF_ASSETS_URL.'ee-registration-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -412,7 +412,7 @@ 
             $codes[$field] = implode(', ', array_keys($shortcode_array));
         }
         $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+        $form_template = REG_CAF_TEMPLATE_PATH.'newsletter-send-form.template.php';
         $form_template_args = array(
             'form_action'       => admin_url('admin.php?page=espresso_registrations'),
             'form_route'        => 'newsletter_selected_send',
@@ -573,7 +573,7 @@ 
      */
     protected function _registration_reports()
     {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             $this->_reports_template_data,
@@ -595,7 +595,7 @@ 
     {
         $report_ID = 'reg-admin-registrations-per-day-report-dv';
         $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
-        $results = (array)$results;
+        $results = (array) $results;
         $regs = array();
         $subtitle = '';
         if ($results) {
@@ -605,7 +605,7 @@ 
                 $report_column_values = array();
                 foreach ($result as $property_name => $property_value) {
                     $property_value = $property_name === 'Registration_REG_date' ? $property_value
-                        : (int)$property_value;
+                        : (int) $property_value;
                     $report_column_values[] = $property_value;
                     if ($tracker === 0) {
                         if ($property_name === 'Registration_REG_date') {
@@ -622,7 +622,7 @@ 
             array_unshift($regs, $column_titles);
             //setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
@@ -642,7 +642,7 @@ 
                     '%sThere are currently no registration records in the last month for this report.%s',
                     'event_espresso'
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -662,7 +662,7 @@ 
     {
         $report_ID = 'reg-admin-registrations-per-event-report-dv';
         $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
-        $results = (array)$results;
+        $results = (array) $results;
         $regs = array();
         $subtitle = '';
         if ($results) {
@@ -675,7 +675,7 @@ 
                         $property_value,
                         4,
                         '...'
-                    ) : (int)$property_value;
+                    ) : (int) $property_value;
                     $report_column_values[] = $property_value;
                     if ($tracker === 0) {
                         if ($property_name === 'Registration_Event') {
@@ -692,7 +692,7 @@ 
             array_unshift($regs, $column_titles);
             //setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
@@ -712,7 +712,7 @@ 
                     '%sThere are currently no registration records in the last month for this report.%s',
                     'event_espresso'
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -762,7 +762,7 @@ 
         if ($datetime instanceof EE_Datetime) {
             $datetime_label = $datetime->get_dtt_display_name(true);
             $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
+                ? ' ('.$datetime->get_dtt_display_name().')'
                 : $datetime->get_dtt_display_name();
         }
         $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
@@ -776,7 +776,7 @@ 
             )
             : '';
         $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
+            ? '<a href="'.$datetime_link.'">'
               . '<span id="checkin-dtt">'
               . $datetime_label
               . '</span></a>'
@@ -788,8 +788,8 @@ 
             ? $attendee->get_admin_details_link()
             : '';
         $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+            ? '<a href="'.$attendee->get_admin_details_link().'"'
+              . ' title="'.esc_html__('Click for attendee details', 'event_espresso').'">'
               . '<span id="checkin-attendee-name">'
               . $attendee_name
               . '</span></a>'
@@ -798,25 +798,25 @@ 
             ? $registration->event()->get_admin_details_link()
             : '';
         $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+            ? '<a href="'.$event_link.'"'
+              . ' title="'.esc_html__('Click here to edit event.', 'event_espresso').'">'
               . '<span id="checkin-event-name">'
               . $registration->event_name()
               . '</span>'
               . '</a>'
             : '';
         $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
                 $attendee_link,
                 $datetime_link,
                 $event_link
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REGID" value="' . $reg_id . '">' : '';
+            ? '<input type="hidden" name="_REGID" value="'.$reg_id.'">' : '';
         $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+            ? '<input type="hidden" name="DTT_ID" value="'.$dtt_id.'">' : '';
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -852,7 +852,7 @@ 
         //beautiful! Made it this far so let's get the status.
         $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
         //setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
+        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin '.$new_status->cssClasses();
         $this->_template_args['success'] = true;
         $this->_return_json();
     }
@@ -1059,37 +1059,37 @@ 
                 'desc'  => __('View All Check-in Records for this Registrant', 'event_espresso'),
             ),
             'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
             ),
             'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
             ),
             'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
             ),
             'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
             ),
             'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
             ),
             'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
             ),
         );
         $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
         $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
         $this->_template_args['before_list_table'] = ! empty($event_id)
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 __('Viewing Registrations for Event: %s', 'event_espresso'),
                 EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         //need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on the event.
         /** @var EE_Event $event */
@@ -1108,7 +1108,7 @@ 
             $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
             $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
             $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+            $this->_template_args['before_list_table'] .= ' ( '.$datetime->date_and_time_range().' )';
             $this->_template_args['before_list_table'] .= '</span></h2>';
         }
         //if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status column
@@ -1175,11 +1175,11 @@ 
         //normalize some request params that get setup by the parent `get_registrations` method.
         $request = $this->_req_data;
         $request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
-        $request['order'] =  ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
-        if($trash){
+        $request['order'] = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
+        if ($trash) {
             $request['status'] = 'trash';
         }
-        $query_params = $this->_get_checkin_query_params_from_request( $request, $per_page, $count );
+        $query_params = $this->_get_checkin_query_params_from_request($request, $per_page, $count);
         /**
          * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
          * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093

Indentation +1181 added lines, -1181 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\ui\browser\checkins\entities\CheckinStatusDashicon;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -20,1186 +20,1186 @@ 
 {
 
 
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     *
-     * @type array
-     */
-    protected $_reports_template_data = array();
-
-
-
-    /**
-     * Extend_Registrations_Admin_Page constructor.
-     *
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
-        }
-    }
-
-
-
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
-        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID']
-            : 0;
-        // $att_id = ! empty( $this->_req_data['ATT_ID'] ) ? ! is_array( $this->_req_data['ATT_ID'] ) : 0;
-        // $att_id = ! empty( $this->_req_data['post'] ) && ! is_array( $this->_req_data['post'] )
-        // 	? $this->_req_data['post'] : $att_id;
-        $new_page_routes = array(
-            'reports'                  => array(
-                'func'       => '_registration_reports',
-                'capability' => 'ee_read_registrations',
-            ),
-            'registration_checkins'    => array(
-                'func'       => '_registration_checkin_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'newsletter_selected_send' => array(
-                'func'       => '_newsletter_selected_send',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'delete_checkin_rows'      => array(
-                'func'       => '_delete_checkin_rows',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkins',
-            ),
-            'delete_checkin_row'       => array(
-                'func'       => '_delete_checkin_row',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status'    => array(
-                'func'       => '_toggle_checkin_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status_bulk' => array(
-                'func' => '_toggle_checkin_status',
-                'noheader' => true,
-                'capability' => 'ee_edit_checkins'
-            ),
-            'event_registrations'      => array(
-                'func'       => '_event_registrations_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'registrations_checkin_report' => array(
-                'func'       => '_registrations_checkin_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        $new_page_config = array(
-            'reports'               => array(
-                'nav'           => array(
-                    'label' => __('Reports', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'help_tabs'     => array(
-                    'registrations_reports_help_tab' => array(
-                        'title'    => __('Registration Reports', 'event_espresso'),
-                        'filename' => 'registrations_reports',
-                    ),
-                ),
-                /*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/
-                'require_nonce' => false,
-            ),
-            'event_registrations'   => array(
-                'nav'           => array(
-                    'label'      => __('Event Check-In', 'event_espresso'),
-                    'order'      => 10,
-                    'persistent' => true,
-                ),
-                'help_tabs'     => array(
-                    'registrations_event_checkin_help_tab'                       => array(
-                        'title'    => __('Registrations Event Check-In', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin',
-                    ),
-                    'registrations_event_checkin_table_column_headings_help_tab' => array(
-                        'title'    => __('Event Check-In Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_table_column_headings',
-                    ),
-                    'registrations_event_checkin_filters_help_tab'               => array(
-                        'title'    => __('Event Check-In Filters', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_filters',
-                    ),
-                    'registrations_event_checkin_views_help_tab'                 => array(
-                        'title'    => __('Event Check-In Views', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_views',
-                    ),
-                    'registrations_event_checkin_other_help_tab'                 => array(
-                        'title'    => __('Event Check-In Other', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_other',
-                    ),
-                ),
-                'help_tour'     => array('Event_Checkin_Help_Tour'),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Event_Registrations_List_Table',
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            'registration_checkins' => array(
-                'nav'           => array(
-                    'label'      => __('Check-In Records', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'list_table'    => 'EE_Registration_CheckIn_List_Table',
-                //'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ),
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-        $this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
-        $this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
-    }
-
-
-
-    protected function _ajax_hooks()
-    {
-        parent::_ajax_hooks();
-        add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
-    }
-
-
-
-    public function load_scripts_styles()
-    {
-        parent::load_scripts_styles();
-        //if newsletter message type is active then let's add filter and load js for it.
-        if (EEH_MSG_Template::is_mt_active('newsletter')) {
-            //enqueue newsletter js
-            wp_enqueue_script(
-                'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
-                array('ee-dialog'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_style(
-                'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
-                array(),
-                EVENT_ESPRESSO_VERSION
-            );
-            //hook in buttons for newsletter message type trigger.
-            add_action(
-                'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
-                array($this, 'add_newsletter_action_buttons'),
-                10
-            );
-        }
-    }
-
-
-
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-reg-reports-js');
-        $this->_registration_reports_js_setup();
-    }
-
-
-
-    protected function _add_screen_options_event_registrations()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-
-    protected function _add_screen_options_registration_checkins()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = __('Check-In Records', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-
-    protected function _set_list_table_views_event_registrations()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => ! isset($this->_req_data['event_id'])
-                    ? array()
-                    : array(
-                        'toggle_checkin_status_bulk' => __('Toggle Check-In', 'event_espresso'),
-                    ),
-            ),
-        );
-    }
-
-
-
-    protected function _set_list_table_views_registration_checkins()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array('delete_checkin_rows' => __('Delete Check-In Rows', 'event_espresso')),
-            ),
-        );
-    }
-
-
-
-    /**
-     * callback for ajax action.
-     *
-     * @since 4.3.0
-     * @return void (JSON)
-     * @throws \EE_Error
-     */
-    public function get_newsletter_form_content()
-    {
-        //do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
-            $this->_req_data['get_newsletter_form_content_nonce']
-        ) : '';
-        $nonce_ref = 'get_newsletter_form_content_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        //let's get the mtp for the incoming MTP_ ID
-        if ( ! isset($this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                __(
-                    'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
-        if ( ! $MTPG instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
-                        'event_espresso'
-                    ),
-                    $this->_req_data['GRP_ID']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPs = $MTPG->context_templates();
-        $MTPs = $MTPs['attendee'];
-        $template_fields = array();
-        /** @var EE_Message_Template $MTP */
-        foreach ($MTPs as $MTP) {
-            $field = $MTP->get('MTP_template_field');
-            if ($field === 'content') {
-                $content = $MTP->get('MTP_content');
-                if ( ! empty($content['newsletter_content'])) {
-                    $template_fields['newsletter_content'] = $content['newsletter_content'];
-                }
-                continue;
-            }
-            $template_fields[$MTP->get('MTP_template_field')] = $MTP->get('MTP_content');
-        }
-        $this->_template_args['success'] = true;
-        $this->_template_args['error'] = false;
-        $this->_template_args['data'] = array(
-            'batch_message_from'    => isset($template_fields['from'])
-                ? $template_fields['from']
-                : '',
-            'batch_message_subject' => isset($template_fields['subject'])
-                ? $template_fields['subject']
-                : '',
-            'batch_message_content' => isset($template_fields['newsletter_content'])
-                ? $template_fields['newsletter_content']
-                : '',
-        );
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
-     *
-     * @since 4.3.0
-     * @param EE_Admin_List_Table $list_table
-     * @return void
-     */
-    public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
-    {
-        if ( ! EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_registrations_newsletter_selected_send'
-        )
-        ) {
-            return;
-        }
-        $routes_to_add_to = array(
-            'contact_list',
-            'event_registrations',
-            'default',
-        );
-        if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
-            if (($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
-                || (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
-            ) {
-                echo '';
-            } else {
-                $button_text = sprintf(
-                    __('Send Batch Message (%s selected)', 'event_espresso'),
-                    '<span class="send-selected-newsletter-count">0</span>'
-                );
-                echo '<button id="selected-batch-send-trigger" class="button secondary-button"><span class="dashicons dashicons-email "></span>'
-                     . $button_text
-                     . '</button>';
-                add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
-            }
-        }
-    }
-
-
-
-    public function newsletter_send_form_skeleton()
-    {
-        $list_table = $this->_list_table_object;
-        $codes = array();
-        //need to templates for the newsletter message type for the template selector.
-        $values[] = array('text' => __('Select Template to Use', 'event_espresso'), 'id' => 0);
-        $mtps = EEM_Message_Template_Group::instance()->get_all(
-            array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
-        );
-        foreach ($mtps as $mtp) {
-            $name = $mtp->name();
-            $values[] = array(
-                'text' => empty($name) ? __('Global', 'event_espresso') : $name,
-                'id'   => $mtp->ID(),
-            );
-        }
-        //need to get a list of shortcodes that are available for the newsletter message type.
-        $shortcodes = EEH_MSG_Template::get_shortcodes('newsletter', 'email', array(), 'attendee', false);
-        foreach ($shortcodes as $field => $shortcode_array) {
-            $codes[$field] = implode(', ', array_keys($shortcode_array));
-        }
-        $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
-        $form_template_args = array(
-            'form_action'       => admin_url('admin.php?page=espresso_registrations'),
-            'form_route'        => 'newsletter_selected_send',
-            'form_nonce_name'   => 'newsletter_selected_send_nonce',
-            'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
-            'redirect_back_to'  => $this->_req_action,
-            'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
-            'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
-            'shortcodes'        => $shortcodes,
-            'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
-        );
-        EEH_Template::display_template($form_template, $form_template_args);
-    }
-
-
-
-    /**
-     * Handles sending selected registrations/contacts a newsletter.
-     *
-     * @since  4.3.0
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _newsletter_selected_send()
-    {
-        $success = true;
-        //first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
-        if (empty($this->_req_data['newsletter_mtp_selected'])) {
-            EE_Error::add_error(
-                __(
-                    'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            //update Message template in case there are any changes
-            $Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
-                $this->_req_data['newsletter_mtp_selected']
-            );
-            $Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
-                ? $Message_Template_Group->context_templates()
-                : array();
-            if (empty($Message_Templates)) {
-                EE_Error::add_error(
-                    __(
-                        'Unable to retrieve message template fields from the db. Messages not sent.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            //let's just update the specific fields
-            foreach ($Message_Templates['attendee'] as $Message_Template) {
-                if ($Message_Template instanceof EE_Message_Template) {
-                    $field = $Message_Template->get('MTP_template_field');
-                    $content = $Message_Template->get('MTP_content');
-                    $new_content = $content;
-                    switch ($field) {
-                        case 'from' :
-                            $new_content = ! empty($this->_req_data['batch_message']['from'])
-                                ? $this->_req_data['batch_message']['from']
-                                : $content;
-                            break;
-                        case 'subject' :
-                            $new_content = ! empty($this->_req_data['batch_message']['subject'])
-                                ? $this->_req_data['batch_message']['subject']
-                                : $content;
-                            break;
-                        case 'content' :
-                            $new_content = $content;
-                            $new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
-                                ? $this->_req_data['batch_message']['content']
-                                : $content['newsletter_content'];
-                            break;
-                        default :
-                            //continue the foreach loop, we don't want to set $new_content nor save.
-                            continue 2;
-                    }
-                    $Message_Template->set('MTP_content', $new_content);
-                    $Message_Template->save();
-                }
-            }
-            //great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
-            $id_type = ! empty($this->_req_data['batch_message']['id_type'])
-                ? $this->_req_data['batch_message']['id_type']
-                : 'registration';
-            //id_type will affect how we assemble the ids.
-            $ids = ! empty($this->_req_data['batch_message']['ids'])
-                ? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
-                : array();
-            $registrations_used_for_contact_data = array();
-            //using switch because eventually we'll have other contexts that will be used for generating messages.
-            switch ($id_type) {
-                case 'registration' :
-                    $registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
-                        array(
-                            array(
-                                'REG_ID' => array('IN', $ids),
-                            ),
-                        )
-                    );
-                    break;
-                case 'contact' :
-                    $registrations_used_for_contact_data = EEM_Registration::instance()
-                                                                           ->get_latest_registration_for_each_of_given_contacts($ids);
-                    break;
-            }
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-                array(
-                    $registrations_used_for_contact_data,
-                    $Message_Template_Group->ID()
-                )
-            );
-            //kept for backward compat, internally we no longer use this action.
-            //@deprecated 4.8.36.rc.002
-            $contacts = $id_type === 'registration'
-                ? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
-                : EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
-                array(
-                    $contacts,
-                    $Message_Template_Group->ID()
-                )
-            );
-        }
-        $query_args = array(
-            'action' => ! empty($this->_req_data['redirect_back_to'])
-                ? $this->_req_data['redirect_back_to']
-                : 'default',
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
-     */
-    protected function _registration_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
-    }
-
-
-
-    /**
-     *        generates Business Reports regarding Registrations
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _registration_reports()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_reports_template_data,
-            true
-        );
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-
-    /**
-     * Generates Business Report showing total registrations per day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     */
-    private function _registrations_per_day_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-day-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
-        $results = (array)$results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_REG_date' ? $property_value
-                        : (int)$property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_REG_date') {
-                            $column_titles[] = __('Date (only days with registrations are shown)', 'event_espresso');
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            //make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            //setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = __('Total Registrations per Day', 'event_espresso');
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                __(
-                    '%sThere are currently no registration records in the last month for this report.%s',
-                    'event_espresso'
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
-        return $report_ID;
-    }
-
-
-
-    /**
-     * Generates Business Report showing total registrations per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     */
-    private function _registrations_per_event_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-event-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
-        $results = (array)$results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_Event' ? wp_trim_words(
-                        $property_value,
-                        4,
-                        '...'
-                    ) : (int)$property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_Event') {
-                            $column_titles[] = __('Event', 'event_espresso');
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            //make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            //setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = __('Total Registrations per Event', 'event_espresso');
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                __(
-                    '%sThere are currently no registration records in the last month for this report.%s',
-                    'event_espresso'
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
-        return $report_ID;
-    }
-
-
-
-    /**
-     * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _registration_checkin_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $reg_id = isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : null;
-        /** @var EE_Registration $registration */
-        $registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        $attendee = $registration->attendee();
-        $this->_admin_page_title .= $this->get_action_link_or_button(
-            'new_registration',
-            'add-registrant',
-            array('event_id' => $registration->event_ID()),
-            'add-new-h2'
-        );
-        $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
-        $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
-        $legend_items = array(
-            'checkin'  => array(
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ),
-            'checkout' => array(
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-        /** @var EE_Datetime $datetime */
-        $datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
-        $datetime_label = '';
-        if ($datetime instanceof EE_Datetime) {
-            $datetime_label = $datetime->get_dtt_display_name(true);
-            $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
-                : $datetime->get_dtt_display_name();
-        }
-        $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'event_registrations',
-                    'event_id' => $registration->event_ID(),
-                    'DTT_ID'   => $dtt_id,
-                ),
-                $this->_admin_base_url
-            )
-            : '';
-        $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
-              . '<span id="checkin-dtt">'
-              . $datetime_label
-              . '</span></a>'
-            : $datetime_label;
-        $attendee_name = $attendee instanceof EE_Attendee
-            ? $attendee->full_name()
-            : '';
-        $attendee_link = $attendee instanceof EE_Attendee
-            ? $attendee->get_admin_details_link()
-            : '';
-        $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
-              . '<span id="checkin-attendee-name">'
-              . $attendee_name
-              . '</span></a>'
-            : '';
-        $event_link = $registration->event() instanceof EE_Event
-            ? $registration->event()->get_admin_details_link()
-            : '';
-        $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
-              . '<span id="checkin-event-name">'
-              . $registration->event_name()
-              . '</span>'
-              . '</a>'
-            : '';
-        $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
-                esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
-                $attendee_link,
-                $datetime_link,
-                $event_link
-            ) . '</h2>'
-            : '';
-        $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REGID" value="' . $reg_id . '">' : '';
-        $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-
-    /**
-     * toggle the Check-in status for the given registration (coming from ajax)
-     *
-     * @return void (JSON)
-     */
-    public function toggle_checkin_status()
-    {
-        //first make sure we have the necessary data
-        if ( ! isset($this->_req_data['_regid'])) {
-            EE_Error::add_error(
-                __(
-                    'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        };
-        //do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
-            : '';
-        $nonce_ref = 'checkin_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        //beautiful! Made it this far so let's get the status.
-        $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
-        //setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
-        $this->_template_args['success'] = true;
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * handles toggling the checkin status for the registration,
-     *
-     * @access protected
-     * @return int|void
-     */
-    protected function _toggle_checkin_status()
-    {
-        //first let's get the query args out of the way for the redirect
-        $query_args = array(
-            'action'   => 'event_registrations',
-            'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
-            'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
-        );
-        $new_status = false;
-        // bulk action check in toggle
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // cycle thru checkboxes
-            while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
-                $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-                $new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
-            }
-        } elseif (isset($this->_req_data['_regid'])) {
-            //coming from ajax request
-            $DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
-            $query_args['DTT_ID'] = $DTT_ID;
-            $new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
-        } else {
-            EE_Error::add_error(
-                __('Missing some required data to toggle the Check-in', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        if (defined('DOING_AJAX')) {
-            return $new_status;
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * This is toggles a single Check-in for the given registration and datetime.
-     *
-     * @param  int $REG_ID The registration we're toggling
-     * @param  int $DTT_ID The datetime we're toggling
-     * @return int            The new status toggled to.
-     * @throws \EE_Error
-     */
-    private function _toggle_checkin($REG_ID, $DTT_ID)
-    {
-        /** @var EE_Registration $REG */
-        $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-        $new_status = $REG->toggle_checkin_status($DTT_ID);
-        if ($new_status !== false) {
-            EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
-        } else {
-            EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
-            $new_status = false;
-        }
-        return $new_status;
-    }
-
-
-
-    /**
-     * Takes care of deleting multiple EE_Checkin table rows
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _delete_checkin_rows()
-    {
-        $query_args = array(
-            'action' => 'registration_checkins',
-            'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REGID' => isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : 0,
-        );
-        $errors = 0;
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
-                if ( ! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
-                    $errors++;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', $query_args, true);
-        }
-        if ($errors > 0) {
-            EE_Error::add_error(
-                sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_success(__('Records were successfully deleted', 'event_espresso'));
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * Deletes a single EE_Checkin row
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _delete_checkin_row()
-    {
-        $query_args = array(
-            'action' => 'registration_checkins',
-            'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REGID' => isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : 0,
-        );
-        if ( ! empty($this->_req_data['CHK_ID'])) {
-            if ( ! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
-                EE_Error::add_error(
-                    __('Something went wrong and this check-in record was not deleted', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso'));
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     *        generates HTML for the Event Registrations List Table
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _event_registrations_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= isset($this->_req_data['event_id'])
-            ? $this->get_action_link_or_button(
-                'new_registration',
-                'add-registrant',
-                array('event_id' => $this->_req_data['event_id']),
-                'add-new-h2',
-                '',
-                false
-            )
-            : '';
-        $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
-        $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
-        $checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never);
-        $legend_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
-                'desc'  => __('This Registrant is the Primary Registrant', 'event_espresso'),
-            ),
-            'checkin'          => array(
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ),
-            'checkout'         => array(
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ),
-            'nocheckinrecord'  => array(
-                'class' => $checked_never->cssClasses(),
-                'desc'  => $checked_never->legendLabel(),
-            ),
-            'view_details'     => array(
-                'class' => 'dashicons dashicons-search',
-                'desc'  => __('View All Check-in Records for this Registrant', 'event_espresso'),
-            ),
-            'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
-            ),
-            'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
-            ),
-            'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
-            ),
-            'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
-            ),
-            'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
-            ),
-            'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
-        $this->_template_args['before_list_table'] = ! empty($event_id)
-            ? '<h2>' . sprintf(
-                __('Viewing Registrations for Event: %s', 'event_espresso'),
-                EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
-            : '';
-        //need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on the event.
-        /** @var EE_Event $event */
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        $DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
-        $datetime = null;
-        if ($event instanceof EE_Event) {
-            $datetimes_on_event = $event->datetimes();
-            if (count($datetimes_on_event) === 1) {
-                $datetime = reset($datetimes_on_event);
-            }
-        }
-        $datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
-            $this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
-            $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
-            $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
-            $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
-            $this->_template_args['before_list_table'] .= '</span></h2>';
-        }
-        //if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status column
-        //represents
-        if ( ! $datetime instanceof EE_Datetime) {
-            $this->_template_args['before_list_table'] .= '<br><p class="description">'
-                                                          . __('In this view, the check-in status represents the latest check-in record for the registration in that row.',
-                    'event_espresso')
-                                                          . '</p>';
-        }
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-    /**
-     * Download the registrations check-in report (same as the normal registration report, but with different where
-     * conditions)
-     *
-     * @return void ends the request by a redirect or download
-     */
-    public function _registrations_checkin_report()
-    {
-        $this->_registrations_report_base('_get_checkin_query_params_from_request');
-    }
-
-    /**
-     * Gets the query params from the request, plus adds a where condition for the registration status,
-     * because on the checkin page we only ever want to see approved and pending-approval registrations
-     *
-     * @param array     $request
-     * @param int  $per_page
-     * @param bool $count
-     * @return array
-     */
-    protected function _get_checkin_query_params_from_request(
-        $request,
-        $per_page = 10,
-        $count = false
-    ) {
-        $query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
-        //unlike the regular registrations list table,
-        $status_ids_array = apply_filters(
-            'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
-            array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
-        );
-        $query_params[0]['STS_ID'] = array('IN', $status_ids_array);
-        return $query_params;
-    }
-
-
-
-
-    /**
-     * Gets registrations for an event
-     *
-     * @param int    $per_page
-     * @param bool   $count whether to return count or data.
-     * @param bool   $trash
-     * @param string $orderby
-     * @return EE_Registration[]|int
-     * @throws \EE_Error
-     */
-    public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
-    {
-        //normalize some request params that get setup by the parent `get_registrations` method.
-        $request = $this->_req_data;
-        $request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
-        $request['order'] =  ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
-        if($trash){
-            $request['status'] = 'trash';
-        }
-        $query_params = $this->_get_checkin_query_params_from_request( $request, $per_page, $count );
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see EEM_Base::get_all()
-         */
-        $query_params['group_by'] = '';
-
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 *
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
+
+
+
+	/**
+	 * Extend_Registrations_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
+			define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
+			define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
+			define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+		}
+	}
+
+
+
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+		$reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID']
+			: 0;
+		// $att_id = ! empty( $this->_req_data['ATT_ID'] ) ? ! is_array( $this->_req_data['ATT_ID'] ) : 0;
+		// $att_id = ! empty( $this->_req_data['post'] ) && ! is_array( $this->_req_data['post'] )
+		// 	? $this->_req_data['post'] : $att_id;
+		$new_page_routes = array(
+			'reports'                  => array(
+				'func'       => '_registration_reports',
+				'capability' => 'ee_read_registrations',
+			),
+			'registration_checkins'    => array(
+				'func'       => '_registration_checkin_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'newsletter_selected_send' => array(
+				'func'       => '_newsletter_selected_send',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'delete_checkin_rows'      => array(
+				'func'       => '_delete_checkin_rows',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkins',
+			),
+			'delete_checkin_row'       => array(
+				'func'       => '_delete_checkin_row',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status'    => array(
+				'func'       => '_toggle_checkin_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status_bulk' => array(
+				'func' => '_toggle_checkin_status',
+				'noheader' => true,
+				'capability' => 'ee_edit_checkins'
+			),
+			'event_registrations'      => array(
+				'func'       => '_event_registrations_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'registrations_checkin_report' => array(
+				'func'       => '_registrations_checkin_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		$new_page_config = array(
+			'reports'               => array(
+				'nav'           => array(
+					'label' => __('Reports', 'event_espresso'),
+					'order' => 30,
+				),
+				'help_tabs'     => array(
+					'registrations_reports_help_tab' => array(
+						'title'    => __('Registration Reports', 'event_espresso'),
+						'filename' => 'registrations_reports',
+					),
+				),
+				/*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/
+				'require_nonce' => false,
+			),
+			'event_registrations'   => array(
+				'nav'           => array(
+					'label'      => __('Event Check-In', 'event_espresso'),
+					'order'      => 10,
+					'persistent' => true,
+				),
+				'help_tabs'     => array(
+					'registrations_event_checkin_help_tab'                       => array(
+						'title'    => __('Registrations Event Check-In', 'event_espresso'),
+						'filename' => 'registrations_event_checkin',
+					),
+					'registrations_event_checkin_table_column_headings_help_tab' => array(
+						'title'    => __('Event Check-In Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_table_column_headings',
+					),
+					'registrations_event_checkin_filters_help_tab'               => array(
+						'title'    => __('Event Check-In Filters', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_filters',
+					),
+					'registrations_event_checkin_views_help_tab'                 => array(
+						'title'    => __('Event Check-In Views', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_views',
+					),
+					'registrations_event_checkin_other_help_tab'                 => array(
+						'title'    => __('Event Check-In Other', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_other',
+					),
+				),
+				'help_tour'     => array('Event_Checkin_Help_Tour'),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Event_Registrations_List_Table',
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			'registration_checkins' => array(
+				'nav'           => array(
+					'label'      => __('Check-In Records', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'list_table'    => 'EE_Registration_CheckIn_List_Table',
+				//'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ),
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+		$this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
+		$this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
+	}
+
+
+
+	protected function _ajax_hooks()
+	{
+		parent::_ajax_hooks();
+		add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
+	}
+
+
+
+	public function load_scripts_styles()
+	{
+		parent::load_scripts_styles();
+		//if newsletter message type is active then let's add filter and load js for it.
+		if (EEH_MSG_Template::is_mt_active('newsletter')) {
+			//enqueue newsletter js
+			wp_enqueue_script(
+				'ee-newsletter-trigger',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+				array('ee-dialog'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_style(
+				'ee-newsletter-trigger-css',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+				array(),
+				EVENT_ESPRESSO_VERSION
+			);
+			//hook in buttons for newsletter message type trigger.
+			add_action(
+				'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
+				array($this, 'add_newsletter_action_buttons'),
+				10
+			);
+		}
+	}
+
+
+
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-reg-reports-js',
+			REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-reg-reports-js');
+		$this->_registration_reports_js_setup();
+	}
+
+
+
+	protected function _add_screen_options_event_registrations()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+
+	protected function _add_screen_options_registration_checkins()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = __('Check-In Records', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+
+	protected function _set_list_table_views_event_registrations()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => ! isset($this->_req_data['event_id'])
+					? array()
+					: array(
+						'toggle_checkin_status_bulk' => __('Toggle Check-In', 'event_espresso'),
+					),
+			),
+		);
+	}
+
+
+
+	protected function _set_list_table_views_registration_checkins()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array('delete_checkin_rows' => __('Delete Check-In Rows', 'event_espresso')),
+			),
+		);
+	}
+
+
+
+	/**
+	 * callback for ajax action.
+	 *
+	 * @since 4.3.0
+	 * @return void (JSON)
+	 * @throws \EE_Error
+	 */
+	public function get_newsletter_form_content()
+	{
+		//do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
+			$this->_req_data['get_newsletter_form_content_nonce']
+		) : '';
+		$nonce_ref = 'get_newsletter_form_content_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		//let's get the mtp for the incoming MTP_ ID
+		if ( ! isset($this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				__(
+					'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
+		if ( ! $MTPG instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
+						'event_espresso'
+					),
+					$this->_req_data['GRP_ID']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPs = $MTPG->context_templates();
+		$MTPs = $MTPs['attendee'];
+		$template_fields = array();
+		/** @var EE_Message_Template $MTP */
+		foreach ($MTPs as $MTP) {
+			$field = $MTP->get('MTP_template_field');
+			if ($field === 'content') {
+				$content = $MTP->get('MTP_content');
+				if ( ! empty($content['newsletter_content'])) {
+					$template_fields['newsletter_content'] = $content['newsletter_content'];
+				}
+				continue;
+			}
+			$template_fields[$MTP->get('MTP_template_field')] = $MTP->get('MTP_content');
+		}
+		$this->_template_args['success'] = true;
+		$this->_template_args['error'] = false;
+		$this->_template_args['data'] = array(
+			'batch_message_from'    => isset($template_fields['from'])
+				? $template_fields['from']
+				: '',
+			'batch_message_subject' => isset($template_fields['subject'])
+				? $template_fields['subject']
+				: '',
+			'batch_message_content' => isset($template_fields['newsletter_content'])
+				? $template_fields['newsletter_content']
+				: '',
+		);
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
+	 *
+	 * @since 4.3.0
+	 * @param EE_Admin_List_Table $list_table
+	 * @return void
+	 */
+	public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
+	{
+		if ( ! EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_registrations_newsletter_selected_send'
+		)
+		) {
+			return;
+		}
+		$routes_to_add_to = array(
+			'contact_list',
+			'event_registrations',
+			'default',
+		);
+		if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
+			if (($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
+				|| (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
+			) {
+				echo '';
+			} else {
+				$button_text = sprintf(
+					__('Send Batch Message (%s selected)', 'event_espresso'),
+					'<span class="send-selected-newsletter-count">0</span>'
+				);
+				echo '<button id="selected-batch-send-trigger" class="button secondary-button"><span class="dashicons dashicons-email "></span>'
+					 . $button_text
+					 . '</button>';
+				add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
+			}
+		}
+	}
+
+
+
+	public function newsletter_send_form_skeleton()
+	{
+		$list_table = $this->_list_table_object;
+		$codes = array();
+		//need to templates for the newsletter message type for the template selector.
+		$values[] = array('text' => __('Select Template to Use', 'event_espresso'), 'id' => 0);
+		$mtps = EEM_Message_Template_Group::instance()->get_all(
+			array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
+		);
+		foreach ($mtps as $mtp) {
+			$name = $mtp->name();
+			$values[] = array(
+				'text' => empty($name) ? __('Global', 'event_espresso') : $name,
+				'id'   => $mtp->ID(),
+			);
+		}
+		//need to get a list of shortcodes that are available for the newsletter message type.
+		$shortcodes = EEH_MSG_Template::get_shortcodes('newsletter', 'email', array(), 'attendee', false);
+		foreach ($shortcodes as $field => $shortcode_array) {
+			$codes[$field] = implode(', ', array_keys($shortcode_array));
+		}
+		$shortcodes = $codes;
+		$form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+		$form_template_args = array(
+			'form_action'       => admin_url('admin.php?page=espresso_registrations'),
+			'form_route'        => 'newsletter_selected_send',
+			'form_nonce_name'   => 'newsletter_selected_send_nonce',
+			'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
+			'redirect_back_to'  => $this->_req_action,
+			'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
+			'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
+			'shortcodes'        => $shortcodes,
+			'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
+		);
+		EEH_Template::display_template($form_template, $form_template_args);
+	}
+
+
+
+	/**
+	 * Handles sending selected registrations/contacts a newsletter.
+	 *
+	 * @since  4.3.0
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _newsletter_selected_send()
+	{
+		$success = true;
+		//first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
+		if (empty($this->_req_data['newsletter_mtp_selected'])) {
+			EE_Error::add_error(
+				__(
+					'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			//update Message template in case there are any changes
+			$Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
+				$this->_req_data['newsletter_mtp_selected']
+			);
+			$Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
+				? $Message_Template_Group->context_templates()
+				: array();
+			if (empty($Message_Templates)) {
+				EE_Error::add_error(
+					__(
+						'Unable to retrieve message template fields from the db. Messages not sent.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			//let's just update the specific fields
+			foreach ($Message_Templates['attendee'] as $Message_Template) {
+				if ($Message_Template instanceof EE_Message_Template) {
+					$field = $Message_Template->get('MTP_template_field');
+					$content = $Message_Template->get('MTP_content');
+					$new_content = $content;
+					switch ($field) {
+						case 'from' :
+							$new_content = ! empty($this->_req_data['batch_message']['from'])
+								? $this->_req_data['batch_message']['from']
+								: $content;
+							break;
+						case 'subject' :
+							$new_content = ! empty($this->_req_data['batch_message']['subject'])
+								? $this->_req_data['batch_message']['subject']
+								: $content;
+							break;
+						case 'content' :
+							$new_content = $content;
+							$new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
+								? $this->_req_data['batch_message']['content']
+								: $content['newsletter_content'];
+							break;
+						default :
+							//continue the foreach loop, we don't want to set $new_content nor save.
+							continue 2;
+					}
+					$Message_Template->set('MTP_content', $new_content);
+					$Message_Template->save();
+				}
+			}
+			//great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
+			$id_type = ! empty($this->_req_data['batch_message']['id_type'])
+				? $this->_req_data['batch_message']['id_type']
+				: 'registration';
+			//id_type will affect how we assemble the ids.
+			$ids = ! empty($this->_req_data['batch_message']['ids'])
+				? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
+				: array();
+			$registrations_used_for_contact_data = array();
+			//using switch because eventually we'll have other contexts that will be used for generating messages.
+			switch ($id_type) {
+				case 'registration' :
+					$registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
+						array(
+							array(
+								'REG_ID' => array('IN', $ids),
+							),
+						)
+					);
+					break;
+				case 'contact' :
+					$registrations_used_for_contact_data = EEM_Registration::instance()
+																		   ->get_latest_registration_for_each_of_given_contacts($ids);
+					break;
+			}
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+				array(
+					$registrations_used_for_contact_data,
+					$Message_Template_Group->ID()
+				)
+			);
+			//kept for backward compat, internally we no longer use this action.
+			//@deprecated 4.8.36.rc.002
+			$contacts = $id_type === 'registration'
+				? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
+				: EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
+				array(
+					$contacts,
+					$Message_Template_Group->ID()
+				)
+			);
+		}
+		$query_args = array(
+			'action' => ! empty($this->_req_data['redirect_back_to'])
+				? $this->_req_data['redirect_back_to']
+				: 'default',
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
+	 */
+	protected function _registration_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
+	}
+
+
+
+	/**
+	 *        generates Business Reports regarding Registrations
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _registration_reports()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_reports_template_data,
+			true
+		);
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+
+	/**
+	 * Generates Business Report showing total registrations per day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 */
+	private function _registrations_per_day_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-day-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
+		$results = (array)$results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_REG_date' ? $property_value
+						: (int)$property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_REG_date') {
+							$column_titles[] = __('Date (only days with registrations are shown)', 'event_espresso');
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			//make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			//setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = __('Total Registrations per Day', 'event_espresso');
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				__(
+					'%sThere are currently no registration records in the last month for this report.%s',
+					'event_espresso'
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
+		return $report_ID;
+	}
+
+
+
+	/**
+	 * Generates Business Report showing total registrations per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 */
+	private function _registrations_per_event_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-event-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
+		$results = (array)$results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_Event' ? wp_trim_words(
+						$property_value,
+						4,
+						'...'
+					) : (int)$property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_Event') {
+							$column_titles[] = __('Event', 'event_espresso');
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			//make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			//setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = __('Total Registrations per Event', 'event_espresso');
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				__(
+					'%sThere are currently no registration records in the last month for this report.%s',
+					'event_espresso'
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
+		return $report_ID;
+	}
+
+
+
+	/**
+	 * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _registration_checkin_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$reg_id = isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : null;
+		/** @var EE_Registration $registration */
+		$registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		$attendee = $registration->attendee();
+		$this->_admin_page_title .= $this->get_action_link_or_button(
+			'new_registration',
+			'add-registrant',
+			array('event_id' => $registration->event_ID()),
+			'add-new-h2'
+		);
+		$checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
+		$checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
+		$legend_items = array(
+			'checkin'  => array(
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			),
+			'checkout' => array(
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+		/** @var EE_Datetime $datetime */
+		$datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
+		$datetime_label = '';
+		if ($datetime instanceof EE_Datetime) {
+			$datetime_label = $datetime->get_dtt_display_name(true);
+			$datetime_label .= ! empty($datetime_label)
+				? ' (' . $datetime->get_dtt_display_name() . ')'
+				: $datetime->get_dtt_display_name();
+		}
+		$datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'event_registrations',
+					'event_id' => $registration->event_ID(),
+					'DTT_ID'   => $dtt_id,
+				),
+				$this->_admin_base_url
+			)
+			: '';
+		$datetime_link = ! empty($datetime_link)
+			? '<a href="' . $datetime_link . '">'
+			  . '<span id="checkin-dtt">'
+			  . $datetime_label
+			  . '</span></a>'
+			: $datetime_label;
+		$attendee_name = $attendee instanceof EE_Attendee
+			? $attendee->full_name()
+			: '';
+		$attendee_link = $attendee instanceof EE_Attendee
+			? $attendee->get_admin_details_link()
+			: '';
+		$attendee_link = ! empty($attendee_link)
+			? '<a href="' . $attendee->get_admin_details_link() . '"'
+			  . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+			  . '<span id="checkin-attendee-name">'
+			  . $attendee_name
+			  . '</span></a>'
+			: '';
+		$event_link = $registration->event() instanceof EE_Event
+			? $registration->event()->get_admin_details_link()
+			: '';
+		$event_link = ! empty($event_link)
+			? '<a href="' . $event_link . '"'
+			  . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+			  . '<span id="checkin-event-name">'
+			  . $registration->event_name()
+			  . '</span>'
+			  . '</a>'
+			: '';
+		$this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
+			? '<h2>' . sprintf(
+				esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
+				$attendee_link,
+				$datetime_link,
+				$event_link
+			) . '</h2>'
+			: '';
+		$this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
+			? '<input type="hidden" name="_REGID" value="' . $reg_id . '">' : '';
+		$this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
+			? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+
+	/**
+	 * toggle the Check-in status for the given registration (coming from ajax)
+	 *
+	 * @return void (JSON)
+	 */
+	public function toggle_checkin_status()
+	{
+		//first make sure we have the necessary data
+		if ( ! isset($this->_req_data['_regid'])) {
+			EE_Error::add_error(
+				__(
+					'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		};
+		//do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
+			: '';
+		$nonce_ref = 'checkin_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		//beautiful! Made it this far so let's get the status.
+		$new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
+		//setup new class to return via ajax
+		$this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
+		$this->_template_args['success'] = true;
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * handles toggling the checkin status for the registration,
+	 *
+	 * @access protected
+	 * @return int|void
+	 */
+	protected function _toggle_checkin_status()
+	{
+		//first let's get the query args out of the way for the redirect
+		$query_args = array(
+			'action'   => 'event_registrations',
+			'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
+			'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
+		);
+		$new_status = false;
+		// bulk action check in toggle
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// cycle thru checkboxes
+			while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
+				$DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+				$new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
+			}
+		} elseif (isset($this->_req_data['_regid'])) {
+			//coming from ajax request
+			$DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
+			$query_args['DTT_ID'] = $DTT_ID;
+			$new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
+		} else {
+			EE_Error::add_error(
+				__('Missing some required data to toggle the Check-in', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		if (defined('DOING_AJAX')) {
+			return $new_status;
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * This is toggles a single Check-in for the given registration and datetime.
+	 *
+	 * @param  int $REG_ID The registration we're toggling
+	 * @param  int $DTT_ID The datetime we're toggling
+	 * @return int            The new status toggled to.
+	 * @throws \EE_Error
+	 */
+	private function _toggle_checkin($REG_ID, $DTT_ID)
+	{
+		/** @var EE_Registration $REG */
+		$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+		$new_status = $REG->toggle_checkin_status($DTT_ID);
+		if ($new_status !== false) {
+			EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
+		} else {
+			EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
+			$new_status = false;
+		}
+		return $new_status;
+	}
+
+
+
+	/**
+	 * Takes care of deleting multiple EE_Checkin table rows
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _delete_checkin_rows()
+	{
+		$query_args = array(
+			'action' => 'registration_checkins',
+			'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REGID' => isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : 0,
+		);
+		$errors = 0;
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
+				if ( ! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
+					$errors++;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', $query_args, true);
+		}
+		if ($errors > 0) {
+			EE_Error::add_error(
+				sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_success(__('Records were successfully deleted', 'event_espresso'));
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * Deletes a single EE_Checkin row
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _delete_checkin_row()
+	{
+		$query_args = array(
+			'action' => 'registration_checkins',
+			'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REGID' => isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : 0,
+		);
+		if ( ! empty($this->_req_data['CHK_ID'])) {
+			if ( ! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
+				EE_Error::add_error(
+					__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso'));
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 *        generates HTML for the Event Registrations List Table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _event_registrations_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= isset($this->_req_data['event_id'])
+			? $this->get_action_link_or_button(
+				'new_registration',
+				'add-registrant',
+				array('event_id' => $this->_req_data['event_id']),
+				'add-new-h2',
+				'',
+				false
+			)
+			: '';
+		$checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
+		$checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
+		$checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never);
+		$legend_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
+				'desc'  => __('This Registrant is the Primary Registrant', 'event_espresso'),
+			),
+			'checkin'          => array(
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			),
+			'checkout'         => array(
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			),
+			'nocheckinrecord'  => array(
+				'class' => $checked_never->cssClasses(),
+				'desc'  => $checked_never->legendLabel(),
+			),
+			'view_details'     => array(
+				'class' => 'dashicons dashicons-search',
+				'desc'  => __('View All Check-in Records for this Registrant', 'event_espresso'),
+			),
+			'approved_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
+			),
+			'cancelled_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
+			),
+			'declined_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
+			),
+			'not_approved'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
+			),
+			'pending_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
+			),
+			'wait_list'        => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
+		$this->_template_args['before_list_table'] = ! empty($event_id)
+			? '<h2>' . sprintf(
+				__('Viewing Registrations for Event: %s', 'event_espresso'),
+				EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
+			) . '</h2>'
+			: '';
+		//need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on the event.
+		/** @var EE_Event $event */
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		$DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
+		$datetime = null;
+		if ($event instanceof EE_Event) {
+			$datetimes_on_event = $event->datetimes();
+			if (count($datetimes_on_event) === 1) {
+				$datetime = reset($datetimes_on_event);
+			}
+		}
+		$datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
+			$this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
+			$this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
+			$this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
+			$this->_template_args['before_list_table'] .= $datetime->name();
+			$this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+			$this->_template_args['before_list_table'] .= '</span></h2>';
+		}
+		//if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status column
+		//represents
+		if ( ! $datetime instanceof EE_Datetime) {
+			$this->_template_args['before_list_table'] .= '<br><p class="description">'
+														  . __('In this view, the check-in status represents the latest check-in record for the registration in that row.',
+					'event_espresso')
+														  . '</p>';
+		}
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+	/**
+	 * Download the registrations check-in report (same as the normal registration report, but with different where
+	 * conditions)
+	 *
+	 * @return void ends the request by a redirect or download
+	 */
+	public function _registrations_checkin_report()
+	{
+		$this->_registrations_report_base('_get_checkin_query_params_from_request');
+	}
+
+	/**
+	 * Gets the query params from the request, plus adds a where condition for the registration status,
+	 * because on the checkin page we only ever want to see approved and pending-approval registrations
+	 *
+	 * @param array     $request
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @return array
+	 */
+	protected function _get_checkin_query_params_from_request(
+		$request,
+		$per_page = 10,
+		$count = false
+	) {
+		$query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
+		//unlike the regular registrations list table,
+		$status_ids_array = apply_filters(
+			'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
+			array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
+		);
+		$query_params[0]['STS_ID'] = array('IN', $status_ids_array);
+		return $query_params;
+	}
+
+
+
+
+	/**
+	 * Gets registrations for an event
+	 *
+	 * @param int    $per_page
+	 * @param bool   $count whether to return count or data.
+	 * @param bool   $trash
+	 * @param string $orderby
+	 * @return EE_Registration[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
+	{
+		//normalize some request params that get setup by the parent `get_registrations` method.
+		$request = $this->_req_data;
+		$request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
+		$request['order'] =  ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
+		if($trash){
+			$request['status'] = 'trash';
+		}
+		$query_params = $this->_get_checkin_query_params_from_request( $request, $per_page, $count );
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see EEM_Base::get_all()
+		 */
+		$query_params['group_by'] = '';
+
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
 
 
 } //end class Registrations Admin Page

ui/browser/checkins/entities/CheckinStatusDashicon.php

Indentation +94 added lines, -94 removed lines

@@ -21,100 +21,100 @@
 class CheckinStatusDashicon
 {
 
-    /**
-     * @var int $checkin_status
-     */
-    private $checkin_status;
-
-
-    /**
-     * CheckinStatusDashicon constructor.
-     *
-     * @param int $checkin_status
-     */
-    public function __construct($checkin_status = EE_Checkin::status_checked_never)
-    {
-        $this->checkin_status = $checkin_status;
-    }
-
-
-    /**
-     * @param EE_Checkin $checkin
-     * @return CheckinStatusDashicon
-     * @throws EE_Error
-     */
-    public static function fromCheckin(EE_Checkin $checkin)
-    {
-        return new CheckinStatusDashicon(
-            $checkin->status()
-                ? EE_Checkin::status_checked_in
-                : EE_Checkin::status_checked_out
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Datetime     $datetime
-     * @return CheckinStatusDashicon
-     * @throws EE_Error
-     */
-    public static function fromRegistrationAndDatetime(EE_Registration $registration, EE_Datetime $datetime)
-    {
-        return new CheckinStatusDashicon(
-            $registration->check_in_status_for_datetime(
-                $datetime->ID()
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param int             $DTT_ID
-     * @return CheckinStatusDashicon
-     * @throws EE_Error
-     */
-    public static function fromRegistrationAndDatetimeId(EE_Registration $registration, $DTT_ID = 0)
-    {
-        return new CheckinStatusDashicon(
-            $registration->check_in_status_for_datetime(
-                absint($DTT_ID)
-            )
-        );
-    }
-
-    /**
-     * Will return the correct set of dashicon css classes for the set checkin status
-     *
-     * @return string
-     */
-    public function cssClasses()
-    {
-        if ($this->checkin_status === EE_Checkin::status_checked_in) {
-            return "ee-dashicons ee-icon-check-in checkin-icons checkedin-status-{$this->checkin_status}";
-        }
-        if ($this->checkin_status === EE_Checkin::status_checked_out) {
-            return "ee-dashicons ee-icon-check-out checkin-icons checkedin-status-{$this->checkin_status}";
-        }
-        return "dashicons dashicons-no checkin-icons checkedin-status-{$this->checkin_status}";
-    }
-
-    /**
-     * returns a description for the Checkin Status Dashicon that can be used in List Table Legends
-     *
-     * @return string
-     */
-    public function legendLabel()
-    {
-        if ($this->checkin_status === EE_Checkin::status_checked_in) {
-            return esc_html__('This Registrant has been Checked In', 'event_espresso');
-        }
-        if ($this->checkin_status === EE_Checkin::status_checked_out) {
-            return esc_html__('This Registrant has been Checked Out', 'event_espresso');
-        }
-        return esc_html__('No Check-in Record has been Created for this Registrant', 'event_espresso');
-    }
+	/**
+	 * @var int $checkin_status
+	 */
+	private $checkin_status;
+
+
+	/**
+	 * CheckinStatusDashicon constructor.
+	 *
+	 * @param int $checkin_status
+	 */
+	public function __construct($checkin_status = EE_Checkin::status_checked_never)
+	{
+		$this->checkin_status = $checkin_status;
+	}
+
+
+	/**
+	 * @param EE_Checkin $checkin
+	 * @return CheckinStatusDashicon
+	 * @throws EE_Error
+	 */
+	public static function fromCheckin(EE_Checkin $checkin)
+	{
+		return new CheckinStatusDashicon(
+			$checkin->status()
+				? EE_Checkin::status_checked_in
+				: EE_Checkin::status_checked_out
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Datetime     $datetime
+	 * @return CheckinStatusDashicon
+	 * @throws EE_Error
+	 */
+	public static function fromRegistrationAndDatetime(EE_Registration $registration, EE_Datetime $datetime)
+	{
+		return new CheckinStatusDashicon(
+			$registration->check_in_status_for_datetime(
+				$datetime->ID()
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param int             $DTT_ID
+	 * @return CheckinStatusDashicon
+	 * @throws EE_Error
+	 */
+	public static function fromRegistrationAndDatetimeId(EE_Registration $registration, $DTT_ID = 0)
+	{
+		return new CheckinStatusDashicon(
+			$registration->check_in_status_for_datetime(
+				absint($DTT_ID)
+			)
+		);
+	}
+
+	/**
+	 * Will return the correct set of dashicon css classes for the set checkin status
+	 *
+	 * @return string
+	 */
+	public function cssClasses()
+	{
+		if ($this->checkin_status === EE_Checkin::status_checked_in) {
+			return "ee-dashicons ee-icon-check-in checkin-icons checkedin-status-{$this->checkin_status}";
+		}
+		if ($this->checkin_status === EE_Checkin::status_checked_out) {
+			return "ee-dashicons ee-icon-check-out checkin-icons checkedin-status-{$this->checkin_status}";
+		}
+		return "dashicons dashicons-no checkin-icons checkedin-status-{$this->checkin_status}";
+	}
+
+	/**
+	 * returns a description for the Checkin Status Dashicon that can be used in List Table Legends
+	 *
+	 * @return string
+	 */
+	public function legendLabel()
+	{
+		if ($this->checkin_status === EE_Checkin::status_checked_in) {
+			return esc_html__('This Registrant has been Checked In', 'event_espresso');
+		}
+		if ($this->checkin_status === EE_Checkin::status_checked_out) {
+			return esc_html__('This Registrant has been Checked Out', 'event_espresso');
+		}
+		return esc_html__('No Check-in Record has been Created for this Registrant', 'event_espresso');
+	}
 
 
 }

core/libraries/messages/messenger/EE_Email_messenger.class.php

Indentation +641 added lines, -641 removed lines

@@ -8,645 +8,645 @@
 class EE_Email_messenger extends EE_messenger
 {
 
-    /**
-     * To field for email
-     * @var string
-     */
-    protected $_to = '';
-
-
-    /**
-     * CC field for email.
-     * @var string
-     */
-    protected $_cc = '';
-
-    /**
-     * From field for email
-     * @var string
-     */
-    protected $_from = '';
-
-
-    /**
-     * Subject field for email
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * Content field for email
-     * @var string
-     */
-    protected $_content = '';
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        //set name and description properties
-        $this->name                = 'email';
-        $this->description         = sprintf(
-            esc_html__(
-                'This messenger delivers messages via email using the built-in %s function included with WordPress',
-                'event_espresso'
-            ),
-            '<code>wp_mail</code>'
-        );
-        $this->label               = array(
-            'singular' => esc_html__('email', 'event_espresso'),
-            'plural'   => esc_html__('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        //we're using defaults so let's call parent constructor that will take care of setting up all the other
-        // properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
-        // message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'cc' => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type' => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        //prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html__('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for
-        // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
-        // they relate to.  This is important for the Messages_admin to know what fields to display to the user.
-        //  Also, notice that the "values" are equal to the field type that messages admin will use to know what
-        // kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
-        // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
-        // displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
-        // will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'To',
-                    'Label for the "To" field for email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'cc'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'CC',
-                    'Label for the "Carbon Copy" field used for additional email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'From',
-                    'Label for the "From" field for email addresses.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'Subject',
-                    'Label for the "Subject" field (short description of contents) for emails.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            html_entity_decode($this->_to, ENT_QUOTES, "UTF-8"),
-            stripslashes(html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8")),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'
-                    ),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        if (! empty($this->_cc)) {
-            $headers[] = 'cc: ' . $this->_cc;
-        }
-
-        //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
-        // header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     * @return string
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        //includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1])
-            ? $parsed_from[1]
-            : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     * @return string
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        //if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        $from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;
-
-        return stripslashes_deep(html_entity_decode($from_name, ENT_QUOTES, "UTF-8"));
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _body($preview = false)
-    {
-        //setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop(
-                stripslashes_deep(
-                    html_entity_decode($this->_content, ENT_QUOTES, "UTF-8")
-                )
-            ),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-            //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
-
-            //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents(
-                    $this->get_variation(
-                        $this->_tmp_pack,
-                        $this->_incoming_message_type->name,
-                        false,
-                        'main',
-                        $this->_variation
-                    ),
-                    true
-                );
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
-                //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
-                $body  = ltrim($CSS->convert(true), ">\n");
-                //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
-                $body  = ltrim($body, "<?");
-            }
-
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        //override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * To field for email
+	 * @var string
+	 */
+	protected $_to = '';
+
+
+	/**
+	 * CC field for email.
+	 * @var string
+	 */
+	protected $_cc = '';
+
+	/**
+	 * From field for email
+	 * @var string
+	 */
+	protected $_from = '';
+
+
+	/**
+	 * Subject field for email
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * Content field for email
+	 * @var string
+	 */
+	protected $_content = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		//set name and description properties
+		$this->name                = 'email';
+		$this->description         = sprintf(
+			esc_html__(
+				'This messenger delivers messages via email using the built-in %s function included with WordPress',
+				'event_espresso'
+			),
+			'<code>wp_mail</code>'
+		);
+		$this->label               = array(
+			'singular' => esc_html__('email', 'event_espresso'),
+			'plural'   => esc_html__('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		//we're using defaults so let's call parent constructor that will take care of setting up all the other
+		// properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		//remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
+		// message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'cc' => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type' => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		//prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html__('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for
+		// shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
+		// they relate to.  This is important for the Messages_admin to know what fields to display to the user.
+		//  Also, notice that the "values" are equal to the field type that messages admin will use to know what
+		// kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
+		// indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
+		// displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
+		// will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'To',
+					'Label for the "To" field for email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'cc'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'CC',
+					'Label for the "Carbon Copy" field used for additional email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'From',
+					'Label for the "From" field for email addresses.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'Subject',
+					'Label for the "Subject" field (short description of contents) for emails.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			html_entity_decode($this->_to, ENT_QUOTES, "UTF-8"),
+			stripslashes(html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8")),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'
+					),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		if (! empty($this->_cc)) {
+			$headers[] = 'cc: ' . $this->_cc;
+		}
+
+		//but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
+		// header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 * @return string
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		//includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1])
+			? $parsed_from[1]
+			: get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 * @return string
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		//if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		$from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;
+
+		return stripslashes_deep(html_entity_decode($from_name, ENT_QUOTES, "UTF-8"));
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _body($preview = false)
+	{
+		//setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop(
+				stripslashes_deep(
+					html_entity_decode($this->_content, ENT_QUOTES, "UTF-8")
+				)
+			),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+			//require CssToInlineStyles library and its dependencies via composer autoloader
+			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+
+			//now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents(
+					$this->get_variation(
+						$this->_tmp_pack,
+						$this->_incoming_message_type->name,
+						false,
+						'main',
+						$this->_variation
+					),
+					true
+				);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
+				//for some reason the library has a bracket and new line at the beginning.  This takes care of that.
+				$body  = ltrim($CSS->convert(true), ">\n");
+				//see https://events.codebasehq.com/projects/event-espresso/tickets/8609
+				$body  = ltrim($body, "<?");
+			}
+
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		//override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -58,7 +58,7 @@ 
             ),
             '<code>wp_mail</code>'
         );
-        $this->label               = array(
+        $this->label = array(
             'singular' => esc_html__('email', 'event_espresso'),
             'plural'   => esc_html__('emails', 'event_espresso'),
         );
@@ -438,7 +438,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -482,13 +482,13 @@ 
         $this->_ensure_has_from_email_address();
         $from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
-        if (! empty($this->_cc)) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc)) {
+            $headers[] = 'cc: '.$this->_cc;
         }
 
         //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
@@ -598,7 +598,7 @@ 
                 )
             ),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -608,10 +608,10 @@ 
          */
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
             //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents(
                     $this->get_variation(
                         $this->_tmp_pack,

core/exceptions/ExceptionStackTraceDisplay.php

Indentation +280 added lines, -280 removed lines

@@ -8,7 +8,7 @@ 
 use ReflectionMethod;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -26,53 +26,53 @@ 
 
 
 
-    /**
-     * @param Exception $exception
-     * @throws Exception
-     */
-    public function __construct(Exception $exception)
-    {
-        if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
-            $this->displayException($exception);
-        } else {
-            throw $exception;
-        }
-    }
+	/**
+	 * @param Exception $exception
+	 * @throws Exception
+	 */
+	public function __construct(Exception $exception)
+	{
+		if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
+			$this->displayException($exception);
+		} else {
+			throw $exception;
+		}
+	}
 
 
 
-    /**
-     * @access protected
-     * @param Exception $exception
-     * @throws ReflectionException
-     */
-    protected function displayException(Exception $exception)
-    {
-        $error_code = '';
-        $trace_details = '';
-        $time = time();
-        $trace = $exception->getTrace();
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $exception->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // start gathering output
-        $output = $this->exceptionStyles();
-        $output .= '
+	/**
+	 * @access protected
+	 * @param Exception $exception
+	 * @throws ReflectionException
+	 */
+	protected function displayException(Exception $exception)
+	{
+		$error_code = '';
+		$trace_details = '';
+		$time = time();
+		$trace = $exception->getTrace();
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $exception->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// start gathering output
+		$output = $this->exceptionStyles();
+		$output .= '
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // process trace info
-        if (empty($trace)) {
-            $trace_details .= __(
-                'Sorry, but no trace information was available for this exception.',
-                'event_espresso'
-            );
-        } else {
-            $trace_details .= '
+		}
+		// process trace info
+		if (empty($trace)) {
+			$trace_details .= __(
+				'Sorry, but no trace information was available for this exception.',
+				'event_espresso'
+			);
+		} else {
+			$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -80,260 +80,260 @@ 
 					<th scope="col" align="right" style="width:3.5%;">Line</th>
 					<th scope="col" align="left" style="width:40%;">File</th>
 					<th scope="col" align="left">' . __('Class', 'event_espresso') . '->' . __('Method( arguments )',
-                    'event_espresso') . '</th>
+					'event_espresso') . '</th>
 				</tr>';
-            $last_on_stack = count($trace) - 1;
-            // reverse array so that stack is in proper chronological order
-            $sorted_trace = array_reverse($trace);
-            foreach ($sorted_trace as $nmbr => $trace) {
-                $file = isset($trace['file']) ? $trace['file'] : '';
-                $class = isset($trace['class']) ? $trace['class'] : '';
-                $type = isset($trace['type']) ? $trace['type'] : '';
-                $function = isset($trace['function']) ? $trace['function'] : '';
-                $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
-                $line = isset($trace['line']) ? $trace['line'] : '';
-                $zebra = $nmbr % 2 !== 0 ? ' odd' : '';
-                if (empty($file) && ! empty($class)) {
-                    $a = new ReflectionClass($class);
-                    $file = $a->getFileName();
-                    if (empty($line) && ! empty($function)) {
-                        try {
-                            //if $function is a closure, this throws an exception
-                            $b = new ReflectionMethod($class, $function);
-                            $line = $b->getStartLine();
-                        } catch (Exception $closure_exception) {
-                            $line = 'unknown';
-                        }
-                    }
-                }
-                if ($nmbr === $last_on_stack) {
-                    $file = $exception->getFile() !== '' ? $exception->getFile() : $file;
-                    $line = $exception->getLine() !== '' ? $exception->getLine() : $line;
-                    $error_code = $this->generate_error_code($file, $trace['function'], $line);
-                }
-                $file = \EEH_File::standardise_directory_separators($file);
-                $nmbr = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                $line = ! empty($line) ? $line : '&nbsp;';
-                $file = ! empty($file) ? $file : '&nbsp;';
-                $class_display = ! empty($class) ? $class : '';
-                $type = ! empty($type) ? $type : '';
-                $function = ! empty($function) ? $function : '';
-                $args = ! empty($args) ? '( ' . $args . ' )' : '()';
-                $trace_details .= '
+			$last_on_stack = count($trace) - 1;
+			// reverse array so that stack is in proper chronological order
+			$sorted_trace = array_reverse($trace);
+			foreach ($sorted_trace as $nmbr => $trace) {
+				$file = isset($trace['file']) ? $trace['file'] : '';
+				$class = isset($trace['class']) ? $trace['class'] : '';
+				$type = isset($trace['type']) ? $trace['type'] : '';
+				$function = isset($trace['function']) ? $trace['function'] : '';
+				$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+				$args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+				$line = isset($trace['line']) ? $trace['line'] : '';
+				$zebra = $nmbr % 2 !== 0 ? ' odd' : '';
+				if (empty($file) && ! empty($class)) {
+					$a = new ReflectionClass($class);
+					$file = $a->getFileName();
+					if (empty($line) && ! empty($function)) {
+						try {
+							//if $function is a closure, this throws an exception
+							$b = new ReflectionMethod($class, $function);
+							$line = $b->getStartLine();
+						} catch (Exception $closure_exception) {
+							$line = 'unknown';
+						}
+					}
+				}
+				if ($nmbr === $last_on_stack) {
+					$file = $exception->getFile() !== '' ? $exception->getFile() : $file;
+					$line = $exception->getLine() !== '' ? $exception->getLine() : $line;
+					$error_code = $this->generate_error_code($file, $trace['function'], $line);
+				}
+				$file = \EEH_File::standardise_directory_separators($file);
+				$nmbr = ! empty($nmbr) ? $nmbr : '&nbsp;';
+				$line = ! empty($line) ? $line : '&nbsp;';
+				$file = ! empty($file) ? $file : '&nbsp;';
+				$class_display = ! empty($class) ? $class : '';
+				$type = ! empty($type) ? $type : '';
+				$function = ! empty($function) ? $function : '';
+				$args = ! empty($args) ? '( ' . $args . ' )' : '()';
+				$trace_details .= '
 					<tr>
 						<td align="right" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $nmbr
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $nmbr
+								  . '</td>
 						<td align="right" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $line
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $line
+								  . '</td>
 						<td align="left" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $file
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $file
+								  . '</td>
 						<td align="left" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $class_display
-                                  . $type
-                                  . $function
-                                  . $args
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $class_display
+								  . $type
+								  . $function
+								  . $args
+								  . '</td>
 					</tr>';
-            }
-            $trace_details .= '
+			}
+			$trace_details .= '
 			 </table>
 			</div>';
-        }
-        $code = $exception->getCode() ? $exception->getCode() : $error_code;
-        // add generic non-identifying messages for non-privileged users
-        if (! WP_DEBUG) {
-            $output .= '<span class="ee-error-user-msg-spn">'
-                       . trim($msg)
-                       . '</span> &nbsp; <sup>'
-                       . $code
-                       . '</sup><br />';
-        } else {
-            // or helpful developer messages if debugging is on
-            $output .= '
+		}
+		$code = $exception->getCode() ? $exception->getCode() : $error_code;
+		// add generic non-identifying messages for non-privileged users
+		if (! WP_DEBUG) {
+			$output .= '<span class="ee-error-user-msg-spn">'
+					   . trim($msg)
+					   . '</span> &nbsp; <sup>'
+					   . $code
+					   . '</sup><br />';
+		} else {
+			// or helpful developer messages if debugging is on
+			$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				'
-                       . sprintf(
-                           __('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
-                           '<strong class="ee-error-dev-msg-str">',
-                           get_class($exception),
-                           '</strong>  &nbsp; <span>',
-                           $code . '</span>'
-                       )
-                       . '<br />
+					   . sprintf(
+						   __('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
+						   '<strong class="ee-error-dev-msg-str">',
+						   get_class($exception),
+						   '</strong>  &nbsp; <span>',
+						   $code . '</span>'
+					   )
+					   . '<br />
 				<span class="big-text">"'
-                       . trim($msg)
-                       . '"</span><br/>
+					   . trim($msg)
+					   . '"</span><br/>
 				<a id="display-ee-error-trace-1'
-                       . $time
-                       . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
-                       . $time
-                       . '">
+					   . $time
+					   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
+					   . $time
+					   . '">
 					'
-                       . __('click to view backtrace and class/method details', 'event_espresso')
-                       . '
+					   . __('click to view backtrace and class/method details', 'event_espresso')
+					   . '
 				</a><br />
 				'
-                       . $exception->getFile()
-                       . sprintf(
-                           __('%1$s( line no: %2$s )%3$s', 'event_espresso'),
-                           ' &nbsp; <span class="small-text lt-grey-text">',
-                           $exception->getLine(),
-                           '</span>'
-                       )
-                       . '
+					   . $exception->getFile()
+					   . sprintf(
+						   __('%1$s( line no: %2$s )%3$s', 'event_espresso'),
+						   ' &nbsp; <span class="small-text lt-grey-text">',
+						   $exception->getLine(),
+						   '</span>'
+					   )
+					   . '
 			</p>
 			<div id="ee-error-trace-1'
-                       . $time
-                       . '-dv" class="ee-error-trace-dv" style="display: none;">
+					   . $time
+					   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                       . $trace_details;
-            if (! empty($class)) {
-                $output .= '
+					   . $trace_details;
+			if (! empty($class)) {
+				$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
 						<h3>' . __('Class Details', 'event_espresso') . '</h3>';
-                $a = new ReflectionClass($class);
-                $output .= '
+				$a = new ReflectionClass($class);
+				$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-            }
-            $output .= '
+			}
+			$output .= '
 			</div>
 		</div>
 		<br />';
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= $this->printScripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-    }
+		$output .= $this->printScripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+	}
 
 
 
-    /**
-     * generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param int   $indent
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
-    {
-        $args = array();
-        $args_count = count($arguments);
-        if ($args_count > 2) {
-            $indent++;
-            $args[] = '<br />';
-        }
-        $x = 0;
-        foreach ($arguments as $arg) {
-            $x++;
-            for ($i = 0; $i < $indent; $i++) {
-                $args[] = ' &nbsp;&nbsp; ';
-            }
-            if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
-                    $args[] = '<br />';
-                    for ($i = 0; $i <= $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                    $args[] = "'" . $arg . "'<br />";
-                } else {
-                    $args[] = " '" . $arg . "'";
-                }
-            } elseif (is_array($arg)) {
-                $arg_count = count($arg);
-                if ($arg_count > 2) {
-                    $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
-                    $indent--;
-                } else if ($arg_count === 0) {
-                    $args[] = ' array()';
-                } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
-                }
-            } elseif ($arg === null) {
-                $args[] = ' null';
-            } elseif (is_bool($arg)) {
-                $args[] = $arg ? ' true' : ' false';
-            } elseif (is_object($arg)) {
-                $args[] = get_class($arg);
-            } elseif (is_resource($arg)) {
-                $args[] = get_resource_type($arg);
-            } else {
-                $args[] = $arg;
-            }
-            if ($x === $args_count) {
-                if ($args_count > 2) {
-                    $args[] = '<br />';
-                    $indent--;
-                    for ($i = 1; $i < $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                }
-            } else {
-                $args[] = $args_count > 2 ? ',<br />' : ', ';
-            }
-        }
-        return implode('', $args);
-    }
+	/**
+	 * generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param int   $indent
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
+	{
+		$args = array();
+		$args_count = count($arguments);
+		if ($args_count > 2) {
+			$indent++;
+			$args[] = '<br />';
+		}
+		$x = 0;
+		foreach ($arguments as $arg) {
+			$x++;
+			for ($i = 0; $i < $indent; $i++) {
+				$args[] = ' &nbsp;&nbsp; ';
+			}
+			if (is_string($arg)) {
+				if (! $array && strlen($arg) > 75) {
+					$args[] = '<br />';
+					for ($i = 0; $i <= $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+					$args[] = "'" . $arg . "'<br />";
+				} else {
+					$args[] = " '" . $arg . "'";
+				}
+			} elseif (is_array($arg)) {
+				$arg_count = count($arg);
+				if ($arg_count > 2) {
+					$indent++;
+					$args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+					$indent--;
+				} else if ($arg_count === 0) {
+					$args[] = ' array()';
+				} else {
+					$args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+				}
+			} elseif ($arg === null) {
+				$args[] = ' null';
+			} elseif (is_bool($arg)) {
+				$args[] = $arg ? ' true' : ' false';
+			} elseif (is_object($arg)) {
+				$args[] = get_class($arg);
+			} elseif (is_resource($arg)) {
+				$args[] = get_resource_type($arg);
+			} else {
+				$args[] = $arg;
+			}
+			if ($x === $args_count) {
+				if ($args_count > 2) {
+					$args[] = '<br />';
+					$indent--;
+					for ($i = 1; $i < $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+				}
+			} else {
+				$args[] = $args_count > 2 ? ',<br />' : ', ';
+			}
+		}
+		return implode('', $args);
+	}
 
 
 
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @access protected
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    protected function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file_bits = explode('.', basename($file));
-        $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @access protected
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	protected function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file_bits = explode('.', basename($file));
+		$error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
 
 
 
-    /**
-     * _exception_styles
-     *
-     * @return string
-     */
-    private function exceptionStyles()
-    {
-        return '
+	/**
+	 * _exception_styles
+	 *
+	 * @return string
+	 */
+	private function exceptionStyles()
+	{
+		return '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -390,30 +390,30 @@ 
 		color: #999;
 	}
 </style>';
-    }
+	}
 
 
 
-    /**
-     * _print_scripts
-     *
-     * @param bool $force_print
-     * @return string
-     */
-    private function printScripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script( 'ee_error_js' );
+	/**
+	 * _print_scripts
+	 *
+	 * @param bool $force_print
+	 * @return string
+	 */
+	private function printScripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script( 'ee_error_js' );
 				wp_localize_script( 'ee_error_js', 'ee_settings', array( 'wp_debug' => WP_DEBUG ) );
-            }
-        } else {
-            return '
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -423,9 +423,9 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
+		}
+		return '';
+	}
 
 
 

Spacing +26 added lines, -26 removed lines

@@ -7,7 +7,7 @@ 
 use ReflectionException;
 use ReflectionMethod;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -61,7 +61,7 @@ 
         $output = $this->exceptionStyles();
         $output .= '
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	<p>';
         }
@@ -79,8 +79,8 @@ 
 					<th scope="col" align="right" style="width:2.5%;">#</th>
 					<th scope="col" align="right" style="width:3.5%;">Line</th>
 					<th scope="col" align="left" style="width:40%;">File</th>
-					<th scope="col" align="left">' . __('Class', 'event_espresso') . '->' . __('Method( arguments )',
-                    'event_espresso') . '</th>
+					<th scope="col" align="left">' . __('Class', 'event_espresso').'->'.__('Method( arguments )',
+                    'event_espresso').'</th>
 				</tr>';
             $last_on_stack = count($trace) - 1;
             // reverse array so that stack is in proper chronological order
@@ -91,7 +91,7 @@ 
                 $type = isset($trace['type']) ? $trace['type'] : '';
                 $function = isset($trace['function']) ? $trace['function'] : '';
                 $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />'.$args.'<br />' : $args;
                 $line = isset($trace['line']) ? $trace['line'] : '';
                 $zebra = $nmbr % 2 !== 0 ? ' odd' : '';
                 if (empty($file) && ! empty($class)) {
@@ -119,7 +119,7 @@ 
                 $class_display = ! empty($class) ? $class : '';
                 $type = ! empty($type) ? $type : '';
                 $function = ! empty($function) ? $function : '';
-                $args = ! empty($args) ? '( ' . $args . ' )' : '()';
+                $args = ! empty($args) ? '( '.$args.' )' : '()';
                 $trace_details .= '
 					<tr>
 						<td align="right" valign="top" class="'
@@ -153,7 +153,7 @@ 
         }
         $code = $exception->getCode() ? $exception->getCode() : $error_code;
         // add generic non-identifying messages for non-privileged users
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '<span class="ee-error-user-msg-spn">'
                        . trim($msg)
                        . '</span> &nbsp; <sup>'
@@ -170,7 +170,7 @@ 
                            '<strong class="ee-error-dev-msg-str">',
                            get_class($exception),
                            '</strong>  &nbsp; <span>',
-                           $code . '</span>'
+                           $code.'</span>'
                        )
                        . '<br />
 				<span class="big-text">"'
@@ -200,14 +200,14 @@ 
                        . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
                        . $trace_details;
-            if (! empty($class)) {
+            if ( ! empty($class)) {
                 $output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
-						<h3>' . __('Class Details', 'event_espresso') . '</h3>';
+						<h3>' . __('Class Details', 'event_espresso').'</h3>';
                 $a = new ReflectionClass($class);
                 $output .= '
-						<pre>' . $a . '</pre>
+						<pre>' . $a.'</pre>
 					</div>
 				</div>';
             }
@@ -218,7 +218,7 @@ 
         }
         // remove last linebreak
         $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	</p>';
         }
@@ -257,25 +257,25 @@ 
                 $args[] = ' &nbsp;&nbsp; ';
             }
             if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
+                if ( ! $array && strlen($arg) > 75) {
                     $args[] = '<br />';
                     for ($i = 0; $i <= $indent; $i++) {
                         $args[] = ' &nbsp;&nbsp; ';
                     }
-                    $args[] = "'" . $arg . "'<br />";
+                    $args[] = "'".$arg."'<br />";
                 } else {
-                    $args[] = " '" . $arg . "'";
+                    $args[] = " '".$arg."'";
                 }
             } elseif (is_array($arg)) {
                 $arg_count = count($arg);
                 if ($arg_count > 2) {
                     $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+                    $args[] = ' array('.$this->_convert_args_to_string($arg, $indent, true).')';
                     $indent--;
                 } else if ($arg_count === 0) {
                     $args[] = ' array()';
                 } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+                    $args[] = ' array( '.$this->_convert_args_to_string($arg).' )';
                 }
             } elseif ($arg === null) {
                 $args[] = ' null';
@@ -319,8 +319,8 @@ 
     {
         $file_bits = explode('.', basename($file));
         $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
+        $error_code .= ! empty($func) ? ' - '.$func : '';
+        $error_code .= ! empty($line) ? ' - '.$line : '';
         return $error_code;
     }
 
@@ -402,26 +402,26 @@ 
      */
     private function printScripts($force_print = false)
     {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+        if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
             if (wp_script_is('ee_error_js', 'enqueued')) {
                 return '';
             }
             if (wp_script_is('ee_error_js', 'registered')) {
                 wp_enqueue_style('espresso_default');
                 wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script( 'ee_error_js' );
-				wp_localize_script( 'ee_error_js', 'ee_settings', array( 'wp_debug' => WP_DEBUG ) );
+                wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
             }
         } else {
             return '
 <script>
 /* <![CDATA[ */
-var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
+var ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
 /* ]]> */
 </script>
-<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
+<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
 ';
         }
         return '';

core/EE_Error.core.php

Indentation +1095 added lines, -1095 removed lines

@@ -5,8 +5,8 @@ 
 // if you're a dev and want to receive all errors via email
 // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE );
 if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) {
-    set_error_handler(array('EE_Error', 'error_handler'));
-    register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
+	set_error_handler(array('EE_Error', 'error_handler'));
+	register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
 }
 
 
@@ -23,259 +23,259 @@ 
 {
 
 
-    /**
-     *    name of the file to log exceptions to
-     *
-     * @var string
-     */
-    private static $_exception_log_file = 'espresso_error_log.txt';
-
-    /**
-     *    stores details for all exception
-     *
-     * @var array
-     */
-    private static $_all_exceptions = array();
-
-    /**
-     *    tracks number of errors
-     *
-     * @var int
-     */
-    private static $_error_count = 0;
-
-    /**
-     *    has shutdown action been added ?
-     *
-     * @var array $_espresso_notices
-     */
-    private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
-
-
-
-    /**
-     * @override default exception handling
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($message, $code = 0, Exception $previous = null)
-    {
-        if (version_compare(PHP_VERSION, '5.3.0', '<')) {
-            parent::__construct($message, $code);
-        } else {
-            parent::__construct($message, $code, $previous);
-        }
-    }
-
-
-
-    /**
-     *    error_handler
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return void
-     */
-    public static function error_handler($code, $message, $file, $line)
-    {
-        $type = EE_Error::error_type($code);
-        $site = site_url();
-        switch ($site) {
-            case 'http://ee4.eventespresso.com/' :
-            case 'http://ee4decaf.eventespresso.com/' :
-            case 'http://ee4hf.eventespresso.com/' :
-            case 'http://ee4a.eventespresso.com/' :
-            case 'http://ee4ad.eventespresso.com/' :
-            case 'http://ee4b.eventespresso.com/' :
-            case 'http://ee4bd.eventespresso.com/' :
-            case 'http://ee4d.eventespresso.com/' :
-            case 'http://ee4dd.eventespresso.com/' :
-                $to = 'developers@eventespresso.com';
-                break;
-            default :
-                $to = get_option('admin_email');
-        }
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
-        $msg = EE_Error::_format_error($type, $message, $file, $line);
-        if (function_exists('wp_mail')) {
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-            wp_mail($to, $subject, $msg);
-        }
-        echo '<div id="message" class="espresso-notices error"><p>';
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
-        echo '<br /></p></div>';
-    }
-
-
-
-    /**
-     * error_type
-     * http://www.php.net/manual/en/errorfunc.constants.php#109430
-     *
-     * @param $code
-     * @return string
-     */
-    public static function error_type($code)
-    {
-        switch ($code) {
-            case E_ERROR: // 1 //
-                return 'E_ERROR';
-            case E_WARNING: // 2 //
-                return 'E_WARNING';
-            case E_PARSE: // 4 //
-                return 'E_PARSE';
-            case E_NOTICE: // 8 //
-                return 'E_NOTICE';
-            case E_CORE_ERROR: // 16 //
-                return 'E_CORE_ERROR';
-            case E_CORE_WARNING: // 32 //
-                return 'E_CORE_WARNING';
-            case E_COMPILE_ERROR: // 64 //
-                return 'E_COMPILE_ERROR';
-            case E_COMPILE_WARNING: // 128 //
-                return 'E_COMPILE_WARNING';
-            case E_USER_ERROR: // 256 //
-                return 'E_USER_ERROR';
-            case E_USER_WARNING: // 512 //
-                return 'E_USER_WARNING';
-            case E_USER_NOTICE: // 1024 //
-                return 'E_USER_NOTICE';
-            case E_STRICT: // 2048 //
-                return 'E_STRICT';
-            case E_RECOVERABLE_ERROR: // 4096 //
-                return 'E_RECOVERABLE_ERROR';
-            case E_DEPRECATED: // 8192 //
-                return 'E_DEPRECATED';
-            case E_USER_DEPRECATED: // 16384 //
-                return 'E_USER_DEPRECATED';
-            case E_ALL: // 16384 //
-                return 'E_ALL';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    fatal_error_handler
-     *
-     * @return void
-     */
-    public static function fatal_error_handler()
-    {
-        $last_error = error_get_last();
-        if ($last_error['type'] === E_ERROR) {
-            EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
-        }
-    }
-
-
-
-    /**
-     * _format_error
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return string
-     */
-    private static function _format_error($code, $message, $file, $line)
-    {
-        $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
-        $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
-        $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
-        $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
-        $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
-        $html .= '</tbody></table>';
-        return $html;
-    }
-
-
-
-    /**
-     * set_content_type
-     *
-     * @param $content_type
-     * @return string
-     */
-    public static function set_content_type($content_type)
-    {
-        return 'text/html';
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_error()
-    {
-        if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
-            throw $this;
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $this->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add details to _all_exceptions array
-        $x_time = time();
-        self::$_all_exceptions[$x_time]['name'] = get_class($this);
-        self::$_all_exceptions[$x_time]['file'] = $this->getFile();
-        self::$_all_exceptions[$x_time]['line'] = $this->getLine();
-        self::$_all_exceptions[$x_time]['msg'] = $msg;
-        self::$_all_exceptions[$x_time]['code'] = $this->getCode();
-        self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
-        self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
-        self::$_error_count++;
-        //add_action( 'shutdown', array( $this, 'display_errors' ));
-        $this->display_errors();
-    }
-
-
-
-    /**
-     *    has_error
-     *
-     * @param bool   $check_stored
-     * @param string $type_to_check
-     * @return bool
-     */
-    public static function has_error($check_stored = false, $type_to_check = 'errors')
-    {
-        $has_error = isset(self::$_espresso_notices[$type_to_check])
-                     && ! empty(self::$_espresso_notices[$type_to_check])
-            ? true
-            : false;
-        if ($check_stored && ! $has_error) {
-            $notices = (array)get_option('ee_notices', array());
-            foreach ($notices as $type => $notice) {
-                if ($type === $type_to_check && $notice) {
-                    return true;
-                }
-            }
-        }
-        return $has_error;
-    }
-
-
-
-    /**
-     *    display_errors
-     *
-     * @echo   string
-     * @throws \ReflectionException
-     */
-    public function display_errors()
-    {
-        $trace_details = '';
-        $output = '
+	/**
+	 *    name of the file to log exceptions to
+	 *
+	 * @var string
+	 */
+	private static $_exception_log_file = 'espresso_error_log.txt';
+
+	/**
+	 *    stores details for all exception
+	 *
+	 * @var array
+	 */
+	private static $_all_exceptions = array();
+
+	/**
+	 *    tracks number of errors
+	 *
+	 * @var int
+	 */
+	private static $_error_count = 0;
+
+	/**
+	 *    has shutdown action been added ?
+	 *
+	 * @var array $_espresso_notices
+	 */
+	private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
+
+
+
+	/**
+	 * @override default exception handling
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($message, $code = 0, Exception $previous = null)
+	{
+		if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+			parent::__construct($message, $code);
+		} else {
+			parent::__construct($message, $code, $previous);
+		}
+	}
+
+
+
+	/**
+	 *    error_handler
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return void
+	 */
+	public static function error_handler($code, $message, $file, $line)
+	{
+		$type = EE_Error::error_type($code);
+		$site = site_url();
+		switch ($site) {
+			case 'http://ee4.eventespresso.com/' :
+			case 'http://ee4decaf.eventespresso.com/' :
+			case 'http://ee4hf.eventespresso.com/' :
+			case 'http://ee4a.eventespresso.com/' :
+			case 'http://ee4ad.eventespresso.com/' :
+			case 'http://ee4b.eventespresso.com/' :
+			case 'http://ee4bd.eventespresso.com/' :
+			case 'http://ee4d.eventespresso.com/' :
+			case 'http://ee4dd.eventespresso.com/' :
+				$to = 'developers@eventespresso.com';
+				break;
+			default :
+				$to = get_option('admin_email');
+		}
+		$subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+		$msg = EE_Error::_format_error($type, $message, $file, $line);
+		if (function_exists('wp_mail')) {
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			wp_mail($to, $subject, $msg);
+		}
+		echo '<div id="message" class="espresso-notices error"><p>';
+		echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+		echo '<br /></p></div>';
+	}
+
+
+
+	/**
+	 * error_type
+	 * http://www.php.net/manual/en/errorfunc.constants.php#109430
+	 *
+	 * @param $code
+	 * @return string
+	 */
+	public static function error_type($code)
+	{
+		switch ($code) {
+			case E_ERROR: // 1 //
+				return 'E_ERROR';
+			case E_WARNING: // 2 //
+				return 'E_WARNING';
+			case E_PARSE: // 4 //
+				return 'E_PARSE';
+			case E_NOTICE: // 8 //
+				return 'E_NOTICE';
+			case E_CORE_ERROR: // 16 //
+				return 'E_CORE_ERROR';
+			case E_CORE_WARNING: // 32 //
+				return 'E_CORE_WARNING';
+			case E_COMPILE_ERROR: // 64 //
+				return 'E_COMPILE_ERROR';
+			case E_COMPILE_WARNING: // 128 //
+				return 'E_COMPILE_WARNING';
+			case E_USER_ERROR: // 256 //
+				return 'E_USER_ERROR';
+			case E_USER_WARNING: // 512 //
+				return 'E_USER_WARNING';
+			case E_USER_NOTICE: // 1024 //
+				return 'E_USER_NOTICE';
+			case E_STRICT: // 2048 //
+				return 'E_STRICT';
+			case E_RECOVERABLE_ERROR: // 4096 //
+				return 'E_RECOVERABLE_ERROR';
+			case E_DEPRECATED: // 8192 //
+				return 'E_DEPRECATED';
+			case E_USER_DEPRECATED: // 16384 //
+				return 'E_USER_DEPRECATED';
+			case E_ALL: // 16384 //
+				return 'E_ALL';
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    fatal_error_handler
+	 *
+	 * @return void
+	 */
+	public static function fatal_error_handler()
+	{
+		$last_error = error_get_last();
+		if ($last_error['type'] === E_ERROR) {
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
+		}
+	}
+
+
+
+	/**
+	 * _format_error
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return string
+	 */
+	private static function _format_error($code, $message, $file, $line)
+	{
+		$html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
+		$html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
+		$html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
+		$html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
+		$html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
+		$html .= '</tbody></table>';
+		return $html;
+	}
+
+
+
+	/**
+	 * set_content_type
+	 *
+	 * @param $content_type
+	 * @return string
+	 */
+	public static function set_content_type($content_type)
+	{
+		return 'text/html';
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_error()
+	{
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
+			throw $this;
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $this->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add details to _all_exceptions array
+		$x_time = time();
+		self::$_all_exceptions[$x_time]['name'] = get_class($this);
+		self::$_all_exceptions[$x_time]['file'] = $this->getFile();
+		self::$_all_exceptions[$x_time]['line'] = $this->getLine();
+		self::$_all_exceptions[$x_time]['msg'] = $msg;
+		self::$_all_exceptions[$x_time]['code'] = $this->getCode();
+		self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
+		self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
+		self::$_error_count++;
+		//add_action( 'shutdown', array( $this, 'display_errors' ));
+		$this->display_errors();
+	}
+
+
+
+	/**
+	 *    has_error
+	 *
+	 * @param bool   $check_stored
+	 * @param string $type_to_check
+	 * @return bool
+	 */
+	public static function has_error($check_stored = false, $type_to_check = 'errors')
+	{
+		$has_error = isset(self::$_espresso_notices[$type_to_check])
+					 && ! empty(self::$_espresso_notices[$type_to_check])
+			? true
+			: false;
+		if ($check_stored && ! $has_error) {
+			$notices = (array)get_option('ee_notices', array());
+			foreach ($notices as $type => $notice) {
+				if ($type === $type_to_check && $notice) {
+					return true;
+				}
+			}
+		}
+		return $has_error;
+	}
+
+
+
+	/**
+	 *    display_errors
+	 *
+	 * @echo   string
+	 * @throws \ReflectionException
+	 */
+	public function display_errors()
+	{
+		$trace_details = '';
+		$output = '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -331,19 +331,19 @@ 
 	}
 </style>
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // cycle thru errors
-        foreach (self::$_all_exceptions as $time => $ex) {
-            $error_code = '';
-            // process trace info
-            if (empty($ex['trace'])) {
-                $trace_details .= __('Sorry, but no trace information was available for this exception.',
-                    'event_espresso');
-            } else {
-                $trace_details .= '
+		}
+		// cycle thru errors
+		foreach (self::$_all_exceptions as $time => $ex) {
+			$error_code = '';
+			// process trace info
+			if (empty($ex['trace'])) {
+				$trace_details .= __('Sorry, but no trace information was available for this exception.',
+					'event_espresso');
+			} else {
+				$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -353,43 +353,43 @@ 
 					<th scope="col" align="left">Class</th>
 					<th scope="col" align="left">Method( arguments )</th>
 				</tr>';
-                $last_on_stack = count($ex['trace']) - 1;
-                // reverse array so that stack is in proper chronological order
-                $sorted_trace = array_reverse($ex['trace']);
-                foreach ($sorted_trace as $nmbr => $trace) {
-                    $file = isset($trace['file']) ? $trace['file'] : '';
-                    $class = isset($trace['class']) ? $trace['class'] : '';
-                    $type = isset($trace['type']) ? $trace['type'] : '';
-                    $function = isset($trace['function']) ? $trace['function'] : '';
-                    $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                    $line = isset($trace['line']) ? $trace['line'] : '';
-                    $zebra = ($nmbr % 2) ? ' odd' : '';
-                    if (empty($file) && ! empty($class)) {
-                        $a = new ReflectionClass($class);
-                        $file = $a->getFileName();
-                        if (empty($line) && ! empty($function)) {
-                            try {
-                                //if $function is a closure, this throws an exception
-                                $b = new ReflectionMethod($class, $function);
-                                $line = $b->getStartLine();
-                            } catch (Exception $closure_exception) {
-                                $line = 'unknown';
-                            }
-                        }
-                    }
-                    if ($nmbr === $last_on_stack) {
-                        $file = $ex['file'] !== '' ? $ex['file'] : $file;
-                        $line = $ex['line'] !== '' ? $ex['line'] : $line;
-                        $error_code = self::generate_error_code($file, $trace['function'], $line);
-                    }
-                    $nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                    $line_dsply = ! empty($line) ? $line : '&nbsp;';
-                    $file_dsply = ! empty($file) ? $file : '&nbsp;';
-                    $class_dsply = ! empty($class) ? $class : '&nbsp;';
-                    $type_dsply = ! empty($type) ? $type : '&nbsp;';
-                    $function_dsply = ! empty($function) ? $function : '&nbsp;';
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
-                    $trace_details .= '
+				$last_on_stack = count($ex['trace']) - 1;
+				// reverse array so that stack is in proper chronological order
+				$sorted_trace = array_reverse($ex['trace']);
+				foreach ($sorted_trace as $nmbr => $trace) {
+					$file = isset($trace['file']) ? $trace['file'] : '';
+					$class = isset($trace['class']) ? $trace['class'] : '';
+					$type = isset($trace['type']) ? $trace['type'] : '';
+					$function = isset($trace['function']) ? $trace['function'] : '';
+					$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+					$line = isset($trace['line']) ? $trace['line'] : '';
+					$zebra = ($nmbr % 2) ? ' odd' : '';
+					if (empty($file) && ! empty($class)) {
+						$a = new ReflectionClass($class);
+						$file = $a->getFileName();
+						if (empty($line) && ! empty($function)) {
+							try {
+								//if $function is a closure, this throws an exception
+								$b = new ReflectionMethod($class, $function);
+								$line = $b->getStartLine();
+							} catch (Exception $closure_exception) {
+								$line = 'unknown';
+							}
+						}
+					}
+					if ($nmbr === $last_on_stack) {
+						$file = $ex['file'] !== '' ? $ex['file'] : $file;
+						$line = $ex['line'] !== '' ? $ex['line'] : $line;
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
+					}
+					$nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
+					$line_dsply = ! empty($line) ? $line : '&nbsp;';
+					$file_dsply = ! empty($file) ? $file : '&nbsp;';
+					$class_dsply = ! empty($class) ? $class : '&nbsp;';
+					$type_dsply = ! empty($type) ? $type : '&nbsp;';
+					$function_dsply = ! empty($function) ? $function : '&nbsp;';
+					$args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
+					$trace_details .= '
 					<tr>
 						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
 						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
@@ -397,674 +397,674 @@ 
 						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
 						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
 					</tr>';
-                }
-                $trace_details .= '
+				}
+				$trace_details .= '
 			 </table>
 			</div>';
-            }
-            $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
-            // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
-                $output .= '<span class="ee-error-user-msg-spn">'
-                           . trim($ex['msg'])
-                           . '</span> &nbsp; <sup>'
-                           . $ex['code']
-                           . '</sup><br />';
-            } else {
-                // or helpful developer messages if debugging is on
-                $output .= '
+			}
+			$ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
+			// add generic non-identifying messages for non-privileged users
+			if (! WP_DEBUG) {
+				$output .= '<span class="ee-error-user-msg-spn">'
+						   . trim($ex['msg'])
+						   . '</span> &nbsp; <sup>'
+						   . $ex['code']
+						   . '</sup><br />';
+			} else {
+				// or helpful developer messages if debugging is on
+				$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				<strong class="ee-error-dev-msg-str">An '
-                           . $ex['name']
-                           . ' exception was thrown!</strong>  &nbsp; <span>code: '
-                           . $ex['code']
-                           . '</span><br />
+						   . $ex['name']
+						   . ' exception was thrown!</strong>  &nbsp; <span>code: '
+						   . $ex['code']
+						   . '</span><br />
 				<span class="big-text">"'
-                           . trim($ex['msg'])
-                           . '"</span><br/>
+						   . trim($ex['msg'])
+						   . '"</span><br/>
 				<a id="display-ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '">
+						   . self::$_error_count
+						   . $time
+						   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
+						   . self::$_error_count
+						   . $time
+						   . '">
 					'
-                           . __('click to view backtrace and class/method details', 'event_espresso')
-                           . '
+						   . __('click to view backtrace and class/method details', 'event_espresso')
+						   . '
 				</a><br />
 				<span class="small-text lt-grey-text">'
-                           . $ex['file']
-                           . ' &nbsp; ( line no: '
-                           . $ex['line']
-                           . ' )</span>
+						   . $ex['file']
+						   . ' &nbsp; ( line no: '
+						   . $ex['line']
+						   . ' )</span>
 			</p>
 			<div id="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '-dv" class="ee-error-trace-dv" style="display: none;">
+						   . self::$_error_count
+						   . $time
+						   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                           . $trace_details;
-                if (! empty($class)) {
-                    $output .= '
+						   . $trace_details;
+				if (! empty($class)) {
+					$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-                    $a = new ReflectionClass($class);
-                    $output .= '
+					$a = new ReflectionClass($class);
+					$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-                }
-                $output .= '
+				}
+				$output .= '
 			</div>
 		</div>
 		<br />';
-            }
-            $this->write_to_error_log($time, $ex);
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+			}
+			$this->write_to_error_log($time, $ex);
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= self::_print_scripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-        die();
-    }
-
-
-
-    /**
-     *    generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $array = false)
-    {
-        $arg_string = '';
-        if (! empty($arguments)) {
-            $args = array();
-            foreach ($arguments as $arg) {
-                if (! empty($arg)) {
-                    if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
-                    } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
-                    } elseif ($arg === null) {
-                        $args[] = ' NULL';
-                    } elseif (is_bool($arg)) {
-                        $args[] = ($arg) ? ' TRUE' : ' FALSE';
-                    } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
-                    } elseif (is_resource($arg)) {
-                        $args[] = get_resource_type($arg);
-                    } else {
-                        $args[] = $arg;
-                    }
-                }
-            }
-            $arg_string = implode(', ', $args);
-        }
-        if ($array) {
-            $arg_string .= ' )';
-        }
-        return $arg_string;
-    }
-
-
-
-    /**
-     *    add error message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_error($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('errors', $msg, $file, $func, $line);
-        self::$_error_count++;
-    }
-
-
-
-    /**
-     * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
-     * adds an error
-     *
-     * @param string $msg
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws EE_Error
-     */
-    public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
-    {
-        if (WP_DEBUG) {
-            throw new EE_Error($msg);
-        }
-        EE_Error::add_error($msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_success($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('success', $msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add attention message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_attention($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('attention', $msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $type whether the message is for a success or error notification
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    private static function _add_notice($type = 'success', $msg = null, $file = null, $func = null, $line = null)
-    {
-        if (empty($msg)) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
-                sprintf(
-                    __('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
-                        'event_espresso'),
-                    $type,
-                    $file,
-                    $line
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_error()',
-                __('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
-                    'event_espresso'),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $msg);
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        /**
-         * Do an action so other code can be triggered when a notice is created
-         *
-         * @param string $type     can be 'errors', 'attention', or 'success'
-         * @param string $user_msg message displayed to user when WP_DEBUG is off
-         * @param string $user_msg message displayed to user when WP_DEBUG is on
-         * @param string $file     file where error was generated
-         * @param string $func     function where error was generated
-         * @param string $line     line where error was generated
-         */
-        do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add notice if message exists
-        if (! empty($msg)) {
-            // get error code
-            $notice_code = EE_Error::generate_error_code($file, $func, $line);
-            if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
-            }
-            // add notice. Index by code if it's not blank
-            if ($notice_code) {
-                self::$_espresso_notices[$type][$notice_code] = $msg;
-            } else {
-                self::$_espresso_notices[$type][] = $msg;
-            }
-            add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
-        }
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing success messages
-     *
-     * @return        void
-     */
-    public static function overwrite_success()
-    {
-        self::$_espresso_notices['success'] = false;
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing attention messages
-     *
-     * @return        void
-     */
-    public static function overwrite_attention()
-    {
-        self::$_espresso_notices['attention'] = false;
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing error messages
-     *
-     * @return        void
-     */
-    public static function overwrite_errors()
-    {
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-
-    /**
-     *    reset_notices
-     *
-     * @return void
-     */
-    public static function reset_notices()
-    {
-        self::$_espresso_notices['success'] = false;
-        self::$_espresso_notices['attention'] = false;
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-
-    /**
-     *    has_errors
-     *
-     * @return int
-     */
-    public static function has_notices()
-    {
-        $has_notices = 0;
-        // check for success messages
-        $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3
-            : $has_notices;
-        // check for attention messages
-        $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2
-            : $has_notices;
-        // check for error messages
-        $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1
-            : $has_notices;
-        return $has_notices;
-    }
-
-
-
-    /**
-     * This simply returns non formatted error notices as they were sent into the EE_Error object.
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function get_vanilla_notices()
-    {
-        return array(
-            'success'   => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(),
-            'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention']
-                : array(),
-            'errors'    => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(),
-        );
-    }
-
-
-
-    /**
-     *    compile all error or success messages into one string
-     *
-     * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
-     * @param        boolean $format_output     whether or not to format the messages for display in the WP admin
-     * @param        boolean $save_to_transient whether or not to save notices to the db for retrieval on next request
-     *                                          - ONLY do this just before redirecting
-     * @param        boolean $remove_empty      whether or not to unset empty messages
-     * @return        array
-     */
-    public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $success_messages = '';
-        $attention_messages = '';
-        $error_messages = '';
-        $print_scripts = false;
-        // either save notices to the db
-        if ($save_to_transient) {
-            update_option('ee_notices', self::$_espresso_notices);
-            return array();
-        }
-        // grab any notices that have been previously saved
-        if ($notices = get_option('ee_notices', false)) {
-            foreach ($notices as $type => $notice) {
-                if (is_array($notice) && ! empty($notice)) {
-                    // make sure that existing notice type is an array
-                    self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
-                                                      && ! empty(self::$_espresso_notices[$type])
-                        ? self::$_espresso_notices[$type] : array();
-                    // merge stored notices with any newly created ones
-                    self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice);
-                    $print_scripts = true;
-                }
-            }
-            // now clear any stored notices
-            update_option('ee_notices', false);
-        }
-        // check for success messages
-        if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
-            // combine messages
-            $success_messages .= implode(self::$_espresso_notices['success'], '<br /><br />');
-            $print_scripts = true;
-        }
-        // check for attention messages
-        if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
-            // combine messages
-            $attention_messages .= implode(self::$_espresso_notices['attention'], '<br /><br />');
-            $print_scripts = true;
-        }
-        // check for error messages
-        if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
-            $error_messages .= count(self::$_espresso_notices['errors']) > 1
-                ? __('The following errors have occurred:<br />', 'event_espresso')
-                : __('An error has occurred:<br />', 'event_espresso');
-            // combine messages
-            $error_messages .= implode(self::$_espresso_notices['errors'], '<br /><br />');
-            $print_scripts = true;
-        }
-        if ($format_output) {
-            $notices = '<div id="espresso-notices">';
-            $close = is_admin() ? ''
-                : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"></span></a>';
-            if ($success_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-success';
-                $css_class = is_admin() ? 'updated fade' : 'success fade-away';
-                //showMessage( $success_messages );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $success_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            if ($attention_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-attention';
-                $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
-                //showMessage( $error_messages, TRUE );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $attention_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            if ($error_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-error';
-                $css_class = is_admin() ? 'error' : 'error fade-away';
-                //showMessage( $error_messages, TRUE );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $error_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            $notices .= '</div>';
-        } else {
-            $notices = array(
-                'success'   => $success_messages,
-                'attention' => $attention_messages,
-                'errors'    => $error_messages,
-            );
-            if ($remove_empty) {
-                // remove empty notices
-                foreach ($notices as $type => $notice) {
-                    if (empty($notice)) {
-                        unset($notices[$type]);
-                    }
-                }
-            }
-        }
-        if ($print_scripts) {
-            self::_print_scripts();
-        }
-        return $notices;
-    }
-
-
-
-    /**
-     *    add_persistent_admin_notice
-     *
-     * @param        string $pan_name     the name, or key of the Persistent Admin Notice to be stored
-     * @param        string $pan_message  the message to be stored persistently until dismissed
-     * @param bool          $force_update allows one to enforce the reappearance of a persistent message.
-     * @return        void
-     */
-    public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
-    {
-        if (! empty($pan_name) && ! empty($pan_message)) {
-            $persistent_admin_notices = get_option('ee_pers_admin_notices', array());
-            //maybe initialize persistent_admin_notices
-            if (empty($persistent_admin_notices)) {
-                add_option('ee_pers_admin_notices', array(), '', 'no');
-            }
-            $pan_name = sanitize_key($pan_name);
-            if (! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) {
-                $persistent_admin_notices[$pan_name] = $pan_message;
-                update_option('ee_pers_admin_notices', $persistent_admin_notices);
-            }
-        }
-    }
-
-
-
-    /**
-     *    dismiss_persistent_admin_notice
-     *
-     * @param        string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool          $purge
-     * @param bool          $return_immediately
-     * @return        void
-     */
-    public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return_immediately = false)
-    {
-        $pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice')
-            ? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name;
-        if (! empty($pan_name)) {
-            $persistent_admin_notices = get_option('ee_pers_admin_notices', array());
-            // check if notice we wish to dismiss is actually in the $persistent_admin_notices array
-            if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) {
-                // completely delete nag notice, or just NULL message so that it can NOT be added again ?
-                if ($purge) {
-                    unset($persistent_admin_notices[$pan_name]);
-                } else {
-                    $persistent_admin_notices[$pan_name] = null;
-                }
-                if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === false) {
-                    EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.',
-                        'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        if ($return_immediately) {
-            return;
-        }
-        if (EE_Registry::instance()->REQ->ajax) {
-            // grab any notices and concatenate into string
-            echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(false))));
-            exit();
-        }
-        // save errors to a transient to be displayed on next request (after redirect)
-        EE_Error::get_notices(false, true);
-        $return_url = EE_Registry::instance()->REQ->is_set('return_url')
-            ? EE_Registry::instance()->REQ->get('return_url') : '';
-        wp_safe_redirect(urldecode($return_url));
-    }
-
-
-
-    /**
-     * display_persistent_admin_notices
-     *
-     * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
-     * @param  string $pan_message the message to be stored persistently until dismissed
-     * @param  string $return_url  URL to go back to after nag notice is dismissed
-     * @return string
-     */
-    public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
-    {
-        if (! empty($pan_name) && ! empty($pan_message)) {
-            $args = array(
-                'nag_notice'    => $pan_name,
-                'return_url'    => urlencode($return_url),
-                'ajax_url'      => WP_AJAX_URL,
-                'unknown_error' => esc_html__(
-                    'An unknown error has occurred on the server while attempting to dismiss this notice.',
-                    'event_espresso'
-                ),
-            );
-            EE_Registry::$i18n_js_strings = array_merge(
-                EE_Registry::$i18n_js_strings,
-                array('ee_dismiss' => $args)
-            );
-            return '
+		$output .= self::_print_scripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+		die();
+	}
+
+
+
+	/**
+	 *    generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $array = false)
+	{
+		$arg_string = '';
+		if (! empty($arguments)) {
+			$args = array();
+			foreach ($arguments as $arg) {
+				if (! empty($arg)) {
+					if (is_string($arg)) {
+						$args[] = " '" . $arg . "'";
+					} elseif (is_array($arg)) {
+						$args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+					} elseif ($arg === null) {
+						$args[] = ' NULL';
+					} elseif (is_bool($arg)) {
+						$args[] = ($arg) ? ' TRUE' : ' FALSE';
+					} elseif (is_object($arg)) {
+						$args[] = ' OBJECT ' . get_class($arg);
+					} elseif (is_resource($arg)) {
+						$args[] = get_resource_type($arg);
+					} else {
+						$args[] = $arg;
+					}
+				}
+			}
+			$arg_string = implode(', ', $args);
+		}
+		if ($array) {
+			$arg_string .= ' )';
+		}
+		return $arg_string;
+	}
+
+
+
+	/**
+	 *    add error message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_error($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('errors', $msg, $file, $func, $line);
+		self::$_error_count++;
+	}
+
+
+
+	/**
+	 * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
+	 * adds an error
+	 *
+	 * @param string $msg
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws EE_Error
+	 */
+	public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
+	{
+		if (WP_DEBUG) {
+			throw new EE_Error($msg);
+		}
+		EE_Error::add_error($msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_success($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('success', $msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add attention message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_attention($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('attention', $msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $type whether the message is for a success or error notification
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	private static function _add_notice($type = 'success', $msg = null, $file = null, $func = null, $line = null)
+	{
+		if (empty($msg)) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_' . $type . '()',
+				sprintf(
+					__('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
+						'event_espresso'),
+					$type,
+					$file,
+					$line
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_error()',
+				__('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
+					'event_espresso'),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $msg);
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		/**
+		 * Do an action so other code can be triggered when a notice is created
+		 *
+		 * @param string $type     can be 'errors', 'attention', or 'success'
+		 * @param string $user_msg message displayed to user when WP_DEBUG is off
+		 * @param string $user_msg message displayed to user when WP_DEBUG is on
+		 * @param string $file     file where error was generated
+		 * @param string $func     function where error was generated
+		 * @param string $line     line where error was generated
+		 */
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add notice if message exists
+		if (! empty($msg)) {
+			// get error code
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
+			if (WP_DEBUG && $type === 'errors') {
+				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+			}
+			// add notice. Index by code if it's not blank
+			if ($notice_code) {
+				self::$_espresso_notices[$type][$notice_code] = $msg;
+			} else {
+				self::$_espresso_notices[$type][] = $msg;
+			}
+			add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
+		}
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing success messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_success()
+	{
+		self::$_espresso_notices['success'] = false;
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing attention messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_attention()
+	{
+		self::$_espresso_notices['attention'] = false;
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing error messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_errors()
+	{
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+
+	/**
+	 *    reset_notices
+	 *
+	 * @return void
+	 */
+	public static function reset_notices()
+	{
+		self::$_espresso_notices['success'] = false;
+		self::$_espresso_notices['attention'] = false;
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+
+	/**
+	 *    has_errors
+	 *
+	 * @return int
+	 */
+	public static function has_notices()
+	{
+		$has_notices = 0;
+		// check for success messages
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3
+			: $has_notices;
+		// check for attention messages
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2
+			: $has_notices;
+		// check for error messages
+		$has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1
+			: $has_notices;
+		return $has_notices;
+	}
+
+
+
+	/**
+	 * This simply returns non formatted error notices as they were sent into the EE_Error object.
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function get_vanilla_notices()
+	{
+		return array(
+			'success'   => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(),
+			'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention']
+				: array(),
+			'errors'    => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(),
+		);
+	}
+
+
+
+	/**
+	 *    compile all error or success messages into one string
+	 *
+	 * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
+	 * @param        boolean $format_output     whether or not to format the messages for display in the WP admin
+	 * @param        boolean $save_to_transient whether or not to save notices to the db for retrieval on next request
+	 *                                          - ONLY do this just before redirecting
+	 * @param        boolean $remove_empty      whether or not to unset empty messages
+	 * @return        array
+	 */
+	public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$success_messages = '';
+		$attention_messages = '';
+		$error_messages = '';
+		$print_scripts = false;
+		// either save notices to the db
+		if ($save_to_transient) {
+			update_option('ee_notices', self::$_espresso_notices);
+			return array();
+		}
+		// grab any notices that have been previously saved
+		if ($notices = get_option('ee_notices', false)) {
+			foreach ($notices as $type => $notice) {
+				if (is_array($notice) && ! empty($notice)) {
+					// make sure that existing notice type is an array
+					self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
+													  && ! empty(self::$_espresso_notices[$type])
+						? self::$_espresso_notices[$type] : array();
+					// merge stored notices with any newly created ones
+					self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice);
+					$print_scripts = true;
+				}
+			}
+			// now clear any stored notices
+			update_option('ee_notices', false);
+		}
+		// check for success messages
+		if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
+			// combine messages
+			$success_messages .= implode(self::$_espresso_notices['success'], '<br /><br />');
+			$print_scripts = true;
+		}
+		// check for attention messages
+		if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
+			// combine messages
+			$attention_messages .= implode(self::$_espresso_notices['attention'], '<br /><br />');
+			$print_scripts = true;
+		}
+		// check for error messages
+		if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
+			$error_messages .= count(self::$_espresso_notices['errors']) > 1
+				? __('The following errors have occurred:<br />', 'event_espresso')
+				: __('An error has occurred:<br />', 'event_espresso');
+			// combine messages
+			$error_messages .= implode(self::$_espresso_notices['errors'], '<br /><br />');
+			$print_scripts = true;
+		}
+		if ($format_output) {
+			$notices = '<div id="espresso-notices">';
+			$close = is_admin() ? ''
+				: '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"></span></a>';
+			if ($success_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-success';
+				$css_class = is_admin() ? 'updated fade' : 'success fade-away';
+				//showMessage( $success_messages );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $success_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			if ($attention_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-attention';
+				$css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
+				//showMessage( $error_messages, TRUE );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $attention_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			if ($error_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-error';
+				$css_class = is_admin() ? 'error' : 'error fade-away';
+				//showMessage( $error_messages, TRUE );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $error_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			$notices .= '</div>';
+		} else {
+			$notices = array(
+				'success'   => $success_messages,
+				'attention' => $attention_messages,
+				'errors'    => $error_messages,
+			);
+			if ($remove_empty) {
+				// remove empty notices
+				foreach ($notices as $type => $notice) {
+					if (empty($notice)) {
+						unset($notices[$type]);
+					}
+				}
+			}
+		}
+		if ($print_scripts) {
+			self::_print_scripts();
+		}
+		return $notices;
+	}
+
+
+
+	/**
+	 *    add_persistent_admin_notice
+	 *
+	 * @param        string $pan_name     the name, or key of the Persistent Admin Notice to be stored
+	 * @param        string $pan_message  the message to be stored persistently until dismissed
+	 * @param bool          $force_update allows one to enforce the reappearance of a persistent message.
+	 * @return        void
+	 */
+	public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
+	{
+		if (! empty($pan_name) && ! empty($pan_message)) {
+			$persistent_admin_notices = get_option('ee_pers_admin_notices', array());
+			//maybe initialize persistent_admin_notices
+			if (empty($persistent_admin_notices)) {
+				add_option('ee_pers_admin_notices', array(), '', 'no');
+			}
+			$pan_name = sanitize_key($pan_name);
+			if (! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) {
+				$persistent_admin_notices[$pan_name] = $pan_message;
+				update_option('ee_pers_admin_notices', $persistent_admin_notices);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    dismiss_persistent_admin_notice
+	 *
+	 * @param        string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool          $purge
+	 * @param bool          $return_immediately
+	 * @return        void
+	 */
+	public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return_immediately = false)
+	{
+		$pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice')
+			? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name;
+		if (! empty($pan_name)) {
+			$persistent_admin_notices = get_option('ee_pers_admin_notices', array());
+			// check if notice we wish to dismiss is actually in the $persistent_admin_notices array
+			if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) {
+				// completely delete nag notice, or just NULL message so that it can NOT be added again ?
+				if ($purge) {
+					unset($persistent_admin_notices[$pan_name]);
+				} else {
+					$persistent_admin_notices[$pan_name] = null;
+				}
+				if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === false) {
+					EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.',
+						'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		if ($return_immediately) {
+			return;
+		}
+		if (EE_Registry::instance()->REQ->ajax) {
+			// grab any notices and concatenate into string
+			echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(false))));
+			exit();
+		}
+		// save errors to a transient to be displayed on next request (after redirect)
+		EE_Error::get_notices(false, true);
+		$return_url = EE_Registry::instance()->REQ->is_set('return_url')
+			? EE_Registry::instance()->REQ->get('return_url') : '';
+		wp_safe_redirect(urldecode($return_url));
+	}
+
+
+
+	/**
+	 * display_persistent_admin_notices
+	 *
+	 * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
+	 * @param  string $pan_message the message to be stored persistently until dismissed
+	 * @param  string $return_url  URL to go back to after nag notice is dismissed
+	 * @return string
+	 */
+	public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
+	{
+		if (! empty($pan_name) && ! empty($pan_message)) {
+			$args = array(
+				'nag_notice'    => $pan_name,
+				'return_url'    => urlencode($return_url),
+				'ajax_url'      => WP_AJAX_URL,
+				'unknown_error' => esc_html__(
+					'An unknown error has occurred on the server while attempting to dismiss this notice.',
+					'event_espresso'
+				),
+			);
+			EE_Registry::$i18n_js_strings = array_merge(
+				EE_Registry::$i18n_js_strings,
+				array('ee_dismiss' => $args)
+			);
+			return '
 			<div id="'
-                   . $pan_name
-                   . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;">
+				   . $pan_name
+				   . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;">
 				<p>'
-                   . $pan_message
-                   . '</p>
+				   . $pan_message
+				   . '</p>
 				<a class="dismiss-ee-nag-notice hide-if-no-js" style="float: right; cursor: pointer; text-decoration:none;" rel="'
-                   . $pan_name
-                   . '">
+				   . $pan_name
+				   . '">
 					<span class="dashicons dashicons-dismiss" style="position:relative; top:-1px; margin-right:.25em;"></span>'
-                   . __('Dismiss', 'event_espresso')
-                   . '
+				   . __('Dismiss', 'event_espresso')
+				   . '
 				</a>
 				<div style="clear:both;"></div>
 			</div>';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @param string $return_url
-     * @return string
-     */
-    public static function get_persistent_admin_notices($return_url = '')
-    {
-        $notices = '';
-        // check for persistent admin notices
-        //filter the list though so plugins can notify the admin in a different way if they want
-        $persistent_admin_notices = apply_filters(
-            'FHEE__EE_Error__get_persistent_admin_notices',
-            get_option('ee_pers_admin_notices', false),
-            'ee_pers_admin_notices',
-            $return_url
-        );
-        if ($persistent_admin_notices) {
-            // load scripts
-            wp_register_script(
-                'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-                array('jquery'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_register_script(
-                'ee_error_js',
-                EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-                array('espresso_core'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('ee_error_js');
-            // and display notices
-            foreach ($persistent_admin_notices as $pan_name => $pan_message) {
-                $notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url);
-            }
-        }
-        return $notices;
-    }
-
-
-
-    /**
-     * _print_scripts
-     *
-     * @param    bool $force_print
-     * @return    string
-     */
-    private static function _print_scripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-            }
-        } else {
-            return '
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @param string $return_url
+	 * @return string
+	 */
+	public static function get_persistent_admin_notices($return_url = '')
+	{
+		$notices = '';
+		// check for persistent admin notices
+		//filter the list though so plugins can notify the admin in a different way if they want
+		$persistent_admin_notices = apply_filters(
+			'FHEE__EE_Error__get_persistent_admin_notices',
+			get_option('ee_pers_admin_notices', false),
+			'ee_pers_admin_notices',
+			$return_url
+		);
+		if ($persistent_admin_notices) {
+			// load scripts
+			wp_register_script(
+				'espresso_core',
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+				array('jquery'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_register_script(
+				'ee_error_js',
+				EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+				array('espresso_core'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('ee_error_js');
+			// and display notices
+			foreach ($persistent_admin_notices as $pan_name => $pan_message) {
+				$notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url);
+			}
+		}
+		return $notices;
+	}
+
+
+
+	/**
+	 * _print_scripts
+	 *
+	 * @param    bool $force_print
+	 * @return    string
+	 */
+	private static function _print_scripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -1074,143 +1074,143 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    enqueue_error_scripts
-     *
-     * @return        void
-     */
-    public static function enqueue_error_scripts()
-    {
-        self::_print_scripts();
-    }
-
-
-
-    /**
-     *    create error code from filepath, function name,
-     *    and line number where exception or error was thrown
-     *
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    public static function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file = explode('.', basename($file));
-        $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
-
-
-
-    /**
-     *    write exception details to log file
-     *
-     * @param int   $time
-     * @param array $ex
-     * @param bool  $clear
-     * @return void
-     */
-    public function write_to_error_log($time = 0, $ex = array(), $clear = false)
-    {
-        if (empty($ex)) {
-            return;
-        }
-        if (! $time) {
-            $time = time();
-        }
-        $exception_log = '----------------------------------------------------------------------------------------'
-                         . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
-        $exception_log .= '----------------------------------------------------------------------------------------'
-                          . PHP_EOL;
-        try {
-            EEH_File::ensure_file_exists_and_is_writable(
-                EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
-            );
-            EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
-            if (! $clear) {
-                //get existing log file and append new log info
-                $exception_log = EEH_File::get_file_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
-                ) . $exception_log;
-            }
-            EEH_File::write_to_file(
-                EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file,
-                $exception_log
-            );
-        } catch (EE_Error $e) {
-            EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s',
-                'event_espresso'), $e->getMessage()));
-            return;
-        }
-    }
-
-
-
-    /**
-     * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
-     * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
-     * but the code execution is done in a manner that could lead to unexpected results
-     * (i.e. running to early, or too late in WP or EE loading process).
-     * A good test for knowing whether to use this method is:
-     * 1. Is there going to be a PHP error if something isn't setup/used correctly?
-     * Yes -> use EE_Error::add_error() or throw new EE_Error()
-     * 2. If this is loaded before something else, it won't break anything,
-     * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
-     *
-     * @uses   constant WP_DEBUG test if wp_debug is on or not
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     */
-    public static function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
-        }
-    }
-
-
-
-    /**
-     * Like get_notices, but returns an array of all the notices of the given type.
-     *
-     * @return array {
-     * @type array $success   all the success messages
-     * @type array $errors    all the error messages
-     * @type array $attention all the attention messages
-     * }
-     */
-    public static function get_raw_notices()
-    {
-        return self::$_espresso_notices;
-    }
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    enqueue_error_scripts
+	 *
+	 * @return        void
+	 */
+	public static function enqueue_error_scripts()
+	{
+		self::_print_scripts();
+	}
+
+
+
+	/**
+	 *    create error code from filepath, function name,
+	 *    and line number where exception or error was thrown
+	 *
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	public static function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file = explode('.', basename($file));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
+
+
+
+	/**
+	 *    write exception details to log file
+	 *
+	 * @param int   $time
+	 * @param array $ex
+	 * @param bool  $clear
+	 * @return void
+	 */
+	public function write_to_error_log($time = 0, $ex = array(), $clear = false)
+	{
+		if (empty($ex)) {
+			return;
+		}
+		if (! $time) {
+			$time = time();
+		}
+		$exception_log = '----------------------------------------------------------------------------------------'
+						 . PHP_EOL;
+		$exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
+		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
+		$exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
+		$exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
+		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
+		$exception_log .= 'Stack trace: ' . PHP_EOL;
+		$exception_log .= $ex['string'] . PHP_EOL;
+		$exception_log .= '----------------------------------------------------------------------------------------'
+						  . PHP_EOL;
+		try {
+			EEH_File::ensure_file_exists_and_is_writable(
+				EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
+			);
+			EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
+			if (! $clear) {
+				//get existing log file and append new log info
+				$exception_log = EEH_File::get_file_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
+				) . $exception_log;
+			}
+			EEH_File::write_to_file(
+				EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file,
+				$exception_log
+			);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s',
+				'event_espresso'), $e->getMessage()));
+			return;
+		}
+	}
+
+
+
+	/**
+	 * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
+	 * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
+	 * but the code execution is done in a manner that could lead to unexpected results
+	 * (i.e. running to early, or too late in WP or EE loading process).
+	 * A good test for knowing whether to use this method is:
+	 * 1. Is there going to be a PHP error if something isn't setup/used correctly?
+	 * Yes -> use EE_Error::add_error() or throw new EE_Error()
+	 * 2. If this is loaded before something else, it won't break anything,
+	 * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
+	 *
+	 * @uses   constant WP_DEBUG test if wp_debug is on or not
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 */
+	public static function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
+		}
+	}
+
+
+
+	/**
+	 * Like get_notices, but returns an array of all the notices of the given type.
+	 *
+	 * @return array {
+	 * @type array $success   all the success messages
+	 * @type array $errors    all the error messages
+	 * @type array $attention all the attention messages
+	 * }
+	 */
+	public static function get_raw_notices()
+	{
+		return self::$_espresso_notices;
+	}
 
 
 
@@ -1226,27 +1226,27 @@ 
  */
 function espresso_error_enqueue_scripts()
 {
-    // js for error handling
-    wp_register_script(
-        'espresso_core',
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-        array('jquery'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
-    wp_register_script(
-        'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-        array('espresso_core'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
+	// js for error handling
+	wp_register_script(
+		'espresso_core',
+		EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+		array('jquery'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
+	wp_register_script(
+		'ee_error_js',
+		EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+		array('espresso_core'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
 }
 
 if (is_admin()) {
-    add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 } else {
-    add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 }
 
 

modules/single_page_checkout/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Doc Comments +1 added lines

@@ -569,6 +569,7 @@
      * @param EE_Registration $registration
      * @param EE_Question     $question
      * @param                 mixed EE_Answer|NULL      $answer
+     * @param EE_Answer $answer
      * @return EE_Form_Input_Base
      * @throws \EE_Error
      */

Indentation +1335 added lines, -1335 removed lines

@@ -17,1343 +17,1343 @@
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step
 {
 
-    /**
-     * @type bool $_print_copy_info
-     */
-    private $_print_copy_info = false;
-
-    /**
-     * @type array $_attendee_data
-     */
-    private $_attendee_data = array();
-
-    /**
-     * @type array $_required_questions
-     */
-    private $_required_questions = array();
-
-    /**
-     * @type array $_registration_answers
-     */
-    private $_registration_answers = array();
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug     = 'attendee_information';
-        $this->_name     = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
-        $this->checkout  = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
-        );
-    }
-
-
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
-            ' is a required question.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
-            ' is a required question. Please enter a value for at least one of the options.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
-            'Please answer all required questions correctly before proceeding.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
-            esc_html__(
-                'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
-                'event_espresso'
-            ),
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
-            'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
-            'You must enter a valid email address.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
-            'You must enter a valid email address and answer all other required questions before you can proceed.',
-            'event_espresso'
-        );
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step()
-    {
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function generate_reg_form()
-    {
-        $this->_print_copy_info = false;
-        $primary_registrant     = null;
-        // autoload Line_Item_Display classes
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display = new EE_Line_Item_Display();
-        // calculate taxes
-        $Line_Item_Display->display_line_item(
-            $this->checkout->cart->get_grand_total(),
-            array('set_tax_rate' => true)
-        );
-        /** @var $subsections EE_Form_Section_Proper[] */
-        $subsections   = array(
-            'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-        );
-        $template_args = array(
-            'revisit'       => $this->checkout->revisit,
-            'registrations' => array(),
-            'ticket_count'  => array(),
-        );
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        if ($registrations) {
-            foreach ($registrations as $registration) {
-                // can this registration be processed during this visit ?
-                if ($registration instanceof EE_Registration
-                    && $this->checkout->visit_allows_processing_of_this_registration($registration)
-                ) {
-                    $subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
-                    if (! $this->checkout->admin_request) {
-                        $template_args['registrations'][$registration->reg_url_link()]    = $registration;
-                        $template_args['ticket_count'][$registration->ticket()->ID()]     = isset(
-                            $template_args['ticket_count'][$registration->ticket()->ID()]
-                        )
-                            ? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
-                            : 1;
-                        $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                            $this->checkout->cart->get_grand_total(),
-                            'Ticket',
-                            array($registration->ticket()->ID())
-                        );
-                        $ticket_line_item = is_array($ticket_line_item)
-                            ? reset($ticket_line_item)
-                            : $ticket_line_item;
-                        $template_args['ticket_line_item'][$registration->ticket()->ID()] =
-                            $Line_Item_Display->display_line_item($ticket_line_item);
-                    }
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $registration->reg_url_link();
-                    }
-                }
-            }
-            // print_copy_info ?
-            if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
-                // TODO: add admin option for toggling copy attendee info,
-                // then use that value to change $this->_print_copy_info
-                $copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
-                    ? $this->_copy_attendee_info_form()
-                    : $this->_auto_copy_attendee_info();
-                // generate hidden input
-                if (isset($subsections[$primary_registrant])
-                    && $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
-                ) {
-                    $subsections[$primary_registrant]->add_subsections(
-                        $copy_options,
-                        'primary_registrant',
-                        false
-                    );
-                }
-            }
-        }
-
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => $this->checkout->admin_request ?
-                    new EE_Div_Per_Section_Layout() :
-                    new EE_Template_Layout(
-                        array(
-                            'layout_template_file' => $this->_template, // layout_template
-                            'template_args'        => $template_args,
-                        )
-                    ),
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _registrations_reg_form(EE_Registration $registration)
-    {
-        static $attendee_nmbr = 1;
-        $form_args = array();
-        // verify that registration has valid event
-        if ($registration->event() instanceof EE_Event) {
-            $question_groups = $registration->event()->question_groups(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-                    array(
-                        array(
-                            'Event.EVT_ID'                     => $registration->event()->ID(),
-                            'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
-                        ),
-                        'order_by' => array('QSG_order' => 'ASC'),
-                    ),
-                    $registration,
-                    $this
-                )
-            );
-            if ($question_groups) {
-                // array of params to pass to parent constructor
-                $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => array(),
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        array(
-                            'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
-                            'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr),
-                        )
-                    ),
-                );
-                foreach ($question_groups as $question_group) {
-                    if ($question_group instanceof EE_Question_Group) {
-                        $form_args['subsections'][$question_group->identifier()] = $this->_question_group_reg_form(
-                            $registration,
-                            $question_group
-                        );
-                    }
-                }
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
-                    $registration
-                );
-                // if we have question groups for additional attendees, then display the copy options
-                $this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
-                        $registration
-                    );
-                }
-            }
-        }
-        $attendee_nmbr++;
-        return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * _additional_attendee_reg_info_input
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $additional_attendee_reg_info
-     * @return    EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _additional_attendee_reg_info_input(
-        EE_Registration $registration,
-        $additional_attendee_reg_info = true
-    ) {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            array(
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
-                'default' => $additional_attendee_reg_info,
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
-    {
-        // array of params to pass to parent constructor
-        $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
-            'html_class'      => $this->checkout->admin_request
-                ? 'form-table ee-reg-form-qstn-grp-dv'
-                : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-lbl',
-            'subsections'     => array(
-                'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
-            ),
-            'layout_strategy' => $this->checkout->admin_request
-                ? new EE_Admin_Two_Column_Layout()
-                : new EE_Div_Per_Section_Layout(),
-        );
-        // where params
-        $query_params = array('QST_deleted' => 0);
-        // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
-            $query_params['QST_admin_only'] = array('!=', true);
-        }
-        $questions = $question_group->get_many_related(
-            'Question',
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
-                array(
-                    $query_params,
-                    'order_by' => array(
-                        'Question_Group_Question.QGQ_order' => 'ASC',
-                    ),
-                ),
-                $question_group,
-                $registration,
-                $this
-            )
-        );
-        // filter for additional content before questions
-        $form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
-        // loop thru questions
-        foreach ($questions as $question) {
-            if ($question instanceof EE_Question) {
-                $identifier                            = $question->is_system_question()
-                    ? $question->system_ID()
-                    : $question->ID();
-                $form_args['subsections'][$identifier] = $this->reg_form_question($registration, $question);
-            }
-        }
-        $form_args['subsections'] = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
-            $form_args['subsections'],
-            $registration,
-            $question_group,
-            $this
-        );
-        // filter for additional content after questions
-        $form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
+	/**
+	 * @type bool $_print_copy_info
+	 */
+	private $_print_copy_info = false;
+
+	/**
+	 * @type array $_attendee_data
+	 */
+	private $_attendee_data = array();
+
+	/**
+	 * @type array $_required_questions
+	 */
+	private $_required_questions = array();
+
+	/**
+	 * @type array $_registration_answers
+	 */
+	private $_registration_answers = array();
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug     = 'attendee_information';
+		$this->_name     = esc_html__('Attendee Information', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+		$this->checkout  = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
+		);
+	}
+
+
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+			' is a required question.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+			' is a required question. Please enter a value for at least one of the options.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
+			'Please answer all required questions correctly before proceeding.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+			esc_html__(
+				'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
+				'event_espresso'
+			),
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+			'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+			'You must enter a valid email address.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
+			'You must enter a valid email address and answer all other required questions before you can proceed.',
+			'event_espresso'
+		);
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function generate_reg_form()
+	{
+		$this->_print_copy_info = false;
+		$primary_registrant     = null;
+		// autoload Line_Item_Display classes
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display = new EE_Line_Item_Display();
+		// calculate taxes
+		$Line_Item_Display->display_line_item(
+			$this->checkout->cart->get_grand_total(),
+			array('set_tax_rate' => true)
+		);
+		/** @var $subsections EE_Form_Section_Proper[] */
+		$subsections   = array(
+			'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+		);
+		$template_args = array(
+			'revisit'       => $this->checkout->revisit,
+			'registrations' => array(),
+			'ticket_count'  => array(),
+		);
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
+				// can this registration be processed during this visit ?
+				if ($registration instanceof EE_Registration
+					&& $this->checkout->visit_allows_processing_of_this_registration($registration)
+				) {
+					$subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
+					if (! $this->checkout->admin_request) {
+						$template_args['registrations'][$registration->reg_url_link()]    = $registration;
+						$template_args['ticket_count'][$registration->ticket()->ID()]     = isset(
+							$template_args['ticket_count'][$registration->ticket()->ID()]
+						)
+							? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
+							: 1;
+						$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+							$this->checkout->cart->get_grand_total(),
+							'Ticket',
+							array($registration->ticket()->ID())
+						);
+						$ticket_line_item = is_array($ticket_line_item)
+							? reset($ticket_line_item)
+							: $ticket_line_item;
+						$template_args['ticket_line_item'][$registration->ticket()->ID()] =
+							$Line_Item_Display->display_line_item($ticket_line_item);
+					}
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $registration->reg_url_link();
+					}
+				}
+			}
+			// print_copy_info ?
+			if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
+				// TODO: add admin option for toggling copy attendee info,
+				// then use that value to change $this->_print_copy_info
+				$copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
+					? $this->_copy_attendee_info_form()
+					: $this->_auto_copy_attendee_info();
+				// generate hidden input
+				if (isset($subsections[$primary_registrant])
+					&& $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
+				) {
+					$subsections[$primary_registrant]->add_subsections(
+						$copy_options,
+						'primary_registrant',
+						false
+					);
+				}
+			}
+		}
+
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => $this->checkout->admin_request ?
+					new EE_Div_Per_Section_Layout() :
+					new EE_Template_Layout(
+						array(
+							'layout_template_file' => $this->_template, // layout_template
+							'template_args'        => $template_args,
+						)
+					),
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _registrations_reg_form(EE_Registration $registration)
+	{
+		static $attendee_nmbr = 1;
+		$form_args = array();
+		// verify that registration has valid event
+		if ($registration->event() instanceof EE_Event) {
+			$question_groups = $registration->event()->question_groups(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+					array(
+						array(
+							'Event.EVT_ID'                     => $registration->event()->ID(),
+							'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
+						),
+						'order_by' => array('QSG_order' => 'ASC'),
+					),
+					$registration,
+					$this
+				)
+			);
+			if ($question_groups) {
+				// array of params to pass to parent constructor
+				$form_args = array(
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => array(),
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						array(
+							'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
+							'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr),
+						)
+					),
+				);
+				foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$form_args['subsections'][$question_group->identifier()] = $this->_question_group_reg_form(
+							$registration,
+							$question_group
+						);
+					}
+				}
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
+					$registration
+				);
+				// if we have question groups for additional attendees, then display the copy options
+				$this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
+						$registration
+					);
+				}
+			}
+		}
+		$attendee_nmbr++;
+		return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * _additional_attendee_reg_info_input
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $additional_attendee_reg_info
+	 * @return    EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _additional_attendee_reg_info_input(
+		EE_Registration $registration,
+		$additional_attendee_reg_info = true
+	) {
+		// generate hidden input
+		return new EE_Hidden_Input(
+			array(
+				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'default' => $additional_attendee_reg_info,
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
+	{
+		// array of params to pass to parent constructor
+		$form_args = array(
+			'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
+			'html_class'      => $this->checkout->admin_request
+				? 'form-table ee-reg-form-qstn-grp-dv'
+				: 'ee-reg-form-qstn-grp-dv',
+			'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-lbl',
+			'subsections'     => array(
+				'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
+			),
+			'layout_strategy' => $this->checkout->admin_request
+				? new EE_Admin_Two_Column_Layout()
+				: new EE_Div_Per_Section_Layout(),
+		);
+		// where params
+		$query_params = array('QST_deleted' => 0);
+		// don't load admin only questions on the frontend
+		if (! $this->checkout->admin_request) {
+			$query_params['QST_admin_only'] = array('!=', true);
+		}
+		$questions = $question_group->get_many_related(
+			'Question',
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
+				array(
+					$query_params,
+					'order_by' => array(
+						'Question_Group_Question.QGQ_order' => 'ASC',
+					),
+				),
+				$question_group,
+				$registration,
+				$this
+			)
+		);
+		// filter for additional content before questions
+		$form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
+		// loop thru questions
+		foreach ($questions as $question) {
+			if ($question instanceof EE_Question) {
+				$identifier                            = $question->is_system_question()
+					? $question->system_ID()
+					: $question->ID();
+				$form_args['subsections'][$identifier] = $this->reg_form_question($registration, $question);
+			}
+		}
+		$form_args['subsections'] = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
+			$form_args['subsections'],
+			$registration,
+			$question_group,
+			$this
+		);
+		// filter for additional content after questions
+		$form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
 //		d( $form_args );
-        $question_group_reg_form = new EE_Form_Section_Proper($form_args);
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            $question_group_reg_form,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @access public
-     * @param EE_Question_Group $question_group
-     * @return    EE_Form_Section_HTML
-     */
-    private function _question_group_header(EE_Question_Group $question_group)
-    {
-        $html = '';
-        // group_name
-        if ($question_group->show_group_name() && $question_group->name() !== '') {
-            if ($this->checkout->admin_request) {
-                $html .= EEH_HTML::br();
-                $html .= EEH_HTML::h3(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title title',
-                    'font-size: 1.3em; padding-left:0;'
-                );
-            } else {
-                $html .= EEH_HTML::h4(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title section-title'
-                );
-            }
-        }
-        // group_desc
-        if ($question_group->show_group_desc() && $question_group->desc() !== '') {
-            $html .= EEH_HTML::p(
-                $question_group->desc(),
-                '',
-                $this->checkout->admin_request
-                    ? 'ee-reg-form-qstn-grp-desc-pg'
-                    : 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
-            );
-        }
-        return new EE_Form_Section_HTML($html);
-    }
-
-
-    /**
-     * @access public
-     * @return    EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _copy_attendee_info_form()
-    {
-        // array of params to pass to parent constructor
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections'     => $this->_copy_attendee_info_inputs(),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file'     => SPCO_REG_STEPS_PATH
-                                                      . $this->_slug
-                                                      . DS
-                                                      . 'copy_attendee_info.template.php',
-                        'begin_template_file'      => null,
-                        'input_template_file'      => null,
-                        'subsection_template_file' => null,
-                        'end_template_file'        => null,
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _auto_copy_attendee_info
-     *
-     * @access public
-     * @return EE_Form_Section_HTML
-     */
-    private function _auto_copy_attendee_info()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-                    array()
-                ),
-                true,
-                true
-            )
-        );
-    }
-
-
-    /**
-     * _copy_attendee_info_inputs
-     *
-     * @access public
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _copy_attendee_info_inputs()
-    {
-        $copy_attendee_info_inputs = array();
-        $prev_ticket               = null;
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        foreach ($registrations as $registration) {
-            // for all  attendees other than the primary attendee
-            if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
-                // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-                if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name = $registration->ticket()->name();
-                    $item_name .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
-                        : '';
-                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']'] =
-                        new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
-                        );
-                    $prev_ticket = $registration->ticket()->ID();
-                }
-
-                $copy_attendee_info_inputs['spco_copy_attendee_chk[' . $registration->ID() . ']'] =
-                    new EE_Checkbox_Multi_Input(
-                        array(
-                            $registration->ID() => sprintf(
-                                esc_html__('Attendee #%s', 'event_espresso'),
-                                $registration->count()
-                            ),
-                        ),
-                        array(
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
-                            'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
-                            'display_html_label_text' => false,
-                        )
-                    );
-            }
-        }
-        return $copy_attendee_info_inputs;
-    }
-
-
-    /**
-     * _additional_primary_registrant_inputs
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @return    EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _additional_primary_registrant_inputs(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            array(
-                'html_id' => 'primary_registrant',
-                'default' => $registration->reg_url_link(),
-            )
-        );
-    }
-
-
-    /**
-     * @access public
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function reg_form_question(EE_Registration $registration, EE_Question $question)
-    {
-
-        // if this question was for an attendee detail, then check for that answer
-        $answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
-            $registration,
-            $question->system_ID()
-        );
-        $answer       = $answer_value === null
-            ? EEM_Answer::instance()->get_one(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            )
-            : null;
-        // if NOT returning to edit an existing registration
-        // OR if this question is for an attendee property
-        // OR we still don't have an EE_Answer object
-        if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
-            // create an EE_Answer object for storing everything in
-            $answer = EE_Answer::new_instance(array(
-                'QST_ID' => $question->ID(),
-                'REG_ID' => $registration->ID(),
-            ));
-        }
-        // verify instance
-        if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
-                $answer->set('ANS_value', $answer_value);
-            }
-            $answer->cache('Question', $question);
-            //remember system ID had a bug where sometimes it could be null
-            $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
-            $registration->cache('Answer', $answer, $answer_cache_id);
-        }
-        return $this->_generate_question_input($registration, $question, $answer);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param                 mixed EE_Answer|NULL      $answer
-     * @return EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
-    {
-        $identifier                             = $question->is_system_question()
-            ? $question->system_ID()
-            : $question->ID();
-        $this->_required_questions[$identifier] = $question->required() ? true : false;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input'),
-            10,
-            4
-        );
-        $input_constructor_args                  = array(
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_label_class' => 'ee-reg-qstn',
-        );
-        $input_constructor_args['html_label_id'] .= '-lbl';
-        if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id']       .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
-        }
-        $form_input = $question->generate_form_input(
-            $registration,
-            $answer,
-            $input_constructor_args
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input')
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input')
-        );
-        return $form_input;
-    }
-
-
-    /**
-     * Gets the list of countries for the form input
-     *
-     * @param array|null       $countries_list
-     * @param \EE_Question     $question
-     * @param \EE_Registration $registration
-     * @param \EE_Answer       $answer
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function use_cached_countries_for_form_input(
-        $countries_list,
-        \EE_Question $question = null,
-        \EE_Registration $registration = null,
-        \EE_Answer $answer = null
-    ) {
-        $country_options = array('' => '');
-        // get possibly cached list of countries
-        $countries = $this->checkout->action === 'process_reg_step'
-            ? EEM_Country::instance()->get_all_countries()
-            : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $country_options[$country->ID()] = $country->name();
-                }
-            }
-        }
-        if ($question instanceof EE_Question
-            && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_one(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        $country_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $country_options;
-    }
-
-
-    /**
-     * Gets the list of states for the form input
-     *
-     * @param array|null       $states_list
-     * @param \EE_Question     $question
-     * @param \EE_Registration $registration
-     * @param \EE_Answer       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function use_cached_states_for_form_input(
-        $states_list,
-        \EE_Question $question = null,
-        \EE_Registration $registration = null,
-        \EE_Answer $answer = null
-    ) {
-        $state_options = array('' => array('' => ''));
-        $states        = $this->checkout->action === 'process_reg_step'
-            ? EEM_State::instance()->get_all_states()
-            : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[$state->country()->name()][$state->ID()] = $state->name();
-                }
-            }
-        }
-        $state_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $state_options;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function process_reg_step()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // grab validated data from form
-        $valid_data = $this->checkout->current_step->valid_data();
-        // EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
-        // if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-        if (empty($valid_data)) {
-            EE_Error::add_error(
-                esc_html__('No valid question responses were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid transaction could not be initiated for processing your registrations.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // get cached registrations
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        // verify we got the goods
-        if (empty($registrations)) {
-            //combine the old translated string with a new one, in order to not break translations
-            $error_message = esc_html__( 'Your form data could not be applied to any valid registrations.', 'event_espresso' )
-                             . sprintf(
-                                 esc_html__('%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.', 'event_espresso'),
-                                 '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
-                                 '</a>',
-                                 '<br />'
-                             );
-            EE_Error::add_error(
-                $error_message,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // extract attendee info from form data and save to model objects
-        $registrations_processed = $this->_process_registrations($registrations, $valid_data);
-        // if first pass thru SPCO,
-        // then let's check processed registrations against the total number of tickets in the cart
-        if ($registrations_processed === false) {
-            // but return immediately if the previous step exited early due to errors
-            return false;
-        } elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
-            // generate a correctly translated string for all possible singular/plural combinations
-            if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } else {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of %1$d tickets in the Event Queue, but %2$ds registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            }
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // mark this reg step as completed
-        $this->set_completed();
-        $this->_set_success_message(
-            esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
-        );
-        //do action in case a plugin wants to do something with the data submitted in step 1.
-        //passes EE_Single_Page_Checkout, and it's posted data
-        do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
-        return true;
-    }
-
-
-    /**
-     *    _process_registrations
-     *
-     * @param EE_Registration[] $registrations
-     * @param array             $valid_data
-     * @return bool|int
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_registrations($registrations = array(), $valid_data = array())
-    {
-        // load resources and set some defaults
-        EE_Registry::instance()->load_model('Attendee');
-        // holder for primary registrant attendee object
-        $this->checkout->primary_attendee_obj = null;
-        // array for tracking reg form data for the primary registrant
-        $primary_registrant = array(
-            'line_item_id' => null,
-        );
-        $copy_primary       = false;
-        // reg form sections that do not contain inputs
-        $non_input_form_sections = array(
-            'primary_registrant',
-            'additional_attendee_reg_info',
-            'spco_copy_attendee_chk',
-        );
-        // attendee counter
-        $att_nmbr = 0;
-        // grab the saved registrations from the transaction
-        foreach ($registrations as $registration) {
-            // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to process your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            /** @var string $reg_url_link */
-            $reg_url_link = $registration->reg_url_link();
-            // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
-                // should this registration be processed during this visit ?
-                if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
-                    // if NOT revisiting, then let's save the registration now,
-                    // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
-                        $registration->save();
-                    }
-                    /**
-                     * This allows plugins to trigger a fail on processing of a
-                     * registration for any conditions they may have for it to pass.
-                     *
-                     * @var bool   if true is returned by the plugin then the
-                     *            registration processing is halted.
-                     */
-                    if (apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
-                        false,
-                        $att_nmbr,
-                        $registration,
-                        $registrations,
-                        $valid_data,
-                        $this
-                    )) {
-                        return false;
-                    }
-
-                    // Houston, we have a registration!
-                    $att_nmbr++;
-                    $this->_attendee_data[$reg_url_link] = array();
-                    // grab any existing related answer objects
-                    $this->_registration_answers = $registration->answers();
-                    // unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-                    if (isset($valid_data[$reg_url_link])) {
-                        // do we need to copy basic info from primary attendee ?
-                        $copy_primary = isset($valid_data[$reg_url_link]['additional_attendee_reg_info'])
-                                        && absint($valid_data[$reg_url_link]['additional_attendee_reg_info']) === 0
-                            ? true
-                            : false;
-                        // filter form input data for this registration
-                        $valid_data[$reg_url_link] = (array)apply_filters(
-                            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-                            $valid_data[$reg_url_link]
-                        );
-                        if (isset($valid_data['primary_attendee'])) {
-                            $primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
-                                ? $valid_data['primary_attendee']
-                                : false;
-                            unset($valid_data['primary_attendee']);
-                        }
-                        // now loop through our array of valid post data && process attendee reg forms
-                        foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections)) {
-                                foreach ($form_inputs as $form_input => $input_value) {
-                                    // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
-                                    // check for critical inputs
-                                    if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
-                                        $form_input,
-                                        $input_value
-                                    )
-                                    ) {
-                                        return false;
-                                    }
-                                    // store a bit of data about the primary attendee
-                                    if ($att_nmbr === 1
-                                        && ! empty($input_value)
-                                        && $reg_url_link === $primary_registrant['line_item_id']
-                                    ) {
-                                        $primary_registrant[$form_input] = $input_value;
-                                    } elseif ($copy_primary
-                                        && $input_value === null
-                                        && isset($primary_registrant[$form_input])
-                                    ) {
-                                        $input_value = $primary_registrant[$form_input];
-                                    }
-                                    // now attempt to save the input data
-                                    if (! $this->_save_registration_form_input(
-                                        $registration,
-                                        $form_input,
-                                        $input_value
-                                    )
-                                    ) {
-                                        EE_Error::add_error(
-                                            sprintf(
-                                                esc_html__(
-                                                    'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
-                                                    'event_espresso'
-                                                ),
-                                                $form_input,
-                                                $input_value
-                                            ),
-                                            __FILE__,
-                                            __FUNCTION__,
-                                            __LINE__
-                                        );
-                                        return false;
-                                    }
-                                }
-                            }
-                        }  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
-                    }
-                    //EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
-                    // this registration does not require additional attendee information ?
-                    if ($copy_primary
-                        && $att_nmbr > 1
-                        && $this->checkout->primary_attendee_obj instanceof EE_Attendee
-                    ) {
-                        // just copy the primary registrant
-                        $attendee = $this->checkout->primary_attendee_obj;
-                    } else {
-                        // ensure critical details are set for additional attendees
-                        $this->_attendee_data[$reg_url_link] = $att_nmbr > 1
-                            ? $this->_copy_critical_attendee_details_from_primary_registrant(
-                                $this->_attendee_data[$reg_url_link]
-                            )
-                            : $this->_attendee_data[$reg_url_link];
-                        // execute create attendee command (which may return an existing attendee)
-                        $attendee = EE_Registry::instance()->BUS->execute(
-                            new CreateAttendeeCommand(
-                                $this->_attendee_data[$reg_url_link],
-                                $registration
-                            )
-                        );
-                        // who's #1 ?
-                        if ($att_nmbr === 1) {
-                            $this->checkout->primary_attendee_obj = $attendee;
-                        }
-                    }
-                    // EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
-                    // add relation to registration, set attendee ID, and cache attendee
-                    $this->_associate_attendee_with_registration($registration, $attendee);
-                    // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'Registration %s has an invalid or missing Attendee object.',
-                                    'event_espresso'
-                                ),
-                                $reg_url_link
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                    /** @type EE_Registration_Processor $registration_processor */
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-                    // at this point, we should have enough details about the registrant to consider the registration
-                    // NOT incomplete
-                    $registration_processor->toggle_incomplete_registration_status_to_default(
-                        $registration,
-                        false,
-                        new Context(
-                            'spco_reg_step_attendee_information_process_registrations',
-                            esc_html__(
-                                'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
-                    // abandoned
-                    $this->checkout->transaction->toggle_failed_transaction_status();
-                    // if we've gotten this far, then let's save what we have
-                    $registration->save();
-                    // add relation between TXN and registration
-                    $this->_associate_registration_with_transaction($registration);
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid or missing line item ID was encountered while attempting to process the registration form.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                // remove malformed data
-                unset($valid_data[$reg_url_link]);
-                return false;
-            }
-
-        } // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
-        return $att_nmbr;
-    }
-
-
-    /**
-     *    _save_registration_form_input
-     *
-     * @param EE_Registration $registration
-     * @param string          $form_input
-     * @param string          $input_value
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _save_registration_form_input(
-        EE_Registration $registration,
-        $form_input = '',
-        $input_value = ''
-    ) {
-        // \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
-        // \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
-        // \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
-        // allow for plugins to hook in and do their own processing of the form input.
-        // For plugins to bypass normal processing here, they just need to return a boolean value.
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
-            false,
-            $registration,
-            $form_input,
-            $input_value,
-            $this
-        )) {
-            return true;
-        }
-        /*
+		$question_group_reg_form = new EE_Form_Section_Proper($form_args);
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			$question_group_reg_form,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @param EE_Question_Group $question_group
+	 * @return    EE_Form_Section_HTML
+	 */
+	private function _question_group_header(EE_Question_Group $question_group)
+	{
+		$html = '';
+		// group_name
+		if ($question_group->show_group_name() && $question_group->name() !== '') {
+			if ($this->checkout->admin_request) {
+				$html .= EEH_HTML::br();
+				$html .= EEH_HTML::h3(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title title',
+					'font-size: 1.3em; padding-left:0;'
+				);
+			} else {
+				$html .= EEH_HTML::h4(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title section-title'
+				);
+			}
+		}
+		// group_desc
+		if ($question_group->show_group_desc() && $question_group->desc() !== '') {
+			$html .= EEH_HTML::p(
+				$question_group->desc(),
+				'',
+				$this->checkout->admin_request
+					? 'ee-reg-form-qstn-grp-desc-pg'
+					: 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
+			);
+		}
+		return new EE_Form_Section_HTML($html);
+	}
+
+
+	/**
+	 * @access public
+	 * @return    EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _copy_attendee_info_form()
+	{
+		// array of params to pass to parent constructor
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections'     => $this->_copy_attendee_info_inputs(),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file'     => SPCO_REG_STEPS_PATH
+													  . $this->_slug
+													  . DS
+													  . 'copy_attendee_info.template.php',
+						'begin_template_file'      => null,
+						'input_template_file'      => null,
+						'subsection_template_file' => null,
+						'end_template_file'        => null,
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _auto_copy_attendee_info
+	 *
+	 * @access public
+	 * @return EE_Form_Section_HTML
+	 */
+	private function _auto_copy_attendee_info()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+					array()
+				),
+				true,
+				true
+			)
+		);
+	}
+
+
+	/**
+	 * _copy_attendee_info_inputs
+	 *
+	 * @access public
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+		$copy_attendee_info_inputs = array();
+		$prev_ticket               = null;
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		foreach ($registrations as $registration) {
+			// for all  attendees other than the primary attendee
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
+				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
+				if ($registration->ticket()->ID() !== $prev_ticket) {
+					$item_name = $registration->ticket()->name();
+					$item_name .= $registration->ticket()->description() !== ''
+						? ' - ' . $registration->ticket()->description()
+						: '';
+					$copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']'] =
+						new EE_Form_Section_HTML(
+							'<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+						);
+					$prev_ticket = $registration->ticket()->ID();
+				}
+
+				$copy_attendee_info_inputs['spco_copy_attendee_chk[' . $registration->ID() . ']'] =
+					new EE_Checkbox_Multi_Input(
+						array(
+							$registration->ID() => sprintf(
+								esc_html__('Attendee #%s', 'event_espresso'),
+								$registration->count()
+							),
+						),
+						array(
+							'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+							'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
+							'display_html_label_text' => false,
+						)
+					);
+			}
+		}
+		return $copy_attendee_info_inputs;
+	}
+
+
+	/**
+	 * _additional_primary_registrant_inputs
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @return    EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _additional_primary_registrant_inputs(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			array(
+				'html_id' => 'primary_registrant',
+				'default' => $registration->reg_url_link(),
+			)
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function reg_form_question(EE_Registration $registration, EE_Question $question)
+	{
+
+		// if this question was for an attendee detail, then check for that answer
+		$answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
+			$registration,
+			$question->system_ID()
+		);
+		$answer       = $answer_value === null
+			? EEM_Answer::instance()->get_one(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			)
+			: null;
+		// if NOT returning to edit an existing registration
+		// OR if this question is for an attendee property
+		// OR we still don't have an EE_Answer object
+		if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
+			// create an EE_Answer object for storing everything in
+			$answer = EE_Answer::new_instance(array(
+				'QST_ID' => $question->ID(),
+				'REG_ID' => $registration->ID(),
+			));
+		}
+		// verify instance
+		if ($answer instanceof EE_Answer) {
+			if (! empty($answer_value)) {
+				$answer->set('ANS_value', $answer_value);
+			}
+			$answer->cache('Question', $question);
+			//remember system ID had a bug where sometimes it could be null
+			$answer_cache_id = $question->is_system_question()
+				? $question->system_ID() . '-' . $registration->reg_url_link()
+				: $question->ID() . '-' . $registration->reg_url_link();
+			$registration->cache('Answer', $answer, $answer_cache_id);
+		}
+		return $this->_generate_question_input($registration, $question, $answer);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param                 mixed EE_Answer|NULL      $answer
+	 * @return EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
+	{
+		$identifier                             = $question->is_system_question()
+			? $question->system_ID()
+			: $question->ID();
+		$this->_required_questions[$identifier] = $question->required() ? true : false;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input'),
+			10,
+			4
+		);
+		$input_constructor_args                  = array(
+			'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
+			'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
+			'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_label_class' => 'ee-reg-qstn',
+		);
+		$input_constructor_args['html_label_id'] .= '-lbl';
+		if ($answer instanceof EE_Answer && $answer->ID()) {
+			$input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
+			$input_constructor_args['html_id']       .= '-' . $answer->ID();
+			$input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+		}
+		$form_input = $question->generate_form_input(
+			$registration,
+			$answer,
+			$input_constructor_args
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input')
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input')
+		);
+		return $form_input;
+	}
+
+
+	/**
+	 * Gets the list of countries for the form input
+	 *
+	 * @param array|null       $countries_list
+	 * @param \EE_Question     $question
+	 * @param \EE_Registration $registration
+	 * @param \EE_Answer       $answer
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function use_cached_countries_for_form_input(
+		$countries_list,
+		\EE_Question $question = null,
+		\EE_Registration $registration = null,
+		\EE_Answer $answer = null
+	) {
+		$country_options = array('' => '');
+		// get possibly cached list of countries
+		$countries = $this->checkout->action === 'process_reg_step'
+			? EEM_Country::instance()->get_all_countries()
+			: EEM_Country::instance()->get_all_active_countries();
+		if (! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[$country->ID()] = $country->name();
+				}
+			}
+		}
+		if ($question instanceof EE_Question
+			&& $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_one(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		$country_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $country_options;
+	}
+
+
+	/**
+	 * Gets the list of states for the form input
+	 *
+	 * @param array|null       $states_list
+	 * @param \EE_Question     $question
+	 * @param \EE_Registration $registration
+	 * @param \EE_Answer       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function use_cached_states_for_form_input(
+		$states_list,
+		\EE_Question $question = null,
+		\EE_Registration $registration = null,
+		\EE_Answer $answer = null
+	) {
+		$state_options = array('' => array('' => ''));
+		$states        = $this->checkout->action === 'process_reg_step'
+			? EEM_State::instance()->get_all_states()
+			: EEM_State::instance()->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[$state->country()->name()][$state->ID()] = $state->name();
+				}
+			}
+		}
+		$state_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $state_options;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function process_reg_step()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// grab validated data from form
+		$valid_data = $this->checkout->current_step->valid_data();
+		// EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
+		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
+		if (empty($valid_data)) {
+			EE_Error::add_error(
+				esc_html__('No valid question responses were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid transaction could not be initiated for processing your registrations.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// get cached registrations
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		// verify we got the goods
+		if (empty($registrations)) {
+			//combine the old translated string with a new one, in order to not break translations
+			$error_message = esc_html__( 'Your form data could not be applied to any valid registrations.', 'event_espresso' )
+							 . sprintf(
+								 esc_html__('%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.', 'event_espresso'),
+								 '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
+								 '</a>',
+								 '<br />'
+							 );
+			EE_Error::add_error(
+				$error_message,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// extract attendee info from form data and save to model objects
+		$registrations_processed = $this->_process_registrations($registrations, $valid_data);
+		// if first pass thru SPCO,
+		// then let's check processed registrations against the total number of tickets in the cart
+		if ($registrations_processed === false) {
+			// but return immediately if the previous step exited early due to errors
+			return false;
+		} elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+			// generate a correctly translated string for all possible singular/plural combinations
+			if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} else {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of %1$d tickets in the Event Queue, but %2$ds registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			}
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// mark this reg step as completed
+		$this->set_completed();
+		$this->_set_success_message(
+			esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
+		);
+		//do action in case a plugin wants to do something with the data submitted in step 1.
+		//passes EE_Single_Page_Checkout, and it's posted data
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
+		return true;
+	}
+
+
+	/**
+	 *    _process_registrations
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param array             $valid_data
+	 * @return bool|int
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_registrations($registrations = array(), $valid_data = array())
+	{
+		// load resources and set some defaults
+		EE_Registry::instance()->load_model('Attendee');
+		// holder for primary registrant attendee object
+		$this->checkout->primary_attendee_obj = null;
+		// array for tracking reg form data for the primary registrant
+		$primary_registrant = array(
+			'line_item_id' => null,
+		);
+		$copy_primary       = false;
+		// reg form sections that do not contain inputs
+		$non_input_form_sections = array(
+			'primary_registrant',
+			'additional_attendee_reg_info',
+			'spco_copy_attendee_chk',
+		);
+		// attendee counter
+		$att_nmbr = 0;
+		// grab the saved registrations from the transaction
+		foreach ($registrations as $registration) {
+			// verify EE_Registration object
+			if (! $registration instanceof EE_Registration) {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to process your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			/** @var string $reg_url_link */
+			$reg_url_link = $registration->reg_url_link();
+			// reg_url_link exists ?
+			if (! empty($reg_url_link)) {
+				// should this registration be processed during this visit ?
+				if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
+					// if NOT revisiting, then let's save the registration now,
+					// so that we have a REG_ID to use when generating other objects
+					if (! $this->checkout->revisit) {
+						$registration->save();
+					}
+					/**
+					 * This allows plugins to trigger a fail on processing of a
+					 * registration for any conditions they may have for it to pass.
+					 *
+					 * @var bool   if true is returned by the plugin then the
+					 *            registration processing is halted.
+					 */
+					if (apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
+						false,
+						$att_nmbr,
+						$registration,
+						$registrations,
+						$valid_data,
+						$this
+					)) {
+						return false;
+					}
+
+					// Houston, we have a registration!
+					$att_nmbr++;
+					$this->_attendee_data[$reg_url_link] = array();
+					// grab any existing related answer objects
+					$this->_registration_answers = $registration->answers();
+					// unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
+					if (isset($valid_data[$reg_url_link])) {
+						// do we need to copy basic info from primary attendee ?
+						$copy_primary = isset($valid_data[$reg_url_link]['additional_attendee_reg_info'])
+										&& absint($valid_data[$reg_url_link]['additional_attendee_reg_info']) === 0
+							? true
+							: false;
+						// filter form input data for this registration
+						$valid_data[$reg_url_link] = (array)apply_filters(
+							'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+							$valid_data[$reg_url_link]
+						);
+						if (isset($valid_data['primary_attendee'])) {
+							$primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
+								? $valid_data['primary_attendee']
+								: false;
+							unset($valid_data['primary_attendee']);
+						}
+						// now loop through our array of valid post data && process attendee reg forms
+						foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
+							if (! in_array($form_section, $non_input_form_sections)) {
+								foreach ($form_inputs as $form_input => $input_value) {
+									// \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
+									// check for critical inputs
+									if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+										$form_input,
+										$input_value
+									)
+									) {
+										return false;
+									}
+									// store a bit of data about the primary attendee
+									if ($att_nmbr === 1
+										&& ! empty($input_value)
+										&& $reg_url_link === $primary_registrant['line_item_id']
+									) {
+										$primary_registrant[$form_input] = $input_value;
+									} elseif ($copy_primary
+										&& $input_value === null
+										&& isset($primary_registrant[$form_input])
+									) {
+										$input_value = $primary_registrant[$form_input];
+									}
+									// now attempt to save the input data
+									if (! $this->_save_registration_form_input(
+										$registration,
+										$form_input,
+										$input_value
+									)
+									) {
+										EE_Error::add_error(
+											sprintf(
+												esc_html__(
+													'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
+													'event_espresso'
+												),
+												$form_input,
+												$input_value
+											),
+											__FILE__,
+											__FUNCTION__,
+											__LINE__
+										);
+										return false;
+									}
+								}
+							}
+						}  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
+					}
+					//EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
+					// this registration does not require additional attendee information ?
+					if ($copy_primary
+						&& $att_nmbr > 1
+						&& $this->checkout->primary_attendee_obj instanceof EE_Attendee
+					) {
+						// just copy the primary registrant
+						$attendee = $this->checkout->primary_attendee_obj;
+					} else {
+						// ensure critical details are set for additional attendees
+						$this->_attendee_data[$reg_url_link] = $att_nmbr > 1
+							? $this->_copy_critical_attendee_details_from_primary_registrant(
+								$this->_attendee_data[$reg_url_link]
+							)
+							: $this->_attendee_data[$reg_url_link];
+						// execute create attendee command (which may return an existing attendee)
+						$attendee = EE_Registry::instance()->BUS->execute(
+							new CreateAttendeeCommand(
+								$this->_attendee_data[$reg_url_link],
+								$registration
+							)
+						);
+						// who's #1 ?
+						if ($att_nmbr === 1) {
+							$this->checkout->primary_attendee_obj = $attendee;
+						}
+					}
+					// EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
+					// add relation to registration, set attendee ID, and cache attendee
+					$this->_associate_attendee_with_registration($registration, $attendee);
+					// \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
+					if (! $registration->attendee() instanceof EE_Attendee) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'Registration %s has an invalid or missing Attendee object.',
+									'event_espresso'
+								),
+								$reg_url_link
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+					/** @type EE_Registration_Processor $registration_processor */
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+					// at this point, we should have enough details about the registrant to consider the registration
+					// NOT incomplete
+					$registration_processor->toggle_incomplete_registration_status_to_default(
+						$registration,
+						false,
+						new Context(
+							'spco_reg_step_attendee_information_process_registrations',
+							esc_html__(
+								'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
+								'event_espresso'
+							)
+						)
+					);
+					// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
+					// abandoned
+					$this->checkout->transaction->toggle_failed_transaction_status();
+					// if we've gotten this far, then let's save what we have
+					$registration->save();
+					// add relation between TXN and registration
+					$this->_associate_registration_with_transaction($registration);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid or missing line item ID was encountered while attempting to process the registration form.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				// remove malformed data
+				unset($valid_data[$reg_url_link]);
+				return false;
+			}
+
+		} // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
+		return $att_nmbr;
+	}
+
+
+	/**
+	 *    _save_registration_form_input
+	 *
+	 * @param EE_Registration $registration
+	 * @param string          $form_input
+	 * @param string          $input_value
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _save_registration_form_input(
+		EE_Registration $registration,
+		$form_input = '',
+		$input_value = ''
+	) {
+		// \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
+		// \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
+		// \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
+		// allow for plugins to hook in and do their own processing of the form input.
+		// For plugins to bypass normal processing here, they just need to return a boolean value.
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
+			false,
+			$registration,
+			$form_input,
+			$input_value,
+			$this
+		)) {
+			return true;
+		}
+		/*
          * $answer_cache_id is the key used to find the EE_Answer we want
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
-        $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
-            : $form_input;
-        $answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
-                           && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
-            ? true
-            : false;
-        //rename form_inputs if they are EE_Attendee properties
-        switch ((string) $form_input) {
-            case 'state':
-            case 'STA_ID':
-                $attendee_property = true;
-                $form_input        = 'STA_ID';
-                break;
-
-            case 'country':
-            case 'CNT_ISO':
-                $attendee_property = true;
-                $form_input        = 'CNT_ISO';
-                break;
-
-            default:
-                $ATT_input = 'ATT_' . $form_input;
-                //EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
-                $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
-        }
-        // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
-        // if this form input has a corresponding attendee property
-        if ($attendee_property) {
-            $this->_attendee_data[$registration->reg_url_link()][$form_input] = $input_value;
-            if ($answer_is_obj) {
-                // and delete the corresponding answer since we won't be storing this data in that object
-                $registration->_remove_relation_to($this->_registration_answers[$answer_cache_id], 'Answer');
-                $this->_registration_answers[$answer_cache_id]->delete_permanently();
-            }
-            return true;
-        } elseif ($answer_is_obj) {
-            // save this data to the answer object
-            $this->_registration_answers[$answer_cache_id]->set_value($input_value);
-            $result = $this->_registration_answers[$answer_cache_id]->save();
-            return $result !== false ? true : false;
-        } else {
-            foreach ($this->_registration_answers as $answer) {
-                if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
-                    $answer->set_value($input_value);
-                    $result = $answer->save();
-                    return $result !== false ? true : false;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    _verify_critical_attendee_details_are_set
-     *
-     * @param string $form_input
-     * @param string $input_value
-     * @return boolean
-     */
-    private function _verify_critical_attendee_details_are_set_and_validate_email(
-        $form_input = '',
-        $input_value = ''
-    ) {
-        if (empty($input_value)) {
-            // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
-                return true;
-            }
-            switch ($form_input) {
-                case 'fname':
-                    EE_Error::add_error(
-                        esc_html__('First Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'lname':
-                    EE_Error::add_error(
-                        esc_html__('Last Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'email':
-                    EE_Error::add_error(
-                        esc_html__('Please enter a valid email address.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     *    _associate_attendee_with_registration
-     *
-     * @param EE_Registration $registration
-     * @param EE_Attendee     $attendee
-     * @return void
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
-    {
-        // add relation to attendee
-        $registration->_add_relation_to($attendee, 'Attendee');
-        $registration->set_attendee_id($attendee->ID());
-        $registration->update_cache_after_object_save('Attendee', $attendee);
-    }
-
-
-    /**
-     *    _associate_registration_with_transaction
-     *
-     * @param EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _associate_registration_with_transaction(EE_Registration $registration)
-    {
-        // add relation to registration
-        $this->checkout->transaction->_add_relation_to($registration, 'Registration');
-        $this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
-    }
-
-
-    /**
-     *    _copy_critical_attendee_details_from_primary_registrant
-     *    ensures that all attendees at least have data for first name, last name, and email address
-     *
-     * @param array $attendee_data
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
-    {
-        // bare minimum critical details include first name, last name, email address
-        $critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
-        // add address info to critical details?
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-            false
-        )) {
-            $address_details           = array(
-                'ATT_address',
-                'ATT_address2',
-                'ATT_city',
-                'STA_ID',
-                'CNT_ISO',
-                'ATT_zip',
-                'ATT_phone',
-            );
-            $critical_attendee_details = array_merge($critical_attendee_details, $address_details);
-        }
-        foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (! isset($attendee_data[$critical_attendee_detail])
-                || empty($attendee_data[$critical_attendee_detail])
-            ) {
-                $attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(
-                    $critical_attendee_detail
-                );
-            }
-        }
-        return $attendee_data;
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to edit their attendee information
-     *    this gets called AFTER the process_reg_step() method above
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function update_reg_step()
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect     = true;
-            $this->checkout->redirect_url = add_query_arg(
-                array(
-                    'e_reg_url_link' => $this->checkout->reg_url_link,
-                    'revisit'        => true,
-                ),
-                $this->checkout->thank_you_page_url
-            );
-            $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-            return true;
-        }
-        return false;
-    }
+		$answer_cache_id = $this->checkout->reg_url_link
+			? $form_input . '-' . $registration->reg_url_link()
+			: $form_input;
+		$answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
+						   && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
+			? true
+			: false;
+		//rename form_inputs if they are EE_Attendee properties
+		switch ((string) $form_input) {
+			case 'state':
+			case 'STA_ID':
+				$attendee_property = true;
+				$form_input        = 'STA_ID';
+				break;
+
+			case 'country':
+			case 'CNT_ISO':
+				$attendee_property = true;
+				$form_input        = 'CNT_ISO';
+				break;
+
+			default:
+				$ATT_input = 'ATT_' . $form_input;
+				//EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
+				$attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
+				$form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
+		}
+		// EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
+		// if this form input has a corresponding attendee property
+		if ($attendee_property) {
+			$this->_attendee_data[$registration->reg_url_link()][$form_input] = $input_value;
+			if ($answer_is_obj) {
+				// and delete the corresponding answer since we won't be storing this data in that object
+				$registration->_remove_relation_to($this->_registration_answers[$answer_cache_id], 'Answer');
+				$this->_registration_answers[$answer_cache_id]->delete_permanently();
+			}
+			return true;
+		} elseif ($answer_is_obj) {
+			// save this data to the answer object
+			$this->_registration_answers[$answer_cache_id]->set_value($input_value);
+			$result = $this->_registration_answers[$answer_cache_id]->save();
+			return $result !== false ? true : false;
+		} else {
+			foreach ($this->_registration_answers as $answer) {
+				if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
+					$answer->set_value($input_value);
+					$result = $answer->save();
+					return $result !== false ? true : false;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    _verify_critical_attendee_details_are_set
+	 *
+	 * @param string $form_input
+	 * @param string $input_value
+	 * @return boolean
+	 */
+	private function _verify_critical_attendee_details_are_set_and_validate_email(
+		$form_input = '',
+		$input_value = ''
+	) {
+		if (empty($input_value)) {
+			// if the form input isn't marked as being required, then just return
+			if (! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
+				return true;
+			}
+			switch ($form_input) {
+				case 'fname':
+					EE_Error::add_error(
+						esc_html__('First Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'lname':
+					EE_Error::add_error(
+						esc_html__('Last Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'email':
+					EE_Error::add_error(
+						esc_html__('Please enter a valid email address.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 *    _associate_attendee_with_registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Attendee     $attendee
+	 * @return void
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
+	{
+		// add relation to attendee
+		$registration->_add_relation_to($attendee, 'Attendee');
+		$registration->set_attendee_id($attendee->ID());
+		$registration->update_cache_after_object_save('Attendee', $attendee);
+	}
+
+
+	/**
+	 *    _associate_registration_with_transaction
+	 *
+	 * @param EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _associate_registration_with_transaction(EE_Registration $registration)
+	{
+		// add relation to registration
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
+	}
+
+
+	/**
+	 *    _copy_critical_attendee_details_from_primary_registrant
+	 *    ensures that all attendees at least have data for first name, last name, and email address
+	 *
+	 * @param array $attendee_data
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
+	{
+		// bare minimum critical details include first name, last name, email address
+		$critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
+		// add address info to critical details?
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+			false
+		)) {
+			$address_details           = array(
+				'ATT_address',
+				'ATT_address2',
+				'ATT_city',
+				'STA_ID',
+				'CNT_ISO',
+				'ATT_zip',
+				'ATT_phone',
+			);
+			$critical_attendee_details = array_merge($critical_attendee_details, $address_details);
+		}
+		foreach ($critical_attendee_details as $critical_attendee_detail) {
+			if (! isset($attendee_data[$critical_attendee_detail])
+				|| empty($attendee_data[$critical_attendee_detail])
+			) {
+				$attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(
+					$critical_attendee_detail
+				);
+			}
+		}
+		return $attendee_data;
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to edit their attendee information
+	 *    this gets called AFTER the process_reg_step() method above
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function update_reg_step()
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect     = true;
+			$this->checkout->redirect_url = add_query_arg(
+				array(
+					'e_reg_url_link' => $this->checkout->reg_url_link,
+					'revisit'        => true,
+				),
+				$this->checkout->thank_you_page_url
+			);
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+			return true;
+		}
+		return false;
+	}
 }

Spacing +51 added lines, -52 removed lines

@@ -48,7 +48,7 @@ 
     {
         $this->_slug     = 'attendee_information';
         $this->_name     = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'attendee_info_main.template.php';
         $this->checkout  = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -59,11 +59,11 @@ 
 
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+        EE_Registry::$i18n_js_strings['required_field'] = esc_html__(
             ' is a required question.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+        EE_Registry::$i18n_js_strings['required_multi_field'] = esc_html__(
             ' is a required question. Please enter a value for at least one of the options.',
             'event_espresso'
         );
@@ -71,18 +71,18 @@ 
             'Please answer all required questions correctly before proceeding.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+        EE_Registry::$i18n_js_strings['attendee_info_copied'] = sprintf(
             esc_html__(
                 'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
                 'event_espresso'
             ),
             '<br/>'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+        EE_Registry::$i18n_js_strings['attendee_info_copy_error'] = esc_html__(
             'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+        EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
             'You must enter a valid email address.',
             'event_espresso'
         );
@@ -145,7 +145,7 @@ 
                     && $this->checkout->visit_allows_processing_of_this_registration($registration)
                 ) {
                     $subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
-                    if (! $this->checkout->admin_request) {
+                    if ( ! $this->checkout->admin_request) {
                         $template_args['registrations'][$registration->reg_url_link()]    = $registration;
                         $template_args['ticket_count'][$registration->ticket()->ID()]     = isset(
                             $template_args['ticket_count'][$registration->ticket()->ID()]
@@ -194,8 +194,7 @@ 
                 'html_id'         => $this->reg_form_name(),
                 'subsections'     => $subsections,
                 'layout_strategy' => $this->checkout->admin_request ?
-                    new EE_Div_Per_Section_Layout() :
-                    new EE_Template_Layout(
+                    new EE_Div_Per_Section_Layout() : new EE_Template_Layout(
                         array(
                             'layout_template_file' => $this->_template, // layout_template
                             'template_args'        => $template_args,
@@ -238,7 +237,7 @@ 
             if ($question_groups) {
                 // array of params to pass to parent constructor
                 $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+                    'html_id'         => 'ee-registration-'.$registration->reg_url_link(),
                     'html_class'      => 'ee-reg-form-attendee-dv',
                     'html_style'      => $this->checkout->admin_request
                         ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
@@ -294,7 +293,7 @@ 
         // generate hidden input
         return new EE_Hidden_Input(
             array(
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+                'html_id' => 'additional-attendee-reg-info-'.$registration->reg_url_link(),
                 'default' => $additional_attendee_reg_info,
             )
         );
@@ -314,11 +313,11 @@ 
     {
         // array of params to pass to parent constructor
         $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
+            'html_id'         => 'ee-reg-form-qstn-grp-'.$question_group->identifier(),
             'html_class'      => $this->checkout->admin_request
                 ? 'form-table ee-reg-form-qstn-grp-dv'
                 : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-lbl',
+            'html_label_id'   => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-lbl',
             'subsections'     => array(
                 'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
             ),
@@ -329,7 +328,7 @@ 
         // where params
         $query_params = array('QST_deleted' => 0);
         // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
+        if ( ! $this->checkout->admin_request) {
             $query_params['QST_admin_only'] = array('!=', true);
         }
         $questions = $question_group->get_many_related(
@@ -473,7 +472,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+                SPCO_REG_STEPS_PATH.$this->_slug.DS.'_auto_copy_attendee_info.template.php',
                 apply_filters(
                     'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
                     array()
@@ -505,16 +504,16 @@ 
                 if ($registration->ticket()->ID() !== $prev_ticket) {
                     $item_name = $registration->ticket()->name();
                     $item_name .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
+                        ? ' - '.$registration->ticket()->description()
                         : '';
-                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']'] =
+                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-'.$registration->ticket()->ID().']'] =
                         new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+                            '<h6 class="spco-copy-attendee-event-hdr">'.$item_name.'</h6>'
                         );
                     $prev_ticket = $registration->ticket()->ID();
                 }
 
-                $copy_attendee_info_inputs['spco_copy_attendee_chk[' . $registration->ID() . ']'] =
+                $copy_attendee_info_inputs['spco_copy_attendee_chk['.$registration->ID().']'] =
                     new EE_Checkbox_Multi_Input(
                         array(
                             $registration->ID() => sprintf(
@@ -523,7 +522,7 @@ 
                             ),
                         ),
                         array(
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+                            'html_id'                 => 'spco-copy-attendee-chk-'.$registration->reg_url_link(),
                             'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
                             'display_html_label_text' => false,
                         )
@@ -572,7 +571,7 @@ 
             $registration,
             $question->system_ID()
         );
-        $answer       = $answer_value === null
+        $answer = $answer_value === null
             ? EEM_Answer::instance()->get_one(
                 array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
             )
@@ -589,14 +588,14 @@ 
         }
         // verify instance
         if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
+            if ( ! empty($answer_value)) {
                 $answer->set('ANS_value', $answer_value);
             }
             $answer->cache('Question', $question);
             //remember system ID had a bug where sometimes it could be null
             $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
+                ? $question->system_ID().'-'.$registration->reg_url_link()
+                : $question->ID().'-'.$registration->reg_url_link();
             $registration->cache('Answer', $answer, $answer_cache_id);
         }
         return $this->_generate_question_input($registration, $question, $answer);
@@ -628,18 +627,18 @@ 
             10,
             4
         );
-        $input_constructor_args                  = array(
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+        $input_constructor_args = array(
+            'html_name'        => 'ee_reg_qstn['.$registration->ID().']['.$identifier.']',
+            'html_id'          => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
+            'html_class'       => 'ee-reg-qstn ee-reg-qstn-'.$identifier,
+            'html_label_id'    => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
             'html_label_class' => 'ee-reg-qstn',
         );
         $input_constructor_args['html_label_id'] .= '-lbl';
         if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id']       .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+            $input_constructor_args['html_name']     .= '['.$answer->ID().']';
+            $input_constructor_args['html_id']       .= '-'.$answer->ID();
+            $input_constructor_args['html_label_id'] .= '-'.$answer->ID();
         }
         $form_input = $question->generate_form_input(
             $registration,
@@ -682,7 +681,7 @@ 
         $countries = $this->checkout->action === 'process_reg_step'
             ? EEM_Country::instance()->get_all_countries()
             : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
                     $country_options[$country->ID()] = $country->name();
@@ -732,7 +731,7 @@ 
         $states        = $this->checkout->action === 'process_reg_step'
             ? EEM_State::instance()->get_all_states()
             : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
                     $state_options[$state->country()->name()][$state->ID()] = $state->name();
@@ -784,7 +783,7 @@ 
             );
             return false;
         }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+        if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
             EE_Error::add_error(
                 esc_html__(
                     'A valid transaction could not be initiated for processing your registrations.',
@@ -801,10 +800,10 @@ 
         // verify we got the goods
         if (empty($registrations)) {
             //combine the old translated string with a new one, in order to not break translations
-            $error_message = esc_html__( 'Your form data could not be applied to any valid registrations.', 'event_espresso' )
+            $error_message = esc_html__('Your form data could not be applied to any valid registrations.', 'event_espresso')
                              . sprintf(
                                  esc_html__('%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.', 'event_espresso'),
-                                 '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
+                                 '<a href="'.get_post_type_archive_link('espresso_events').'" >',
                                  '</a>',
                                  '<br />'
                              );
@@ -823,7 +822,7 @@ 
         if ($registrations_processed === false) {
             // but return immediately if the previous step exited early due to errors
             return false;
-        } elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+        } elseif ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
             // generate a correctly translated string for all possible singular/plural combinations
             if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
                 $error_msg = sprintf(
@@ -904,7 +903,7 @@ 
         // grab the saved registrations from the transaction
         foreach ($registrations as $registration) {
             // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 EE_Error::add_error(
                     esc_html__(
                         'An invalid Registration object was discovered when attempting to process your registration information.',
@@ -919,12 +918,12 @@ 
             /** @var string $reg_url_link */
             $reg_url_link = $registration->reg_url_link();
             // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
+            if ( ! empty($reg_url_link)) {
                 // should this registration be processed during this visit ?
                 if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
                     // if NOT revisiting, then let's save the registration now,
                     // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
+                    if ( ! $this->checkout->revisit) {
                         $registration->save();
                     }
                     /**
@@ -959,7 +958,7 @@ 
                             ? true
                             : false;
                         // filter form input data for this registration
-                        $valid_data[$reg_url_link] = (array)apply_filters(
+                        $valid_data[$reg_url_link] = (array) apply_filters(
                             'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
                             $valid_data[$reg_url_link]
                         );
@@ -971,11 +970,11 @@ 
                         }
                         // now loop through our array of valid post data && process attendee reg forms
                         foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections)) {
+                            if ( ! in_array($form_section, $non_input_form_sections)) {
                                 foreach ($form_inputs as $form_input => $input_value) {
                                     // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
                                     // check for critical inputs
-                                    if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+                                    if ( ! $this->_verify_critical_attendee_details_are_set_and_validate_email(
                                         $form_input,
                                         $input_value
                                     )
@@ -995,7 +994,7 @@ 
                                         $input_value = $primary_registrant[$form_input];
                                     }
                                     // now attempt to save the input data
-                                    if (! $this->_save_registration_form_input(
+                                    if ( ! $this->_save_registration_form_input(
                                         $registration,
                                         $form_input,
                                         $input_value
@@ -1051,7 +1050,7 @@ 
                     // add relation to registration, set attendee ID, and cache attendee
                     $this->_associate_attendee_with_registration($registration, $attendee);
                     // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
+                    if ( ! $registration->attendee() instanceof EE_Attendee) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1146,7 +1145,7 @@ 
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
         $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
+            ? $form_input.'-'.$registration->reg_url_link()
             : $form_input;
         $answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
                            && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
@@ -1167,10 +1166,10 @@ 
                 break;
 
             default:
-                $ATT_input = 'ATT_' . $form_input;
+                $ATT_input = 'ATT_'.$form_input;
                 //EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
                 $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
+                $form_input        = $attendee_property ? 'ATT_'.$form_input : $form_input;
         }
         // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
         // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
@@ -1215,7 +1214,7 @@ 
     ) {
         if (empty($input_value)) {
             // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
+            if ( ! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
                 return true;
             }
             switch ($form_input) {
@@ -1302,7 +1301,7 @@ 
             'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
             false
         )) {
-            $address_details           = array(
+            $address_details = array(
                 'ATT_address',
                 'ATT_address2',
                 'ATT_city',
@@ -1314,7 +1313,7 @@ 
             $critical_attendee_details = array_merge($critical_attendee_details, $address_details);
         }
         foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (! isset($attendee_data[$critical_attendee_detail])
+            if ( ! isset($attendee_data[$critical_attendee_detail])
                 || empty($attendee_data[$critical_attendee_detail])
             ) {
                 $attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(

modules/ticket_selector/DisplayTicketSelector.php

Indentation +705 added lines, -705 removed lines

@@ -17,7 +17,7 @@ 
 use WP_Post;
 
 if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+	exit( 'No direct script access allowed' );
 }
 
 
@@ -34,713 +34,713 @@ 
 class DisplayTicketSelector
 {
 
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected $iframe = false;
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @var int $max_attendees
-     */
-    private $max_attendees = EE_INF;
-
-    /**
-     *@var string $date_format
-     */
-    private $date_format;
-
-    /**
-     *@var string $time_format
-     */
-    private $time_format;
-
-    /**
-     *@var boolean $display_full_ui
-     */
-    private $display_full_ui;
-
-
-
-    /**
-     * DisplayTicketSelector constructor.
-     */
-    public function __construct()
-    {
-        $this->date_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format')
-        );
-        $this->time_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format')
-        );
-    }
-
-
-
-    /**
-     * @param boolean $iframe
-     */
-    public function setIframe( $iframe = true )
-    {
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
-    }
-
-
-    /**
-     * finds and sets the \EE_Event object for use throughout class
-     *
-     * @param mixed $event
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function setEvent( $event = null )
-    {
-        if ( $event === null ) {
-            global $post;
-            $event = $post;
-        }
-        if ( $event instanceof EE_Event ) {
-            $this->event = $event;
-        } elseif ( $event instanceof WP_Post ) {
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
-                $this->event = $event->EE_Event;
-            } elseif ( $event->post_type === 'espresso_events' ) {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
-                $this->event = $event->EE_Event;
-            }
-        } else {
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
-            $dev_msg = $user_msg . __(
-                    'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                    'event_espresso'
-                );
-            EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function getMaxAttendees()
-    {
-        return $this->max_attendees;
-    }
-
-
-
-    /**
-     * @param int $max_attendees
-     */
-    public function setMaxAttendees($max_attendees)
-    {
-        $this->max_attendees = absint(
-            apply_filters(
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-                $max_attendees
-            )
-        );
-    }
-
-
-
-    /**
-     * Returns whether or not the full ticket selector should be shown or not.
-     * Currently, it displays on the frontend (including ajax requests) but not the backend
-     * @return bool
-     */
-    private function display_full_ui()
-    {
-        if ($this->display_full_ui === null) {
-            $this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
-        }
-        return $this->display_full_ui;
-    }
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param WP_Post|int $event
-     * @param bool         $view_details
-     * @return string
-     * @throws EE_Error
-     */
-    public function display( $event = null, $view_details = false )
-    {
-        // reset filter for displaying submit button
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
-        // poke and prod incoming event till it tells us what it is
-        if ( ! $this->setEvent( $event ) ) {
-            return false;
-        }
-        // begin gathering template arguments by getting event status
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
-        if (
-            $this->activeEventAndShowTicketSelector(
-                $event,
-                $template_args['event_status'],
-                $view_details
-            )
-        ) {
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        $this->setMaxAttendees($this->event->additional_limit());
-        if ($this->getMaxAttendees() < 1) {
-            return $this->ticketSalesClosedMessage();
-        }
-        // is the event expired ?
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        if ( $template_args[ 'event_is_expired' ] ) {
-            return $this->expiredEventMessage();
-        }
-        // get all tickets for this event ordered by the datetime
-        $tickets = $this->getTickets();
-        if (count($tickets) < 1) {
-            return $this->noTicketAvailableMessage();
-        }
-        if (EED_Events_Archive::is_iframe()){
-            $this->setIframe();
-        }
-        // redirecting to another site for registration ??
-        $external_url = (string) $this->event->external_url();
-        // if redirecting to another site for registration, then we don't load the TS
-        $ticket_selector = $external_url
-            ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets,$template_args);
-        // now set up the form (but not for the admin)
-        $ticket_selector = $this->display_full_ui()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
-        return $ticket_selector;
-    }
-
-
-
-    /**
-     * displayTicketSelector
-     * examines the event properties and determines whether a Ticket Selector should be displayed
-     *
-     * @param WP_Post|int $event
-     * @param string       $_event_active_status
-     * @param bool         $view_details
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
-    {
-        $event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
-        return $this->display_full_ui()
-               && (
-                   ! $this->event->display_ticket_selector()
-                   || $view_details
-                   || post_password_required($event_post)
-                   || (
-                       $_event_active_status !== EE_Datetime::active
-                       && $_event_active_status !== EE_Datetime::upcoming
-                       && $_event_active_status !== EE_Datetime::sold_out
-                       && ! (
-                           $_event_active_status === EE_Datetime::inactive
-                           && is_user_logged_in()
-                       )
-                   )
-               );
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event is expired
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function expiredEventMessage()
-    {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
-            'We\'re sorry, but all tickets sales have ended because the event is expired.',
-            'event_espresso'
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event has no more tickets available
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function noTicketAvailableMessage()
-    {
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $no_ticket_available_msg .= sprintf(
-                esc_html__(
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
-            );
-        }
-        return '
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected $iframe = false;
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @var int $max_attendees
+	 */
+	private $max_attendees = EE_INF;
+
+	/**
+	 *@var string $date_format
+	 */
+	private $date_format;
+
+	/**
+	 *@var string $time_format
+	 */
+	private $time_format;
+
+	/**
+	 *@var boolean $display_full_ui
+	 */
+	private $display_full_ui;
+
+
+
+	/**
+	 * DisplayTicketSelector constructor.
+	 */
+	public function __construct()
+	{
+		$this->date_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format')
+		);
+		$this->time_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format')
+		);
+	}
+
+
+
+	/**
+	 * @param boolean $iframe
+	 */
+	public function setIframe( $iframe = true )
+	{
+		$this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
+	}
+
+
+	/**
+	 * finds and sets the \EE_Event object for use throughout class
+	 *
+	 * @param mixed $event
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function setEvent( $event = null )
+	{
+		if ( $event === null ) {
+			global $post;
+			$event = $post;
+		}
+		if ( $event instanceof EE_Event ) {
+			$this->event = $event;
+		} elseif ( $event instanceof WP_Post ) {
+			if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
+				$this->event = $event->EE_Event;
+			} elseif ( $event->post_type === 'espresso_events' ) {
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
+				$this->event = $event->EE_Event;
+			}
+		} else {
+			$user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
+			$dev_msg = $user_msg . __(
+					'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+					'event_espresso'
+				);
+			EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function getMaxAttendees()
+	{
+		return $this->max_attendees;
+	}
+
+
+
+	/**
+	 * @param int $max_attendees
+	 */
+	public function setMaxAttendees($max_attendees)
+	{
+		$this->max_attendees = absint(
+			apply_filters(
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+				$max_attendees
+			)
+		);
+	}
+
+
+
+	/**
+	 * Returns whether or not the full ticket selector should be shown or not.
+	 * Currently, it displays on the frontend (including ajax requests) but not the backend
+	 * @return bool
+	 */
+	private function display_full_ui()
+	{
+		if ($this->display_full_ui === null) {
+			$this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
+		}
+		return $this->display_full_ui;
+	}
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param WP_Post|int $event
+	 * @param bool         $view_details
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display( $event = null, $view_details = false )
+	{
+		// reset filter for displaying submit button
+		remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
+		// poke and prod incoming event till it tells us what it is
+		if ( ! $this->setEvent( $event ) ) {
+			return false;
+		}
+		// begin gathering template arguments by getting event status
+		$template_args = array( 'event_status' => $this->event->get_active_status() );
+		if (
+			$this->activeEventAndShowTicketSelector(
+				$event,
+				$template_args['event_status'],
+				$view_details
+			)
+		) {
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		$this->setMaxAttendees($this->event->additional_limit());
+		if ($this->getMaxAttendees() < 1) {
+			return $this->ticketSalesClosedMessage();
+		}
+		// is the event expired ?
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		if ( $template_args[ 'event_is_expired' ] ) {
+			return $this->expiredEventMessage();
+		}
+		// get all tickets for this event ordered by the datetime
+		$tickets = $this->getTickets();
+		if (count($tickets) < 1) {
+			return $this->noTicketAvailableMessage();
+		}
+		if (EED_Events_Archive::is_iframe()){
+			$this->setIframe();
+		}
+		// redirecting to another site for registration ??
+		$external_url = (string) $this->event->external_url();
+		// if redirecting to another site for registration, then we don't load the TS
+		$ticket_selector = $external_url
+			? $this->externalEventRegistration()
+			: $this->loadTicketSelector($tickets,$template_args);
+		// now set up the form (but not for the admin)
+		$ticket_selector = $this->display_full_ui()
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
+		return $ticket_selector;
+	}
+
+
+
+	/**
+	 * displayTicketSelector
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
+	 *
+	 * @param WP_Post|int $event
+	 * @param string       $_event_active_status
+	 * @param bool         $view_details
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
+	{
+		$event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
+		return $this->display_full_ui()
+			   && (
+				   ! $this->event->display_ticket_selector()
+				   || $view_details
+				   || post_password_required($event_post)
+				   || (
+					   $_event_active_status !== EE_Datetime::active
+					   && $_event_active_status !== EE_Datetime::upcoming
+					   && $_event_active_status !== EE_Datetime::sold_out
+					   && ! (
+						   $_event_active_status === EE_Datetime::inactive
+						   && is_user_logged_in()
+					   )
+				   )
+			   );
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event is expired
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function expiredEventMessage()
+	{
+		return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+			'We\'re sorry, but all tickets sales have ended because the event is expired.',
+			'event_espresso'
+		) . '</span></div><!-- .ee-event-expired-notice -->';
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event has no more tickets available
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function noTicketAvailableMessage()
+	{
+		$no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$no_ticket_available_msg .= sprintf(
+				esc_html__(
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
+			);
+		}
+		return '
             <div class="ee-event-expired-notice">
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
             </div><!-- .ee-event-expired-notice -->';
-    }
-
-
-
-    /**
-     * ticketSalesClosed
-     * notice displayed if event ticket sales are turned off
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketSalesClosedMessage()
-    {
-        $sales_closed_msg = esc_html__(
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-            'event_espresso'
-        );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $sales_closed_msg .= sprintf(
-                esc_html__(
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
-            );
-        }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-    }
-
-
-
-    /**
-     * getTickets
-     *
-     * @return \EE_Base_Class[]|\EE_Ticket[]
-     * @throws EE_Error
-     */
-    protected function getTickets()
-    {
-        $ticket_query_args = array(
-            array('Datetime.EVT_ID' => $this->event->ID()),
-            'order_by' => array(
-                'TKT_order'              => 'ASC',
-                'TKT_required'           => 'DESC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ),
-        );
-        if (
-            ! (
-                EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
-                && EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
-            )
-        ) {
-            //use the correct applicable time query depending on what version of core is being run.
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
-                ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
-        }
-        return EEM_Ticket::instance()->get_all($ticket_query_args);
-    }
-
-
-
-    /**
-     * loadTicketSelector
-     * begins to assemble template arguments
-     * and decides whether to load a "simple" ticket selector, or the standard
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function loadTicketSelector(array $tickets, array $template_args)
-    {
-        $template_args['event'] = $this->event;
-        $template_args['EVT_ID'] = $this->event->ID();
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        $template_args['max_atndz'] = $this->getMaxAttendees();
-        $template_args['date_format'] = $this->date_format;
-        $template_args['time_format'] = $this->time_format;
-        /**
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
-         *
-         * @since 4.9.13
-         * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
-         * @param int $EVT_ID The Event ID
-         */
-        $template_args['anchor_id'] = apply_filters(
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
-            $this->event->ID()
-        );
-        $template_args['tickets'] = $tickets;
-        $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
-        return $ticket_selector instanceof TicketSelectorSimple
-            ? $ticket_selector
-            : new TicketSelectorStandard(
-                $this->event,
-                $tickets,
-                $this->getMaxAttendees(),
-                $template_args,
-                $this->date_format,
-                $this->time_format
-            );
-    }
-
-
-
-    /**
-     * simpleTicketSelector
-     * there's one ticket, and max attendees is set to one,
-     * so if the event is free, then this is a "simple" ticket selector
-     * a.k.a. "Dude Where's my Ticket Selector?"
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array  $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function simpleTicketSelector($tickets, array $template_args)
-    {
-        // if there is only ONE ticket with a max qty of ONE
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
-            return '';
-        }
-        /** @var \EE_Ticket $ticket */
-        $ticket = reset($tickets);
-        // if the ticket is free... then not much need for the ticket selector
-        if (
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__hide_ticket_selector',
-                $ticket->is_free(),
-                $this->event->ID()
-            )
-        ) {
-            return new TicketSelectorSimple(
-                $this->event,
-                $ticket,
-                $this->getMaxAttendees(),
-                $template_args
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     * externalEventRegistration
-     *
-     * @return string
-     */
-    public function externalEventRegistration()
-    {
-        // if not we still need to trigger the display of the submit button
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        //display notice to admin that registration is external
-        return $this->display_full_ui()
-            ? esc_html__(
-                'Registration is at an external URL for this event.',
-                'event_espresso'
-            )
-            : '';
-    }
-
-
-
-    /**
-     * formOpen
-     *
-     * @param        int    $ID
-     * @param        string $external_url
-     * @return        string
-     */
-    public function formOpen( $ID = 0, $external_url = '' )
-    {
-        // if redirecting, we don't need any anything else
-        if ( $external_url ) {
-            $html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
-            // open link in new window ?
-            $html .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                EED_Events_Archive::is_iframe()
-            )
-                ? ' target="_blank"'
-                : '';
-            $html .= '>';
-            $query_args = EEH_URL::get_query_string( $external_url );
-            foreach ( (array)$query_args as $query_arg => $value ) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
-            return '';
-        }
-        $checkout_url = EEH_Event_View::event_link_url( $ID );
-        if ( ! $checkout_url ) {
-            EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-        $extra_params = $this->iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
-        return $html;
-    }
-
-
-
-    /**
-     * displaySubmitButton
-     *
-     * @param  string $external_url
-     * @return string
-     * @throws EE_Error
-     */
-    public function displaySubmitButton($external_url = '')
-    {
-        $html = '';
-        if ($this->display_full_ui()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= $this->displayRegisterNowButton();
-                $html .= empty($external_url)
-                    ? $this->ticketSelectorEndDiv()
-                    : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
-            } elseif ($this->getMaxAttendees() === 1) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ($this->event->is_sold_out()) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            __(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            $this->event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        $this->event
-                    );
-                    if (
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                            false,
-                            $this->event
-                        )
-                    ) {
-                        $html .= $this->displayRegisterNowButton();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .=  $this->ticketSelectorEndDiv();
-                } elseif (
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                    && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= $this->displayViewDetailsButton(true);
-                } else {
-                    $html .= $this->ticketSelectorEndDiv();
-                }
-            } elseif (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= $this->ticketSelectorEndDiv();
-                $html .= $this->displayViewDetailsButton();
-            } else {
-                if (
-                    apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        $this->event
-                    )
-                ) {
-                    $html .= $this->displayRegisterNowButton();
-                }
-                // no submit or view details button, and no additional content
-                $html .= $this->ticketSelectorEndDiv();
-            }
-            if ( ! $this->iframe && ! is_archive()) {
-                $html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
-            }
-        }
-	    return apply_filters(
-		    'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
-		    $html,
-		    $this->event
-	    );
-    }
-
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayRegisterNowButton()
-    {
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            __('Register Now', 'event_espresso'),
-            $this->event
-        );
-        $external_url = $this->event->external_url();
-        $html = EEH_HTML::div(
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
-        );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
-        $html .= ' class="ticket-selector-submit-btn ';
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
-        $html .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            $this->event
-        );
-        return $html;
-    }
-
-
-    /**
-     * displayViewDetailsButton
-     *
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayViewDetailsButton( $DWMTS = false )
-    {
-        if ( ! $this->event->get_permalink() ) {
-            EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $view_details_btn = '<form method="POST" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            $this->event->get_permalink(),
-            $this->event
-        );
-        $view_details_btn .= '"';
-        // open link in new window ?
-        $view_details_btn .= apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
-            EED_Events_Archive::is_iframe()
-        )
-            ? ' target="_blank"'
-            : '';
-        $view_details_btn .='>';
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            esc_html__('View Details', 'event_espresso'),
-            $this->event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . $this->event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
-        if ($DWMTS) {
-            $view_details_btn .= $this->formClose();
-            $view_details_btn .= $this->ticketSelectorEndDiv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= $this->clearTicketSelector();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= $this->formClose();
-        }
-        return $view_details_btn;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ticketSelectorEndDiv()
-    {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function clearTicketSelector()
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div><!-- clearTicketSelector -->';
-    }
-
-
-
-    /**
-     * @access        public
-     * @return        string
-     */
-    public function formClose()
-    {
-        return '</form>';
-    }
+	}
+
+
+
+	/**
+	 * ticketSalesClosed
+	 * notice displayed if event ticket sales are turned off
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketSalesClosedMessage()
+	{
+		$sales_closed_msg = esc_html__(
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+			'event_espresso'
+		);
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$sales_closed_msg .= sprintf(
+				esc_html__(
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
+			);
+		}
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+	}
+
+
+
+	/**
+	 * getTickets
+	 *
+	 * @return \EE_Base_Class[]|\EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	protected function getTickets()
+	{
+		$ticket_query_args = array(
+			array('Datetime.EVT_ID' => $this->event->ID()),
+			'order_by' => array(
+				'TKT_order'              => 'ASC',
+				'TKT_required'           => 'DESC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			),
+		);
+		if (
+			! (
+				EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
+				&& EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
+			)
+		) {
+			//use the correct applicable time query depending on what version of core is being run.
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query')
+				? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
+		}
+		return EEM_Ticket::instance()->get_all($ticket_query_args);
+	}
+
+
+
+	/**
+	 * loadTicketSelector
+	 * begins to assemble template arguments
+	 * and decides whether to load a "simple" ticket selector, or the standard
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function loadTicketSelector(array $tickets, array $template_args)
+	{
+		$template_args['event'] = $this->event;
+		$template_args['EVT_ID'] = $this->event->ID();
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		$template_args['max_atndz'] = $this->getMaxAttendees();
+		$template_args['date_format'] = $this->date_format;
+		$template_args['time_format'] = $this->time_format;
+		/**
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
+		 *
+		 * @since 4.9.13
+		 * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
+		 * @param int $EVT_ID The Event ID
+		 */
+		$template_args['anchor_id'] = apply_filters(
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
+			'#tkt-slctr-tbl-' . $this->event->ID(),
+			$this->event->ID()
+		);
+		$template_args['tickets'] = $tickets;
+		$template_args['ticket_count'] = count($tickets);
+		$ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
+		return $ticket_selector instanceof TicketSelectorSimple
+			? $ticket_selector
+			: new TicketSelectorStandard(
+				$this->event,
+				$tickets,
+				$this->getMaxAttendees(),
+				$template_args,
+				$this->date_format,
+				$this->time_format
+			);
+	}
+
+
+
+	/**
+	 * simpleTicketSelector
+	 * there's one ticket, and max attendees is set to one,
+	 * so if the event is free, then this is a "simple" ticket selector
+	 * a.k.a. "Dude Where's my Ticket Selector?"
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array  $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function simpleTicketSelector($tickets, array $template_args)
+	{
+		// if there is only ONE ticket with a max qty of ONE
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
+			return '';
+		}
+		/** @var \EE_Ticket $ticket */
+		$ticket = reset($tickets);
+		// if the ticket is free... then not much need for the ticket selector
+		if (
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__hide_ticket_selector',
+				$ticket->is_free(),
+				$this->event->ID()
+			)
+		) {
+			return new TicketSelectorSimple(
+				$this->event,
+				$ticket,
+				$this->getMaxAttendees(),
+				$template_args
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * externalEventRegistration
+	 *
+	 * @return string
+	 */
+	public function externalEventRegistration()
+	{
+		// if not we still need to trigger the display of the submit button
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		//display notice to admin that registration is external
+		return $this->display_full_ui()
+			? esc_html__(
+				'Registration is at an external URL for this event.',
+				'event_espresso'
+			)
+			: '';
+	}
+
+
+
+	/**
+	 * formOpen
+	 *
+	 * @param        int    $ID
+	 * @param        string $external_url
+	 * @return        string
+	 */
+	public function formOpen( $ID = 0, $external_url = '' )
+	{
+		// if redirecting, we don't need any anything else
+		if ( $external_url ) {
+			$html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
+			// open link in new window ?
+			$html .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				EED_Events_Archive::is_iframe()
+			)
+				? ' target="_blank"'
+				: '';
+			$html .= '>';
+			$query_args = EEH_URL::get_query_string( $external_url );
+			foreach ( (array)$query_args as $query_arg => $value ) {
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
+			return '';
+		}
+		$checkout_url = EEH_Event_View::event_link_url( $ID );
+		if ( ! $checkout_url ) {
+			EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+		$extra_params = $this->iframe ? ' target="_blank"' : '';
+		$html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		$html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
+		return $html;
+	}
+
+
+
+	/**
+	 * displaySubmitButton
+	 *
+	 * @param  string $external_url
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displaySubmitButton($external_url = '')
+	{
+		$html = '';
+		if ($this->display_full_ui()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= $this->displayRegisterNowButton();
+				$html .= empty($external_url)
+					? $this->ticketSelectorEndDiv()
+					: $this->clearTicketSelector();
+				$html .= '<br/>' . $this->formClose();
+			} elseif ($this->getMaxAttendees() === 1) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ($this->event->is_sold_out()) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							$this->event->name(),
+							'</p>',
+							'<br />'
+						),
+						$this->event
+					);
+					if (
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+							false,
+							$this->event
+						)
+					) {
+						$html .= $this->displayRegisterNowButton();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .=  $this->ticketSelectorEndDiv();
+				} elseif (
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+					&& ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= $this->displayViewDetailsButton(true);
+				} else {
+					$html .= $this->ticketSelectorEndDiv();
+				}
+			} elseif (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= $this->ticketSelectorEndDiv();
+				$html .= $this->displayViewDetailsButton();
+			} else {
+				if (
+					apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						$this->event
+					)
+				) {
+					$html .= $this->displayRegisterNowButton();
+				}
+				// no submit or view details button, and no additional content
+				$html .= $this->ticketSelectorEndDiv();
+			}
+			if ( ! $this->iframe && ! is_archive()) {
+				$html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
+			$html,
+			$this->event
+		);
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayRegisterNowButton()
+	{
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			__('Register Now', 'event_espresso'),
+			$this->event
+		);
+		$external_url = $this->event->external_url();
+		$html = EEH_HTML::div(
+			'', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
+		);
+		$html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+		$html .= ' class="ticket-selector-submit-btn ';
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html .= ' type="submit" value="' . $btn_text . '" />';
+		$html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+		$html .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			$this->event
+		);
+		return $html;
+	}
+
+
+	/**
+	 * displayViewDetailsButton
+	 *
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayViewDetailsButton( $DWMTS = false )
+	{
+		if ( ! $this->event->get_permalink() ) {
+			EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$view_details_btn = '<form method="POST" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			$this->event->get_permalink(),
+			$this->event
+		);
+		$view_details_btn .= '"';
+		// open link in new window ?
+		$view_details_btn .= apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
+			EED_Events_Archive::is_iframe()
+		)
+			? ' target="_blank"'
+			: '';
+		$view_details_btn .='>';
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			esc_html__('View Details', 'event_espresso'),
+			$this->event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . $this->event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
+		if ($DWMTS) {
+			$view_details_btn .= $this->formClose();
+			$view_details_btn .= $this->ticketSelectorEndDiv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= $this->clearTicketSelector();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= $this->formClose();
+		}
+		return $view_details_btn;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ticketSelectorEndDiv()
+	{
+		return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function clearTicketSelector()
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div><!-- clearTicketSelector -->';
+	}
+
+
+
+	/**
+	 * @access        public
+	 * @return        string
+	 */
+	public function formClose()
+	{
+		return '</form>';
+	}
 
 
 

Spacing +53 added lines, -53 removed lines

@@ -16,8 +16,8 @@ 
 use EEM_Ticket;
 use WP_Post;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+    exit('No direct script access allowed');
 }
 
 
@@ -93,9 +93,9 @@ 
     /**
      * @param boolean $iframe
      */
-    public function setIframe( $iframe = true )
+    public function setIframe($iframe = true)
     {
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
+        $this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
     }
 
 
@@ -106,28 +106,28 @@ 
      * @return bool
      * @throws EE_Error
      */
-    protected function setEvent( $event = null )
+    protected function setEvent($event = null)
     {
-        if ( $event === null ) {
+        if ($event === null) {
             global $post;
             $event = $post;
         }
-        if ( $event instanceof EE_Event ) {
+        if ($event instanceof EE_Event) {
             $this->event = $event;
-        } elseif ( $event instanceof WP_Post ) {
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
+        } elseif ($event instanceof WP_Post) {
+            if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
                 $this->event = $event->EE_Event;
-            } elseif ( $event->post_type === 'espresso_events' ) {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
+            } elseif ($event->post_type === 'espresso_events') {
+                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
                 $this->event = $event->EE_Event;
             }
         } else {
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
-            $dev_msg = $user_msg . __(
+            $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
+            $dev_msg = $user_msg.__(
                     'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
                     'event_espresso'
                 );
-            EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         return true;
@@ -182,16 +182,16 @@ 
      * @return string
      * @throws EE_Error
      */
-    public function display( $event = null, $view_details = false )
+    public function display($event = null, $view_details = false)
     {
         // reset filter for displaying submit button
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
+        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
         // poke and prod incoming event till it tells us what it is
-        if ( ! $this->setEvent( $event ) ) {
+        if ( ! $this->setEvent($event)) {
             return false;
         }
         // begin gathering template arguments by getting event status
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
+        $template_args = array('event_status' => $this->event->get_active_status());
         if (
             $this->activeEventAndShowTicketSelector(
                 $event,
@@ -208,7 +208,7 @@ 
         }
         // is the event expired ?
         $template_args['event_is_expired'] = $this->event->is_expired();
-        if ( $template_args[ 'event_is_expired' ] ) {
+        if ($template_args['event_is_expired']) {
             return $this->expiredEventMessage();
         }
         // get all tickets for this event ordered by the datetime
@@ -216,7 +216,7 @@ 
         if (count($tickets) < 1) {
             return $this->noTicketAvailableMessage();
         }
-        if (EED_Events_Archive::is_iframe()){
+        if (EED_Events_Archive::is_iframe()) {
             $this->setIframe();
         }
         // redirecting to another site for registration ??
@@ -224,10 +224,10 @@ 
         // if redirecting to another site for registration, then we don't load the TS
         $ticket_selector = $external_url
             ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets,$template_args);
+            : $this->loadTicketSelector($tickets, $template_args);
         // now set up the form (but not for the admin)
         $ticket_selector = $this->display_full_ui()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+            ? $this->formOpen($this->event->ID(), $external_url).$ticket_selector
             : $ticket_selector;
         // submit button and form close tag
         $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
@@ -277,10 +277,10 @@ 
      */
     protected function expiredEventMessage()
     {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+        return '<div class="ee-event-expired-notice"><span class="important-notice">'.esc_html__(
             'We\'re sorry, but all tickets sales have ended because the event is expired.',
             'event_espresso'
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
+        ).'</span></div><!-- .ee-event-expired-notice -->';
     }
 
 
@@ -294,7 +294,7 @@ 
      */
     protected function noTicketAvailableMessage()
     {
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
+        $no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
         if (current_user_can('edit_post', $this->event->ID())) {
             $no_ticket_available_msg .= sprintf(
                 esc_html__(
@@ -309,7 +309,7 @@ 
         }
         return '
             <div class="ee-event-expired-notice">
-                <span class="important-notice">' . $no_ticket_available_msg . '</span>
+                <span class="important-notice">' . $no_ticket_available_msg.'</span>
             </div><!-- .ee-event-expired-notice -->';
     }
 
@@ -340,7 +340,7 @@ 
                 '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
             );
         }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+        return '<p><span class="important-notice">'.$sales_closed_msg.'</span></p>';
     }
 
 
@@ -407,12 +407,12 @@ 
          */
         $template_args['anchor_id'] = apply_filters(
             'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
+            '#tkt-slctr-tbl-'.$this->event->ID(),
             $this->event->ID()
         );
         $template_args['tickets'] = $tickets;
         $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
+        $ticket_selector = $this->simpleTicketSelector($tickets, $template_args);
         return $ticket_selector instanceof TicketSelectorSimple
             ? $ticket_selector
             : new TicketSelectorStandard(
@@ -493,11 +493,11 @@ 
      * @param        string $external_url
      * @return        string
      */
-    public function formOpen( $ID = 0, $external_url = '' )
+    public function formOpen($ID = 0, $external_url = '')
     {
         // if redirecting, we don't need any anything else
-        if ( $external_url ) {
-            $html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
+        if ($external_url) {
+            $html = '<form method="GET" action="'.EEH_URL::refactor_url($external_url).'"';
             // open link in new window ?
             $html .= apply_filters(
                 'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
@@ -506,21 +506,21 @@ 
                 ? ' target="_blank"'
                 : '';
             $html .= '>';
-            $query_args = EEH_URL::get_query_string( $external_url );
-            foreach ( (array)$query_args as $query_arg => $value ) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+            $query_args = EEH_URL::get_query_string($external_url);
+            foreach ((array) $query_args as $query_arg => $value) {
+                $html .= '<input type="hidden" name="'.$query_arg.'" value="'.$value.'">';
             }
             return $html;
         }
         // if there is no submit button, then don't start building a form
         // because the "View Details" button will build its own form
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
+        if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
             return '';
         }
-        $checkout_url = EEH_Event_View::event_link_url( $ID );
-        if ( ! $checkout_url ) {
+        $checkout_url = EEH_Event_View::event_link_url($ID);
+        if ( ! $checkout_url) {
             EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
                 __FILE__,
                 __FUNCTION__,
                 __LINE__
@@ -529,9 +529,9 @@ 
         // set no cache headers and constants
         EE_System::do_not_cache();
         $extra_params = $this->iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
+        $html = '<form method="POST" action="'.$checkout_url.'"'.$extra_params.'>';
         $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
+        $html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
         return $html;
     }
 
@@ -554,7 +554,7 @@ 
                 $html .= empty($external_url)
                     ? $this->ticketSelectorEndDiv()
                     : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
+                $html .= '<br/>'.$this->formClose();
             } elseif ($this->getMaxAttendees() === 1) {
                 // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
                 if ($this->event->is_sold_out()) {
@@ -583,7 +583,7 @@ 
                         $html .= $this->displayRegisterNowButton();
                     }
                     // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .=  $this->ticketSelectorEndDiv();
+                    $html .= $this->ticketSelectorEndDiv();
                 } elseif (
                     apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
                     && ! is_single()
@@ -638,13 +638,13 @@ 
         );
         $external_url = $this->event->external_url();
         $html = EEH_HTML::div(
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
+            '', 'ticket-selector-submit-'.$this->event->ID().'-btn-wrap', 'ticket-selector-submit-btn-wrap'
         );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+        $html .= '<input id="ticket-selector-submit-'.$this->event->ID().'-btn"';
         $html .= ' class="ticket-selector-submit-btn ';
         $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+        $html .= ' type="submit" value="'.$btn_text.'" />';
+        $html .= EEH_HTML::divx().'<!-- .ticket-selector-submit-btn-wrap -->';
         $html .= apply_filters(
             'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
             '',
@@ -664,11 +664,11 @@ 
      * @return string
      * @throws EE_Error
      */
-    public function displayViewDetailsButton( $DWMTS = false )
+    public function displayViewDetailsButton($DWMTS = false)
     {
-        if ( ! $this->event->get_permalink() ) {
+        if ( ! $this->event->get_permalink()) {
             EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
                 __FILE__, __FUNCTION__, __LINE__
             );
         }
@@ -686,7 +686,7 @@ 
         )
             ? ' target="_blank"'
             : '';
-        $view_details_btn .='>';
+        $view_details_btn .= '>';
         $btn_text = apply_filters(
             'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
             esc_html__('View Details', 'event_espresso'),
@@ -697,7 +697,7 @@ 
                              . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
                              . $btn_text
                              . '" />';
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
+        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
         if ($DWMTS) {
             $view_details_btn .= $this->formClose();
             $view_details_btn .= $this->ticketSelectorEndDiv();
@@ -717,7 +717,7 @@ 
      */
     public function ticketSelectorEndDiv()
     {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+        return $this->clearTicketSelector().'</div><!-- ticketSelectorEndDiv -->';
     }