eventespresso / event-espresso-core

core/libraries/payment_methods/EE_Gateway.lib.php

Spacing +5 added lines, -5 removed lines

@@ -187,7 +187,7 @@ 
     public function set_settings($settings_array)
     {
         foreach ($settings_array as $name => $value) {
-            $property_name = "_" . $name;
+            $property_name = "_".$name;
             $this->{$property_name} = $value;
         }
     }
@@ -251,7 +251,7 @@ 
      */
     public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
     {
-        if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+        if ( ! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
             throw new InvalidEntityException(
                 is_object($gateway_data_formatter)
                     ? get_class($gateway_data_formatter)
@@ -270,7 +270,7 @@ 
      */
     protected function _get_gateway_formatter()
     {
-        if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+        if ( ! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
             throw new InvalidEntityException(
                 is_object($this->_gateway_data_formatter)
                     ? get_class($this->_gateway_data_formatter)
@@ -291,7 +291,7 @@ 
      */
     public function set_unsupported_character_remover(FormatterInterface $formatter)
     {
-        if (! $formatter instanceof FormatterInterface) {
+        if ( ! $formatter instanceof FormatterInterface) {
             throw new InvalidEntityException(
                 is_object($formatter)
                     ? get_class($formatter)
@@ -310,7 +310,7 @@ 
      */
     protected function _get_unsupported_character_remover()
     {
-        if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
+        if ( ! $this->_unsupported_character_remover instanceof FormatterInterface) {
             throw new InvalidEntityException(
                 is_object($this->_unsupported_character_remover)
                     ? get_class($this->_unsupported_character_remover)

Indentation +491 added lines, -491 removed lines

@@ -23,495 +23,495 @@
  */
 abstract class EE_Gateway
 {
-    /**
-     * a constant used as a possible value for $_currencies_supported to indicate
-     * that ALL currencies are supported by this gateway
-     */
-    const all_currencies_supported = 'all_currencies_supported';
-    /**
-     * Where values are 3-letter currency codes
-     *
-     * @var array
-     */
-    protected $_currencies_supported = array();
-    /**
-     * Whether or not this gateway can support SENDING a refund request (ie, initiated by
-     * admin in EE's wp-admin page)
-     *
-     * @var boolean
-     */
-    protected $_supports_sending_refunds = false;
-
-    /**
-     * Whether or not this gateway can support RECEIVING a refund request from the payment
-     * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
-     *
-     * @var boolean
-     */
-    protected $_supports_receiving_refunds = false;
-    /**
-     * Model for querying for existing payments
-     *
-     * @var EEMI_Payment
-     */
-    protected $_pay_model;
-
-    /**
-     * Model used for adding to the payments log
-     *
-     * @var EEMI_Payment_Log
-     */
-    protected $_pay_log;
-
-    /**
-     * Used for formatting some input to gateways
-     *
-     * @var EEHI_Template
-     */
-    protected $_template;
-
-    /**
-     * Concrete class that implements EEHI_Money, used by most gateways
-     *
-     * @var EEHI_Money
-     */
-    protected $_money;
-
-    /**
-     * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
-     *
-     * @var EEHI_Line_Item
-     */
-    protected $_line_item;
-
-    /**
-     * @var GatewayDataFormatterInterface
-     */
-    protected $_gateway_data_formatter;
-
-    /**
-     * @var FormatterInterface
-     */
-    protected $_unsupported_character_remover;
-
-    /**
-     * The ID of the payment method using this gateway
-     *
-     * @var int
-     */
-    protected $_ID;
-
-    /**
-     * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
-     */
-    protected $_debug_mode;
-    /**
-     *
-     * @var string $_name name to show for this payment method
-     */
-    protected $_name;
-    /**
-     *
-     * @var string name to show fir this payment method to admin-type users
-     */
-    protected $_admin_name;
-
-    /**
-     * @return EE_Gateway
-     */
-    public function __construct()
-    {
-    }
-
-    /**
-     * We don't want to serialize models as they often have circular structures
-     * (eg a payment model has a reference to each payment model object; and most
-     * payments have a transaction, most transactions have a payment method;
-     * most payment methods have a payment method type; most payment method types
-     * have a gateway. And if a gateway serializes its models, we start at the
-     * beginning again)
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_pay_model'], $properties['_pay_log']);
-        return array_keys($properties);
-    }
-
-    /**
-     * Returns whether or not this gateway should support SENDING refunds
-     * see $_supports_sending_refunds
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        return $this->_supports_sending_refunds;
-    }
-
-    /**
-     * Returns whether or not this gateway should support RECEIVING refunds
-     * see $_supports_receiving_refunds
-     *
-     * @return boolean
-     */
-    public function supports_receiving_refunds()
-    {
-        return $this->_supports_receiving_refunds;
-    }
-
-
-    /**
-     * Tries to refund the payment specified, taking into account the extra
-     * refund info. Note that if the gateway's _supports_sending_refunds is false,
-     * this should just throw an exception.
-     *
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @return EE_Payment for the refund
-     * @throws EE_Error
-     */
-    public function do_direct_refund(EE_Payment $payment, $refund_info = null)
-    {
-        return null;
-    }
-
-
-    /**
-     * Sets the payment method's settings so the gateway knows where to send the request
-     * etc
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        foreach ($settings_array as $name => $value) {
-            $property_name = "_" . $name;
-            $this->{$property_name} = $value;
-        }
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment $payment_model
-     */
-    public function set_payment_model($payment_model)
-    {
-        $this->_pay_model = $payment_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment_Log $payment_log_model
-     */
-    public function set_payment_log($payment_log_model)
-    {
-        $this->_pay_log = $payment_log_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Template $template_helper
-     */
-    public function set_template_helper($template_helper)
-    {
-        $this->_template = $template_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Line_Item $line_item_helper
-     */
-    public function set_line_item_helper($line_item_helper)
-    {
-        $this->_line_item = $line_item_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Money $money_helper
-     */
-    public function set_money_helper($money_helper)
-    {
-        $this->_money = $money_helper;
-    }
-
-
-    /**
-     * Sets the gateway data formatter helper
-     *
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
-     * @throws InvalidEntityException if it's not set properly
-     */
-    public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
-    {
-        if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($gateway_data_formatter)
-                    ? get_class($gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        $this->_gateway_data_formatter = $gateway_data_formatter;
-    }
-
-    /**
-     * Gets the gateway data formatter
-     *
-     * @return GatewayDataFormatterInterface
-     * @throws InvalidEntityException if it's not set properly
-     */
-    protected function _get_gateway_formatter()
-    {
-        if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_gateway_data_formatter)
-                    ? get_class($this->_gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        return $this->_gateway_data_formatter;
-    }
-
-
-    /**
-     * Sets the helper which will remove unsupported characters for most gateways
-     *
-     * @param FormatterInterface $formatter
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    public function set_unsupported_character_remover(FormatterInterface $formatter)
-    {
-        if (! $formatter instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($formatter)
-                    ? get_class($formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        $this->_unsupported_character_remover = $formatter;
-    }
-
-    /**
-     * Gets the helper which removes characters which gateways might not support, like emojis etc.
-     *
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    protected function _get_unsupported_character_remover()
-    {
-        if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_unsupported_character_remover)
-                    ? get_class($this->_unsupported_character_remover)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        return $this->_unsupported_character_remover;
-    }
-
-
-    /**
-     * @param $message
-     * @param $payment
-     */
-    public function log($message, $object_logged)
-    {
-        if ($object_logged instanceof EEI_Payment) {
-            $type = 'Payment';
-            $id = $object_logged->ID();
-        } elseif ($object_logged instanceof EEI_Transaction) {
-            $type = 'Transaction';
-            $id = $object_logged->ID();
-        } else {
-            $type = 'Payment_Method';
-            $id = $this->_ID;
-        }
-        // only log if we're going to store it for longer than the minimum time
-        $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-        if ($reg_config->gateway_log_lifespan !== '1 second') {
-            $this->_pay_log->gateway_log($message, $id, $type);
-        }
-    }
-
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     * @deprecated since 4.9.31 insetad use
-     *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
-     */
-    public function format_currency($amount)
-    {
-        return $this->_get_gateway_formatter()->formatCurrency($amount);
-    }
-
-    /**
-     * Returns either an array of all the currency codes supported,
-     * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
-     *
-     * @return mixed array or string
-     */
-    public function currencies_supported()
-    {
-        return $this->_currencies_supported;
-    }
-
-    /**
-     * Returns what a simple summing of items and taxes for this transaction. This
-     * can be used to determine if some more complex line items, like promotions,
-     * surcharges, or cancellations occurred (in which case we might want to forget
-     * about creating an itemized list of purchases and instead only send the total due)
-     *
-     * @param EE_Transaction $transaction
-     * @return float
-     */
-    protected function _sum_items_and_taxes(EE_Transaction $transaction)
-    {
-        $total_line_item = $transaction->total_line_item();
-        $total = 0;
-        foreach ($total_line_item->get_items() as $item_line_item) {
-            $total += max($item_line_item->total(), 0);
-        }
-        foreach ($total_line_item->tax_descendants() as $tax_line_item) {
-            $total += max($tax_line_item->total(), 0);
-        }
-        return $total;
-    }
-
-    /**
-     * Determines whether or not we can easily itemize the transaction using only
-     * items and taxes (ie, no promotions or surcharges or cancellations needed)
-     *
-     * @param EEI_Payment $payment
-     * @return boolean
-     */
-    protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
-    {
-        return $this->_money->compare_floats(
-            $this->_sum_items_and_taxes($payment->transaction()),
-            $payment->transaction()->total()
-        )
-               && $this->_money->compare_floats(
-                   $payment->amount(),
-                   $payment->transaction()->total()
-               );
-    }
-
-    /**
-     * Handles updating the transaction and any other related data based on the payment.
-     * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
-     * but doing so on those functions might be too early. It's possible that the changes
-     * you make to teh transaction or registration or line items may just get overwritten
-     * at that point. Instead, you should store any info you need on the payment during those
-     * functions, and use that information at this step, which client code will decide
-     * for you when it should be called.
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        // maybe update the transaction or line items or registrations
-        // but most gateways don't need to do this, because they only update the payment
-    }
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @param EEI_Payment $payment
-     * @return EEI_Event|null
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
-     */
-    protected function _get_first_event_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event();
-    }
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
-     */
-    protected function _get_first_event_name_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event_name();
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
-     * @param EE_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
-    }
-
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
-    }
-
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
-    }
-
-    /**
-     * Gets the order description that should generlly be sent to gateways
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
-     * @param EEI_Payment $payment
-     * @return type
-     */
-    protected function _format_order_description(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatOrderDescription($payment);
-    }
+	/**
+	 * a constant used as a possible value for $_currencies_supported to indicate
+	 * that ALL currencies are supported by this gateway
+	 */
+	const all_currencies_supported = 'all_currencies_supported';
+	/**
+	 * Where values are 3-letter currency codes
+	 *
+	 * @var array
+	 */
+	protected $_currencies_supported = array();
+	/**
+	 * Whether or not this gateway can support SENDING a refund request (ie, initiated by
+	 * admin in EE's wp-admin page)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_sending_refunds = false;
+
+	/**
+	 * Whether or not this gateway can support RECEIVING a refund request from the payment
+	 * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_receiving_refunds = false;
+	/**
+	 * Model for querying for existing payments
+	 *
+	 * @var EEMI_Payment
+	 */
+	protected $_pay_model;
+
+	/**
+	 * Model used for adding to the payments log
+	 *
+	 * @var EEMI_Payment_Log
+	 */
+	protected $_pay_log;
+
+	/**
+	 * Used for formatting some input to gateways
+	 *
+	 * @var EEHI_Template
+	 */
+	protected $_template;
+
+	/**
+	 * Concrete class that implements EEHI_Money, used by most gateways
+	 *
+	 * @var EEHI_Money
+	 */
+	protected $_money;
+
+	/**
+	 * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
+	 *
+	 * @var EEHI_Line_Item
+	 */
+	protected $_line_item;
+
+	/**
+	 * @var GatewayDataFormatterInterface
+	 */
+	protected $_gateway_data_formatter;
+
+	/**
+	 * @var FormatterInterface
+	 */
+	protected $_unsupported_character_remover;
+
+	/**
+	 * The ID of the payment method using this gateway
+	 *
+	 * @var int
+	 */
+	protected $_ID;
+
+	/**
+	 * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
+	 */
+	protected $_debug_mode;
+	/**
+	 *
+	 * @var string $_name name to show for this payment method
+	 */
+	protected $_name;
+	/**
+	 *
+	 * @var string name to show fir this payment method to admin-type users
+	 */
+	protected $_admin_name;
+
+	/**
+	 * @return EE_Gateway
+	 */
+	public function __construct()
+	{
+	}
+
+	/**
+	 * We don't want to serialize models as they often have circular structures
+	 * (eg a payment model has a reference to each payment model object; and most
+	 * payments have a transaction, most transactions have a payment method;
+	 * most payment methods have a payment method type; most payment method types
+	 * have a gateway. And if a gateway serializes its models, we start at the
+	 * beginning again)
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_pay_model'], $properties['_pay_log']);
+		return array_keys($properties);
+	}
+
+	/**
+	 * Returns whether or not this gateway should support SENDING refunds
+	 * see $_supports_sending_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		return $this->_supports_sending_refunds;
+	}
+
+	/**
+	 * Returns whether or not this gateway should support RECEIVING refunds
+	 * see $_supports_receiving_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_receiving_refunds()
+	{
+		return $this->_supports_receiving_refunds;
+	}
+
+
+	/**
+	 * Tries to refund the payment specified, taking into account the extra
+	 * refund info. Note that if the gateway's _supports_sending_refunds is false,
+	 * this should just throw an exception.
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @return EE_Payment for the refund
+	 * @throws EE_Error
+	 */
+	public function do_direct_refund(EE_Payment $payment, $refund_info = null)
+	{
+		return null;
+	}
+
+
+	/**
+	 * Sets the payment method's settings so the gateway knows where to send the request
+	 * etc
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		foreach ($settings_array as $name => $value) {
+			$property_name = "_" . $name;
+			$this->{$property_name} = $value;
+		}
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment $payment_model
+	 */
+	public function set_payment_model($payment_model)
+	{
+		$this->_pay_model = $payment_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment_Log $payment_log_model
+	 */
+	public function set_payment_log($payment_log_model)
+	{
+		$this->_pay_log = $payment_log_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Template $template_helper
+	 */
+	public function set_template_helper($template_helper)
+	{
+		$this->_template = $template_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Line_Item $line_item_helper
+	 */
+	public function set_line_item_helper($line_item_helper)
+	{
+		$this->_line_item = $line_item_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Money $money_helper
+	 */
+	public function set_money_helper($money_helper)
+	{
+		$this->_money = $money_helper;
+	}
+
+
+	/**
+	 * Sets the gateway data formatter helper
+	 *
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
+	{
+		if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($gateway_data_formatter)
+					? get_class($gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		$this->_gateway_data_formatter = $gateway_data_formatter;
+	}
+
+	/**
+	 * Gets the gateway data formatter
+	 *
+	 * @return GatewayDataFormatterInterface
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	protected function _get_gateway_formatter()
+	{
+		if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_gateway_data_formatter)
+					? get_class($this->_gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		return $this->_gateway_data_formatter;
+	}
+
+
+	/**
+	 * Sets the helper which will remove unsupported characters for most gateways
+	 *
+	 * @param FormatterInterface $formatter
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	public function set_unsupported_character_remover(FormatterInterface $formatter)
+	{
+		if (! $formatter instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($formatter)
+					? get_class($formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		$this->_unsupported_character_remover = $formatter;
+	}
+
+	/**
+	 * Gets the helper which removes characters which gateways might not support, like emojis etc.
+	 *
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	protected function _get_unsupported_character_remover()
+	{
+		if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_unsupported_character_remover)
+					? get_class($this->_unsupported_character_remover)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		return $this->_unsupported_character_remover;
+	}
+
+
+	/**
+	 * @param $message
+	 * @param $payment
+	 */
+	public function log($message, $object_logged)
+	{
+		if ($object_logged instanceof EEI_Payment) {
+			$type = 'Payment';
+			$id = $object_logged->ID();
+		} elseif ($object_logged instanceof EEI_Transaction) {
+			$type = 'Transaction';
+			$id = $object_logged->ID();
+		} else {
+			$type = 'Payment_Method';
+			$id = $this->_ID;
+		}
+		// only log if we're going to store it for longer than the minimum time
+		$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+		if ($reg_config->gateway_log_lifespan !== '1 second') {
+			$this->_pay_log->gateway_log($message, $id, $type);
+		}
+	}
+
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 * @deprecated since 4.9.31 insetad use
+	 *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
+	 */
+	public function format_currency($amount)
+	{
+		return $this->_get_gateway_formatter()->formatCurrency($amount);
+	}
+
+	/**
+	 * Returns either an array of all the currency codes supported,
+	 * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
+	 *
+	 * @return mixed array or string
+	 */
+	public function currencies_supported()
+	{
+		return $this->_currencies_supported;
+	}
+
+	/**
+	 * Returns what a simple summing of items and taxes for this transaction. This
+	 * can be used to determine if some more complex line items, like promotions,
+	 * surcharges, or cancellations occurred (in which case we might want to forget
+	 * about creating an itemized list of purchases and instead only send the total due)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return float
+	 */
+	protected function _sum_items_and_taxes(EE_Transaction $transaction)
+	{
+		$total_line_item = $transaction->total_line_item();
+		$total = 0;
+		foreach ($total_line_item->get_items() as $item_line_item) {
+			$total += max($item_line_item->total(), 0);
+		}
+		foreach ($total_line_item->tax_descendants() as $tax_line_item) {
+			$total += max($tax_line_item->total(), 0);
+		}
+		return $total;
+	}
+
+	/**
+	 * Determines whether or not we can easily itemize the transaction using only
+	 * items and taxes (ie, no promotions or surcharges or cancellations needed)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return boolean
+	 */
+	protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
+	{
+		return $this->_money->compare_floats(
+			$this->_sum_items_and_taxes($payment->transaction()),
+			$payment->transaction()->total()
+		)
+			   && $this->_money->compare_floats(
+				   $payment->amount(),
+				   $payment->transaction()->total()
+			   );
+	}
+
+	/**
+	 * Handles updating the transaction and any other related data based on the payment.
+	 * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
+	 * but doing so on those functions might be too early. It's possible that the changes
+	 * you make to teh transaction or registration or line items may just get overwritten
+	 * at that point. Instead, you should store any info you need on the payment during those
+	 * functions, and use that information at this step, which client code will decide
+	 * for you when it should be called.
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		// maybe update the transaction or line items or registrations
+		// but most gateways don't need to do this, because they only update the payment
+	}
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return EEI_Event|null
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
+	 */
+	protected function _get_first_event_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event();
+	}
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
+	 */
+	protected function _get_first_event_name_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event_name();
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
+	}
+
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
+	}
+
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
+	}
+
+	/**
+	 * Gets the order description that should generlly be sent to gateways
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
+	 * @param EEI_Payment $payment
+	 * @return type
+	 */
+	protected function _format_order_description(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatOrderDescription($payment);
+	}
 }

core/libraries/payment_methods/EE_Offsite_Gateway.lib.php

Indentation +102 added lines, -102 removed lines

@@ -15,117 +15,117 @@
 abstract class EE_Offsite_Gateway extends EE_Gateway
 {
 
-    /**
-     * whether or not the gateway uses an IPN
-     * that is sent in a separate request than the returning registrant.
-     * if false, then we need to process the payment results manually
-     * as soon as the registrant returns from the off-site gateway
-     *
-     * @type bool
-     */
-    protected $_uses_separate_IPN_request = false;
+	/**
+	 * whether or not the gateway uses an IPN
+	 * that is sent in a separate request than the returning registrant.
+	 * if false, then we need to process the payment results manually
+	 * as soon as the registrant returns from the off-site gateway
+	 *
+	 * @type bool
+	 */
+	protected $_uses_separate_IPN_request = false;
 
 
-    /**
-     * @return EE_Offsite_Gateway
-     */
-    public function __construct()
-    {
-        $this->_supports_receiving_refunds = true;
-        parent::__construct();
-    }
+	/**
+	 * @return EE_Offsite_Gateway
+	 */
+	public function __construct()
+	{
+		$this->_supports_receiving_refunds = true;
+		parent::__construct();
+	}
 
 
-    /**
-     * Adds information into the payment object's redirect_url and redirect_args so
-     * client code can use that payment to know where (and with what information)
-     * to redirect the user to in order to make the payment on the offsite gateway's website.
-     * Saving the payment from within this method is unnecessary,
-     * as it is the responsibility of client code to save it.
-     *
-     * @param EE_Payment $payment    to process
-     * @param array      $billing_info
-     * @param string     $return_url URL to send the user to after a successful 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 teh payment
-     *                               provider's website
-     * @return EE_Payment
-     */
-    abstract public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    );
+	/**
+	 * Adds information into the payment object's redirect_url and redirect_args so
+	 * client code can use that payment to know where (and with what information)
+	 * to redirect the user to in order to make the payment on the offsite gateway's website.
+	 * Saving the payment from within this method is unnecessary,
+	 * as it is the responsibility of client code to save it.
+	 *
+	 * @param EE_Payment $payment    to process
+	 * @param array      $billing_info
+	 * @param string     $return_url URL to send the user to after a successful 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 teh payment
+	 *                               provider's website
+	 * @return EE_Payment
+	 */
+	abstract public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	);
 
 
-    /**
-     * 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. Saving the payment from within this method is unnecessary,
-     * as it is the responsibility of client code to save it.
-     *
-     * @param array           $update_info of whatever
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment updated
-     */
-    abstract public function handle_payment_update($update_info, $transaction);
+	/**
+	 * 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. Saving the payment from within this method is unnecessary,
+	 * as it is the responsibility of client code to save it.
+	 *
+	 * @param array           $update_info of whatever
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment updated
+	 */
+	abstract public function handle_payment_update($update_info, $transaction);
 
 
-    /**
-     * uses_separate_IPN_request
-     *
-     * return true or false for whether or not the gateway uses an IPN
-     * that is sent in a separate request than the returning registrant.
-     * if false, then we need to process the payment results manually
-     * as soon as the registrant returns from the off-site gateway
-     *
-     * @deprecated since version 4.8.39.rc.001 please use handle_IPN_in_this_request() instead
-     *
-     * @return bool
-     */
-    public function uses_separate_IPN_request()
-    {
-        return $this->_uses_separate_IPN_request;
-    }
+	/**
+	 * uses_separate_IPN_request
+	 *
+	 * return true or false for whether or not the gateway uses an IPN
+	 * that is sent in a separate request than the returning registrant.
+	 * if false, then we need to process the payment results manually
+	 * as soon as the registrant returns from the off-site gateway
+	 *
+	 * @deprecated since version 4.8.39.rc.001 please use handle_IPN_in_this_request() instead
+	 *
+	 * @return bool
+	 */
+	public function uses_separate_IPN_request()
+	{
+		return $this->_uses_separate_IPN_request;
+	}
 
 
-    /**
-     * set_uses_separate_IPN_request
-     *
-     * @access protected
-     * @param boolean $uses_separate_IPN_request
-     */
-    protected function set_uses_separate_IPN_request($uses_separate_IPN_request)
-    {
-        $this->_uses_separate_IPN_request = filter_var($uses_separate_IPN_request, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * set_uses_separate_IPN_request
+	 *
+	 * @access protected
+	 * @param boolean $uses_separate_IPN_request
+	 */
+	protected function set_uses_separate_IPN_request($uses_separate_IPN_request)
+	{
+		$this->_uses_separate_IPN_request = filter_var($uses_separate_IPN_request, FILTER_VALIDATE_BOOLEAN);
+	}
 
-    /**
-     * Allows gateway to dynamically decide whether or not to handle a payment update
-     * by overriding this method. By default, if this is a "true" IPN (meaning
-     * it's a separate request from when the user returns from the offsite gateway)
-     * and this gateway class is setup to handle IPNs in separate "true" IPNs, then
-     * this will return true, otherwise it will return false.
-     * If however, this is a request when the user is returning
-     * from an offsite gateway, and this gateway class is setup to process the payment
-     * data when the user returns, then this will return true.
-     *
-     * @param array   $request_data
-     * @param boolean $separate_IPN_request
-     * @return boolean
-     */
-    public function handle_IPN_in_this_request($request_data, $separate_IPN_request)
-    {
-        if ($separate_IPN_request) {
-            // payment data being sent in a request separate from the user
-            // it is this other request that will update the TXN and payment info
-            return $this->_uses_separate_IPN_request;
-        } else {
-            // it's a request where the user returned from an offsite gateway WITH the payment data
-            return ! $this->_uses_separate_IPN_request;
-        }
-    }
+	/**
+	 * Allows gateway to dynamically decide whether or not to handle a payment update
+	 * by overriding this method. By default, if this is a "true" IPN (meaning
+	 * it's a separate request from when the user returns from the offsite gateway)
+	 * and this gateway class is setup to handle IPNs in separate "true" IPNs, then
+	 * this will return true, otherwise it will return false.
+	 * If however, this is a request when the user is returning
+	 * from an offsite gateway, and this gateway class is setup to process the payment
+	 * data when the user returns, then this will return true.
+	 *
+	 * @param array   $request_data
+	 * @param boolean $separate_IPN_request
+	 * @return boolean
+	 */
+	public function handle_IPN_in_this_request($request_data, $separate_IPN_request)
+	{
+		if ($separate_IPN_request) {
+			// payment data being sent in a request separate from the user
+			// it is this other request that will update the TXN and payment info
+			return $this->_uses_separate_IPN_request;
+		} else {
+			// it's a request where the user returned from an offsite gateway WITH the payment data
+			return ! $this->_uses_separate_IPN_request;
+		}
+	}
 }

core/libraries/payment_methods/EE_Onsite_Gateway.lib.php

Indentation +31 added lines, -31 removed lines

@@ -15,36 +15,36 @@
 abstract class EE_Onsite_Gateway extends EE_Gateway
 {
 
-    /**
-     * @return EE_Onsite_Gateway
-     */
-    public function __construct()
-    {
-        $this->_supports_sending_refunds = true;
-        parent::__construct();
-    }
+	/**
+	 * @return EE_Onsite_Gateway
+	 */
+	public function __construct()
+	{
+		$this->_supports_sending_refunds = true;
+		parent::__construct();
+	}
 
-    /**
-     * Asks the gateway to do whatever it does to process the payment. Onsite gateways will
-     * usually send a request directly to the payment provider and update the payment's status based on that;
-     * whereas offsite gateways will usually just update the payment with the URL and query parameters to use
-     * for sending the request via http_remote_request(). Saving the payment from within this method is unnecessary,
-     * as it is the responsibility of client code to save it.
-     *
-     * @param EEI_Payment $payment
-     * @param array       $billing_info {
-     * @type              $first_name   string
-     * @type              $last_name    string
-     * @type              $email        string
-     * @type              $address      string
-     * @type              $address2     string
-     * @type              $city         string
-     * @type              $state        string name of the state (NOT int)
-     * @type              $country      string 2-character ISO code see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
-     * @type              $zip          string
-     * @type              $phone        string
-     *                                  } unless a child class specifies these array keys are NOT present
-     * @return EE_Payment updated
-     */
-    abstract public function do_direct_payment($payment, $billing_info = null);
+	/**
+	 * Asks the gateway to do whatever it does to process the payment. Onsite gateways will
+	 * usually send a request directly to the payment provider and update the payment's status based on that;
+	 * whereas offsite gateways will usually just update the payment with the URL and query parameters to use
+	 * for sending the request via http_remote_request(). Saving the payment from within this method is unnecessary,
+	 * as it is the responsibility of client code to save it.
+	 *
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info {
+	 * @type              $first_name   string
+	 * @type              $last_name    string
+	 * @type              $email        string
+	 * @type              $address      string
+	 * @type              $address2     string
+	 * @type              $city         string
+	 * @type              $state        string name of the state (NOT int)
+	 * @type              $country      string 2-character ISO code see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+	 * @type              $zip          string
+	 * @type              $phone        string
+	 *                                  } unless a child class specifies these array keys are NOT present
+	 * @return EE_Payment updated
+	 */
+	abstract public function do_direct_payment($payment, $billing_info = null);
 }

core/libraries/payment_methods/templates/payment_details_content.template.php

Indentation +2 added lines, -2 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * payment_details_content
@@ -10,5 +10,5 @@ 
  */
 $gateway_response = $payment->gateway_response();
 if (! empty($gateway_response)) {
-    echo '<span class="error payment-problem">' . $gateway_response . '</span>';
+	echo '<span class="error payment-problem">' . $gateway_response . '</span>';
 }

Spacing +3 added lines, -3 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 /**
@@ -9,6 +9,6 @@ 
  * @var EE_Payment_Method $payment_method
  */
 $gateway_response = $payment->gateway_response();
-if (! empty($gateway_response)) {
-    echo '<span class="error payment-problem">' . $gateway_response . '</span>';
+if ( ! empty($gateway_response)) {
+    echo '<span class="error payment-problem">'.$gateway_response.'</span>';
 }

core/libraries/line_item_display/EE_Receipt_Line_Item_Display_Strategy.strategy.php

Indentation +57 added lines, -57 removed lines

@@ -14,88 +14,88 @@
  * ------------------------------------------------------------------------
  */
  /**
- *
- * Class EE_Receipt_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Receipt_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 
 class EE_Receipt_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
+	/**
+	 * @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,
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_separator_row( $options );
 //              $html .= $this->_total_row( $line_item, __('Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+			case EEM_Line_Item::type_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_total_row( $line_item, __('Sub-Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_tax_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+			case EEM_Line_Item::type_tax_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_total_row( $line_item, __('Tax Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_line_item:
-                // item row
+			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) {
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
 //                  $this->display_line_item( $child_line_item, $options );
-                }
-                break;
+				}
+				break;
 
 
-            case EEM_Line_Item::type_sub_line_item:
+			case EEM_Line_Item::type_sub_line_item:
 //              $html .= $this->_sub_item_row( $line_item, $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_tax:
 //              $html .= $this->_tax_row( $line_item, $options );
-                break;
-        }
+				break;
+		}
 
-        return $html;
-    }
+		return $html;
+	}
 }

core/libraries/line_item_display/EE_Admin_Table_Registration_Line_Item_Display_Strategy.strategy.php

Spacing +11 added lines, -11 removed lines

@@ -71,22 +71,22 @@ 
 
         $name_html = $line_item_related_object instanceof EEI_Line_Item_Object
             ? $line_item_related_object->name() : $line_item->name();
-        $name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>'
+        $name_html = $name_link ? '<a href="'.$name_link.'">'.$name_html.'</a>'
             : $name_html;
         $name_html .= $line_item->is_taxable() ? ' *' : '';
         // maybe preface with icon?
         $name_html = $line_item_related_object instanceof EEI_Has_Icon
-            ? $line_item_related_object->get_icon() . $name_html
+            ? $line_item_related_object->get_icon().$name_html
             : $name_html;
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
-        $name_html .=  sprintf(
+        $name_html = '<span class="ee-line-item-name linked">'.$name_html.'</span><br>';
+        $name_html .= sprintf(
             _x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
             '<span class="ee-line-item-related-parent-object">',
             $line_item->parent() instanceof EE_Line_Item
                 ? $line_item->parent()->OBJ_type_i18n()
                 : __('Item:', 'event_espresso'),
             $parent_related_object_link
-                ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
+                ? '<a href="'.$parent_related_object_link.'">'.$parent_related_object_name.'</a>'
                 : $parent_related_object_name,
             '</span>'
         );
@@ -96,7 +96,7 @@ 
         $type_html .= $this->_get_cancellations($line_item);
         $type_html .= $line_item->OBJ_type() ? '<br />' : '';
         $code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
-        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
+        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">'.sprintf(__('Code: %s', 'event_espresso'), $code).'</span>' : '';
         $html .= EEH_HTML::td($type_html, '', 'jst-left');
 
         // Date column
@@ -105,7 +105,7 @@ 
             $datetimes = $line_item_related_object->datetimes();
             foreach ($datetimes as $datetime) {
                 if ($datetime instanceof EE_Datetime) {
-                    $datetime_content .= $datetime->get_dtt_display_name() . '<br>';
+                    $datetime_content .= $datetime->get_dtt_display_name().'<br>';
                 }
             }
         }
@@ -113,7 +113,7 @@ 
 
         // Amount Column
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'jst-rght');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
         }
@@ -138,7 +138,7 @@ 
         // start of row
         $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
         // name th
-        $html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="3"');
+        $html .= EEH_HTML::th($line_item->name().'('.$line_item->get_pretty('LIN_percent').'%)', '', 'jst-rght', '', ' colspan="3"');
         // total th
         $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
         // end of row
@@ -171,9 +171,9 @@ 
         $html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
         // Total th label
         if ($total_match) {
-            $total_label = sprintf(__('This registration\'s total %s:', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+            $total_label = sprintf(__('This registration\'s total %s:', 'event_espresso'), '('.EE_Registry::instance()->CFG->currency->code.')');
         } else {
-            $total_label = sprintf(__('This registration\'s approximate total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+            $total_label = sprintf(__('This registration\'s approximate total %s', 'event_espresso'), '('.EE_Registry::instance()->CFG->currency->code.')');
             $total_label .= '<br>';
             $total_label .= '<p class="ee-footnote-text">'
                             . sprintf(

Indentation +187 added lines, -187 removed lines

@@ -14,191 +14,191 @@
 class EE_Admin_Table_Registration_Line_Item_Display_Strategy extends EE_Admin_Table_Line_Item_Display_Strategy
 {
 
-    /**
-     * Table header for display.
-     * @since   4.8
-     * @param array $options
-     * @return string
-     */
-    protected function _table_header($options)
-    {
-        $html = EEH_HTML::table('', '', $options['table_css_class']);
-        $html .= EEH_HTML::thead();
-        $html .= EEH_HTML::tr();
-        $html .= EEH_HTML::th(__('Name', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(__('Type', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(__('Date(s)', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(__('Amount', 'event_espresso'), '', 'jst-cntr');
-        $html .= EEH_HTML::tbody();
-        return $html;
-    }
-
-
-
-
-
-    /**
-     *    _item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        $line_item_related_object = $line_item->get_object();
-        $parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item
-            ? $line_item->parent()->get_object()
-            : null;
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-
-
-        // Name Column
-        $name_link = $line_item_related_object instanceof EEI_Admin_Links ? $line_item_related_object->get_admin_details_link() : '';
-
-        // related object scope.
-        $parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object
-            ? $parent_line_item_related_object->name()
-            : '';
-        $parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item
-            ? $line_item->parent()->name()
-            : $parent_related_object_name;
-        $parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links
-            ? $parent_line_item_related_object->get_admin_details_link()
-            : '';
-
-
-        $name_html = $line_item_related_object instanceof EEI_Line_Item_Object
-            ? $line_item_related_object->name() : $line_item->name();
-        $name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>'
-            : $name_html;
-        $name_html .= $line_item->is_taxable() ? ' *' : '';
-        // maybe preface with icon?
-        $name_html = $line_item_related_object instanceof EEI_Has_Icon
-            ? $line_item_related_object->get_icon() . $name_html
-            : $name_html;
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
-        $name_html .=  sprintf(
-            _x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
-            '<span class="ee-line-item-related-parent-object">',
-            $line_item->parent() instanceof EE_Line_Item
-                ? $line_item->parent()->OBJ_type_i18n()
-                : __('Item:', 'event_espresso'),
-            $parent_related_object_link
-                ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
-                : $parent_related_object_name,
-            '</span>'
-        );
-
-        $name_html = apply_filters(
-            'FHEE__EE_Admin_Table_Registration_Line_Item_Display_Strategy___item_row__name_html',
-            $name_html,
-            $line_item,
-            $options
-        );
-
-        $html .= EEH_HTML::td($name_html, '', 'jst-left');
-        // Type Column
-        $type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
-        $type_html .= $this->_get_cancellations($line_item);
-        $type_html .= $line_item->OBJ_type() ? '<br />' : '';
-        $code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
-        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
-        $html .= EEH_HTML::td($type_html, '', 'jst-left');
-
-        // Date column
-        $datetime_content = '';
-        if ($line_item_related_object instanceof EE_Ticket) {
-            $datetimes = $line_item_related_object->datetimes();
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime_content .= $datetime->get_dtt_display_name() . '<br>';
-                }
-            }
-        }
-        $html .= EEH_HTML::td($datetime_content, '', 'jst-left');
-
-        // Amount Column
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
-        }
-
-
-        // finish things off and return
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
-        // name th
-        $html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="3"');
-        // total th
-        $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _total_row(EE_Line_Item $line_item, $options = array())
-    {
-
-        $registration = isset($options['EE_Registration']) ? $options['EE_Registration'] : null;
-        $registration_total = $registration instanceof EE_Registration ? $registration->pretty_final_price() : 0;
-        // if no valid registration object then we're not going to show the approximate text.
-        $total_match = $registration instanceof EE_Registration
-            ? $registration->final_price() === $line_item->total()
-            : true;
-
-        // start of row
-        $html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
-        // Total th label
-        if ($total_match) {
-            $total_label = sprintf(__('This registration\'s total %s:', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
-        } else {
-            $total_label = sprintf(__('This registration\'s approximate total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
-            $total_label .= '<br>';
-            $total_label .= '<p class="ee-footnote-text">'
-                            . sprintf(
-                                __('The registrations\' share of the transaction total is approximate because it might not be possible to evenly divide the transaction total among each registration, and so some registrations may need to pay a penny more than others.  This registration\'s final share is actually %1$s%2$s%3$s.', 'event_espresso'),
-                                '<strong>',
-                                $registration_total,
-                                '</strong>'
-                            )
-                            . '</p>';
-        }
-        $html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="3"');
-        // total th
-
-        $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
+	/**
+	 * Table header for display.
+	 * @since   4.8
+	 * @param array $options
+	 * @return string
+	 */
+	protected function _table_header($options)
+	{
+		$html = EEH_HTML::table('', '', $options['table_css_class']);
+		$html .= EEH_HTML::thead();
+		$html .= EEH_HTML::tr();
+		$html .= EEH_HTML::th(__('Name', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(__('Type', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(__('Date(s)', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(__('Amount', 'event_espresso'), '', 'jst-cntr');
+		$html .= EEH_HTML::tbody();
+		return $html;
+	}
+
+
+
+
+
+	/**
+	 *    _item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		$line_item_related_object = $line_item->get_object();
+		$parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item
+			? $line_item->parent()->get_object()
+			: null;
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+
+
+		// Name Column
+		$name_link = $line_item_related_object instanceof EEI_Admin_Links ? $line_item_related_object->get_admin_details_link() : '';
+
+		// related object scope.
+		$parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object
+			? $parent_line_item_related_object->name()
+			: '';
+		$parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item
+			? $line_item->parent()->name()
+			: $parent_related_object_name;
+		$parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links
+			? $parent_line_item_related_object->get_admin_details_link()
+			: '';
+
+
+		$name_html = $line_item_related_object instanceof EEI_Line_Item_Object
+			? $line_item_related_object->name() : $line_item->name();
+		$name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>'
+			: $name_html;
+		$name_html .= $line_item->is_taxable() ? ' *' : '';
+		// maybe preface with icon?
+		$name_html = $line_item_related_object instanceof EEI_Has_Icon
+			? $line_item_related_object->get_icon() . $name_html
+			: $name_html;
+		$name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
+		$name_html .=  sprintf(
+			_x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
+			'<span class="ee-line-item-related-parent-object">',
+			$line_item->parent() instanceof EE_Line_Item
+				? $line_item->parent()->OBJ_type_i18n()
+				: __('Item:', 'event_espresso'),
+			$parent_related_object_link
+				? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
+				: $parent_related_object_name,
+			'</span>'
+		);
+
+		$name_html = apply_filters(
+			'FHEE__EE_Admin_Table_Registration_Line_Item_Display_Strategy___item_row__name_html',
+			$name_html,
+			$line_item,
+			$options
+		);
+
+		$html .= EEH_HTML::td($name_html, '', 'jst-left');
+		// Type Column
+		$type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
+		$type_html .= $this->_get_cancellations($line_item);
+		$type_html .= $line_item->OBJ_type() ? '<br />' : '';
+		$code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
+		$type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
+		$html .= EEH_HTML::td($type_html, '', 'jst-left');
+
+		// Date column
+		$datetime_content = '';
+		if ($line_item_related_object instanceof EE_Ticket) {
+			$datetimes = $line_item_related_object->datetimes();
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime_content .= $datetime->get_dtt_display_name() . '<br>';
+				}
+			}
+		}
+		$html .= EEH_HTML::td($datetime_content, '', 'jst-left');
+
+		// Amount Column
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
+		}
+
+
+		// finish things off and return
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
+		// name th
+		$html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="3"');
+		// total th
+		$html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _total_row(EE_Line_Item $line_item, $options = array())
+	{
+
+		$registration = isset($options['EE_Registration']) ? $options['EE_Registration'] : null;
+		$registration_total = $registration instanceof EE_Registration ? $registration->pretty_final_price() : 0;
+		// if no valid registration object then we're not going to show the approximate text.
+		$total_match = $registration instanceof EE_Registration
+			? $registration->final_price() === $line_item->total()
+			: true;
+
+		// start of row
+		$html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
+		// Total th label
+		if ($total_match) {
+			$total_label = sprintf(__('This registration\'s total %s:', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+		} else {
+			$total_label = sprintf(__('This registration\'s approximate total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+			$total_label .= '<br>';
+			$total_label .= '<p class="ee-footnote-text">'
+							. sprintf(
+								__('The registrations\' share of the transaction total is approximate because it might not be possible to evenly divide the transaction total among each registration, and so some registrations may need to pay a penny more than others.  This registration\'s final share is actually %1$s%2$s%3$s.', 'event_espresso'),
+								'<strong>',
+								$registration_total,
+								'</strong>'
+							)
+							. '</p>';
+		}
+		$html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="3"');
+		// total th
+
+		$html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
 }

core/libraries/line_item_display/EE_Invoice_Line_Item_Display_Strategy.strategy.php

Indentation +212 added lines, -212 removed lines

@@ -1,222 +1,222 @@
 <?php
  /**
- *
- * Class EE_Invoice_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Invoice_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 class EE_Invoice_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * @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,
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_separator_row($options);
-                $html .= $this->_total_row($line_item, __('Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_total_row($line_item, __('Sub-Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_tax_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_total_row($line_item, __('Tax Total', 'event_espresso'), $options);
-                break;
-
-
-            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_tax:
-                $html .= $this->_tax_row($line_item, $options);
-                break;
-        }
-
-        return $html;
-    }
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', $row_class);
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l');
-        // price td
-        $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
-        // total td
-        $total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
-        $html .= EEH_HTML::td($total, '', 'item_r');
-        // 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 td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        $html .= EEH_HTML::td() . EEH_HTML::tdx();
-        // 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');
-        }
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item tax-total');
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @param array        $options
-     * @return mixed
-     */
-    private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
-    {
-        // colspan
-        $colspan = $options['show_desc'] ? ' colspan="2"' : '';
-        // start of row
-        $html = EEH_HTML::tr('', '', 'total_tr odd');
-        // empty td
-        $html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
-        // total td
-        $html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'total');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _separator_row
-     *
-     * @param array        $options
-     * @return mixed
-     */
-    private function _separator_row($options = array())
-    {
-        // colspan
-        $colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
-        // start of row
-        $html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
+	/**
+	 * @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,
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_separator_row($options);
+				$html .= $this->_total_row($line_item, __('Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_total_row($line_item, __('Sub-Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_tax_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_total_row($line_item, __('Tax Total', 'event_espresso'), $options);
+				break;
+
+
+			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_tax:
+				$html .= $this->_tax_row($line_item, $options);
+				break;
+		}
+
+		return $html;
+	}
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', $row_class);
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l');
+		// price td
+		$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
+		// total td
+		$total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
+		$html .= EEH_HTML::td($total, '', 'item_r');
+		// 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 td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		$html .= EEH_HTML::td() . EEH_HTML::tdx();
+		// 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');
+		}
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item tax-total');
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		// percent td
+		$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
+	{
+		// colspan
+		$colspan = $options['show_desc'] ? ' colspan="2"' : '';
+		// start of row
+		$html = EEH_HTML::tr('', '', 'total_tr odd');
+		// empty td
+		$html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
+		// total td
+		$html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'total');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _separator_row
+	 *
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _separator_row($options = array())
+	{
+		// colspan
+		$colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
+		// start of row
+		$html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
 //      // separator td
 //      $html .= EEH_HTML::td( '<hr>', '',  '',  '',  $colspan );
 //      // end of row
 //      $html .= EEH_HTML::trx();
-        return $html;
-    }
+		return $html;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -108,7 +108,7 @@ 
         // price td
         $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
         // total td
-        $total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
+        $total = $line_item->is_taxable() ? $line_item->total_no_code().'*' : $line_item->total_no_code();
         $html .= EEH_HTML::td($total, '', 'item_r');
         // end of row
         $html .= EEH_HTML::trx();
@@ -132,10 +132,10 @@ 
         $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
         // desc td
         $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        $html .= EEH_HTML::td() . EEH_HTML::tdx();
+        $html .= EEH_HTML::td().EEH_HTML::tdx();
         // discount/surcharge td
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
         }
@@ -164,7 +164,7 @@ 
         // desc td
         $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
         // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
+        $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c', '', ' colspan="2"');
         // total td
         $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
         // end of row

core/libraries/batch/JobHandlerBaseClasses/JobHandlerInterface.php

Indentation +24 added lines, -24 removed lines

@@ -22,30 +22,30 @@
 
 interface JobHandlerInterface
 {
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     * @param JobParameters $job_parameters
-     * @throws BatchRequestException
-     * @return JobStepResponse
-     */
-    public function create_job(JobParameters $job_parameters);
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 * @param JobParameters $job_parameters
+	 * @throws BatchRequestException
+	 * @return JobStepResponse
+	 */
+	public function create_job(JobParameters $job_parameters);
 
-    /**
-     * Performs another step of the job
-     * @param JobParameters $job_parameters
-     * @param int $batch_size
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50);
+	/**
+	 * Performs another step of the job
+	 * @param JobParameters $job_parameters
+	 * @param int $batch_size
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50);
 
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job(JobParameters $job_parameters);
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job(JobParameters $job_parameters);
 }

core/request_stack/EE_Request.core.php

Indentation +355 added lines, -355 removed lines

@@ -18,359 +18,359 @@
 class EE_Request implements LegacyRequestInterface, InterminableInterface
 {
 
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * whether current request is for the admin but NOT via AJAX
-     *
-     * @var boolean $admin
-     */
-    public $admin = false;
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var boolean $ajax
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var boolean $front_ajax
-     */
-    public $front_ajax = false;
-
-
-    /**
-     * @deprecated 4.9.53
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     * @param array $server
-     */
-    public function __construct(
-        array $get = array(),
-        array $post = array(),
-        array $cookie = array(),
-        array $server = array()
-    ) {
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private function request()
-    {
-        if ($this->request instanceof RequestInterface) {
-            return $this->request;
-        }
-        $loader = LoaderFactory::getLoader();
-        $this->request = $loader->getShared('EventEspresso\core\services\request\RequestInterface');
-        return $this->request;
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_params()
-    {
-        return $this->request()->getParams();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function post_params()
-    {
-        return $this->request()->postParams();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function cookie_params()
-    {
-        return $this->request()->cookieParams();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function server_params()
-    {
-        return $this->request()->serverParams();
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function params()
-    {
-        return $this->request()->requestParams();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        $this->request()->setRequestParam($key, $value, $override_ee);
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @deprecated 4.9.53
-     * @param      $key
-     * @param null $default
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get($key, $default = null)
-    {
-        return $this->request()->getRequestParam($key, $default);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @deprecated 4.9.53
-     * @param $key
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function is_set($key)
-    {
-        return $this->request()->requestParamIsSet($key);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @deprecated 4.9.53
-     * @param      $key
-     * @param bool $unset_from_global_too
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function un_set($key, $unset_from_global_too = false)
-    {
-        $this->request()->unSetRequestParam($key, $unset_from_global_too);
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function ip_address()
-    {
-        return $this->request()->ipAddress();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function isAdmin()
-    {
-        return $this->request()->isAdmin();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function isAjax()
-    {
-        return $this->request()->isAjax();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function isFrontAjax()
-    {
-        return $this->request()->isFrontAjax();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return mixed|string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function requestUri()
-    {
-        return $this->request()->requestUri();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function userAgent()
-    {
-        return $this->request()->userAgent();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @param string $user_agent
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->request()->setUserAgent($user_agent);
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function isBot()
-    {
-        return $this->request()->isBot();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @param bool $is_bot
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->request()->setIsBot($is_bot);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return false|int
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->request()->getMatch($pattern, $default);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function matches($pattern)
-    {
-        return $this->request()->matches($pattern);
-    }
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * whether current request is for the admin but NOT via AJAX
+	 *
+	 * @var boolean $admin
+	 */
+	public $admin = false;
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var boolean $ajax
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var boolean $front_ajax
+	 */
+	public $front_ajax = false;
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 * @param array $server
+	 */
+	public function __construct(
+		array $get = array(),
+		array $post = array(),
+		array $cookie = array(),
+		array $server = array()
+	) {
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private function request()
+	{
+		if ($this->request instanceof RequestInterface) {
+			return $this->request;
+		}
+		$loader = LoaderFactory::getLoader();
+		$this->request = $loader->getShared('EventEspresso\core\services\request\RequestInterface');
+		return $this->request;
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_params()
+	{
+		return $this->request()->getParams();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function post_params()
+	{
+		return $this->request()->postParams();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function cookie_params()
+	{
+		return $this->request()->cookieParams();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function server_params()
+	{
+		return $this->request()->serverParams();
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function params()
+	{
+		return $this->request()->requestParams();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		$this->request()->setRequestParam($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @deprecated 4.9.53
+	 * @param      $key
+	 * @param null $default
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get($key, $default = null)
+	{
+		return $this->request()->getRequestParam($key, $default);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @deprecated 4.9.53
+	 * @param $key
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function is_set($key)
+	{
+		return $this->request()->requestParamIsSet($key);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @deprecated 4.9.53
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function un_set($key, $unset_from_global_too = false)
+	{
+		$this->request()->unSetRequestParam($key, $unset_from_global_too);
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function ip_address()
+	{
+		return $this->request()->ipAddress();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function isAdmin()
+	{
+		return $this->request()->isAdmin();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function isAjax()
+	{
+		return $this->request()->isAjax();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request()->isFrontAjax();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return mixed|string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function requestUri()
+	{
+		return $this->request()->requestUri();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function userAgent()
+	{
+		return $this->request()->userAgent();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @param string $user_agent
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->request()->setUserAgent($user_agent);
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function isBot()
+	{
+		return $this->request()->isBot();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @param bool $is_bot
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->request()->setIsBot($is_bot);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->request()->getMatch($pattern, $default);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function matches($pattern)
+	{
+		return $this->request()->matches($pattern);
+	}
 }