EE_Payment

Complexity

Total Complexity

88

Size/Duplication

Total Lines	856
Duplicated Lines	1.17 %

Coupling/Cohesion

Components	3
Dependencies	11

Importance

Changes

0

56 Methods

Rating	Name	Duplication	Size	Complexity
A	set_amount()	0	3	1
A	new_instance()	0	4	2
A	new_instance_from_db()	0	3	1
A	set_transaction_id()	0	3	1
A	transaction()	0	3	1
A	set_status()	0	3	1
A	set_timestamp()	0	3	1
A	set_source()	0	3	1
A	set_gateway_response()	0	3	1
A	gateway()	0	11	2
A	set_txn_id_chq_nmbr()	0	3	1
A	set_po_number()	0	3	1
A	set_extra_accntng()	0	3	1
A	set_payment_made_via_admin()	0	7	2
A	set_details()	5	8	2
A	set_redirect_url()	0	3	1
A	set_redirect_args()	0	3	1
A	TXN_ID()	0	3	1
A	status()	0	3	1
A	STS_ID()	0	3	1
A	timestamp()	0	3	1
A	source()	0	3	1
A	amount()	0	3	1
A	amount_no_code()	0	3	1
A	gateway_response()	0	3	1
A	txn_id_chq_nmbr()	0	3	1
A	po_number()	0	3	1
A	extra_accntng()	0	3	1
A	payment_made_via_admin()	0	3	1
A	details()	0	3	1
A	redirect_url()	0	3	1
A	redirect_args()	0	3	1
A	e_pretty_status()	0	3	1
D	pretty_status()	0	31	9
A	is_approved()	0	3	1
A	status_is()	0	3	2
A	is_pending()	0	3	1
A	is_cancelled()	0	3	1
A	is_declined()	0	3	1
A	is_failed()	0	3	1
A	is_a_refund()	0	3	2
A	status_obj()	0	3	1
A	extra_meta()	0	3	1
A	payment_method()	0	3	1
B	redirect_form()	0	48	5
A	redirect_args_as_inputs()	0	3	1
A	_args_as_inputs()	0	14	4
A	currency_code()	0	3	1
A	_strip_all_tags_within_array()	5	10	3
A	just_approved()	0	16	3
A	get_pretty()	0	6	3
A	registration_payments()	0	3	1
A	get_first_event()	0	11	3
A	get_first_event_name()	0	5	2
A	get_primary_registration()	0	7	2
A	get_primary_attendee()	0	8	2

<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
	exit( 'No direct script access allowed' );
}

/**
 * Payment class
 *
 * @package        Event Espresso
 * @subpackage  includes/classes/EE_Payment.class.php
 * @author      Brent Christensen
 */
class EE_Payment extends EE_Base_Class implements EEI_Payment {

