eventespresso / event-espresso-core

core/helpers/EEH_Line_Item.helper.php

Doc Comments +2 added lines, -1 removed lines

@@ -874,7 +874,7 @@ 
      * Deletes ALL children of the passed line item
      *
      * @param EE_Line_Item $parent_line_item
-     * @return bool
+     * @return integer
      * @throws \EE_Error
      */
     public static function delete_all_child_items(EE_Line_Item $parent_line_item)
@@ -1138,6 +1138,7 @@ 
      * @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
+     * @param string $obj_type
      * @return EE_Line_Item[]
      */
     protected static function _get_descendants_by_type_and_object_type(

Indentation +1685 added lines, -1685 removed lines

@@ -20,1689 +20,1689 @@
 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);
-        } elseif ($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;
-            } elseif ($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);
+		} elseif ($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;
+			} elseif ($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 +40 added lines, -40 removed lines

@@ -122,13 +122,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();
@@ -177,7 +177,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);
@@ -202,7 +202,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);
@@ -227,7 +227,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();
@@ -263,7 +263,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(),
@@ -372,8 +372,8 @@ 
         $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->is_percent()
+                && ! $child_line_item->is_cancellation()
             ) {
                 $child_line_item->set_quantity($child_line_item->quantity() - $qty);
             }
