eventespresso / event-espresso-core

core/libraries/form_sections/strategies/sensitive_data_removal/EE_All_Sensitive_Data_Removal.strategy.php

Indentation +19 added lines, -19 removed lines

@@ -11,23 +11,23 @@
  */
 class EE_All_Sensitive_Data_Removal extends EE_Sensitive_Data_Removal_Base
 {
-    public function remove_sensitive_data($normalized_value)
-    {
-        switch (gettype($normalized_value)) {
-            case "boolean":
-                return false;
-            case "integer":
-            case "double":
-                return 0;
-            case "string":
-                return '';
-            case "array":
-                return array();
-            case "object":
-            case "resource":
-            case "NULL":
-            default:
-                return null;
-        }
-    }
+	public function remove_sensitive_data($normalized_value)
+	{
+		switch (gettype($normalized_value)) {
+			case "boolean":
+				return false;
+			case "integer":
+			case "double":
+				return 0;
+			case "string":
+				return '';
+			case "array":
+				return array();
+			case "object":
+			case "resource":
+			case "NULL":
+			default:
+				return null;
+		}
+	}
 }

core/libraries/form_sections/strategies/sensitive_data_removal/EE_No_Sensitive_Data_Removal.strategy.php

Indentation +4 added lines, -4 removed lines

@@ -11,8 +11,8 @@
  */
 class EE_No_Sensitive_Data_Removal extends EE_Sensitive_Data_Removal_Base
 {
-    public function remove_sensitive_data($normalized_value)
-    {
-        return $normalized_value;
-    }
+	public function remove_sensitive_data($normalized_value)
+	{
+		return $normalized_value;
+	}
 }

core/libraries/form_sections/base/EE_Form_Section_HTML_From_Template.form.php

Indentation +5 added lines, -5 removed lines

@@ -11,11 +11,11 @@
  */
 class EE_Form_Section_HTML_From_Template extends EE_Form_Section_HTML
 {
-    public function __construct($template_file, $args = array(), $options_array = array())
-    {
-        $html = EEH_Template::locate_template($template_file, $args);
+	public function __construct($template_file, $args = array(), $options_array = array())
+	{
+		$html = EEH_Template::locate_template($template_file, $args);
 
 //      echo " filepath:$template_file html $html";
-        parent::__construct($html, $options_array);
-    }
+		parent::__construct($html, $options_array);
+	}
 }

core/libraries/form_sections/payment_methods/EE_Billing_Info_Form.form.php

Spacing +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
      */
     public function html_class()
     {
-        return ! empty($this->_html_class) ? $this->_html_class . ' ee-billing-form' : 'ee-billing-form';
+        return ! empty($this->_html_class) ? $this->_html_class.' ee-billing-form' : 'ee-billing-form';
     }
 }
 // End of file EE_Billing_Info_Form.form.php

Indentation +69 added lines, -69 removed lines

