eventespresso / event-espresso-core

core/services/calculators/LineItemCalculator.php

Indentation +752 added lines, -752 removed lines

@@ -21,756 +21,756 @@
 class LineItemCalculator
 {
 
-    /**
-     * @var DecimalValues
-     */
-    protected $decimal_values;
-
-    /**
-     * @var array
-     */
-    protected $default_query_params = [
-        ['LIN_type' => ['!=', EEM_Line_Item::type_cancellation]]
-    ];
-
-    private $lb = "\n"; // \n <br />
-
-
-    /**
-     * @param DecimalValues $decimal_values
-     */
-    public function __construct(DecimalValues $decimal_values)
-    {
-        $this->decimal_values = $decimal_values;
-    }
-
-
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total (provided this line item is allowed to persist, otherwise we don't
-     * want to change a persistable transaction with info from a non-persistent line item)
-     *
-     * @param EE_Line_Item $line_item
-     * @param bool         $update_txn_status
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateTotalIncludingTaxes(EE_Line_Item $line_item, bool $update_txn_status = false): float
-    {
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-        if (empty($ticket_line_items)) {
-            return 0;
-        }
-        [$total, $pretax_total] = $this->recalculateLineItemTotals($line_item);
-        // echo "{$this->lb}{$this->lb} = PRETAX GRAND TOTAL: {$pretax_total}";
-        // echo "{$this->lb} = GRAND TOTAL: {$total}{$this->lb}";
-        // EEH_Line_Item::visualize($line_item);
-        $total_tax = $this->recalculateTaxesAndTaxTotal($line_item);
-        // no negative totals plz
-        $grand_total  = max($pretax_total + $total_tax, 0);
-        $this->updatePreTaxTotal($line_item, $pretax_total, true);
-        $grand_total  = $this->updateTotal($line_item, $grand_total, true);
-        $this->updateTransaction($line_item, $grand_total, $update_txn_status);
-        // die();
-        return $grand_total;
-    }
-
-
-    /**
-     * Recursively goes through all the children and recalculates sub-totals EXCEPT for
-     * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
-     * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
-     * when this is called on the grand total
-     *
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param float        $pretax_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateLineItemTotals(
-        EE_Line_Item $line_item,
-        float $total = 0,
-        float $pretax_total = 0
-    ): array {
-        // echo "{$this->lb}recalculate LineItem Totals: {$line_item->type()} -> {$line_item->name()}";
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-            case EEM_Line_Item::type_sub_total:
-                [$total, $pretax_total] = $this->recalculateSubTotal($line_item);
-                break;
-
-            case EEM_Line_Item::type_line_item:
-                [$total, $pretax_total] = $this->recalculateLineItem($line_item, $total, $pretax_total);
-                break;
-
-            case EEM_Line_Item::type_sub_line_item:
-                // sub line items operate on the total and update both the total AND the pre-tax total
-                [$total, $pretax_total] = $this->recalculateSubLineItem($line_item, $total, $pretax_total);
-                break;
-
-            case EEM_Line_Item::type_sub_tax:
-                // sub line item taxes ONLY operate on the pre-tax total and ONLY update the total
-                [$total, $pretax_total] = $this->recalculateSubTax($line_item, $pretax_total);
-                break;
-
-            case EEM_Line_Item::type_tax_sub_total:
-            case EEM_Line_Item::type_tax:
-            case EEM_Line_Item::type_cancellation:
-                // completely ignore tax totals, tax sub-totals, and cancelled line items
-                // when calculating the pre-tax-total
-                $total = $pretax_total = 0;
-                break;
-        }
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubTotal(EE_Line_Item $line_item): array
-    {
-        // echo "{$this->lb}  recalculate SubTotal: {$line_item->name()}";
-        // reset the total and pretax total to zero since we are recalculating them
-        $total = $pretax_total = 0;
-        if ($line_item->is_total()) {
-            // if this is the grand total line item
-            // then first update ALL of the line item quantities (if need be)
-            $this->updateLineItemQuantities($line_item);
-        }
-        // recursively loop through children and recalculate their totals
-        $children = $line_item->children($this->default_query_params);
-        if (empty($children)) {
-            return [$total, $pretax_total];
-        }
-        foreach ($children as $child_line_item) {
-            [$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
-                $child_line_item,
-                $total,
-                $pretax_total
-            );
-            $total += $child_total;
-            $pretax_total += $child_pretax_total;
-            // echo "{$this->lb}   = running sub total: {$total} ({$child_line_item->name()})";
-            // echo "{$this->lb}   = running pretax sub total: {$pretax_total} ({$child_line_item->name()})";
-        }
-        // update the unit price and pretax total
-        $this->updateUnitPrice($line_item, $pretax_total);
-        $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
-        // for the actual pre-tax sub total line item, we want to save the pretax value for everything
-        if ($line_item->is_sub_total() && $line_item->name() === esc_html__('Pre-Tax Subtotal', 'event_espresso')) {
-            $this->updateTotal($line_item, $pretax_total, true);
-        } elseif (! $line_item->is_total()) {
-            // we don't update the total for the total line item, because that will need to include taxes
-            $total = $this->updateTotal($line_item, $total, true);
-        }
-        // echo "{$this->lb}   = pretax sub total: {$pretax_total} ({$line_item->name()})";
-        // echo "{$this->lb}   = sub total: {$total} ({$line_item->name()})";
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param float        $pretax_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateLineItem(
-        EE_Line_Item $line_item,
-        float $total = 0,
-        float $pretax_total = 0
-    ): array {
-        // echo "{$this->lb}    recalculate LineItem: {$line_item->name()}";
-        if ($line_item->is_percent()) {
-            $total = $this->calculatePercentage($total, $line_item->percent());
-            $pretax_total = $this->calculatePercentage($pretax_total, $line_item->percent());
-            // echo "{$this->lb}     = % pretax total: {$pretax_total} ({$line_item->name()})";
-            // echo "{$this->lb}     = % total: {$total} ({$line_item->name()})";
-        } else {
-            // recursively loop through children and recalculate their totals
-            $children = $line_item->children($this->default_query_params);
-            if (! empty($children)) {
-                // reset the total and pretax total to zero since we are recalculating them
-                $total = $pretax_total = 0;
-                foreach ($children as $child_line_item) {
-                    [$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
-                        $child_line_item,
-                        $total,
-                        $pretax_total
-                    );
-                    $total        += $child_total;
-                    $pretax_total += $child_pretax_total;
-                    // echo "{$this->lb}     = running total: {$total} ({$child_line_item->name()})";
-                    // echo "{$this->lb}     = running pretax total: {$pretax_total} ({$child_line_item->name()})";
-                }
-                // echo "{$this->lb}     = child pretax total: {$pretax_total} ({$line_item->name()})";
-                // echo "{$this->lb}     = child total: {$total} ({$line_item->name()})";
-            } else {
-                // no child line items, so recalculate the total from the unit price and quantity
-                // and set the pretax total to match since their are obviously no sub-taxes
-                $pretax_total = $total = $this->calculateTotalForQuantity($line_item);
-                // echo "{$this->lb}     = li pretax total: {$pretax_total} ({$line_item->name()})";
-                // echo "{$this->lb}     = li total: {$total} ({$line_item->name()})";
-            }
-        }
-        $total  = $this->updateTotal($line_item, $total, true);
-        $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
-
-        // need to also adjust unit price too if the pretax total or quantity has been updated
-        $this->updateUnitPrice($line_item, $pretax_total);
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $sub_line_item
-     * @param float|int    $total
-     * @param float|int    $pretax_total
-     * @return float[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubLineItem(EE_Line_Item $sub_line_item, float $total = 0, float $pretax_total = 0): array
-    {
-        // echo "{$this->lb}      recalculate SubLineItem: {$sub_line_item->name()}";
-        if ($sub_line_item->is_percent()) {
-            $new_total = $this->calculatePercentage($total, $sub_line_item->percent());
-            $new_pretax_total = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
-            // echo "{$this->lb}       = sub li percent: {$sub_line_item->percent()}";
-            // echo "{$this->lb}       = sub li total: {$total}";
-            // echo "{$this->lb}       = sub li pretax_total: {$pretax_total}";
-        } else {
-            $new_total = $new_pretax_total = $this->calculateTotalForQuantity($sub_line_item);
-            // echo "{$this->lb}       = sub li unit price: {$sub_line_item->unit_price()}";
-            // echo "{$this->lb}       = sub li quantity: {$sub_line_item->quantity()}";
-            // echo "{$this->lb}       = sub li new_total: {$new_total}";
-        }
-        $total = $this->updateTotal($sub_line_item, $new_total);
-        $pretax_total = $this->updatePreTaxTotal($sub_line_item, $new_pretax_total);
-        // need to also adjust unit price too if the pretax total or quantity has been updated
-        $this->updateUnitPrice($sub_line_item, $pretax_total);
-        // echo "{$this->lb}       = sub li final pretax total: {$pretax_total}";
-        // echo "{$this->lb}       = sub li final total: {$total}";
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $sub_line_item
-     * @param float|int    $pretax_total
-     * @return float[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubTax(EE_Line_Item $sub_line_item, float $pretax_total = 0): array
-    {
-        // echo "{$this->lb}      recalculate SubTax: {$sub_line_item->name()}";
-        // echo "{$this->lb}       = sub li percent: {$sub_line_item->percent()}";
-        $total_tax = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
-        $total_tax = $this->updateTotal($sub_line_item, $total_tax);
-        // echo "{$this->lb}       = sub li total tax: {$total_tax}";
-        return [$total_tax, 0];
-    }
-
-
-    /**
-     * recursively loops through the entire line item tree updating line item quantities accordingly.
-     * this needs to be done prior to running any other calculations for reasons that are hopefully obvious :p
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $quantity
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateLineItemQuantities(EE_Line_Item $line_item, int $quantity = 1): int
-    {
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-            case EEM_Line_Item::type_sub_total:
-            case EEM_Line_Item::type_tax_sub_total:
-                // first, loop through children and set their quantities
-                $count = 0;
-                $children = $line_item->children($this->default_query_params);
-                foreach ($children as $child_line_item) {
-                    $count += $this->updateLineItemQuantities($child_line_item);
-                }
-                // totals and subtotals should have a quantity of 1
-                // unless their children have all been removed, in which case we can set them to 0
-                $quantity = $count > 0 ? 1 : 0;
-                $this->updateQuantity($line_item, $quantity);
-                return $quantity;
-
-            case EEM_Line_Item::type_line_item:
-                // line items should ALREADY have accurate quantities set, if not, then somebody done goofed!
-                // but if this is a percentage based line item, then ensure its quantity is 1
-                if ($line_item->is_percent()) {
-                    $this->updateQuantity($line_item, 1);
-                }
-                // and we also need to loop through all of the sub items and ensure those quantities match this parent.
-                $children = $line_item->children($this->default_query_params);
-                $quantity = $line_item->quantity();
-                foreach ($children as $child_line_item) {
-                    $this->updateLineItemQuantities($child_line_item, $quantity);
-                }
-                // percentage line items should not increment their parent's count, so they return 0
-                return ! $line_item->is_percent() ? $quantity : 0;
-
-            case EEM_Line_Item::type_sub_line_item:
-                // percentage based items need their quantity set to 1,
-                // all others use the incoming value from the parent line item
-                $quantity = $line_item->is_percent() ? 1 : $quantity;
-                $this->updateQuantity($line_item, $quantity);
-                // percentage line items should not increment their parent's count, so they return 0
-                return ! $line_item->is_percent() ? $quantity : 0;
-
-            case EEM_Line_Item::type_tax:
-            case EEM_Line_Item::type_sub_tax:
-                // taxes should have a quantity of 1
-                $this->updateQuantity($line_item, 1);
-                return 1;
-
-            case EEM_Line_Item::type_cancellation:
-                // cancellations will be ignored for all calculations
-                // because their parent quantities should have already been adjusted when they were added
-                // so assume that things are already set correctly
-                return 0;
-        }
-        return 0;
-    }
-
-
-    /**
-     * @param float $total
-     * @param float $percent
-     * @param bool  $round
-     * @return float
-     */
-    private function calculatePercentage(float $total, float $percent, bool $round = false): float
-    {
-        $amount = $total * $percent / 100;
-        // echo "{$this->lb}     = calculate %: {$total} * {$percent}% = {$amount}";
-        return $this->decimal_values->roundDecimalValue($amount, $round);
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function calculateTotalForQuantity(EE_Line_Item $line_item): float
-    {
-        $total = $line_item->unit_price() * $line_item->quantity();
-        return $this->decimal_values->roundDecimalValue($total);
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $percent
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updatePercent(EE_Line_Item $line_item, float $percent)
-    {
-        // update and save new percent only if incoming value does not match existing value
-        if ($line_item->percent() !== $percent) {
-            $line_item->set_percent($percent);
-            $line_item->maybe_save();
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $pretax_total
-     * @param bool         $round
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updatePreTaxTotal(EE_Line_Item $line_item, float $pretax_total, bool $round = false): float
-    {
-        $pretax_total = $this->decimal_values->roundDecimalValue($pretax_total, $round);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->preTaxTotal() !== $pretax_total) {
-            $line_item->setPreTaxTotal($pretax_total);
-            $line_item->maybe_save();
-        }
-        return $pretax_total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param int          $quantity
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateQuantity(EE_Line_Item $line_item, int $quantity)
-    {
-        // update and save new quantity only if incoming value does not match existing value
-        if ($line_item->quantity() !== $quantity) {
-            $line_item->set_quantity($quantity);
-            $line_item->maybe_save();
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param bool         $round
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateTotal(EE_Line_Item $line_item, float $total, bool $round = false): float
-    {
-        $total = $this->decimal_values->roundDecimalValue($total, $round);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->total() !== $total) {
-            $line_item->set_total($total);
-            $line_item->maybe_save();
-        }
-        return $total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param bool         $update_status
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateTransaction(EE_Line_Item $line_item, float $total, bool $update_status)
-    {
-        // only update the related transaction's total
-        // if we intend to save this line item and its a grand total
-        if ($line_item->allow_persist()) {
-            $transaction = $line_item->transaction();
-            if ($transaction instanceof EE_Transaction) {
-                $transaction->set_total($total);
-                if ($update_status) {
-                    // don't save the TXN because that will be done below
-                    // and the following method only saves if the status changes
-                    $transaction->update_status_based_on_total_paid(false);
-                }
-                if ($transaction->ID()) {
-                    $transaction->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $pretax_total
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateUnitPrice(EE_Line_Item $line_item, float $pretax_total)
-    {
-        $quantity = $line_item->quantity();
-        // don't divide by zero else you'll create a singularity and implode the interweb
-        // we also don't set unit prices for percentage based line items
-        if ($quantity === 0 || $line_item->is_percent()) {
-            return;
-        }
-        $new_unit_price = $pretax_total / $quantity;
-        $new_unit_price = $this->decimal_values->roundDecimalValue($new_unit_price);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->unit_price() !== $new_unit_price) {
-            $line_item->set_unit_price($new_unit_price);
-            $line_item->maybe_save();
-        }
-    }
-
-
-    /**
-     * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
-     * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
-     * and tax sub-total if already in the DB
-     *
-     * @param EE_Line_Item $total_line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateTaxesAndTaxTotal(EE_Line_Item $total_line_item): float
-    {
-        $this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
-        // calculate the total taxable amount for globally applied taxes
-        $taxable_total = $this->taxableAmountForGlobalTaxes($total_line_item);
-        $global_taxes     = $this->applyGlobalTaxes($total_line_item, $taxable_total);
-        $non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
-        $all_tax_total        = $this->applyNonGlobalTaxes($total_line_item, $global_taxes, $non_global_taxes);
-        $this->recalculateTaxSubTotal($total_line_item);
-        return $all_tax_total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param float        $taxable_total
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function applyGlobalTaxes(EE_Line_Item $total_line_item, float $taxable_total): float
-    {
-        $this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
-        $total_tax = 0;
-        // loop through all global taxes all taxes
-        $global_taxes = $total_line_item->tax_descendants();
-        foreach ($global_taxes as $tax) {
-            $tax_total = $this->calculatePercentage($taxable_total, $tax->percent());
-            $tax_total = $this->updateTotal($tax, $tax_total, true);
-            $total_tax += $tax_total;
-        }
-        return $this->decimal_values->roundDecimalValue($total_tax, true);
-    }
-
-
-    /**
-     * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
-     *
-     * @param EE_Line_Item $line_item
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateTaxSubTotal(EE_Line_Item $line_item)
-    {
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        foreach ($line_item->children() as $maybe_tax_subtotal) {
-            if (
-                $this->validateLineItemAndType($maybe_tax_subtotal)
-                && $maybe_tax_subtotal->is_tax_sub_total()
-            ) {
-                $total         = 0;
-                $total_percent = 0;
-                // simply loop through all its children (which should be taxes) and sum their total
-                foreach ($maybe_tax_subtotal->children() as $child_tax) {
-                    if ($this->validateLineItemAndType($child_tax) && $child_tax->isGlobalTax()) {
-                        $total         += $child_tax->total();
-                        $total_percent += $child_tax->percent();
-                    }
-                }
-                $this->updateTotal($maybe_tax_subtotal, $total, true);
-                $this->updatePercent($maybe_tax_subtotal, $total_percent);
-            }
-        }
-    }
-
-
-    /**
-     * returns an array of tax details like:
-     *  [
-     *      'GST_7' => [
-     *          'name'  => 'GST',
-     *          'rate'  => float(7),
-     *          'total' => float(4.9),
-     *      ]
-     *  ]
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param array        $non_global_taxes
-     * @param float        $line_item_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function calculateNonGlobalTaxes(
-        EE_Line_Item $total_line_item,
-        array $non_global_taxes = [],
-        float $line_item_total = 0
-    ): array {
-        foreach ($total_line_item->children() as $line_item) {
-            if ($this->validateLineItemAndType($line_item)) {
-                if ($line_item->is_sub_total()) {
-                    $non_global_taxes = $this->calculateNonGlobalTaxes($line_item, $non_global_taxes);
-                } elseif ($line_item->is_line_item()) {
-                    $non_global_taxes = $this->calculateNonGlobalTaxes(
-                        $line_item,
-                        $non_global_taxes,
-                        $line_item->pretaxTotal()
-                    );
-                } elseif ($line_item->isSubTax()) {
-                    $tax_ID = $line_item->name() . '_' . $line_item->percent();
-                    if (! isset($non_global_taxes[ $tax_ID ])) {
-                        $non_global_taxes[ $tax_ID ] = [
-                            'name'  => $line_item->name(),
-                            'rate'  => $line_item->percent(),
-                            'total' => 0,
-                            'obj'   => $line_item->OBJ_type(),
-                            'objID' => $line_item->OBJ_ID(),
-                        ];
-                    }
-                    $tax = $this->calculatePercentage($line_item_total, $line_item->percent());
-                    $non_global_taxes[ $tax_ID ]['total'] += $tax;
-                }
-            }
-        }
-        return $non_global_taxes;
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param float        $tax_total
-     * @param array        $non_global_taxes array of tax details generated by calculateNonGlobalTaxes()
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function applyNonGlobalTaxes(
-        EE_Line_Item $total_line_item,
-        float $tax_total,
-        array $non_global_taxes
-    ): float {
-        $global_taxes   = $total_line_item->tax_descendants();
-        $taxes_subtotal = EEH_Line_Item::get_taxes_subtotal($total_line_item);
-        foreach ($non_global_taxes as $non_global_tax) {
-            $found = false;
-            foreach ($global_taxes as $global_tax) {
-                if (
-                    $this->validateLineItemAndType($global_tax)
-                    && $non_global_tax['obj'] === $global_tax->OBJ_type()
-                    && $non_global_tax['objID'] === $global_tax->OBJ_ID()
-                ) {
-                    $found = true;
-                    $new_total = $global_tax->total() + $non_global_tax['total'];
-                    // add non global tax to matching global tax AND the tax total
-                    $global_tax->set_total($new_total);
-                    $global_tax->maybe_save();
-                    $tax_total += $non_global_tax['total'];
-                }
-            }
-            if (! $found) {
-                // add a new line item for this non global tax
-                $taxes_subtotal->add_child_line_item(
-                    EE_Line_Item::new_instance(
-                        [
-                            'LIN_name'       => $non_global_tax['name'],
-                            'LIN_percent'    => $non_global_tax['rate'],
-                            'LIN_is_taxable' => false,
-                            'LIN_total'      => $non_global_tax['total'],
-                            'LIN_type'       => EEM_Line_Item::type_tax,
-                            'OBJ_type'       => $non_global_tax['obj'],
-                            'OBJ_ID'         => $non_global_tax['objID'],
-                        ]
-                    )
-                );
-                $tax_total += $non_global_tax['total'];
-            }
-        }
-        return $this->decimal_values->roundDecimalValue($tax_total, true);
-    }
-
-
-    /**
-     * Gets the total tax on this line item. Assumes taxes have already been calculated using
-     * recalculate_taxes_and_total
-     *
-     * @param EE_Line_Item $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getTotalTax(EE_Line_Item $line_item): float
-    {
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        $this->recalculateTaxSubTotal($line_item);
-        $total = 0;
-        foreach ($line_item->tax_descendants() as $tax_line_item) {
-            if ($this->validateLineItemAndType($tax_line_item)) {
-                $total += $tax_line_item->total();
-            }
-        }
-        return $this->decimal_values->roundDecimalValue($total, true);
-    }
-
-
-    /**
-     * Returns the amount taxable among this line item's children (or if it has no children,
-     * how much of it is taxable). Does not recalculate totals or subtotals.
-     * If the taxable total is negative, (eg, if none of the tickets were taxable,
-     * but there is a "Taxable" discount), returns 0.
-     *
-     * @param EE_Line_Item|null $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function taxableAmountForGlobalTaxes(?EE_Line_Item $line_item): float
-    {
-        $total      = 0;
-        $child_line_items = $line_item->children($this->default_query_params);
-        foreach ($child_line_items as $child_line_item) {
-            $this->validateLineItemAndType($child_line_item);
-            if ($child_line_item->is_sub_total()) {
-                $total += $this->taxableAmountForGlobalTaxes($child_line_item);
-            } elseif ($child_line_item->is_line_item() && $child_line_item->is_taxable()) {
-                // if it's a percent item, only take into account
-                // the percentage that's taxable (the taxable total so far)
-                if ($child_line_item->is_percent()) {
-                    $total += $this->calculatePercentage($total, $child_line_item->percent(), true);
-                } else {
-                    // pretax total will be equal to the total for line items with globally applied taxes
-                    $pretax_total = $this->calculateTotalForQuantity($child_line_item);
-                    $total += $this->updatePreTaxTotal($child_line_item, $pretax_total);
-                }
-            }
-        }
-        return max($total, 0);
-    }
-
-
-    /**
-     * @param EE_Line_Item|null $line_item
-     * @param string|null       $type
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
-    {
-        if (! $line_item instanceof EE_Line_Item) {
-            throw new DomainException(
-                esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
-            );
-        }
-        if ($type && $line_item->type() !== $type) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'Invalid Line Item type supplied. Received "%1$s" but expected "%2$s".',
-                        'event_espresso'
-                    ),
-                    $line_item->type(),
-                    $type
-                )
-            );
-        }
-        return true;
-    }
+	/**
+	 * @var DecimalValues
+	 */
+	protected $decimal_values;
+
+	/**
+	 * @var array
+	 */
+	protected $default_query_params = [
+		['LIN_type' => ['!=', EEM_Line_Item::type_cancellation]]
+	];
+
+	private $lb = "\n"; // \n <br />
+
+
+	/**
+	 * @param DecimalValues $decimal_values
+	 */
+	public function __construct(DecimalValues $decimal_values)
+	{
+		$this->decimal_values = $decimal_values;
+	}
+
+
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total (provided this line item is allowed to persist, otherwise we don't
+	 * want to change a persistable transaction with info from a non-persistent line item)
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param bool         $update_txn_status
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateTotalIncludingTaxes(EE_Line_Item $line_item, bool $update_txn_status = false): float
+	{
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+		if (empty($ticket_line_items)) {
+			return 0;
+		}
+		[$total, $pretax_total] = $this->recalculateLineItemTotals($line_item);
+		// echo "{$this->lb}{$this->lb} = PRETAX GRAND TOTAL: {$pretax_total}";
+		// echo "{$this->lb} = GRAND TOTAL: {$total}{$this->lb}";
+		// EEH_Line_Item::visualize($line_item);
+		$total_tax = $this->recalculateTaxesAndTaxTotal($line_item);
+		// no negative totals plz
+		$grand_total  = max($pretax_total + $total_tax, 0);
+		$this->updatePreTaxTotal($line_item, $pretax_total, true);
+		$grand_total  = $this->updateTotal($line_item, $grand_total, true);
+		$this->updateTransaction($line_item, $grand_total, $update_txn_status);
+		// die();
+		return $grand_total;
+	}
+
+
+	/**
+	 * Recursively goes through all the children and recalculates sub-totals EXCEPT for
+	 * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
+	 * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
+	 * when this is called on the grand total
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param float        $pretax_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateLineItemTotals(
+		EE_Line_Item $line_item,
+		float $total = 0,
+		float $pretax_total = 0
+	): array {
+		// echo "{$this->lb}recalculate LineItem Totals: {$line_item->type()} -> {$line_item->name()}";
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+			case EEM_Line_Item::type_sub_total:
+				[$total, $pretax_total] = $this->recalculateSubTotal($line_item);
+				break;
+
+			case EEM_Line_Item::type_line_item:
+				[$total, $pretax_total] = $this->recalculateLineItem($line_item, $total, $pretax_total);
+				break;
+
+			case EEM_Line_Item::type_sub_line_item:
+				// sub line items operate on the total and update both the total AND the pre-tax total
+				[$total, $pretax_total] = $this->recalculateSubLineItem($line_item, $total, $pretax_total);
+				break;
+
+			case EEM_Line_Item::type_sub_tax:
+				// sub line item taxes ONLY operate on the pre-tax total and ONLY update the total
+				[$total, $pretax_total] = $this->recalculateSubTax($line_item, $pretax_total);
+				break;
+
+			case EEM_Line_Item::type_tax_sub_total:
+			case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_cancellation:
+				// completely ignore tax totals, tax sub-totals, and cancelled line items
+				// when calculating the pre-tax-total
+				$total = $pretax_total = 0;
+				break;
+		}
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubTotal(EE_Line_Item $line_item): array
+	{
+		// echo "{$this->lb}  recalculate SubTotal: {$line_item->name()}";
+		// reset the total and pretax total to zero since we are recalculating them
+		$total = $pretax_total = 0;
+		if ($line_item->is_total()) {
+			// if this is the grand total line item
+			// then first update ALL of the line item quantities (if need be)
+			$this->updateLineItemQuantities($line_item);
+		}
+		// recursively loop through children and recalculate their totals
+		$children = $line_item->children($this->default_query_params);
+		if (empty($children)) {
+			return [$total, $pretax_total];
+		}
+		foreach ($children as $child_line_item) {
+			[$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
+				$child_line_item,
+				$total,
+				$pretax_total
+			);
+			$total += $child_total;
+			$pretax_total += $child_pretax_total;
+			// echo "{$this->lb}   = running sub total: {$total} ({$child_line_item->name()})";
+			// echo "{$this->lb}   = running pretax sub total: {$pretax_total} ({$child_line_item->name()})";
+		}
+		// update the unit price and pretax total
+		$this->updateUnitPrice($line_item, $pretax_total);
+		$pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
+		// for the actual pre-tax sub total line item, we want to save the pretax value for everything
+		if ($line_item->is_sub_total() && $line_item->name() === esc_html__('Pre-Tax Subtotal', 'event_espresso')) {
+			$this->updateTotal($line_item, $pretax_total, true);
+		} elseif (! $line_item->is_total()) {
+			// we don't update the total for the total line item, because that will need to include taxes
+			$total = $this->updateTotal($line_item, $total, true);
+		}
+		// echo "{$this->lb}   = pretax sub total: {$pretax_total} ({$line_item->name()})";
+		// echo "{$this->lb}   = sub total: {$total} ({$line_item->name()})";
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param float        $pretax_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateLineItem(
+		EE_Line_Item $line_item,
+		float $total = 0,
+		float $pretax_total = 0
+	): array {
+		// echo "{$this->lb}    recalculate LineItem: {$line_item->name()}";
+		if ($line_item->is_percent()) {
+			$total = $this->calculatePercentage($total, $line_item->percent());
+			$pretax_total = $this->calculatePercentage($pretax_total, $line_item->percent());
+			// echo "{$this->lb}     = % pretax total: {$pretax_total} ({$line_item->name()})";
+			// echo "{$this->lb}     = % total: {$total} ({$line_item->name()})";
+		} else {
+			// recursively loop through children and recalculate their totals
+			$children = $line_item->children($this->default_query_params);
+			if (! empty($children)) {
+				// reset the total and pretax total to zero since we are recalculating them
+				$total = $pretax_total = 0;
+				foreach ($children as $child_line_item) {
+					[$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
+						$child_line_item,
+						$total,
+						$pretax_total
+					);
+					$total        += $child_total;
+					$pretax_total += $child_pretax_total;
+					// echo "{$this->lb}     = running total: {$total} ({$child_line_item->name()})";
+					// echo "{$this->lb}     = running pretax total: {$pretax_total} ({$child_line_item->name()})";
+				}
+				// echo "{$this->lb}     = child pretax total: {$pretax_total} ({$line_item->name()})";
+				// echo "{$this->lb}     = child total: {$total} ({$line_item->name()})";
+			} else {
+				// no child line items, so recalculate the total from the unit price and quantity
+				// and set the pretax total to match since their are obviously no sub-taxes
+				$pretax_total = $total = $this->calculateTotalForQuantity($line_item);
+				// echo "{$this->lb}     = li pretax total: {$pretax_total} ({$line_item->name()})";
+				// echo "{$this->lb}     = li total: {$total} ({$line_item->name()})";
+			}
+		}
+		$total  = $this->updateTotal($line_item, $total, true);
+		$pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
+
+		// need to also adjust unit price too if the pretax total or quantity has been updated
+		$this->updateUnitPrice($line_item, $pretax_total);
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $sub_line_item
+	 * @param float|int    $total
+	 * @param float|int    $pretax_total
+	 * @return float[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubLineItem(EE_Line_Item $sub_line_item, float $total = 0, float $pretax_total = 0): array
+	{
+		// echo "{$this->lb}      recalculate SubLineItem: {$sub_line_item->name()}";
+		if ($sub_line_item->is_percent()) {
+			$new_total = $this->calculatePercentage($total, $sub_line_item->percent());
+			$new_pretax_total = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
+			// echo "{$this->lb}       = sub li percent: {$sub_line_item->percent()}";
+			// echo "{$this->lb}       = sub li total: {$total}";
+			// echo "{$this->lb}       = sub li pretax_total: {$pretax_total}";
+		} else {
+			$new_total = $new_pretax_total = $this->calculateTotalForQuantity($sub_line_item);
+			// echo "{$this->lb}       = sub li unit price: {$sub_line_item->unit_price()}";
+			// echo "{$this->lb}       = sub li quantity: {$sub_line_item->quantity()}";
+			// echo "{$this->lb}       = sub li new_total: {$new_total}";
+		}
+		$total = $this->updateTotal($sub_line_item, $new_total);
+		$pretax_total = $this->updatePreTaxTotal($sub_line_item, $new_pretax_total);
+		// need to also adjust unit price too if the pretax total or quantity has been updated
+		$this->updateUnitPrice($sub_line_item, $pretax_total);
+		// echo "{$this->lb}       = sub li final pretax total: {$pretax_total}";
+		// echo "{$this->lb}       = sub li final total: {$total}";
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $sub_line_item
+	 * @param float|int    $pretax_total
+	 * @return float[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubTax(EE_Line_Item $sub_line_item, float $pretax_total = 0): array
+	{
+		// echo "{$this->lb}      recalculate SubTax: {$sub_line_item->name()}";
+		// echo "{$this->lb}       = sub li percent: {$sub_line_item->percent()}";
+		$total_tax = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
+		$total_tax = $this->updateTotal($sub_line_item, $total_tax);
+		// echo "{$this->lb}       = sub li total tax: {$total_tax}";
+		return [$total_tax, 0];
+	}
+
+
+	/**
+	 * recursively loops through the entire line item tree updating line item quantities accordingly.
+	 * this needs to be done prior to running any other calculations for reasons that are hopefully obvious :p
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $quantity
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateLineItemQuantities(EE_Line_Item $line_item, int $quantity = 1): int
+	{
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+			case EEM_Line_Item::type_sub_total:
+			case EEM_Line_Item::type_tax_sub_total:
+				// first, loop through children and set their quantities
+				$count = 0;
+				$children = $line_item->children($this->default_query_params);
+				foreach ($children as $child_line_item) {
+					$count += $this->updateLineItemQuantities($child_line_item);
+				}
+				// totals and subtotals should have a quantity of 1
+				// unless their children have all been removed, in which case we can set them to 0
+				$quantity = $count > 0 ? 1 : 0;
+				$this->updateQuantity($line_item, $quantity);
+				return $quantity;
+
+			case EEM_Line_Item::type_line_item:
+				// line items should ALREADY have accurate quantities set, if not, then somebody done goofed!
+				// but if this is a percentage based line item, then ensure its quantity is 1
+				if ($line_item->is_percent()) {
+					$this->updateQuantity($line_item, 1);
+				}
+				// and we also need to loop through all of the sub items and ensure those quantities match this parent.
+				$children = $line_item->children($this->default_query_params);
+				$quantity = $line_item->quantity();
+				foreach ($children as $child_line_item) {
+					$this->updateLineItemQuantities($child_line_item, $quantity);
+				}
+				// percentage line items should not increment their parent's count, so they return 0
+				return ! $line_item->is_percent() ? $quantity : 0;
+
+			case EEM_Line_Item::type_sub_line_item:
+				// percentage based items need their quantity set to 1,
+				// all others use the incoming value from the parent line item
+				$quantity = $line_item->is_percent() ? 1 : $quantity;
+				$this->updateQuantity($line_item, $quantity);
+				// percentage line items should not increment their parent's count, so they return 0
+				return ! $line_item->is_percent() ? $quantity : 0;
+
+			case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_sub_tax:
+				// taxes should have a quantity of 1
+				$this->updateQuantity($line_item, 1);
+				return 1;
+
+			case EEM_Line_Item::type_cancellation:
+				// cancellations will be ignored for all calculations
+				// because their parent quantities should have already been adjusted when they were added
+				// so assume that things are already set correctly
+				return 0;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * @param float $total
+	 * @param float $percent
+	 * @param bool  $round
+	 * @return float
+	 */
+	private function calculatePercentage(float $total, float $percent, bool $round = false): float
+	{
+		$amount = $total * $percent / 100;
+		// echo "{$this->lb}     = calculate %: {$total} * {$percent}% = {$amount}";
+		return $this->decimal_values->roundDecimalValue($amount, $round);
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function calculateTotalForQuantity(EE_Line_Item $line_item): float
+	{
+		$total = $line_item->unit_price() * $line_item->quantity();
+		return $this->decimal_values->roundDecimalValue($total);
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $percent
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updatePercent(EE_Line_Item $line_item, float $percent)
+	{
+		// update and save new percent only if incoming value does not match existing value
+		if ($line_item->percent() !== $percent) {
+			$line_item->set_percent($percent);
+			$line_item->maybe_save();
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $pretax_total
+	 * @param bool         $round
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updatePreTaxTotal(EE_Line_Item $line_item, float $pretax_total, bool $round = false): float
+	{
+		$pretax_total = $this->decimal_values->roundDecimalValue($pretax_total, $round);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->preTaxTotal() !== $pretax_total) {
+			$line_item->setPreTaxTotal($pretax_total);
+			$line_item->maybe_save();
+		}
+		return $pretax_total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param int          $quantity
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateQuantity(EE_Line_Item $line_item, int $quantity)
+	{
+		// update and save new quantity only if incoming value does not match existing value
+		if ($line_item->quantity() !== $quantity) {
+			$line_item->set_quantity($quantity);
+			$line_item->maybe_save();
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param bool         $round
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateTotal(EE_Line_Item $line_item, float $total, bool $round = false): float
+	{
+		$total = $this->decimal_values->roundDecimalValue($total, $round);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->total() !== $total) {
+			$line_item->set_total($total);
+			$line_item->maybe_save();
+		}
+		return $total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param bool         $update_status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateTransaction(EE_Line_Item $line_item, float $total, bool $update_status)
+	{
+		// only update the related transaction's total
+		// if we intend to save this line item and its a grand total
+		if ($line_item->allow_persist()) {
+			$transaction = $line_item->transaction();
+			if ($transaction instanceof EE_Transaction) {
+				$transaction->set_total($total);
+				if ($update_status) {
+					// don't save the TXN because that will be done below
+					// and the following method only saves if the status changes
+					$transaction->update_status_based_on_total_paid(false);
+				}
+				if ($transaction->ID()) {
+					$transaction->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $pretax_total
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateUnitPrice(EE_Line_Item $line_item, float $pretax_total)
+	{
+		$quantity = $line_item->quantity();
+		// don't divide by zero else you'll create a singularity and implode the interweb
+		// we also don't set unit prices for percentage based line items
+		if ($quantity === 0 || $line_item->is_percent()) {
+			return;
+		}
+		$new_unit_price = $pretax_total / $quantity;
+		$new_unit_price = $this->decimal_values->roundDecimalValue($new_unit_price);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->unit_price() !== $new_unit_price) {
+			$line_item->set_unit_price($new_unit_price);
+			$line_item->maybe_save();
+		}
+	}
+
+
+	/**
+	 * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
+	 * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
+	 * and tax sub-total if already in the DB
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateTaxesAndTaxTotal(EE_Line_Item $total_line_item): float
+	{
+		$this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
+		// calculate the total taxable amount for globally applied taxes
+		$taxable_total = $this->taxableAmountForGlobalTaxes($total_line_item);
+		$global_taxes     = $this->applyGlobalTaxes($total_line_item, $taxable_total);
+		$non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
+		$all_tax_total        = $this->applyNonGlobalTaxes($total_line_item, $global_taxes, $non_global_taxes);
+		$this->recalculateTaxSubTotal($total_line_item);
+		return $all_tax_total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $taxable_total
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function applyGlobalTaxes(EE_Line_Item $total_line_item, float $taxable_total): float
+	{
+		$this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
+		$total_tax = 0;
+		// loop through all global taxes all taxes
+		$global_taxes = $total_line_item->tax_descendants();
+		foreach ($global_taxes as $tax) {
+			$tax_total = $this->calculatePercentage($taxable_total, $tax->percent());
+			$tax_total = $this->updateTotal($tax, $tax_total, true);
+			$total_tax += $tax_total;
+		}
+		return $this->decimal_values->roundDecimalValue($total_tax, true);
+	}
+
+
+	/**
+	 * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateTaxSubTotal(EE_Line_Item $line_item)
+	{
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		foreach ($line_item->children() as $maybe_tax_subtotal) {
+			if (
+				$this->validateLineItemAndType($maybe_tax_subtotal)
+				&& $maybe_tax_subtotal->is_tax_sub_total()
+			) {
+				$total         = 0;
+				$total_percent = 0;
+				// simply loop through all its children (which should be taxes) and sum their total
+				foreach ($maybe_tax_subtotal->children() as $child_tax) {
+					if ($this->validateLineItemAndType($child_tax) && $child_tax->isGlobalTax()) {
+						$total         += $child_tax->total();
+						$total_percent += $child_tax->percent();
+					}
+				}
+				$this->updateTotal($maybe_tax_subtotal, $total, true);
+				$this->updatePercent($maybe_tax_subtotal, $total_percent);
+			}
+		}
+	}
+
+
+	/**
+	 * returns an array of tax details like:
+	 *  [
+	 *      'GST_7' => [
+	 *          'name'  => 'GST',
+	 *          'rate'  => float(7),
+	 *          'total' => float(4.9),
+	 *      ]
+	 *  ]
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param array        $non_global_taxes
+	 * @param float        $line_item_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function calculateNonGlobalTaxes(
+		EE_Line_Item $total_line_item,
+		array $non_global_taxes = [],
+		float $line_item_total = 0
+	): array {
+		foreach ($total_line_item->children() as $line_item) {
+			if ($this->validateLineItemAndType($line_item)) {
+				if ($line_item->is_sub_total()) {
+					$non_global_taxes = $this->calculateNonGlobalTaxes($line_item, $non_global_taxes);
+				} elseif ($line_item->is_line_item()) {
+					$non_global_taxes = $this->calculateNonGlobalTaxes(
+						$line_item,
+						$non_global_taxes,
+						$line_item->pretaxTotal()
+					);
+				} elseif ($line_item->isSubTax()) {
+					$tax_ID = $line_item->name() . '_' . $line_item->percent();
+					if (! isset($non_global_taxes[ $tax_ID ])) {
+						$non_global_taxes[ $tax_ID ] = [
+							'name'  => $line_item->name(),
+							'rate'  => $line_item->percent(),
+							'total' => 0,
+							'obj'   => $line_item->OBJ_type(),
+							'objID' => $line_item->OBJ_ID(),
+						];
+					}
+					$tax = $this->calculatePercentage($line_item_total, $line_item->percent());
+					$non_global_taxes[ $tax_ID ]['total'] += $tax;
+				}
+			}
+		}
+		return $non_global_taxes;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $tax_total
+	 * @param array        $non_global_taxes array of tax details generated by calculateNonGlobalTaxes()
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function applyNonGlobalTaxes(
+		EE_Line_Item $total_line_item,
+		float $tax_total,
+		array $non_global_taxes
+	): float {
+		$global_taxes   = $total_line_item->tax_descendants();
+		$taxes_subtotal = EEH_Line_Item::get_taxes_subtotal($total_line_item);
+		foreach ($non_global_taxes as $non_global_tax) {
+			$found = false;
+			foreach ($global_taxes as $global_tax) {
+				if (
+					$this->validateLineItemAndType($global_tax)
+					&& $non_global_tax['obj'] === $global_tax->OBJ_type()
+					&& $non_global_tax['objID'] === $global_tax->OBJ_ID()
+				) {
+					$found = true;
+					$new_total = $global_tax->total() + $non_global_tax['total'];
+					// add non global tax to matching global tax AND the tax total
+					$global_tax->set_total($new_total);
+					$global_tax->maybe_save();
+					$tax_total += $non_global_tax['total'];
+				}
+			}
+			if (! $found) {
+				// add a new line item for this non global tax
+				$taxes_subtotal->add_child_line_item(
+					EE_Line_Item::new_instance(
+						[
+							'LIN_name'       => $non_global_tax['name'],
+							'LIN_percent'    => $non_global_tax['rate'],
+							'LIN_is_taxable' => false,
+							'LIN_total'      => $non_global_tax['total'],
+							'LIN_type'       => EEM_Line_Item::type_tax,
+							'OBJ_type'       => $non_global_tax['obj'],
+							'OBJ_ID'         => $non_global_tax['objID'],
+						]
+					)
+				);
+				$tax_total += $non_global_tax['total'];
+			}
+		}
+		return $this->decimal_values->roundDecimalValue($tax_total, true);
+	}
+
+
+	/**
+	 * Gets the total tax on this line item. Assumes taxes have already been calculated using
+	 * recalculate_taxes_and_total
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getTotalTax(EE_Line_Item $line_item): float
+	{
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		$this->recalculateTaxSubTotal($line_item);
+		$total = 0;
+		foreach ($line_item->tax_descendants() as $tax_line_item) {
+			if ($this->validateLineItemAndType($tax_line_item)) {
+				$total += $tax_line_item->total();
+			}
+		}
+		return $this->decimal_values->roundDecimalValue($total, true);
+	}
+
+
+	/**
+	 * Returns the amount taxable among this line item's children (or if it has no children,
+	 * how much of it is taxable). Does not recalculate totals or subtotals.
+	 * If the taxable total is negative, (eg, if none of the tickets were taxable,
+	 * but there is a "Taxable" discount), returns 0.
+	 *
+	 * @param EE_Line_Item|null $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function taxableAmountForGlobalTaxes(?EE_Line_Item $line_item): float
+	{
+		$total      = 0;
+		$child_line_items = $line_item->children($this->default_query_params);
+		foreach ($child_line_items as $child_line_item) {
+			$this->validateLineItemAndType($child_line_item);
+			if ($child_line_item->is_sub_total()) {
+				$total += $this->taxableAmountForGlobalTaxes($child_line_item);
+			} elseif ($child_line_item->is_line_item() && $child_line_item->is_taxable()) {
+				// if it's a percent item, only take into account
+				// the percentage that's taxable (the taxable total so far)
+				if ($child_line_item->is_percent()) {
+					$total += $this->calculatePercentage($total, $child_line_item->percent(), true);
+				} else {
+					// pretax total will be equal to the total for line items with globally applied taxes
+					$pretax_total = $this->calculateTotalForQuantity($child_line_item);
+					$total += $this->updatePreTaxTotal($child_line_item, $pretax_total);
+				}
+			}
+		}
+		return max($total, 0);
+	}
+
+
+	/**
+	 * @param EE_Line_Item|null $line_item
+	 * @param string|null       $type
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
+	{
+		if (! $line_item instanceof EE_Line_Item) {
+			throw new DomainException(
+				esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
+			);
+		}
+		if ($type && $line_item->type() !== $type) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'Invalid Line Item type supplied. Received "%1$s" but expected "%2$s".',
+						'event_espresso'
+					),
+					$line_item->type(),
+					$type
+				)
+			);
+		}
+		return true;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -169,7 +169,7 @@ 
         // for the actual pre-tax sub total line item, we want to save the pretax value for everything
         if ($line_item->is_sub_total() && $line_item->name() === esc_html__('Pre-Tax Subtotal', 'event_espresso')) {
             $this->updateTotal($line_item, $pretax_total, true);
-        } elseif (! $line_item->is_total()) {
+        } elseif ( ! $line_item->is_total()) {
             // we don't update the total for the total line item, because that will need to include taxes
             $total = $this->updateTotal($line_item, $total, true);
         }
@@ -201,7 +201,7 @@ 
         } else {
             // recursively loop through children and recalculate their totals
             $children = $line_item->children($this->default_query_params);
-            if (! empty($children)) {
+            if ( ! empty($children)) {
                 // reset the total and pretax total to zero since we are recalculating them
                 $total = $pretax_total = 0;
                 foreach ($children as $child_line_item) {
@@ -225,7 +225,7 @@ 
                 // echo "{$this->lb}     = li total: {$total} ({$line_item->name()})";
             }
         }
-        $total  = $this->updateTotal($line_item, $total, true);
+        $total = $this->updateTotal($line_item, $total, true);
         $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
 
         // need to also adjust unit price too if the pretax total or quantity has been updated
@@ -522,7 +522,7 @@ 
         $taxable_total = $this->taxableAmountForGlobalTaxes($total_line_item);
         $global_taxes     = $this->applyGlobalTaxes($total_line_item, $taxable_total);
         $non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
-        $all_tax_total        = $this->applyNonGlobalTaxes($total_line_item, $global_taxes, $non_global_taxes);
+        $all_tax_total = $this->applyNonGlobalTaxes($total_line_item, $global_taxes, $non_global_taxes);
         $this->recalculateTaxSubTotal($total_line_item);
         return $all_tax_total;
     }
@@ -615,9 +615,9 @@ 
                         $line_item->pretaxTotal()
                     );
                 } elseif ($line_item->isSubTax()) {
-                    $tax_ID = $line_item->name() . '_' . $line_item->percent();
-                    if (! isset($non_global_taxes[ $tax_ID ])) {
-                        $non_global_taxes[ $tax_ID ] = [
+                    $tax_ID = $line_item->name().'_'.$line_item->percent();
+                    if ( ! isset($non_global_taxes[$tax_ID])) {
+                        $non_global_taxes[$tax_ID] = [
                             'name'  => $line_item->name(),
                             'rate'  => $line_item->percent(),
                             'total' => 0,
@@ -626,7 +626,7 @@ 
                         ];
                     }
                     $tax = $this->calculatePercentage($line_item_total, $line_item->percent());
-                    $non_global_taxes[ $tax_ID ]['total'] += $tax;
+                    $non_global_taxes[$tax_ID]['total'] += $tax;
                 }
             }
         }
@@ -665,7 +665,7 @@ 
                     $tax_total += $non_global_tax['total'];
                 }
             }
-            if (! $found) {
+            if ( ! $found) {
                 // add a new line item for this non global tax
                 $taxes_subtotal->add_child_line_item(
                     EE_Line_Item::new_instance(
@@ -723,7 +723,7 @@ 
      */
     public function taxableAmountForGlobalTaxes(?EE_Line_Item $line_item): float
     {
-        $total      = 0;
+        $total = 0;
         $child_line_items = $line_item->children($this->default_query_params);
         foreach ($child_line_items as $child_line_item) {
             $this->validateLineItemAndType($child_line_item);
@@ -754,7 +754,7 @@ 
      */
     private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
     {
-        if (! $line_item instanceof EE_Line_Item) {
+        if ( ! $line_item instanceof EE_Line_Item) {
             throw new DomainException(
                 esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
             );

core/libraries/line_item_display/EE_Default_Line_Item_Display_Strategy.strategy.php

Indentation +241 added lines, -241 removed lines

@@ -1,248 +1,248 @@
 <?php
 
  /**
- *
- * Class EE_Default_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Default_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 
 class EE_Default_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
-    /**
-     * @var bool
-     */
-    protected $prices_include_taxes = false;
-
-    /**
-     * total amount of tax to apply
-     * @type float $_tax_rate
-     */
-    private $_tax_rate = 0;
-
-    /**
-     * total amount including tax we can bill for at this time
-     * @type float $_grand_total
-     */
-    private $_grand_total = 0.00;
-
-    /**
-     * total number of items being billed for
-     * @type int $_total_items
-     */
-    private $_total_items = 0;
-
-
-    public function __construct()
-    {
-        $this->prices_include_taxes = EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes;
-    }
-
-
-    /**
-     * @return float
-     */
-    public function grand_total()
-    {
-        return $this->_grand_total;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function total_items()
-    {
-        return $this->_total_items;
-    }
-
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
-
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,  //    TRUE        FALSE
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_line_item:
-                // item row
-                $html .= $this->_item_row($line_item, $options);
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
-                    $this->display_line_item($child_line_item, $options);
-                }
-                break;
-
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options);
-                break;
-
-            case EEM_Line_Item::type_sub_total:
-                break;
-
-            case EEM_Line_Item::type_tax:
-                $this->_tax_rate += $line_item->percent();
-                break;
-
-            case EEM_Line_Item::type_tax_sub_total:
-                foreach ($line_item->children() as $child_line_item) {
-                    if ($child_line_item->type() == EEM_Line_Item::type_tax) {
-                        // recursively feed children back into this method
-                        $this->display_line_item($child_line_item, $options);
-                    }
-                }
-                break;
-
-            case EEM_Line_Item::type_total:
-                // get all child line items
-                $children = $line_item->children();
-                if ($options['set_tax_rate'] === true) {
-                    // loop thru tax child line items just to determine tax rate
-                    foreach ($children as $child_line_item) {
-                        if ($child_line_item->type() == EEM_Line_Item::type_tax_sub_total) {
-                            // recursively feed children back into this method
-                            $this->display_line_item($child_line_item, $options);
-                        }
-                    }
-                } else {
-                    // now loop thru all non-tax child line items
-                    foreach ($children as $child_line_item) {
-                        if ($child_line_item->type() != EEM_Line_Item::type_tax_sub_total) {
-                            // recursively feed children back into this method
-                            $html .= $this->display_line_item($child_line_item, $options);
-                        }
-                    }
-                }
-                break;
-        }
-
-        return $html;
-    }
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _item_row(EE_Line_Item $line_item, array $options = array()): string
-    {
-        $sub_taxes = $line_item->getSubTaxes();
-        $has_sub_taxes = ! empty($sub_taxes);
-        $is_taxable = $line_item->is_taxable();
-
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-        // name && desc
-        $name_and_desc = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__name',
-            $line_item->name(),
-            $line_item
-        );
-        $name_and_desc .= apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__desc',
-            ( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
-            $line_item,
-            $options
-        );
-        if ($is_taxable || $has_sub_taxes) {
-            $includes_taxes = $this->prices_include_taxes
-                ? esc_html__('* price includes taxes', 'event_espresso')
-                : esc_html__('* price does not include taxes', 'event_espresso');
-            $name_and_desc .= '<br /><span class="smaller-text grey-text">' . $includes_taxes . '</span>';
-        }
-
-        // name td
-        $html .= EEH_HTML::td($name_and_desc, '', 'item_l');
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
-        $tax_rate = 1;
-        if ($this->prices_include_taxes) {
-            if ($has_sub_taxes) {
-                $tax_rate = 0;
-                foreach ($sub_taxes as $sub_tax) {
-                    if ($sub_tax instanceof EE_Line_Item && $sub_tax->isSubTax()) {
-                        $tax_rate += $sub_tax->percent();
-                    }
-                }
-                $tax_rate = 1 + $tax_rate / 100;
-            } elseif ($is_taxable && $this->prices_include_taxes) {
-                $tax_rate = 1 + ($this->_tax_rate / 100);
-            }
-        }
-
-        // price td
-        $unit_price = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__unit_price',
-            EEH_Template::format_currency($line_item->unit_price() * $tax_rate, false, false),
-            $line_item,
-            $tax_rate
-        );
-        $html .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
-        // total td
-        $total = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__total',
-            EEH_Template::format_currency($line_item->unit_price() * $line_item->quantity() * $tax_rate, false, false),
-            $line_item,
-            $tax_rate
-        );
-        $html .= EEH_HTML::td($total, '', 'item_r jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-
-        return $html;
-    }
-
-
-
-    /**
-     *  _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _sub_item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item-row');
-        // name && desc
-        $name_and_desc = $line_item->name();
-        $name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '';
-        // name td
-        $html .= EEH_HTML::td(/*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item');
-        // discount/surcharge td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
-        }
-        // total td
-        $html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'item_r jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
+	/**
+	 * @var bool
+	 */
+	protected $prices_include_taxes = false;
+
+	/**
+	 * total amount of tax to apply
+	 * @type float $_tax_rate
+	 */
+	private $_tax_rate = 0;
+
+	/**
+	 * total amount including tax we can bill for at this time
+	 * @type float $_grand_total
+	 */
+	private $_grand_total = 0.00;
+
+	/**
+	 * total number of items being billed for
+	 * @type int $_total_items
+	 */
+	private $_total_items = 0;
+
+
+	public function __construct()
+	{
+		$this->prices_include_taxes = EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes;
+	}
+
+
+	/**
+	 * @return float
+	 */
+	public function grand_total()
+	{
+		return $this->_grand_total;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function total_items()
+	{
+		return $this->_total_items;
+	}
+
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
+
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,  //    TRUE        FALSE
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_line_item:
+				// item row
+				$html .= $this->_item_row($line_item, $options);
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
+					$this->display_line_item($child_line_item, $options);
+				}
+				break;
+
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options);
+				break;
+
+			case EEM_Line_Item::type_sub_total:
+				break;
+
+			case EEM_Line_Item::type_tax:
+				$this->_tax_rate += $line_item->percent();
+				break;
+
+			case EEM_Line_Item::type_tax_sub_total:
+				foreach ($line_item->children() as $child_line_item) {
+					if ($child_line_item->type() == EEM_Line_Item::type_tax) {
+						// recursively feed children back into this method
+						$this->display_line_item($child_line_item, $options);
+					}
+				}
+				break;
+
+			case EEM_Line_Item::type_total:
+				// get all child line items
+				$children = $line_item->children();
+				if ($options['set_tax_rate'] === true) {
+					// loop thru tax child line items just to determine tax rate
+					foreach ($children as $child_line_item) {
+						if ($child_line_item->type() == EEM_Line_Item::type_tax_sub_total) {
+							// recursively feed children back into this method
+							$this->display_line_item($child_line_item, $options);
+						}
+					}
+				} else {
+					// now loop thru all non-tax child line items
+					foreach ($children as $child_line_item) {
+						if ($child_line_item->type() != EEM_Line_Item::type_tax_sub_total) {
+							// recursively feed children back into this method
+							$html .= $this->display_line_item($child_line_item, $options);
+						}
+					}
+				}
+				break;
+		}
+
+		return $html;
+	}
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _item_row(EE_Line_Item $line_item, array $options = array()): string
+	{
+		$sub_taxes = $line_item->getSubTaxes();
+		$has_sub_taxes = ! empty($sub_taxes);
+		$is_taxable = $line_item->is_taxable();
+
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+		// name && desc
+		$name_and_desc = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__name',
+			$line_item->name(),
+			$line_item
+		);
+		$name_and_desc .= apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__desc',
+			( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
+			$line_item,
+			$options
+		);
+		if ($is_taxable || $has_sub_taxes) {
+			$includes_taxes = $this->prices_include_taxes
+				? esc_html__('* price includes taxes', 'event_espresso')
+				: esc_html__('* price does not include taxes', 'event_espresso');
+			$name_and_desc .= '<br /><span class="smaller-text grey-text">' . $includes_taxes . '</span>';
+		}
+
+		// name td
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l');
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+		$tax_rate = 1;
+		if ($this->prices_include_taxes) {
+			if ($has_sub_taxes) {
+				$tax_rate = 0;
+				foreach ($sub_taxes as $sub_tax) {
+					if ($sub_tax instanceof EE_Line_Item && $sub_tax->isSubTax()) {
+						$tax_rate += $sub_tax->percent();
+					}
+				}
+				$tax_rate = 1 + $tax_rate / 100;
+			} elseif ($is_taxable && $this->prices_include_taxes) {
+				$tax_rate = 1 + ($this->_tax_rate / 100);
+			}
+		}
+
+		// price td
+		$unit_price = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__unit_price',
+			EEH_Template::format_currency($line_item->unit_price() * $tax_rate, false, false),
+			$line_item,
+			$tax_rate
+		);
+		$html .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
+		// total td
+		$total = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__total',
+			EEH_Template::format_currency($line_item->unit_price() * $line_item->quantity() * $tax_rate, false, false),
+			$line_item,
+			$tax_rate
+		);
+		$html .= EEH_HTML::td($total, '', 'item_r jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+
+		return $html;
+	}
+
+
+
+	/**
+	 *  _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item-row');
+		// name && desc
+		$name_and_desc = $line_item->name();
+		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '';
+		// name td
+		$html .= EEH_HTML::td(/*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item');
+		// discount/surcharge td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
+		}
+		// total td
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'item_r jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
 }

core/helpers/EEH_Debug_Tools.helper.php

Indentation +705 added lines, -705 removed lines

@@ -13,699 +13,699 @@ 
 class EEH_Debug_Tools
 {
 
-    /**
-     *    instance of the EEH_Autoloader object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var array
-     */
-    protected $_memory_usage_points = array();
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EEH_Debug_Tools
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private class constructor
-     */
-    private function __construct()
-    {
-        // load Kint PHP debugging library
-        if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')) {
-            // despite EE4 having a check for an existing copy of the Kint debugging class,
-            // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
-            // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
-            // so we've moved it to our test folder so that it is not included with production releases
-            // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
-        }
-        // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
-        // add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
-        // }
-        $plugin = basename(EE_PLUGIN_DIR_PATH);
-        add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
-    }
-
-
-
-    /**
-     *    show_db_name
-     *
-     * @return void
-     */
-    public static function show_db_name()
-    {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
-            echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
-                 . DB_NAME
-                 . '</p>';
-        }
-        if (EE_DEBUG) {
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    dump EE_Session object at bottom of page after everything else has happened
-     *
-     * @return void
-     */
-    public function espresso_session_footer_dump()
-    {
-        if (
-            (defined('WP_DEBUG') && WP_DEBUG)
-            && ! defined('DOING_AJAX')
-            && class_exists('Kint')
-            && function_exists('wp_get_current_user')
-            && current_user_can('update_core')
-            && class_exists('EE_Registry')
-        ) {
-            Kint::dump(EE_Registry::instance()->SSN->id());
-            Kint::dump(EE_Registry::instance()->SSN);
-            //          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
-            $this->espresso_list_hooked_functions();
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    List All Hooked Functions
-     *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
-     *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
-     *
-     * @param string $tag
-     * @return void
-     */
-    public function espresso_list_hooked_functions($tag = '')
-    {
-        global $wp_filter;
-        echo '<br/><br/><br/><h3>Hooked Functions</h3>';
-        if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
-                trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
-                return;
-            }
-            echo '<h5>For Tag: ' . $tag . '</h5>';
-        } else {
-            $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
-            ksort($hook);
-        }
-        foreach ($hook as $tag_name => $priorities) {
-            echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag_name</strong><br />";
-            ksort($priorities);
-            foreach ($priorities as $priority => $function) {
-                echo $priority;
-                foreach ($function as $name => $properties) {
-                    echo "\t$name<br />";
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    registered_filter_callbacks
-     *
-     * @param string $hook_name
-     * @return array
-     */
-    public static function registered_filter_callbacks($hook_name = '')
-    {
-        $filters = array();
-        global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
-                foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
-                }
-            }
-        }
-        return $filters;
-    }
-
-
-
-    /**
-     *    captures plugin activation errors for debugging
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ee_plugin_activation_errors()
-    {
-        if (WP_DEBUG) {
-            $activation_errors = ob_get_contents();
-            if (empty($activation_errors)) {
-                return;
-            }
-            $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
-            if (class_exists('EEH_File')) {
-                try {
-                    EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
-                    );
-                    EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
-                        $activation_errors
-                    );
-                } catch (EE_Error $e) {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'The Event Espresso activation errors file could not be setup because: %s',
-                                'event_espresso'
-                            ),
-                            $e->getMessage()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // old school attempt
-                file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
-                    $activation_errors
-                );
-            }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
-            update_option('ee_plugin_activation_errors', $activation_errors);
-        }
-    }
-
-
-
-    /**
-     * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
-     * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
-     * or we want to make sure they use something the right way.
-     *
-     * @access public
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     * @uses   trigger_error()
-     */
-    public function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        $applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
-        $error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
-        // because we swapped the parameter order around for the last two params,
-        // let's verify that some third party isn't still passing an error type value for the third param
-        if (is_int($applies_when)) {
-            $error_type = $applies_when;
-            $applies_when = espresso_version();
-        }
-        // if not displaying notices yet, then just leave
-        if (version_compare(espresso_version(), $applies_when, '<')) {
-            return;
-        }
-        do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
-        $version = $version === null
-            ? ''
-            : sprintf(
-                __('(This message was added in version %s of Event Espresso)', 'event_espresso'),
-                $version
-            );
-        $error_message = sprintf(
-            esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
-            $function,
-            '<strong>',
-            '</strong>',
-            $message,
-            $version
-        );
-        // don't trigger error if doing ajax,
-        // instead we'll add a transient EE_Error notice that in theory should show on the next request.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
-                'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
-                'event_espresso'
-            );
-            $error_message .= '<ul><li>';
-            $error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params());
-            $error_message .= '</ul>';
-            EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
-            // now we set this on the transient so it shows up on the next request.
-            EE_Error::get_notices(false, true);
-        } else {
-            trigger_error($error_message, $error_type);
-        }
-    }
-
-
-
-
-    /**
-     * Logger helpers
-     */
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @param string $debug_index
-     * @param string $debug_key
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        $info = array(),
-        $display_request = false,
-        $debug_index = '',
-        $debug_key = 'EE_DEBUG_SPCO'
-    ) {
-        if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
-            $debug_data = get_option($debug_key, array());
-            $default_data = array(
-                $class => $func . '() : ' . $line,
-                'REQ'  => $display_request ? $_REQUEST : '',
-            );
-            // don't serialize objects
-            $info = self::strip_objects($info);
-            $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
-            }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
-            update_option($debug_key, $debug_data);
-        }
-    }
-
-
-
-    /**
-     * strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public static function strip_objects($info = array())
-    {
-        foreach ($info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
-                if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
-                }
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     * @param string     $margin
-     */
-    public static function printv(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false,
-        $margin = ''
-    ) {
-        $var_name = ! $var_name ? 'string' : $var_name;
-        $var_name = ucwords(str_replace('$', '', $var_name));
-        $is_method = method_exists($var_name, $var);
-        $var_name = ucwords(str_replace('_', ' ', $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        // $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo $result;
-    }
-
-
-    protected static function headingTag($heading_tag)
-    {
-        $heading_tag = absint($heading_tag);
-        return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
-    }
-
-
-    protected static function headingSpacer($heading_tag)
-    {
-        return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
-            ? "\n"
-            : '';
-    }
-
-
-    protected static function plainOutput()
-    {
-        return defined('EE_TESTS_DIR')
-               || (defined('DOING_AJAX') && DOING_AJAX && ! isset($_REQUEST['pretty_output']))
-               || (
-                   isset($_SERVER['REQUEST_URI'])
-                   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
-               );
-    }
-
-
-    /**
-     * @param string $var_name
-     * @param string $heading_tag
-     * @param string $margin
-     * @param int    $line
-     * @return string
-     */
-    protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            switch ($heading_tag) {
-                case 'h1':
-                    $line_breaks = EEH_Debug_Tools::lineBreak(3);
-                    break;
-                case 'h2':
-                    $line_breaks = EEH_Debug_Tools::lineBreak(2);
-                    break;
-                default:
-                    $line_breaks = EEH_Debug_Tools::lineBreak();
-                    break;
-            }
-            return "{$line_breaks}{$line}) {$var_name}";
-        }
-        $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
-    }
-
-
-
-    /**
-     * @param string $heading_tag
-     * @return string
-     */
-    protected static function headingX($heading_tag = 'h5')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return '';
-        }
-        return '</' . $heading_tag . '>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function grey_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#999">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param string $file
-     * @param int    $line
-     * @return string
-     */
-    protected static function file_and_line($file, $line, $heading_tag)
-    {
-        if ($file === '' || $line === '') {
-            return '';
-        }
-        $file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
-        if (EEH_Debug_Tools::plainOutput()) {
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                return " ({$file})" . EEH_Debug_Tools::lineBreak();
-            }
-            return '';
-        }
-        return EEH_Debug_Tools::lineBreak()
-               . '<span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
-               . $file
-               . EEH_Debug_Tools::lineBreak()
-               . 'line no: '
-               . $line
-               . '</span>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function orange_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#E76700">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param mixed $var
-     * @return string
-     */
-    protected static function pre_span($var)
-    {
-        ob_start();
-        var_dump($var);
-        $var = ob_get_clean();
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $var;
-        }
-        return '<pre style="color: #9C3; display: inline-block; padding:.4em .6em; background: #334">' . $var . '</pre>';
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     */
-    public static function printr(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false
-    ) {
-        // return;
-        $file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
-        if (empty($var) && empty($var_name)) {
-            $var = $file;
-            $var_name = "line $line";
-            $file = '';
-            $line = '';
-        }
-        $margin = is_admin() ? ' 180px' : '0';
-        // $print_r = false;
-        if (is_string($var)) {
-            EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
-            return;
-        }
-        if (is_object($var)) {
-            $var_name = ! $var_name ? 'object' : $var_name;
-            // $print_r = true;
-        } elseif (is_array($var)) {
-            $var_name = ! $var_name ? 'array' : $var_name;
-            // $print_r = true;
-        } elseif (is_numeric($var)) {
-            $var_name = ! $var_name ? 'numeric' : $var_name;
-        } elseif ($var === null) {
-            $var_name = ! $var_name ? 'null' : $var_name;
-        }
-        $var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        // $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
-            EEH_Debug_Tools::pre_span($var)
-        );
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo $result;
-    }
-
-
-    private static function lineBreak($lines = 1): string
-    {
-        $linebreak = defined('DOING_AJAX') && DOING_AJAX ? '<br />' : PHP_EOL;
-        return str_repeat($linebreak, $lines);
-    }
-
-
-    public static function shortClassName(string $fqcn): string
-    {
-        return substr(strrchr($fqcn, '\\'), 1);
-    }
-
-
-
-    /******************** deprecated ********************/
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     */
-    public function reset_times()
-    {
-        Benchmark::resetTimes();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param null $timer_name
-     */
-    public function start_timer($timer_name = null)
-    {
-        Benchmark::startTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     */
-    public function stop_timer($timer_name = '')
-    {
-        Benchmark::stopTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @return void
-     */
-    public function measure_memory($label, $output_now = false)
-    {
-        Benchmark::measureMemory($label, $output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param int $size
-     * @return string
-     */
-    public function convert($size)
-    {
-        return Benchmark::convert($size);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param bool $output_now
-     * @return string
-     */
-    public function show_times($output_now = true)
-    {
-        return Benchmark::displayResults($output_now);
-    }
+	/**
+	 *    instance of the EEH_Autoloader object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array
+	 */
+	protected $_memory_usage_points = array();
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EEH_Debug_Tools
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_Debug_Tools) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private class constructor
+	 */
+	private function __construct()
+	{
+		// load Kint PHP debugging library
+		if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')) {
+			// despite EE4 having a check for an existing copy of the Kint debugging class,
+			// if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
+			// then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
+			// so we've moved it to our test folder so that it is not included with production releases
+			// plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
+			require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
+		}
+		// if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
+		// add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
+		// }
+		$plugin = basename(EE_PLUGIN_DIR_PATH);
+		add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
+	}
+
+
+
+	/**
+	 *    show_db_name
+	 *
+	 * @return void
+	 */
+	public static function show_db_name()
+	{
+		if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
+				 . DB_NAME
+				 . '</p>';
+		}
+		if (EE_DEBUG) {
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    dump EE_Session object at bottom of page after everything else has happened
+	 *
+	 * @return void
+	 */
+	public function espresso_session_footer_dump()
+	{
+		if (
+			(defined('WP_DEBUG') && WP_DEBUG)
+			&& ! defined('DOING_AJAX')
+			&& class_exists('Kint')
+			&& function_exists('wp_get_current_user')
+			&& current_user_can('update_core')
+			&& class_exists('EE_Registry')
+		) {
+			Kint::dump(EE_Registry::instance()->SSN->id());
+			Kint::dump(EE_Registry::instance()->SSN);
+			//          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
+			$this->espresso_list_hooked_functions();
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    List All Hooked Functions
+	 *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
+	 *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
+	 *
+	 * @param string $tag
+	 * @return void
+	 */
+	public function espresso_list_hooked_functions($tag = '')
+	{
+		global $wp_filter;
+		echo '<br/><br/><br/><h3>Hooked Functions</h3>';
+		if ($tag) {
+			$hook[ $tag ] = $wp_filter[ $tag ];
+			if (! is_array($hook[ $tag ])) {
+				trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
+				return;
+			}
+			echo '<h5>For Tag: ' . $tag . '</h5>';
+		} else {
+			$hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
+			ksort($hook);
+		}
+		foreach ($hook as $tag_name => $priorities) {
+			echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag_name</strong><br />";
+			ksort($priorities);
+			foreach ($priorities as $priority => $function) {
+				echo $priority;
+				foreach ($function as $name => $properties) {
+					echo "\t$name<br />";
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    registered_filter_callbacks
+	 *
+	 * @param string $hook_name
+	 * @return array
+	 */
+	public static function registered_filter_callbacks($hook_name = '')
+	{
+		$filters = array();
+		global $wp_filter;
+		if (isset($wp_filter[ $hook_name ])) {
+			$filters[ $hook_name ] = array();
+			foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
+				$filters[ $hook_name ][ $priority ] = array();
+				foreach ($callbacks as $callback) {
+					$filters[ $hook_name ][ $priority ][] = $callback['function'];
+				}
+			}
+		}
+		return $filters;
+	}
+
+
+
+	/**
+	 *    captures plugin activation errors for debugging
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ee_plugin_activation_errors()
+	{
+		if (WP_DEBUG) {
+			$activation_errors = ob_get_contents();
+			if (empty($activation_errors)) {
+				return;
+			}
+			$activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+			espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+			if (class_exists('EEH_File')) {
+				try {
+					EEH_File::ensure_file_exists_and_is_writable(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
+					);
+					EEH_File::write_to_file(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+						$activation_errors
+					);
+				} catch (EE_Error $e) {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'The Event Espresso activation errors file could not be setup because: %s',
+								'event_espresso'
+							),
+							$e->getMessage()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// old school attempt
+				file_put_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+					$activation_errors
+				);
+			}
+			$activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+			update_option('ee_plugin_activation_errors', $activation_errors);
+		}
+	}
+
+
+
+	/**
+	 * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
+	 * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
+	 * or we want to make sure they use something the right way.
+	 *
+	 * @access public
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 * @uses   trigger_error()
+	 */
+	public function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		$applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
+		$error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
+		// because we swapped the parameter order around for the last two params,
+		// let's verify that some third party isn't still passing an error type value for the third param
+		if (is_int($applies_when)) {
+			$error_type = $applies_when;
+			$applies_when = espresso_version();
+		}
+		// if not displaying notices yet, then just leave
+		if (version_compare(espresso_version(), $applies_when, '<')) {
+			return;
+		}
+		do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
+		$version = $version === null
+			? ''
+			: sprintf(
+				__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
+				$version
+			);
+		$error_message = sprintf(
+			esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
+			$function,
+			'<strong>',
+			'</strong>',
+			$message,
+			$version
+		);
+		// don't trigger error if doing ajax,
+		// instead we'll add a transient EE_Error notice that in theory should show on the next request.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$error_message .= ' ' . esc_html__(
+				'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
+				'event_espresso'
+			);
+			$error_message .= '<ul><li>';
+			$error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params());
+			$error_message .= '</ul>';
+			EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
+			// now we set this on the transient so it shows up on the next request.
+			EE_Error::get_notices(false, true);
+		} else {
+			trigger_error($error_message, $error_type);
+		}
+	}
+
+
+
+
+	/**
+	 * Logger helpers
+	 */
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @param string $debug_index
+	 * @param string $debug_key
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		$info = array(),
+		$display_request = false,
+		$debug_index = '',
+		$debug_key = 'EE_DEBUG_SPCO'
+	) {
+		if (WP_DEBUG) {
+			$debug_key = $debug_key . '_' . EE_Session::instance()->id();
+			$debug_data = get_option($debug_key, array());
+			$default_data = array(
+				$class => $func . '() : ' . $line,
+				'REQ'  => $display_request ? $_REQUEST : '',
+			);
+			// don't serialize objects
+			$info = self::strip_objects($info);
+			$index = ! empty($debug_index) ? $debug_index : 0;
+			if (! isset($debug_data[ $index ])) {
+				$debug_data[ $index ] = array();
+			}
+			$debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+			update_option($debug_key, $debug_data);
+		}
+	}
+
+
+
+	/**
+	 * strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public static function strip_objects($info = array())
+	{
+		foreach ($info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = self::strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+				if (method_exists($value, 'ID')) {
+					$info[ $object_class ]['ID'] = $value->ID();
+				}
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 * @param string     $margin
+	 */
+	public static function printv(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false,
+		$margin = ''
+	) {
+		$var_name = ! $var_name ? 'string' : $var_name;
+		$var_name = ucwords(str_replace('$', '', $var_name));
+		$is_method = method_exists($var_name, $var);
+		$var_name = ucwords(str_replace('_', ' ', $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		// $result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= $is_method
+			? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
+			: EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo $result;
+	}
+
+
+	protected static function headingTag($heading_tag)
+	{
+		$heading_tag = absint($heading_tag);
+		return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
+	}
+
+
+	protected static function headingSpacer($heading_tag)
+	{
+		return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
+			? "\n"
+			: '';
+	}
+
+
+	protected static function plainOutput()
+	{
+		return defined('EE_TESTS_DIR')
+			   || (defined('DOING_AJAX') && DOING_AJAX && ! isset($_REQUEST['pretty_output']))
+			   || (
+				   isset($_SERVER['REQUEST_URI'])
+				   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
+			   );
+	}
+
+
+	/**
+	 * @param string $var_name
+	 * @param string $heading_tag
+	 * @param string $margin
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			switch ($heading_tag) {
+				case 'h1':
+					$line_breaks = EEH_Debug_Tools::lineBreak(3);
+					break;
+				case 'h2':
+					$line_breaks = EEH_Debug_Tools::lineBreak(2);
+					break;
+				default:
+					$line_breaks = EEH_Debug_Tools::lineBreak();
+					break;
+			}
+			return "{$line_breaks}{$line}) {$var_name}";
+		}
+		$margin = "25px 0 0 {$margin}";
+		return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+	}
+
+
+
+	/**
+	 * @param string $heading_tag
+	 * @return string
+	 */
+	protected static function headingX($heading_tag = 'h5')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return '';
+		}
+		return '</' . $heading_tag . '>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function grey_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#999">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $file
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function file_and_line($file, $line, $heading_tag)
+	{
+		if ($file === '' || $line === '') {
+			return '';
+		}
+		$file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
+		if (EEH_Debug_Tools::plainOutput()) {
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				return " ({$file})" . EEH_Debug_Tools::lineBreak();
+			}
+			return '';
+		}
+		return EEH_Debug_Tools::lineBreak()
+			   . '<span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
+			   . $file
+			   . EEH_Debug_Tools::lineBreak()
+			   . 'line no: '
+			   . $line
+			   . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function orange_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#E76700">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param mixed $var
+	 * @return string
+	 */
+	protected static function pre_span($var)
+	{
+		ob_start();
+		var_dump($var);
+		$var = ob_get_clean();
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $var;
+		}
+		return '<pre style="color: #9C3; display: inline-block; padding:.4em .6em; background: #334">' . $var . '</pre>';
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 */
+	public static function printr(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false
+	) {
+		// return;
+		$file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
+		if (empty($var) && empty($var_name)) {
+			$var = $file;
+			$var_name = "line $line";
+			$file = '';
+			$line = '';
+		}
+		$margin = is_admin() ? ' 180px' : '0';
+		// $print_r = false;
+		if (is_string($var)) {
+			EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
+			return;
+		}
+		if (is_object($var)) {
+			$var_name = ! $var_name ? 'object' : $var_name;
+			// $print_r = true;
+		} elseif (is_array($var)) {
+			$var_name = ! $var_name ? 'array' : $var_name;
+			// $print_r = true;
+		} elseif (is_numeric($var)) {
+			$var_name = ! $var_name ? 'numeric' : $var_name;
+		} elseif ($var === null) {
+			$var_name = ! $var_name ? 'null' : $var_name;
+		}
+		$var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		// $result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+			EEH_Debug_Tools::pre_span($var)
+		);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo $result;
+	}
+
+
+	private static function lineBreak($lines = 1): string
+	{
+		$linebreak = defined('DOING_AJAX') && DOING_AJAX ? '<br />' : PHP_EOL;
+		return str_repeat($linebreak, $lines);
+	}
+
+
+	public static function shortClassName(string $fqcn): string
+	{
+		return substr(strrchr($fqcn, '\\'), 1);
+	}
+
+
+
+	/******************** deprecated ********************/
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 */
+	public function reset_times()
+	{
+		Benchmark::resetTimes();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param null $timer_name
+	 */
+	public function start_timer($timer_name = null)
+	{
+		Benchmark::startTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 */
+	public function stop_timer($timer_name = '')
+	{
+		Benchmark::stopTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @return void
+	 */
+	public function measure_memory($label, $output_now = false)
+	{
+		Benchmark::measureMemory($label, $output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param int $size
+	 * @return string
+	 */
+	public function convert($size)
+	{
+		return Benchmark::convert($size);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param bool $output_now
+	 * @return string
+	 */
+	public function show_times($output_now = true)
+	{
+		return Benchmark::displayResults($output_now);
+	}
 
 
 
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     * @param float  $total_time
-     * @return string
-     */
-    public function format_time($timer_name, $total_time)
-    {
-        return Benchmark::formatTime($timer_name, $total_time);
-    }
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @return string
+	 */
+	public function format_time($timer_name, $total_time)
+	{
+		return Benchmark::formatTime($timer_name, $total_time);
+	}
 }
 
 
@@ -715,31 +715,31 @@ 
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp_query')) {
-    function dump_wp_query()
-    {
-        global $wp_query;
-        d($wp_query);
-    }
+	function dump_wp_query()
+	{
+		global $wp_query;
+		d($wp_query);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp')) {
-    function dump_wp()
-    {
-        global $wp;
-        d($wp);
-    }
+	function dump_wp()
+	{
+		global $wp;
+		d($wp);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_post')) {
-    function dump_post()
-    {
-        global $post;
-        d($post);
-    }
+	function dump_post()
+	{
+		global $post;
+		d($post);
+	}
 }

Spacing +40 added lines, -40 removed lines

@@ -36,7 +36,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
+        if ( ! self::$_instance instanceof EEH_Debug_Tools) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -50,13 +50,13 @@ 
     private function __construct()
     {
         // load Kint PHP debugging library
-        if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')) {
+        if ( ! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH.'tests/kint/Kint.class.php')) {
             // despite EE4 having a check for an existing copy of the Kint debugging class,
             // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
             // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
             // so we've moved it to our test folder so that it is not included with production releases
             // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
+            require_once(EE_PLUGIN_DIR_PATH.'tests/kint/Kint.class.php');
         }
         // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
         // add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
@@ -76,7 +76,7 @@ 
      */
     public static function show_db_name()
     {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+        if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
             echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
                  . DB_NAME
                  . '</p>';
@@ -126,12 +126,12 @@ 
         global $wp_filter;
         echo '<br/><br/><br/><h3>Hooked Functions</h3>';
         if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
+            $hook[$tag] = $wp_filter[$tag];
+            if ( ! is_array($hook[$tag])) {
                 trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
                 return;
             }
-            echo '<h5>For Tag: ' . $tag . '</h5>';
+            echo '<h5>For Tag: '.$tag.'</h5>';
         } else {
             $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
             ksort($hook);
@@ -160,12 +160,12 @@ 
     {
         $filters = array();
         global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
+        if (isset($wp_filter[$hook_name])) {
+            $filters[$hook_name] = array();
+            foreach ($wp_filter[$hook_name] as $priority => $callbacks) {
+                $filters[$hook_name][$priority] = array();
                 foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
+                    $filters[$hook_name][$priority][] = $callback['function'];
                 }
             }
         }
@@ -187,15 +187,15 @@ 
             if (empty($activation_errors)) {
                 return;
             }
-            $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+            $activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors;
+            espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php');
             if (class_exists('EEH_File')) {
                 try {
                     EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html'
                     );
                     EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html',
                         $activation_errors
                     );
                 } catch (EE_Error $e) {
@@ -215,11 +215,11 @@ 
             } else {
                 // old school attempt
                 file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+                    EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html',
                     $activation_errors
                 );
             }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+            $activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors;
             update_option('ee_plugin_activation_errors', $activation_errors);
         }
     }
@@ -279,7 +279,7 @@ 
         // don't trigger error if doing ajax,
         // instead we'll add a transient EE_Error notice that in theory should show on the next request.
         if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
+            $error_message .= ' '.esc_html__(
                 'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
                 'event_espresso'
             );
@@ -323,19 +323,19 @@ 
         $debug_key = 'EE_DEBUG_SPCO'
     ) {
         if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
+            $debug_key = $debug_key.'_'.EE_Session::instance()->id();
             $debug_data = get_option($debug_key, array());
             $default_data = array(
-                $class => $func . '() : ' . $line,
+                $class => $func.'() : '.$line,
                 'REQ'  => $display_request ? $_REQUEST : '',
             );
             // don't serialize objects
             $info = self::strip_objects($info);
             $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
+            if ( ! isset($debug_data[$index])) {
+                $debug_data[$index] = array();
             }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+            $debug_data[$index][microtime()] = array_merge($default_data, $info);
             update_option($debug_key, $debug_data);
         }
     }
@@ -352,20 +352,20 @@ 
     {
         foreach ($info as $key => $value) {
             if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
+                $info[$key] = self::strip_objects($value);
             } elseif (is_object($value)) {
                 $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+                $info[$object_class] = array();
+                $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
                 if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
+                    $info[$object_class]['ID'] = $value->ID();
                 }
                 if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
+                    $info[$object_class]['status'] = $value->status();
                 } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
+                    $info[$object_class]['status'] = $value->status_ID();
                 }
-                unset($info[ $key ]);
+                unset($info[$key]);
             }
         }
         return (array) $info;
@@ -399,8 +399,8 @@ 
         // $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
         $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+            ? EEH_Debug_Tools::grey_span('::').EEH_Debug_Tools::orange_span($var.'()')
+            : EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span($var);
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
         $result .= EEH_Debug_Tools::headingX($heading_tag);
         if ($die) {
@@ -460,7 +460,7 @@ 
             return "{$line_breaks}{$line}) {$var_name}";
         }
         $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+        return '<'.$heading_tag.' style="color:#2EA2CC; margin:'.$margin.';"><b>'.$var_name.'</b>';
     }
 
 
@@ -474,7 +474,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return '';
         }
-        return '</' . $heading_tag . '>';
+        return '</'.$heading_tag.'>';
     }
 
 
@@ -488,7 +488,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#999">' . $content . '</span>';
+        return '<span style="color:#999">'.$content.'</span>';
     }
 
 
@@ -506,7 +506,7 @@ 
         $file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
         if (EEH_Debug_Tools::plainOutput()) {
             if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                return " ({$file})" . EEH_Debug_Tools::lineBreak();
+                return " ({$file})".EEH_Debug_Tools::lineBreak();
             }
             return '';
         }
@@ -530,7 +530,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#E76700">' . $content . '</span>';
+        return '<span style="color:#E76700">'.$content.'</span>';
     }
 
 
@@ -547,7 +547,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $var;
         }
-        return '<pre style="color: #9C3; display: inline-block; padding:.4em .6em; background: #334">' . $var . '</pre>';
+        return '<pre style="color: #9C3; display: inline-block; padding:.4em .6em; background: #334">'.$var.'</pre>';
     }
 
 
@@ -597,7 +597,7 @@ 
         $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
         // $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+        $result .= EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span(
             EEH_Debug_Tools::pre_span($var)
         );
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);