@@ -395,7 +395,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,
@@ -448,7 +448,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) {
@@ -622,7 +622,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',
@@ -674,7 +674,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');
     }
 
     /**
@@ -710,13 +710,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'),
@@ -725,7 +725,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'),
@@ -754,7 +754,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;
@@ -765,7 +765,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
@@ -859,7 +859,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();
@@ -920,7 +920,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);
         }
@@ -1021,7 +1021,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) {
@@ -1321,7 +1321,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++) {
@@ -1332,10 +1332,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} )";
         }
@@ -1386,10 +1386,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) {
@@ -1415,8 +1415,8 @@ 
                         if ($line_item_id === 'taxable') {
                             continue;
                         }
-                        $taxable_total = $running_totals['taxable'][ $line_item_id ];
-                        $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal);
+                        $taxable_total = $running_totals['taxable'][$line_item_id];
+                        $running_totals[$line_item_id] += ($taxable_total * $tax_percent_decimal);
                     }
                     break;
 
@@ -1424,7 +1424,7 @@ 
                     // ticket line items or ????
                     if ($child_line_item->OBJ_type() === 'Ticket') {
                         // kk it's a ticket
-                        if (isset($running_totals[ $child_line_item->ID() ])) {
+                        if (isset($running_totals[$child_line_item->ID()])) {
                             // huh? that shouldn't happen.
                             $running_totals['total'] += $child_line_item->total();
                         } else {
@@ -1435,18 +1435,18 @@ 
                                 $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
+                            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
+                                $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[$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;
@@ -1466,12 +1466,12 @@ 
                             }
                             // update the running totals
                             // yes this actually even works for the running grand total!
-                            $running_totals[ $line_item_id ] =
+                            $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 ];
+                                $running_totals['taxable'][$line_item_id] =
+                                    $line_items_percent_of_running_total * $running_totals['taxable'][$line_item_id];
                             }
                         }
                     }
@@ -1497,8 +1497,8 @@ 
             );
         }
         // 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() ];
+        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(
             __(
@@ -1508,7 +1508,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/helpers/EEH_DTT_Helper.helper.php

Doc Comments +5 added lines, -5 removed lines

@@ -197,8 +197,8 @@ 
      * Get Timezone Offset for given timezone object.
      *
      * @param DateTimeZone $date_time_zone
-     * @param null         $time
-     * @return mixed
+     * @param integer|null         $time
+     * @return integer
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
      * @throws InvalidInterfaceException
@@ -320,7 +320,7 @@ 
      * @param  DateTime   $DateTime DateTime object
      * @param  string     $period   a value to indicate what interval is being used in the calculation. The options are
      *                              'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
-     * @param  int|string $value    What you want to increment the date by
+     * @param  integer $value    What you want to increment the date by
      * @param  string     $operand  What operand you wish to use for the calculation
      * @return DateTime return whatever type came in.
      * @throws Exception
@@ -856,7 +856,7 @@ 
      * this method will add that "1" into your date regardless of the format.
      *
      * @param string $month
-     * @return string
+     * @return integer
      */
     public static function first_of_month_timestamp($month = '')
     {
@@ -1004,7 +1004,7 @@ 
     /**
      * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0
      *
-     * @param int|WP_User $user_id
+     * @param integer $user_id
      * @return string
      */
     public static function get_user_locale($user_id = 0)

Indentation +981 added lines, -981 removed lines

@@ -17,1043 +17,1043 @@
 {
 
 
-    /**
-     * return the timezone set for the WP install
-     *
-     * @return string valid timezone string for PHP DateTimeZone() class
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone()
-    {
-        return EEH_DTT_Helper::get_valid_timezone_string();
-    }
+	/**
+	 * return the timezone set for the WP install
+	 *
+	 * @return string valid timezone string for PHP DateTimeZone() class
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone()
+	{
+		return EEH_DTT_Helper::get_valid_timezone_string();
+	}
 
 
-    /**
-     * get_valid_timezone_string
-     *    ensures that a valid timezone string is returned
-     *
-     * @param string $timezone_string
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_valid_timezone_string($timezone_string = '')
-    {
-        return self::getHelperAdapter()->getValidTimezoneString($timezone_string);
-    }
+	/**
+	 * get_valid_timezone_string
+	 *    ensures that a valid timezone string is returned
+	 *
+	 * @param string $timezone_string
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_valid_timezone_string($timezone_string = '')
+	{
+		return self::getHelperAdapter()->getValidTimezoneString($timezone_string);
+	}
 
 
-    /**
-     * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @static
-     * @param  string $timezone_string Timezone string to check
-     * @param bool    $throw_error
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function validate_timezone($timezone_string, $throw_error = true)
-    {
-        return self::getHelperAdapter()->validateTimezone($timezone_string, $throw_error);
-    }
+	/**
+	 * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @static
+	 * @param  string $timezone_string Timezone string to check
+	 * @param bool    $throw_error
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function validate_timezone($timezone_string, $throw_error = true)
+	{
+		return self::getHelperAdapter()->validateTimezone($timezone_string, $throw_error);
+	}
 
 
-    /**
-     * This returns a string that can represent the provided gmt offset in format that can be passed into
-     * DateTimeZone.  This is NOT a string that can be passed as a value on the WordPress timezone_string option.
-     *
-     * @param float|string $gmt_offset
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone_string_from_gmt_offset($gmt_offset = '')
-    {
-        return self::getHelperAdapter()->getTimezoneStringFromGmtOffset($gmt_offset);
-    }
+	/**
+	 * This returns a string that can represent the provided gmt offset in format that can be passed into
+	 * DateTimeZone.  This is NOT a string that can be passed as a value on the WordPress timezone_string option.
+	 *
+	 * @param float|string $gmt_offset
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone_string_from_gmt_offset($gmt_offset = '')
+	{
+		return self::getHelperAdapter()->getTimezoneStringFromGmtOffset($gmt_offset);
+	}
 
 
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case teh gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int seconds offset
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_site_timezone_gmt_offset()
-    {
-        return self::getHelperAdapter()->getSiteTimezoneGmtOffset();
-    }
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case teh gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int seconds offset
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_site_timezone_gmt_offset()
+	{
+		return self::getHelperAdapter()->getSiteTimezoneGmtOffset();
+	}
 
 
-    /**
-     * Depending on PHP version,
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @deprecated 4.9.54.rc    Developers this was always meant to only be an internally used method.  This will be
-     *                          removed in a future version of EE.
-     * @param int $gmt_offset
-     * @return int
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
-    {
-        return self::getHelperAdapter()->adjustInvalidGmtOffsets($gmt_offset);
-    }
+	/**
+	 * Depending on PHP version,
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @deprecated 4.9.54.rc    Developers this was always meant to only be an internally used method.  This will be
+	 *                          removed in a future version of EE.
+	 * @param int $gmt_offset
+	 * @return int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
+	{
+		return self::getHelperAdapter()->adjustInvalidGmtOffsets($gmt_offset);
+	}
 
 
-    /**
-     * get_timezone_string_from_abbreviations_list
-     *
-     * @deprecated 4.9.54.rc  Developers, this was never intended to be public.  This is a soft deprecation for now.
-     *                        If you are using this, you'll want to work out an alternate way of getting the value.
-     * @param int  $gmt_offset
-     * @param bool $coerce If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
-    {
-        $gmt_offset =  (int) $gmt_offset;
-        /** @var array[] $abbreviations */
-        $abbreviations = DateTimeZone::listAbbreviations();
-        foreach ($abbreviations as $abbreviation) {
-            foreach ($abbreviation as $timezone) {
-                if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
-                    try {
-                        $offset = self::get_timezone_offset(new DateTimeZone($timezone['timezone_id']));
-                        if ($offset !== $gmt_offset) {
-                            continue;
-                        }
-                        return $timezone['timezone_id'];
-                    } catch (Exception $e) {
-                        continue;
-                    }
-                }
-            }
-        }
-        // if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
-        if ($coerce === true) {
-            $timezone_string = self::get_timezone_string_from_abbreviations_list(
-                self::adjust_invalid_gmt_offsets($gmt_offset),
-                false
-            );
-            if ($timezone_string) {
-                return $timezone_string;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
-                    'event_espresso'
-                ),
-                $gmt_offset / HOUR_IN_SECONDS,
-                '<a href="http://www.php.net/manual/en/timezones.php">',
-                '</a>'
-            )
-        );
-    }
+	/**
+	 * get_timezone_string_from_abbreviations_list
+	 *
+	 * @deprecated 4.9.54.rc  Developers, this was never intended to be public.  This is a soft deprecation for now.
+	 *                        If you are using this, you'll want to work out an alternate way of getting the value.
+	 * @param int  $gmt_offset
+	 * @param bool $coerce If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
+	{
+		$gmt_offset =  (int) $gmt_offset;
+		/** @var array[] $abbreviations */
+		$abbreviations = DateTimeZone::listAbbreviations();
+		foreach ($abbreviations as $abbreviation) {
+			foreach ($abbreviation as $timezone) {
+				if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
+					try {
+						$offset = self::get_timezone_offset(new DateTimeZone($timezone['timezone_id']));
+						if ($offset !== $gmt_offset) {
+							continue;
+						}
+						return $timezone['timezone_id'];
+					} catch (Exception $e) {
+						continue;
+					}
+				}
+			}
+		}
+		// if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
+		if ($coerce === true) {
+			$timezone_string = self::get_timezone_string_from_abbreviations_list(
+				self::adjust_invalid_gmt_offsets($gmt_offset),
+				false
+			);
+			if ($timezone_string) {
+				return $timezone_string;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
+					'event_espresso'
+				),
+				$gmt_offset / HOUR_IN_SECONDS,
+				'<a href="http://www.php.net/manual/en/timezones.php">',
+				'</a>'
+			)
+		);
+	}
 
 
-    /**
-     * Get Timezone Transitions
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
-    {
-        return self::getHelperAdapter()->getTimezoneTransitions($date_time_zone, $time, $first_only);
-    }
+	/**
+	 * Get Timezone Transitions
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
+	{
+		return self::getHelperAdapter()->getTimezoneTransitions($date_time_zone, $time, $first_only);
+	}
 
 
-    /**
-     * Get Timezone Offset for given timezone object.
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param null         $time
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
-    {
-        return self::getHelperAdapter()->getTimezoneOffset($date_time_zone, $time);
-    }
+	/**
+	 * Get Timezone Offset for given timezone object.
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param null         $time
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
+	{
+		return self::getHelperAdapter()->getTimezoneOffset($date_time_zone, $time);
+	}
 
 
-    /**
-     * Prints a select input for the given timezone string.
-     * @param string $timezone_string
-     * @deprecatd 4.9.54.rc   Soft deprecation.  Consider using \EEH_DTT_Helper::wp_timezone_choice instead.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function timezone_select_input($timezone_string = '')
-    {
-        self::getHelperAdapter()->timezoneSelectInput($timezone_string);
-    }
+	/**
+	 * Prints a select input for the given timezone string.
+	 * @param string $timezone_string
+	 * @deprecatd 4.9.54.rc   Soft deprecation.  Consider using \EEH_DTT_Helper::wp_timezone_choice instead.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function timezone_select_input($timezone_string = '')
+	{
+		self::getHelperAdapter()->timezoneSelectInput($timezone_string);
+	}
 
 
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp                  if 0, then time() will be used.
-     * @param string $timezone_string                 timezone_string. If empty, then the current set timezone for the
-     *                                                site will be used.
-     * @return int $unix_timestamp with the offset applied for the given timezone.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
-    {
-        return self::getHelperAdapter()->getTimestampWithOffset($unix_timestamp, $timezone_string);
-    }
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp                  if 0, then time() will be used.
+	 * @param string $timezone_string                 timezone_string. If empty, then the current set timezone for the
+	 *                                                site will be used.
+	 * @return int $unix_timestamp with the offset applied for the given timezone.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
+	{
+		return self::getHelperAdapter()->getTimestampWithOffset($unix_timestamp, $timezone_string);
+	}
 
 
-    /**
-     *    _set_date_time_field
-     *    modifies EE_Base_Class EE_Datetime_Field objects
-     *
-     * @param  EE_Base_Class $obj                 EE_Base_Class object
-     * @param    DateTime    $DateTime            PHP DateTime object
-     * @param  string        $datetime_field_name the datetime fieldname to be manipulated
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name)
-    {
-        // grab current datetime format
-        $current_format = $obj->get_format();
-        // set new full timestamp format
-        $obj->set_date_format(EE_Datetime_Field::mysql_date_format);
-        $obj->set_time_format(EE_Datetime_Field::mysql_time_format);
-        // set the new date value using a full timestamp format so that no data is lost
-        $obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format));
-        // reset datetime formats
-        $obj->set_date_format($current_format[0]);
-        $obj->set_time_format($current_format[1]);
-        return $obj;
-    }
+	/**
+	 *    _set_date_time_field
+	 *    modifies EE_Base_Class EE_Datetime_Field objects
+	 *
+	 * @param  EE_Base_Class $obj                 EE_Base_Class object
+	 * @param    DateTime    $DateTime            PHP DateTime object
+	 * @param  string        $datetime_field_name the datetime fieldname to be manipulated
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name)
+	{
+		// grab current datetime format
+		$current_format = $obj->get_format();
+		// set new full timestamp format
+		$obj->set_date_format(EE_Datetime_Field::mysql_date_format);
+		$obj->set_time_format(EE_Datetime_Field::mysql_time_format);
+		// set the new date value using a full timestamp format so that no data is lost
+		$obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format));
+		// reset datetime formats
+		$obj->set_date_format($current_format[0]);
+		$obj->set_time_format($current_format[1]);
+		return $obj;
+	}
 
 
-    /**
-     *    date_time_add
-     *    helper for doing simple datetime calculations on a given datetime from EE_Base_Class
-     *    and modifying it IN the EE_Base_Class so you don't have to do anything else.
-     *
-     * @param  EE_Base_Class $obj                 EE_Base_Class object
-     * @param  string        $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
-     * @param  string        $period              what you are adding. The options are (years, months, days, hours,
-     *                                            minutes, seconds) defaults to years
-     * @param  integer       $value               what you want to increment the time by
-     * @return EE_Base_Class return the EE_Base_Class object so right away you can do something with it
-     *                                            (chaining)
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
-    {
-        // get the raw UTC date.
-        $DateTime = $obj->get_DateTime_object($datetime_field_name);
-        $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value);
-        return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
-    }
+	/**
+	 *    date_time_add
+	 *    helper for doing simple datetime calculations on a given datetime from EE_Base_Class
+	 *    and modifying it IN the EE_Base_Class so you don't have to do anything else.
+	 *
+	 * @param  EE_Base_Class $obj                 EE_Base_Class object
+	 * @param  string        $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
+	 * @param  string        $period              what you are adding. The options are (years, months, days, hours,
+	 *                                            minutes, seconds) defaults to years
+	 * @param  integer       $value               what you want to increment the time by
+	 * @return EE_Base_Class return the EE_Base_Class object so right away you can do something with it
+	 *                                            (chaining)
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
+	{
+		// get the raw UTC date.
+		$DateTime = $obj->get_DateTime_object($datetime_field_name);
+		$DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value);
+		return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
+	}
 
 
-    /**
-     *    date_time_subtract
-     *    same as date_time_add except subtracting value instead of adding.
-     *
-     * @param EE_Base_Class $obj
-     * @param  string       $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
-     * @param string        $period
-     * @param int           $value
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
-    {
-        // get the raw UTC date
-        $DateTime = $obj->get_DateTime_object($datetime_field_name);
-        $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-');
-        return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
-    }
+	/**
+	 *    date_time_subtract
+	 *    same as date_time_add except subtracting value instead of adding.
+	 *
+	 * @param EE_Base_Class $obj
+	 * @param  string       $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
+	 * @param string        $period
+	 * @param int           $value
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
+	{
+		// get the raw UTC date
+		$DateTime = $obj->get_DateTime_object($datetime_field_name);
+		$DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-');
+		return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
+	}
 
 
-    /**
-     * Simply takes an incoming DateTime object and does calculations on it based on the incoming parameters
-     *
-     * @param  DateTime   $DateTime DateTime object
-     * @param  string     $period   a value to indicate what interval is being used in the calculation. The options are
-     *                              'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
-     * @param  int|string $value    What you want to increment the date by
-     * @param  string     $operand  What operand you wish to use for the calculation
-     * @return DateTime return whatever type came in.
-     * @throws Exception
-     * @throws EE_Error
-     */
-    protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+')
-    {
-        if (! $DateTime instanceof DateTime) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
-                    print_r($DateTime, true)
-                )
-            );
-        }
-        switch ($period) {
-            case 'years':
-                $value = 'P' . $value . 'Y';
-                break;
-            case 'months':
-                $value = 'P' . $value . 'M';
-                break;
-            case 'weeks':
-                $value = 'P' . $value . 'W';
-                break;
-            case 'days':
-                $value = 'P' . $value . 'D';
-                break;
-            case 'hours':
-                $value = 'PT' . $value . 'H';
-                break;
-            case 'minutes':
-                $value = 'PT' . $value . 'M';
-                break;
-            case 'seconds':
-                $value = 'PT' . $value . 'S';
-                break;
-        }
-        switch ($operand) {
-            case '+':
-                $DateTime->add(new DateInterval($value));
-                break;
-            case '-':
-                $DateTime->sub(new DateInterval($value));
-                break;
-        }
-        return $DateTime;
-    }
+	/**
+	 * Simply takes an incoming DateTime object and does calculations on it based on the incoming parameters
+	 *
+	 * @param  DateTime   $DateTime DateTime object
+	 * @param  string     $period   a value to indicate what interval is being used in the calculation. The options are
+	 *                              'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
+	 * @param  int|string $value    What you want to increment the date by
+	 * @param  string     $operand  What operand you wish to use for the calculation
+	 * @return DateTime return whatever type came in.
+	 * @throws Exception
+	 * @throws EE_Error
+	 */
+	protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+')
+	{
+		if (! $DateTime instanceof DateTime) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
+					print_r($DateTime, true)
+				)
+			);
+		}
+		switch ($period) {
+			case 'years':
+				$value = 'P' . $value . 'Y';
+				break;
+			case 'months':
+				$value = 'P' . $value . 'M';
+				break;
+			case 'weeks':
+				$value = 'P' . $value . 'W';
+				break;
+			case 'days':
+				$value = 'P' . $value . 'D';
+				break;
+			case 'hours':
+				$value = 'PT' . $value . 'H';
+				break;
+			case 'minutes':
+				$value = 'PT' . $value . 'M';
+				break;
+			case 'seconds':
+				$value = 'PT' . $value . 'S';
+				break;
+		}
+		switch ($operand) {
+			case '+':
+				$DateTime->add(new DateInterval($value));
+				break;
+			case '-':
+				$DateTime->sub(new DateInterval($value));
+				break;
+		}
+		return $DateTime;
+	}
 
 
-    /**
-     * Simply takes an incoming Unix timestamp and does calculations on it based on the incoming parameters
-     *
-     * @param  int     $timestamp Unix timestamp
-     * @param  string  $period    a value to indicate what interval is being used in the calculation. The options are
-     *                            'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
-     * @param  integer $value     What you want to increment the date by
-     * @param  string  $operand   What operand you wish to use for the calculation
-     * @return int
-     * @throws EE_Error
-     */
-    protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+')
-    {
-        if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
-                    print_r($timestamp, true)
-                )
-            );
-        }
-        switch ($period) {
-            case 'years':
-                $value = YEAR_IN_SECONDS * $value;
-                break;
-            case 'months':
-                $value = YEAR_IN_SECONDS / 12 * $value;
-                break;
-            case 'weeks':
-                $value = WEEK_IN_SECONDS * $value;
-                break;
-            case 'days':
-                $value = DAY_IN_SECONDS * $value;
-                break;
-            case 'hours':
-                $value = HOUR_IN_SECONDS * $value;
-                break;
-            case 'minutes':
-                $value = MINUTE_IN_SECONDS * $value;
-                break;
-        }
-        switch ($operand) {
-            case '+':
-                $timestamp += $value;
-                break;
-            case '-':
-                $timestamp -= $value;
-                break;
-        }
-        return $timestamp;
-    }
+	/**
+	 * Simply takes an incoming Unix timestamp and does calculations on it based on the incoming parameters
+	 *
+	 * @param  int     $timestamp Unix timestamp
+	 * @param  string  $period    a value to indicate what interval is being used in the calculation. The options are
+	 *                            'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
+	 * @param  integer $value     What you want to increment the date by
+	 * @param  string  $operand   What operand you wish to use for the calculation
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+')
+	{
+		if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
+					print_r($timestamp, true)
+				)
+			);
+		}
+		switch ($period) {
+			case 'years':
+				$value = YEAR_IN_SECONDS * $value;
+				break;
+			case 'months':
+				$value = YEAR_IN_SECONDS / 12 * $value;
+				break;
+			case 'weeks':
+				$value = WEEK_IN_SECONDS * $value;
+				break;
+			case 'days':
+				$value = DAY_IN_SECONDS * $value;
+				break;
+			case 'hours':
+				$value = HOUR_IN_SECONDS * $value;
+				break;
+			case 'minutes':
+				$value = MINUTE_IN_SECONDS * $value;
+				break;
+		}
+		switch ($operand) {
+			case '+':
+				$timestamp += $value;
+				break;
+			case '-':
+				$timestamp -= $value;
+				break;
+		}
+		return $timestamp;
+	}
 
 
-    /**
-     * Simply takes an incoming UTC timestamp or DateTime object and does calculations on it based on the incoming
-     * parameters and returns the new timestamp or DateTime.
-     *
-     * @param  int | DateTime $DateTime_or_timestamp DateTime object or Unix timestamp
-     * @param  string         $period                a value to indicate what interval is being used in the
-     *                                               calculation. The options are 'years', 'months', 'days', 'hours',
-     *                                               'minutes', 'seconds'. Defaults to years.
-     * @param  integer        $value                 What you want to increment the date by
-     * @param  string         $operand               What operand you wish to use for the calculation
-     * @return mixed string|DateTime          return whatever type came in.
-     * @throws Exception
-     * @throws EE_Error
-     */
-    public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+')
-    {
-        if ($DateTime_or_timestamp instanceof DateTime) {
-            return EEH_DTT_Helper::_modify_datetime_object(
-                $DateTime_or_timestamp,
-                $period,
-                $value,
-                $operand
-            );
-        }
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
-            return EEH_DTT_Helper::_modify_timestamp(
-                $DateTime_or_timestamp,
-                $period,
-                $value,
-                $operand
-            );
-        }
-        // error
-        return $DateTime_or_timestamp;
-    }
+	/**
+	 * Simply takes an incoming UTC timestamp or DateTime object and does calculations on it based on the incoming
+	 * parameters and returns the new timestamp or DateTime.
+	 *
+	 * @param  int | DateTime $DateTime_or_timestamp DateTime object or Unix timestamp
+	 * @param  string         $period                a value to indicate what interval is being used in the
+	 *                                               calculation. The options are 'years', 'months', 'days', 'hours',
+	 *                                               'minutes', 'seconds'. Defaults to years.
+	 * @param  integer        $value                 What you want to increment the date by
+	 * @param  string         $operand               What operand you wish to use for the calculation
+	 * @return mixed string|DateTime          return whatever type came in.
+	 * @throws Exception
+	 * @throws EE_Error
+	 */
+	public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+')
+	{
+		if ($DateTime_or_timestamp instanceof DateTime) {
+			return EEH_DTT_Helper::_modify_datetime_object(
+				$DateTime_or_timestamp,
+				$period,
+				$value,
+				$operand
+			);
+		}
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
+			return EEH_DTT_Helper::_modify_timestamp(
+				$DateTime_or_timestamp,
+				$period,
+				$value,
+				$operand
+			);
+		}
+		// error
+		return $DateTime_or_timestamp;
+	}
 
 
-    /**
-     * The purpose of this helper method is to receive an incoming format string in php date/time format
-     * and spit out the js and moment.js equivalent formats.
-     * Note, if no format string is given, then it is assumed the user wants what is set for WP.
-     * Note, js date and time formats are those used by the jquery-ui datepicker and the jquery-ui date-
-     * time picker.
-     *
-     * @see http://stackoverflow.com/posts/16725290/ for the code inspiration.
-     * @param string $date_format_string
-     * @param string $time_format_string
-     * @return array
-     *              array(
-     *              'js' => array (
-     *              'date' => //date format
-     *              'time' => //time format
-     *              ),
-     *              'moment' => //date and time format.
-     *              )
-     */
-    public static function convert_php_to_js_and_moment_date_formats(
-        $date_format_string = null,
-        $time_format_string = null
-    ) {
-        if ($date_format_string === null) {
-            $date_format_string = (string) get_option('date_format');
-        }
-        if ($time_format_string === null) {
-            $time_format_string = (string) get_option('time_format');
-        }
-        $date_format = self::_php_to_js_moment_converter($date_format_string);
-        $time_format = self::_php_to_js_moment_converter($time_format_string);
-        return array(
-            'js'     => array(
-                'date' => $date_format['js'],
-                'time' => $time_format['js'],
-            ),
-            'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
-            'moment_split' => array(
-                'date' => $date_format['moment'],
-                'time' => $time_format['moment']
-            )
-        );
-    }
+	/**
+	 * The purpose of this helper method is to receive an incoming format string in php date/time format
+	 * and spit out the js and moment.js equivalent formats.
+	 * Note, if no format string is given, then it is assumed the user wants what is set for WP.
+	 * Note, js date and time formats are those used by the jquery-ui datepicker and the jquery-ui date-
+	 * time picker.
+	 *
+	 * @see http://stackoverflow.com/posts/16725290/ for the code inspiration.
+	 * @param string $date_format_string
+	 * @param string $time_format_string
+	 * @return array
+	 *              array(
+	 *              'js' => array (
+	 *              'date' => //date format
+	 *              'time' => //time format
+	 *              ),
+	 *              'moment' => //date and time format.
+	 *              )
+	 */
+	public static function convert_php_to_js_and_moment_date_formats(
+		$date_format_string = null,
+		$time_format_string = null
+	) {
+		if ($date_format_string === null) {
+			$date_format_string = (string) get_option('date_format');
+		}
+		if ($time_format_string === null) {
+			$time_format_string = (string) get_option('time_format');
+		}
+		$date_format = self::_php_to_js_moment_converter($date_format_string);
+		$time_format = self::_php_to_js_moment_converter($time_format_string);
+		return array(
+			'js'     => array(
+				'date' => $date_format['js'],
+				'time' => $time_format['js'],
+			),
+			'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
+			'moment_split' => array(
+				'date' => $date_format['moment'],
+				'time' => $time_format['moment']
+			)
+		);
+	}
 
 
-    /**
-     * This converts incoming format string into js and moment variations.
-     *
-     * @param string $format_string incoming php format string
-     * @return array js and moment formats.
-     */
-    protected static function _php_to_js_moment_converter($format_string)
-    {
-        /**
-         * This is a map of symbols for formats.
-         * The index is the php symbol, the equivalent values are in the array.
-         *
-         * @var array
-         */
-        $symbols_map          = array(
-            // Day
-            // 01
-            'd' => array(
-                'js'     => 'dd',
-                'moment' => 'DD',
-            ),
-            // Mon
-            'D' => array(
-                'js'     => 'D',
-                'moment' => 'ddd',
-            ),
-            // 1,2,...31
-            'j' => array(
-                'js'     => 'd',
-                'moment' => 'D',
-            ),
-            // Monday
-            'l' => array(
-                'js'     => 'DD',
-                'moment' => 'dddd',
-            ),
-            // ISO numeric representation of the day of the week (1-6)
-            'N' => array(
-                'js'     => '',
-                'moment' => 'E',
-            ),
-            // st,nd.rd
-            'S' => array(
-                'js'     => '',
-                'moment' => 'o',
-            ),
-            // numeric representation of day of week (0-6)
-            'w' => array(
-                'js'     => '',
-                'moment' => 'd',
-            ),
-            // day of year starting from 0 (0-365)
-            'z' => array(
-                'js'     => 'o',
-                'moment' => 'DDD' // note moment does not start with 0 so will need to modify by subtracting 1
-            ),
-            // Week
-            // ISO-8601 week number of year (weeks starting on monday)
-            'W' => array(
-                'js'     => '',
-                'moment' => 'w',
-            ),
-            // Month
-            // January...December
-            'F' => array(
-                'js'     => 'MM',
-                'moment' => 'MMMM',
-            ),
-            // 01...12
-            'm' => array(
-                'js'     => 'mm',
-                'moment' => 'MM',
-            ),
-            // Jan...Dec
-            'M' => array(
-                'js'     => 'M',
-                'moment' => 'MMM',
-            ),
-            // 1-12
-            'n' => array(
-                'js'     => 'm',
-                'moment' => 'M',
-            ),
-            // number of days in given month
-            't' => array(
-                'js'     => '',
-                'moment' => '',
-            ),
-            // Year
-            // whether leap year or not 1/0
-            'L' => array(
-                'js'     => '',
-                'moment' => '',
-            ),
-            // ISO-8601 year number
-            'o' => array(
-                'js'     => '',
-                'moment' => 'GGGG',
-            ),
-            // 1999...2003
-            'Y' => array(
-                'js'     => 'yy',
-                'moment' => 'YYYY',
-            ),
-            // 99...03
-            'y' => array(
-                'js'     => 'y',
-                'moment' => 'YY',
-            ),
-            // Time
-            // am/pm
-            'a' => array(
-                'js'     => 'tt',
-                'moment' => 'a',
-            ),
-            // AM/PM
-            'A' => array(
-                'js'     => 'TT',
-                'moment' => 'A',
-            ),
-            // Swatch Internet Time?!?
-            'B' => array(
-                'js'     => '',
-                'moment' => '',
-            ),
-            // 1...12
-            'g' => array(
-                'js'     => 'h',
-                'moment' => 'h',
-            ),
-            // 0...23
-            'G' => array(
-                'js'     => 'H',
-                'moment' => 'H',
-            ),
-            // 01...12
-            'h' => array(
-                'js'     => 'hh',
-                'moment' => 'hh',
-            ),
-            // 00...23
-            'H' => array(
-                'js'     => 'HH',
-                'moment' => 'HH',
-            ),
-            // 00..59
-            'i' => array(
-                'js'     => 'mm',
-                'moment' => 'mm',
-            ),
-            // seconds... 00...59
-            's' => array(
-                'js'     => 'ss',
-                'moment' => 'ss',
-            ),
-            // microseconds
-            'u' => array(
-                'js'     => '',
-                'moment' => '',
-            ),
-        );
-        $jquery_ui_format     = '';
-        $moment_format        = '';
-        $escaping             = false;
-        $format_string_length = strlen($format_string);
-        for ($i = 0; $i < $format_string_length; $i++) {
-            $char = $format_string[ $i ];
-            if ($char === '\\') { // PHP date format escaping character
-                $i++;
-                if ($escaping) {
-                    $jquery_ui_format .= $format_string[ $i ];
-                    $moment_format    .= $format_string[ $i ];
-                } else {
-                    $jquery_ui_format .= '\'' . $format_string[ $i ];
-                    $moment_format    .= $format_string[ $i ];
-                }
-                $escaping = true;
-            } else {
-                if ($escaping) {
-                    $jquery_ui_format .= "'";
-                    $moment_format    .= "'";
-                    $escaping         = false;
-                }
-                if (isset($symbols_map[ $char ])) {
-                    $jquery_ui_format .= $symbols_map[ $char ]['js'];
-                    $moment_format    .= $symbols_map[ $char ]['moment'];
-                } else {
-                    $jquery_ui_format .= $char;
-                    $moment_format    .= $char;
-                }
-            }
-        }
-        return array('js' => $jquery_ui_format, 'moment' => $moment_format);
-    }
+	/**
+	 * This converts incoming format string into js and moment variations.
+	 *
+	 * @param string $format_string incoming php format string
+	 * @return array js and moment formats.
+	 */
+	protected static function _php_to_js_moment_converter($format_string)
+	{
+		/**
+		 * This is a map of symbols for formats.
+		 * The index is the php symbol, the equivalent values are in the array.
+		 *
+		 * @var array
+		 */
+		$symbols_map          = array(
+			// Day
+			// 01
+			'd' => array(
+				'js'     => 'dd',
+				'moment' => 'DD',
+			),
+			// Mon
+			'D' => array(
+				'js'     => 'D',
+				'moment' => 'ddd',
+			),
+			// 1,2,...31
+			'j' => array(
+				'js'     => 'd',
+				'moment' => 'D',
+			),
+			// Monday
+			'l' => array(
+				'js'     => 'DD',
+				'moment' => 'dddd',
+			),
+			// ISO numeric representation of the day of the week (1-6)
+			'N' => array(
+				'js'     => '',
+				'moment' => 'E',
+			),
+			// st,nd.rd
+			'S' => array(
+				'js'     => '',
+				'moment' => 'o',
+			),
+			// numeric representation of day of week (0-6)
+			'w' => array(
+				'js'     => '',
+				'moment' => 'd',
+			),
+			// day of year starting from 0 (0-365)
+			'z' => array(
+				'js'     => 'o',
+				'moment' => 'DDD' // note moment does not start with 0 so will need to modify by subtracting 1
+			),
+			// Week
+			// ISO-8601 week number of year (weeks starting on monday)
+			'W' => array(
+				'js'     => '',
+				'moment' => 'w',
+			),
+			// Month
+			// January...December
+			'F' => array(
+				'js'     => 'MM',
+				'moment' => 'MMMM',
+			),
+			// 01...12
+			'm' => array(
+				'js'     => 'mm',
+				'moment' => 'MM',
+			),
+			// Jan...Dec
+			'M' => array(
+				'js'     => 'M',
+				'moment' => 'MMM',
+			),
+			// 1-12
+			'n' => array(
+				'js'     => 'm',
+				'moment' => 'M',
+			),
+			// number of days in given month
+			't' => array(
+				'js'     => '',
+				'moment' => '',
+			),
+			// Year
+			// whether leap year or not 1/0
+			'L' => array(
+				'js'     => '',
+				'moment' => '',
+			),
+			// ISO-8601 year number
+			'o' => array(
+				'js'     => '',
+				'moment' => 'GGGG',
+			),
+			// 1999...2003
+			'Y' => array(
+				'js'     => 'yy',
+				'moment' => 'YYYY',
+			),
+			// 99...03
+			'y' => array(
+				'js'     => 'y',
+				'moment' => 'YY',
+			),
+			// Time
+			// am/pm
+			'a' => array(
+				'js'     => 'tt',
+				'moment' => 'a',
+			),
+			// AM/PM
+			'A' => array(
+				'js'     => 'TT',
+				'moment' => 'A',
+			),
+			// Swatch Internet Time?!?
+			'B' => array(
+				'js'     => '',
+				'moment' => '',
+			),
+			// 1...12
+			'g' => array(
+				'js'     => 'h',
+				'moment' => 'h',
+			),
+			// 0...23
+			'G' => array(
+				'js'     => 'H',
+				'moment' => 'H',
+			),
+			// 01...12
+			'h' => array(
+				'js'     => 'hh',
+				'moment' => 'hh',
+			),
+			// 00...23
+			'H' => array(
+				'js'     => 'HH',
+				'moment' => 'HH',
+			),
+			// 00..59
+			'i' => array(
+				'js'     => 'mm',
+				'moment' => 'mm',
+			),
+			// seconds... 00...59
+			's' => array(
+				'js'     => 'ss',
+				'moment' => 'ss',
+			),
+			// microseconds
+			'u' => array(
+				'js'     => '',
+				'moment' => '',
+			),
+		);
+		$jquery_ui_format     = '';
+		$moment_format        = '';
+		$escaping             = false;
+		$format_string_length = strlen($format_string);
+		for ($i = 0; $i < $format_string_length; $i++) {
+			$char = $format_string[ $i ];
+			if ($char === '\\') { // PHP date format escaping character
+				$i++;
+				if ($escaping) {
+					$jquery_ui_format .= $format_string[ $i ];
+					$moment_format    .= $format_string[ $i ];
+				} else {
+					$jquery_ui_format .= '\'' . $format_string[ $i ];
+					$moment_format    .= $format_string[ $i ];
+				}
+				$escaping = true;
+			} else {
+				if ($escaping) {
+					$jquery_ui_format .= "'";
+					$moment_format    .= "'";
+					$escaping         = false;
+				}
+				if (isset($symbols_map[ $char ])) {
+					$jquery_ui_format .= $symbols_map[ $char ]['js'];
+					$moment_format    .= $symbols_map[ $char ]['moment'];
+				} else {
+					$jquery_ui_format .= $char;
+					$moment_format    .= $char;
+				}
+			}
+		}
+		return array('js' => $jquery_ui_format, 'moment' => $moment_format);
+	}
 
 
-    /**
-     * This takes an incoming format string and validates it to ensure it will work fine with PHP.
-     *
-     * @param string $format_string   Incoming format string for php date().
-     * @return mixed bool|array  If all is okay then TRUE is returned.  Otherwise an array of validation
-     *                                errors is returned.  So for client code calling, check for is_array() to
-     *                                indicate failed validations.
-     */
-    public static function validate_format_string($format_string)
-    {
-        $error_msg = array();
-        // time format checks
-        switch (true) {
-            case strpos($format_string, 'h') !== false:
-            case strpos($format_string, 'g') !== false:
-                /**
-                 * if the time string has a lowercase 'h' which == 12 hour time format and there
-                 * is not any ante meridiem format ('a' or 'A').  Then throw an error because its
-                 * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am.
-                 */
-                if (stripos($format_string, 'A') === false) {
-                    $error_msg[] = esc_html__(
-                        'There is a  time format for 12 hour time but no  "a" or "A" to indicate am/pm.  Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".',
-                        'event_espresso'
-                    );
-                }
-                break;
-        }
-        return empty($error_msg) ? true : $error_msg;
-    }
+	/**
+	 * This takes an incoming format string and validates it to ensure it will work fine with PHP.
+	 *
+	 * @param string $format_string   Incoming format string for php date().
+	 * @return mixed bool|array  If all is okay then TRUE is returned.  Otherwise an array of validation
+	 *                                errors is returned.  So for client code calling, check for is_array() to
+	 *                                indicate failed validations.
+	 */
+	public static function validate_format_string($format_string)
+	{
+		$error_msg = array();
+		// time format checks
+		switch (true) {
+			case strpos($format_string, 'h') !== false:
+			case strpos($format_string, 'g') !== false:
+				/**
+				 * if the time string has a lowercase 'h' which == 12 hour time format and there
+				 * is not any ante meridiem format ('a' or 'A').  Then throw an error because its
+				 * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am.
+				 */
+				if (stripos($format_string, 'A') === false) {
+					$error_msg[] = esc_html__(
+						'There is a  time format for 12 hour time but no  "a" or "A" to indicate am/pm.  Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".',
+						'event_espresso'
+					);
+				}
+				break;
+		}
+		return empty($error_msg) ? true : $error_msg;
+	}
 
 
-    /**
-     *     If the the first date starts at midnight on one day, and the next date ends at midnight on the
-     *     very next day then this method will return true.
-     *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-16 00:00:00 then this function will return true.
-     *    If $date_1 = 2015-12-15 03:00:00 and $date_2 = 2015-12_16 03:00:00 then this function will return false.
-     *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-15 00:00:00 then this function will return true.
-     *
-     * @param mixed $date_1
-     * @param mixed $date_2
-     * @return bool
-     */
-    public static function dates_represent_one_24_hour_date($date_1, $date_2)
-    {
+	/**
+	 *     If the the first date starts at midnight on one day, and the next date ends at midnight on the
+	 *     very next day then this method will return true.
+	 *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-16 00:00:00 then this function will return true.
+	 *    If $date_1 = 2015-12-15 03:00:00 and $date_2 = 2015-12_16 03:00:00 then this function will return false.
+	 *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-15 00:00:00 then this function will return true.
+	 *
+	 * @param mixed $date_1
+	 * @param mixed $date_2
+	 * @return bool
+	 */
+	public static function dates_represent_one_24_hour_date($date_1, $date_2)
+	{
 
-        if ((! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime)
-            || ($date_1->format(EE_Datetime_Field::mysql_time_format) !== '00:00:00'
-                || $date_2->format(
-                    EE_Datetime_Field::mysql_time_format
-                ) !== '00:00:00')
-        ) {
-            return false;
-        }
-        return $date_2->format('U') - $date_1->format('U') === 86400;
-    }
+		if ((! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime)
+			|| ($date_1->format(EE_Datetime_Field::mysql_time_format) !== '00:00:00'
+				|| $date_2->format(
+					EE_Datetime_Field::mysql_time_format
+				) !== '00:00:00')
+		) {
+			return false;
+		}
+		return $date_2->format('U') - $date_1->format('U') === 86400;
+	}
 
 
-    /**
-     * This returns the appropriate query interval string that can be used in sql queries involving mysql Date
-     * Functions.
-     *
-     * @param string $timezone_string    A timezone string in a valid format to instantiate a DateTimeZone object.
-     * @param string $field_for_interval The Database field that is the interval is applied to in the query.
-     * @return string
-     */
-    public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval)
-    {
-        try {
-            /** need to account for timezone offset on the selects */
-            $DateTimeZone = new DateTimeZone($timezone_string);
-        } catch (Exception $e) {
-            $DateTimeZone = null;
-        }
-        /**
-         * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds.
-         * Hence we do the calc for DateTimeZone::getOffset.
-         */
-        $offset         = $DateTimeZone instanceof DateTimeZone
-            ? $DateTimeZone->getOffset(new DateTime('now')) / HOUR_IN_SECONDS
-            : (float) get_option('gmt_offset');
-        $query_interval = $offset < 0
-            ? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)'
-            : 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)';
-        return $query_interval;
-    }
+	/**
+	 * This returns the appropriate query interval string that can be used in sql queries involving mysql Date
+	 * Functions.
+	 *
+	 * @param string $timezone_string    A timezone string in a valid format to instantiate a DateTimeZone object.
+	 * @param string $field_for_interval The Database field that is the interval is applied to in the query.
+	 * @return string
+	 */
+	public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval)
+	{
+		try {
+			/** need to account for timezone offset on the selects */
+			$DateTimeZone = new DateTimeZone($timezone_string);
+		} catch (Exception $e) {
+			$DateTimeZone = null;
+		}
+		/**
+		 * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds.
+		 * Hence we do the calc for DateTimeZone::getOffset.
+		 */
+		$offset         = $DateTimeZone instanceof DateTimeZone
+			? $DateTimeZone->getOffset(new DateTime('now')) / HOUR_IN_SECONDS
+			: (float) get_option('gmt_offset');
+		$query_interval = $offset < 0
+			? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)'
+			: 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)';
+		return $query_interval;
+	}
 
 
-    /**
-     * Retrieves the site's default timezone and returns it formatted so it's ready for display
-     * to users. If you want to customize how its displayed feel free to fetch the 'timezone_string'
-     * and 'gmt_offset' WordPress options directly; or use the filter
-     * FHEE__EEH_DTT_Helper__get_timezone_string_for_display
-     * (although note that we remove any HTML that may be added)
-     *
-     * @return string
-     */
-    public static function get_timezone_string_for_display()
-    {
-        $pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
-        if (! empty($pretty_timezone)) {
-            return esc_html($pretty_timezone);
-        }
-        $timezone_string = get_option('timezone_string');
-        if ($timezone_string) {
-            static $mo_loaded = false;
-            // Load translations for continents and cities just like wp_timezone_choice does
-            if (! $mo_loaded) {
-                $locale = get_locale();
-                $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
-                load_textdomain('continents-cities', $mofile);
-                $mo_loaded = true;
-            }
-            // well that was easy.
-            $parts = explode('/', $timezone_string);
-            // remove the continent
-            unset($parts[0]);
-            $t_parts = array();
-            // phpcs:disable WordPress.WP.I18n.NonSingularStringLiteralText
-            // phpcs:disable WordPress.WP.I18n.TextDomainMismatch
-            // disabled because this code is copied from WordPress and is a WordPress domain
-            foreach ($parts as $part) {
-                $t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities');
-            }
-            return implode(' - ', $t_parts);
-            // phpcs:enable
-        }
-        // they haven't set the timezone string, so let's return a string like "UTC+1"
-        $gmt_offset = get_option('gmt_offset');
-        $prefix     = (int) $gmt_offset >= 0 ? '+' : '';
-        $parts      = explode('.', (string) $gmt_offset);
-        if (count($parts) === 1) {
-            $parts[1] = '00';
-        } else {
-            // convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
-            // to minutes, eg 30 or 15, respectively
-            $hour_fraction = (float) ('0.' . $parts[1]);
-            $parts[1]      = (string) $hour_fraction * 60;
-        }
-        return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts));
-    }
+	/**
+	 * Retrieves the site's default timezone and returns it formatted so it's ready for display
+	 * to users. If you want to customize how its displayed feel free to fetch the 'timezone_string'
+	 * and 'gmt_offset' WordPress options directly; or use the filter
+	 * FHEE__EEH_DTT_Helper__get_timezone_string_for_display
+	 * (although note that we remove any HTML that may be added)
+	 *
+	 * @return string
+	 */
+	public static function get_timezone_string_for_display()
+	{
+		$pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
+		if (! empty($pretty_timezone)) {
+			return esc_html($pretty_timezone);
+		}
+		$timezone_string = get_option('timezone_string');
+		if ($timezone_string) {
+			static $mo_loaded = false;
+			// Load translations for continents and cities just like wp_timezone_choice does
+			if (! $mo_loaded) {
+				$locale = get_locale();
+				$mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
+				load_textdomain('continents-cities', $mofile);
+				$mo_loaded = true;
+			}
+			// well that was easy.
+			$parts = explode('/', $timezone_string);
+			// remove the continent
+			unset($parts[0]);
+			$t_parts = array();
+			// phpcs:disable WordPress.WP.I18n.NonSingularStringLiteralText
+			// phpcs:disable WordPress.WP.I18n.TextDomainMismatch
+			// disabled because this code is copied from WordPress and is a WordPress domain
+			foreach ($parts as $part) {
+				$t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities');
+			}
+			return implode(' - ', $t_parts);
+			// phpcs:enable
+		}
+		// they haven't set the timezone string, so let's return a string like "UTC+1"
+		$gmt_offset = get_option('gmt_offset');
+		$prefix     = (int) $gmt_offset >= 0 ? '+' : '';
+		$parts      = explode('.', (string) $gmt_offset);
+		if (count($parts) === 1) {
+			$parts[1] = '00';
+		} else {
+			// convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
+			// to minutes, eg 30 or 15, respectively
+			$hour_fraction = (float) ('0.' . $parts[1]);
+			$parts[1]      = (string) $hour_fraction * 60;
+		}
+		return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts));
+	}
 
 
 