@@ -14,74 +14,74 @@
  */
 class EE_Billing_Info_Form extends EE_Form_Section_Proper
 {
-    /**
-     * The payment method this billing form is for
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance;
-
-
-
-    /**
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param array $options_array @see EE_Form_Section_Proper::__construct()
-     */
-    public function __construct(EE_Payment_Method $payment_method, $options_array = array())
-    {
-        $this->_pm_instance = $payment_method;
-        $this->_layout_strategy = new EE_Div_Per_Section_Layout();
-        parent::__construct($options_array);
-    }
-
-
-
-    /**
-     * Sets the payment method for this billing form
-     * @param EE_Payment_Method $payment_method
-     * @return void
-     */
-    public function set_payment_method(EE_Payment_Method $payment_method)
-    {
-        $this->_pm_instance = $payment_method;
-    }
-
-
-
-    /**
-     * Returns the instance of the payment method this billing form is for
-     * @return EE_Payment_Method
-     */
-    public function payment_method()
-    {
-        return $this->_pm_instance;
-    }
-
-
-
-    /**
-     * payment_fields_autofilled_notice_html
-     * @return string
-     */
-    public function payment_fields_autofilled_notice_html()
-    {
-        return  new EE_Form_Section_HTML(
-            EEH_HTML::p(
-                apply_filters('FHEE__EE_Billing_Info_Form__payment_fields_autofilled_notice_html_text', esc_html__('Payment fields have been autofilled because you are in debug mode', 'event_espresso')),
-                '',
-                'important-notice'
-            )
-        );
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_class()
-    {
-        return ! empty($this->_html_class) ? $this->_html_class . ' ee-billing-form' : 'ee-billing-form';
-    }
+	/**
+	 * The payment method this billing form is for
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance;
+
+
+
+	/**
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param array $options_array @see EE_Form_Section_Proper::__construct()
+	 */
+	public function __construct(EE_Payment_Method $payment_method, $options_array = array())
+	{
+		$this->_pm_instance = $payment_method;
+		$this->_layout_strategy = new EE_Div_Per_Section_Layout();
+		parent::__construct($options_array);
+	}
+
+
+
+	/**
+	 * Sets the payment method for this billing form
+	 * @param EE_Payment_Method $payment_method
+	 * @return void
+	 */
+	public function set_payment_method(EE_Payment_Method $payment_method)
+	{
+		$this->_pm_instance = $payment_method;
+	}
+
+
+
+	/**
+	 * Returns the instance of the payment method this billing form is for
+	 * @return EE_Payment_Method
+	 */
+	public function payment_method()
+	{
+		return $this->_pm_instance;
+	}
+
+
+
+	/**
+	 * payment_fields_autofilled_notice_html
+	 * @return string
+	 */
+	public function payment_fields_autofilled_notice_html()
+	{
+		return  new EE_Form_Section_HTML(
+			EEH_HTML::p(
+				apply_filters('FHEE__EE_Billing_Info_Form__payment_fields_autofilled_notice_html_text', esc_html__('Payment fields have been autofilled because you are in debug mode', 'event_espresso')),
+				'',
+				'important-notice'
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_class()
+	{
+		return ! empty($this->_html_class) ? $this->_html_class . ' ee-billing-form' : 'ee-billing-form';
+	}
 }
 // End of file EE_Billing_Info_Form.form.php

core/libraries/form_sections/helpers/EE_Validation_Error.error.php

Indentation +41 added lines, -41 removed lines

@@ -2,47 +2,47 @@
 
 class EE_Validation_Error extends Exception
 {
-    /**
-     * Form Section from which this error originated.
-     * @var EE_Form_Section
-     */
-    protected $_form_section;
-    /**
-     * a short string for uniquely identifying the error, which isn't internationalized and
-     * machines can use to identify the error
-     * @var string
-     */
-    protected $_string_code;
+	/**
+	 * Form Section from which this error originated.
+	 * @var EE_Form_Section
+	 */
+	protected $_form_section;
+	/**
+	 * a short string for uniquely identifying the error, which isn't internationalized and
+	 * machines can use to identify the error
+	 * @var string
+	 */
+	protected $_string_code;
 
-    /**
-     * When creating a validation error, we need to know which field the error relates to.
-     * @param string $message message you want to display about this error
-     * @param string $string_code a code for uniquely identifying the exception
-     * @param EE_Form_Section_Validatable $form_section
-     * @param Exception $previous if there was an exception that caused this exception
-     */
-    public function __construct($message = null, $string_code = null, $form_section = null, $previous = null)
-    {
-        $this->_form_section = $form_section;
-        $this->_string_code = $string_code;
-        parent::__construct($message, 500, $previous);
-    }
+	/**
+	 * When creating a validation error, we need to know which field the error relates to.
+	 * @param string $message message you want to display about this error
+	 * @param string $string_code a code for uniquely identifying the exception
+	 * @param EE_Form_Section_Validatable $form_section
+	 * @param Exception $previous if there was an exception that caused this exception
+	 */
+	public function __construct($message = null, $string_code = null, $form_section = null, $previous = null)
+	{
+		$this->_form_section = $form_section;
+		$this->_string_code = $string_code;
+		parent::__construct($message, 500, $previous);
+	}
 
-    /**
-     * returns teh form section which caused the error.
-     * @return EE_Form_Section_Validatable
-     */
-    public function get_form_section()
-    {
-        return $this->_form_section;
-    }
-    /**
-     * Sets teh form seciton of the error, in case it wasnt set previously
-     * @param EE_Form_Section_Validatable $form_section
-     * @return void
-     */
-    public function set_form_section($form_section)
-    {
-        $this->_form_section = $form_section;
-    }
+	/**
+	 * returns teh form section which caused the error.
+	 * @return EE_Form_Section_Validatable
+	 */
+	public function get_form_section()
+	{
+		return $this->_form_section;
+	}
+	/**
+	 * Sets teh form seciton of the error, in case it wasnt set previously
+	 * @param EE_Form_Section_Validatable $form_section
+	 * @return void
+	 */
+	public function set_form_section($form_section)
+	{
+		$this->_form_section = $form_section;
+	}
 }

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/line_item_display/EE_Invoice_Line_Item_Display_Strategy.strategy.php

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

Indentation +212 added lines, -212 removed lines

@@ -1,223 +1,223 @@
 <?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, esc_html__('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, esc_html__('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, esc_html__('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, esc_html__('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, esc_html__('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, esc_html__('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;
+	}
 }

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_Response.core.php

Spacing +3 added lines, -3 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function set_notice($key, $value)
     {
-        $this->_notice[ $key ] = $value;
+        $this->_notice[$key] = $value;
     }
 
 
@@ -82,7 +82,7 @@ 
      */
     public function get_notice($key)
     {
-        return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null;
+        return isset($this->_notice[$key]) ? $this->_notice[$key] : null;
     }
 
 
@@ -103,7 +103,7 @@ 
      */
     public function add_output($string, $append = true)
     {
-        $this->_output = $append ? $this->_output . $string : $string . $this->_output;
+        $this->_output = $append ? $this->_output.$string : $string.$this->_output;
     }
 
 

Indentation +142 added lines, -142 removed lines

@@ -12,146 +12,146 @@
  */
 class EE_Response
 {
-    /**
-     * @access    protected
-     * @type        array $_notice
-     */
-    protected $_notice = array();
-
-    /**
-     *    rendered output to be returned to WP
-     *
-     * @access    protected
-     * @type        string
-     */
-    protected $_output = '';
-
-    /**
-     * @access    protected
-     * @type        bool
-     */
-    protected $request_terminated = false;
-
-    /**
-     * @access    protected
-     * @type        bool
-     */
-    protected $deactivate_plugin = false;
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return \EE_Response
-     */
-    public function __construct()
-    {
-        $this->terminate_request(false);
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\Response',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.53'
-        );
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function set_notice($key, $value)
-    {
-        $this->_notice[ $key ] = $value;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @param $key
-     * @return    mixed
-     */
-    public function get_notice($key)
-    {
-        return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return    array
-     */
-    public function get_notices()
-    {
-        return $this->_notice;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @param      $string
-     * @param bool $append
-     */
-    public function add_output($string, $append = true)
-    {
-        $this->_output = $append ? $this->_output . $string : $string . $this->_output;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return    string
-     */
-    public function get_output()
-    {
-        return $this->_output;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return boolean
-     */
-    public function request_terminated()
-    {
-        return $this->request_terminated;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @param boolean $request_terminated
-     */
-    public function terminate_request($request_terminated = true)
-    {
-        $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return boolean
-     */
-    public function plugin_deactivated()
-    {
-        return $this->deactivate_plugin;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * sets $deactivate_plugin to true
-     */
-    public function deactivate_plugin()
-    {
-        $this->deactivate_plugin = true;
-    }
+	/**
+	 * @access    protected
+	 * @type        array $_notice
+	 */
+	protected $_notice = array();
+
+	/**
+	 *    rendered output to be returned to WP
+	 *
+	 * @access    protected
+	 * @type        string
+	 */
+	protected $_output = '';
+
+	/**
+	 * @access    protected
+	 * @type        bool
+	 */
+	protected $request_terminated = false;
+
+	/**
+	 * @access    protected
+	 * @type        bool
+	 */
+	protected $deactivate_plugin = false;
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return \EE_Response
+	 */
+	public function __construct()
+	{
+		$this->terminate_request(false);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\Response',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.53'
+		);
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function set_notice($key, $value)
+	{
+		$this->_notice[ $key ] = $value;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function get_notice($key)
+	{
+		return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return    array
+	 */
+	public function get_notices()
+	{
+		return $this->_notice;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @param      $string
+	 * @param bool $append
+	 */
+	public function add_output($string, $append = true)
+	{
+		$this->_output = $append ? $this->_output . $string : $string . $this->_output;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return    string
+	 */
+	public function get_output()
+	{
+		return $this->_output;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return boolean
+	 */
+	public function request_terminated()
+	{
+		return $this->request_terminated;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @param boolean $request_terminated
+	 */
+	public function terminate_request($request_terminated = true)
+	{
+		$this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return boolean
+	 */
+	public function plugin_deactivated()
+	{
+		return $this->deactivate_plugin;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivate_plugin()
+	{
+		$this->deactivate_plugin = true;
+	}
 }