core/db_classes/EE_Line_Item.class.php

Indentation +1610 added lines, -1610 removed lines

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

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +687 added lines, -687 removed lines

@@ -13,695 +13,695 @@
 
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
 if (! function_exists('mb_strcut')) {
-    /**
-     * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
-     * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
-     * @param $string
-     * @param $start
-     * @param $length
-     * @return bool|string
-     */
-    function mb_strcut($string, $start, $length = null)
-    {
-        return mb_substr($string, $start, $length);
-    }
+	/**
+	 * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
+	 * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
+	 * @param $string
+	 * @param $start
+	 * @param $length
+	 * @return bool|string
+	 */
+	function mb_strcut($string, $start, $length = null)
+	{
+		return mb_substr($string, $start, $length);
+	}
 }
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
 
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url;
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-    /**
-     * number of decimal places to round numbers to when performing calculations
-     *
-     * @var integer
-     */
-    protected $decimal_precision = 6;
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-            'INR',
-        );
-        parent::__construct();
-        $this->decimal_precision = EE_Registry::instance()->CFG->currency->dec_plc;
-    }
-
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $payment instanceof EEI_Payment) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error. No associated payment was found.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
-        $primary_registration = $transaction->primary_registration();
-        $primary_attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : false;
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_dtls = array(
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => $order_description,
-            'RETURNURL'                      => $return_url,
-            'CANCELURL'                      => $cancel_url,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            // Buyer does not need to create a PayPal account to check out.
-            // This is referred to as PayPal Account Optional.
-            'SOLUTIONTYPE'                   => 'Sole',
-            // Locale of the pages displayed by PayPal during Express Checkout.
-            'LOCALECODE'                     => $locale[1]
-        );
-        // Show itemized list.
-        $itemized_list = $this->itemize_list($payment, $transaction);
-        $token_request_dtls = array_merge($token_request_dtls, $itemized_list);
-        // Automatically filling out shipping and contact information.
-        if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
-            // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-            $token_request_dtls['NOSHIPPING'] = '2';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
-            $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_dtls['NOSHIPPING'] = '1';
-            $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
-            $token_request_dtls['LOGOIMG'] = $this->_image_url;
-        }
-        $token_request_dtls = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $token_request_dtls,
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
-        $token_rstatus = $this->_ppExpress_check_response($token_request_response);
-        $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
-            ? $token_rstatus['args']
-            : array();
-        if ($token_rstatus['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $payment->set_redirect_url(
-                $gateway_url
-                . '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
-                . $response_args['TOKEN']
-            );
-        } else {
-            if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
-            } else {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Error occurred while trying to setup the Express Checkout.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $payment->set_details($response_args);
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string status an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
-        if ($payment instanceof EEI_Payment) {
-            $this->log(array('Return from Authorization' => $update_info), $payment);
-            $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Could not process this payment because it has no associated transaction.',
-                        'event_espresso'
-                    )
-                );
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $cdetails_request_dtls = array(
-                'METHOD' => 'GetExpressCheckoutDetails',
-                'TOKEN'  => $payment_details['TOKEN'],
-            );
-            // Request Customer Details.
-            $cdetails_request_response = $this->_ppExpress_request(
-                $cdetails_request_dtls,
-                'Customer Details',
-                $payment
-            );
-            $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
-            $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
-                ? $cdetails_rstatus['args']
-                : array();
-            if ($cdetails_rstatus['status']) {
-                // We got the PayerID so now we can Complete the transaction.
-                $docheckout_request_dtls = array(
-                    'METHOD'                         => 'DoExpressCheckoutPayment',
-                    'PAYERID'                        => $cdata_response_args['PAYERID'],
-                    'TOKEN'                          => $payment_details['TOKEN'],
-                    'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-                    'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-                    'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-                );
-                 // Include itemized list.
-                $itemized_list = $this->itemize_list(
-                    $payment,
-                    $transaction,
-                    $cdata_response_args
-                );
-                $docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
-                // Payment Checkout/Capture.
-                $docheckout_request_response = $this->_ppExpress_request(
-                    $docheckout_request_dtls,
-                    'Do Payment',
-                    $payment
-                );
-                $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
-                $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
-                    ? $docheckout_rstatus['args']
-                    : array();
-                if ($docheckout_rstatus['status']) {
-                    // All is well, payment approved.
-                    $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-                        $primary_registrant->reg_code()
-                        : '';
-                    $payment->set_extra_accntng($primary_registration_code);
-                    $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
-                        : 0);
-                    $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
-                        : null);
-                    $payment->set_details($cdata_response_args);
-                    $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_ACK']
-                        : '');
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    if (isset($docheckout_response_args['L_ERRORCODE'])) {
-                        $payment->set_gateway_response(
-                            $docheckout_response_args['L_ERRORCODE']
-                            . '; '
-                            . $docheckout_response_args['L_SHORTMESSAGE']
-                        );
-                    } else {
-                        $payment->set_gateway_response(
-                            esc_html__(
-                                'Error occurred while trying to Capture the funds.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $payment->set_details($docheckout_response_args);
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-            } else {
-                if (isset($cdata_response_args['L_ERRORCODE'])) {
-                    $payment->set_gateway_response(
-                        $cdata_response_args['L_ERRORCODE']
-                        . '; '
-                        . $cdata_response_args['L_SHORTMESSAGE']
-                    );
-                } else {
-                    $payment->set_gateway_response(
-                        esc_html__(
-                            'Error occurred while trying to get payment Details from PayPal.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                $payment->set_details($cdata_response_args);
-                $payment->set_status($this->_pay_model->failed_status());
-            }
-        } else {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     *  Make a list of items that are in the giver transaction.
-     *
-     * @param EEI_Payment     $payment
-     * @param EEI_Transaction $transaction
-     * @param array           $request_response_args Data from a previous communication with PP.
-     * @return array
-     */
-    public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
-    {
-        $itemized_list = array();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        // If we have data from a previous communication with PP (on this transaction) we may use that for our list...
-        if (
-            ! empty($request_response_args)
-            && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
-            && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
-        ) {
-            foreach ($request_response_args as $arg_key => $arg_val) {
-                if (
-                    strpos($arg_key, 'PAYMENTREQUEST_') !== false
-                    && strpos($arg_key, 'NOTIFYURL') === false
-                ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
-                }
-            }
-            // If we got only a few Items then something is not right.
-            if (count($itemized_list) > 2) {
-                return $itemized_list;
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                // @codingStandardsIgnoreStart
-                                'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($itemized_list)
-                        )
-                    );
-                }
-                // Reset the list and log an error, maybe allow to try and generate a new list (below).
-                $itemized_list = array();
-                $this->log(
-                    array(
-                        (string) esc_html__(
-                            'Could not generate a proper item list with:',
-                            'event_espresso'
-                        ) => $request_response_args
-                    ),
-                    $payment
-                );
-            }
-        }
-        // ...otherwise we generate a new list for this transaction.
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 0;
-            $itemized_sum = 0;
-            $total_line_items = $transaction->total_line_item();
-            // Go through each item in the list.
-            foreach ($total_line_items->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // PayPal doesn't like line items with 0.00 amount, so we may skip those.
-                    if (EEH_Money::compare_floats($line_item->pretaxTotal(), '0.00', '==')) {
-                        continue;
-                    }
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                    // This is a discount.
-                    if ($line_item->is_percent()) {
-                        $unit_price = $line_item->pretaxTotal();
-                        $line_item_quantity = 1;
-                    }
-                    // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
-                        $unit_price,
-                        $this->decimal_precision
-                    );
-                    // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                    // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
-                    // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                    $itemized_sum += $line_item->pretaxTotal();
-                    ++$item_num;
-                }
-            }
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
-                $this->decimal_precision
-            );
-            // If we were not able to recognize some item like promotion, surcharge or cancellation,
-            // add the difference as an extra line item.
-            if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
-                // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                    esc_html__(
-                        'Other (promotion/surcharge/cancellation)',
-                        'event_espresso'
-                    ),
-                    0,
-                    127
-                );
-                // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
-                // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
-                    $itemized_sum_diff_from_txn_total,
-                    $this->decimal_precision
-                );
-                // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
-                // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                $item_num++;
-            }
-        } else {
-            // Just one Item.
-            // Item Name.
-            $itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                0,
-                127
-            );
-            // Item description.
-            $itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemDesc($payment),
-                0,
-                127
-            );
-            // Cost of individual item.
-            $itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency(
-                $payment->amount(),
-                $this->decimal_precision
-            );
-            // Item Number.
-            $itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-            // Item quantity.
-            $itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
-            // Digital item is sold.
-            $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency(
-                $payment->amount(),
-                $this->decimal_precision
-            );
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-        }
-        return $itemized_list;
-    }
-
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return mixed
-     */
-    public function _ppExpress_request($request_params, $request_text, $payment)
-    {
-        $request_dtls = array(
-            'VERSION' => '204.0',
-            'USER' => $this->_api_username,
-            'PWD' => $this->_api_password,
-            'SIGNATURE' => $this->_api_signature,
-            // EE will blow up if you change this
-            'BUTTONSOURCE' => 'EventEspresso_SP',
-        );
-        $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($dtls, '', '&'),
-            )
-        );
-        // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
-        return $request_response;
-    }
-
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response)
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if (
-            (
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
-    }
-
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request($request, $payment, $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log(array($info => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors($data_array)
-    {
-        $errors = array();
-        $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
-                : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
-                : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
-                : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
-                : '';
-            if ($n === 0) {
-                $errors = array(
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                );
-            } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url;
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+	/**
+	 * number of decimal places to round numbers to when performing calculations
+	 *
+	 * @var integer
+	 */
+	protected $decimal_precision = 6;
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+			'INR',
+		);
+		parent::__construct();
+		$this->decimal_precision = EE_Registry::instance()->CFG->currency->dec_plc;
+	}
+
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error. No associated payment was found.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
+		$primary_registration = $transaction->primary_registration();
+		$primary_attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: false;
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_dtls = array(
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => $order_description,
+			'RETURNURL'                      => $return_url,
+			'CANCELURL'                      => $cancel_url,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			// Buyer does not need to create a PayPal account to check out.
+			// This is referred to as PayPal Account Optional.
+			'SOLUTIONTYPE'                   => 'Sole',
+			// Locale of the pages displayed by PayPal during Express Checkout.
+			'LOCALECODE'                     => $locale[1]
+		);
+		// Show itemized list.
+		$itemized_list = $this->itemize_list($payment, $transaction);
+		$token_request_dtls = array_merge($token_request_dtls, $itemized_list);
+		// Automatically filling out shipping and contact information.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			// If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+			$token_request_dtls['NOSHIPPING'] = '2';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
+			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
+		} elseif (! $this->_request_shipping_addr) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_dtls['NOSHIPPING'] = '1';
+			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($this->_image_url)) {
+			$token_request_dtls['LOGOIMG'] = $this->_image_url;
+		}
+		$token_request_dtls = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$token_request_dtls,
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
+			? $token_rstatus['args']
+			: array();
+		if ($token_rstatus['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$payment->set_redirect_url(
+				$gateway_url
+				. '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
+				. $response_args['TOKEN']
+			);
+		} else {
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+			} else {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Error occurred while trying to setup the Express Checkout.',
+						'event_espresso'
+					)
+				);
+			}
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string status an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
+			$transaction = $payment->transaction();
+			if (! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Could not process this payment because it has no associated transaction.',
+						'event_espresso'
+					)
+				);
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$primary_registrant = $transaction->primary_registration();
+			$payment_details = $payment->details();
+			// Check if we still have the token.
+			if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$cdetails_request_dtls = array(
+				'METHOD' => 'GetExpressCheckoutDetails',
+				'TOKEN'  => $payment_details['TOKEN'],
+			);
+			// Request Customer Details.
+			$cdetails_request_response = $this->_ppExpress_request(
+				$cdetails_request_dtls,
+				'Customer Details',
+				$payment
+			);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
+				? $cdetails_rstatus['args']
+				: array();
+			if ($cdetails_rstatus['status']) {
+				// We got the PayerID so now we can Complete the transaction.
+				$docheckout_request_dtls = array(
+					'METHOD'                         => 'DoExpressCheckoutPayment',
+					'PAYERID'                        => $cdata_response_args['PAYERID'],
+					'TOKEN'                          => $payment_details['TOKEN'],
+					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+					'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+					'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+				);
+				 // Include itemized list.
+				$itemized_list = $this->itemize_list(
+					$payment,
+					$transaction,
+					$cdata_response_args
+				);
+				$docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
+				// Payment Checkout/Capture.
+				$docheckout_request_response = $this->_ppExpress_request(
+					$docheckout_request_dtls,
+					'Do Payment',
+					$payment
+				);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
+					? $docheckout_rstatus['args']
+					: array();
+				if ($docheckout_rstatus['status']) {
+					// All is well, payment approved.
+					$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+						$primary_registrant->reg_code()
+						: '';
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
+						? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
+						: 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
+						? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
+						: null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
+						? $docheckout_response_args['PAYMENTINFO_0_ACK']
+						: '');
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response(
+							$docheckout_response_args['L_ERRORCODE']
+							. '; '
+							. $docheckout_response_args['L_SHORTMESSAGE']
+						);
+					} else {
+						$payment->set_gateway_response(
+							esc_html__(
+								'Error occurred while trying to Capture the funds.',
+								'event_espresso'
+							)
+						);
+					}
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+			} else {
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response(
+						$cdata_response_args['L_ERRORCODE']
+						. '; '
+						. $cdata_response_args['L_SHORTMESSAGE']
+					);
+				} else {
+					$payment->set_gateway_response(
+						esc_html__(
+							'Error occurred while trying to get payment Details from PayPal.',
+							'event_espresso'
+						)
+					);
+				}
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
+			}
+		} else {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 *  Make a list of items that are in the giver transaction.
+	 *
+	 * @param EEI_Payment     $payment
+	 * @param EEI_Transaction $transaction
+	 * @param array           $request_response_args Data from a previous communication with PP.
+	 * @return array
+	 */
+	public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
+	{
+		$itemized_list = array();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		// If we have data from a previous communication with PP (on this transaction) we may use that for our list...
+		if (
+			! empty($request_response_args)
+			&& array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
+			&& array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
+		) {
+			foreach ($request_response_args as $arg_key => $arg_val) {
+				if (
+					strpos($arg_key, 'PAYMENTREQUEST_') !== false
+					&& strpos($arg_key, 'NOTIFYURL') === false
+				) {
+					$itemized_list[ $arg_key ] = $arg_val;
+				}
+			}
+			// If we got only a few Items then something is not right.
+			if (count($itemized_list) > 2) {
+				return $itemized_list;
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								// @codingStandardsIgnoreStart
+								'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($itemized_list)
+						)
+					);
+				}
+				// Reset the list and log an error, maybe allow to try and generate a new list (below).
+				$itemized_list = array();
+				$this->log(
+					array(
+						(string) esc_html__(
+							'Could not generate a proper item list with:',
+							'event_espresso'
+						) => $request_response_args
+					),
+					$payment
+				);
+			}
+		}
+		// ...otherwise we generate a new list for this transaction.
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 0;
+			$itemized_sum = 0;
+			$total_line_items = $transaction->total_line_item();
+			// Go through each item in the list.
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
+					if (EEH_Money::compare_floats($line_item->pretaxTotal(), '0.00', '==')) {
+						continue;
+					}
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+					// This is a discount.
+					if ($line_item->is_percent()) {
+						$unit_price = $line_item->pretaxTotal();
+						$line_item_quantity = 1;
+					}
+					// Item Name.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					);
+					// Item description.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemDesc($line_item, $payment),
+						0,
+						127
+					);
+					// Cost of individual item.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+						$unit_price,
+						$this->decimal_precision
+					);
+					// Item Number.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+					// Item quantity.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+					// Digital item is sold.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+					$itemized_sum += $line_item->pretaxTotal();
+					++$item_num;
+				}
+			}
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
+				$this->decimal_precision
+			);
+			// If we were not able to recognize some item like promotion, surcharge or cancellation,
+			// add the difference as an extra line item.
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
+				// Item Name.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+					esc_html__(
+						'Other (promotion/surcharge/cancellation)',
+						'event_espresso'
+					),
+					0,
+					127
+				);
+				// Item description.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+				// Cost of individual item.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+					$itemized_sum_diff_from_txn_total,
+					$this->decimal_precision
+				);
+				// Item Number.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+				// Item quantity.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+				// Digital item is sold.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+				$item_num++;
+			}
+		} else {
+			// Just one Item.
+			// Item Name.
+			$itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemName($payment),
+				0,
+				127
+			);
+			// Item description.
+			$itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemDesc($payment),
+				0,
+				127
+			);
+			// Cost of individual item.
+			$itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency(
+				$payment->amount(),
+				$this->decimal_precision
+			);
+			// Item Number.
+			$itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+			// Item quantity.
+			$itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
+			// Digital item is sold.
+			$itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency(
+				$payment->amount(),
+				$this->decimal_precision
+			);
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+		}
+		return $itemized_list;
+	}
+
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return mixed
+	 */
+	public function _ppExpress_request($request_params, $request_text, $payment)
+	{
+		$request_dtls = array(
+			'VERSION' => '204.0',
+			'USER' => $this->_api_username,
+			'PWD' => $this->_api_password,
+			'SIGNATURE' => $this->_api_signature,
+			// EE will blow up if you change this
+			'BUTTONSOURCE' => 'EventEspresso_SP',
+		);
+		$dtls = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($dtls, '', '&'),
+			)
+		);
+		// Log the response.
+		$this->log(array($request_text . ' Response' => $request_response), $payment);
+		return $request_response;
+	}
+
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response)
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if (
+			(
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
+	}
+
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment, $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log(array($info => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors($data_array)
+	{
+		$errors = array();
+		$n = 0;
+		while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
+			$l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
+				? $data_array[ "L_ERRORCODE{$n}" ]
+				: '';
+			$l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
+				? $data_array[ "L_SEVERITYCODE{$n}" ]
+				: '';
+			$l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
+				? $data_array[ "L_SHORTMESSAGE{$n}" ]
+				: '';
+			$l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
+				? $data_array[ "L_LONGMESSAGE{$n}" ]
+				: '';
+			if ($n === 0) {
+				$errors = array(
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				);
+			} else {
+				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
 }

Spacing +37 added lines, -37 removed lines

@@ -12,7 +12,7 @@ 
  */
 
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
-if (! function_exists('mb_strcut')) {
+if ( ! function_exists('mb_strcut')) {
     /**
      * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
      * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
@@ -151,7 +151,7 @@ 
         $notify_url = null,
         $cancel_url = null
     ) {
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Error. No associated payment was found.',
@@ -162,7 +162,7 @@ 
             return $payment;
         }
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Could not process this payment because it has no associated transaction.',
@@ -209,13 +209,13 @@ 
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
             $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
+        } elseif ( ! $this->_request_shipping_addr) {
             // Do not request shipping details on the PP Checkout page.
             $token_request_dtls['NOSHIPPING'] = '1';
             $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
         }
         // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
+        if ( ! empty($this->_image_url)) {
             $token_request_dtls['LOGOIMG'] = $this->_image_url;
         }
         $token_request_dtls = apply_filters(
@@ -240,7 +240,7 @@ 
             );
         } else {
             if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+                $payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
             } else {
                 $payment->set_gateway_response(
                     esc_html__(
@@ -271,7 +271,7 @@ 
         if ($payment instanceof EEI_Payment) {
             $this->log(array('Return from Authorization' => $update_info), $payment);
             $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
+            if ( ! $transaction instanceof EEI_Transaction) {
                 $payment->set_gateway_response(
                     esc_html__(
                         'Could not process this payment because it has no associated transaction.',
@@ -284,7 +284,7 @@ 
             $primary_registrant = $transaction->primary_registration();
             $payment_details = $payment->details();
             // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+            if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
                 $payment->set_status($this->_pay_model->failed_status());
                 return $payment;
             }
@@ -419,7 +419,7 @@ 
                     strpos($arg_key, 'PAYMENTREQUEST_') !== false
                     && strpos($arg_key, 'NOTIFYURL') === false
                 ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
+                    $itemized_list[$arg_key] = $arg_val;
                 }
             }
             // If we got only a few Items then something is not right.
@@ -472,28 +472,28 @@ 
                         $line_item_quantity = 1;
                     }
                     // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                         $gateway_formatter->formatLineItemName($line_item, $payment),
                         0,
                         127
                     );
                     // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = mb_strcut(
                         $gateway_formatter->formatLineItemDesc($line_item, $payment),
                         0,
                         127
                     );
                     // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+                    $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency(
                         $unit_price,
                         $this->decimal_precision
                     );
                     // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+                    $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                     // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+                    $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
                     // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+                    $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                     $itemized_sum += $line_item->pretaxTotal();
                     ++$item_num;
                 }
@@ -511,7 +511,7 @@ 
             // add the difference as an extra line item.
             if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
                 // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+                $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                     esc_html__(
                         'Other (promotion/surcharge/cancellation)',
                         'event_espresso'
@@ -520,18 +520,18 @@ 
                     127
                 );
                 // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+                $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
                 // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+                $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency(
                     $itemized_sum_diff_from_txn_total,
                     $this->decimal_precision
                 );
                 // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+                $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                 // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+                $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
                 // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+                $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                 $item_num++;
             }
         } else {
@@ -592,7 +592,7 @@ 
             'BUTTONSOURCE' => 'EventEspresso_SP',
         );
         $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+        $this->_log_clean_request($dtls, $payment, $request_text.' Request');
         // Request Customer Details.
         $request_response = wp_remote_post(
             $this->_base_gateway_url,
@@ -606,7 +606,7 @@ 
             )
         );
         // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
+        $this->log(array($request_text.' Response' => $request_response), $payment);
         return $request_response;
     }
 
@@ -626,7 +626,7 @@ 
         }
         $response_args = array();
         parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
+        if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
         if (
@@ -674,18 +674,18 @@ 
     {
         $errors = array();
         $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
+        while (isset($data_array["L_ERRORCODE{$n}"])) {
+            $l_error_code = isset($data_array["L_ERRORCODE{$n}"])
+                ? $data_array["L_ERRORCODE{$n}"]
                 : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
+            $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
+                ? $data_array["L_SEVERITYCODE{$n}"]
                 : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
+            $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
+                ? $data_array["L_SHORTMESSAGE{$n}"]
                 : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
+            $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
+                ? $data_array["L_LONGMESSAGE{$n}"]
                 : '';
             if ($n === 0) {
                 $errors = array(
@@ -695,10 +695,10 @@ 
                     'L_SEVERITYCODE' => $l_severity_code,
                 );
             } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+                $errors['L_ERRORCODE'] .= ', '.$l_error_code;
+                $errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+                $errors['L_LONGMESSAGE'] .= ', '.$l_long_message;
+                $errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
             }
             $n++;
         }

payment_methods/Paypal_Standard/EEG_Paypal_Standard.gateway.php

Indentation +603 added lines, -603 removed lines

@@ -19,608 +19,608 @@
 class EEG_Paypal_Standard extends EE_Offsite_Gateway
 {
 
-    /**
-     * Name for the wp option used to save the itemized payment
-     */
-    const itemized_payment_option_name = '_itemized_payment';
-
-    protected $_paypal_id;
-
-    protected $_image_url;
-
-    protected $_shipping_details;
-
-    protected $_paypal_shipping;
-
-    protected $_paypal_taxes;
-
-    protected $_gateway_url;
-
-    protected $_currencies_supported = array(
-        'USD',
-        'GBP',
-        'CAD',
-        'AUD',
-        'BRL',
-        'CHF',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MXN',
-        'MYR',
-        'NOK',
-        'NZD',
-        'PHP',
-        'PLN',
-        'SEK',
-        'SGD',
-        'THB',
-        'TRY',
-        'TWD',
-        'RUB'
-    );
-
-
-    /**
-     * EEG_Paypal_Standard constructor.
-     *
-     * @return EEG_Paypal_Standard
-     */
-    public function __construct()
-    {
-        $this->set_uses_separate_IPN_request(true);
-        parent::__construct();
-    }
-
-
-    /**
-     * Also sets the gateway url class variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        $this->_gateway_url = $this->_debug_mode
-            ? 'https://www.sandbox.paypal.com/cgi-bin/webscr'
-            : 'https://www.paypal.com/cgi-bin/webscr';
-    }
-
-
-    /**
-     * @param EEI_Payment $payment      the payment to process
-     * @param array       $billing_info but should be empty for this gateway
-     * @param string      $return_url   URL to send the user to after payment on the payment provider's website
-     * @param string      $notify_url   URL to send the instant payment notification
-     * @param string      $cancel_url   URL to send the user to after a cancelled payment attempt
-     *                                  on the payment provider's website
-     * @return EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        $redirect_args = array();
-        $transaction = $payment->transaction();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $item_num = 1;
-        /** @type EE_Line_Item $total_line_item */
-        $total_line_item = $transaction->total_line_item();
-
-        $total_discounts_to_cart_total = $transaction->paid();
-        // only itemize the order if we're paying for the rest of the order's amount
-        if (EEH_Money::compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true);
-            // this payment is for the remaining transaction amount,
-            // keep track of exactly how much the itemized order amount equals
-            $itemized_sum = 0;
-            $shipping_previously_added = 0;
-            // so let's show all the line items
-            foreach ($total_line_item->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // it's some kind of discount
-                    if ($line_item->pretaxTotal() < 0) {
-                        $total_discounts_to_cart_total += abs($line_item->pretaxTotal());
-                        $itemized_sum += $line_item->pretaxTotal();
-                        continue;
-                    }
-                    // dont include shipping again.
-                    if (strpos($line_item->code(), 'paypal_shipping_') === 0) {
-                        $shipping_previously_added = $line_item->pretaxTotal();
-                        continue;
-                    }
-                    $redirect_args[ 'item_name_' . $item_num ] = substr(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    );
-                    $redirect_args[ 'amount_' . $item_num ] = $line_item->unit_price();
-                    $redirect_args[ 'quantity_' . $item_num ] = $line_item->quantity();
-                    // if we're not letting PayPal calculate shipping, tell them its 0
-                    if (! $this->_paypal_shipping) {
-                        $redirect_args[ 'shipping_' . $item_num ] = '0';
-                        $redirect_args[ 'shipping2_' . $item_num ] = '0';
-                    }
-                    $item_num++;
-                    $itemized_sum += $line_item->pretaxTotal();
-                }
-            }
-            $taxes_li = $this->_line_item->get_taxes_subtotal($total_line_item);
-            // ideally itemized sum equals the transaction total. but if not (which is weird)
-            // and the itemized sum is LESS than the transaction total
-            // add another line item
-            // if the itemized sum is MORE than the transaction total,
-            // add the difference it to the discounts
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $taxes_li->total() - $shipping_previously_added,
-                2
-            );
-            if ($itemized_sum_diff_from_txn_total < 0) {
-                // itemized sum is too big
-                $total_discounts_to_cart_total += abs($itemized_sum_diff_from_txn_total);
-            } elseif ($itemized_sum_diff_from_txn_total > 0) {
-                $redirect_args[ 'item_name_' . $item_num ] = substr(
-                    __('Other charges', 'event_espresso'),
-                    0,
-                    127
-                );
-                $redirect_args[ 'amount_' . $item_num ] = $gateway_formatter->formatCurrency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                $redirect_args[ 'quantity_' . $item_num ] = 1;
-                $item_num++;
-            }
-            if ($total_discounts_to_cart_total > 0) {
-                $redirect_args['discount_amount_cart'] = $gateway_formatter->formatCurrency(
-                    $total_discounts_to_cart_total
-                );
-            }
-            // add our taxes to the order if we're NOT using PayPal's
-            if (! $this->_paypal_taxes) {
-                $redirect_args['tax_cart'] = $total_line_item->get_total_tax();
-            }
-        } else {
-            $payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
-            // partial payment that's not for the remaining amount, so we can't send an itemized list
-            $redirect_args[ 'item_name_' . $item_num ] = substr(
-                $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                0,
-                127
-            );
-            $redirect_args[ 'amount_' . $item_num ] = $payment->amount();
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
-            $redirect_args['tax_cart'] = '0';
-            $item_num++;
-        }
-
-        if ($this->_debug_mode) {
-            $redirect_args[ 'item_name_' . $item_num ] = 'DEBUG INFO (this item only added in sandbox mode';
-            $redirect_args[ 'amount_' . $item_num ] = 0;
-            $redirect_args[ 'on0_' . $item_num ] = 'NOTIFY URL';
-            $redirect_args[ 'os0_' . $item_num ] = $notify_url;
-            $redirect_args[ 'on1_' . $item_num ] = 'RETURN URL';
-            $redirect_args[ 'os1_' . $item_num ] = $return_url;
+	/**
+	 * Name for the wp option used to save the itemized payment
+	 */
+	const itemized_payment_option_name = '_itemized_payment';
+
+	protected $_paypal_id;
+
+	protected $_image_url;
+
+	protected $_shipping_details;
+
+	protected $_paypal_shipping;
+
+	protected $_paypal_taxes;
+
+	protected $_gateway_url;
+
+	protected $_currencies_supported = array(
+		'USD',
+		'GBP',
+		'CAD',
+		'AUD',
+		'BRL',
+		'CHF',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MXN',
+		'MYR',
+		'NOK',
+		'NZD',
+		'PHP',
+		'PLN',
+		'SEK',
+		'SGD',
+		'THB',
+		'TRY',
+		'TWD',
+		'RUB'
+	);
+
+
+	/**
+	 * EEG_Paypal_Standard constructor.
+	 *
+	 * @return EEG_Paypal_Standard
+	 */
+	public function __construct()
+	{
+		$this->set_uses_separate_IPN_request(true);
+		parent::__construct();
+	}
+
+
+	/**
+	 * Also sets the gateway url class variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		$this->_gateway_url = $this->_debug_mode
+			? 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+			: 'https://www.paypal.com/cgi-bin/webscr';
+	}
+
+
+	/**
+	 * @param EEI_Payment $payment      the payment to process
+	 * @param array       $billing_info but should be empty for this gateway
+	 * @param string      $return_url   URL to send the user to after payment on the payment provider's website
+	 * @param string      $notify_url   URL to send the instant payment notification
+	 * @param string      $cancel_url   URL to send the user to after a cancelled payment attempt
+	 *                                  on the payment provider's website
+	 * @return EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		$redirect_args = array();
+		$transaction = $payment->transaction();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$item_num = 1;
+		/** @type EE_Line_Item $total_line_item */
+		$total_line_item = $transaction->total_line_item();
+
+		$total_discounts_to_cart_total = $transaction->paid();
+		// only itemize the order if we're paying for the rest of the order's amount
+		if (EEH_Money::compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true);
+			// this payment is for the remaining transaction amount,
+			// keep track of exactly how much the itemized order amount equals
+			$itemized_sum = 0;
+			$shipping_previously_added = 0;
+			// so let's show all the line items
+			foreach ($total_line_item->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// it's some kind of discount
+					if ($line_item->pretaxTotal() < 0) {
+						$total_discounts_to_cart_total += abs($line_item->pretaxTotal());
+						$itemized_sum += $line_item->pretaxTotal();
+						continue;
+					}
+					// dont include shipping again.
+					if (strpos($line_item->code(), 'paypal_shipping_') === 0) {
+						$shipping_previously_added = $line_item->pretaxTotal();
+						continue;
+					}
+					$redirect_args[ 'item_name_' . $item_num ] = substr(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					);
+					$redirect_args[ 'amount_' . $item_num ] = $line_item->unit_price();
+					$redirect_args[ 'quantity_' . $item_num ] = $line_item->quantity();
+					// if we're not letting PayPal calculate shipping, tell them its 0
+					if (! $this->_paypal_shipping) {
+						$redirect_args[ 'shipping_' . $item_num ] = '0';
+						$redirect_args[ 'shipping2_' . $item_num ] = '0';
+					}
+					$item_num++;
+					$itemized_sum += $line_item->pretaxTotal();
+				}
+			}
+			$taxes_li = $this->_line_item->get_taxes_subtotal($total_line_item);
+			// ideally itemized sum equals the transaction total. but if not (which is weird)
+			// and the itemized sum is LESS than the transaction total
+			// add another line item
+			// if the itemized sum is MORE than the transaction total,
+			// add the difference it to the discounts
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $taxes_li->total() - $shipping_previously_added,
+				2
+			);
+			if ($itemized_sum_diff_from_txn_total < 0) {
+				// itemized sum is too big
+				$total_discounts_to_cart_total += abs($itemized_sum_diff_from_txn_total);
+			} elseif ($itemized_sum_diff_from_txn_total > 0) {
+				$redirect_args[ 'item_name_' . $item_num ] = substr(
+					__('Other charges', 'event_espresso'),
+					0,
+					127
+				);
+				$redirect_args[ 'amount_' . $item_num ] = $gateway_formatter->formatCurrency(
+					$itemized_sum_diff_from_txn_total
+				);
+				$redirect_args[ 'quantity_' . $item_num ] = 1;
+				$item_num++;
+			}
+			if ($total_discounts_to_cart_total > 0) {
+				$redirect_args['discount_amount_cart'] = $gateway_formatter->formatCurrency(
+					$total_discounts_to_cart_total
+				);
+			}
+			// add our taxes to the order if we're NOT using PayPal's
+			if (! $this->_paypal_taxes) {
+				$redirect_args['tax_cart'] = $total_line_item->get_total_tax();
+			}
+		} else {
+			$payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
+			// partial payment that's not for the remaining amount, so we can't send an itemized list
+			$redirect_args[ 'item_name_' . $item_num ] = substr(
+				$gateway_formatter->formatPartialPaymentLineItemName($payment),
+				0,
+				127
+			);
+			$redirect_args[ 'amount_' . $item_num ] = $payment->amount();
+			$redirect_args[ 'shipping_' . $item_num ] = '0';
+			$redirect_args[ 'shipping2_' . $item_num ] = '0';
+			$redirect_args['tax_cart'] = '0';
+			$item_num++;
+		}
+
+		if ($this->_debug_mode) {
+			$redirect_args[ 'item_name_' . $item_num ] = 'DEBUG INFO (this item only added in sandbox mode';
+			$redirect_args[ 'amount_' . $item_num ] = 0;
+			$redirect_args[ 'on0_' . $item_num ] = 'NOTIFY URL';
+			$redirect_args[ 'os0_' . $item_num ] = $notify_url;
+			$redirect_args[ 'on1_' . $item_num ] = 'RETURN URL';
+			$redirect_args[ 'os1_' . $item_num ] = $return_url;
 //          $redirect_args['option_index_' . $item_num] = 1; // <-- dunno if this is needed ?
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
-        }
-
-        $redirect_args['business'] = $this->_paypal_id;
-        $redirect_args['return'] = $return_url;
-        $redirect_args['cancel_return'] = $cancel_url;
-        $redirect_args['notify_url'] = $notify_url;
-        $redirect_args['cmd'] = '_cart';
-        $redirect_args['upload'] = 1;
-        $redirect_args['currency_code'] = $payment->currency_code();
-        $redirect_args['rm'] = 2;// makes the user return with method=POST
-        if ($this->_image_url) {
-            $redirect_args['image_url'] = $this->_image_url;
-        }
-        $redirect_args['no_shipping'] = $this->_shipping_details;
-        $redirect_args['bn'] = 'EventEspresso_SP';// EE will blow up if you change this
-
-        $redirect_args = apply_filters("FHEE__EEG_Paypal_Standard__set_redirection_info__arguments", $redirect_args, $this);
-
-        $payment->set_redirect_url($this->_gateway_url);
-        $payment->set_redirect_args($redirect_args);
-        // log the results
-        $this->log(
-            array(
-                'message'     => sprintf(
-                    __('PayPal payment request initiated.', 'event_espresso')
-                ),
-                'transaction' => $transaction->model_field_array(),
-            ),
-            $payment
-        );
-        return $payment;
-    }
-
-
-    /**
-     * Often used for IPNs. But applies the info in $update_info to the payment.
-     * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
-     * the payment method passes in.
-     *
-     * @param array $update_info like $_POST
-     * @param EEI_Transaction $transaction
-     * @return \EEI_Payment updated
-     * @throws \EE_Error, IpnException
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        // verify there's payment data that's been sent
-        if (empty($update_info['payment_status']) || empty($update_info['txn_id'])) {
-            // log the results
-            $this->log(
-                array(
-                    'message'     => sprintf(
-                        // @codingStandardsIgnoreStart
-                        __('PayPal IPN response is missing critical payment data. This may indicate a PDT request and require your PayPal account settings to be corrected.', 'event_espresso')
-                        // @codingStandardsIgnoreEnd
-                    ),
-                    'update_info' => $update_info,
-                ),
-                $transaction
-            );
-            // waaaait... is this a PDT request? (see https://developer.paypal.com/docs/classic/products/payment-data-transfer/)
-            // indicated by the "tx" argument? If so, we don't need it. We'll just use the IPN data when it comes
-            if (isset($update_info['tx'])) {
-                return $transaction->last_payment();
-            } else {
-                return null;
-            }
-        }
-        $payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
-        if (! $payment instanceof EEI_Payment) {
-            $payment = $transaction->last_payment();
-        }
-        // ok, then validate the IPN. Even if we've already processed this payment,
-        // let PayPal know we don't want to hear from them anymore!
-        if (! $this->validate_ipn($update_info, $payment)) {
-            return $payment;
-        }
-        // kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
-        // registrations, ticket counts, etc)
-        if (
-            (
-                $update_info['payment_status'] === 'Refunded'
-                || $update_info['payment_status'] === 'Partially_Refunded'
-            )
-            && apply_filters('FHEE__EEG_Paypal_Standard__handle_payment_update__kill_refund_request', true)
-        ) {
-            throw new EventEspresso\core\exceptions\IpnException(
-                sprintf(
-                    esc_html__('Event Espresso does not yet support %1$s IPNs from PayPal', 'event_espresso'),
-                    $update_info['payment_status']
-                ),
-                EventEspresso\core\exceptions\IpnException::UNSUPPORTED,
-                null,
-                $payment,
-                $update_info
-            );
-        }
-        // ok, well let's process this payment then!
-        switch ($update_info['payment_status']) {
-            case 'Completed':
-                $status = $this->_pay_model->approved_status();
-                $gateway_response = esc_html__('The payment is approved.', 'event_espresso');
-                break;
-
-            case 'Pending':
-                $status = $this->_pay_model->pending_status();
-                $gateway_response = esc_html__(
-                    'The payment is in progress. Another message will be sent when payment is approved.',
-                    'event_espresso'
-                );
-                break;
-
-            case 'Denied':
-                $status = $this->_pay_model->declined_status();
-                $gateway_response = esc_html__('The payment has been declined.', 'event_espresso');
-                break;
-
-            case 'Expired':
-            case 'Failed':
-                $status = $this->_pay_model->failed_status();
-                $gateway_response = esc_html__('The payment failed for technical reasons or expired.', 'event_espresso');
-                break;
-
-            case 'Refunded':
-            case 'Partially_Refunded':
-                // even though it's a refund, we consider the payment as approved, it just has a negative value
-                $status = $this->_pay_model->approved_status();
-                $gateway_response = esc_html__(
-                    'The payment has been refunded. Please update registrations accordingly.',
-                    'event_espresso'
-                );
-                break;
-
-            case 'Voided':
-            case 'Reversed':
-            case 'Canceled_Reversal':
-            default:
-                $status = $this->_pay_model->cancelled_status();
-                $gateway_response = esc_html__(
-                    'The payment was cancelled, reversed, or voided. Please update registrations accordingly.',
-                    'event_espresso'
-                );
-                break;
-        }
-
-        // check if we've already processed this payment
-        if ($payment instanceof EEI_Payment) {
-            // payment exists. if this has the exact same status and amount, don't bother updating. just return
-            if ($payment->status() === $status && (float) $payment->amount() === (float) $update_info['mc_gross']) {
-                // DUPLICATED IPN! don't bother updating transaction
-                throw new IpnException(
-                    sprintf(
-                        esc_html__(
-                            'It appears we have received a duplicate IPN from PayPal for payment %d',
-                            'event_espresso'
-                        ),
-                        $payment->ID()
-                    ),
-                    IpnException::DUPLICATE,
-                    null,
-                    $payment,
-                    $update_info
-                );
-            } else {
-                // new payment yippee !!!
-                $payment->set_status($status);
-                $payment->set_amount((float) $update_info['mc_gross']);
-                $payment->set_gateway_response($gateway_response);
-                $payment->set_details($update_info);
-                $payment->set_txn_id_chq_nmbr($update_info['txn_id']);
-                $this->log(
-                    array(
-                        'message'  => esc_html__(
-                            'Updated payment either from IPN or as part of POST from PayPal',
-                            'event_espresso'
-                        ),
-                        'url'      => $this->_process_response_url(),
-                        'payment'  => $payment->model_field_array(),
-                        'IPN_data' => $update_info
-                    ),
-                    $payment
-                );
-            }
-        }
-        do_action('FHEE__EEG_Paypal_Standard__handle_payment_update__payment_processed', $payment, $this);
-        return $payment;
-    }
-
-
-    /**
-     * Validate the IPN notification.
-     *
-     * @param array                  $update_info like $_REQUEST
-     * @param EE_Payment|EEI_Payment $payment
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function validate_ipn($update_info, $payment)
-    {
-        // allow us to skip validating IPNs with PayPal (useful for testing)
-        if (apply_filters('FHEE__EEG_Paypal_Standard__validate_ipn__skip', false)) {
-            return true;
-        }
-        // ...otherwise, we actually don't care what the $update_info is, we need to look
-        // at the request directly because we can't use $update_info because it has issues with quotes
-        // Reading POSTed data directly from $_POST causes serialization issues with array data in the POST.
-        // Instead, read raw POST data from the input stream.
-        // @see https://gist.github.com/xcommerce-gists/3440401
-        $raw_post_data = file_get_contents('php://input');
-        $raw_post_array = explode('&', $raw_post_data);
-        $update_info = array();
-        foreach ($raw_post_array as $keyval) {
-            $keyval = explode('=', $keyval);
-            if (count($keyval) === 2) {
-                $update_info[ $keyval[0] ] = urldecode($keyval[1]);
-            }
-        }
-        // read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
-        $req = 'cmd=_notify-validate';
-        $uses_get_magic_quotes = function_exists('get_magic_quotes_gpc') && get_magic_quotes_gpc() === 1
-            ? true
-            : false;
-        foreach ($update_info as $key => $value) {
-            $value = $uses_get_magic_quotes ? urlencode(stripslashes($value)) : urlencode($value);
-            $req .= "&$key=$value";
-        }
-        // HTTP POST the complete, unaltered IPN back to PayPal
-        $response = wp_remote_post(
-            $this->_gateway_url,
-            array(
-                'body'              => $req,
-                'sslverify'         => false,
-                'timeout'           => 60,
-                // make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
-                // plz see: https://github.com/websharks/s2member/issues/610
-                'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
-                'httpversion'       => '1.1'
-            )
-        );
-        // then check the response
-        if (
-            array_key_exists('body', $response)
-            && ! is_wp_error($response)
-            && strcmp($response['body'], "VERIFIED") === 0
-        ) {
-            return true;
-        }
-        // huh, something's wack... the IPN didn't validate. We must have replied to the IPN incorrectly,
-        // or their API must have changed: http://www.paypalobjects.com/en_US/ebook/PP_OrderManagement_IntegrationGuide/ipn.html
-        if ($response instanceof WP_Error) {
-            $error_msg = sprintf(
-                esc_html__('WP Error. Code: "%1$s", Message: "%2$s", Data: "%3$s"', 'event_espresso'),
-                $response->get_error_code(),
-                $response->get_error_message(),
-                print_r($response->get_error_data(), true)
-            );
-        } elseif (is_array($response) && isset($response['body'])) {
-            $error_msg = $response['body'];
-        } else {
-            $error_msg = print_r($response, true);
-        }
-        $payment->set_gateway_response(
-            sprintf(
-                esc_html__("IPN Validation failed! Paypal responded with '%s'", "event_espresso"),
-                $error_msg
-            )
-        );
-        $payment->set_details(array('REQUEST' => $update_info, 'VALIDATION_RESPONSE' => $response));
-        $payment->set_status(EEM_Payment::status_id_failed);
-        // log the results
-        $this->log(
-            array(
-                'url'     => $this->_process_response_url(),
-                'message' => $payment->gateway_response(),
-                'details' => $payment->details(),
-            ),
-            $payment
-        );
-        return false;
-    }
-
-
-    /**
-     * _process_response_url
-     * @return string
-     */
-    protected function _process_response_url()
-    {
-        if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= EEH_URL::filter_input_server_url();
-        } else {
-            $url = 'unknown';
-        }
-        return $url;
-    }
-
-
-    /**
-     * Updates the transaction and line items based on the payment IPN data from PayPal,
-     * like the taxes or shipping
-     *
-     * @param EEI_Payment $payment
-     * @throws \EE_Error
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        $update_info = $payment->details();
-        /** @var EE_Transaction $transaction */
-        $transaction = $payment->transaction();
-        $payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
-        if (! $transaction) {
-            $this->log(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Payment with ID %d has no related transaction, and so update_txn_based_on_payment couldn\'t be executed properly',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $payment
-            );
-            return;
-        }
-        if (
-            ! is_array($update_info)
-            || ! isset($update_info['mc_shipping'])
-            || ! isset($update_info['tax'])
-        ) {
-            $this->log(
-                array(
-                    'message' => esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'Could not update transaction based on payment because the payment details have not yet been put on the payment. This normally happens during the IPN or returning from PayPal',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    'url'     => $this->_process_response_url(),
-                    'payment' => $payment->model_field_array()
-                ),
-                $payment
-            );
-            return;
-        }
-        if ($payment->status() !== $this->_pay_model->approved_status()) {
-            $this->log(
-                array(
-                    'message' => esc_html__(
-                        'We shouldn\'t update transactions taxes or shipping data from non-approved payments',
-                        'event_espresso'
-                    ),
-                    'url'     => $this->_process_response_url(),
-                    'payment' => $payment->model_field_array()
-                ),
-                $payment
-            );
-            return;
-        }
-        $grand_total_needs_resaving = false;
-        /** @var EE_Line_Item $transaction_total_line_item */
-        $transaction_total_line_item = $transaction->total_line_item();
-
-        // might paypal have changed the taxes?
-        if ($this->_paypal_taxes && $payment_was_itemized) {
-            // note that we're doing this BEFORE adding shipping;
-            // we actually want PayPal's shipping to remain non-taxable
-            $this->_line_item->set_line_items_taxable($transaction_total_line_item, true, 'paypal_shipping');
-            $this->_line_item->set_total_tax_to(
-                $transaction_total_line_item,
-                (float) $update_info['tax'],
-                esc_html__('Taxes', 'event_espresso'),
-                esc_html__('Calculated by Paypal', 'event_espresso'),
-                'paypal_tax'
-            );
-            $grand_total_needs_resaving = true;
-        }
-
-        $shipping_amount = (float) $update_info['mc_shipping'];
-        // might paypal have added shipping?
-        if ($this->_paypal_shipping && $shipping_amount && $payment_was_itemized) {
-            $this->_line_item->add_unrelated_item(
-                $transaction_total_line_item,
-                sprintf(esc_html__('Shipping for transaction %1$s', 'event_espresso'), $transaction->ID()),
-                $shipping_amount,
-                esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
-                1,
-                false,
-                'paypal_shipping_' . $transaction->ID()
-            );
-            $grand_total_needs_resaving = true;
-        }
-
-        if ($grand_total_needs_resaving) {
-            $transaction_total_line_item->save_this_and_descendants_to_txn($transaction->ID());
-            /** @var EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->update_registration_final_prices($transaction);
-        }
-        $this->log(
-            array(
-                'message'                     => esc_html__('Updated transaction related to payment', 'event_espresso'),
-                'url'                         => $this->_process_response_url(),
-                'transaction (updated)'       => $transaction->model_field_array(),
-                'payment (updated)'           => $payment->model_field_array(),
-                'use_paypal_shipping'         => $this->_paypal_shipping,
-                'use_paypal_tax'              => $this->_paypal_taxes,
-                'grand_total_needed_resaving' => $grand_total_needs_resaving,
-            ),
-            $payment
-        );
-    }
+			$redirect_args[ 'shipping_' . $item_num ] = '0';
+			$redirect_args[ 'shipping2_' . $item_num ] = '0';
+		}
+
+		$redirect_args['business'] = $this->_paypal_id;
+		$redirect_args['return'] = $return_url;
+		$redirect_args['cancel_return'] = $cancel_url;
+		$redirect_args['notify_url'] = $notify_url;
+		$redirect_args['cmd'] = '_cart';
+		$redirect_args['upload'] = 1;
+		$redirect_args['currency_code'] = $payment->currency_code();
+		$redirect_args['rm'] = 2;// makes the user return with method=POST
+		if ($this->_image_url) {
+			$redirect_args['image_url'] = $this->_image_url;
+		}
+		$redirect_args['no_shipping'] = $this->_shipping_details;
+		$redirect_args['bn'] = 'EventEspresso_SP';// EE will blow up if you change this
+
+		$redirect_args = apply_filters("FHEE__EEG_Paypal_Standard__set_redirection_info__arguments", $redirect_args, $this);
+
+		$payment->set_redirect_url($this->_gateway_url);
+		$payment->set_redirect_args($redirect_args);
+		// log the results
+		$this->log(
+			array(
+				'message'     => sprintf(
+					__('PayPal payment request initiated.', 'event_espresso')
+				),
+				'transaction' => $transaction->model_field_array(),
+			),
+			$payment
+		);
+		return $payment;
+	}
+
+
+	/**
+	 * Often used for IPNs. But applies the info in $update_info to the payment.
+	 * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
+	 * the payment method passes in.
+	 *
+	 * @param array $update_info like $_POST
+	 * @param EEI_Transaction $transaction
+	 * @return \EEI_Payment updated
+	 * @throws \EE_Error, IpnException
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		// verify there's payment data that's been sent
+		if (empty($update_info['payment_status']) || empty($update_info['txn_id'])) {
+			// log the results
+			$this->log(
+				array(
+					'message'     => sprintf(
+						// @codingStandardsIgnoreStart
+						__('PayPal IPN response is missing critical payment data. This may indicate a PDT request and require your PayPal account settings to be corrected.', 'event_espresso')
+						// @codingStandardsIgnoreEnd
+					),
+					'update_info' => $update_info,
+				),
+				$transaction
+			);
+			// waaaait... is this a PDT request? (see https://developer.paypal.com/docs/classic/products/payment-data-transfer/)
+			// indicated by the "tx" argument? If so, we don't need it. We'll just use the IPN data when it comes
+			if (isset($update_info['tx'])) {
+				return $transaction->last_payment();
+			} else {
+				return null;
+			}
+		}
+		$payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
+		if (! $payment instanceof EEI_Payment) {
+			$payment = $transaction->last_payment();
+		}
+		// ok, then validate the IPN. Even if we've already processed this payment,
+		// let PayPal know we don't want to hear from them anymore!
+		if (! $this->validate_ipn($update_info, $payment)) {
+			return $payment;
+		}
+		// kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
+		// registrations, ticket counts, etc)
+		if (
+			(
+				$update_info['payment_status'] === 'Refunded'
+				|| $update_info['payment_status'] === 'Partially_Refunded'
+			)
+			&& apply_filters('FHEE__EEG_Paypal_Standard__handle_payment_update__kill_refund_request', true)
+		) {
+			throw new EventEspresso\core\exceptions\IpnException(
+				sprintf(
+					esc_html__('Event Espresso does not yet support %1$s IPNs from PayPal', 'event_espresso'),
+					$update_info['payment_status']
+				),
+				EventEspresso\core\exceptions\IpnException::UNSUPPORTED,
+				null,
+				$payment,
+				$update_info
+			);
+		}
+		// ok, well let's process this payment then!
+		switch ($update_info['payment_status']) {
+			case 'Completed':
+				$status = $this->_pay_model->approved_status();
+				$gateway_response = esc_html__('The payment is approved.', 'event_espresso');
+				break;
+
+			case 'Pending':
+				$status = $this->_pay_model->pending_status();
+				$gateway_response = esc_html__(
+					'The payment is in progress. Another message will be sent when payment is approved.',
+					'event_espresso'
+				);
+				break;
+
+			case 'Denied':
+				$status = $this->_pay_model->declined_status();
+				$gateway_response = esc_html__('The payment has been declined.', 'event_espresso');
+				break;
+
+			case 'Expired':
+			case 'Failed':
+				$status = $this->_pay_model->failed_status();
+				$gateway_response = esc_html__('The payment failed for technical reasons or expired.', 'event_espresso');
+				break;
+
+			case 'Refunded':
+			case 'Partially_Refunded':
+				// even though it's a refund, we consider the payment as approved, it just has a negative value
+				$status = $this->_pay_model->approved_status();
+				$gateway_response = esc_html__(
+					'The payment has been refunded. Please update registrations accordingly.',
+					'event_espresso'
+				);
+				break;
+
+			case 'Voided':
+			case 'Reversed':
+			case 'Canceled_Reversal':
+			default:
+				$status = $this->_pay_model->cancelled_status();
+				$gateway_response = esc_html__(
+					'The payment was cancelled, reversed, or voided. Please update registrations accordingly.',
+					'event_espresso'
+				);
+				break;
+		}
+
+		// check if we've already processed this payment
+		if ($payment instanceof EEI_Payment) {
+			// payment exists. if this has the exact same status and amount, don't bother updating. just return
+			if ($payment->status() === $status && (float) $payment->amount() === (float) $update_info['mc_gross']) {
+				// DUPLICATED IPN! don't bother updating transaction
+				throw new IpnException(
+					sprintf(
+						esc_html__(
+							'It appears we have received a duplicate IPN from PayPal for payment %d',
+							'event_espresso'
+						),
+						$payment->ID()
+					),
+					IpnException::DUPLICATE,
+					null,
+					$payment,
+					$update_info
+				);
+			} else {
+				// new payment yippee !!!
+				$payment->set_status($status);
+				$payment->set_amount((float) $update_info['mc_gross']);
+				$payment->set_gateway_response($gateway_response);
+				$payment->set_details($update_info);
+				$payment->set_txn_id_chq_nmbr($update_info['txn_id']);
+				$this->log(
+					array(
+						'message'  => esc_html__(
+							'Updated payment either from IPN or as part of POST from PayPal',
+							'event_espresso'
+						),
+						'url'      => $this->_process_response_url(),
+						'payment'  => $payment->model_field_array(),
+						'IPN_data' => $update_info
+					),
+					$payment
+				);
+			}
+		}
+		do_action('FHEE__EEG_Paypal_Standard__handle_payment_update__payment_processed', $payment, $this);
+		return $payment;
+	}
+
+
+	/**
+	 * Validate the IPN notification.
+	 *
+	 * @param array                  $update_info like $_REQUEST
+	 * @param EE_Payment|EEI_Payment $payment
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function validate_ipn($update_info, $payment)
+	{
+		// allow us to skip validating IPNs with PayPal (useful for testing)
+		if (apply_filters('FHEE__EEG_Paypal_Standard__validate_ipn__skip', false)) {
+			return true;
+		}
+		// ...otherwise, we actually don't care what the $update_info is, we need to look
+		// at the request directly because we can't use $update_info because it has issues with quotes
+		// Reading POSTed data directly from $_POST causes serialization issues with array data in the POST.
+		// Instead, read raw POST data from the input stream.
+		// @see https://gist.github.com/xcommerce-gists/3440401
+		$raw_post_data = file_get_contents('php://input');
+		$raw_post_array = explode('&', $raw_post_data);
+		$update_info = array();
+		foreach ($raw_post_array as $keyval) {
+			$keyval = explode('=', $keyval);
+			if (count($keyval) === 2) {
+				$update_info[ $keyval[0] ] = urldecode($keyval[1]);
+			}
+		}
+		// read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
+		$req = 'cmd=_notify-validate';
+		$uses_get_magic_quotes = function_exists('get_magic_quotes_gpc') && get_magic_quotes_gpc() === 1
+			? true
+			: false;
+		foreach ($update_info as $key => $value) {
+			$value = $uses_get_magic_quotes ? urlencode(stripslashes($value)) : urlencode($value);
+			$req .= "&$key=$value";
+		}
+		// HTTP POST the complete, unaltered IPN back to PayPal
+		$response = wp_remote_post(
+			$this->_gateway_url,
+			array(
+				'body'              => $req,
+				'sslverify'         => false,
+				'timeout'           => 60,
+				// make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
+				// plz see: https://github.com/websharks/s2member/issues/610
+				'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
+				'httpversion'       => '1.1'
+			)
+		);
+		// then check the response
+		if (
+			array_key_exists('body', $response)
+			&& ! is_wp_error($response)
+			&& strcmp($response['body'], "VERIFIED") === 0
+		) {
+			return true;
+		}
+		// huh, something's wack... the IPN didn't validate. We must have replied to the IPN incorrectly,
+		// or their API must have changed: http://www.paypalobjects.com/en_US/ebook/PP_OrderManagement_IntegrationGuide/ipn.html
+		if ($response instanceof WP_Error) {
+			$error_msg = sprintf(
+				esc_html__('WP Error. Code: "%1$s", Message: "%2$s", Data: "%3$s"', 'event_espresso'),
+				$response->get_error_code(),
+				$response->get_error_message(),
+				print_r($response->get_error_data(), true)
+			);
+		} elseif (is_array($response) && isset($response['body'])) {
+			$error_msg = $response['body'];
+		} else {
+			$error_msg = print_r($response, true);
+		}
+		$payment->set_gateway_response(
+			sprintf(
+				esc_html__("IPN Validation failed! Paypal responded with '%s'", "event_espresso"),
+				$error_msg
+			)
+		);
+		$payment->set_details(array('REQUEST' => $update_info, 'VALIDATION_RESPONSE' => $response));
+		$payment->set_status(EEM_Payment::status_id_failed);
+		// log the results
+		$this->log(
+			array(
+				'url'     => $this->_process_response_url(),
+				'message' => $payment->gateway_response(),
+				'details' => $payment->details(),
+			),
+			$payment
+		);
+		return false;
+	}
+
+
+	/**
+	 * _process_response_url
+	 * @return string
+	 */
+	protected function _process_response_url()
+	{
+		if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= EEH_URL::filter_input_server_url();
+		} else {
+			$url = 'unknown';
+		}
+		return $url;
+	}
+
+
+	/**
+	 * Updates the transaction and line items based on the payment IPN data from PayPal,
+	 * like the taxes or shipping
+	 *
+	 * @param EEI_Payment $payment
+	 * @throws \EE_Error
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		$update_info = $payment->details();
+		/** @var EE_Transaction $transaction */
+		$transaction = $payment->transaction();
+		$payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
+		if (! $transaction) {
+			$this->log(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Payment with ID %d has no related transaction, and so update_txn_based_on_payment couldn\'t be executed properly',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$payment
+			);
+			return;
+		}
+		if (
+			! is_array($update_info)
+			|| ! isset($update_info['mc_shipping'])
+			|| ! isset($update_info['tax'])
+		) {
+			$this->log(
+				array(
+					'message' => esc_html__(
+						// @codingStandardsIgnoreStart
+						'Could not update transaction based on payment because the payment details have not yet been put on the payment. This normally happens during the IPN or returning from PayPal',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					'url'     => $this->_process_response_url(),
+					'payment' => $payment->model_field_array()
+				),
+				$payment
+			);
+			return;
+		}
+		if ($payment->status() !== $this->_pay_model->approved_status()) {
+			$this->log(
+				array(
+					'message' => esc_html__(
+						'We shouldn\'t update transactions taxes or shipping data from non-approved payments',
+						'event_espresso'
+					),
+					'url'     => $this->_process_response_url(),
+					'payment' => $payment->model_field_array()
+				),
+				$payment
+			);
+			return;
+		}
+		$grand_total_needs_resaving = false;
+		/** @var EE_Line_Item $transaction_total_line_item */
+		$transaction_total_line_item = $transaction->total_line_item();
+
+		// might paypal have changed the taxes?
+		if ($this->_paypal_taxes && $payment_was_itemized) {
+			// note that we're doing this BEFORE adding shipping;
+			// we actually want PayPal's shipping to remain non-taxable
+			$this->_line_item->set_line_items_taxable($transaction_total_line_item, true, 'paypal_shipping');
+			$this->_line_item->set_total_tax_to(
+				$transaction_total_line_item,
+				(float) $update_info['tax'],
+				esc_html__('Taxes', 'event_espresso'),
+				esc_html__('Calculated by Paypal', 'event_espresso'),
+				'paypal_tax'
+			);
+			$grand_total_needs_resaving = true;
+		}
+
+		$shipping_amount = (float) $update_info['mc_shipping'];
+		// might paypal have added shipping?
+		if ($this->_paypal_shipping && $shipping_amount && $payment_was_itemized) {
+			$this->_line_item->add_unrelated_item(
+				$transaction_total_line_item,
+				sprintf(esc_html__('Shipping for transaction %1$s', 'event_espresso'), $transaction->ID()),
+				$shipping_amount,
+				esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
+				1,
+				false,
+				'paypal_shipping_' . $transaction->ID()
+			);
+			$grand_total_needs_resaving = true;
+		}
+
+		if ($grand_total_needs_resaving) {
+			$transaction_total_line_item->save_this_and_descendants_to_txn($transaction->ID());
+			/** @var EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->update_registration_final_prices($transaction);
+		}
+		$this->log(
+			array(
+				'message'                     => esc_html__('Updated transaction related to payment', 'event_espresso'),
+				'url'                         => $this->_process_response_url(),
+				'transaction (updated)'       => $transaction->model_field_array(),
+				'payment (updated)'           => $payment->model_field_array(),
+				'use_paypal_shipping'         => $this->_paypal_shipping,
+				'use_paypal_tax'              => $this->_paypal_taxes,
+				'grand_total_needed_resaving' => $grand_total_needs_resaving,
+			),
+			$payment
+		);
+	}
 }

Spacing +30 added lines, -30 removed lines

@@ -137,17 +137,17 @@ 
                         $shipping_previously_added = $line_item->pretaxTotal();
                         continue;
                     }
-                    $redirect_args[ 'item_name_' . $item_num ] = substr(
+                    $redirect_args['item_name_'.$item_num] = substr(
                         $gateway_formatter->formatLineItemName($line_item, $payment),
                         0,
                         127
                     );
-                    $redirect_args[ 'amount_' . $item_num ] = $line_item->unit_price();
-                    $redirect_args[ 'quantity_' . $item_num ] = $line_item->quantity();
+                    $redirect_args['amount_'.$item_num] = $line_item->unit_price();
+                    $redirect_args['quantity_'.$item_num] = $line_item->quantity();
                     // if we're not letting PayPal calculate shipping, tell them its 0
-                    if (! $this->_paypal_shipping) {
-                        $redirect_args[ 'shipping_' . $item_num ] = '0';
-                        $redirect_args[ 'shipping2_' . $item_num ] = '0';
+                    if ( ! $this->_paypal_shipping) {
+                        $redirect_args['shipping_'.$item_num] = '0';
+                        $redirect_args['shipping2_'.$item_num] = '0';
                     }
                     $item_num++;
                     $itemized_sum += $line_item->pretaxTotal();
@@ -167,15 +167,15 @@ 
                 // itemized sum is too big
                 $total_discounts_to_cart_total += abs($itemized_sum_diff_from_txn_total);
             } elseif ($itemized_sum_diff_from_txn_total > 0) {
-                $redirect_args[ 'item_name_' . $item_num ] = substr(
+                $redirect_args['item_name_'.$item_num] = substr(
                     __('Other charges', 'event_espresso'),
                     0,
                     127
                 );
-                $redirect_args[ 'amount_' . $item_num ] = $gateway_formatter->formatCurrency(
+                $redirect_args['amount_'.$item_num] = $gateway_formatter->formatCurrency(
                     $itemized_sum_diff_from_txn_total
                 );
-                $redirect_args[ 'quantity_' . $item_num ] = 1;
+                $redirect_args['quantity_'.$item_num] = 1;
                 $item_num++;
             }
             if ($total_discounts_to_cart_total > 0) {
@@ -184,34 +184,34 @@ 
                 );
             }
             // add our taxes to the order if we're NOT using PayPal's
-            if (! $this->_paypal_taxes) {
+            if ( ! $this->_paypal_taxes) {
                 $redirect_args['tax_cart'] = $total_line_item->get_total_tax();
             }
         } else {
             $payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
             // partial payment that's not for the remaining amount, so we can't send an itemized list
-            $redirect_args[ 'item_name_' . $item_num ] = substr(
+            $redirect_args['item_name_'.$item_num] = substr(
                 $gateway_formatter->formatPartialPaymentLineItemName($payment),
                 0,
                 127
             );
-            $redirect_args[ 'amount_' . $item_num ] = $payment->amount();
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
+            $redirect_args['amount_'.$item_num] = $payment->amount();
+            $redirect_args['shipping_'.$item_num] = '0';
+            $redirect_args['shipping2_'.$item_num] = '0';
             $redirect_args['tax_cart'] = '0';
             $item_num++;
         }
 
         if ($this->_debug_mode) {
-            $redirect_args[ 'item_name_' . $item_num ] = 'DEBUG INFO (this item only added in sandbox mode';
-            $redirect_args[ 'amount_' . $item_num ] = 0;
-            $redirect_args[ 'on0_' . $item_num ] = 'NOTIFY URL';
-            $redirect_args[ 'os0_' . $item_num ] = $notify_url;
-            $redirect_args[ 'on1_' . $item_num ] = 'RETURN URL';
-            $redirect_args[ 'os1_' . $item_num ] = $return_url;
+            $redirect_args['item_name_'.$item_num] = 'DEBUG INFO (this item only added in sandbox mode';
+            $redirect_args['amount_'.$item_num] = 0;
+            $redirect_args['on0_'.$item_num] = 'NOTIFY URL';
+            $redirect_args['os0_'.$item_num] = $notify_url;
+            $redirect_args['on1_'.$item_num] = 'RETURN URL';
+            $redirect_args['os1_'.$item_num] = $return_url;
 //          $redirect_args['option_index_' . $item_num] = 1; // <-- dunno if this is needed ?
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
+            $redirect_args['shipping_'.$item_num] = '0';
+            $redirect_args['shipping2_'.$item_num] = '0';
         }
 
         $redirect_args['business'] = $this->_paypal_id;
@@ -221,12 +221,12 @@ 
         $redirect_args['cmd'] = '_cart';
         $redirect_args['upload'] = 1;
         $redirect_args['currency_code'] = $payment->currency_code();
-        $redirect_args['rm'] = 2;// makes the user return with method=POST
+        $redirect_args['rm'] = 2; // makes the user return with method=POST
         if ($this->_image_url) {
             $redirect_args['image_url'] = $this->_image_url;
         }
         $redirect_args['no_shipping'] = $this->_shipping_details;
-        $redirect_args['bn'] = 'EventEspresso_SP';// EE will blow up if you change this
+        $redirect_args['bn'] = 'EventEspresso_SP'; // EE will blow up if you change this
 
         $redirect_args = apply_filters("FHEE__EEG_Paypal_Standard__set_redirection_info__arguments", $redirect_args, $this);
 
@@ -281,12 +281,12 @@ 
             }
         }
         $payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment = $transaction->last_payment();
         }
         // ok, then validate the IPN. Even if we've already processed this payment,
         // let PayPal know we don't want to hear from them anymore!
-        if (! $this->validate_ipn($update_info, $payment)) {
+        if ( ! $this->validate_ipn($update_info, $payment)) {
             return $payment;
         }
         // kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
@@ -426,7 +426,7 @@ 
         foreach ($raw_post_array as $keyval) {
             $keyval = explode('=', $keyval);
             if (count($keyval) === 2) {
-                $update_info[ $keyval[0] ] = urldecode($keyval[1]);
+                $update_info[$keyval[0]] = urldecode($keyval[1]);
             }
         }
         // read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
@@ -447,7 +447,7 @@ 
                 'timeout'           => 60,
                 // make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
                 // plz see: https://github.com/websharks/s2member/issues/610
-                'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
+                'user-agent'        => 'Event Espresso v'.EVENT_ESPRESSO_VERSION.'; '.home_url(),
                 'httpversion'       => '1.1'
             )
         );
@@ -524,7 +524,7 @@ 
         /** @var EE_Transaction $transaction */
         $transaction = $payment->transaction();
         $payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
-        if (! $transaction) {
+        if ( ! $transaction) {
             $this->log(
                 esc_html__(
                     // @codingStandardsIgnoreStart
@@ -599,7 +599,7 @@ 
                 esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
                 1,
                 false,
-                'paypal_shipping_' . $transaction->ID()
+                'paypal_shipping_'.$transaction->ID()
             );
             $grand_total_needs_resaving = true;
         }