EE_Gateway

Complexity

Total Complexity

41

Size/Duplication

Total Lines	416
Duplicated Lines	8.65 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	2	1
A	__sleep()	0	5	1
A	supports_sending_refunds()	0	3	1
A	supports_receiving_refunds()	0	3	1
A	do_direct_refund()	0	3	1
A	set_settings()	0	6	2
A	set_payment_model()	0	3	1
A	set_payment_log()	0	3	1
A	set_template_helper()	0	3	1
A	set_line_item_helper()	0	3	1
A	set_money_helper()	0	3	1
A	set_gateway_data_formatter()	9	11	3
A	_get_gateway_formatter()	9	11	3
A	set_unsupported_character_remover()	9	11	3
A	_get_unsupported_character_remover()	9	11	3
A	log()	0	10	2
A	format_currency()	0	3	1
A	currencies_supported()	0	3	1
A	_sum_items_and_taxes()	0	11	3
A	_can_easily_itemize_transaction_for()	0	8	2
A	update_txn_based_on_payment()	0	4	1
A	_get_first_event_for_payment()	0	3	1
A	_get_first_event_name_for_payment()	0	3	1
A	_format_partial_payment_line_item_name()	0	3	1
A	_format_partial_payment_line_item_desc()	0	3	1
A	_format_line_item_name()	0	3	1
A	_format_line_item_desc()	0	3	1
A	_format_order_description()	0	3	1

<?php

use \EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatterInterface;
use \EventEspresso\core\exceptions\InvalidEntityException;
use \EventEspresso\core\services\formatters\FormatterInterface;

/**
 * EE_Gateway
 * Abstract base class for all gateways for processing payments.
 * This has been designed in a way so that other WP Plugins
 * can use this class for processing payments, and theoretically any of its children,
 * provided they implement the interfaces it uses.
 * The necessary interfaces to be implemented are contained in:
 * core/libraries/payment_methods/EEI_Payment_Method_Interfaces.php and EEI_Interfaces.
 * After constructing a gateway object, you need to set all the properties which reference many of the
 * needed helpers and models (see all the methods starting with "set_",
 * eg seg_line_item_helper which should be passed an object which implements EEHI_Line_Item_Helper; etc).
 *
 * @package            Event Espresso
 * @subpackage		core/libraries/payment_methods
 * @author			Mike Nelson
 */
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

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

	 */
	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 ) {

The parameter $payment is not used and could be removed.

The parameter $refund_info is not used and could be removed.

		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){

This method seems to be duplicated in your project.

        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(){

This method seems to be duplicated in your project.

        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){

This method seems to be duplicated in your project.

        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(){

This method seems to be duplicated in your project.

        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,$payment){
		if($payment instanceof EEI_Payment){
			$type='Payment';
			$id = $payment->ID();
		}else{
			$type = 'Payment_Method';
			$id = $this->_ID;
		}
		$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() of type object<EEI_Transaction> is not a sub-type of object<EE_Transaction>. It seems like you assume a concrete implementation of the interface EEI_Transaction to be always present.

					$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);
	}
}