-    /**
-     * So PHP does this awesome thing where if you are trying to get a timestamp
-     * for a month using a string like "February" or "February 2017",
-     * and you don't specify a day as part of your string,
-     * then PHP will use whatever the current day of the month is.
-     * IF the current day of the month happens to be the 30th or 31st,
-     * then PHP gets really confused by a date like February 30,
-     * so instead of saying
-     *      "Hey February only has 28 days (this year)...
-     *      ...you must have meant the last day of the month!"
-     * PHP does the next most logical thing, and bumps the date up to March 2nd,
-     * because someone requesting February 30th obviously meant March 1st!
-     * The way around this is to always set the day to the first,
-     * so that the month will stay on the month you wanted.
-     * this method will add that "1" into your date regardless of the format.
-     *
-     * @param string $month
-     * @return string
-     */
-    public static function first_of_month_timestamp($month = '')
-    {
-        $month = (string) $month;
-        $year  = '';
-        // check if the incoming string has a year in it or not
-        if (preg_match('/\b\d{4}\b/', $month, $matches)) {
-            $year = $matches[0];
-            // ten remove that from the month string as well as any spaces
-            $month = trim(str_replace($year, '', $month));
-            // add a space before the year
-            $year = " {$year}";
-        }
-        // return timestamp for something like "February 1 2017"
-        return strtotime("{$month} 1{$year}");
-    }
+	/**
+	 * So PHP does this awesome thing where if you are trying to get a timestamp
+	 * for a month using a string like "February" or "February 2017",
+	 * and you don't specify a day as part of your string,
+	 * then PHP will use whatever the current day of the month is.
+	 * IF the current day of the month happens to be the 30th or 31st,
+	 * then PHP gets really confused by a date like February 30,
+	 * so instead of saying
+	 *      "Hey February only has 28 days (this year)...
+	 *      ...you must have meant the last day of the month!"
+	 * PHP does the next most logical thing, and bumps the date up to March 2nd,
+	 * because someone requesting February 30th obviously meant March 1st!
+	 * The way around this is to always set the day to the first,
+	 * so that the month will stay on the month you wanted.
+	 * this method will add that "1" into your date regardless of the format.
+	 *
+	 * @param string $month
+	 * @return string
+	 */
+	public static function first_of_month_timestamp($month = '')
+	{
+		$month = (string) $month;
+		$year  = '';
+		// check if the incoming string has a year in it or not
+		if (preg_match('/\b\d{4}\b/', $month, $matches)) {
+			$year = $matches[0];
+			// ten remove that from the month string as well as any spaces
+			$month = trim(str_replace($year, '', $month));
+			// add a space before the year
+			$year = " {$year}";
+		}
+		// return timestamp for something like "February 1 2017"
+		return strtotime("{$month} 1{$year}");
+	}
 
 
-    /**
-     * This simply returns the timestamp for tomorrow (midnight next day) in this sites timezone.  So it may be midnight
-     * for this sites timezone, but the timestamp could be some other time GMT.
-     */
-    public static function tomorrow()
-    {
-        // The multiplication of -1 ensures that we switch positive offsets to negative and negative offsets to positive
-        // before adding to the timestamp.  Why? Because we want tomorrow to be for midnight the next day in THIS timezone
-        // not an offset from midnight in UTC.  So if we're starting with UTC 00:00:00, then we want to make sure the
-        // final timestamp is equivalent to midnight in this timezone as represented in GMT.
-        return strtotime('tomorrow') + (self::get_site_timezone_gmt_offset() * -1);
-    }
+	/**
+	 * This simply returns the timestamp for tomorrow (midnight next day) in this sites timezone.  So it may be midnight
+	 * for this sites timezone, but the timestamp could be some other time GMT.
+	 */
+	public static function tomorrow()
+	{
+		// The multiplication of -1 ensures that we switch positive offsets to negative and negative offsets to positive
+		// before adding to the timestamp.  Why? Because we want tomorrow to be for midnight the next day in THIS timezone
+		// not an offset from midnight in UTC.  So if we're starting with UTC 00:00:00, then we want to make sure the
+		// final timestamp is equivalent to midnight in this timezone as represented in GMT.
+		return strtotime('tomorrow') + (self::get_site_timezone_gmt_offset() * -1);
+	}
 
 
-    /**
-     * **
-     * Gives a nicely-formatted list of timezone strings.
-     * Copied from the core wp function by the same name so we could customize to remove UTC offsets.
-     *
-     * @since     4.9.40.rc.008
-     * @staticvar bool $mo_loaded
-     * @staticvar string $locale_loaded
-     * @param string $selected_zone Selected timezone.
-     * @param string $locale        Optional. Locale to load the timezones in. Default current site locale.
-     * @return string
-     */
-    public static function wp_timezone_choice($selected_zone, $locale = null)
-    {
-        static $mo_loaded = false, $locale_loaded = null;
-        $continents = array(
-            'Africa',
-            'America',
-            'Antarctica',
-            'Arctic',
-            'Asia',
-            'Atlantic',
-            'Australia',
-            'Europe',
-            'Indian',
-            'Pacific',
-        );
-        // Load translations for continents and cities.
-        if (! $mo_loaded || $locale !== $locale_loaded) {
-            $locale_loaded = $locale ? $locale : get_locale();
-            $mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
-            unload_textdomain('continents-cities');
-            load_textdomain('continents-cities', $mofile);
-            $mo_loaded = true;
-        }
-        $zone_data = array();
-        foreach (timezone_identifiers_list() as $zone) {
-            $zone = explode('/', $zone);
-            if (! in_array($zone[0], $continents, true)) {
-                continue;
-            }
-            // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
-            $exists      = array(
-                0 => isset($zone[0]) && $zone[0],
-                1 => isset($zone[1]) && $zone[1],
-                2 => isset($zone[2]) && $zone[2],
-            );
-            $exists[3]   = $exists[0] && $zone[0] !== 'Etc';
-            $exists[4]   = $exists[1] && $exists[3];
-            $exists[5]   = $exists[2] && $exists[3];
-            // phpcs:disable WordPress.WP.I18n.NonSingularStringLiteralText
-            // phpcs:disable WordPress.WP.I18n.TextDomainMismatch
-            // disabled because this code is copied from WordPress and is a WordPress domain
-            $zone_data[] = array(
-                'continent'   => $exists[0] ? $zone[0] : '',
-                'city'        => $exists[1] ? $zone[1] : '',
-                'subcity'     => $exists[2] ? $zone[2] : '',
-                't_continent' => $exists[3]
-                    ? translate(str_replace('_', ' ', $zone[0]), 'continents-cities')
-                    : '',
-                't_city'      => $exists[4]
-                    ? translate(str_replace('_', ' ', $zone[1]), 'continents-cities')
-                    : '',
-                't_subcity'   => $exists[5]
-                    ? translate(str_replace('_', ' ', $zone[2]), 'continents-cities')
-                    : '',
-            );
-            // phpcs:enable
-        }
-        usort($zone_data, '_wp_timezone_choice_usort_callback');
-        $structure = array();
-        if (empty($selected_zone)) {
-            $structure[] = '<option selected="selected" value="">' . __('Select a city', 'event_espresso') . '</option>';
-        }
-        foreach ($zone_data as $key => $zone) {
-            // Build value in an array to join later
-            $value = array($zone['continent']);
-            if (empty($zone['city'])) {
-                // It's at the continent level (generally won't happen)
-                $display = $zone['t_continent'];
-            } else {
-                // It's inside a continent group
-                // Continent optgroup
-                if (! isset($zone_data[ $key - 1 ]) || $zone_data[ $key - 1 ]['continent'] !== $zone['continent']) {
-                    $label       = $zone['t_continent'];
-                    $structure[] = '<optgroup label="' . esc_attr($label) . '">';
-                }
-                // Add the city to the value
-                $value[] = $zone['city'];
-                $display = $zone['t_city'];
-                if (! empty($zone['subcity'])) {
-                    // Add the subcity to the value
-                    $value[] = $zone['subcity'];
-                    $display .= ' - ' . $zone['t_subcity'];
-                }
-            }
-            // Build the value
-            $value       = implode('/', $value);
-            $selected    = $value === $selected_zone ? ' selected="selected"' : '';
-            $structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>'
-                           . esc_html($display)
-                           . '</option>';
-            // Close continent optgroup
-            if (! empty($zone['city'])
-                && (
-                    ! isset($zone_data[ $key + 1 ])
-                    || (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent'])
-                )
-            ) {
-                $structure[] = '</optgroup>';
-            }
-        }
-        return implode("\n", $structure);
-    }
+	/**
+	 * **
+	 * Gives a nicely-formatted list of timezone strings.
+	 * Copied from the core wp function by the same name so we could customize to remove UTC offsets.
+	 *
+	 * @since     4.9.40.rc.008
+	 * @staticvar bool $mo_loaded
+	 * @staticvar string $locale_loaded
+	 * @param string $selected_zone Selected timezone.
+	 * @param string $locale        Optional. Locale to load the timezones in. Default current site locale.
+	 * @return string
+	 */
+	public static function wp_timezone_choice($selected_zone, $locale = null)
+	{
+		static $mo_loaded = false, $locale_loaded = null;
+		$continents = array(
+			'Africa',
+			'America',
+			'Antarctica',
+			'Arctic',
+			'Asia',
+			'Atlantic',
+			'Australia',
+			'Europe',
+			'Indian',
+			'Pacific',
+		);
+		// Load translations for continents and cities.
+		if (! $mo_loaded || $locale !== $locale_loaded) {
+			$locale_loaded = $locale ? $locale : get_locale();
+			$mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
+			unload_textdomain('continents-cities');
+			load_textdomain('continents-cities', $mofile);
+			$mo_loaded = true;
+		}
+		$zone_data = array();
+		foreach (timezone_identifiers_list() as $zone) {
+			$zone = explode('/', $zone);
+			if (! in_array($zone[0], $continents, true)) {
+				continue;
+			}
+			// This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
+			$exists      = array(
+				0 => isset($zone[0]) && $zone[0],
+				1 => isset($zone[1]) && $zone[1],
+				2 => isset($zone[2]) && $zone[2],
+			);
+			$exists[3]   = $exists[0] && $zone[0] !== 'Etc';
+			$exists[4]   = $exists[1] && $exists[3];
+			$exists[5]   = $exists[2] && $exists[3];
+			// phpcs:disable WordPress.WP.I18n.NonSingularStringLiteralText
+			// phpcs:disable WordPress.WP.I18n.TextDomainMismatch
+			// disabled because this code is copied from WordPress and is a WordPress domain
+			$zone_data[] = array(
+				'continent'   => $exists[0] ? $zone[0] : '',
+				'city'        => $exists[1] ? $zone[1] : '',
+				'subcity'     => $exists[2] ? $zone[2] : '',
+				't_continent' => $exists[3]
+					? translate(str_replace('_', ' ', $zone[0]), 'continents-cities')
+					: '',
+				't_city'      => $exists[4]
+					? translate(str_replace('_', ' ', $zone[1]), 'continents-cities')
+					: '',
+				't_subcity'   => $exists[5]
+					? translate(str_replace('_', ' ', $zone[2]), 'continents-cities')
+					: '',
+			);
+			// phpcs:enable
+		}
+		usort($zone_data, '_wp_timezone_choice_usort_callback');
+		$structure = array();
+		if (empty($selected_zone)) {
+			$structure[] = '<option selected="selected" value="">' . __('Select a city', 'event_espresso') . '</option>';
+		}
+		foreach ($zone_data as $key => $zone) {
+			// Build value in an array to join later
+			$value = array($zone['continent']);
+			if (empty($zone['city'])) {
+				// It's at the continent level (generally won't happen)
+				$display = $zone['t_continent'];
+			} else {
+				// It's inside a continent group
+				// Continent optgroup
+				if (! isset($zone_data[ $key - 1 ]) || $zone_data[ $key - 1 ]['continent'] !== $zone['continent']) {
+					$label       = $zone['t_continent'];
+					$structure[] = '<optgroup label="' . esc_attr($label) . '">';
+				}
+				// Add the city to the value
+				$value[] = $zone['city'];
+				$display = $zone['t_city'];
+				if (! empty($zone['subcity'])) {
+					// Add the subcity to the value
+					$value[] = $zone['subcity'];
+					$display .= ' - ' . $zone['t_subcity'];
+				}
+			}
+			// Build the value
+			$value       = implode('/', $value);
+			$selected    = $value === $selected_zone ? ' selected="selected"' : '';
+			$structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>'
+						   . esc_html($display)
+						   . '</option>';
+			// Close continent optgroup
+			if (! empty($zone['city'])
+				&& (
+					! isset($zone_data[ $key + 1 ])
+					|| (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent'])
+				)
+			) {
+				$structure[] = '</optgroup>';
+			}
+		}
+		return implode("\n", $structure);
+	}
 
 
-    /**
-     * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0
-     *
-     * @param int|WP_User $user_id
-     * @return string
-     */
-    public static function get_user_locale($user_id = 0)
-    {
-        if (function_exists('get_user_locale')) {
-            return get_user_locale($user_id);
-        }
-        return get_locale();
-    }
+	/**
+	 * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0
+	 *
+	 * @param int|WP_User $user_id
+	 * @return string
+	 */
+	public static function get_user_locale($user_id = 0)
+	{
+		if (function_exists('get_user_locale')) {
+			return get_user_locale($user_id);
+		}
+		return get_locale();
+	}
 
 
-    /**
-     * Return the appropriate helper adapter for DTT related things.
-     *
-     * @return HelperInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function getHelperAdapter()
-    {
-        $dtt_helper_fqcn = PHP_VERSION_ID < 50600
-            ? 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
-            : 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper';
-        return LoaderFactory::getLoader()->getShared($dtt_helper_fqcn);
-    }
+	/**
+	 * Return the appropriate helper adapter for DTT related things.
+	 *
+	 * @return HelperInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function getHelperAdapter()
+	{
+		$dtt_helper_fqcn = PHP_VERSION_ID < 50600
+			? 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
+			: 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper';
+		return LoaderFactory::getLoader()->getShared($dtt_helper_fqcn);
+	}
 
 
-    /**
-     * Helper function for setting the timezone on a DateTime object.
-     * This is implemented to standardize a workaround for a PHP bug outlined in
-     * https://events.codebasehq.com/projects/event-espresso/tickets/11407 and
-     * https://events.codebasehq.com/projects/event-espresso/tickets/11233
-     *
-     * @param DateTime     $datetime
-     * @param DateTimeZone $timezone
-     */
-    public static function setTimezone(DateTime $datetime, DateTimeZone $timezone)
-    {
-        $datetime->setTimezone($timezone);
-        $datetime->getTimestamp();
-    }
+	/**
+	 * Helper function for setting the timezone on a DateTime object.
+	 * This is implemented to standardize a workaround for a PHP bug outlined in
+	 * https://events.codebasehq.com/projects/event-espresso/tickets/11407 and
+	 * https://events.codebasehq.com/projects/event-espresso/tickets/11233
+	 *
+	 * @param DateTime     $datetime
+	 * @param DateTimeZone $timezone
+	 */
+	public static function setTimezone(DateTime $datetime, DateTimeZone $timezone)
+	{
+		$datetime->setTimezone($timezone);
+		$datetime->getTimestamp();
+	}
 }

Spacing +42 added lines, -42 removed lines

@@ -131,7 +131,7 @@ 
      */
     public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
     {
-        $gmt_offset =  (int) $gmt_offset;
+        $gmt_offset = (int) $gmt_offset;
         /** @var array[] $abbreviations */
         $abbreviations = DateTimeZone::listAbbreviations();
         foreach ($abbreviations as $abbreviation) {
@@ -326,7 +326,7 @@ 
      */
     protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+')
     {
-        if (! $DateTime instanceof DateTime) {
+        if ( ! $DateTime instanceof DateTime) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
@@ -336,25 +336,25 @@ 
         }
         switch ($period) {
             case 'years':
-                $value = 'P' . $value . 'Y';
+                $value = 'P'.$value.'Y';
                 break;
             case 'months':
-                $value = 'P' . $value . 'M';
+                $value = 'P'.$value.'M';
                 break;
             case 'weeks':
-                $value = 'P' . $value . 'W';
+                $value = 'P'.$value.'W';
                 break;
             case 'days':
-                $value = 'P' . $value . 'D';
+                $value = 'P'.$value.'D';
                 break;
             case 'hours':
-                $value = 'PT' . $value . 'H';
+                $value = 'PT'.$value.'H';
                 break;
             case 'minutes':
-                $value = 'PT' . $value . 'M';
+                $value = 'PT'.$value.'M';
                 break;
             case 'seconds':
-                $value = 'PT' . $value . 'S';
+                $value = 'PT'.$value.'S';
                 break;
         }
         switch ($operand) {
@@ -382,7 +382,7 @@ 
      */
     protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+')
     {
-        if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
+        if ( ! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
@@ -495,7 +495,7 @@ 
                 'date' => $date_format['js'],
                 'time' => $time_format['js'],
             ),
-            'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
+            'moment' => $date_format['moment'].' '.$time_format['moment'],
             'moment_split' => array(
                 'date' => $date_format['moment'],
                 'time' => $time_format['moment']
@@ -518,7 +518,7 @@ 
          *
          * @var array
          */
-        $symbols_map          = array(
+        $symbols_map = array(
             // Day
             // 01
             'd' => array(
@@ -670,26 +670,26 @@ 
         $escaping             = false;
         $format_string_length = strlen($format_string);
         for ($i = 0; $i < $format_string_length; $i++) {
-            $char = $format_string[ $i ];
+            $char = $format_string[$i];
             if ($char === '\\') { // PHP date format escaping character
                 $i++;
                 if ($escaping) {
-                    $jquery_ui_format .= $format_string[ $i ];
-                    $moment_format    .= $format_string[ $i ];
+                    $jquery_ui_format .= $format_string[$i];
+                    $moment_format    .= $format_string[$i];
                 } else {
-                    $jquery_ui_format .= '\'' . $format_string[ $i ];
-                    $moment_format    .= $format_string[ $i ];
+                    $jquery_ui_format .= '\''.$format_string[$i];
+                    $moment_format    .= $format_string[$i];
                 }
                 $escaping = true;
             } else {
                 if ($escaping) {
                     $jquery_ui_format .= "'";
                     $moment_format    .= "'";
-                    $escaping         = false;
+                    $escaping = false;
                 }
-                if (isset($symbols_map[ $char ])) {
-                    $jquery_ui_format .= $symbols_map[ $char ]['js'];
-                    $moment_format    .= $symbols_map[ $char ]['moment'];
+                if (isset($symbols_map[$char])) {
+                    $jquery_ui_format .= $symbols_map[$char]['js'];
+                    $moment_format    .= $symbols_map[$char]['moment'];
                 } else {
                     $jquery_ui_format .= $char;
                     $moment_format    .= $char;
@@ -746,7 +746,7 @@ 
     public static function dates_represent_one_24_hour_date($date_1, $date_2)
     {
 
-        if ((! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime)
+        if (( ! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime)
             || ($date_1->format(EE_Datetime_Field::mysql_time_format) !== '00:00:00'
                 || $date_2->format(
                     EE_Datetime_Field::mysql_time_format
@@ -782,8 +782,8 @@ 
             ? $DateTimeZone->getOffset(new DateTime('now')) / HOUR_IN_SECONDS
             : (float) get_option('gmt_offset');
         $query_interval = $offset < 0
-            ? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)'
-            : 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)';
+            ? 'DATE_SUB('.$field_for_interval.', INTERVAL '.$offset * -1.' HOUR)'
+            : 'DATE_ADD('.$field_for_interval.', INTERVAL '.$offset.' HOUR)';
         return $query_interval;
     }
 
@@ -800,16 +800,16 @@ 
     public static function get_timezone_string_for_display()
     {
         $pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
-        if (! empty($pretty_timezone)) {
+        if ( ! empty($pretty_timezone)) {
             return esc_html($pretty_timezone);
         }
         $timezone_string = get_option('timezone_string');
         if ($timezone_string) {
             static $mo_loaded = false;
             // Load translations for continents and cities just like wp_timezone_choice does
-            if (! $mo_loaded) {
+            if ( ! $mo_loaded) {
                 $locale = get_locale();
-                $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
+                $mofile = WP_LANG_DIR.'/continents-cities-'.$locale.'.mo';
                 load_textdomain('continents-cities', $mofile);
                 $mo_loaded = true;
             }
@@ -836,10 +836,10 @@ 
         } else {
             // convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
             // to minutes, eg 30 or 15, respectively
-            $hour_fraction = (float) ('0.' . $parts[1]);
+            $hour_fraction = (float) ('0.'.$parts[1]);
             $parts[1]      = (string) $hour_fraction * 60;
         }
-        return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts));
+        return sprintf(__('UTC%1$s', 'event_espresso'), $prefix.implode(':', $parts));
     }
 
 
@@ -922,9 +922,9 @@ 
             'Pacific',
         );
         // Load translations for continents and cities.
-        if (! $mo_loaded || $locale !== $locale_loaded) {
+        if ( ! $mo_loaded || $locale !== $locale_loaded) {
             $locale_loaded = $locale ? $locale : get_locale();
-            $mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
+            $mofile        = WP_LANG_DIR.'/continents-cities-'.$locale_loaded.'.mo';
             unload_textdomain('continents-cities');
             load_textdomain('continents-cities', $mofile);
             $mo_loaded = true;
@@ -932,11 +932,11 @@ 
         $zone_data = array();
         foreach (timezone_identifiers_list() as $zone) {
             $zone = explode('/', $zone);
-            if (! in_array($zone[0], $continents, true)) {
+            if ( ! in_array($zone[0], $continents, true)) {
                 continue;
             }
             // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
-            $exists      = array(
+            $exists = array(
                 0 => isset($zone[0]) && $zone[0],
                 1 => isset($zone[1]) && $zone[1],
                 2 => isset($zone[2]) && $zone[2],
@@ -966,7 +966,7 @@ 
         usort($zone_data, '_wp_timezone_choice_usort_callback');
         $structure = array();
         if (empty($selected_zone)) {
-            $structure[] = '<option selected="selected" value="">' . __('Select a city', 'event_espresso') . '</option>';
+            $structure[] = '<option selected="selected" value="">'.__('Select a city', 'event_espresso').'</option>';
         }
         foreach ($zone_data as $key => $zone) {
             // Build value in an array to join later
@@ -977,30 +977,30 @@ 
             } else {
                 // It's inside a continent group
                 // Continent optgroup
-                if (! isset($zone_data[ $key - 1 ]) || $zone_data[ $key - 1 ]['continent'] !== $zone['continent']) {
+                if ( ! isset($zone_data[$key - 1]) || $zone_data[$key - 1]['continent'] !== $zone['continent']) {
                     $label       = $zone['t_continent'];
-                    $structure[] = '<optgroup label="' . esc_attr($label) . '">';
+                    $structure[] = '<optgroup label="'.esc_attr($label).'">';
                 }
                 // Add the city to the value
                 $value[] = $zone['city'];
                 $display = $zone['t_city'];
-                if (! empty($zone['subcity'])) {
+                if ( ! empty($zone['subcity'])) {
                     // Add the subcity to the value
                     $value[] = $zone['subcity'];
-                    $display .= ' - ' . $zone['t_subcity'];
+                    $display .= ' - '.$zone['t_subcity'];
                 }
             }
             // Build the value
             $value       = implode('/', $value);
             $selected    = $value === $selected_zone ? ' selected="selected"' : '';
-            $structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>'
+            $structure[] = '<option value="'.esc_attr($value).'"'.$selected.'>'
                            . esc_html($display)
                            . '</option>';
             // Close continent optgroup
-            if (! empty($zone['city'])
+            if ( ! empty($zone['city'])
                 && (
-                    ! isset($zone_data[ $key + 1 ])
-                    || (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent'])
+                    ! isset($zone_data[$key + 1])
+                    || (isset($zone_data[$key + 1]) && $zone_data[$key + 1]['continent'] !== $zone['continent'])
                 )
             ) {
                 $structure[] = '</optgroup>';

core/services/helpers/datetime/HelperInterface.php

Indentation +90 added lines, -90 removed lines

@@ -16,94 +16,94 @@
 interface HelperInterface
 {
 
-    /**
-     * Ensures that a valid timezone string is returned.
-     *
-     * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
-     *                                 settings (or derive from set UTC offset).
-     * @return string
-     */
-    public function getValidTimezoneString($timezone_string = '');
-
-
-    /**
-     * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @param string $timezone_string
-     * @param bool   $throw_error
-     * @return bool
-     */
-    public function validateTimezone($timezone_string, $throw_error = true);
-
-
-    /**
-     * Returns a timezone string for the provided gmt_offset.
-     * @param float|string $gmt_offset
-     * @return string
-     */
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '');
-
-
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case the gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int  seconds offset
-     */
-    public function getSiteTimezoneGmtOffset();
-
-
-    /**
-     * Get timezone transitions
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array
-     */
-    public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true);
-
-
-    /**
-     * Get Timezone offset for given timezone object
-     * @param DateTimeZone $date_time_zone
-     * @param null|int         $time
-     * @return int
-     */
-    public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null);
-
-
-    /**
-     * Provide a timezone select input
-     * @param string $timezone_string
-     * @return string
-     */
-    public function timezoneSelectInput($timezone_string = '');
-
-
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp    if 0, then time() will be used.
-     * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
-     *                                site will be used.
-     * @return int      unix_timestamp value with the offset applied for the given timezone.
-     */
-    public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '');
-
-
-    /**
-     * Depending on PHP version,
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset);
+	/**
+	 * Ensures that a valid timezone string is returned.
+	 *
+	 * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
+	 *                                 settings (or derive from set UTC offset).
+	 * @return string
+	 */
+	public function getValidTimezoneString($timezone_string = '');
+
+
+	/**
+	 * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @param string $timezone_string
+	 * @param bool   $throw_error
+	 * @return bool
+	 */
+	public function validateTimezone($timezone_string, $throw_error = true);
+
+
+	/**
+	 * Returns a timezone string for the provided gmt_offset.
+	 * @param float|string $gmt_offset
+	 * @return string
+	 */
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '');
+
+
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case the gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int  seconds offset
+	 */
+	public function getSiteTimezoneGmtOffset();
+
+
+	/**
+	 * Get timezone transitions
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array
+	 */
+	public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true);
+
+
+	/**
+	 * Get Timezone offset for given timezone object
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int         $time
+	 * @return int
+	 */
+	public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null);
+
+
+	/**
+	 * Provide a timezone select input
+	 * @param string $timezone_string
+	 * @return string
+	 */
+	public function timezoneSelectInput($timezone_string = '');
+
+
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp    if 0, then time() will be used.
+	 * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
+	 *                                site will be used.
+	 * @return int      unix_timestamp value with the offset applied for the given timezone.
+	 */
+	public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '');
+
+
+	/**
+	 * Depending on PHP version,
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset);
 }

core/services/context/ContextChecker.php

Spacing +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
     {
         $this->evaluation_callback = $evaluation_callback instanceof Closure
             ? $evaluation_callback
-            : function (ContextInterface $context, $acceptable_values) {
+            : function(ContextInterface $context, $acceptable_values) {
                 return in_array($context->slug(), $acceptable_values, true);
             };
     }

Indentation +141 added lines, -141 removed lines

@@ -17,145 +17,145 @@
 class ContextChecker
 {
 
-    /**
-     * A unique string used to identify where this ContextChecker is being employed
-     * Is currently only used within the hook name for the filterable return value of isAllowed().
-     *
-     * @var string $identifier
-     */
-    private $identifier;
-
-    /**
-     * A list of values to be compared against the slug of the Context class passed to isAllowed()
-     *
-     * @var array $acceptable_values
-     */
-    private $acceptable_values;
-
-    /**
-     * Closure that will be called to perform the evaluation within isAllowed().
-     * If none is provided, then a simple type sensitive in_array() check will be used
-     * and return true if the incoming Context::slug() is found within the array of $acceptable_values.
-     *
-     * @var Closure $evaluation_callback
-     */
-    private $evaluation_callback;
-
-
-    /**
-     * ContextChecker constructor.
-     *
-     * @param string       $identifier
-     * @param array        $acceptable_values
-     * @param Closure|null $evaluation_callback [optional]
-     */
-    public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null)
-    {
-        $this->setIdentifier($identifier);
-        $this->setAcceptableValues($acceptable_values);
-        $this->setEvaluationCallback($evaluation_callback);
-    }
-
-
-    /**
-     * @param string $identifier
-     */
-    private function setIdentifier($identifier)
-    {
-        $this->identifier = sanitize_key($identifier);
-    }
-
-
-    /**
-     * @param array $acceptable_values
-     */
-    private function setAcceptableValues(array $acceptable_values)
-    {
-        $this->acceptable_values = $acceptable_values;
-    }
-
-
-    /**
-     * @param Closure $evaluation_callback
-     */
-    private function setEvaluationCallback(Closure $evaluation_callback = null)
-    {
-        $this->evaluation_callback = $evaluation_callback instanceof Closure
-            ? $evaluation_callback
-            : function (ContextInterface $context, $acceptable_values) {
-                return in_array($context->slug(), $acceptable_values, true);
-            };
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function acceptableValues()
-    {
-        return apply_filters(
-            "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues",
-            $this->acceptable_values
-        );
-    }
-
-
-    /**
-     * @return Closure
-     */
-    protected function evaluationCallback()
-    {
-        return $this->evaluation_callback;
-    }
-
-
-    /**
-     * Returns true if the incoming Context class slug matches one of the preset acceptable values.
-     * The result is filterable using the identifier for this ContextChecker.
-     * example:
-     * If this ContextChecker's $identifier was set to "registration-checkout-type",
-     * then the filter here would be named:
-     *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed".
-     * Other code could hook into the filter in isAllowed() using the above name
-     * and test for additional acceptable values.
-     * So if the set of $acceptable_values was: [ "initial-visit",  "revisit" ]
-     * then adding a filter to
-     *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed",
-     * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value.
-     *  example:
-     *      add_filter(
-     *          'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed',
-     *          function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout'
-     *                  ? true
-     *                  : $is_allowed;
-     *          },
-     *          10,
-     *          2
-     *      );
-     *
-     * @param ContextInterface $context
-     * @return boolean
-     */
-    public function isAllowed(ContextInterface $context)
-    {
-        $evaluation_callback = $this->evaluationCallback();
-        return filter_var(
-            apply_filters(
-                "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed",
-                $evaluation_callback($context, $this->acceptableValues()),
-                $context,
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
+	/**
+	 * A unique string used to identify where this ContextChecker is being employed
+	 * Is currently only used within the hook name for the filterable return value of isAllowed().
+	 *
+	 * @var string $identifier
+	 */
+	private $identifier;
+
+	/**
+	 * A list of values to be compared against the slug of the Context class passed to isAllowed()
+	 *
+	 * @var array $acceptable_values
+	 */
+	private $acceptable_values;
+
+	/**
+	 * Closure that will be called to perform the evaluation within isAllowed().
+	 * If none is provided, then a simple type sensitive in_array() check will be used
+	 * and return true if the incoming Context::slug() is found within the array of $acceptable_values.
+	 *
+	 * @var Closure $evaluation_callback
+	 */
+	private $evaluation_callback;
+
+
+	/**
+	 * ContextChecker constructor.
+	 *
+	 * @param string       $identifier
+	 * @param array        $acceptable_values
+	 * @param Closure|null $evaluation_callback [optional]
+	 */
+	public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null)
+	{
+		$this->setIdentifier($identifier);
+		$this->setAcceptableValues($acceptable_values);
+		$this->setEvaluationCallback($evaluation_callback);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 */
+	private function setIdentifier($identifier)
+	{
+		$this->identifier = sanitize_key($identifier);
+	}
+
+
+	/**
+	 * @param array $acceptable_values
+	 */
+	private function setAcceptableValues(array $acceptable_values)
+	{
+		$this->acceptable_values = $acceptable_values;
+	}
+
+
+	/**
+	 * @param Closure $evaluation_callback
+	 */
+	private function setEvaluationCallback(Closure $evaluation_callback = null)
+	{
+		$this->evaluation_callback = $evaluation_callback instanceof Closure
+			? $evaluation_callback
+			: function (ContextInterface $context, $acceptable_values) {
+				return in_array($context->slug(), $acceptable_values, true);
+			};
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function acceptableValues()
+	{
+		return apply_filters(
+			"FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues",
+			$this->acceptable_values
+		);
+	}
+
+
+	/**
+	 * @return Closure
+	 */
+	protected function evaluationCallback()
+	{
+		return $this->evaluation_callback;
+	}
+
+
+	/**
+	 * Returns true if the incoming Context class slug matches one of the preset acceptable values.
+	 * The result is filterable using the identifier for this ContextChecker.
+	 * example:
+	 * If this ContextChecker's $identifier was set to "registration-checkout-type",
+	 * then the filter here would be named:
+	 *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed".
+	 * Other code could hook into the filter in isAllowed() using the above name
+	 * and test for additional acceptable values.
+	 * So if the set of $acceptable_values was: [ "initial-visit",  "revisit" ]
+	 * then adding a filter to
+	 *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed",
+	 * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value.
+	 *  example:
+	 *      add_filter(
+	 *          'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed',
+	 *          function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout'
+	 *                  ? true
+	 *                  : $is_allowed;
+	 *          },
+	 *          10,
+	 *          2
+	 *      );
+	 *
+	 * @param ContextInterface $context
+	 * @return boolean
+	 */
+	public function isAllowed(ContextInterface $context)
+	{
+		$evaluation_callback = $this->evaluationCallback();
+		return filter_var(
+			apply_filters(
+				"FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed",
+				$evaluation_callback($context, $this->acceptableValues()),
+				$context,
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
 }

core/domain/entities/contexts/ContextInterface.php

Indentation +8 added lines, -8 removed lines

@@ -18,14 +18,14 @@
 interface ContextInterface
 {
 
-    /**
-     * @return string
-     */
-    public function slug();
+	/**
+	 * @return string
+	 */
+	public function slug();
 
 
-    /**
-     * @return string
-     */
-    public function description();
+	/**
+	 * @return string
+	 */
+	public function description();
 }

core/db_models/EEM_Question.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -364,7 +364,7 @@ 
      * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
      * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
      * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
+     * @return string of QST_ID for the question that corresponds to that QST_system
      */
     public function get_Question_ID_from_system_string($QST_system)
     {
@@ -425,7 +425,7 @@ 
 
 
     /**
-     * @return array
+     * @return EEM_Question
      */
     public function question_descriptions()
     {

Spacing +10 added lines, -10 removed lines

@@ -213,10 +213,10 @@ 
             'Question_Group_Question' => new EE_Has_Many_Relation()
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('QST_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form('QST_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form('QST_system');
         parent::__construct($timezone);
     }
 
@@ -256,10 +256,10 @@ 
      */
     public function question_type_is_in_category($question_type, $category)
     {
-        if (!isset($this->_question_type_categories[ $category ])) {
+        if ( ! isset($this->_question_type_categories[$category])) {
             return false;
         }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
+        return in_array($question_type, $this->_question_type_categories[$category]);
     }
 
 
@@ -270,8 +270,8 @@ 
      */
     public function question_types_in_category($category)
     {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
+        if (isset($this->_question_type_categories[$category])) {
+            return $this->_question_type_categories[$category];
         }
         return array();
     }
@@ -410,8 +410,8 @@ 
     public function absolute_max_for_system_question($system_question_value)
     {
         $maxes = $this->system_question_maxes();
-        if (isset($maxes[ $system_question_value ])) {
-            return $maxes[ $system_question_value ];
+        if (isset($maxes[$system_question_value])) {
+            return $maxes[$system_question_value];
         } else {
             return EE_INF;
         }

Indentation +425 added lines, -425 removed lines

@@ -10,429 +10,429 @@
 class EEM_Question extends EEM_Soft_Delete_Base
 {
 
-    // constant used to indicate that the question type is COUNTRY
-    const QST_type_country = 'COUNTRY';
-
-    // constant used to indicate that the question type is DATE
-    const QST_type_date = 'DATE';
-
-    // constant used to indicate that the question type is DROPDOWN
-    const QST_type_dropdown = 'DROPDOWN';
-
-    // constant used to indicate that the question type is CHECKBOX
-    const QST_type_checkbox = 'CHECKBOX';
-
-    // constant used to indicate that the question type is RADIO_BTN
-    const QST_type_radio = 'RADIO_BTN';
-
-    // constant used to indicate that the question type is STATE
-    const QST_type_state = 'STATE';
-
-    // constant used to indicate that the question type is TEXT
-    const QST_type_text = 'TEXT';
-
-    // constant used to indicate that the question type is TEXTAREA
-    const QST_type_textarea = 'TEXTAREA';
-
-    // constant used to indicate that the question type is a TEXTAREA that allows simple html
-    const QST_type_html_textarea = 'HTML_TEXTAREA';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email = 'EMAIL';
-
-    // constant used to indicate that the question type is a US-formatted phone number
-    const QST_type_us_phone = 'US_PHONE';
-
-    // constant used to indicate that the question type is an integer (whole number)
-    const QST_type_int = 'INTEGER';
-
-    // constant used to indicate that the question type is a decimal (float)
-    const QST_type_decimal = 'DECIMAL';
-
-    // constant used to indicate that the question type is a valid URL
-    const QST_type_url = 'URL';
-
-    // constant used to indicate that the question type is a YEAR
-    const QST_type_year = 'YEAR';
-
-    // constant used to indicate that the question type is a multi-select
-    const QST_type_multi_select = 'MULTI_SELECT';
-
-    /**
-     * Question types that are interchangeable, even after answers have been provided for them.
-     * Top-level keys are category slugs, next level is an array of question types. If question types
-     * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
-     *
-     * @access protected
-     * @var array $_question_type_categories {
-     * @type string $text
-     * @type string $single -answer-enum
-     * @type string $multi -answer-enum
-     *                    }
-     */
-    protected $_question_type_categories = array();
-
-    /**
-     * lists all the question types which should be allowed. Ideally, this will be extensible.
-     *
-     * @access protected
-     * @var array $_allowed_question_types
-     */
-    protected $_allowed_question_types = array();
-
-    /**
-     * brief descriptions for all the question types
-     *
-     * @access protected
-     * @var EEM_Question $_instance
-     */
-    protected $_question_descriptions;
-
-
-    /**
-     * Question types that should have an admin-defined max input length
-     * @var array
-     */
-    protected $question_types_with_max_lengh;
-
-
-    // private instance of the Attendee object
-    protected static $_instance = null;
-
-
-    /**
-     * EEM_Question constructor.
-     *
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Question', 'event_espresso');
-        $this->plural_item = __('Questions', 'event_espresso');
-        $this->_allowed_question_types = apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            array(
-                EEM_Question::QST_type_text => __('Text', 'event_espresso'),
-                EEM_Question::QST_type_textarea => __('Textarea', 'event_espresso'),
-                EEM_Question::QST_type_checkbox => __('Checkboxes', 'event_espresso'),
-                EEM_Question::QST_type_radio => __('Radio Buttons', 'event_espresso'),
-                EEM_Question::QST_type_dropdown => __('Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_state => __('State/Province Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_country => __('Country Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_date => __('Date Picker', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => __('HTML Textarea', 'event_espresso'),
-                EEM_Question::QST_type_email => __('Email', 'event_espresso'),
-                EEM_Question::QST_type_us_phone => __('USA - Format Phone', 'event_espresso'),
-                EEM_Question::QST_type_decimal => __('Number', 'event_espresso'),
-                EEM_Question::QST_type_int => __('Whole Number', 'event_espresso'),
-                EEM_Question::QST_type_url => __('URL', 'event_espresso'),
-                EEM_Question::QST_type_year => __('Year', 'event_espresso'),
-                EEM_Question::QST_type_multi_select => __('Multi Select', 'event_espresso')
-            )
-        );
-        $this->_question_descriptions = apply_filters(
-            'FHEE__EEM_Question__construct__question_descriptions',
-            array(
-                EEM_Question::QST_type_text => __('A single line text input field', 'event_espresso'),
-                EEM_Question::QST_type_textarea => __('A multi line text input field', 'event_espresso'),
-                EEM_Question::QST_type_checkbox => __('Allows multiple preset options to be selected', 'event_espresso'),
-                EEM_Question::QST_type_radio => __('Allows a single preset option to be selected', 'event_espresso'),
-                EEM_Question::QST_type_dropdown => __('A dropdown that allows a single selection', 'event_espresso'),
-                EEM_Question::QST_type_state => __('A dropdown that lists states/provinces', 'event_espresso'),
-                EEM_Question::QST_type_country => __('A dropdown that lists countries', 'event_espresso'),
-                EEM_Question::QST_type_date => __('A popup calendar that allows date selections', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => __('A multi line text input field that allows HTML', 'event_espresso'),
-                EEM_Question::QST_type_email => __('A text field that must contain a valid Email address', 'event_espresso'),
-                EEM_Question::QST_type_us_phone => __('A text field that must contain a valid US phone number', 'event_espresso'),
-                EEM_Question::QST_type_decimal => __('A text field that allows number values with decimals', 'event_espresso'),
-                EEM_Question::QST_type_int => __('A text field that only allows whole numbers (no decimals)', 'event_espresso'),
-                EEM_Question::QST_type_url => __('A text field that must contain a valid URL', 'event_espresso'),
-                EEM_Question::QST_type_year => __('A dropdown that lists the last 100 years', 'event_espresso'),
-                EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
-            )
-        );
-        $this->_question_type_categories = (array) apply_filters(
-            'FHEE__EEM_Question__construct__question_type_categories',
-            array(
-                'text' => array(
-                    EEM_Question::QST_type_text,
-                    EEM_Question::QST_type_textarea,
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_html_textarea,
-                    EEM_Question::QST_type_email,
-                    EEM_Question::QST_type_us_phone,
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_int,
-                    EEM_Question::QST_type_url,
-                    EEM_Question::QST_type_year
-                ),
-                'single-answer-enum' => array(
-                    EEM_Question::QST_type_radio,
-                    EEM_Question::QST_type_dropdown
-                ),
-                'multi-answer-enum' => array(
-                    EEM_Question::QST_type_checkbox,
-                    EEM_Question::QST_type_multi_select
-                )
-            )
-        );
-        $this->question_types_with_max_lengh = apply_filters(
-            'FHEE__EEM_Question___construct__question_types_with_max_length',
-            array(
-                EEM_Question::QST_type_text,
-                EEM_Question::QST_type_textarea,
-                EEM_Question::QST_type_html_textarea
-            )
-        );
-
-        $this->_tables = array(
-            'Question' => new EE_Primary_Table('esp_question', 'QST_ID')
-        );
-        $this->_fields = array(
-            'Question' => array(
-                'QST_ID' => new EE_Primary_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso')),
-                'QST_display_text' => new EE_Post_Content_Field('QST_display_text', __('Question Text', 'event_espresso'), true, ''),
-                'QST_admin_label' => new EE_Plain_Text_Field('QST_admin_label', __('Question Label (admin-only)', 'event_espresso'), true, ''),
-                'QST_system' => new EE_Plain_Text_Field('QST_system', __('Internal string ID for question', 'event_espresso'), false, ''),
-                'QST_type' => new EE_Enum_Text_Field('QST_type', __('Question Type', 'event_espresso'), false, 'TEXT', $this->_allowed_question_types),
-                'QST_required' => new EE_Boolean_Field('QST_required', __('Required Question?', 'event_espresso'), false, false),
-                'QST_required_text' => new EE_Simple_HTML_Field('QST_required_text', __('Text to Display if Not Provided', 'event_espresso'), true, ''),
-                'QST_order' => new EE_Integer_Field('QST_order', __('Question Order', 'event_espresso'), false, 0),
-                'QST_admin_only' => new EE_Boolean_Field('QST_admin_only', __('Admin-Only Question?', 'event_espresso'), false, false),
-                'QST_max' => new EE_Infinite_Integer_Field('QST_max', __('Max Size', 'event_espresso'), false, EE_INF),
-                'QST_wp_user' => new EE_WP_User_Field('QST_wp_user', __('Question Creator ID', 'event_espresso'), false),
-                'QST_deleted' => new EE_Trashed_Flag_Field('QST_deleted', __('Flag Indicating question was deleted', 'event_espresso'), false, false)
-            )
-        );
-        $this->_model_relations = array(
-            'Question_Group' => new EE_HABTM_Relation('Question_Group_Question'),
-            'Question_Option' => new EE_Has_Many_Relation(),
-            'Answer' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-            // for QST_order column
-            'Question_Group_Question' => new EE_Has_Many_Relation()
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        parent::__construct($timezone);
-    }
-
-    /**
-     * Returns the list of allowed question types, which are normally: 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE'
-     * but they can be extended
-     * @return string[]
-     */
-    public function allowed_question_types()
-    {
-        return $this->_allowed_question_types;
-    }
-
-    /**
-     * Gets all the question types in the same category
-     * @param string $question_type one of EEM_Question::allowed_question_types(
-     * @return string[] like EEM_Question::allowed_question_types()
-     */
-    public function question_types_in_same_category($question_type)
-    {
-        $question_types = array($question_type);
-        foreach ($this->_question_type_categories as $category => $question_types_in_category) {
-            if (in_array($question_type, $question_types_in_category)) {
-                $question_types = $question_types_in_category;
-                break;
-            }
-        }
-
-        return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
-    }
-
-    /**
-     * Determines if the given question type is in the given question type category
-     * @param string $question_type one of EEM_Question::allowed_question_types()
-     * @param string $category one of the top-level keys of EEM_Question::question_type_categories()
-     * @return boolean
-     */
-    public function question_type_is_in_category($question_type, $category)
-    {
-        if (!isset($this->_question_type_categories[ $category ])) {
-            return false;
-        }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
-    }
-
-
-    /**
-     * Returns all the question types in the given category
-     * @param string $category
-     * @return array|mixed
-     */
-    public function question_types_in_category($category)
-    {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
-        }
-        return array();
-    }
-
-
-    /**
-     * Returns all the question types that should have question options
-     * @return array
-     */
-    public function question_types_with_options()
-    {
-        return array_merge(
-            $this->question_types_in_category('single-answer-enum'),
-            $this->question_types_in_category('multi-answer-enum')
-        );
-    }
-
-    /**
-     * Returns the question type categories 2d array
-     * @return array see EEM_Question::_question_type_categories
-     */
-    public function question_type_categories()
-    {
-        return $this->_question_type_categories;
-    }
-
-    /**
-     * Returns an array of all the QST_system values that can be allowed in the system question group
-     * identified by $system_question_group_id
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function allowed_system_questions_in_system_question_group($system_question_group_id)
-    {
-        $question_system_ids = array();
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_lname,
-                    EEM_Attendee::system_question_email,
-                    EEM_Attendee::system_question_phone
-                );
-                break;
-            case EEM_Question_Group::system_address:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_address,
-                    EEM_Attendee::system_question_address2,
-                    EEM_Attendee::system_question_city,
-                    EEM_Attendee::system_question_state,
-                    EEM_Attendee::system_question_country,
-                    EEM_Attendee::system_question_zip,
-                    EEM_Attendee::system_question_phone
-                );
-                break;
-        }
-        return apply_filters('FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return', $question_system_ids, $system_question_group_id);
-    }
-
-    /**
-     * Returns an array of all the QST_system values that are required in the system question group
-     * identified by $system_question_group_id
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function required_system_questions_in_system_question_group($system_question_group_id)
-    {
-        $question_system_ids = null;
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_email,
-                );
-                break;
-            default:
-                $question_system_ids = array();
-        }
-        return apply_filters('FHEE__EEM_Question__system_questions_required_in_system_question_group', $question_system_ids, $system_question_group_id);
-    }
-
-
-    /**
-     * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
-     * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
-     * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
-     */
-    public function get_Question_ID_from_system_string($QST_system)
-    {
-        return $this->get_var(array(array('QST_system' => $QST_system)));
-    }
-
-
-    /**
-     * searches the db for the question with the latest question order and returns that value.
-     * @access public
-     * @return int
-     */
-    public function get_latest_question_order()
-    {
-        $columns_to_select = array(
-            'max_order' => array("MAX(QST_order)", "%d")
-        );
-        $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
-        return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
-    }
-
-    /**
-     * Returns an array where keys are system question QST_system values,
-     * and values are the highest question max the admin can set on the question
-     * (aka the "max max"; eg, a site admin can change the zip question to have a max
-     * of 5, but no larger than 12)
-     * @return array
-     */
-    public function system_question_maxes()
-    {
-        return array(
-            'fname' => 45,
-            'lname' => 45,
-            'address' => 255,
-            'address2' => 255,
-            'city' => 45,
-            'zip' => 12,
-            'email' => 255,
-            'phone' => 45,
-        );
-    }
-
-    /**
-     * Given a QST_system value, gets the question's largest allowable max input.
-     * @see Registration_Form_Admin_Page::system_question_maxes()
-     * @param string $system_question_value
-     * @return int|float
-     */
-    public function absolute_max_for_system_question($system_question_value)
-    {
-        $maxes = $this->system_question_maxes();
-        if (isset($maxes[ $system_question_value ])) {
-            return $maxes[ $system_question_value ];
-        } else {
-            return EE_INF;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function question_descriptions()
-    {
-        return $this->_question_descriptions;
-    }
-
-
-    /**
-     * Returns all the question types that should have an admin-defined max input length
-     * @return array
-     */
-    public function questionTypesWithMaxLength()
-    {
-        return (array) $this->question_types_with_max_lengh;
-    }
+	// constant used to indicate that the question type is COUNTRY
+	const QST_type_country = 'COUNTRY';
+
+	// constant used to indicate that the question type is DATE
+	const QST_type_date = 'DATE';
+
+	// constant used to indicate that the question type is DROPDOWN
+	const QST_type_dropdown = 'DROPDOWN';
+
+	// constant used to indicate that the question type is CHECKBOX
+	const QST_type_checkbox = 'CHECKBOX';
+
+	// constant used to indicate that the question type is RADIO_BTN
+	const QST_type_radio = 'RADIO_BTN';
+
+	// constant used to indicate that the question type is STATE
+	const QST_type_state = 'STATE';
+
+	// constant used to indicate that the question type is TEXT
+	const QST_type_text = 'TEXT';
+
+	// constant used to indicate that the question type is TEXTAREA
+	const QST_type_textarea = 'TEXTAREA';
+
+	// constant used to indicate that the question type is a TEXTAREA that allows simple html
+	const QST_type_html_textarea = 'HTML_TEXTAREA';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email = 'EMAIL';
+
+	// constant used to indicate that the question type is a US-formatted phone number
+	const QST_type_us_phone = 'US_PHONE';
+
+	// constant used to indicate that the question type is an integer (whole number)
+	const QST_type_int = 'INTEGER';
+
+	// constant used to indicate that the question type is a decimal (float)
+	const QST_type_decimal = 'DECIMAL';
+
+	// constant used to indicate that the question type is a valid URL
+	const QST_type_url = 'URL';
+
+	// constant used to indicate that the question type is a YEAR
+	const QST_type_year = 'YEAR';
+
+	// constant used to indicate that the question type is a multi-select
+	const QST_type_multi_select = 'MULTI_SELECT';
+
+	/**
+	 * Question types that are interchangeable, even after answers have been provided for them.
+	 * Top-level keys are category slugs, next level is an array of question types. If question types
+	 * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
+	 *
+	 * @access protected
+	 * @var array $_question_type_categories {
+	 * @type string $text
+	 * @type string $single -answer-enum
+	 * @type string $multi -answer-enum
+	 *                    }
+	 */
+	protected $_question_type_categories = array();
+
+	/**
+	 * lists all the question types which should be allowed. Ideally, this will be extensible.
+	 *
+	 * @access protected
+	 * @var array $_allowed_question_types
+	 */
+	protected $_allowed_question_types = array();
+
+	/**
+	 * brief descriptions for all the question types
+	 *
+	 * @access protected
+	 * @var EEM_Question $_instance
+	 */
+	protected $_question_descriptions;
+
+
+	/**
+	 * Question types that should have an admin-defined max input length
+	 * @var array
+	 */
+	protected $question_types_with_max_lengh;
+
+
+	// private instance of the Attendee object
+	protected static $_instance = null;
+
+
+	/**
+	 * EEM_Question constructor.
+	 *
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Question', 'event_espresso');
+		$this->plural_item = __('Questions', 'event_espresso');
+		$this->_allowed_question_types = apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			array(
+				EEM_Question::QST_type_text => __('Text', 'event_espresso'),
+				EEM_Question::QST_type_textarea => __('Textarea', 'event_espresso'),
+				EEM_Question::QST_type_checkbox => __('Checkboxes', 'event_espresso'),
+				EEM_Question::QST_type_radio => __('Radio Buttons', 'event_espresso'),
+				EEM_Question::QST_type_dropdown => __('Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_state => __('State/Province Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_country => __('Country Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_date => __('Date Picker', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => __('HTML Textarea', 'event_espresso'),
+				EEM_Question::QST_type_email => __('Email', 'event_espresso'),
+				EEM_Question::QST_type_us_phone => __('USA - Format Phone', 'event_espresso'),
+				EEM_Question::QST_type_decimal => __('Number', 'event_espresso'),
+				EEM_Question::QST_type_int => __('Whole Number', 'event_espresso'),
+				EEM_Question::QST_type_url => __('URL', 'event_espresso'),
+				EEM_Question::QST_type_year => __('Year', 'event_espresso'),
+				EEM_Question::QST_type_multi_select => __('Multi Select', 'event_espresso')
+			)
+		);
+		$this->_question_descriptions = apply_filters(
+			'FHEE__EEM_Question__construct__question_descriptions',
+			array(
+				EEM_Question::QST_type_text => __('A single line text input field', 'event_espresso'),
+				EEM_Question::QST_type_textarea => __('A multi line text input field', 'event_espresso'),
+				EEM_Question::QST_type_checkbox => __('Allows multiple preset options to be selected', 'event_espresso'),
+				EEM_Question::QST_type_radio => __('Allows a single preset option to be selected', 'event_espresso'),
+				EEM_Question::QST_type_dropdown => __('A dropdown that allows a single selection', 'event_espresso'),
+				EEM_Question::QST_type_state => __('A dropdown that lists states/provinces', 'event_espresso'),
+				EEM_Question::QST_type_country => __('A dropdown that lists countries', 'event_espresso'),
+				EEM_Question::QST_type_date => __('A popup calendar that allows date selections', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => __('A multi line text input field that allows HTML', 'event_espresso'),
+				EEM_Question::QST_type_email => __('A text field that must contain a valid Email address', 'event_espresso'),
+				EEM_Question::QST_type_us_phone => __('A text field that must contain a valid US phone number', 'event_espresso'),
+				EEM_Question::QST_type_decimal => __('A text field that allows number values with decimals', 'event_espresso'),
+				EEM_Question::QST_type_int => __('A text field that only allows whole numbers (no decimals)', 'event_espresso'),
+				EEM_Question::QST_type_url => __('A text field that must contain a valid URL', 'event_espresso'),
+				EEM_Question::QST_type_year => __('A dropdown that lists the last 100 years', 'event_espresso'),
+				EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
+			)
+		);
+		$this->_question_type_categories = (array) apply_filters(
+			'FHEE__EEM_Question__construct__question_type_categories',
+			array(
+				'text' => array(
+					EEM_Question::QST_type_text,
+					EEM_Question::QST_type_textarea,
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_html_textarea,
+					EEM_Question::QST_type_email,
+					EEM_Question::QST_type_us_phone,
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_int,
+					EEM_Question::QST_type_url,
+					EEM_Question::QST_type_year
+				),
+				'single-answer-enum' => array(
+					EEM_Question::QST_type_radio,
+					EEM_Question::QST_type_dropdown
+				),
+				'multi-answer-enum' => array(
+					EEM_Question::QST_type_checkbox,
+					EEM_Question::QST_type_multi_select
+				)
+			)
+		);
+		$this->question_types_with_max_lengh = apply_filters(
+			'FHEE__EEM_Question___construct__question_types_with_max_length',
+			array(
+				EEM_Question::QST_type_text,
+				EEM_Question::QST_type_textarea,
+				EEM_Question::QST_type_html_textarea
+			)
+		);
+
+		$this->_tables = array(
+			'Question' => new EE_Primary_Table('esp_question', 'QST_ID')
+		);
+		$this->_fields = array(
+			'Question' => array(
+				'QST_ID' => new EE_Primary_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso')),
+				'QST_display_text' => new EE_Post_Content_Field('QST_display_text', __('Question Text', 'event_espresso'), true, ''),
+				'QST_admin_label' => new EE_Plain_Text_Field('QST_admin_label', __('Question Label (admin-only)', 'event_espresso'), true, ''),
+				'QST_system' => new EE_Plain_Text_Field('QST_system', __('Internal string ID for question', 'event_espresso'), false, ''),
+				'QST_type' => new EE_Enum_Text_Field('QST_type', __('Question Type', 'event_espresso'), false, 'TEXT', $this->_allowed_question_types),
+				'QST_required' => new EE_Boolean_Field('QST_required', __('Required Question?', 'event_espresso'), false, false),
+				'QST_required_text' => new EE_Simple_HTML_Field('QST_required_text', __('Text to Display if Not Provided', 'event_espresso'), true, ''),
+				'QST_order' => new EE_Integer_Field('QST_order', __('Question Order', 'event_espresso'), false, 0),
+				'QST_admin_only' => new EE_Boolean_Field('QST_admin_only', __('Admin-Only Question?', 'event_espresso'), false, false),
+				'QST_max' => new EE_Infinite_Integer_Field('QST_max', __('Max Size', 'event_espresso'), false, EE_INF),
+				'QST_wp_user' => new EE_WP_User_Field('QST_wp_user', __('Question Creator ID', 'event_espresso'), false),
+				'QST_deleted' => new EE_Trashed_Flag_Field('QST_deleted', __('Flag Indicating question was deleted', 'event_espresso'), false, false)
+			)
+		);
+		$this->_model_relations = array(
+			'Question_Group' => new EE_HABTM_Relation('Question_Group_Question'),
+			'Question_Option' => new EE_Has_Many_Relation(),
+			'Answer' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+			// for QST_order column
+			'Question_Group_Question' => new EE_Has_Many_Relation()
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		parent::__construct($timezone);
+	}
+
+	/**
+	 * Returns the list of allowed question types, which are normally: 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE'
+	 * but they can be extended
+	 * @return string[]
+	 */
+	public function allowed_question_types()
+	{
+		return $this->_allowed_question_types;
+	}
+
+	/**
+	 * Gets all the question types in the same category
+	 * @param string $question_type one of EEM_Question::allowed_question_types(
+	 * @return string[] like EEM_Question::allowed_question_types()
+	 */
+	public function question_types_in_same_category($question_type)
+	{
+		$question_types = array($question_type);
+		foreach ($this->_question_type_categories as $category => $question_types_in_category) {
+			if (in_array($question_type, $question_types_in_category)) {
+				$question_types = $question_types_in_category;
+				break;
+			}
+		}
+
+		return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
+	}
+
+	/**
+	 * Determines if the given question type is in the given question type category
+	 * @param string $question_type one of EEM_Question::allowed_question_types()
+	 * @param string $category one of the top-level keys of EEM_Question::question_type_categories()
+	 * @return boolean
+	 */
+	public function question_type_is_in_category($question_type, $category)
+	{
+		if (!isset($this->_question_type_categories[ $category ])) {
+			return false;
+		}
+		return in_array($question_type, $this->_question_type_categories[ $category ]);
+	}
+
+
+	/**
+	 * Returns all the question types in the given category
+	 * @param string $category
+	 * @return array|mixed
+	 */
+	public function question_types_in_category($category)
+	{
+		if (isset($this->_question_type_categories[ $category ])) {
+			return $this->_question_type_categories[ $category ];
+		}
+		return array();
+	}
+
+
+	/**
+	 * Returns all the question types that should have question options
+	 * @return array
+	 */
+	public function question_types_with_options()
+	{
+		return array_merge(
+			$this->question_types_in_category('single-answer-enum'),
+			$this->question_types_in_category('multi-answer-enum')
+		);
+	}
+
+	/**
+	 * Returns the question type categories 2d array
+	 * @return array see EEM_Question::_question_type_categories
+	 */
+	public function question_type_categories()
+	{
+		return $this->_question_type_categories;
+	}
+
+	/**
+	 * Returns an array of all the QST_system values that can be allowed in the system question group
+	 * identified by $system_question_group_id
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function allowed_system_questions_in_system_question_group($system_question_group_id)
+	{
+		$question_system_ids = array();
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_lname,
+					EEM_Attendee::system_question_email,
+					EEM_Attendee::system_question_phone
+				);
+				break;
+			case EEM_Question_Group::system_address:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_address,
+					EEM_Attendee::system_question_address2,
+					EEM_Attendee::system_question_city,
+					EEM_Attendee::system_question_state,
+					EEM_Attendee::system_question_country,
+					EEM_Attendee::system_question_zip,
+					EEM_Attendee::system_question_phone
+				);
+				break;
+		}
+		return apply_filters('FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return', $question_system_ids, $system_question_group_id);
+	}
+
+	/**
+	 * Returns an array of all the QST_system values that are required in the system question group
+	 * identified by $system_question_group_id
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function required_system_questions_in_system_question_group($system_question_group_id)
+	{
+		$question_system_ids = null;
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_email,
+				);
+				break;
+			default:
+				$question_system_ids = array();
+		}
+		return apply_filters('FHEE__EEM_Question__system_questions_required_in_system_question_group', $question_system_ids, $system_question_group_id);
+	}
+
+
+	/**
+	 * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
+	 * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
+	 * @param $QST_system
+	 * @return int of QST_ID for the question that corresponds to that QST_system
+	 */
+	public function get_Question_ID_from_system_string($QST_system)
+	{
+		return $this->get_var(array(array('QST_system' => $QST_system)));
+	}
+
+
+	/**
+	 * searches the db for the question with the latest question order and returns that value.
+	 * @access public
+	 * @return int
+	 */
+	public function get_latest_question_order()
+	{
+		$columns_to_select = array(
+			'max_order' => array("MAX(QST_order)", "%d")
+		);
+		$max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
+		return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
+	}
+
+	/**
+	 * Returns an array where keys are system question QST_system values,
+	 * and values are the highest question max the admin can set on the question
+	 * (aka the "max max"; eg, a site admin can change the zip question to have a max
+	 * of 5, but no larger than 12)
+	 * @return array
+	 */
+	public function system_question_maxes()
+	{
+		return array(
+			'fname' => 45,
+			'lname' => 45,
+			'address' => 255,
+			'address2' => 255,
+			'city' => 45,
+			'zip' => 12,
+			'email' => 255,
+			'phone' => 45,
+		);
+	}
+
+	/**
+	 * Given a QST_system value, gets the question's largest allowable max input.
+	 * @see Registration_Form_Admin_Page::system_question_maxes()
+	 * @param string $system_question_value
+	 * @return int|float
+	 */
+	public function absolute_max_for_system_question($system_question_value)
+	{
+		$maxes = $this->system_question_maxes();
+		if (isset($maxes[ $system_question_value ])) {
+			return $maxes[ $system_question_value ];
+		} else {
+			return EE_INF;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function question_descriptions()
+	{
+		return $this->_question_descriptions;
+	}
+
+
+	/**
+	 * Returns all the question types that should have an admin-defined max input length
+	 * @return array
+	 */
+	public function questionTypesWithMaxLength()
+	{
+		return (array) $this->question_types_with_max_lengh;
+	}
 }

acceptance_tests/tests/b-TestRegistrationSummaryCept.php

Indentation +41 added lines, -41 removed lines

@@ -14,8 +14,8 @@ 
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 //k now we need to make sure the registration multi-status message type is active because it isn't by default
@@ -73,38 +73,38 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->see(
-    'rsm_tester@example.org',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	'rsm_tester@example.org',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 //verify count
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'rsm_tester@example.org',
-    'to',
-    'Registration Multi-status Summary',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Primary Registrant'
+	1,
+	'rsm_tester@example.org',
+	'to',
+	'Registration Multi-status Summary',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Primary Registrant'
 );
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'admin@example.com',
-    'to',
-    'Registration Multi-status Summary'
+	1,
+	'admin@example.com',
+	'to',
+	'Registration Multi-status Summary'
 );
 
 //okay now let's do some registrations for just the first event and verify that registration multi-status summary is NOT
@@ -134,25 +134,25 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->dontSee(
-    'rsm_testerb@example.org',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	'rsm_testerb@example.org',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 //there should still only be one admin multi-status summary thing.
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'admin@example.com',
-    'to',
-    'Registration Multi-status Summary'
+	1,
+	'admin@example.com',
+	'to',
+	'Registration Multi-status Summary'
 );
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'plugins deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'plugins deactivated'
 );
\ No newline at end of file

acceptance_tests/tests/c-TestCustomMessageTemplateCept.php

Indentation +27 added lines, -27 removed lines

@@ -18,14 +18,14 @@ 
 $event_one_link = $event_two_link = $event_three_link = '';
 
 $I->wantTo(
-    'Test that when registrations for multiple events are completed, and those events share the same custom'
-    . 'template, that that custom template will be used.'
+	'Test that when registrations for multiple events are completed, and those events share the same custom'
+	. 'template, that that custom template will be used.'
 );
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 $I->loginAsAdmin();
@@ -80,9 +80,9 @@ 
 
 
 $test_registration_details = array(
-    'fname' => 'CTGuy',
-    'lname' => 'Dude',
-    'email' => 'ctguy_dude@example.org'
+	'fname' => 'CTGuy',
+	'lname' => 'Dude',
+	'email' => 'ctguy_dude@example.org'
 );
 
 $I->amGoingTo('Register for Event One and Event Two and verify Custom Template A was used.');
@@ -108,23 +108,23 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->dismissMessageModal();
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->dismissMessageModal();
@@ -153,25 +153,25 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSeeTextInViewMessageModal($custom_template_a_label);
 $I->dontSeeTextInViewMessageModal($custom_template_b_label);
 $I->dismissMessageModal();
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSee($custom_template_a_label);
@@ -183,6 +183,6 @@ 
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'plugins deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'plugins deactivated'
 );
\ No newline at end of file

acceptance_tests/Helpers/RegistrationsAdmin.php

Indentation +134 added lines, -134 removed lines

@@ -15,139 +15,139 @@
 trait RegistrationsAdmin
 {
 
-    /**
-     * This will select all checkboxes on a registration list table for the given array of
-     * registration ids.
-     * Assumes the actor is on a list table page for registrations.
-     * @param $registration_ids
-     */
-    public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids)
-    {
-        foreach ($registration_ids as $registration_id) {
-            $this->actor()->checkOption(
-                RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id)
-            );
-        }
-    }
-
-
-    /**
-     * Navigates the actor to the default registration list table page.
-     * @param string $additional_params
-     */
-    public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(
-            RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params)
-        );
-        //wait for page to fully load
-        $this->actor()->wait(5);
-    }
-
-
-    /**
-     * Will enter the provided value in the registration list table search field and execute a search for that value.
-     * @param string $search_text
-     */
-    public function searchForRegistrationOnRegistrationListTableWithText($search_text)
-    {
-        $this->amOnDefaultRegistrationsListTableAdminPage();
-        $this->actor()->fillField(RegistrationsAdminPage::SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION, $search_text);
-        $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
-        $this->actor()->waitForText('Displaying search results for');
-    }
-
-
-
-    /**
-     * This will filter the registration list table to view registrations for the given event id.
-     * Assumption is made that you are logged into the admin but you do not need to be on the registration list table
-     * page.
-     *
-     * @param int $event_id  The id of the event viewing registrations for.
-     */
-    public function amViewingRegistrationsForEvent($event_id)
-    {
-        $this->actor()->amOnDefaultEventsListTablePage();
-        $this->actor()->click(EventsAdmin::listTableActionLinkRegistrationsForEvent($event_id));
-        $this->actor()->waitForText('Viewing registrations for the event');
-    }
-
-
-    /**
-     * This helper will initiate registering for the given event via the backend.
-     * @param int $event_id  The event to initiate registration for.
-     */
-    public function amOnAdminRegistrationPageForEvent($event_id)
-    {
-        $this->actor()->amViewingRegistrationsForEvent($event_id);
-        $this->actor()->click(RegistrationsAdminPage::BUTTON_ADD_NEW_REGISTRATION);
-        $this->actor()->waitForText('Adding Registration For');
-    }
-
-
-
-    /**
-     * This clicks the View Details Link for Registration with the given Id
-     * @param $registration_id
-     */
-    public function clickViewDetailsLinkForRegistrationWithId($registration_id)
-    {
-        $this->actor()->click(RegistrationsAdminPage::viewDetailsLinkSelectorForRegistrationId($registration_id));
-    }
-
-
-    /**
-     * /**
-     * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
-     * dropdown for changing registration status.
-     *
-     * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
-     * @param $status_label_or_value
-     */
-    public function selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value)
-    {
-        $this->actor()->selectOption(
-            RegistrationsAdminPage::DROPDOWN_REGISTRATION_STATUS,
-            $status_label_or_value
-        );
-    }
-
-
-    /**
-     * This selects (or deselects) the "Send Related Messages" checkbox on the Registration Details page.
-     * @param bool $send_related_messages
-     */
-    public function selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages = true)
-    {
-        $send_related_messages
-            ? $this->actor()->selectOption(
-                RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
-                'Yes'
-            )
-            : $this->actor()->selecOption(
-                RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
-                'No'
-            );
-    }
-
-
-
-    /**
-     * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
-     * dropdown for changing registration status and submits the change.
-     *
-     * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
-     * @param bool   $send_related_messages  Whether or not to send related messages after changing the bulk action.
-     */
-    public function changeRegistrationStatusOnRegistrationDetailsPageTo(
-        $status_label_or_value,
-        $send_related_messages = true
-    ) {
-        $this->actor()->selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value);
-        $this->actor()->selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages);
-        $this->actor()->click(RegistrationsAdminPage::BUTTON_UPDATE_REGISTRATION_STATUS);
-        $this->actor()->waitForText('Registration status has been set to');
-    }
+	/**
+	 * This will select all checkboxes on a registration list table for the given array of
+	 * registration ids.
+	 * Assumes the actor is on a list table page for registrations.
+	 * @param $registration_ids
+	 */
+	public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids)
+	{
+		foreach ($registration_ids as $registration_id) {
+			$this->actor()->checkOption(
+				RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id)
+			);
+		}
+	}
+
+
+	/**
+	 * Navigates the actor to the default registration list table page.
+	 * @param string $additional_params
+	 */
+	public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(
+			RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params)
+		);
+		//wait for page to fully load
+		$this->actor()->wait(5);
+	}
+
+
+	/**
+	 * Will enter the provided value in the registration list table search field and execute a search for that value.
+	 * @param string $search_text
+	 */
+	public function searchForRegistrationOnRegistrationListTableWithText($search_text)
+	{
+		$this->amOnDefaultRegistrationsListTableAdminPage();
+		$this->actor()->fillField(RegistrationsAdminPage::SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION, $search_text);
+		$this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
+		$this->actor()->waitForText('Displaying search results for');
+	}
+
+
+
+	/**
+	 * This will filter the registration list table to view registrations for the given event id.
+	 * Assumption is made that you are logged into the admin but you do not need to be on the registration list table
+	 * page.
+	 *
+	 * @param int $event_id  The id of the event viewing registrations for.
+	 */
+	public function amViewingRegistrationsForEvent($event_id)
+	{
+		$this->actor()->amOnDefaultEventsListTablePage();
+		$this->actor()->click(EventsAdmin::listTableActionLinkRegistrationsForEvent($event_id));
+		$this->actor()->waitForText('Viewing registrations for the event');
+	}
+
+
+	/**
+	 * This helper will initiate registering for the given event via the backend.
+	 * @param int $event_id  The event to initiate registration for.
+	 */
+	public function amOnAdminRegistrationPageForEvent($event_id)
+	{
+		$this->actor()->amViewingRegistrationsForEvent($event_id);
+		$this->actor()->click(RegistrationsAdminPage::BUTTON_ADD_NEW_REGISTRATION);
+		$this->actor()->waitForText('Adding Registration For');
+	}
+
+
+
+	/**
+	 * This clicks the View Details Link for Registration with the given Id
+	 * @param $registration_id
+	 */
+	public function clickViewDetailsLinkForRegistrationWithId($registration_id)
+	{
+		$this->actor()->click(RegistrationsAdminPage::viewDetailsLinkSelectorForRegistrationId($registration_id));
+	}
+
+
+	/**
+	 * /**
+	 * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
+	 * dropdown for changing registration status.
+	 *
+	 * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
+	 * @param $status_label_or_value
+	 */
+	public function selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value)
+	{
+		$this->actor()->selectOption(
+			RegistrationsAdminPage::DROPDOWN_REGISTRATION_STATUS,
+			$status_label_or_value
+		);
+	}
+
+
+	/**
+	 * This selects (or deselects) the "Send Related Messages" checkbox on the Registration Details page.
+	 * @param bool $send_related_messages
+	 */
+	public function selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages = true)
+	{
+		$send_related_messages
+			? $this->actor()->selectOption(
+				RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
+				'Yes'
+			)
+			: $this->actor()->selecOption(
+				RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
+				'No'
+			);
+	}
+
+
+
+	/**
+	 * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
+	 * dropdown for changing registration status and submits the change.
+	 *
+	 * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
+	 * @param bool   $send_related_messages  Whether or not to send related messages after changing the bulk action.
+	 */
+	public function changeRegistrationStatusOnRegistrationDetailsPageTo(
+		$status_label_or_value,
+		$send_related_messages = true
+	) {
+		$this->actor()->selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value);
+		$this->actor()->selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages);
+		$this->actor()->click(RegistrationsAdminPage::BUTTON_UPDATE_REGISTRATION_STATUS);
+		$this->actor()->waitForText('Registration status has been set to');
+	}
 
 }
\ No newline at end of file