eventespresso / event-espresso-core

admin_pages/about/templates/credits.template.php

Spacing +13 added lines, -13 removed lines

@@ -3,7 +3,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-owners">
 	<li class="wp-person" id="ee-person-sshoultes">
 		<a href="<?php esp_gravatar_profile('seth@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'seth@eventespresso.com', 'Seth Shoultes' ); ?>
+			<?php echo esp_gravatar_image('seth@eventespresso.com', 'Seth Shoultes'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('seth@eventespresso.com'); ?>">
 			Seth Shoultes
@@ -12,7 +12,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-gkoyle">
 		<a href="<?php esp_gravatar_profile('garth@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'garth@eventespresso.com', 'Garth Koyle' ); ?>
+			<?php echo esp_gravatar_image('garth@eventespresso.com', 'Garth Koyle'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('garth@eventespresso.com'); ?>">
 			Garth Koyle
@@ -24,7 +24,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-core-developers">
 	<li class="wp-person" id="ee-person-bchristensen">
 		<a href="<?php esp_gravatar_profile('brent@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'brent@eventespresso.com', 'Brent Christensen' ); ?>
+			<?php echo esp_gravatar_image('brent@eventespresso.com', 'Brent Christensen'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('brent@eventespresso.com'); ?>">
 			Brent Christensen
@@ -33,7 +33,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-dethier">
 		<a href="<?php esp_gravatar_profile('darren@roughsmootheng.in'); ?>">
-			<?php echo esp_gravatar_image( 'darren@roughsmootheng.in', 'Darren Ethier' ); ?>
+			<?php echo esp_gravatar_image('darren@roughsmootheng.in', 'Darren Ethier'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('darren@roughsmootheng.in'); ?>">
 			Darren Ethier
@@ -42,7 +42,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-mnelson">
 		<a href="<?php esp_gravatar_profile('michael@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'michael@eventespresso.com', 'Michael Nelson' ); ?>
+			<?php echo esp_gravatar_image('michael@eventespresso.com', 'Michael Nelson'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('michael@eventespresso.com'); ?>">
 			Michael Nelson
@@ -51,7 +51,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-nkolivoshka">
 		<a href="<?php esp_gravatar_profile('nazar@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'nazar@eventespresso.com', 'Nazar Kolivoshka' ); ?>
+			<?php echo esp_gravatar_image('nazar@eventespresso.com', 'Nazar Kolivoshka'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('nazar@eventespresso.com'); ?>">
 			Nazar Kolivoshka
@@ -63,7 +63,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-support-staff">
 	<li class="wp-person" id="ee-person-jfeck">
 		<a href="<?php esp_gravatar_profile('josh@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'josh@eventespresso.com', 'Josh Feck' ); ?>
+			<?php echo esp_gravatar_image('josh@eventespresso.com', 'Josh Feck'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('josh@eventespresso.com'); ?>">
 			Josh Feck
@@ -71,7 +71,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-twarwick">
 		<a href="<?php esp_gravatar_profile('tony@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'tony@eventespresso.com', 'Tony Warwick' ); ?>
+			<?php echo esp_gravatar_image('tony@eventespresso.com', 'Tony Warwick'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('tony@eventespresso.com'); ?>">
 			Tony Warwick
@@ -79,7 +79,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-lcaum">
 		<a href="<?php esp_gravatar_profile('lorenzo@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'lorenzo@eventespresso.com', 'Lorenzo Caum' ); ?>
+			<?php echo esp_gravatar_image('lorenzo@eventespresso.com', 'Lorenzo Caum'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('lorenzo@eventespresso.com'); ?>">
 			Lorenzo Caum
@@ -89,7 +89,7 @@ 
 </ul>
 <h3 class="wp-people-group"><?php _e('Contributor Recognition', 'event_espresso'); ?></h3>
 <p class="description">
-	<?php printf( __('For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.', 'event_espresso'), '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub">', '</a>' ); ?>
+	<?php printf(__('For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.', 'event_espresso'), '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub">', '</a>'); ?>
 </p>
 <p class="wp-credits-list">
 	<ul>
@@ -103,7 +103,7 @@ 
 </p>
 <h3 class="wp-people-group"><?php _e('External Libraries', 'event_espresso'); ?></h3>
 <p class="description">
-	<?php printf( __('Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:', 'event_espresso'), '<a href="credits.php">', '</a>' ); ?>
+	<?php printf(__('Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:', 'event_espresso'), '<a href="credits.php">', '</a>'); ?>
 </p>
 <p class="wp-credits-list">
 	<a href="http://josscrowcroft.github.io/accounting.js/"><?php _e('accounting.js', 'event_espresso'); ?></a>,
@@ -119,10 +119,10 @@ 
 
 <?php
 	function esp_gravatar_profile($email) {
-		echo 'http://www.gravatar.com/' . md5($email);
+		echo 'http://www.gravatar.com/'.md5($email);
 	}
 
 	function esp_gravatar_image($email, $name) {
-		echo '<img src="http://0.gravatar.com/avatar/' . md5($email) . '?s=60" class="gravatar" alt="' . $name . '"/>';
+		echo '<img src="http://0.gravatar.com/avatar/'.md5($email).'?s=60" class="gravatar" alt="'.$name.'"/>';
 	}
 ?>

core/helpers/EEH_Line_Item.helper.php

Indentation +1698 added lines, -1698 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (!defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -23,1703 +23,1703 @@ 
 class EEH_Line_Item
 {
 
-    //other functions: cancel ticket purchase
-    //delete ticket purchase
-    //add promotion
-
-
-    /**
-     * Adds a simple item (unrelated to any other model object) to the provided PARENT line item.
-     * Does NOT automatically re-calculate the line item totals or update the related transaction.
-     * You should call recalculate_total_including_taxes() on the grant total line item after this
-     * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param string $name
-     * @param float $unit_price
-     * @param string $description
-     * @param int $quantity
-     * @param boolean $taxable
-     * @param boolean $code if set to a value, ensures there is only one line item with that code
-     * @return boolean success
-     * @throws \EE_Error
-     */
-    public static function add_unrelated_item(EE_Line_Item $parent_line_item, $name, $unit_price, $description = '', $quantity = 1, $taxable = FALSE, $code = NULL)
-    {
-        $items_subtotal = self::get_pre_tax_subtotal($parent_line_item);
-        $line_item = EE_Line_Item::new_instance(array(
-            'LIN_name' => $name,
-            'LIN_desc' => $description,
-            'LIN_unit_price' => $unit_price,
-            'LIN_quantity' => $quantity,
-            'LIN_percent' => null,
-            'LIN_is_taxable' => $taxable,
-            'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0,
-            'LIN_total' => (float)$unit_price * (int)$quantity,
-            'LIN_type' => EEM_Line_Item::type_line_item,
-            'LIN_code' => $code,
-        ));
-        $line_item = apply_filters(
-            'FHEE__EEH_Line_Item__add_unrelated_item__line_item',
-            $line_item,
-            $parent_line_item
-        );
-        return self::add_item($parent_line_item, $line_item);
-    }
-
-
-    /**
-     * Adds a simple item ( unrelated to any other model object) to the total line item,
-     * in the correct spot in the line item tree. Automatically
-     * re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param string $name
-     * @param float $percentage_amount
-     * @param string $description
-     * @param boolean $taxable
-     * @return boolean success
-     * @throws \EE_Error
-     */
-    public static function add_percentage_based_item(EE_Line_Item $parent_line_item, $name, $percentage_amount, $description = '', $taxable = FALSE)
-    {
-        $line_item = EE_Line_Item::new_instance(array(
-            'LIN_name' => $name,
-            'LIN_desc' => $description,
-            'LIN_unit_price' => 0,
-            'LIN_percent' => $percentage_amount,
-            'LIN_quantity' => 1,
-            'LIN_is_taxable' => $taxable,
-            'LIN_total' => (float)($percentage_amount * ($parent_line_item->total() / 100)),
-            'LIN_type' => EEM_Line_Item::type_line_item,
-            'LIN_parent' => $parent_line_item->ID()
-        ));
-        $line_item = apply_filters(
-            'FHEE__EEH_Line_Item__add_percentage_based_item__line_item',
-            $line_item
-        );
-        return $parent_line_item->add_child_line_item($line_item, false);
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     * ensures that ticket line item is saved, and that cart total has been recalculated.
-     * If this ticket has already been purchased, just increments its count.
-     * Automatically re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $total_line_item grand total line item of type EEM_Line_Item::type_total
-     * @param EE_Ticket $ticket
-     * @param int $qty
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
-    {
-        if (!$total_line_item instanceof EE_Line_Item || !$total_line_item->is_total()) {
-            throw new EE_Error(sprintf(__('A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', 'event_espresso'), $ticket->ID(), $total_line_item->ID()));
-        }
-        // either increment the qty for an existing ticket
-        $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
-        // or add a new one
-        if (!$line_item instanceof EE_Line_Item) {
-            $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
-        }
-        $total_line_item->recalculate_total_including_taxes();
-        return $line_item;
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     * @param \EE_Line_Item $total_line_item
-     * @param EE_Ticket $ticket
-     * @param int $qty
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function increment_ticket_qty_if_already_in_cart(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
-    {
-        $line_item = null;
-        if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-            foreach ((array)$ticket_line_items as $ticket_line_item) {
-                if (
-                    $ticket_line_item instanceof EE_Line_Item
-                    && (int)$ticket_line_item->OBJ_ID() === (int)$ticket->ID()
-                ) {
-                    $line_item = $ticket_line_item;
-                    break;
-                }
-            }
-        }
-        if ($line_item instanceof EE_Line_Item) {
-            EEH_Line_Item::increment_quantity($line_item, $qty);
-            return $line_item;
-        }
-        return null;
-    }
-
-
-    /**
-     * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected).
-     * Does NOT save or recalculate other line items totals
-     *
-     * @param EE_Line_Item $line_item
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function increment_quantity(EE_Line_Item $line_item, $qty = 1)
-    {
-        if (!$line_item->is_percent()) {
-            $qty += $line_item->quantity();
-            $line_item->set_quantity($qty);
-            $line_item->set_total($line_item->unit_price() * $qty);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $qty);
-            }
-        }
-    }
-
-
-    /**
-     * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected).
-     * Does NOT save or recalculate other line items totals
-     *
-     * @param EE_Line_Item $line_item
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1)
-    {
-        if (!$line_item->is_percent()) {
-            $qty = $line_item->quantity() - $qty;
-            $qty = max($qty, 0);
-            $line_item->set_quantity($qty);
-            $line_item->set_total($line_item->unit_price() * $qty);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $qty);
-            }
-        }
-    }
-
-
-    /**
-     * Updates the line item and its children's quantities to the specified number.
-     * Does NOT save them or recalculate totals.
-     *
-     * @param EE_Line_Item $line_item
-     * @param int $new_quantity
-     * @throws \EE_Error
-     */
-    public static function update_quantity(EE_Line_Item $line_item, $new_quantity)
-    {
-        if (!$line_item->is_percent()) {
-            $line_item->set_quantity($new_quantity);
-            $line_item->set_total($line_item->unit_price() * $new_quantity);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $new_quantity);
-            }
-        }
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @param EE_Ticket $ticket
-     * @param int $qty
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
-    {
-        $datetimes = $ticket->datetimes();
-        $first_datetime = reset($datetimes);
-        if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) {
-            $first_datetime_name = $first_datetime->event()->name();
-        } else {
-            $first_datetime_name = __('Event', 'event_espresso');
-        }
-        $event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name);
-        // get event subtotal line
-        $events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket);
-        // add $ticket to cart
-        $line_item = EE_Line_Item::new_instance(array(
-            'LIN_name' => $ticket->name(),
-            'LIN_desc' => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
-            'LIN_unit_price' => $ticket->price(),
-            'LIN_quantity' => $qty,
-            'LIN_is_taxable' => $ticket->taxable(),
-            'LIN_order' => count($events_sub_total->children()),
-            'LIN_total' => $ticket->price() * $qty,
-            'LIN_type' => EEM_Line_Item::type_line_item,
-            'OBJ_ID' => $ticket->ID(),
-            'OBJ_type' => 'Ticket'
-        ));
-        $line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
-            $line_item
-        );
-        $events_sub_total->add_child_line_item($line_item);
-        //now add the sub-line items
-        $running_total_for_ticket = 0;
-        foreach ($ticket->prices(array('order_by' => array('PRC_order' => 'ASC'))) as $price) {
-            $sign = $price->is_discount() ? -1 : 1;
-            $price_total = $price->is_percent()
-                ? $running_total_for_ticket * $price->amount() / 100
-                : $price->amount() * $qty;
-            $sub_line_item = EE_Line_Item::new_instance(array(
-                'LIN_name' => $price->name(),
-                'LIN_desc' => $price->desc(),
-                'LIN_quantity' => $price->is_percent() ? null : $qty,
-                'LIN_is_taxable' => false,
-                'LIN_order' => $price->order(),
-                'LIN_total' => $sign * $price_total,
-                'LIN_type' => EEM_Line_Item::type_sub_line_item,
-                'OBJ_ID' => $price->ID(),
-                'OBJ_type' => 'Price'
-            ));
-            $sub_line_item = apply_filters(
-                'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
-                $sub_line_item
-            );
-            if ($price->is_percent()) {
-                $sub_line_item->set_percent($sign * $price->amount());
-            } else {
-                $sub_line_item->set_unit_price($sign * $price->amount());
-            }
-            $running_total_for_ticket += $price_total;
-            $line_item->add_child_line_item($sub_line_item);
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Adds the specified item under the pre-tax-sub-total line item. Automatically
-     * re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Line_Item $item to be added
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item)
-    {
-        $pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item);
-        if ($pre_tax_subtotal instanceof EE_Line_Item) {
-            $success = $pre_tax_subtotal->add_child_line_item($item);
-        } else {
-            return FALSE;
-        }
-        $total_line_item->recalculate_total_including_taxes();
-        return $success;
-    }
-
-
-    /**
-     * cancels an existing ticket line item,
-     * by decrementing it's quantity by 1 and adding a new "type_cancellation" sub-line-item.
-     * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
-     *
-     * @param EE_Line_Item $ticket_line_item
-     * @param int $qty
-     * @return bool success
-     * @throws \EE_Error
-     */
-    public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1)
-    {
-        // validate incoming line_item
-        if ($ticket_line_item->OBJ_type() !== 'Ticket') {
-            throw new EE_Error(
-                sprintf(
-                    __('The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso'),
-                    $ticket_line_item->type()
-                )
-            );
-        }
-        if ($ticket_line_item->quantity() < $qty) {
-            throw new EE_Error(
-                sprintf(
-                    __('Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', 'event_espresso'),
-                    $qty,
-                    $ticket_line_item->quantity()
-                )
-            );
-        }
-        // decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this
-        $ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty);
-        foreach ($ticket_line_item->children() as $child_line_item) {
-            if (
-                $child_line_item->is_sub_line_item()
-                && !$child_line_item->is_percent()
-                && !$child_line_item->is_cancellation()
-            ) {
-                $child_line_item->set_quantity($child_line_item->quantity() - $qty);
-            }
-        }
-        // get cancellation sub line item
-        $cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
-            $ticket_line_item,
-            EEM_Line_Item::type_cancellation
-        );
-        $cancellation_line_item = reset($cancellation_line_item);
-        // verify that this ticket was indeed previously cancelled
-        if ($cancellation_line_item instanceof EE_Line_Item) {
-            // increment cancelled quantity
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty);
-        } else {
-            // create cancellation sub line item
-            $cancellation_line_item = EE_Line_Item::new_instance(array(
-                'LIN_name' => __('Cancellation', 'event_espresso'),
-                'LIN_desc' => sprintf(
-                    _x('Cancelled %1$s : %2$s', 'Cancelled Ticket Name : 2015-01-01 11:11', 'event_espresso'),
-                    $ticket_line_item->name(),
-                    current_time(get_option('date_format') . ' ' . get_option('time_format'))
-                ),
-                'LIN_unit_price' => 0, // $ticket_line_item->unit_price()
-                'LIN_quantity' => $qty,
-                'LIN_is_taxable' => $ticket_line_item->is_taxable(),
-                'LIN_order' => count($ticket_line_item->children()),
-                'LIN_total' => 0, // $ticket_line_item->unit_price()
-                'LIN_type' => EEM_Line_Item::type_cancellation,
-            ));
-            $ticket_line_item->add_child_line_item($cancellation_line_item);
-        }
-        if ($ticket_line_item->save_this_and_descendants() > 0) {
-            // decrement parent line item quantity
-            $event_line_item = $ticket_line_item->parent();
-            if ($event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event') {
-                $event_line_item->set_quantity($event_line_item->quantity() - $qty);
-                $event_line_item->save();
-            }
-            EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * reinstates (un-cancels?) a previously canceled ticket line item,
-     * by incrementing it's quantity by 1, and decrementing it's "type_cancellation" sub-line-item.
-     * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
-     *
-     * @param EE_Line_Item $ticket_line_item
-     * @param int $qty
-     * @return bool success
-     * @throws \EE_Error
-     */
-    public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1)
-    {
-        // validate incoming line_item
-        if ($ticket_line_item->OBJ_type() !== 'Ticket') {
-            throw new EE_Error(
-                sprintf(
-                    __('The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso'),
-                    $ticket_line_item->type()
-                )
-            );
-        }
-        // get cancellation sub line item
-        $cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
-            $ticket_line_item,
-            EEM_Line_Item::type_cancellation
-        );
-        $cancellation_line_item = reset($cancellation_line_item);
-        // verify that this ticket was indeed previously cancelled
-        if (!$cancellation_line_item instanceof EE_Line_Item) {
-            return false;
-        }
-        if ($cancellation_line_item->quantity() > $qty) {
-            // decrement cancelled quantity
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
-        } else if ($cancellation_line_item->quantity() == $qty) {
-            // decrement cancelled quantity in case anyone still has the object kicking around
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
-            // delete because quantity will end up as 0
-            $cancellation_line_item->delete();
-            // and attempt to destroy the object,
-            // even though PHP won't actually destroy it until it needs the memory
-            unset($cancellation_line_item);
-        } else {
-            // what ?!?! negative quantity ?!?!
-            throw new EE_Error(
-                sprintf(
-                    __('Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
-                        'event_espresso'),
-                    $qty,
-                    $cancellation_line_item->quantity()
-                )
-            );
-        }
-        // increment ticket quantity
-        $ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty);
-        if ($ticket_line_item->save_this_and_descendants() > 0) {
-            // increment parent line item quantity
-            $event_line_item = $ticket_line_item->parent();
-            if ($event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event') {
-                $event_line_item->set_quantity($event_line_item->quantity() + $qty);
-            }
-            EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * calls EEH_Line_Item::find_transaction_grand_total_for_line_item()
-     * then EE_Line_Item::recalculate_total_including_taxes() on the result
-     *
-     * @param EE_Line_Item $line_item
-     * @return \EE_Line_Item
-     */
-    public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item)
-    {
-        $grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item);
-        return $grand_total_line_item->recalculate_total_including_taxes();
-    }
-
-
-    /**
-     * Gets the line item which contains the subtotal of all the items
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item)
-    {
-        $pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal');
-        return $pre_tax_subtotal instanceof EE_Line_Item
-            ? $pre_tax_subtotal
-            : self::create_pre_tax_subtotal($total_line_item);
-    }
-
-
-    /**
-     * Gets the line item for the taxes subtotal
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function get_taxes_subtotal(EE_Line_Item $total_line_item)
-    {
-        $taxes = $total_line_item->get_child_line_item('taxes');
-        return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item);
-    }
-
-
-    /**
-     * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object
-     *
-     * @param EE_Line_Item $line_item
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = NULL)
-    {
-        if ($transaction) {
-            /** @type EEM_Transaction $EEM_Transaction */
-            $EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
-            $TXN_ID = $EEM_Transaction->ensure_is_ID($transaction);
-            $line_item->set_TXN_ID($TXN_ID);
-        }
-    }
-
-
-    /**
-     * Creates a new default total line item for the transaction,
-     * and its tickets subtotal and taxes subtotal line items (and adds the
-     * existing taxes as children of the taxes subtotal line item)
-     *
-     * @param EE_Transaction $transaction
-     * @return \EE_Line_Item of type total
-     * @throws \EE_Error
-     */
-    public static function create_total_line_item($transaction = NULL)
-    {
-        $total_line_item = EE_Line_Item::new_instance(array(
-            'LIN_code' => 'total',
-            'LIN_name' => __('Grand Total', 'event_espresso'),
-            'LIN_type' => EEM_Line_Item::type_total,
-            'OBJ_type' => 'Transaction'
-        ));
-        $total_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_total_line_item__total_line_item',
-            $total_line_item
-        );
-        self::set_TXN_ID($total_line_item, $transaction);
-        self::create_pre_tax_subtotal($total_line_item, $transaction);
-        self::create_taxes_subtotal($total_line_item, $transaction);
-        return $total_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
-    {
-        $pre_tax_line_item = EE_Line_Item::new_instance(array(
-            'LIN_code' => 'pre-tax-subtotal',
-            'LIN_name' => __('Pre-Tax Subtotal', 'event_espresso'),
-            'LIN_type' => EEM_Line_Item::type_sub_total
-        ));
-        $pre_tax_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item',
-            $pre_tax_line_item
-        );
-        self::set_TXN_ID($pre_tax_line_item, $transaction);
-        $total_line_item->add_child_line_item($pre_tax_line_item);
-        self::create_event_subtotal($pre_tax_line_item, $transaction);
-        return $pre_tax_line_item;
-    }
-
-
-    /**
-     * Creates a line item for the taxes subtotal and finds all the tax prices
-     * and applies taxes to it
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
-    {
-        $tax_line_item = EE_Line_Item::new_instance(array(
-            'LIN_code' => 'taxes',
-            'LIN_name' => __('Taxes', 'event_espresso'),
-            'LIN_type' => EEM_Line_Item::type_tax_sub_total,
-            'LIN_order' => 1000,//this should always come last
-        ));
-        $tax_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
-            $tax_line_item
-        );
-        self::set_TXN_ID($tax_line_item, $transaction);
-        $total_line_item->add_child_line_item($tax_line_item);
-        //and lastly, add the actual taxes
-        self::apply_taxes($total_line_item);
-        return $tax_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item $pre_tax_line_item
-     * @param EE_Transaction $transaction
-     * @param EE_Event $event
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = NULL, $event = NULL)
-    {
-        $event_line_item = EE_Line_Item::new_instance(array(
-            'LIN_code' => self::get_event_code($event),
-            'LIN_name' => self::get_event_name($event),
-            'LIN_desc' => self::get_event_desc($event),
-            'LIN_type' => EEM_Line_Item::type_sub_total,
-            'OBJ_type' => 'Event',
-            'OBJ_ID' => $event instanceof EE_Event ? $event->ID() : 0
-        ));
-        $event_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item',
-            $event_line_item
-        );
-        self::set_TXN_ID($event_line_item, $transaction);
-        $pre_tax_line_item->add_child_line_item($event_line_item);
-        return $event_line_item;
-    }
-
-
-    /**
-     * Gets what the event ticket's code SHOULD be
-     *
-     * @param EE_Event $event
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function get_event_code($event)
-    {
-        return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
-    }
-
-    /**
-     * Gets the event name
-     * @param EE_Event $event
-     * @return string
-     */
-    public static function get_event_name($event)
-    {
-        return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
-    }
-
-    /**
-     * Gets the event excerpt
-     * @param EE_Event $event
-     * @return string
-     */
-    public static function get_event_desc($event)
-    {
-        return $event instanceof EE_Event ? $event->short_description() : '';
-    }
-
-    /**
-     * Given the grand total line item and a ticket, finds the event sub-total
-     * line item the ticket's purchase should be added onto
-     *
-     * @access public
-     * @param EE_Line_Item $grand_total the grand total line item
-     * @param EE_Ticket $ticket
-     * @throws \EE_Error
-     * @return EE_Line_Item
-     */
-    public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket)
-    {
-        $first_datetime = $ticket->first_datetime();
-        if (!$first_datetime instanceof EE_Datetime) {
-            throw new EE_Error(
-                sprintf(__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), $ticket->ID())
-            );
-        }
-        $event = $first_datetime->event();
-        if (!$event instanceof EE_Event) {
-            throw new EE_Error(
-                sprintf(
-                    __('The supplied ticket (ID %d) has no event data associated with it.', 'event_espresso'),
-                    $ticket->ID()
-                )
-            );
-        }
-        $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
-        if (!$events_sub_total instanceof EE_Line_Item) {
-            throw new EE_Error(
-                sprintf(
-                    __('There is no events sub-total for ticket %s on total line item %d', 'event_espresso'),
-                    $ticket->ID(),
-                    $grand_total->ID()
-                )
-            );
-        }
-        return $events_sub_total;
-    }
-
-
-    /**
-     * Gets the event line item
-     *
-     * @param EE_Line_Item $grand_total
-     * @param EE_Event $event
-     * @return EE_Line_Item for the event subtotal which is a child of $grand_total
-     * @throws \EE_Error
-     */
-    public static function get_event_line_item(EE_Line_Item $grand_total, $event)
-    {
-        /** @type EE_Event $event */
-        $event = EEM_Event::instance()->ensure_is_obj($event, true);
-        $event_line_item = NULL;
-        $found = false;
-        foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) {
-            // default event subtotal, we should only ever find this the first time this method is called
-            if (!$event_line_item->OBJ_ID()) {
-                // let's use this! but first... set the event details
-                EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
-                $found = true;
-                break;
-            } else if ($event_line_item->OBJ_ID() === $event->ID()) {
-                // found existing line item for this event in the cart, so break out of loop and use this one
-                $found = true;
-                break;
-            }
-        }
-        if (!$found) {
-            //there is no event sub-total yet, so add it
-            $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total);
-            // create a new "event" subtotal below that
-            $event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event);
-            // and set the event details
-            EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
-        }
-        return $event_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item $event_line_item
-     * @param EE_Event $event
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function set_event_subtotal_details(
-        EE_Line_Item $event_line_item,
-        EE_Event $event,
-        $transaction = null
-    )
-    {
-        if ($event instanceof EE_Event) {
-            $event_line_item->set_code(self::get_event_code($event));
-            $event_line_item->set_name(self::get_event_name($event));
-            $event_line_item->set_desc(self::get_event_desc($event));
-            $event_line_item->set_OBJ_ID($event->ID());
-        }
-        self::set_TXN_ID($event_line_item, $transaction);
-    }
-
-
-    /**
-     * Finds what taxes should apply, adds them as tax line items under the taxes sub-total,
-     * and recalculates the taxes sub-total and the grand total. Resets the taxes, so
-     * any old taxes are removed
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @throws \EE_Error
-     */
-    public static function apply_taxes(EE_Line_Item $total_line_item)
-    {
-        /** @type EEM_Price $EEM_Price */
-        $EEM_Price = EE_Registry::instance()->load_model('Price');
-        // get array of taxes via Price Model
-        $ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes();
-        ksort($ordered_taxes);
-        $taxes_line_item = self::get_taxes_subtotal($total_line_item);
-        //just to be safe, remove its old tax line items
-        $taxes_line_item->delete_children_line_items();
-        //loop thru taxes
-        foreach ($ordered_taxes as $order => $taxes) {
-            foreach ($taxes as $tax) {
-                if ($tax instanceof EE_Price) {
-                    $tax_line_item = EE_Line_Item::new_instance(
-                        array(
-                            'LIN_name' => $tax->name(),
-                            'LIN_desc' => $tax->desc(),
-                            'LIN_percent' => $tax->amount(),
-                            'LIN_is_taxable' => false,
-                            'LIN_order' => $order,
-                            'LIN_total' => 0,
-                            'LIN_type' => EEM_Line_Item::type_tax,
-                            'OBJ_type' => 'Price',
-                            'OBJ_ID' => $tax->ID()
-                        )
-                    );
-                    $tax_line_item = apply_filters(
-                        'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
-                        $tax_line_item
-                    );
-                    $taxes_line_item->add_child_line_item($tax_line_item);
-                }
-            }
-        }
-        $total_line_item->recalculate_total_including_taxes();
-    }
-
-
-    /**
-     * Ensures that taxes have been applied to the order, if not applies them.
-     * Returns the total amount of tax
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return float
-     * @throws \EE_Error
-     */
-    public static function ensure_taxes_applied($total_line_item)
-    {
-        $taxes_subtotal = self::get_taxes_subtotal($total_line_item);
-        if (!$taxes_subtotal->children()) {
-            self::apply_taxes($total_line_item);
-        }
-        return $taxes_subtotal->total();
-    }
-
-
-    /**
-     * Deletes ALL children of the passed line item
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return bool
-     * @throws \EE_Error
-     */
-    public static function delete_all_child_items(EE_Line_Item $parent_line_item)
-    {
-        $deleted = 0;
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $deleted += EEH_Line_Item::delete_all_child_items($child_line_item);
-                if ($child_line_item->ID()) {
-                    $child_line_item->delete();
-                    unset($child_line_item);
-                } else {
-                    $parent_line_item->delete_child_line_item($child_line_item->code());
-                }
-                $deleted++;
-            }
-        }
-        return $deleted;
-    }
-
-
-    /**
-     * Deletes the line items as indicated by the line item code(s) provided,
-     * regardless of where they're found in the line item tree. Automatically
-     * re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @param array|bool|string $line_item_codes
-     * @return int number of items successfully removed
-     */
-    public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = FALSE)
-    {
-
-        if ($total_line_item->type() !== EEM_Line_Item::type_total) {
-            EE_Error::doing_it_wrong(
-                'EEH_Line_Item::delete_items',
-                __(
-                    'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly',
-                    'event_espresso'
-                ),
-                '4.6.18'
-            );
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        // check if only a single line_item_id was passed
-        if (!empty($line_item_codes) && !is_array($line_item_codes)) {
-            // place single line_item_id in an array to appear as multiple line_item_ids
-            $line_item_codes = array($line_item_codes);
-        }
-        $removals = 0;
-        // cycle thru line_item_ids
-        foreach ($line_item_codes as $line_item_id) {
-            $removals += $total_line_item->delete_child_line_item($line_item_id);
-        }
-
-        if ($removals > 0) {
-            $total_line_item->recalculate_taxes_and_tax_total();
-            return $removals;
-        } else {
-            return FALSE;
-        }
-    }
-
-
-    /**
-     * Overwrites the previous tax by clearing out the old taxes, and creates a new
-     * tax and updates the total line item accordingly
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param float $amount
-     * @param string $name
-     * @param string $description
-     * @param string $code
-     * @param boolean $add_to_existing_line_item
-     *                          if true, and a duplicate line item with the same code is found,
-     *                          $amount will be added onto it; otherwise will simply set the taxes to match $amount
-     * @return EE_Line_Item the new tax line item created
-     * @throws \EE_Error
-     */
-    public static function set_total_tax_to(
-        EE_Line_Item $total_line_item,
-        $amount,
-        $name = null,
-        $description = null,
-        $code = null,
-        $add_to_existing_line_item = false
-    )
-    {
-        $tax_subtotal = self::get_taxes_subtotal($total_line_item);
-        $taxable_total = $total_line_item->taxable_total();
-
-        if ($add_to_existing_line_item) {
-            $new_tax = $tax_subtotal->get_child_line_item($code);
-            EEM_Line_Item::instance()->delete(
-                array(array('LIN_code' => array('!=', $code), 'LIN_parent' => $tax_subtotal->ID()))
-            );
-        } else {
-            $new_tax = null;
-            $tax_subtotal->delete_children_line_items();
-        }
-        if ($new_tax) {
-            $new_tax->set_total($new_tax->total() + $amount);
-            $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0);
-        } else {
-            //no existing tax item. Create it
-            $new_tax = EE_Line_Item::new_instance(array(
-                'TXN_ID' => $total_line_item->TXN_ID(),
-                'LIN_name' => $name ? $name : __('Tax', 'event_espresso'),
-                'LIN_desc' => $description ? $description : '',
-                'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0,
-                'LIN_total' => $amount,
-                'LIN_parent' => $tax_subtotal->ID(),
-                'LIN_type' => EEM_Line_Item::type_tax,
-                'LIN_code' => $code
-            ));
-        }
-
-        $new_tax = apply_filters(
-            'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal',
-            $new_tax,
-            $total_line_item
-        );
-        $new_tax->save();
-        $tax_subtotal->set_total($new_tax->total());
-        $tax_subtotal->save();
-        $total_line_item->recalculate_total_including_taxes();
-        return $new_tax;
-    }
-
-
-    /**
-     * Makes all the line items which are children of $line_item taxable (or not).
-     * Does NOT save the line items
-     * @param EE_Line_Item $line_item
-     * @param string $code_substring_for_whitelist if this string is part of the line item's code
-     *  it will be whitelisted (ie, except from becoming taxable)
-     * @param boolean $taxable
-     */
-    public static function set_line_items_taxable(
-        EE_Line_Item $line_item,
-        $taxable = true,
-        $code_substring_for_whitelist = null
-    )
-    {
-        $whitelisted = false;
-        if ($code_substring_for_whitelist !== null) {
-            $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false ? true : false;
-        }
-        if (!$whitelisted && $line_item->is_line_item()) {
-            $line_item->set_is_taxable($taxable);
-        }
-        foreach ($line_item->children() as $child_line_item) {
-            EEH_Line_Item::set_line_items_taxable($child_line_item, $taxable, $code_substring_for_whitelist);
-        }
-    }
-
-
-    /**
-     * Gets all descendants that are event subtotals
-     *
-     * @uses  EEH_Line_Item::get_subtotals_of_object_type()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     */
-    public static function get_event_subtotals(EE_Line_Item $parent_line_item)
-    {
-        return self::get_subtotals_of_object_type($parent_line_item, 'Event');
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $obj_type
-     * @return EE_Line_Item[]
-     */
-    public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '')
-    {
-        return self::_get_descendants_by_type_and_object_type(
-            $parent_line_item,
-            EEM_Line_Item::type_sub_total,
-            $obj_type
-        );
-    }
-
-
-    /**
-     * Gets all descendants that are tickets
-     *
-     * @uses  EEH_Line_Item::get_line_items_of_object_type()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     */
-    public static function get_ticket_line_items(EE_Line_Item $parent_line_item)
-    {
-        return self::get_line_items_of_object_type($parent_line_item, 'Ticket');
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $obj_type
-     * @return EE_Line_Item[]
-     */
-    public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '')
-    {
-        return self::_get_descendants_by_type_and_object_type($parent_line_item, EEM_Line_Item::type_line_item, $obj_type);
-    }
-
-
-    /**
-     * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax'
-     * @uses  EEH_Line_Item::get_descendants_of_type()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     */
-    public static function get_tax_descendants(EE_Line_Item $parent_line_item)
-    {
-        return EEH_Line_Item::get_descendants_of_type($parent_line_item, EEM_Line_Item::type_tax);
-    }
-
-
-    /**
-     * Gets all the real items purchased which are children of this item
-     * @uses  EEH_Line_Item::get_descendants_of_type()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     */
-    public static function get_line_item_descendants(EE_Line_Item $parent_line_item)
-    {
-        return EEH_Line_Item::get_descendants_of_type($parent_line_item, EEM_Line_Item::type_line_item);
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type
-     *
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $line_item_type one of the EEM_Line_Item constants
-     * @return EE_Line_Item[]
-     */
-    public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type)
-    {
-        return self::_get_descendants_by_type_and_object_type($parent_line_item, $line_item_type, NULL);
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type as well
-     *
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $line_item_type one of the EEM_Line_Item constants
-     * @param string | NULL $obj_type object model class name (minus prefix) or NULL to ignore object type when searching
-     * @return EE_Line_Item[]
-     */
-    protected static function _get_descendants_by_type_and_object_type(
-        EE_Line_Item $parent_line_item,
-        $line_item_type,
-        $obj_type = null
-    )
-    {
-        $objects = array();
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                if (
-                    $child_line_item->type() === $line_item_type
-                    && (
-                        $child_line_item->OBJ_type() === $obj_type || $obj_type === null
-                    )
-                ) {
-                    $objects[] = $child_line_item;
-                } else {
-                    //go-through-all-its children looking for more matches
-                    $objects = array_merge(
-                        $objects,
-                        self::_get_descendants_by_type_and_object_type(
-                            $child_line_item,
-                            $line_item_type,
-                            $obj_type
-                        )
-                    );
-                }
-            }
-        }
-        return $objects;
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $OBJ_type object type (like Event)
-     * @param array $OBJ_IDs array of OBJ_IDs
-     * @return EE_Line_Item[]
-     */
-    public static function get_line_items_by_object_type_and_IDs(
-        EE_Line_Item $parent_line_item,
-        $OBJ_type = '',
-        $OBJ_IDs = array()
-    )
-    {
-        return self::_get_descendants_by_object_type_and_object_ID($parent_line_item, $OBJ_type, $OBJ_IDs);
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type as well
-     *
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $OBJ_type object type (like Event)
-     * @param array $OBJ_IDs array of OBJ_IDs
-     * @return EE_Line_Item[]
-     */
-    protected static function _get_descendants_by_object_type_and_object_ID(
-        EE_Line_Item $parent_line_item,
-        $OBJ_type,
-        $OBJ_IDs
-    )
-    {
-        $objects = array();
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                if (
-                    $child_line_item->OBJ_type() === $OBJ_type
-                    && is_array($OBJ_IDs)
-                    && in_array($child_line_item->OBJ_ID(), $OBJ_IDs)
-                ) {
-                    $objects[] = $child_line_item;
-                } else {
-                    //go-through-all-its children looking for more matches
-                    $objects = array_merge(
-                        $objects,
-                        self::_get_descendants_by_object_type_and_object_ID(
-                            $child_line_item,
-                            $OBJ_type,
-                            $OBJ_IDs
-                        )
-                    );
-                }
-            }
-        }
-        return $objects;
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant of
-     * the specified type and returns it, else NULL
-     *
-     * @uses  EEH_Line_Item::_get_nearest_descendant()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $type like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     */
-    public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type)
-    {
-        return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type);
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant
-     * having the specified LIN_code and returns it, else NULL
-     *
-     * @uses  EEH_Line_Item::_get_nearest_descendant()
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $code any value used for LIN_code
-     * @return EE_Line_Item
-     */
-    public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code)
-    {
-        return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code);
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant
-     * having the specified LIN_code and returns it, else NULL
-     *
-     * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string $search_field name of EE_Line_Item property
-     * @param string $value any value stored in $search_field
-     * @return EE_Line_Item
-     */
-    protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value)
-    {
-        foreach ($parent_line_item->children() as $child) {
-            if ($child->get($search_field) == $value) {
-                return $child;
-            }
-        }
-        foreach ($parent_line_item->children() as $child) {
-            $descendant_found = self::_get_nearest_descendant($child, $search_field, $value);
-            if ($descendant_found) {
-                return $descendant_found;
-            }
-        }
-        return NULL;
-    }
-
-
-    /**
-     * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction,
-     * else recursively walks up the line item tree until a parent of type total is found,
-     *
-     * @param EE_Line_Item $line_item
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item)
-    {
-        if ($line_item->TXN_ID()) {
-            $total_line_item = $line_item->transaction()->total_line_item(false);
-            if ($total_line_item instanceof EE_Line_Item) {
-                return $total_line_item;
-            }
-        } else {
-            $line_item_parent = $line_item->parent();
-            if ($line_item_parent instanceof EE_Line_Item) {
-                if ($line_item_parent->is_total()) {
-                    return $line_item_parent;
-                }
-                return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent);
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                __('A valid grand total for line item %1$d was not found.', 'event_espresso'),
-                $line_item->ID()
-            )
-        );
-    }
-
-
-    /**
-     * Prints out a representation of the line item tree
-     *
-     * @param EE_Line_Item $line_item
-     * @param int $indentation
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function visualize(EE_Line_Item $line_item, $indentation = 0)
-    {
-        echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
-        if (!$indentation) {
-            echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
-        }
-        for ($i = 0; $i < $indentation; $i++) {
-            echo ". ";
-        }
-        $breakdown = '';
-        if ($line_item->is_line_item()) {
-            if ($line_item->is_percent()) {
-                $breakdown = "{$line_item->percent()}%";
-            } else {
-                $breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}";
-            }
-        }
-        echo $line_item->name() . " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : " . '$' . "{$line_item->total()}";
-        if ($breakdown) {
-            echo " ( {$breakdown} )";
-        }
-        if ($line_item->is_taxable()) {
-            echo "  * taxable";
-        }
-        if ($line_item->children()) {
-            foreach ($line_item->children() as $child) {
-                self::visualize($child, $indentation + 1);
-            }
-        }
-    }
-
-
-    /**
-     * Calculates the registration's final price, taking into account that they
-     * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes,
-     * and receive a portion of any transaction-wide discounts.
-     * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount
-     * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get
-     * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50
-     * and brent's final price should be $5.50.
-     *
-     * In order to do this, we basically need to traverse the line item tree calculating
-     * the running totals (just as if we were recalculating the total), but when we identify
-     * regular line items, we need to keep track of their share of the grand total.
-     * Also, we need to keep track of the TAXABLE total for each ticket purchase, so
-     * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total"
-     * when there are non-taxable items; otherwise they would be the same)
-     *
-     * @param EE_Line_Item $line_item
-     * @param array $billable_ticket_quantities array of EE_Ticket IDs and their corresponding quantity that
-     *                                                                            can be included in price calculations at this moment
-     * @return array        keys are line items for tickets IDs and values are their share of the running total,
-     *                                          plus the key 'total', and 'taxable' which also has keys of all the ticket IDs. Eg
-     *                                          array(
-     *                                          12 => 4.3
-     *                                          23 => 8.0
-     *                                          'total' => 16.6,
-     *                                          'taxable' => array(
-     *                                          12 => 10,
-     *                                          23 => 4
-     *                                          ).
-     *                                          So to find which registrations have which final price, we need to find which line item
-     *                                          is theirs, which can be done with
-     *                                          `EEM_Line_Item::instance()->get_line_item_for_registration( $registration );`
-     */
-    public static function calculate_reg_final_prices_per_line_item(EE_Line_Item $line_item, $billable_ticket_quantities = array())
-    {
-        //init running grand total if not already
-        if (!isset($running_totals['total'])) {
-            $running_totals['total'] = 0;
-        }
-        if (!isset($running_totals['taxable'])) {
-            $running_totals['taxable'] = array('total' => 0);
-        }
-        foreach ($line_item->children() as $child_line_item) {
-            switch ($child_line_item->type()) {
-
-                case EEM_Line_Item::type_sub_total :
-                    $running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item($child_line_item, $billable_ticket_quantities);
-                    //combine arrays but preserve numeric keys
-                    $running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals);
-                    $running_totals['total'] += $running_totals_from_subtotal['total'];
-                    $running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total'];
-                    break;
-
-                case EEM_Line_Item::type_tax_sub_total :
-
-                    //find how much the taxes percentage is
-                    if ($child_line_item->percent() !== 0) {
-                        $tax_percent_decimal = $child_line_item->percent() / 100;
-                    } else {
-                        $tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100;
-                    }
-                    //and apply to all the taxable totals, and add to the pretax totals
-                    foreach ($running_totals as $line_item_id => $this_running_total) {
-                        //"total" and "taxable" array key is an exception
-                        if ($line_item_id === 'taxable') {
-                            continue;
-                        }
-                        $taxable_total = $running_totals['taxable'][$line_item_id];
-                        $running_totals[$line_item_id] += ($taxable_total * $tax_percent_decimal);
-                    }
-                    break;
-
-                case EEM_Line_Item::type_line_item :
-
-                    // ticket line items or ????
-                    if ($child_line_item->OBJ_type() === 'Ticket') {
-                        // kk it's a ticket
-                        if (isset($running_totals[$child_line_item->ID()])) {
-                            //huh? that shouldn't happen.
-                            $running_totals['total'] += $child_line_item->total();
-                        } else {
-                            //its not in our running totals yet. great.
-                            if ($child_line_item->is_taxable()) {
-                                $taxable_amount = $child_line_item->unit_price();
-                            } else {
-                                $taxable_amount = 0;
-                            }
-                            // are we only calculating totals for some tickets?
-                            if (isset($billable_ticket_quantities[$child_line_item->OBJ_ID()])) {
-                                $quantity = $billable_ticket_quantities[$child_line_item->OBJ_ID()];
-                                $running_totals[$child_line_item->ID()] = $quantity
-                                    ? $child_line_item->unit_price()
-                                    : 0;
-                                $running_totals['taxable'][$child_line_item->ID()] = $quantity
-                                    ? $taxable_amount
-                                    : 0;
-                            } else {
-                                $quantity = $child_line_item->quantity();
-                                $running_totals[$child_line_item->ID()] = $child_line_item->unit_price();
-                                $running_totals['taxable'][$child_line_item->ID()] = $taxable_amount;
-                            }
-                            $running_totals['taxable']['total'] += $taxable_amount * $quantity;
-                            $running_totals['total'] += $child_line_item->unit_price() * $quantity;
-                        }
-                    } else {
-                        // it's some other type of item added to the cart
-                        // it should affect the running totals
-                        // basically we want to convert it into a PERCENT modifier. Because
-                        // more clearly affect all registration's final price equally
-                        $line_items_percent_of_running_total = $running_totals['total'] > 0
-                            ? ($child_line_item->total() / $running_totals['total']) + 1
-                            : 1;
-                        foreach ($running_totals as $line_item_id => $this_running_total) {
-                            //the "taxable" array key is an exception
-                            if ($line_item_id === 'taxable') {
-                                continue;
-                            }
-                            // update the running totals
-                            // yes this actually even works for the running grand total!
-                            $running_totals[$line_item_id] =
-                                $line_items_percent_of_running_total * $this_running_total;
-
-                            if ($child_line_item->is_taxable()) {
-                                $running_totals['taxable'][$line_item_id] =
-                                    $line_items_percent_of_running_total * $running_totals['taxable'][$line_item_id];
-                            }
-                        }
-                    }
-                    break;
-            }
-        }
-        return $running_totals;
-    }
-
-
-    /**
-     * @param \EE_Line_Item $total_line_item
-     * @param \EE_Line_Item $ticket_line_item
-     * @return float | null
-     * @throws \OutOfRangeException
-     */
-    public static function calculate_final_price_for_ticket_line_item(\EE_Line_Item $total_line_item, \EE_Line_Item $ticket_line_item)
-    {
-        static $final_prices_per_ticket_line_item = array();
-        if (empty($final_prices_per_ticket_line_item)) {
-            $final_prices_per_ticket_line_item = \EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-                $total_line_item
-            );
-        }
-        //ok now find this new registration's final price
-        if (isset($final_prices_per_ticket_line_item[$ticket_line_item->ID()])) {
-            return $final_prices_per_ticket_line_item[$ticket_line_item->ID()];
-        }
-        $message = sprintf(
-            __(
-                'The final price for the ticket line item (ID:%1$d) could not be calculated.',
-                'event_espresso'
-            ),
-            $ticket_line_item->ID()
-        );
-        if (WP_DEBUG) {
-            $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
-            throw new \OutOfRangeException($message);
-        } else {
-            EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EE_Line_Item $line_item
-     * @param EE_Registration[] $registrations
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations)
-    {
-        $copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations);
-        foreach ($line_item->children() as $child_li) {
-            $copy_li->add_child_line_item(EEH_Line_Item::billable_line_item_tree($child_li, $registrations));
-        }
-        //if this is the grand total line item, make sure the totals all add up
-        //(we could have duplicated this logic AS we copied the line items, but
-        //it seems DRYer this way)
-        if ($copy_li->type() === EEM_Line_Item::type_total) {
-            $copy_li->recalculate_total_including_taxes();
-        }
-        return $copy_li;
-    }
-
-
-    /**
-     * Creates a new, unsaved line item from $line_item that factors in the
-     * number of billable registrations on $registrations.
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     * @param EE_Registration[] $registrations
-     */
-    public static function billable_line_item(EE_Line_Item $line_item, $registrations)
-    {
-        $new_li_fields = $line_item->model_field_array();
-        if ($line_item->type() === EEM_Line_Item::type_line_item &&
-            $line_item->OBJ_type() === 'Ticket'
-        ) {
-            $count = 0;
-            foreach ($registrations as $registration) {
-                if ($line_item->OBJ_ID() === $registration->ticket_ID() &&
-                    in_array($registration->status_ID(), EEM_Registration::reg_statuses_that_allow_payment())
-                ) {
-                    $count++;
-                }
-            }
-            $new_li_fields['LIN_quantity'] = $count;
-        }
-        //don't set the total. We'll leave that up to the code that calculates it
-        unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']);
-        return EE_Line_Item::new_instance($new_li_fields);
-    }
-
-
-    /**
-     * Returns a modified line item tree where all the subtotals which have a total of 0
-     * are removed, and line items with a quantity of 0
-     *
-     * @param EE_Line_Item $line_item |null
-     * @return \EE_Line_Item|null
-     * @throws \EE_Error
-     */
-    public static function non_empty_line_items(EE_Line_Item $line_item)
-    {
-        $copied_li = EEH_Line_Item::non_empty_line_item($line_item);
-        if ($copied_li === null) {
-            return null;
-        }
-        //if this is an event subtotal, we want to only include it if it
-        //has a non-zero total and at least one ticket line item child
-        $ticket_children = 0;
-        foreach ($line_item->children() as $child_li) {
-            $child_li_copy = EEH_Line_Item::non_empty_line_items($child_li);
-            if ($child_li_copy !== null) {
-                $copied_li->add_child_line_item($child_li_copy);
-                if ($child_li_copy->type() === EEM_Line_Item::type_line_item &&
-                    $child_li_copy->OBJ_type() === 'Ticket'
-                ) {
-                    $ticket_children++;
-                }
-            }
-        }
-        //if this is an event subtotal with NO ticket children
-        //we basically want to ignore it
-        if (
-            $ticket_children === 0
-            && $line_item->type() === EEM_Line_Item::type_sub_total
-            && $line_item->OBJ_type() === 'Event'
-            && $line_item->total() === 0
-        ) {
-            return null;
-        }
-        return $copied_li;
-    }
-
-
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function non_empty_line_item(EE_Line_Item $line_item)
-    {
-        if ($line_item->type() === EEM_Line_Item::type_line_item &&
-            $line_item->OBJ_type() === 'Ticket' &&
-            $line_item->quantity() === 0
-        ) {
-            return null;
-        }
-        $new_li_fields = $line_item->model_field_array();
-        //don't set the total. We'll leave that up to the code that calculates it
-        unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']);
-        return EE_Line_Item::new_instance($new_li_fields);
-    }
-
-
-
-    /**************************************** @DEPRECATED METHODS *************************************** */
-    /**
-     * @deprecated
-     * @param EE_Line_Item $total_line_item
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function get_items_subtotal(EE_Line_Item $total_line_item)
-    {
-        EE_Error::doing_it_wrong('EEH_Line_Item::get_items_subtotal()', __('Method replaced with EEH_Line_Item::get_pre_tax_subtotal()', 'event_espresso'), '4.6.0');
-        return self::get_pre_tax_subtotal($total_line_item);
-    }
-
-
-    /**
-     * @deprecated
-     * @param EE_Transaction $transaction
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function create_default_total_line_item($transaction = NULL)
-    {
-        EE_Error::doing_it_wrong('EEH_Line_Item::create_default_total_line_item()', __('Method replaced with EEH_Line_Item::create_total_line_item()', 'event_espresso'), '4.6.0');
-        return self::create_total_line_item($transaction);
-    }
-
-
-    /**
-     * @deprecated
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Transaction $transaction
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
-    {
-        EE_Error::doing_it_wrong('EEH_Line_Item::create_default_tickets_subtotal()', __('Method replaced with EEH_Line_Item::create_pre_tax_subtotal()', 'event_espresso'), '4.6.0');
-        return self::create_pre_tax_subtotal($total_line_item, $transaction);
-    }
-
-
-    /**
-     * @deprecated
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Transaction $transaction
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
-    {
-        EE_Error::doing_it_wrong('EEH_Line_Item::create_default_taxes_subtotal()', __('Method replaced with EEH_Line_Item::create_taxes_subtotal()', 'event_espresso'), '4.6.0');
-        return self::create_taxes_subtotal($total_line_item, $transaction);
-    }
-
-
-    /**
-     * @deprecated
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Transaction $transaction
-     * @return \EE_Line_Item
-     * @throws \EE_Error
-     */
-    public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
-    {
-        EE_Error::doing_it_wrong('EEH_Line_Item::create_default_event_subtotal()', __('Method replaced with EEH_Line_Item::create_event_subtotal()', 'event_espresso'), '4.6.0');
-        return self::create_event_subtotal($total_line_item, $transaction);
-    }
+	//other functions: cancel ticket purchase
+	//delete ticket purchase
+	//add promotion
+
+
+	/**
+	 * Adds a simple item (unrelated to any other model object) to the provided PARENT line item.
+	 * Does NOT automatically re-calculate the line item totals or update the related transaction.
+	 * You should call recalculate_total_including_taxes() on the grant total line item after this
+	 * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param string $name
+	 * @param float $unit_price
+	 * @param string $description
+	 * @param int $quantity
+	 * @param boolean $taxable
+	 * @param boolean $code if set to a value, ensures there is only one line item with that code
+	 * @return boolean success
+	 * @throws \EE_Error
+	 */
+	public static function add_unrelated_item(EE_Line_Item $parent_line_item, $name, $unit_price, $description = '', $quantity = 1, $taxable = FALSE, $code = NULL)
+	{
+		$items_subtotal = self::get_pre_tax_subtotal($parent_line_item);
+		$line_item = EE_Line_Item::new_instance(array(
+			'LIN_name' => $name,
+			'LIN_desc' => $description,
+			'LIN_unit_price' => $unit_price,
+			'LIN_quantity' => $quantity,
+			'LIN_percent' => null,
+			'LIN_is_taxable' => $taxable,
+			'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0,
+			'LIN_total' => (float)$unit_price * (int)$quantity,
+			'LIN_type' => EEM_Line_Item::type_line_item,
+			'LIN_code' => $code,
+		));
+		$line_item = apply_filters(
+			'FHEE__EEH_Line_Item__add_unrelated_item__line_item',
+			$line_item,
+			$parent_line_item
+		);
+		return self::add_item($parent_line_item, $line_item);
+	}
+
+
+	/**
+	 * Adds a simple item ( unrelated to any other model object) to the total line item,
+	 * in the correct spot in the line item tree. Automatically
+	 * re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param string $name
+	 * @param float $percentage_amount
+	 * @param string $description
+	 * @param boolean $taxable
+	 * @return boolean success
+	 * @throws \EE_Error
+	 */
+	public static function add_percentage_based_item(EE_Line_Item $parent_line_item, $name, $percentage_amount, $description = '', $taxable = FALSE)
+	{
+		$line_item = EE_Line_Item::new_instance(array(
+			'LIN_name' => $name,
+			'LIN_desc' => $description,
+			'LIN_unit_price' => 0,
+			'LIN_percent' => $percentage_amount,
+			'LIN_quantity' => 1,
+			'LIN_is_taxable' => $taxable,
+			'LIN_total' => (float)($percentage_amount * ($parent_line_item->total() / 100)),
+			'LIN_type' => EEM_Line_Item::type_line_item,
+			'LIN_parent' => $parent_line_item->ID()
+		));
+		$line_item = apply_filters(
+			'FHEE__EEH_Line_Item__add_percentage_based_item__line_item',
+			$line_item
+		);
+		return $parent_line_item->add_child_line_item($line_item, false);
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 * ensures that ticket line item is saved, and that cart total has been recalculated.
+	 * If this ticket has already been purchased, just increments its count.
+	 * Automatically re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $total_line_item grand total line item of type EEM_Line_Item::type_total
+	 * @param EE_Ticket $ticket
+	 * @param int $qty
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
+	{
+		if (!$total_line_item instanceof EE_Line_Item || !$total_line_item->is_total()) {
+			throw new EE_Error(sprintf(__('A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', 'event_espresso'), $ticket->ID(), $total_line_item->ID()));
+		}
+		// either increment the qty for an existing ticket
+		$line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
+		// or add a new one
+		if (!$line_item instanceof EE_Line_Item) {
+			$line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
+		}
+		$total_line_item->recalculate_total_including_taxes();
+		return $line_item;
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 * @param \EE_Line_Item $total_line_item
+	 * @param EE_Ticket $ticket
+	 * @param int $qty
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function increment_ticket_qty_if_already_in_cart(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
+	{
+		$line_item = null;
+		if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+			foreach ((array)$ticket_line_items as $ticket_line_item) {
+				if (
+					$ticket_line_item instanceof EE_Line_Item
+					&& (int)$ticket_line_item->OBJ_ID() === (int)$ticket->ID()
+				) {
+					$line_item = $ticket_line_item;
+					break;
+				}
+			}
+		}
+		if ($line_item instanceof EE_Line_Item) {
+			EEH_Line_Item::increment_quantity($line_item, $qty);
+			return $line_item;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected).
+	 * Does NOT save or recalculate other line items totals
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function increment_quantity(EE_Line_Item $line_item, $qty = 1)
+	{
+		if (!$line_item->is_percent()) {
+			$qty += $line_item->quantity();
+			$line_item->set_quantity($qty);
+			$line_item->set_total($line_item->unit_price() * $qty);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $qty);
+			}
+		}
+	}
+
+
+	/**
+	 * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected).
+	 * Does NOT save or recalculate other line items totals
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1)
+	{
+		if (!$line_item->is_percent()) {
+			$qty = $line_item->quantity() - $qty;
+			$qty = max($qty, 0);
+			$line_item->set_quantity($qty);
+			$line_item->set_total($line_item->unit_price() * $qty);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $qty);
+			}
+		}
+	}
+
+
+	/**
+	 * Updates the line item and its children's quantities to the specified number.
+	 * Does NOT save them or recalculate totals.
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int $new_quantity
+	 * @throws \EE_Error
+	 */
+	public static function update_quantity(EE_Line_Item $line_item, $new_quantity)
+	{
+		if (!$line_item->is_percent()) {
+			$line_item->set_quantity($new_quantity);
+			$line_item->set_total($line_item->unit_price() * $new_quantity);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $new_quantity);
+			}
+		}
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @param EE_Ticket $ticket
+	 * @param int $qty
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
+	{
+		$datetimes = $ticket->datetimes();
+		$first_datetime = reset($datetimes);
+		if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) {
+			$first_datetime_name = $first_datetime->event()->name();
+		} else {
+			$first_datetime_name = __('Event', 'event_espresso');
+		}
+		$event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name);
+		// get event subtotal line
+		$events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket);
+		// add $ticket to cart
+		$line_item = EE_Line_Item::new_instance(array(
+			'LIN_name' => $ticket->name(),
+			'LIN_desc' => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
+			'LIN_unit_price' => $ticket->price(),
+			'LIN_quantity' => $qty,
+			'LIN_is_taxable' => $ticket->taxable(),
+			'LIN_order' => count($events_sub_total->children()),
+			'LIN_total' => $ticket->price() * $qty,
+			'LIN_type' => EEM_Line_Item::type_line_item,
+			'OBJ_ID' => $ticket->ID(),
+			'OBJ_type' => 'Ticket'
+		));
+		$line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
+			$line_item
+		);
+		$events_sub_total->add_child_line_item($line_item);
+		//now add the sub-line items
+		$running_total_for_ticket = 0;
+		foreach ($ticket->prices(array('order_by' => array('PRC_order' => 'ASC'))) as $price) {
+			$sign = $price->is_discount() ? -1 : 1;
+			$price_total = $price->is_percent()
+				? $running_total_for_ticket * $price->amount() / 100
+				: $price->amount() * $qty;
+			$sub_line_item = EE_Line_Item::new_instance(array(
+				'LIN_name' => $price->name(),
+				'LIN_desc' => $price->desc(),
+				'LIN_quantity' => $price->is_percent() ? null : $qty,
+				'LIN_is_taxable' => false,
+				'LIN_order' => $price->order(),
+				'LIN_total' => $sign * $price_total,
+				'LIN_type' => EEM_Line_Item::type_sub_line_item,
+				'OBJ_ID' => $price->ID(),
+				'OBJ_type' => 'Price'
+			));
+			$sub_line_item = apply_filters(
+				'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
+				$sub_line_item
+			);
+			if ($price->is_percent()) {
+				$sub_line_item->set_percent($sign * $price->amount());
+			} else {
+				$sub_line_item->set_unit_price($sign * $price->amount());
+			}
+			$running_total_for_ticket += $price_total;
+			$line_item->add_child_line_item($sub_line_item);
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Adds the specified item under the pre-tax-sub-total line item. Automatically
+	 * re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Line_Item $item to be added
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item)
+	{
+		$pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item);
+		if ($pre_tax_subtotal instanceof EE_Line_Item) {
+			$success = $pre_tax_subtotal->add_child_line_item($item);
+		} else {
+			return FALSE;
+		}
+		$total_line_item->recalculate_total_including_taxes();
+		return $success;
+	}
+
+
+	/**
+	 * cancels an existing ticket line item,
+	 * by decrementing it's quantity by 1 and adding a new "type_cancellation" sub-line-item.
+	 * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
+	 *
+	 * @param EE_Line_Item $ticket_line_item
+	 * @param int $qty
+	 * @return bool success
+	 * @throws \EE_Error
+	 */
+	public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1)
+	{
+		// validate incoming line_item
+		if ($ticket_line_item->OBJ_type() !== 'Ticket') {
+			throw new EE_Error(
+				sprintf(
+					__('The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso'),
+					$ticket_line_item->type()
+				)
+			);
+		}
+		if ($ticket_line_item->quantity() < $qty) {
+			throw new EE_Error(
+				sprintf(
+					__('Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', 'event_espresso'),
+					$qty,
+					$ticket_line_item->quantity()
+				)
+			);
+		}
+		// decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty);
+		foreach ($ticket_line_item->children() as $child_line_item) {
+			if (
+				$child_line_item->is_sub_line_item()
+				&& !$child_line_item->is_percent()
+				&& !$child_line_item->is_cancellation()
+			) {
+				$child_line_item->set_quantity($child_line_item->quantity() - $qty);
+			}
+		}
+		// get cancellation sub line item
+		$cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
+			$ticket_line_item,
+			EEM_Line_Item::type_cancellation
+		);
+		$cancellation_line_item = reset($cancellation_line_item);
+		// verify that this ticket was indeed previously cancelled
+		if ($cancellation_line_item instanceof EE_Line_Item) {
+			// increment cancelled quantity
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty);
+		} else {
+			// create cancellation sub line item
+			$cancellation_line_item = EE_Line_Item::new_instance(array(
+				'LIN_name' => __('Cancellation', 'event_espresso'),
+				'LIN_desc' => sprintf(
+					_x('Cancelled %1$s : %2$s', 'Cancelled Ticket Name : 2015-01-01 11:11', 'event_espresso'),
+					$ticket_line_item->name(),
+					current_time(get_option('date_format') . ' ' . get_option('time_format'))
+				),
+				'LIN_unit_price' => 0, // $ticket_line_item->unit_price()
+				'LIN_quantity' => $qty,
+				'LIN_is_taxable' => $ticket_line_item->is_taxable(),
+				'LIN_order' => count($ticket_line_item->children()),
+				'LIN_total' => 0, // $ticket_line_item->unit_price()
+				'LIN_type' => EEM_Line_Item::type_cancellation,
+			));
+			$ticket_line_item->add_child_line_item($cancellation_line_item);
+		}
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
+			// decrement parent line item quantity
+			$event_line_item = $ticket_line_item->parent();
+			if ($event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event') {
+				$event_line_item->set_quantity($event_line_item->quantity() - $qty);
+				$event_line_item->save();
+			}
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * reinstates (un-cancels?) a previously canceled ticket line item,
+	 * by incrementing it's quantity by 1, and decrementing it's "type_cancellation" sub-line-item.
+	 * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
+	 *
+	 * @param EE_Line_Item $ticket_line_item
+	 * @param int $qty
+	 * @return bool success
+	 * @throws \EE_Error
+	 */
+	public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1)
+	{
+		// validate incoming line_item
+		if ($ticket_line_item->OBJ_type() !== 'Ticket') {
+			throw new EE_Error(
+				sprintf(
+					__('The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso'),
+					$ticket_line_item->type()
+				)
+			);
+		}
+		// get cancellation sub line item
+		$cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
+			$ticket_line_item,
+			EEM_Line_Item::type_cancellation
+		);
+		$cancellation_line_item = reset($cancellation_line_item);
+		// verify that this ticket was indeed previously cancelled
+		if (!$cancellation_line_item instanceof EE_Line_Item) {
+			return false;
+		}
+		if ($cancellation_line_item->quantity() > $qty) {
+			// decrement cancelled quantity
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
+		} else if ($cancellation_line_item->quantity() == $qty) {
+			// decrement cancelled quantity in case anyone still has the object kicking around
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
+			// delete because quantity will end up as 0
+			$cancellation_line_item->delete();
+			// and attempt to destroy the object,
+			// even though PHP won't actually destroy it until it needs the memory
+			unset($cancellation_line_item);
+		} else {
+			// what ?!?! negative quantity ?!?!
+			throw new EE_Error(
+				sprintf(
+					__('Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
+						'event_espresso'),
+					$qty,
+					$cancellation_line_item->quantity()
+				)
+			);
+		}
+		// increment ticket quantity
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty);
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
+			// increment parent line item quantity
+			$event_line_item = $ticket_line_item->parent();
+			if ($event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event') {
+				$event_line_item->set_quantity($event_line_item->quantity() + $qty);
+			}
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * calls EEH_Line_Item::find_transaction_grand_total_for_line_item()
+	 * then EE_Line_Item::recalculate_total_including_taxes() on the result
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return \EE_Line_Item
+	 */
+	public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item)
+	{
+		$grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item);
+		return $grand_total_line_item->recalculate_total_including_taxes();
+	}
+
+
+	/**
+	 * Gets the line item which contains the subtotal of all the items
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item)
+	{
+		$pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal');
+		return $pre_tax_subtotal instanceof EE_Line_Item
+			? $pre_tax_subtotal
+			: self::create_pre_tax_subtotal($total_line_item);
+	}
+
+
+	/**
+	 * Gets the line item for the taxes subtotal
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function get_taxes_subtotal(EE_Line_Item $total_line_item)
+	{
+		$taxes = $total_line_item->get_child_line_item('taxes');
+		return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item);
+	}
+
+
+	/**
+	 * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = NULL)
+	{
+		if ($transaction) {
+			/** @type EEM_Transaction $EEM_Transaction */
+			$EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
+			$TXN_ID = $EEM_Transaction->ensure_is_ID($transaction);
+			$line_item->set_TXN_ID($TXN_ID);
+		}
+	}
+
+
+	/**
+	 * Creates a new default total line item for the transaction,
+	 * and its tickets subtotal and taxes subtotal line items (and adds the
+	 * existing taxes as children of the taxes subtotal line item)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return \EE_Line_Item of type total
+	 * @throws \EE_Error
+	 */
+	public static function create_total_line_item($transaction = NULL)
+	{
+		$total_line_item = EE_Line_Item::new_instance(array(
+			'LIN_code' => 'total',
+			'LIN_name' => __('Grand Total', 'event_espresso'),
+			'LIN_type' => EEM_Line_Item::type_total,
+			'OBJ_type' => 'Transaction'
+		));
+		$total_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_total_line_item__total_line_item',
+			$total_line_item
+		);
+		self::set_TXN_ID($total_line_item, $transaction);
+		self::create_pre_tax_subtotal($total_line_item, $transaction);
+		self::create_taxes_subtotal($total_line_item, $transaction);
+		return $total_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
+	{
+		$pre_tax_line_item = EE_Line_Item::new_instance(array(
+			'LIN_code' => 'pre-tax-subtotal',
+			'LIN_name' => __('Pre-Tax Subtotal', 'event_espresso'),
+			'LIN_type' => EEM_Line_Item::type_sub_total
+		));
+		$pre_tax_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item',
+			$pre_tax_line_item
+		);
+		self::set_TXN_ID($pre_tax_line_item, $transaction);
+		$total_line_item->add_child_line_item($pre_tax_line_item);
+		self::create_event_subtotal($pre_tax_line_item, $transaction);
+		return $pre_tax_line_item;
+	}
+
+
+	/**
+	 * Creates a line item for the taxes subtotal and finds all the tax prices
+	 * and applies taxes to it
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
+	{
+		$tax_line_item = EE_Line_Item::new_instance(array(
+			'LIN_code' => 'taxes',
+			'LIN_name' => __('Taxes', 'event_espresso'),
+			'LIN_type' => EEM_Line_Item::type_tax_sub_total,
+			'LIN_order' => 1000,//this should always come last
+		));
+		$tax_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
+			$tax_line_item
+		);
+		self::set_TXN_ID($tax_line_item, $transaction);
+		$total_line_item->add_child_line_item($tax_line_item);
+		//and lastly, add the actual taxes
+		self::apply_taxes($total_line_item);
+		return $tax_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item $pre_tax_line_item
+	 * @param EE_Transaction $transaction
+	 * @param EE_Event $event
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = NULL, $event = NULL)
+	{
+		$event_line_item = EE_Line_Item::new_instance(array(
+			'LIN_code' => self::get_event_code($event),
+			'LIN_name' => self::get_event_name($event),
+			'LIN_desc' => self::get_event_desc($event),
+			'LIN_type' => EEM_Line_Item::type_sub_total,
+			'OBJ_type' => 'Event',
+			'OBJ_ID' => $event instanceof EE_Event ? $event->ID() : 0
+		));
+		$event_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item',
+			$event_line_item
+		);
+		self::set_TXN_ID($event_line_item, $transaction);
+		$pre_tax_line_item->add_child_line_item($event_line_item);
+		return $event_line_item;
+	}
+
+
+	/**
+	 * Gets what the event ticket's code SHOULD be
+	 *
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function get_event_code($event)
+	{
+		return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
+	}
+
+	/**
+	 * Gets the event name
+	 * @param EE_Event $event
+	 * @return string
+	 */
+	public static function get_event_name($event)
+	{
+		return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
+	}
+
+	/**
+	 * Gets the event excerpt
+	 * @param EE_Event $event
+	 * @return string
+	 */
+	public static function get_event_desc($event)
+	{
+		return $event instanceof EE_Event ? $event->short_description() : '';
+	}
+
+	/**
+	 * Given the grand total line item and a ticket, finds the event sub-total
+	 * line item the ticket's purchase should be added onto
+	 *
+	 * @access public
+	 * @param EE_Line_Item $grand_total the grand total line item
+	 * @param EE_Ticket $ticket
+	 * @throws \EE_Error
+	 * @return EE_Line_Item
+	 */
+	public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket)
+	{
+		$first_datetime = $ticket->first_datetime();
+		if (!$first_datetime instanceof EE_Datetime) {
+			throw new EE_Error(
+				sprintf(__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), $ticket->ID())
+			);
+		}
+		$event = $first_datetime->event();
+		if (!$event instanceof EE_Event) {
+			throw new EE_Error(
+				sprintf(
+					__('The supplied ticket (ID %d) has no event data associated with it.', 'event_espresso'),
+					$ticket->ID()
+				)
+			);
+		}
+		$events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
+		if (!$events_sub_total instanceof EE_Line_Item) {
+			throw new EE_Error(
+				sprintf(
+					__('There is no events sub-total for ticket %s on total line item %d', 'event_espresso'),
+					$ticket->ID(),
+					$grand_total->ID()
+				)
+			);
+		}
+		return $events_sub_total;
+	}
+
+
+	/**
+	 * Gets the event line item
+	 *
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Event $event
+	 * @return EE_Line_Item for the event subtotal which is a child of $grand_total
+	 * @throws \EE_Error
+	 */
+	public static function get_event_line_item(EE_Line_Item $grand_total, $event)
+	{
+		/** @type EE_Event $event */
+		$event = EEM_Event::instance()->ensure_is_obj($event, true);
+		$event_line_item = NULL;
+		$found = false;
+		foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) {
+			// default event subtotal, we should only ever find this the first time this method is called
+			if (!$event_line_item->OBJ_ID()) {
+				// let's use this! but first... set the event details
+				EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
+				$found = true;
+				break;
+			} else if ($event_line_item->OBJ_ID() === $event->ID()) {
+				// found existing line item for this event in the cart, so break out of loop and use this one
+				$found = true;
+				break;
+			}
+		}
+		if (!$found) {
+			//there is no event sub-total yet, so add it
+			$pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total);
+			// create a new "event" subtotal below that
+			$event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event);
+			// and set the event details
+			EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
+		}
+		return $event_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item $event_line_item
+	 * @param EE_Event $event
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function set_event_subtotal_details(
+		EE_Line_Item $event_line_item,
+		EE_Event $event,
+		$transaction = null
+	)
+	{
+		if ($event instanceof EE_Event) {
+			$event_line_item->set_code(self::get_event_code($event));
+			$event_line_item->set_name(self::get_event_name($event));
+			$event_line_item->set_desc(self::get_event_desc($event));
+			$event_line_item->set_OBJ_ID($event->ID());
+		}
+		self::set_TXN_ID($event_line_item, $transaction);
+	}
+
+
+	/**
+	 * Finds what taxes should apply, adds them as tax line items under the taxes sub-total,
+	 * and recalculates the taxes sub-total and the grand total. Resets the taxes, so
+	 * any old taxes are removed
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @throws \EE_Error
+	 */
+	public static function apply_taxes(EE_Line_Item $total_line_item)
+	{
+		/** @type EEM_Price $EEM_Price */
+		$EEM_Price = EE_Registry::instance()->load_model('Price');
+		// get array of taxes via Price Model
+		$ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes();
+		ksort($ordered_taxes);
+		$taxes_line_item = self::get_taxes_subtotal($total_line_item);
+		//just to be safe, remove its old tax line items
+		$taxes_line_item->delete_children_line_items();
+		//loop thru taxes
+		foreach ($ordered_taxes as $order => $taxes) {
+			foreach ($taxes as $tax) {
+				if ($tax instanceof EE_Price) {
+					$tax_line_item = EE_Line_Item::new_instance(
+						array(
+							'LIN_name' => $tax->name(),
+							'LIN_desc' => $tax->desc(),
+							'LIN_percent' => $tax->amount(),
+							'LIN_is_taxable' => false,
+							'LIN_order' => $order,
+							'LIN_total' => 0,
+							'LIN_type' => EEM_Line_Item::type_tax,
+							'OBJ_type' => 'Price',
+							'OBJ_ID' => $tax->ID()
+						)
+					);
+					$tax_line_item = apply_filters(
+						'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
+						$tax_line_item
+					);
+					$taxes_line_item->add_child_line_item($tax_line_item);
+				}
+			}
+		}
+		$total_line_item->recalculate_total_including_taxes();
+	}
+
+
+	/**
+	 * Ensures that taxes have been applied to the order, if not applies them.
+	 * Returns the total amount of tax
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public static function ensure_taxes_applied($total_line_item)
+	{
+		$taxes_subtotal = self::get_taxes_subtotal($total_line_item);
+		if (!$taxes_subtotal->children()) {
+			self::apply_taxes($total_line_item);
+		}
+		return $taxes_subtotal->total();
+	}
+
+
+	/**
+	 * Deletes ALL children of the passed line item
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public static function delete_all_child_items(EE_Line_Item $parent_line_item)
+	{
+		$deleted = 0;
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$deleted += EEH_Line_Item::delete_all_child_items($child_line_item);
+				if ($child_line_item->ID()) {
+					$child_line_item->delete();
+					unset($child_line_item);
+				} else {
+					$parent_line_item->delete_child_line_item($child_line_item->code());
+				}
+				$deleted++;
+			}
+		}
+		return $deleted;
+	}
+
+
+	/**
+	 * Deletes the line items as indicated by the line item code(s) provided,
+	 * regardless of where they're found in the line item tree. Automatically
+	 * re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @param array|bool|string $line_item_codes
+	 * @return int number of items successfully removed
+	 */
+	public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = FALSE)
+	{
+
+		if ($total_line_item->type() !== EEM_Line_Item::type_total) {
+			EE_Error::doing_it_wrong(
+				'EEH_Line_Item::delete_items',
+				__(
+					'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly',
+					'event_espresso'
+				),
+				'4.6.18'
+			);
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		// check if only a single line_item_id was passed
+		if (!empty($line_item_codes) && !is_array($line_item_codes)) {
+			// place single line_item_id in an array to appear as multiple line_item_ids
+			$line_item_codes = array($line_item_codes);
+		}
+		$removals = 0;
+		// cycle thru line_item_ids
+		foreach ($line_item_codes as $line_item_id) {
+			$removals += $total_line_item->delete_child_line_item($line_item_id);
+		}
+
+		if ($removals > 0) {
+			$total_line_item->recalculate_taxes_and_tax_total();
+			return $removals;
+		} else {
+			return FALSE;
+		}
+	}
+
+
+	/**
+	 * Overwrites the previous tax by clearing out the old taxes, and creates a new
+	 * tax and updates the total line item accordingly
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param float $amount
+	 * @param string $name
+	 * @param string $description
+	 * @param string $code
+	 * @param boolean $add_to_existing_line_item
+	 *                          if true, and a duplicate line item with the same code is found,
+	 *                          $amount will be added onto it; otherwise will simply set the taxes to match $amount
+	 * @return EE_Line_Item the new tax line item created
+	 * @throws \EE_Error
+	 */
+	public static function set_total_tax_to(
+		EE_Line_Item $total_line_item,
+		$amount,
+		$name = null,
+		$description = null,
+		$code = null,
+		$add_to_existing_line_item = false
+	)
+	{
+		$tax_subtotal = self::get_taxes_subtotal($total_line_item);
+		$taxable_total = $total_line_item->taxable_total();
+
+		if ($add_to_existing_line_item) {
+			$new_tax = $tax_subtotal->get_child_line_item($code);
+			EEM_Line_Item::instance()->delete(
+				array(array('LIN_code' => array('!=', $code), 'LIN_parent' => $tax_subtotal->ID()))
+			);
+		} else {
+			$new_tax = null;
+			$tax_subtotal->delete_children_line_items();
+		}
+		if ($new_tax) {
+			$new_tax->set_total($new_tax->total() + $amount);
+			$new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0);
+		} else {
+			//no existing tax item. Create it
+			$new_tax = EE_Line_Item::new_instance(array(
+				'TXN_ID' => $total_line_item->TXN_ID(),
+				'LIN_name' => $name ? $name : __('Tax', 'event_espresso'),
+				'LIN_desc' => $description ? $description : '',
+				'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0,
+				'LIN_total' => $amount,
+				'LIN_parent' => $tax_subtotal->ID(),
+				'LIN_type' => EEM_Line_Item::type_tax,
+				'LIN_code' => $code
+			));
+		}
+
+		$new_tax = apply_filters(
+			'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal',
+			$new_tax,
+			$total_line_item
+		);
+		$new_tax->save();
+		$tax_subtotal->set_total($new_tax->total());
+		$tax_subtotal->save();
+		$total_line_item->recalculate_total_including_taxes();
+		return $new_tax;
+	}
+
+
+	/**
+	 * Makes all the line items which are children of $line_item taxable (or not).
+	 * Does NOT save the line items
+	 * @param EE_Line_Item $line_item
+	 * @param string $code_substring_for_whitelist if this string is part of the line item's code
+	 *  it will be whitelisted (ie, except from becoming taxable)
+	 * @param boolean $taxable
+	 */
+	public static function set_line_items_taxable(
+		EE_Line_Item $line_item,
+		$taxable = true,
+		$code_substring_for_whitelist = null
+	)
+	{
+		$whitelisted = false;
+		if ($code_substring_for_whitelist !== null) {
+			$whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false ? true : false;
+		}
+		if (!$whitelisted && $line_item->is_line_item()) {
+			$line_item->set_is_taxable($taxable);
+		}
+		foreach ($line_item->children() as $child_line_item) {
+			EEH_Line_Item::set_line_items_taxable($child_line_item, $taxable, $code_substring_for_whitelist);
+		}
+	}
+
+
+	/**
+	 * Gets all descendants that are event subtotals
+	 *
+	 * @uses  EEH_Line_Item::get_subtotals_of_object_type()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 */
+	public static function get_event_subtotals(EE_Line_Item $parent_line_item)
+	{
+		return self::get_subtotals_of_object_type($parent_line_item, 'Event');
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $obj_type
+	 * @return EE_Line_Item[]
+	 */
+	public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '')
+	{
+		return self::_get_descendants_by_type_and_object_type(
+			$parent_line_item,
+			EEM_Line_Item::type_sub_total,
+			$obj_type
+		);
+	}
+
+
+	/**
+	 * Gets all descendants that are tickets
+	 *
+	 * @uses  EEH_Line_Item::get_line_items_of_object_type()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 */
+	public static function get_ticket_line_items(EE_Line_Item $parent_line_item)
+	{
+		return self::get_line_items_of_object_type($parent_line_item, 'Ticket');
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $obj_type
+	 * @return EE_Line_Item[]
+	 */
+	public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '')
+	{
+		return self::_get_descendants_by_type_and_object_type($parent_line_item, EEM_Line_Item::type_line_item, $obj_type);
+	}
+
+
+	/**
+	 * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax'
+	 * @uses  EEH_Line_Item::get_descendants_of_type()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 */
+	public static function get_tax_descendants(EE_Line_Item $parent_line_item)
+	{
+		return EEH_Line_Item::get_descendants_of_type($parent_line_item, EEM_Line_Item::type_tax);
+	}
+
+
+	/**
+	 * Gets all the real items purchased which are children of this item
+	 * @uses  EEH_Line_Item::get_descendants_of_type()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 */
+	public static function get_line_item_descendants(EE_Line_Item $parent_line_item)
+	{
+		return EEH_Line_Item::get_descendants_of_type($parent_line_item, EEM_Line_Item::type_line_item);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type
+	 *
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $line_item_type one of the EEM_Line_Item constants
+	 * @return EE_Line_Item[]
+	 */
+	public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type)
+	{
+		return self::_get_descendants_by_type_and_object_type($parent_line_item, $line_item_type, NULL);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type as well
+	 *
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $line_item_type one of the EEM_Line_Item constants
+	 * @param string | NULL $obj_type object model class name (minus prefix) or NULL to ignore object type when searching
+	 * @return EE_Line_Item[]
+	 */
+	protected static function _get_descendants_by_type_and_object_type(
+		EE_Line_Item $parent_line_item,
+		$line_item_type,
+		$obj_type = null
+	)
+	{
+		$objects = array();
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				if (
+					$child_line_item->type() === $line_item_type
+					&& (
+						$child_line_item->OBJ_type() === $obj_type || $obj_type === null
+					)
+				) {
+					$objects[] = $child_line_item;
+				} else {
+					//go-through-all-its children looking for more matches
+					$objects = array_merge(
+						$objects,
+						self::_get_descendants_by_type_and_object_type(
+							$child_line_item,
+							$line_item_type,
+							$obj_type
+						)
+					);
+				}
+			}
+		}
+		return $objects;
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $OBJ_type object type (like Event)
+	 * @param array $OBJ_IDs array of OBJ_IDs
+	 * @return EE_Line_Item[]
+	 */
+	public static function get_line_items_by_object_type_and_IDs(
+		EE_Line_Item $parent_line_item,
+		$OBJ_type = '',
+		$OBJ_IDs = array()
+	)
+	{
+		return self::_get_descendants_by_object_type_and_object_ID($parent_line_item, $OBJ_type, $OBJ_IDs);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type as well
+	 *
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $OBJ_type object type (like Event)
+	 * @param array $OBJ_IDs array of OBJ_IDs
+	 * @return EE_Line_Item[]
+	 */
+	protected static function _get_descendants_by_object_type_and_object_ID(
+		EE_Line_Item $parent_line_item,
+		$OBJ_type,
+		$OBJ_IDs
+	)
+	{
+		$objects = array();
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				if (
+					$child_line_item->OBJ_type() === $OBJ_type
+					&& is_array($OBJ_IDs)
+					&& in_array($child_line_item->OBJ_ID(), $OBJ_IDs)
+				) {
+					$objects[] = $child_line_item;
+				} else {
+					//go-through-all-its children looking for more matches
+					$objects = array_merge(
+						$objects,
+						self::_get_descendants_by_object_type_and_object_ID(
+							$child_line_item,
+							$OBJ_type,
+							$OBJ_IDs
+						)
+					);
+				}
+			}
+		}
+		return $objects;
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant of
+	 * the specified type and returns it, else NULL
+	 *
+	 * @uses  EEH_Line_Item::_get_nearest_descendant()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $type like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 */
+	public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type)
+	{
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type);
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant
+	 * having the specified LIN_code and returns it, else NULL
+	 *
+	 * @uses  EEH_Line_Item::_get_nearest_descendant()
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $code any value used for LIN_code
+	 * @return EE_Line_Item
+	 */
+	public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code)
+	{
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code);
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant
+	 * having the specified LIN_code and returns it, else NULL
+	 *
+	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string $search_field name of EE_Line_Item property
+	 * @param string $value any value stored in $search_field
+	 * @return EE_Line_Item
+	 */
+	protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value)
+	{
+		foreach ($parent_line_item->children() as $child) {
+			if ($child->get($search_field) == $value) {
+				return $child;
+			}
+		}
+		foreach ($parent_line_item->children() as $child) {
+			$descendant_found = self::_get_nearest_descendant($child, $search_field, $value);
+			if ($descendant_found) {
+				return $descendant_found;
+			}
+		}
+		return NULL;
+	}
+
+
+	/**
+	 * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction,
+	 * else recursively walks up the line item tree until a parent of type total is found,
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item)
+	{
+		if ($line_item->TXN_ID()) {
+			$total_line_item = $line_item->transaction()->total_line_item(false);
+			if ($total_line_item instanceof EE_Line_Item) {
+				return $total_line_item;
+			}
+		} else {
+			$line_item_parent = $line_item->parent();
+			if ($line_item_parent instanceof EE_Line_Item) {
+				if ($line_item_parent->is_total()) {
+					return $line_item_parent;
+				}
+				return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent);
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				__('A valid grand total for line item %1$d was not found.', 'event_espresso'),
+				$line_item->ID()
+			)
+		);
+	}
+
+
+	/**
+	 * Prints out a representation of the line item tree
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int $indentation
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function visualize(EE_Line_Item $line_item, $indentation = 0)
+	{
+		echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
+		if (!$indentation) {
+			echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
+		}
+		for ($i = 0; $i < $indentation; $i++) {
+			echo ". ";
+		}
+		$breakdown = '';
+		if ($line_item->is_line_item()) {
+			if ($line_item->is_percent()) {
+				$breakdown = "{$line_item->percent()}%";
+			} else {
+				$breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}";
+			}
+		}
+		echo $line_item->name() . " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : " . '$' . "{$line_item->total()}";
+		if ($breakdown) {
+			echo " ( {$breakdown} )";
+		}
+		if ($line_item->is_taxable()) {
+			echo "  * taxable";
+		}
+		if ($line_item->children()) {
+			foreach ($line_item->children() as $child) {
+				self::visualize($child, $indentation + 1);
+			}
+		}
+	}
+
+
+	/**
+	 * Calculates the registration's final price, taking into account that they
+	 * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes,
+	 * and receive a portion of any transaction-wide discounts.
+	 * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount
+	 * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get
+	 * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50
+	 * and brent's final price should be $5.50.
+	 *
+	 * In order to do this, we basically need to traverse the line item tree calculating
+	 * the running totals (just as if we were recalculating the total), but when we identify
+	 * regular line items, we need to keep track of their share of the grand total.
+	 * Also, we need to keep track of the TAXABLE total for each ticket purchase, so
+	 * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total"
+	 * when there are non-taxable items; otherwise they would be the same)
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array $billable_ticket_quantities array of EE_Ticket IDs and their corresponding quantity that
+	 *                                                                            can be included in price calculations at this moment
+	 * @return array        keys are line items for tickets IDs and values are their share of the running total,
+	 *                                          plus the key 'total', and 'taxable' which also has keys of all the ticket IDs. Eg
+	 *                                          array(
+	 *                                          12 => 4.3
+	 *                                          23 => 8.0
+	 *                                          'total' => 16.6,
+	 *                                          'taxable' => array(
+	 *                                          12 => 10,
+	 *                                          23 => 4
+	 *                                          ).
+	 *                                          So to find which registrations have which final price, we need to find which line item
+	 *                                          is theirs, which can be done with
+	 *                                          `EEM_Line_Item::instance()->get_line_item_for_registration( $registration );`
+	 */
+	public static function calculate_reg_final_prices_per_line_item(EE_Line_Item $line_item, $billable_ticket_quantities = array())
+	{
+		//init running grand total if not already
+		if (!isset($running_totals['total'])) {
+			$running_totals['total'] = 0;
+		}
+		if (!isset($running_totals['taxable'])) {
+			$running_totals['taxable'] = array('total' => 0);
+		}
+		foreach ($line_item->children() as $child_line_item) {
+			switch ($child_line_item->type()) {
+
+				case EEM_Line_Item::type_sub_total :
+					$running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item($child_line_item, $billable_ticket_quantities);
+					//combine arrays but preserve numeric keys
+					$running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals);
+					$running_totals['total'] += $running_totals_from_subtotal['total'];
+					$running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total'];
+					break;
+
+				case EEM_Line_Item::type_tax_sub_total :
+
+					//find how much the taxes percentage is
+					if ($child_line_item->percent() !== 0) {
+						$tax_percent_decimal = $child_line_item->percent() / 100;
+					} else {
+						$tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100;
+					}
+					//and apply to all the taxable totals, and add to the pretax totals
+					foreach ($running_totals as $line_item_id => $this_running_total) {
+						//"total" and "taxable" array key is an exception
+						if ($line_item_id === 'taxable') {
+							continue;
+						}
+						$taxable_total = $running_totals['taxable'][$line_item_id];
+						$running_totals[$line_item_id] += ($taxable_total * $tax_percent_decimal);
+					}
+					break;
+
+				case EEM_Line_Item::type_line_item :
+
+					// ticket line items or ????
+					if ($child_line_item->OBJ_type() === 'Ticket') {
+						// kk it's a ticket
+						if (isset($running_totals[$child_line_item->ID()])) {
+							//huh? that shouldn't happen.
+							$running_totals['total'] += $child_line_item->total();
+						} else {
+							//its not in our running totals yet. great.
+							if ($child_line_item->is_taxable()) {
+								$taxable_amount = $child_line_item->unit_price();
+							} else {
+								$taxable_amount = 0;
+							}
+							// are we only calculating totals for some tickets?
+							if (isset($billable_ticket_quantities[$child_line_item->OBJ_ID()])) {
+								$quantity = $billable_ticket_quantities[$child_line_item->OBJ_ID()];
+								$running_totals[$child_line_item->ID()] = $quantity
+									? $child_line_item->unit_price()
+									: 0;
+								$running_totals['taxable'][$child_line_item->ID()] = $quantity
+									? $taxable_amount
+									: 0;
+							} else {
+								$quantity = $child_line_item->quantity();
+								$running_totals[$child_line_item->ID()] = $child_line_item->unit_price();
+								$running_totals['taxable'][$child_line_item->ID()] = $taxable_amount;
+							}
+							$running_totals['taxable']['total'] += $taxable_amount * $quantity;
+							$running_totals['total'] += $child_line_item->unit_price() * $quantity;
+						}
+					} else {
+						// it's some other type of item added to the cart
+						// it should affect the running totals
+						// basically we want to convert it into a PERCENT modifier. Because
+						// more clearly affect all registration's final price equally
+						$line_items_percent_of_running_total = $running_totals['total'] > 0
+							? ($child_line_item->total() / $running_totals['total']) + 1
+							: 1;
+						foreach ($running_totals as $line_item_id => $this_running_total) {
+							//the "taxable" array key is an exception
+							if ($line_item_id === 'taxable') {
+								continue;
+							}
+							// update the running totals
+							// yes this actually even works for the running grand total!
+							$running_totals[$line_item_id] =
+								$line_items_percent_of_running_total * $this_running_total;
+
+							if ($child_line_item->is_taxable()) {
+								$running_totals['taxable'][$line_item_id] =
+									$line_items_percent_of_running_total * $running_totals['taxable'][$line_item_id];
+							}
+						}
+					}
+					break;
+			}
+		}
+		return $running_totals;
+	}
+
+
+	/**
+	 * @param \EE_Line_Item $total_line_item
+	 * @param \EE_Line_Item $ticket_line_item
+	 * @return float | null
+	 * @throws \OutOfRangeException
+	 */
+	public static function calculate_final_price_for_ticket_line_item(\EE_Line_Item $total_line_item, \EE_Line_Item $ticket_line_item)
+	{
+		static $final_prices_per_ticket_line_item = array();
+		if (empty($final_prices_per_ticket_line_item)) {
+			$final_prices_per_ticket_line_item = \EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+				$total_line_item
+			);
+		}
+		//ok now find this new registration's final price
+		if (isset($final_prices_per_ticket_line_item[$ticket_line_item->ID()])) {
+			return $final_prices_per_ticket_line_item[$ticket_line_item->ID()];
+		}
+		$message = sprintf(
+			__(
+				'The final price for the ticket line item (ID:%1$d) could not be calculated.',
+				'event_espresso'
+			),
+			$ticket_line_item->ID()
+		);
+		if (WP_DEBUG) {
+			$message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
+			throw new \OutOfRangeException($message);
+		} else {
+			EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param EE_Registration[] $registrations
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations)
+	{
+		$copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations);
+		foreach ($line_item->children() as $child_li) {
+			$copy_li->add_child_line_item(EEH_Line_Item::billable_line_item_tree($child_li, $registrations));
+		}
+		//if this is the grand total line item, make sure the totals all add up
+		//(we could have duplicated this logic AS we copied the line items, but
+		//it seems DRYer this way)
+		if ($copy_li->type() === EEM_Line_Item::type_total) {
+			$copy_li->recalculate_total_including_taxes();
+		}
+		return $copy_li;
+	}
+
+
+	/**
+	 * Creates a new, unsaved line item from $line_item that factors in the
+	 * number of billable registrations on $registrations.
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 * @param EE_Registration[] $registrations
+	 */
+	public static function billable_line_item(EE_Line_Item $line_item, $registrations)
+	{
+		$new_li_fields = $line_item->model_field_array();
+		if ($line_item->type() === EEM_Line_Item::type_line_item &&
+			$line_item->OBJ_type() === 'Ticket'
+		) {
+			$count = 0;
+			foreach ($registrations as $registration) {
+				if ($line_item->OBJ_ID() === $registration->ticket_ID() &&
+					in_array($registration->status_ID(), EEM_Registration::reg_statuses_that_allow_payment())
+				) {
+					$count++;
+				}
+			}
+			$new_li_fields['LIN_quantity'] = $count;
+		}
+		//don't set the total. We'll leave that up to the code that calculates it
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']);
+		return EE_Line_Item::new_instance($new_li_fields);
+	}
+
+
+	/**
+	 * Returns a modified line item tree where all the subtotals which have a total of 0
+	 * are removed, and line items with a quantity of 0
+	 *
+	 * @param EE_Line_Item $line_item |null
+	 * @return \EE_Line_Item|null
+	 * @throws \EE_Error
+	 */
+	public static function non_empty_line_items(EE_Line_Item $line_item)
+	{
+		$copied_li = EEH_Line_Item::non_empty_line_item($line_item);
+		if ($copied_li === null) {
+			return null;
+		}
+		//if this is an event subtotal, we want to only include it if it
+		//has a non-zero total and at least one ticket line item child
+		$ticket_children = 0;
+		foreach ($line_item->children() as $child_li) {
+			$child_li_copy = EEH_Line_Item::non_empty_line_items($child_li);
+			if ($child_li_copy !== null) {
+				$copied_li->add_child_line_item($child_li_copy);
+				if ($child_li_copy->type() === EEM_Line_Item::type_line_item &&
+					$child_li_copy->OBJ_type() === 'Ticket'
+				) {
+					$ticket_children++;
+				}
+			}
+		}
+		//if this is an event subtotal with NO ticket children
+		//we basically want to ignore it
+		if (
+			$ticket_children === 0
+			&& $line_item->type() === EEM_Line_Item::type_sub_total
+			&& $line_item->OBJ_type() === 'Event'
+			&& $line_item->total() === 0
+		) {
+			return null;
+		}
+		return $copied_li;
+	}
+
+
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function non_empty_line_item(EE_Line_Item $line_item)
+	{
+		if ($line_item->type() === EEM_Line_Item::type_line_item &&
+			$line_item->OBJ_type() === 'Ticket' &&
+			$line_item->quantity() === 0
+		) {
+			return null;
+		}
+		$new_li_fields = $line_item->model_field_array();
+		//don't set the total. We'll leave that up to the code that calculates it
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']);
+		return EE_Line_Item::new_instance($new_li_fields);
+	}
+
+
+
+	/**************************************** @DEPRECATED METHODS *************************************** */
+	/**
+	 * @deprecated
+	 * @param EE_Line_Item $total_line_item
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function get_items_subtotal(EE_Line_Item $total_line_item)
+	{
+		EE_Error::doing_it_wrong('EEH_Line_Item::get_items_subtotal()', __('Method replaced with EEH_Line_Item::get_pre_tax_subtotal()', 'event_espresso'), '4.6.0');
+		return self::get_pre_tax_subtotal($total_line_item);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param EE_Transaction $transaction
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function create_default_total_line_item($transaction = NULL)
+	{
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_total_line_item()', __('Method replaced with EEH_Line_Item::create_total_line_item()', 'event_espresso'), '4.6.0');
+		return self::create_total_line_item($transaction);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Transaction $transaction
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
+	{
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_tickets_subtotal()', __('Method replaced with EEH_Line_Item::create_pre_tax_subtotal()', 'event_espresso'), '4.6.0');
+		return self::create_pre_tax_subtotal($total_line_item, $transaction);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Transaction $transaction
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
+	{
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_taxes_subtotal()', __('Method replaced with EEH_Line_Item::create_taxes_subtotal()', 'event_espresso'), '4.6.0');
+		return self::create_taxes_subtotal($total_line_item, $transaction);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Transaction $transaction
+	 * @return \EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = NULL)
+	{
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_event_subtotal()', __('Method replaced with EEH_Line_Item::create_event_subtotal()', 'event_espresso'), '4.6.0');
+		return self::create_event_subtotal($total_line_item, $transaction);
+	}
 
 
 }

Spacing +31 added lines, -31 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (!defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -56,7 +56,7 @@ 
             'LIN_percent' => null,
             'LIN_is_taxable' => $taxable,
             'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0,
-            'LIN_total' => (float)$unit_price * (int)$quantity,
+            'LIN_total' => (float) $unit_price * (int) $quantity,
             'LIN_type' => EEM_Line_Item::type_line_item,
             'LIN_code' => $code,
         ));
@@ -95,7 +95,7 @@ 
             'LIN_percent' => $percentage_amount,
             'LIN_quantity' => 1,
             'LIN_is_taxable' => $taxable,
-            'LIN_total' => (float)($percentage_amount * ($parent_line_item->total() / 100)),
+            'LIN_total' => (float) ($percentage_amount * ($parent_line_item->total() / 100)),
             'LIN_type' => EEM_Line_Item::type_line_item,
             'LIN_parent' => $parent_line_item->ID()
         ));
@@ -125,13 +125,13 @@ 
      */
     public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
     {
-        if (!$total_line_item instanceof EE_Line_Item || !$total_line_item->is_total()) {
+        if ( ! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
             throw new EE_Error(sprintf(__('A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', 'event_espresso'), $ticket->ID(), $total_line_item->ID()));
         }
         // either increment the qty for an existing ticket
         $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
         // or add a new one
-        if (!$line_item instanceof EE_Line_Item) {
+        if ( ! $line_item instanceof EE_Line_Item) {
             $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
         }
         $total_line_item->recalculate_total_including_taxes();
@@ -152,10 +152,10 @@ 
         $line_item = null;
         if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
             $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-            foreach ((array)$ticket_line_items as $ticket_line_item) {
+            foreach ((array) $ticket_line_items as $ticket_line_item) {
                 if (
                     $ticket_line_item instanceof EE_Line_Item
-                    && (int)$ticket_line_item->OBJ_ID() === (int)$ticket->ID()
+                    && (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID()
                 ) {
                     $line_item = $ticket_line_item;
                     break;
@@ -181,7 +181,7 @@ 
      */
     public static function increment_quantity(EE_Line_Item $line_item, $qty = 1)
     {
-        if (!$line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $qty += $line_item->quantity();
             $line_item->set_quantity($qty);
             $line_item->set_total($line_item->unit_price() * $qty);
@@ -206,7 +206,7 @@ 
      */
     public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1)
     {
-        if (!$line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $qty = $line_item->quantity() - $qty;
             $qty = max($qty, 0);
             $line_item->set_quantity($qty);
@@ -231,7 +231,7 @@ 
      */
     public static function update_quantity(EE_Line_Item $line_item, $new_quantity)
     {
-        if (!$line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $line_item->set_quantity($new_quantity);
             $line_item->set_total($line_item->unit_price() * $new_quantity);
             $line_item->save();
@@ -267,7 +267,7 @@ 
         // add $ticket to cart
         $line_item = EE_Line_Item::new_instance(array(
             'LIN_name' => $ticket->name(),
-            'LIN_desc' => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
+            'LIN_desc' => $ticket->description() !== '' ? $ticket->description().' '.$event : $event,
             'LIN_unit_price' => $ticket->price(),
             'LIN_quantity' => $qty,
             'LIN_is_taxable' => $ticket->taxable(),
@@ -377,8 +377,8 @@ 
         foreach ($ticket_line_item->children() as $child_line_item) {
             if (
                 $child_line_item->is_sub_line_item()
-                && !$child_line_item->is_percent()
-                && !$child_line_item->is_cancellation()
+                && ! $child_line_item->is_percent()
+                && ! $child_line_item->is_cancellation()
             ) {
                 $child_line_item->set_quantity($child_line_item->quantity() - $qty);
             }
@@ -400,7 +400,7 @@ 
                 'LIN_desc' => sprintf(
                     _x('Cancelled %1$s : %2$s', 'Cancelled Ticket Name : 2015-01-01 11:11', 'event_espresso'),
                     $ticket_line_item->name(),
-                    current_time(get_option('date_format') . ' ' . get_option('time_format'))
+                    current_time(get_option('date_format').' '.get_option('time_format'))
                 ),
                 'LIN_unit_price' => 0, // $ticket_line_item->unit_price()
                 'LIN_quantity' => $qty,
@@ -453,7 +453,7 @@ 
         );
         $cancellation_line_item = reset($cancellation_line_item);
         // verify that this ticket was indeed previously cancelled
-        if (!$cancellation_line_item instanceof EE_Line_Item) {
+        if ( ! $cancellation_line_item instanceof EE_Line_Item) {
             return false;
         }
         if ($cancellation_line_item->quantity() > $qty) {
@@ -625,7 +625,7 @@ 
             'LIN_code' => 'taxes',
             'LIN_name' => __('Taxes', 'event_espresso'),
             'LIN_type' => EEM_Line_Item::type_tax_sub_total,
-            'LIN_order' => 1000,//this should always come last
+            'LIN_order' => 1000, //this should always come last
         ));
         $tax_line_item = apply_filters(
             'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
@@ -677,7 +677,7 @@ 
      */
     public static function get_event_code($event)
     {
-        return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
+        return 'event-'.($event instanceof EE_Event ? $event->ID() : '0');
     }
 
     /**
@@ -713,13 +713,13 @@ 
     public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket)
     {
         $first_datetime = $ticket->first_datetime();
-        if (!$first_datetime instanceof EE_Datetime) {
+        if ( ! $first_datetime instanceof EE_Datetime) {
             throw new EE_Error(
                 sprintf(__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), $ticket->ID())
             );
         }
         $event = $first_datetime->event();
-        if (!$event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             throw new EE_Error(
                 sprintf(
                     __('The supplied ticket (ID %d) has no event data associated with it.', 'event_espresso'),
@@ -728,7 +728,7 @@ 
             );
         }
         $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
-        if (!$events_sub_total instanceof EE_Line_Item) {
+        if ( ! $events_sub_total instanceof EE_Line_Item) {
             throw new EE_Error(
                 sprintf(
                     __('There is no events sub-total for ticket %s on total line item %d', 'event_espresso'),
@@ -757,7 +757,7 @@ 
         $found = false;
         foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) {
             // default event subtotal, we should only ever find this the first time this method is called
-            if (!$event_line_item->OBJ_ID()) {
+            if ( ! $event_line_item->OBJ_ID()) {
                 // let's use this! but first... set the event details
                 EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
                 $found = true;
@@ -768,7 +768,7 @@ 
                 break;
             }
         }
-        if (!$found) {
+        if ( ! $found) {
             //there is no event sub-total yet, so add it
             $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total);
             // create a new "event" subtotal below that
@@ -863,7 +863,7 @@ 
     public static function ensure_taxes_applied($total_line_item)
     {
         $taxes_subtotal = self::get_taxes_subtotal($total_line_item);
-        if (!$taxes_subtotal->children()) {
+        if ( ! $taxes_subtotal->children()) {
             self::apply_taxes($total_line_item);
         }
         return $taxes_subtotal->total();
@@ -924,7 +924,7 @@ 
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 
         // check if only a single line_item_id was passed
-        if (!empty($line_item_codes) && !is_array($line_item_codes)) {
+        if ( ! empty($line_item_codes) && ! is_array($line_item_codes)) {
             // place single line_item_id in an array to appear as multiple line_item_ids
             $line_item_codes = array($line_item_codes);
         }
@@ -1027,7 +1027,7 @@ 
         if ($code_substring_for_whitelist !== null) {
             $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false ? true : false;
         }
-        if (!$whitelisted && $line_item->is_line_item()) {
+        if ( ! $whitelisted && $line_item->is_line_item()) {
             $line_item->set_is_taxable($taxable);
         }
         foreach ($line_item->children() as $child_line_item) {
@@ -1332,7 +1332,7 @@ 
     public static function visualize(EE_Line_Item $line_item, $indentation = 0)
     {
         echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
-        if (!$indentation) {
+        if ( ! $indentation) {
             echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
         }
         for ($i = 0; $i < $indentation; $i++) {
@@ -1343,10 +1343,10 @@ 
             if ($line_item->is_percent()) {
                 $breakdown = "{$line_item->percent()}%";
             } else {
-                $breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}";
+                $breakdown = '$'."{$line_item->unit_price()} x {$line_item->quantity()}";
             }
         }
-        echo $line_item->name() . " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : " . '$' . "{$line_item->total()}";
+        echo $line_item->name()." [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : ".'$'."{$line_item->total()}";
         if ($breakdown) {
             echo " ( {$breakdown} )";
         }
@@ -1397,10 +1397,10 @@ 
     public static function calculate_reg_final_prices_per_line_item(EE_Line_Item $line_item, $billable_ticket_quantities = array())
     {
         //init running grand total if not already
-        if (!isset($running_totals['total'])) {
+        if ( ! isset($running_totals['total'])) {
             $running_totals['total'] = 0;
         }
-        if (!isset($running_totals['taxable'])) {
+        if ( ! isset($running_totals['taxable'])) {
             $running_totals['taxable'] = array('total' => 0);
         }
         foreach ($line_item->children() as $child_line_item) {
@@ -1522,7 +1522,7 @@ 
             $ticket_line_item->ID()
         );
         if (WP_DEBUG) {
-            $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
+            $message .= '<br>'.print_r($final_prices_per_ticket_line_item, true);
             throw new \OutOfRangeException($message);
         } else {
             EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);

core/db_classes/EE_Line_Item.class.php

Indentation +1426 added lines, -1426 removed lines

@@ -17,1432 +17,1432 @@
 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();
-        }
-        $subtotal_quantity = 0;
-        //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();
-                    $subtotal_quantity += $child_line_item->quantity();
-                }
-            }
-        }
-        if ($this->is_sub_total()) {
-            // no negative totals plz
-            $calculated_total_so_far = max($calculated_total_so_far, 0);
-            $subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0;
-            $this->set_quantity($subtotal_quantity);
-            $this->maybe_save();
-        }
-        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. Re-saves tax line items
-     * and tax sub-total if already in the DB
-     *
-     * @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->maybe_save();
-            $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);
-            $this->maybe_save();
-        } 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();
+		}
+		$subtotal_quantity = 0;
+		//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();
+					$subtotal_quantity += $child_line_item->quantity();
+				}
+			}
+		}
+		if ($this->is_sub_total()) {
+			// no negative totals plz
+			$calculated_total_so_far = max($calculated_total_so_far, 0);
+			$subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0;
+			$this->set_quantity($subtotal_quantity);
+			$this->maybe_save();
+		}
+		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. Re-saves tax line items
+	 * and tax sub-total if already in the DB
+	 *
+	 * @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->maybe_save();
+			$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);
+			$this->maybe_save();
+		} 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 +17 added lines, -17 removed lines

@@ -75,7 +75,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());
         }
     }
@@ -126,7 +126,7 @@ 
     public function name()
     {
         $name = $this->get('LIN_name');
-        if (!$name) {
+        if ( ! $name) {
             $name = ucwords(str_replace('-', ' ', $this->type()));
         }
         return $name;
@@ -313,7 +313,7 @@ 
         if ($unit_price < .001 && $percent) {
             return true;
         }
-        if ($unit_price >= .001 && !$percent) {
+        if ($unit_price >= .001 && ! $percent) {
             return false;
         }
         if ($unit_price >= .001 && $percent) {
@@ -482,7 +482,7 @@ 
                 )
             );
         }
-        if (!is_array($this->_children)) {
+        if ( ! is_array($this->_children)) {
             $this->_children = array();
         }
         return $this->_children;
@@ -698,7 +698,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());
@@ -769,7 +769,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;
                 }
@@ -797,7 +797,7 @@ 
      */
     public function delete_if_childless_subtotal()
     {
-        if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && !$this->children()) {
+        if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
             return $this->delete();
         }
         return false;
@@ -813,7 +813,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());
     }
 
 
@@ -974,10 +974,10 @@ 
     {
         $total = 0;
         $my_children = $this->children();
-        $has_children = !empty($my_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())) {
+        } 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);
@@ -987,24 +987,24 @@ 
         }
         // 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()
+            ! $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()) {
+            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 (
                 $has_children
                 && $this->is_line_item()
-                && !$this->is_percent()
+                && ! $this->is_percent()
             ) {
                 if ($this->quantity() === 0) {
                     $new_unit_price = 0;
@@ -1041,7 +1041,7 @@ 
         $subtotal_quantity = 0;
         //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 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
@@ -1101,7 +1101,7 @@ 
         $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 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
@@ -1314,7 +1314,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);

core/EE_Cart.core.php

Indentation +416 added lines, -416 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\interfaces\ResettableInterface;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 
@@ -23,421 +23,421 @@ 
 class EE_Cart implements ResettableInterface
 {
 
-    /**
-     * instance of the EE_Cart object
-     *
-     * @access    private
-     * @var EE_Cart $_instance
-     */
-    private static $_instance;
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @access    protected
-     * @var EE_Session $_session
-     */
-    protected $_session;
-
-    /**
-     * The total Line item which comprises all the children line-item subtotals,
-     * which in turn each have their line items.
-     * Typically, the line item structure will look like:
-     * grand total
-     * -tickets-sub-total
-     * --ticket1
-     * --ticket2
-     * --...
-     * -taxes-sub-total
-     * --tax1
-     * --tax2
-     *
-     * @var EE_Line_Item
-     */
-    private $_grand_total;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return \EE_Cart
-     * @throws \EE_Error
-     */
-    public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        // or maybe retrieve an existing one ?
-        if ( ! self::$_instance instanceof EE_Cart) {
-            // try getting the cart out of the session
-            $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
-            self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
-            unset($saved_cart);
-        }
-        // verify that cart is ok and grand total line item exists
-        if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        self::$_instance->get_grand_total();
-        // once everything is all said and done, save the cart to the EE_Session
-        add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     */
-    private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->set_session($session);
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            $this->set_grand_total_line_item($grand_total);
-        }
-    }
-
-
-
-    /**
-     * Resets the cart completely (whereas empty_cart
-     *
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return EE_Cart
-     * @throws \EE_Error
-     */
-    public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        if ($session instanceof EE_Session) {
-            $session->reset_cart();
-        }
-        self::$_instance = null;
-        return self::instance($grand_total, $session);
-    }
-
-
-
-    /**
-     * @return \EE_Session
-     */
-    public function session()
-    {
-        if ( ! $this->_session instanceof EE_Session) {
-            $this->set_session();
-        }
-        return $this->_session;
-    }
-
-
-
-    /**
-     * @param EE_Session $session
-     */
-    public function set_session(EE_Session $session = null)
-    {
-        $this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
-    }
-
-
-
-    /**
-     * Sets the cart to match the line item. Especially handy for loading an old cart where you
-     *  know the grand total line item on it
-     *
-     * @param EE_Line_Item $line_item
-     */
-    public function set_grand_total_line_item(EE_Line_Item $line_item)
-    {
-        $this->_grand_total = $line_item;
-    }
-
-
-
-    /**
-     * get_cart_from_reg_url_link
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param EE_Session     $session
-     * @return \EE_Cart
-     * @throws \EE_Error
-     */
-    public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
-    {
-        $grand_total = $transaction->total_line_item();
-        $grand_total->get_items();
-        $grand_total->tax_descendants();
-        return EE_Cart::instance($grand_total, $session);
-    }
-
-
-
-    /**
-     * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
-     *
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    private function _create_grand_total()
-    {
-        $this->_grand_total = EEH_Line_Item::create_total_line_item();
-        return $this->_grand_total;
-    }
-
-
-
-    /**
-     * Gets all the line items of object type Ticket
-     *
-     * @access public
-     * @return \EE_Line_Item[]
-     */
-    public function get_tickets()
-    {
-        if ($this->_grand_total === null ) {
-            return array();
-        }
-        return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
-    }
-
-
-
-    /**
-     * returns the total quantity of tickets in the cart
-     *
-     * @access public
-     * @return int
-     * @throws \EE_Error
-     */
-    public function all_ticket_quantity_count()
-    {
-        $tickets = $this->get_tickets();
-        if (empty($tickets)) {
-            return 0;
-        }
-        $count = 0;
-        foreach ($tickets as $ticket) {
-            $count += $ticket->get('LIN_quantity');
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Gets all the tax line items
-     *
-     * @return \EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_taxes()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
-    }
-
-
-
-    /**
-     * Gets the total line item (which is a parent of all other line items) on this cart
-     *
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    public function get_grand_total()
-    {
-        return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
-    }
-
-
-
-    /**
-     * @process items for adding to cart
-     * @access  public
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
-    {
-        EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
-        return $this->save_cart() ? true : false;
-    }
-
-
-
-    /**
-     * get_cart_total_before_tax
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_cart_total_before_tax()
-    {
-        return $this->get_grand_total()->recalculate_pre_tax_total();
-    }
-
-
-
-    /**
-     * gets the total amount of tax paid for items in this cart
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_applied_taxes()
-    {
-        return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-    }
-
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_cart_grand_total()
-    {
-        EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        return $this->get_grand_total()->total();
-    }
-
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function recalculate_all_cart_totals()
-    {
-        $pre_tax_total = $this->get_cart_total_before_tax();
-        $taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        $this->_grand_total->set_total($pre_tax_total + $taxes_total);
-        $this->_grand_total->save_this_and_descendants_to_txn();
-        return $this->get_grand_total()->total();
-    }
-
-
-
-    /**
-     * deletes an item from the cart
-     *
-     * @access public
-     * @param array|bool|string $line_item_codes
-     * @return int on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function delete_items($line_item_codes = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
-    }
-
-
-
-    /**
-     * @remove ALL items from cart and zero ALL totals
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function empty_cart()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_grand_total = $this->_create_grand_total();
-        return $this->save_cart(true);
-    }
-
-
-
-    /**
-     * @remove ALL items from cart and delete total as well
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function delete_cart()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item) {
-            $deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
-            if ($deleted) {
-                $deleted += $this->_grand_total->delete();
-                $this->_grand_total = null;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @save   cart to session
-     * @access public
-     * @param bool $apply_taxes
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function save_cart($apply_taxes = true)
-    {
-        if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
-            EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-            //make sure we don't cache the transaction because it can get stale
-            if ($this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
-                && $this->_grand_total->get_one_from_cache('Transaction')->ID()
-            ) {
-                $this->_grand_total->clear_cache('Transaction', null, true);
-            }
-        }
-        if ($this->session() instanceof EE_Session) {
-            return $this->session()->set_cart($this);
-        } else {
-            return false;
-        }
-    }
-
-
-
-    public function __wakeup()
-    {
-        if ( ! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
-            // $this->_grand_total is actually just an ID, so use it to get the object from the db
-            $this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
-        }
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function __sleep()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
-            $this->_grand_total = $this->_grand_total->ID();
-        }
-        return array('_grand_total');
-    }
+	/**
+	 * instance of the EE_Cart object
+	 *
+	 * @access    private
+	 * @var EE_Cart $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @access    protected
+	 * @var EE_Session $_session
+	 */
+	protected $_session;
+
+	/**
+	 * The total Line item which comprises all the children line-item subtotals,
+	 * which in turn each have their line items.
+	 * Typically, the line item structure will look like:
+	 * grand total
+	 * -tickets-sub-total
+	 * --ticket1
+	 * --ticket2
+	 * --...
+	 * -taxes-sub-total
+	 * --tax1
+	 * --tax2
+	 *
+	 * @var EE_Line_Item
+	 */
+	private $_grand_total;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return \EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		// or maybe retrieve an existing one ?
+		if ( ! self::$_instance instanceof EE_Cart) {
+			// try getting the cart out of the session
+			$saved_cart = $session instanceof EE_Session ? $session->cart() : null;
+			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
+			unset($saved_cart);
+		}
+		// verify that cart is ok and grand total line item exists
+		if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		self::$_instance->get_grand_total();
+		// once everything is all said and done, save the cart to the EE_Session
+		add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 */
+	private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->set_session($session);
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			$this->set_grand_total_line_item($grand_total);
+		}
+	}
+
+
+
+	/**
+	 * Resets the cart completely (whereas empty_cart
+	 *
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		if ($session instanceof EE_Session) {
+			$session->reset_cart();
+		}
+		self::$_instance = null;
+		return self::instance($grand_total, $session);
+	}
+
+
+
+	/**
+	 * @return \EE_Session
+	 */
+	public function session()
+	{
+		if ( ! $this->_session instanceof EE_Session) {
+			$this->set_session();
+		}
+		return $this->_session;
+	}
+
+
+
+	/**
+	 * @param EE_Session $session
+	 */
+	public function set_session(EE_Session $session = null)
+	{
+		$this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
+	}
+
+
+
+	/**
+	 * Sets the cart to match the line item. Especially handy for loading an old cart where you
+	 *  know the grand total line item on it
+	 *
+	 * @param EE_Line_Item $line_item
+	 */
+	public function set_grand_total_line_item(EE_Line_Item $line_item)
+	{
+		$this->_grand_total = $line_item;
+	}
+
+
+
+	/**
+	 * get_cart_from_reg_url_link
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param EE_Session     $session
+	 * @return \EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
+	{
+		$grand_total = $transaction->total_line_item();
+		$grand_total->get_items();
+		$grand_total->tax_descendants();
+		return EE_Cart::instance($grand_total, $session);
+	}
+
+
+
+	/**
+	 * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
+	 *
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	private function _create_grand_total()
+	{
+		$this->_grand_total = EEH_Line_Item::create_total_line_item();
+		return $this->_grand_total;
+	}
+
+
+
+	/**
+	 * Gets all the line items of object type Ticket
+	 *
+	 * @access public
+	 * @return \EE_Line_Item[]
+	 */
+	public function get_tickets()
+	{
+		if ($this->_grand_total === null ) {
+			return array();
+		}
+		return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
+	}
+
+
+
+	/**
+	 * returns the total quantity of tickets in the cart
+	 *
+	 * @access public
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function all_ticket_quantity_count()
+	{
+		$tickets = $this->get_tickets();
+		if (empty($tickets)) {
+			return 0;
+		}
+		$count = 0;
+		foreach ($tickets as $ticket) {
+			$count += $ticket->get('LIN_quantity');
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Gets all the tax line items
+	 *
+	 * @return \EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_taxes()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
+	}
+
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other line items) on this cart
+	 *
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public function get_grand_total()
+	{
+		return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
+	}
+
+
+
+	/**
+	 * @process items for adding to cart
+	 * @access  public
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
+	{
+		EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
+		return $this->save_cart() ? true : false;
+	}
+
+
+
+	/**
+	 * get_cart_total_before_tax
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_cart_total_before_tax()
+	{
+		return $this->get_grand_total()->recalculate_pre_tax_total();
+	}
+
+
+
+	/**
+	 * gets the total amount of tax paid for items in this cart
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_applied_taxes()
+	{
+		return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+	}
+
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_cart_grand_total()
+	{
+		EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		return $this->get_grand_total()->total();
+	}
+
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function recalculate_all_cart_totals()
+	{
+		$pre_tax_total = $this->get_cart_total_before_tax();
+		$taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		$this->_grand_total->set_total($pre_tax_total + $taxes_total);
+		$this->_grand_total->save_this_and_descendants_to_txn();
+		return $this->get_grand_total()->total();
+	}
+
+
+
+	/**
+	 * deletes an item from the cart
+	 *
+	 * @access public
+	 * @param array|bool|string $line_item_codes
+	 * @return int on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function delete_items($line_item_codes = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
+	}
+
+
+
+	/**
+	 * @remove ALL items from cart and zero ALL totals
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function empty_cart()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_grand_total = $this->_create_grand_total();
+		return $this->save_cart(true);
+	}
+
+
+
+	/**
+	 * @remove ALL items from cart and delete total as well
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function delete_cart()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item) {
+			$deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
+			if ($deleted) {
+				$deleted += $this->_grand_total->delete();
+				$this->_grand_total = null;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @save   cart to session
+	 * @access public
+	 * @param bool $apply_taxes
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function save_cart($apply_taxes = true)
+	{
+		if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
+			EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+			//make sure we don't cache the transaction because it can get stale
+			if ($this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
+				&& $this->_grand_total->get_one_from_cache('Transaction')->ID()
+			) {
+				$this->_grand_total->clear_cache('Transaction', null, true);
+			}
+		}
+		if ($this->session() instanceof EE_Session) {
+			return $this->session()->set_cart($this);
+		} else {
+			return false;
+		}
+	}
+
+
+
+	public function __wakeup()
+	{
+		if ( ! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
+			// $this->_grand_total is actually just an ID, so use it to get the object from the db
+			$this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
+		}
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
+			$this->_grand_total = $this->_grand_total->ID();
+		}
+		return array('_grand_total');
+	}
 
 
 }

core/domain/services/factories/CartFactory.php

Indentation +10 added lines, -10 removed lines

@@ -23,14 +23,14 @@
 class CartFactory
 {
 
-    /**
-     * @return EE_Cart
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function getCart()
-    {
-        return LoaderFactory::getLoader()->getShared('EE_Cart');
-    }
+	/**
+	 * @return EE_Cart
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function getCart()
+	{
+		return LoaderFactory::getLoader()->getShared('EE_Cart');
+	}
 }

core/domain/services/factories/ModelFactory.php

Indentation +13 added lines, -13 removed lines

@@ -25,17 +25,17 @@
 class ModelFactory
 {
 
-    /**
-     * @param string $model_name
-     * @return bool|EEM_Base
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public static function getModel($model_name)
-    {
-        return EE_Registry::instance()->load_model($model_name);
-    }
+	/**
+	 * @param string $model_name
+	 * @return bool|EEM_Base
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public static function getModel($model_name)
+	{
+		return EE_Registry::instance()->load_model($model_name);
+	}
 }

modules/ticket_selector/TicketDatetimeAvailabilityTracker.php

Spacing +13 added lines, -13 removed lines

@@ -66,24 +66,24 @@ 
     public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
     {
         // if the $_available_spaces array has not been set up yet...
-        if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+        if ( ! isset($this->available_spaces['tickets'][$ticket->ID()])) {
             $this->setInitialTicketDatetimeAvailability($ticket);
         }
         $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+        if (isset($this->available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+            foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // if we want the original datetime availability BEFORE we started subtracting tickets ?
                 if ($get_original_ticket_spaces) {
                     // then grab the available spaces from the "tickets" array
                     // and compare with the above to get the lowest number
                     $available_spaces = min(
                         $available_spaces,
-                        $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
+                        $this->available_spaces['tickets'][$ticket->ID()][$DTD_ID]
                     );
                 } else {
                     // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]);
+                    $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][$DTD_ID]);
                 }
             }
         }
@@ -114,7 +114,7 @@ 
                 'order_by' => array('DTT_EVT_start' => 'ASC'),
             )
         );
-        if (! empty($datetimes)) {
+        if ( ! empty($datetimes)) {
             // now loop thru all of the datetimes
             foreach ($datetimes as $datetime) {
                 if ($datetime instanceof EE_Datetime) {
@@ -122,17 +122,17 @@ 
                     $spaces_remaining = $datetime->spaces_remaining();
                     // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
                     // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
+                    $this->available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min(
                         $ticket->qty() - $ticket->sold(),
                         $spaces_remaining
                     );
                     // if the remaining spaces for this datetime is already set,
                     // then compare that against the datetime spaces remaining, and take the lowest number,
                     // else just take the datetime spaces remaining, and assign to the datetimes array
-                    $this->available_spaces['datetimes'][ $datetime->ID() ] = isset(
-                        $this->available_spaces['datetimes'][ $datetime->ID() ]
+                    $this->available_spaces['datetimes'][$datetime->ID()] = isset(
+                        $this->available_spaces['datetimes'][$datetime->ID()]
                     )
-                        ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
+                        ? min($this->available_spaces['datetimes'][$datetime->ID()], $spaces_remaining)
                         : $spaces_remaining;
                 }
             }
@@ -148,11 +148,11 @@ 
      */
     public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
     {
-        if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+        if (isset($this->available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+            foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty;
+                $this->available_spaces['datetimes'][$DTD_ID] -= $qty;
             }
         }
     }

Indentation +211 added lines, -211 removed lines

@@ -26,215 +26,215 @@
 class TicketDatetimeAvailabilityTracker
 {
 
-    /**
-     * array of datetimes and the spaces available for them
-     *
-     * @var array[][]
-     */
-    private $available_spaces = array();
-
-    /**
-     * @var EEM_Datetime $datetime_model
-     */
-    private $datetime_model;
-
-
-    /**
-     * TicketDatetimeAvailabilityTracker constructor.
-     *
-     * @param EEM_Datetime $datetime_model
-     */
-    public function __construct(EEM_Datetime $datetime_model)
-    {
-        $this->datetime_model = $datetime_model;
-    }
-
-
-    /**
-     * ticketDatetimeAvailability
-     * creates an array of tickets plus all of the datetimes available to each ticket
-     * and tracks the spaces remaining for each of those datetimes
-     *
-     * @param EE_Ticket $ticket - selected ticket
-     * @param bool      $get_original_ticket_spaces
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
-    {
-        // if the $_available_spaces array has not been set up yet...
-        if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
-            $this->setInitialTicketDatetimeAvailability($ticket);
-        }
-        $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
-                // if we want the original datetime availability BEFORE we started subtracting tickets ?
-                if ($get_original_ticket_spaces) {
-                    // then grab the available spaces from the "tickets" array
-                    // and compare with the above to get the lowest number
-                    $available_spaces = min(
-                        $available_spaces,
-                        $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
-                    );
-                } else {
-                    // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]);
-                }
-            }
-        }
-        return $available_spaces;
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket)
-    {
-        // first, get all of the datetimes that are available to this ticket
-        $datetimes = $ticket->get_many_related(
-            'Datetime',
-            array(
-                array(
-                    'DTT_EVT_end' => array(
-                        '>=',
-                        $this->datetime_model->current_time_for_query('DTT_EVT_end'),
-                    ),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-        if (! empty($datetimes)) {
-            // now loop thru all of the datetimes
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    // the number of spaces available for the datetime without considering individual ticket quantities
-                    $spaces_remaining = $datetime->spaces_remaining();
-                    // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
-                    // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
-                        $ticket->qty() - $ticket->sold(),
-                        $spaces_remaining
-                    );
-                    // if the remaining spaces for this datetime is already set,
-                    // then compare that against the datetime spaces remaining, and take the lowest number,
-                    // else just take the datetime spaces remaining, and assign to the datetimes array
-                    $this->available_spaces['datetimes'][ $datetime->ID() ] = isset(
-                        $this->available_spaces['datetimes'][ $datetime->ID() ]
-                    )
-                        ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
-                        : $spaces_remaining;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param    EE_Ticket $ticket
-     * @param    int       $qty
-     * @return    void
-     * @throws EE_Error
-     */
-    public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
-    {
-        if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
-                // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty;
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @param           $qty
-     * @param int       $total_ticket_count
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1)
-    {
-        // tickets can not be purchased but let's find the exact number left
-        // for the last ticket selected PRIOR to subtracting tickets
-        $available_spaces = $this->ticketDatetimeAvailability($ticket, true);
-        // greedy greedy greedy eh?
-        if ($available_spaces > 0) {
-            if (
-            apply_filters(
-                'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
-                true,
-                $ticket,
-                $qty,
-                $available_spaces
-            )
-            ) {
-                $this->availabilityError(
-                    $available_spaces,
-                    $total_ticket_count
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $available_spaces
-     * @param int $total_ticket_count
-     */
-    private function availabilityError($available_spaces = 1, $total_ticket_count = 1)
-    {
-        // add error messaging - we're using the _n function that will generate
-        // the appropriate singular or plural message based on the number of $available_spaces
-        if ($total_ticket_count) {
-            $msg = sprintf(
-                esc_html(
-                    _n(
-                        'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                        'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                        $available_spaces,
-                        'event_espresso'
-                    )
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        } else {
-            $msg = sprintf(
-                esc_html(
-                    _n(
-                        'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                        'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                        $available_spaces,
-                        'event_espresso'
-                    )
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        }
-        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-    }
+	/**
+	 * array of datetimes and the spaces available for them
+	 *
+	 * @var array[][]
+	 */
+	private $available_spaces = array();
+
+	/**
+	 * @var EEM_Datetime $datetime_model
+	 */
+	private $datetime_model;
+
+
+	/**
+	 * TicketDatetimeAvailabilityTracker constructor.
+	 *
+	 * @param EEM_Datetime $datetime_model
+	 */
+	public function __construct(EEM_Datetime $datetime_model)
+	{
+		$this->datetime_model = $datetime_model;
+	}
+
+
+	/**
+	 * ticketDatetimeAvailability
+	 * creates an array of tickets plus all of the datetimes available to each ticket
+	 * and tracks the spaces remaining for each of those datetimes
+	 *
+	 * @param EE_Ticket $ticket - selected ticket
+	 * @param bool      $get_original_ticket_spaces
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
+	{
+		// if the $_available_spaces array has not been set up yet...
+		if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+			$this->setInitialTicketDatetimeAvailability($ticket);
+		}
+		$available_spaces = $ticket->qty() - $ticket->sold();
+		if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+				// if we want the original datetime availability BEFORE we started subtracting tickets ?
+				if ($get_original_ticket_spaces) {
+					// then grab the available spaces from the "tickets" array
+					// and compare with the above to get the lowest number
+					$available_spaces = min(
+						$available_spaces,
+						$this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
+					);
+				} else {
+					// we want the updated ticket availability as stored in the "datetimes" array
+					$available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]);
+				}
+			}
+		}
+		return $available_spaces;
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket)
+	{
+		// first, get all of the datetimes that are available to this ticket
+		$datetimes = $ticket->get_many_related(
+			'Datetime',
+			array(
+				array(
+					'DTT_EVT_end' => array(
+						'>=',
+						$this->datetime_model->current_time_for_query('DTT_EVT_end'),
+					),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+		if (! empty($datetimes)) {
+			// now loop thru all of the datetimes
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					// the number of spaces available for the datetime without considering individual ticket quantities
+					$spaces_remaining = $datetime->spaces_remaining();
+					// save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
+					// or the datetime spaces remaining) to this ticket using the datetime ID as the key
+					$this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
+						$ticket->qty() - $ticket->sold(),
+						$spaces_remaining
+					);
+					// if the remaining spaces for this datetime is already set,
+					// then compare that against the datetime spaces remaining, and take the lowest number,
+					// else just take the datetime spaces remaining, and assign to the datetimes array
+					$this->available_spaces['datetimes'][ $datetime->ID() ] = isset(
+						$this->available_spaces['datetimes'][ $datetime->ID() ]
+					)
+						? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
+						: $spaces_remaining;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param    EE_Ticket $ticket
+	 * @param    int       $qty
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
+	{
+		if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+				// subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
+				$this->available_spaces['datetimes'][ $DTD_ID ] -= $qty;
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @param           $qty
+	 * @param int       $total_ticket_count
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1)
+	{
+		// tickets can not be purchased but let's find the exact number left
+		// for the last ticket selected PRIOR to subtracting tickets
+		$available_spaces = $this->ticketDatetimeAvailability($ticket, true);
+		// greedy greedy greedy eh?
+		if ($available_spaces > 0) {
+			if (
+			apply_filters(
+				'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
+				true,
+				$ticket,
+				$qty,
+				$available_spaces
+			)
+			) {
+				$this->availabilityError(
+					$available_spaces,
+					$total_ticket_count
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $available_spaces
+	 * @param int $total_ticket_count
+	 */
+	private function availabilityError($available_spaces = 1, $total_ticket_count = 1)
+	{
+		// add error messaging - we're using the _n function that will generate
+		// the appropriate singular or plural message based on the number of $available_spaces
+		if ($total_ticket_count) {
+			$msg = sprintf(
+				esc_html(
+					_n(
+						'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+						'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+						$available_spaces,
+						'event_espresso'
+					)
+				),
+				$available_spaces,
+				'<br />'
+			);
+		} else {
+			$msg = sprintf(
+				esc_html(
+					_n(
+						'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+						'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+						$available_spaces,
+						'event_espresso'
+					)
+				),
+				$available_spaces,
+				'<br />'
+			);
+		}
+		EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+	}
 }

modules/ticket_selector/EED_Ticket_Selector.module.php

Indentation +464 added lines, -464 removed lines

@@ -20,470 +20,470 @@
 class EED_Ticket_Selector extends EED_Module
 {
 
-    /**
-     * @var DisplayTicketSelector $ticket_selector
-     */
-    private static $ticket_selector;
-
-    /**
-     * @var TicketSelectorIframeEmbedButton $iframe_embed_button
-     */
-    private static $iframe_embed_button;
-
-
-
-    /**
-     * @return EED_Module|EED_Ticket_Selector
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * @return void
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Ticket_Selector_Config');
-        $this->set_config_name('EED_Ticket_Selector');
-    }
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        // routing
-        EE_Config::register_route(
-            'iframe',
-            'EED_Ticket_Selector',
-            'ticket_selector_iframe',
-            'ticket_selector'
-        );
-        EE_Config::register_route(
-            'process_ticket_selections',
-            'EED_Ticket_Selector',
-            'process_ticket_selections'
-        );
-        EE_Config::register_route(
-            'cancel_ticket_selections',
-            'EED_Ticket_Selector',
-            'cancel_ticket_selections'
-        );
-        add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
-        add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
-        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0);
-        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
-        EED_Ticket_Selector::loadIframeAssets();
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        // hook into the end of the \EE_Admin_Page::_load_page_dependencies()
-        // to load assets for "espresso_events" page on the "edit" route (action)
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
-            array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'),
-            10
-        );
-        /**
-         * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
-         * registrations work.
-         */
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
-            array('EED_Ticket_Selector', 'set_definitions'),
-            10
-        );
-    }
-
-
-
-    /**
-     *    set_definitions
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_definitions()
-    {
-        // don't do this twice
-        if (defined('TICKET_SELECTOR_ASSETS_URL')) {
-            return;
-        }
-        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
-        define(
-            'TICKET_SELECTOR_TEMPLATES_PATH',
-            str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS
-        );
-        //if config is not set, initialize
-        if (
-            ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
-        ) {
-            EED_Ticket_Selector::instance()->set_config();
-            EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance()->config();
-        }
-    }
-
-
-
-    /**
-     * @return DisplayTicketSelector
-     */
-    public static function ticketSelector()
-    {
-        if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
-            EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe());
-        }
-        return EED_Ticket_Selector::$ticket_selector;
-    }
-
-
-    /**
-     * gets the ball rolling
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-
-    /**
-     * @return TicketSelectorIframeEmbedButton
-     */
-    public static function getIframeEmbedButton()
-    {
-        if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
-            self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
-        }
-        return self::$iframe_embed_button;
-    }
-
-
-
-    /**
-     * ticket_selector_iframe_embed_button
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_selector_iframe_embed_button()
-    {
-        $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
-        $iframe_embed_button->addEventEditorIframeEmbedButton();
-    }
-
-
-
-    /**
-     * ticket_selector_iframe
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function ticket_selector_iframe()
-    {
-        $ticket_selector_iframe = new TicketSelectorIframe();
-        $ticket_selector_iframe->display();
-    }
-
-
-
-    /**
-     * 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 static function display_ticket_selector($event = null, $view_details = false)
-    {
-        return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
-    }
-
-
-    /**
-     * @return array  or FALSE
-     * @throws \ReflectionException
-     * @throws \EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function process_ticket_selections()
-    {
-        /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
-        $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
-        return $form->processTicketSelections();
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public static function cancel_ticket_selections()
-    {
-        /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
-        $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
-        return $form->cancelTicketSelections();
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
-            'please select a datetime',
-            'event_espresso'
-        );
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function load_tckt_slctr_assets()
-    {
-        if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
-            // add some style
-            wp_register_style(
-                'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
-                array(),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('ticket_selector');
-            // make it dance
-            wp_register_script(
-                'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
-                array('espresso_core'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('ticket_selector');
-            require_once EE_LIBRARIES
-                         . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php';
-            \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function loadIframeAssets()
-    {
-        // for event lists
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            array('EED_Ticket_Selector', 'iframeCss')
-        );
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            array('EED_Ticket_Selector', 'iframeJs')
-        );
-        // for ticket selectors
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
-            array('EED_Ticket_Selector', 'iframeCss')
-        );
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            array('EED_Ticket_Selector', 'iframeJs')
-        );
-    }
-
-
-
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     *
-     * @param array $iframe_css
-     * @return array
-     */
-    public static function iframeCss(array $iframe_css)
-    {
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
-        return $iframe_css;
-    }
-
-
-
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     *
-     * @param array $iframe_js
-     * @return array
-     */
-    public static function iframeJs(array $iframe_js)
-    {
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
-        return $iframe_js;
-    }
-
-
-    /****************************** DEPRECATED ******************************/
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     * @throws EE_Error
-     */
-    public static function display_view_details_btn()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     * @throws EE_Error
-     */
-    public static function display_ticket_selector_submit()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param string $permalink_string
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        if (
-            EE_Registry::instance()->REQ->get('page') === 'espresso_events'
-            && EE_Registry::instance()->REQ->get('action') === 'edit'
-        ) {
-            $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->addEventEditorIframeEmbedButton();
-        }
-        return '';
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param int    $ID
-     * @param string $external_url
-     * @return string
-     */
-    public static function ticket_selector_form_open($ID = 0, $external_url = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function ticket_selector_form_close()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formClose();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function no_tkt_slctr_end_dv()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.13
-     * @return string
-     */
-    public static function tkt_slctr_end_dv()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function clear_tkt_slctr()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-
-    /**
-     * @deprecated
-     */
-    public static function load_tckt_slctr_assets_admin()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        if (
-            EE_Registry::instance()->REQ->get('page') === 'espresso_events'
-            && EE_Registry::instance()->REQ->get('action') === 'edit'
-        ) {
-            $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->embedButtonAssets();
-        }
-    }
+	/**
+	 * @var DisplayTicketSelector $ticket_selector
+	 */
+	private static $ticket_selector;
+
+	/**
+	 * @var TicketSelectorIframeEmbedButton $iframe_embed_button
+	 */
+	private static $iframe_embed_button;
+
+
+
+	/**
+	 * @return EED_Module|EED_Ticket_Selector
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Ticket_Selector_Config');
+		$this->set_config_name('EED_Ticket_Selector');
+	}
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		// routing
+		EE_Config::register_route(
+			'iframe',
+			'EED_Ticket_Selector',
+			'ticket_selector_iframe',
+			'ticket_selector'
+		);
+		EE_Config::register_route(
+			'process_ticket_selections',
+			'EED_Ticket_Selector',
+			'process_ticket_selections'
+		);
+		EE_Config::register_route(
+			'cancel_ticket_selections',
+			'EED_Ticket_Selector',
+			'cancel_ticket_selections'
+		);
+		add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
+		add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
+		add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0);
+		add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
+		EED_Ticket_Selector::loadIframeAssets();
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
+		// to load assets for "espresso_events" page on the "edit" route (action)
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
+			array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'),
+			10
+		);
+		/**
+		 * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
+		 * registrations work.
+		 */
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
+			array('EED_Ticket_Selector', 'set_definitions'),
+			10
+		);
+	}
+
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_definitions()
+	{
+		// don't do this twice
+		if (defined('TICKET_SELECTOR_ASSETS_URL')) {
+			return;
+		}
+		define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+		define(
+			'TICKET_SELECTOR_TEMPLATES_PATH',
+			str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS
+		);
+		//if config is not set, initialize
+		if (
+			! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
+		) {
+			EED_Ticket_Selector::instance()->set_config();
+			EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance()->config();
+		}
+	}
+
+
+
+	/**
+	 * @return DisplayTicketSelector
+	 */
+	public static function ticketSelector()
+	{
+		if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
+			EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe());
+		}
+		return EED_Ticket_Selector::$ticket_selector;
+	}
+
+
+	/**
+	 * gets the ball rolling
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+
+	/**
+	 * @return TicketSelectorIframeEmbedButton
+	 */
+	public static function getIframeEmbedButton()
+	{
+		if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
+			self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
+		}
+		return self::$iframe_embed_button;
+	}
+
+
+
+	/**
+	 * ticket_selector_iframe_embed_button
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_selector_iframe_embed_button()
+	{
+		$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
+		$iframe_embed_button->addEventEditorIframeEmbedButton();
+	}
+
+
+
+	/**
+	 * ticket_selector_iframe
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function ticket_selector_iframe()
+	{
+		$ticket_selector_iframe = new TicketSelectorIframe();
+		$ticket_selector_iframe->display();
+	}
+
+
+
+	/**
+	 * 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 static function display_ticket_selector($event = null, $view_details = false)
+	{
+		return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
+	}
+
+
+	/**
+	 * @return array  or FALSE
+	 * @throws \ReflectionException
+	 * @throws \EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function process_ticket_selections()
+	{
+		/** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
+		$form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
+		return $form->processTicketSelections();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public static function cancel_ticket_selections()
+	{
+		/** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
+		$form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
+		return $form->cancelTicketSelections();
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
+			'please select a datetime',
+			'event_espresso'
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function load_tckt_slctr_assets()
+	{
+		if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
+			// add some style
+			wp_register_style(
+				'ticket_selector',
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
+				array(),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('ticket_selector');
+			// make it dance
+			wp_register_script(
+				'ticket_selector',
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
+				array('espresso_core'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('ticket_selector');
+			require_once EE_LIBRARIES
+						 . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php';
+			\EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function loadIframeAssets()
+	{
+		// for event lists
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			array('EED_Ticket_Selector', 'iframeCss')
+		);
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			array('EED_Ticket_Selector', 'iframeJs')
+		);
+		// for ticket selectors
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
+			array('EED_Ticket_Selector', 'iframeCss')
+		);
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			array('EED_Ticket_Selector', 'iframeJs')
+		);
+	}
+
+
+
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 *
+	 * @param array $iframe_css
+	 * @return array
+	 */
+	public static function iframeCss(array $iframe_css)
+	{
+		$iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
+		return $iframe_css;
+	}
+
+
+
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 *
+	 * @param array $iframe_js
+	 * @return array
+	 */
+	public static function iframeJs(array $iframe_js)
+	{
+		$iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
+		return $iframe_js;
+	}
+
+
+	/****************************** DEPRECATED ******************************/
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function display_view_details_btn()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function display_ticket_selector_submit()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+			&& EE_Registry::instance()->REQ->get('action') === 'edit'
+		) {
+			$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->addEventEditorIframeEmbedButton();
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param int    $ID
+	 * @param string $external_url
+	 * @return string
+	 */
+	public static function ticket_selector_form_open($ID = 0, $external_url = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function ticket_selector_form_close()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formClose();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function no_tkt_slctr_end_dv()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.13
+	 * @return string
+	 */
+	public static function tkt_slctr_end_dv()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function clear_tkt_slctr()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 */
+	public static function load_tckt_slctr_assets_admin()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+			&& EE_Registry::instance()->REQ->get('action') === 'edit'
+		) {
+			$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->embedButtonAssets();
+		}
+	}
 
 
 }

Doc Comments +1 added lines, -1 removed lines

@@ -241,7 +241,7 @@
 
 
     /**
-     * @return string
+     * @return boolean
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
      * @throws InvalidDataTypeException

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

Doc Comments +2 added lines, -1 removed lines

@@ -211,7 +211,7 @@ 
 
     /**
      * @param EE_Registration $registration
-     * @return EE_Form_Section_Base
+     * @return EE_Form_Section_Proper|null
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\EntityNotFoundException
@@ -610,6 +610,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 +1338 added lines, -1338 removed lines

@@ -17,1346 +17,1346 @@
 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)
-                ) {
-                    $subsection = $this->_registrations_reg_form($registration);
-                    if(!$subsection instanceof EE_Form_Section_Proper) {
-                        continue;
-                    }
-                    $subsections[ $registration->reg_url_link() ] = $subsection;
-                    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) : null;
-    }
-
-
-    /**
-     * _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() . '-' . $registration->ID(),
-            '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() .  '-' . $registration->ID() . '-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)
+				) {
+					$subsection = $this->_registrations_reg_form($registration);
+					if(!$subsection instanceof EE_Form_Section_Proper) {
+						continue;
+					}
+					$subsections[ $registration->reg_url_link() ] = $subsection;
+					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) : null;
+	}
+
+
+	/**
+	 * _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() . '-' . $registration->ID(),
+			'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() .  '-' . $registration->ID() . '-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 +53 added lines, -54 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,11 +145,11 @@ 
                     && $this->checkout->visit_allows_processing_of_this_registration($registration)
                 ) {
                     $subsection = $this->_registrations_reg_form($registration);
-                    if(!$subsection instanceof EE_Form_Section_Proper) {
+                    if ( ! $subsection instanceof EE_Form_Section_Proper) {
                         continue;
                     }
-                    $subsections[ $registration->reg_url_link() ] = $subsection;
-                    if (! $this->checkout->admin_request) {
+                    $subsections[$registration->reg_url_link()] = $subsection;
+                    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()]
@@ -197,8 +197,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,
@@ -241,7 +240,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;'
@@ -297,7 +296,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,
             )
         );
@@ -317,11 +316,11 @@ 
     {
         // array of params to pass to parent constructor
         $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
+            'html_id'         => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-'.$registration->ID(),
             '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() .  '-' . $registration->ID() . '-lbl',
+            'html_label_id'   => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-'.$registration->ID().'-lbl',
             'subsections'     => array(
                 'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
             ),
@@ -332,7 +331,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(
@@ -476,7 +475,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()
@@ -508,16 +507,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(
@@ -526,7 +525,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,
                         )
@@ -575,7 +574,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()))
             )
@@ -592,14 +591,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);
@@ -631,18 +630,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,
@@ -685,7 +684,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();
@@ -735,7 +734,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();
@@ -787,7 +786,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.',
@@ -804,10 +803,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 />'
                              );
@@ -826,7 +825,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(
@@ -907,7 +906,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.',
@@ -922,12 +921,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();
                     }
                     /**
@@ -962,7 +961,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]
                         );
@@ -974,11 +973,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
                                     )
@@ -998,7 +997,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
@@ -1054,7 +1053,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__(
@@ -1149,7 +1148,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
@@ -1170,10 +1169,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__ );
@@ -1218,7 +1217,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) {
@@ -1305,7 +1304,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',
@@ -1317,7 +1316,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(