	/**
	 * @param array  $props_n_values          incoming values
	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
	 *                                        used.)
	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
	 *                                        date_format and the second value is the time format
	 * @return EE_Payment
	 * @throws \EE_Error
	 */
	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
	}



	/**
	 * @param array  $props_n_values  incoming values from the database
	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
	 *                                the website will be used.
	 * @return EE_Payment
	 * @throws \EE_Error
	 */
	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
		return new self( $props_n_values, true, $timezone );
	}



	/**
	 * Set Transaction ID
	 *
	 * @access public
	 * @param int $TXN_ID
	 * @throws \EE_Error
	 */
	public function set_transaction_id( $TXN_ID = 0 ) {
		$this->set( 'TXN_ID', $TXN_ID );
	}



	/**
	 * Gets the transaction related to this payment
	 *
	 * @return EE_Transaction
	 * @throws \EE_Error
	 */
	public function transaction() {
		return $this->get_first_related( 'Transaction' );
	}



	/**
	 * Set Status
	 *
	 * @access public
	 * @param string $STS_ID
	 * @throws \EE_Error
	 */
	public function set_status( $STS_ID = '' ) {
		$this->set( 'STS_ID', $STS_ID );
	}



	/**
	 * Set Payment Timestamp
	 *
	 * @access public
	 * @param int $timestamp
	 * @throws \EE_Error
	 */
	public function set_timestamp( $timestamp = 0 ) {
		$this->set( 'PAY_timestamp', $timestamp );
	}



	/**
	 * Set Payment Method
	 *
	 * @access public
	 * @param string $PAY_source
	 * @throws \EE_Error
	 */
	public function set_source( $PAY_source = '' ) {
		$this->set( 'PAY_source', $PAY_source );
	}



	/**
	 * Set Payment Amount
	 *
	 * @access public
	 * @param float $amount
	 * @throws \EE_Error
	 */
	public function set_amount( $amount = 0.00 ) {
		$this->set( 'PAY_amount', (float)$amount );
	}



	/**
	 * Set Payment Gateway Response
	 *
	 * @access public
	 * @param string $gateway_response
	 * @throws \EE_Error
	 */
	public function set_gateway_response( $gateway_response = '' ) {
		$this->set( 'PAY_gateway_response', $gateway_response );
	}



	/**
	 * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
	 * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
	 * used on it
	 *
	 * @deprecated
	 * @return string
	 * @throws \EE_Error
	 */
	public function gateway() {
		EE_Error::doing_it_wrong(
			'EE_Payment::gateway',
			__(
				'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
				'event_espresso'
			),
			'4.6.0'
		);
		return $this->payment_method() ? $this->payment_method()->name() : __( 'Unknown', 'event_espresso' );
	}



	/**
	 * Set Gateway Transaction ID
	 *
	 * @access public
	 * @param string $txn_id_chq_nmbr
	 * @throws \EE_Error
	 */
	public function set_txn_id_chq_nmbr( $txn_id_chq_nmbr = '' ) {
		$this->set( 'PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr );
	}



	/**
	 * Set Purchase Order Number
	 *
	 * @access public
	 * @param string $po_number
	 * @throws \EE_Error
	 */
	public function set_po_number( $po_number = '' ) {
		$this->set( 'PAY_po_number', $po_number );
	}



	/**
	 * Set Extra Accounting Field
	 *
	 * @access public
	 * @param string $extra_accntng
	 * @throws \EE_Error
	 */
	public function set_extra_accntng( $extra_accntng = '' ) {
		$this->set( 'PAY_extra_accntng', $extra_accntng );
	}



	/**
	 * Set Payment made via admin flag
	 *
	 * @access public
	 * @param bool $via_admin
	 * @throws \EE_Error
	 */
	public function set_payment_made_via_admin( $via_admin = false ) {
		if ( $via_admin ) {
			$this->set( 'PAY_source', EEM_Payment_Method::scope_admin );
		} else {
			$this->set( 'PAY_source', EEM_Payment_Method::scope_cart );
		}
	}



	/**
	 * Set Payment Details
	 *
	 * @access public
	 * @param string|array $details
	 * @throws \EE_Error
	 */
	public function set_details( $details = '' ) {
		if ( is_array( $details ) ) {
			array_walk_recursive( $details, array( $this, '_strip_all_tags_within_array' ) );
		} else {
			$details = wp_strip_all_tags( $details );
		}
		$this->set( 'PAY_details', $details );
	}



	/**
	 * Sets redirect_url
	 *
	 * @param string $redirect_url
	 * @throws \EE_Error
	 */
	public function set_redirect_url( $redirect_url ) {
		$this->set( 'PAY_redirect_url', $redirect_url );
	}



	/**
	 * Sets redirect_args
	 *
	 * @param array $redirect_args
	 * @throws \EE_Error
	 */
	public function set_redirect_args( $redirect_args ) {
		$this->set( 'PAY_redirect_args', $redirect_args );
	}



	/**
	 * get Payment Transaction ID
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function TXN_ID() {
		return $this->get( 'TXN_ID' );
	}



	/**
	 * get Payment Status
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function status() {
		return $this->get( 'STS_ID' );
	}



	/**
	 * get Payment Status
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function STS_ID() {
		return $this->get( 'STS_ID' );
	}



	/**
	 * get Payment Timestamp
	 *
	 * @access public
	 * @param string $dt_frmt
	 * @param string $tm_frmt
	 * @return string
	 * @throws \EE_Error
	 */
	public function timestamp( $dt_frmt = '', $tm_frmt = '' ) {
		return $this->get_i18n_datetime( 'PAY_timestamp', trim( $dt_frmt . ' ' . $tm_frmt) );
	}



	/**
	 * get Payment Source
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function source() {
		return $this->get( 'PAY_source' );
	}



	/**
	 * get Payment Amount
	 *
	 * @access public
	 * @return float
	 * @throws \EE_Error
	 */
	public function amount() {
		return (float)$this->get( 'PAY_amount' );
	}



	/**
	 * @return mixed
	 * @throws \EE_Error
	 */
	public function amount_no_code() {
		return $this->get_pretty( 'PAY_amount', 'no_currency_code' );
	}



	/**
	 * get Payment Gateway Response
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function gateway_response() {
		return $this->get( 'PAY_gateway_response' );
	}



	/**
	 * get Payment Gateway Transaction ID
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function txn_id_chq_nmbr() {
		return $this->get( 'PAY_txn_id_chq_nmbr' );
	}



	/**
	 * get Purchase Order Number
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function po_number() {
		return $this->get( 'PAY_po_number' );
	}



	/**
	 * get Extra Accounting Field
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function extra_accntng() {
		return $this->get( 'PAY_extra_accntng' );
	}



	/**
	 * get Payment made via admin source
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function payment_made_via_admin() {
		return ( $this->get( 'PAY_source' ) === EEM_Payment_Method::scope_admin );
	}



	/**
	 * get Payment Details
	 *
	 * @access public
	 * @throws \EE_Error
	 */
	public function details() {
		return $this->get( 'PAY_details' );
	}



	/**
	 * Gets redirect_url
	 *
	 * @return string
	 * @throws \EE_Error
	 */
	public function redirect_url() {
		return $this->get( 'PAY_redirect_url' );
	}



	/**
	 * Gets redirect_args
	 *
	 * @return array
	 * @throws \EE_Error
	 */
	public function redirect_args() {
		return $this->get( 'PAY_redirect_args' );
	}



	/**
	 * echoes $this->pretty_status()
	 *
	 * @param bool $show_icons
	 * @return void
	 * @throws \EE_Error
	 */
	public function e_pretty_status( $show_icons = false ) {
		echo $this->pretty_status( $show_icons );
	}



	/**
	 * returns a pretty version of the status, good for displaying to users
	 *
	 * @param bool $show_icons
	 * @return string
	 * @throws \EE_Error
	 */
	public function pretty_status( $show_icons = false ) {
		$status = EEM_Status::instance()->localized_status(
			array( $this->STS_ID() => __( 'unknown', 'event_espresso' ) ),
			false,
			'sentence'
		);
		$icon = '';
		switch ( $this->STS_ID() ) {
			case EEM_Payment::status_id_approved:
				$icon = $show_icons
					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
					: '';
				break;
			case EEM_Payment::status_id_pending:
				$icon = $show_icons
					? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
					: '';
				break;
			case EEM_Payment::status_id_cancelled:
				$icon = $show_icons
					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
					: '';
				break;
			case EEM_Payment::status_id_declined:
				$icon = $show_icons
					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
					: '';
				break;
		}
		return $icon . $status[ $this->STS_ID() ];
	}



	/**
	 * For determining the status of the payment
	 *
	 * @return boolean whether the payment is approved or not
	 * @throws \EE_Error
	 */
	public function is_approved() {
		return $this->status_is( EEM_Payment::status_id_approved );
	}



	/**
	 * Generally determines if the status of this payment equals
	 * the $STS_ID string
	 *
	 * @param string $STS_ID an ID from the esp_status table/
	 *                       one of the status_id_* on the EEM_Payment model
	 * @return boolean whether the status of this payment equals the status id
	 * @throws \EE_Error
	 */
	protected function status_is( $STS_ID ) {
		return $STS_ID === $this->STS_ID() ? true : false;
	}



	/**
	 * For determining the status of the payment
	 *
	 * @return boolean whether the payment is pending or not
	 * @throws \EE_Error
	 */
	public function is_pending() {
		return $this->status_is( EEM_Payment::status_id_pending );
	}



	/**
	 * For determining the status of the payment
	 *
	 * @return boolean
	 * @throws \EE_Error
	 */
	public function is_cancelled() {
		return $this->status_is( EEM_Payment::status_id_cancelled );
	}



	/**
	 * For determining the status of the payment
	 *
	 * @return boolean
	 * @throws \EE_Error
	 */
	public function is_declined() {
		return $this->status_is( EEM_Payment::status_id_declined );
	}



	/**
	 * For determining the status of the payment
	 *
	 * @return boolean
	 * @throws \EE_Error
	 */
	public function is_failed() {
		return $this->status_is( EEM_Payment::status_id_failed );
	}



	/**
	 * For determining if the payment is actually a refund ( ie: has a negative value )
	 *
	 * @return boolean
	 * @throws \EE_Error
	 */
	public function is_a_refund() {
		return $this->amount() < 0 ? true : false;
	}



	/**
	 * Get the status object of this object
	 *
	 * @return EE_Status
	 * @throws \EE_Error
	 */
	public function status_obj() {
		return $this->get_first_related( 'Status' );
	}



	/**
	 * Gets all the extra meta info on this payment
	 *
	 * @param array $query_params like EEM_Base::get_all
	 * @return EE_Extra_Meta
	 * @throws \EE_Error
	 */
	public function extra_meta( $query_params = array() ) {
		return $this->get_many_related( 'Extra_Meta', $query_params );
	}



	/**
	 * Gets the last-used payment method on this transaction
	 * (we COULD just use the last-made payment, but some payment methods, namely
	 * offline ones, dont' create payments)
	 *
	 * @return EE_Payment_Method
	 * @throws \EE_Error
	 */
	public function payment_method() {
		return $this->get_first_related( 'Payment_Method' );
	}



	/**
	 * Gets the HTML for redirecting the user to an offsite gateway
	 * You can pass it special content to put inside the form, or use
	 * the default inner content (or possibly generate this all yourself using
	 * redirect_url() and redirect_args() or redirect_args_as_inputs()).
	 * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
	 * (and any querystring variables in the redirect_url are converted into html inputs
	 * so browsers submit them properly)
	 *
	 * @param string $inside_form_html
	 * @return string html
	 * @throws \EE_Error
	 */
	public function redirect_form( $inside_form_html = null ) {
		$redirect_url = $this->redirect_url();
		if ( ! empty( $redirect_url ) ) {
			// what ? no inner form content?
			if ( $inside_form_html === null ) {
				$inside_form_html = EEH_HTML::p(
					sprintf(
						__(
							'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
							'event_espresso'
						),
						EEH_HTML::br( 2 ),
						'<input type="submit" value="',
						'">'
					),
					'',
					'',
					'text-align:center;'
				);
			}
			$method = apply_filters(
				'FHEE__EE_Payment__redirect_form__method',
				$this->redirect_args() ? 'POST' : 'GET',
				$this
			);
			//if it's a GET request, we need to remove all the GET params in the querystring
			//and put them into the form instead
			if ( $method === 'GET' ) {
				$querystring = parse_url( $redirect_url, PHP_URL_QUERY );
				$get_params = null;
				parse_str( $querystring, $get_params );
				$inside_form_html .= $this->_args_as_inputs( $get_params );
				$redirect_url = str_replace( '?' . $querystring, '', $redirect_url );
			}
			$form = EEH_HTML::nl( 1 )
			        . '<form method="'
			        . $method
			        . '" name="gateway_form" action="'
			        . $redirect_url
			        . '">';
			$form .= EEH_HTML::nl( 1 ) . $this->redirect_args_as_inputs();
			$form .= $inside_form_html;
			$form .= EEH_HTML::nl( -1 ) . '</form>' . EEH_HTML::nl( -1 );
			return $form;
		} else {
			return null;
		}
	}



	/**
	 * Changes all the name-value pairs of the redirect args into html inputs
	 * and returns the html as a string
	 *
	 * @return string
	 * @throws \EE_Error
	 */
	public function redirect_args_as_inputs() {
		return $this->_args_as_inputs( $this->redirect_args() );
	}



	/**
	 * Converts a 1d array of key-value pairs into html hidden inputs
	 * and returns the string of html
	 *
	 * @param array $args key-value pairs
	 * @return string
	 */
	protected function _args_as_inputs( $args ) {
		$html = '';
		if ( $args !== null && is_array( $args ) ) {
			foreach ( $args as $name => $value ) {
				$html .= EEH_HTML::nl( 0 )
				         . '<input type="hidden" name="'
				         . $name
				         . '" value="'
				         . esc_attr( $value )
				         . '"/>';
			}
		}
		return $html;
	}



	/**
	 * Returns the currency of the payment.
	 * (At the time of writing, this will always be the currency in the configuration;
	 * however in the future it is anticipated that this will be stored on the payment
	 * object itself)
	 *
	 * @return string for the currency code
	 */
	public function currency_code() {
		return EE_Config::instance()->currency->code;
	}



	/**
	 * apply wp_strip_all_tags to all elements within an array
	 *
	 * @access private
	 * @param mixed $item
	 */
	private function _strip_all_tags_within_array( &$item ) {
		if ( is_object( $item ) ) {
			$item = (array)$item;
		}
		if ( is_array( $item ) ) {
			array_walk_recursive( $item, array( $this, '_strip_all_tags_within_array' ) );
		} else {
			$item = wp_strip_all_tags( $item );
		}
	}



	/**
	 * Returns TRUE is this payment was set to approved during this request (or
	 * is approved and was created during this request). False otherwise.
	 *
	 * @return boolean
	 * @throws \EE_Error
	 */
	public function just_approved() {
		$original_status = EEH_Array::is_set(
			$this->_props_n_values_provided_in_constructor,
			'STS_ID',
			$this->get_model()->field_settings_for( 'STS_ID' )->get_default_value()
		);
		$current_status = $this->status();
		if (
			$original_status !== EEM_Payment::status_id_approved
			&& $current_status === EEM_Payment::status_id_approved
		) {
			return true;
		} else {
			return false;
		}
	}



	/**
	 * Overrides parents' get_pretty() function just for legacy reasons
	 * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
	 *
	 * @param string $field_name
	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
	 *                                (in cases where the same property may be used for different outputs
	 *                                - i.e. datetime, money etc.)
	 * @return mixed
	 * @throws \EE_Error
	 */
	public function get_pretty( $field_name, $extra_cache_ref = null ) {
		if ( $field_name === 'PAY_gateway' ) {
			return $this->payment_method() ? $this->payment_method()->name() : __( 'Unknown', 'event_espresso' );
		}
		return $this->_get_cached_property( $field_name, true, $extra_cache_ref );
	}



	/**
	 * Gets details regarding which registrations this payment was applied to
	 *
	 * @param array $query_params like EEM_Base::get_all
	 * @return EE_Registration_Payment[]
	 * @throws \EE_Error
	 */
	public function registration_payments( $query_params = array() ) {
		return $this->get_many_related( 'Registration_Payment', $query_params );
	}



    /**
     * Gets the first event for this payment (it's possible that it could be for multiple)
     *
     * @return EE_Event|null
     */
    public function get_first_event()
    {
        $transaction = $this->transaction();
        if ($transaction instanceof EE_Transaction) {
            $primary_registrant = $transaction->primary_registration();
            if ($primary_registrant instanceof EE_Registration) {
                return $primary_registrant->event_obj();
            }
        }
        return null;
    }



    /**
     * Gets the name of the first event for which is being paid
     *
     * @return string
     */
    public function get_first_event_name()
    {
        $event = $this->get_first_event();
        return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
    }



    /**
     * Returns the payment's transaction's primary registration
     * @return EE_Registration|null
     */
    public function get_primary_registration()
    {
        if ($this->transaction() instanceof EE_Transaction) {
            return $this->transaction()->primary_registration();
        }
        return null;
    }



    /**
     * Gets the payment's transaction's primary registration's attendee, or null
     * @return EE_Attendee|null
     */
    public function get_primary_attendee()
    {
        $primary_reg = $this->get_primary_registration();
        if( $primary_reg instanceof EE_Registration) {
            return $primary_reg->attendee();
        }
        return null;
    }
}
/* End of file EE_Payment.class.php */
/* Location: /includes/classes/EE_Payment.class.php */