eventespresso / event-espresso-core

core/db_models/EEM_Payment.model.php

Indentation +224 added lines, -224 removed lines

@@ -12,232 +12,232 @@
 class EEM_Payment extends EEM_Base implements EEMI_Payment
 {
 
-    // private instance of the Payment object
-    protected static $_instance = null;
+	// private instance of the Payment object
+	protected static $_instance = null;
 
 
 
 /**
-     * Status id in esp_status table that represents an approved payment
-     */
-    const status_id_approved = 'PAP';
-
-
-    /**
-     * Status id in esp_status table that represents a pending payment
-     */
-    const status_id_pending = 'PPN';
-
-
-    /**
-     * Status id in esp_status table that represents a cancelled payment (eg, the
-     * user went to PayPal, but on the paypal site decided to cancel the payment)
-     */
-    const status_id_cancelled = 'PCN';
-
-
-
-    /**
-     * Status id in esp_status table that represents a payment that was declined by
-     * the gateway. (eg, the user's card had no funds, or it was a fraudulent card)
-     */
-    const status_id_declined = 'PDC';
-
-
-
-    /**
-     * Status id in esp_status table that represents a payment that failed for technical reasons.
-     * (Eg, there was some error in communicating with the payment gateway.)
-     */
-    const status_id_failed = 'PFL';
-
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_Payment
-     */
-    protected function __construct($timezone)
-    {
-
-        $this->singular_item = esc_html__('Payment', 'event_espresso');
-        $this->plural_item = esc_html__('Payments', 'event_espresso');
-
-        $this->_tables = array(
-            'Payment' => new EE_Primary_Table('esp_payment', 'PAY_ID')
-        );
-        $this->_fields = array(
-            'Payment' => array(
-                'PAY_ID' => new EE_Primary_Key_Int_Field('PAY_ID', esc_html__('Payment ID', 'event_espresso')),
-                'TXN_ID' => new EE_Foreign_Key_Int_Field('TXN_ID', esc_html__('Transaction ID', 'event_espresso'), false, 0, 'Transaction'),
-                'STS_ID' => new EE_Foreign_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso'), false, EEM_Payment::status_id_failed, 'Status'),
-                'PAY_timestamp' => new EE_Datetime_Field('PAY_timestamp', esc_html__('Timestamp of when payment was attempted', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
-                'PAY_source' => new EE_All_Caps_Text_Field('PAY_source', esc_html__('User-friendly description of payment', 'event_espresso'), false, 'CART'),
-                'PAY_amount' => new EE_Money_Field('PAY_amount', esc_html__('Amount Payment should be for', 'event_espresso'), false, 0),
-                'PMD_ID' => new EE_Foreign_Key_Int_Field('PMD_ID', esc_html__("Payment Method ID", 'event_espresso'), false, null, 'Payment_Method'),
-                'PAY_gateway_response' => new EE_Plain_Text_Field('PAY_gateway_response', esc_html__('Response from Gateway about the payment', 'event_espresso'), false, ''),
-                'PAY_txn_id_chq_nmbr' => new EE_Plain_Text_Field('PAY_txn_id_chq_nmbr', esc_html__('Gateway Transaction ID or Cheque Number', 'event_espresso'), true, ''),
-                'PAY_po_number' => new EE_Plain_Text_Field('PAY_po_number', esc_html__('Purchase or Sales Number', 'event_espresso'), true, ''),
-                'PAY_extra_accntng' => new EE_Simple_HTML_Field('PAY_extra_accntng', esc_html__('Extra Account Info', 'event_espresso'), true, ''),
-                'PAY_details' => new EE_Serialized_Text_Field('PAY_details', esc_html__('Full Gateway response about payment', 'event_espresso'), true, ''),
-                'PAY_redirect_url' => new EE_Plain_Text_Field('PAY_redirect_url', esc_html__("Redirect URL", 'event_espresso'), true),
-                'PAY_redirect_args' => new EE_Serialized_Text_Field('PAY_redirect_args', esc_html__("Key-Value POST vars to send along with redirect", 'event_espresso'), true)
-            )
-        );
-        $this->_model_relations = array(
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Status' => new EE_Belongs_To_Relation(),
-            'Payment_Method' => new EE_Belongs_To_Relation(),
-            'Registration_Payment' => new EE_Has_Many_Relation(),
-            'Registration' => new EE_HABTM_Relation('Registration_Payment'),
-        );
-        $this->_model_chain_to_wp_user = 'Payment_Method';
-        $this->_caps_slug = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-
-
-    /**
-     * Gets the payment by the gateway server's unique ID. Eg, the unique ID PayPal assigned
-     * to the payment. This is handy for verifying an IPN hasn't already been processed.
-     * @param string $PAY_txn_id_chq_nmbr
-     * @return EE_Payment
-     */
-    public function get_payment_by_txn_id_chq_nmbr($PAY_txn_id_chq_nmbr)
-    {
-        return $this->get_one(array(array('PAY_txn_id_chq_nmbr' => $PAY_txn_id_chq_nmbr)));
-    }
-
-
-
-
-    /**
-    *       retrieve  all payments from db for a particular transaction, optionally with
-     *      a particular status
-    *
-    *       @access     public
-    *       @param      $TXN_ID
-     *      @param  string  $status_of_payment one of EEM_Payment::status_id_*, like 'PAP','PCN',etc. If none is provided, gets payments with any status
-    *       @return     EE_Payment[]
-    */
-    public function get_payments_for_transaction($TXN_ID = false, $status_of_payment = null)
-    {
-        // all payments for a TXN ordered chronologically
-        $query_params = array( array( 'TXN_ID' => $TXN_ID ), 'order_by' => array( 'PAY_timestamp' => 'ASC' ));
-        // if provided with a status, search specifically for that status. Otherwise get them all
-        if ($status_of_payment) {
-            $query_params[0]['STS_ID'] = $status_of_payment;
-        }
-        // retrieve payments
-        return $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * Only gets payments which have been approved
-     * @param int $TXN_ID
-     * @return EE_Payment[]
-     */
-    public function get_approved_payments_for_transaction($TXN_ID = 0)
-    {
-        return $this->get_payments_for_transaction($TXN_ID, EEM_Payment::status_id_approved);
-    }
-
-
-
-
-
-    /**
-     * retrieve  all payments from db between two dates,
-     *
-     * @param string $start_date incoming start date. If empty the beginning of today is used.
-     * @param string $end_date   incoming end date. If empty the end of today is used.
-     * @param string $format    If you include $start_date or $end_date then you must include the format string
-     *                              for the format your date is in.
-     * @param string $timezone   If your range is in a different timezone then the current setting on this
-     *                                  WordPress install, then include it here.
-     * @throws EE_Error
-     *
-     * @return EE_Payment[]
-     */
-    public function get_payments_made_between_dates($start_date = '', $end_date = '', $format = '', $timezone = '')
-    {
-        $timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
-        // if $start_date or $end date, verify $format is included.
-        if (( ! empty($start_date) || ! empty($end_date) ) && empty($format)) {
-            throw new EE_Error(esc_html__('You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query', 'event_espresso'));
-        }
-        $now = new DateTime('now');
-        // setup timezone objects once
-        $modelDateTimeZone = new DateTimeZone($this->_timezone);
-        $passedDateTimeZone = new DateTimeZone($timezone);
-        // setup start date
-        $start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
-        EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
-        $start_date = $start_date->format('Y-m-d') . ' 00:00:00';
-        $start_date = strtotime($start_date);
-        // setup end date
-        $end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
-        EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
-        $end_date = $end_date->format('Y-m-d') . ' 23:59:59';
-        $end_date = strtotime($end_date);
-
-        // make sure our start date is the lowest value and vice versa
-        $start = min($start_date, $end_date);
-        $end = max($start_date, $end_date);
-
-        // yes we generated the date and time string in utc but we WANT this start date and time used in the set timezone on the model.
-        $start_date = $this->convert_datetime_for_query('PAY_timestamp', date('Y-m-d', $start) . ' 00:00:00', 'Y-m-d H:i:s', $this->get_timezone());
-        $end_date = $this->convert_datetime_for_query('PAY_timestamp', date('Y-m-d', $end) . ' 23:59:59', 'Y-m-d H:i:s', $this->get_timezone());
-
-        return $this->get_all(array(array('PAY_timestamp' => array('>=',$start_date),'PAY_timestamp*' => array('<=',$end_date))));
-    }
-
-    /**
-     * methods for EEMI_Payment
-     */
-    /**
-     * returns a string for the approved status
-     * @return  string
-     */
-    public function approved_status()
-    {
-        return self::status_id_approved;
-    }
-    /**
-     * returns a string for the pending status
-     * @return  string
-     */
-    public function pending_status()
-    {
-        return self::status_id_pending;
-    }
-    /**
-     * returns a string for the cancelled status
-     * @return  string
-     */
-    public function cancelled_status()
-    {
-        return self::status_id_cancelled;
-    }
-    /**
-     * returns a string for the failed status
-     * @return  string
-     */
-    public function failed_status()
-    {
-        return self::status_id_failed;
-    }
-    /**
-     * returns a string for the declined status
-     * @return  string
-     */
-    public function declined_status()
-    {
-        return self::status_id_declined;
-    }
+ * Status id in esp_status table that represents an approved payment
+ */
+	const status_id_approved = 'PAP';
+
+
+	/**
+	 * Status id in esp_status table that represents a pending payment
+	 */
+	const status_id_pending = 'PPN';
+
+
+	/**
+	 * Status id in esp_status table that represents a cancelled payment (eg, the
+	 * user went to PayPal, but on the paypal site decided to cancel the payment)
+	 */
+	const status_id_cancelled = 'PCN';
+
+
+
+	/**
+	 * Status id in esp_status table that represents a payment that was declined by
+	 * the gateway. (eg, the user's card had no funds, or it was a fraudulent card)
+	 */
+	const status_id_declined = 'PDC';
+
+
+
+	/**
+	 * Status id in esp_status table that represents a payment that failed for technical reasons.
+	 * (Eg, there was some error in communicating with the payment gateway.)
+	 */
+	const status_id_failed = 'PFL';
+
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return EEM_Payment
+	 */
+	protected function __construct($timezone)
+	{
+
+		$this->singular_item = esc_html__('Payment', 'event_espresso');
+		$this->plural_item = esc_html__('Payments', 'event_espresso');
+
+		$this->_tables = array(
+			'Payment' => new EE_Primary_Table('esp_payment', 'PAY_ID')
+		);
+		$this->_fields = array(
+			'Payment' => array(
+				'PAY_ID' => new EE_Primary_Key_Int_Field('PAY_ID', esc_html__('Payment ID', 'event_espresso')),
+				'TXN_ID' => new EE_Foreign_Key_Int_Field('TXN_ID', esc_html__('Transaction ID', 'event_espresso'), false, 0, 'Transaction'),
+				'STS_ID' => new EE_Foreign_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso'), false, EEM_Payment::status_id_failed, 'Status'),
+				'PAY_timestamp' => new EE_Datetime_Field('PAY_timestamp', esc_html__('Timestamp of when payment was attempted', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
+				'PAY_source' => new EE_All_Caps_Text_Field('PAY_source', esc_html__('User-friendly description of payment', 'event_espresso'), false, 'CART'),
+				'PAY_amount' => new EE_Money_Field('PAY_amount', esc_html__('Amount Payment should be for', 'event_espresso'), false, 0),
+				'PMD_ID' => new EE_Foreign_Key_Int_Field('PMD_ID', esc_html__("Payment Method ID", 'event_espresso'), false, null, 'Payment_Method'),
+				'PAY_gateway_response' => new EE_Plain_Text_Field('PAY_gateway_response', esc_html__('Response from Gateway about the payment', 'event_espresso'), false, ''),
+				'PAY_txn_id_chq_nmbr' => new EE_Plain_Text_Field('PAY_txn_id_chq_nmbr', esc_html__('Gateway Transaction ID or Cheque Number', 'event_espresso'), true, ''),
+				'PAY_po_number' => new EE_Plain_Text_Field('PAY_po_number', esc_html__('Purchase or Sales Number', 'event_espresso'), true, ''),
+				'PAY_extra_accntng' => new EE_Simple_HTML_Field('PAY_extra_accntng', esc_html__('Extra Account Info', 'event_espresso'), true, ''),
+				'PAY_details' => new EE_Serialized_Text_Field('PAY_details', esc_html__('Full Gateway response about payment', 'event_espresso'), true, ''),
+				'PAY_redirect_url' => new EE_Plain_Text_Field('PAY_redirect_url', esc_html__("Redirect URL", 'event_espresso'), true),
+				'PAY_redirect_args' => new EE_Serialized_Text_Field('PAY_redirect_args', esc_html__("Key-Value POST vars to send along with redirect", 'event_espresso'), true)
+			)
+		);
+		$this->_model_relations = array(
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Status' => new EE_Belongs_To_Relation(),
+			'Payment_Method' => new EE_Belongs_To_Relation(),
+			'Registration_Payment' => new EE_Has_Many_Relation(),
+			'Registration' => new EE_HABTM_Relation('Registration_Payment'),
+		);
+		$this->_model_chain_to_wp_user = 'Payment_Method';
+		$this->_caps_slug = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+
+
+	/**
+	 * Gets the payment by the gateway server's unique ID. Eg, the unique ID PayPal assigned
+	 * to the payment. This is handy for verifying an IPN hasn't already been processed.
+	 * @param string $PAY_txn_id_chq_nmbr
+	 * @return EE_Payment
+	 */
+	public function get_payment_by_txn_id_chq_nmbr($PAY_txn_id_chq_nmbr)
+	{
+		return $this->get_one(array(array('PAY_txn_id_chq_nmbr' => $PAY_txn_id_chq_nmbr)));
+	}
+
+
+
+
+	/**
+	 *       retrieve  all payments from db for a particular transaction, optionally with
+	 *      a particular status
+	 *
+	 *       @access     public
+	 *       @param      $TXN_ID
+	 *      @param  string  $status_of_payment one of EEM_Payment::status_id_*, like 'PAP','PCN',etc. If none is provided, gets payments with any status
+	 *       @return     EE_Payment[]
+	 */
+	public function get_payments_for_transaction($TXN_ID = false, $status_of_payment = null)
+	{
+		// all payments for a TXN ordered chronologically
+		$query_params = array( array( 'TXN_ID' => $TXN_ID ), 'order_by' => array( 'PAY_timestamp' => 'ASC' ));
+		// if provided with a status, search specifically for that status. Otherwise get them all
+		if ($status_of_payment) {
+			$query_params[0]['STS_ID'] = $status_of_payment;
+		}
+		// retrieve payments
+		return $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * Only gets payments which have been approved
+	 * @param int $TXN_ID
+	 * @return EE_Payment[]
+	 */
+	public function get_approved_payments_for_transaction($TXN_ID = 0)
+	{
+		return $this->get_payments_for_transaction($TXN_ID, EEM_Payment::status_id_approved);
+	}
+
+
+
+
+
+	/**
+	 * retrieve  all payments from db between two dates,
+	 *
+	 * @param string $start_date incoming start date. If empty the beginning of today is used.
+	 * @param string $end_date   incoming end date. If empty the end of today is used.
+	 * @param string $format    If you include $start_date or $end_date then you must include the format string
+	 *                              for the format your date is in.
+	 * @param string $timezone   If your range is in a different timezone then the current setting on this
+	 *                                  WordPress install, then include it here.
+	 * @throws EE_Error
+	 *
+	 * @return EE_Payment[]
+	 */
+	public function get_payments_made_between_dates($start_date = '', $end_date = '', $format = '', $timezone = '')
+	{
+		$timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
+		// if $start_date or $end date, verify $format is included.
+		if (( ! empty($start_date) || ! empty($end_date) ) && empty($format)) {
+			throw new EE_Error(esc_html__('You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query', 'event_espresso'));
+		}
+		$now = new DateTime('now');
+		// setup timezone objects once
+		$modelDateTimeZone = new DateTimeZone($this->_timezone);
+		$passedDateTimeZone = new DateTimeZone($timezone);
+		// setup start date
+		$start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
+		EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
+		$start_date = $start_date->format('Y-m-d') . ' 00:00:00';
+		$start_date = strtotime($start_date);
+		// setup end date
+		$end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
+		EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
+		$end_date = $end_date->format('Y-m-d') . ' 23:59:59';
+		$end_date = strtotime($end_date);
+
+		// make sure our start date is the lowest value and vice versa
+		$start = min($start_date, $end_date);
+		$end = max($start_date, $end_date);
+
+		// yes we generated the date and time string in utc but we WANT this start date and time used in the set timezone on the model.
+		$start_date = $this->convert_datetime_for_query('PAY_timestamp', date('Y-m-d', $start) . ' 00:00:00', 'Y-m-d H:i:s', $this->get_timezone());
+		$end_date = $this->convert_datetime_for_query('PAY_timestamp', date('Y-m-d', $end) . ' 23:59:59', 'Y-m-d H:i:s', $this->get_timezone());
+
+		return $this->get_all(array(array('PAY_timestamp' => array('>=',$start_date),'PAY_timestamp*' => array('<=',$end_date))));
+	}
+
+	/**
+	 * methods for EEMI_Payment
+	 */
+	/**
+	 * returns a string for the approved status
+	 * @return  string
+	 */
+	public function approved_status()
+	{
+		return self::status_id_approved;
+	}
+	/**
+	 * returns a string for the pending status
+	 * @return  string
+	 */
+	public function pending_status()
+	{
+		return self::status_id_pending;
+	}
+	/**
+	 * returns a string for the cancelled status
+	 * @return  string
+	 */
+	public function cancelled_status()
+	{
+		return self::status_id_cancelled;
+	}
+	/**
+	 * returns a string for the failed status
+	 * @return  string
+	 */
+	public function failed_status()
+	{
+		return self::status_id_failed;
+	}
+	/**
+	 * returns a string for the declined status
+	 * @return  string
+	 */
+	public function declined_status()
+	{
+		return self::status_id_declined;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -126,7 +126,7 @@ 
     public function get_payments_for_transaction($TXN_ID = false, $status_of_payment = null)
     {
         // all payments for a TXN ordered chronologically
-        $query_params = array( array( 'TXN_ID' => $TXN_ID ), 'order_by' => array( 'PAY_timestamp' => 'ASC' ));
+        $query_params = array(array('TXN_ID' => $TXN_ID), 'order_by' => array('PAY_timestamp' => 'ASC'));
         // if provided with a status, search specifically for that status. Otherwise get them all
         if ($status_of_payment) {
             $query_params[0]['STS_ID'] = $status_of_payment;
@@ -168,7 +168,7 @@ 
     {
         $timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
         // if $start_date or $end date, verify $format is included.
-        if (( ! empty($start_date) || ! empty($end_date) ) && empty($format)) {
+        if (( ! empty($start_date) || ! empty($end_date)) && empty($format)) {
             throw new EE_Error(esc_html__('You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query', 'event_espresso'));
         }
         $now = new DateTime('now');
@@ -178,12 +178,12 @@ 
         // setup start date
         $start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
         EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
-        $start_date = $start_date->format('Y-m-d') . ' 00:00:00';
+        $start_date = $start_date->format('Y-m-d').' 00:00:00';
         $start_date = strtotime($start_date);
         // setup end date
         $end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
         EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
-        $end_date = $end_date->format('Y-m-d') . ' 23:59:59';
+        $end_date = $end_date->format('Y-m-d').' 23:59:59';
         $end_date = strtotime($end_date);
 
         // make sure our start date is the lowest value and vice versa
@@ -191,10 +191,10 @@ 
         $end = max($start_date, $end_date);
 
         // yes we generated the date and time string in utc but we WANT this start date and time used in the set timezone on the model.
-        $start_date = $this->convert_datetime_for_query('PAY_timestamp', date('Y-m-d', $start) . ' 00:00:00', 'Y-m-d H:i:s', $this->get_timezone());
-        $end_date = $this->convert_datetime_for_query('PAY_timestamp', date('Y-m-d', $end) . ' 23:59:59', 'Y-m-d H:i:s', $this->get_timezone());
+        $start_date = $this->convert_datetime_for_query('PAY_timestamp', date('Y-m-d', $start).' 00:00:00', 'Y-m-d H:i:s', $this->get_timezone());
+        $end_date = $this->convert_datetime_for_query('PAY_timestamp', date('Y-m-d', $end).' 23:59:59', 'Y-m-d H:i:s', $this->get_timezone());
 
-        return $this->get_all(array(array('PAY_timestamp' => array('>=',$start_date),'PAY_timestamp*' => array('<=',$end_date))));
+        return $this->get_all(array(array('PAY_timestamp' => array('>=', $start_date), 'PAY_timestamp*' => array('<=', $end_date))));
     }
 
     /**

core/business/EE_Transaction_Processor.class.php

Indentation +948 added lines, -948 removed lines

@@ -17,952 +17,952 @@
 class EE_Transaction_Processor extends EE_Processor_Base
 {
 
-    /**
-     * @var EE_Registration_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * array of query WHERE params to use when retrieving cached registrations from a transaction
-     *
-     * @var array $registration_query_params
-     * @access private
-     */
-    private $_registration_query_params = array();
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_new_txn_status;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param array $registration_query_params
-     * @return EE_Transaction_Processor instance
-     */
-    public static function instance($registration_query_params = array())
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
-            self::$_instance = new self($registration_query_params);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param array $registration_query_params
-     */
-    private function __construct($registration_query_params = array())
-    {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-    }
-
-
-    /**
-     * @access private
-     * @param array $registration_query_params
-     */
-    private function _set_registration_query_params($registration_query_params)
-    {
-        $this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params
-            : array('order_by' => array('REG_count' => 'ASC'));
-    }
-
-
-    /**
-     * manually_update_registration_statuses
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param string         $new_reg_status
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function manually_update_registration_statuses(
-        EE_Transaction $transaction,
-        $new_reg_status = '',
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'manually_update_registration_status',
-            $transaction,
-            $registration_query_params,
-            $new_reg_status
-        );
-        // send messages
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->trigger_registration_update_notifications(
-            $transaction->primary_registration(),
-            array('manually_updated' => true)
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_for_default_approved_events
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_registration_statuses_for_default_approved_events(
-        EE_Transaction $transaction,
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_for_default_approved_events',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_if_no_monies_owing
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_registration_statuses_if_no_monies_owing(
-        EE_Transaction $transaction,
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_if_no_monies_owing',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * update_transaction_and_registrations_after_checkout_or_payment
-     * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
-     *
-     * @param EE_Transaction     $transaction
-     * @param \EE_Payment | NULL $payment
-     * @param array              $registration_query_params    array of query WHERE params to use
-     *                                                         when retrieving cached registrations from a transaction
-     * @param bool               $trigger_notifications        whether or not to call
-     *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
-     * @return array
-     * @throws \EE_Error
-     */
-    public function update_transaction_and_registrations_after_checkout_or_payment(
-        EE_Transaction $transaction,
-        $payment = null,
-        $registration_query_params = array(),
-        $trigger_notifications = true
-    ) {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // get final reg step status
-        $finalized = $transaction->final_reg_step_completed();
-        // if the 'finalize_registration' step has been initiated (has a timestamp)
-        // but has not yet been fully completed (TRUE)
-        if (is_int($finalized) && $finalized !== false && $finalized !== true) {
-            $transaction->set_reg_step_completed('finalize_registration');
-            $finalized = true;
-        }
-        $transaction->save();
-        // array of details to aid in decision making by systems
-        $update_params = array(
-            'old_txn_status'  => $transaction->old_txn_status(),
-            'new_txn_status'  => $transaction->status_ID(),
-            'finalized'       => $finalized,
-            'revisit'         => $this->_revisit,
-            'payment_updates' => $payment instanceof EE_Payment ? true : false,
-            'last_payment'    => $payment,
-        );
-        // now update the registrations and add the results to our $update_params
-        $update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
-            'update_registration_after_checkout_or_payment',
-            $transaction,
-            $this->_registration_query_params,
-            $update_params
-        );
-        if ($trigger_notifications) {
-            // send messages
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->trigger_registration_update_notifications(
-                $transaction->primary_registration(),
-                $update_params
-            );
-        }
-        do_action(
-            'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
-            $transaction,
-            $update_params
-        );
-        return $update_params;
-    }
-
-
-    /**
-     * update_transaction_after_registration_reopened
-     * readjusts TXN and Line Item totals after a registration is changed from
-     * cancelled or declined to another reg status such as pending payment or approved
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function update_transaction_after_reinstating_canceled_registration(
-        EE_Registration $registration,
-        $closed_reg_statuses = array(),
-        $update_txn = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        try {
-            $transaction = $this->get_transaction_for_registration($registration);
-            $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
-                $transaction,
-                $registration
-            );
-            // un-cancel the ticket
-            $success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save() ? $success : false;
-        }
-        return $success;
-    }
-
-
-    /**
-     * update_transaction_after_canceled_or_declined_registration
-     * readjusts TXN and Line Item totals after a registration is cancelled or declined
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function update_transaction_after_canceled_or_declined_registration(
-        EE_Registration $registration,
-        $closed_reg_statuses = array(),
-        $update_txn = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        try {
-            $transaction = $this->get_transaction_for_registration($registration);
-            if (
-                apply_filters(
-                    'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
-                    true,
-                    $registration,
-                    $transaction
-                )
-            ) {
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
-                    $transaction,
-                    $registration
-                );
-                EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * get_transaction_for_registration
-     *
-     * @access    public
-     * @param    EE_Registration $registration
-     * @return    EE_Transaction
-     * @throws    EE_Error
-     */
-    public function get_transaction_for_registration(EE_Registration $registration)
-    {
-        $transaction = $registration->transaction();
-        if (! $transaction instanceof EE_Transaction) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
-                    $registration->ID()
-                )
-            );
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction_registration
-     *
-     * @access    public
-     * @param    EE_Transaction  $transaction
-     * @param    EE_Registration $registration
-     * @return    EE_Line_Item
-     * @throws    EE_Error
-     */
-    public function get_ticket_line_item_for_transaction_registration(
-        EE_Transaction $transaction,
-        EE_Registration $registration
-    ) {
-        EE_Registry::instance()->load_helper('Line_Item');
-        $ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
-            $transaction->ID(),
-            $registration->ticket_ID()
-        );
-        if (! $ticket_line_item instanceof EE_Line_Item) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID(),
-                    $registration->ticket_ID()
-                )
-            );
-        }
-        return $ticket_line_item;
-    }
-
-
-    /**
-     * cancel_transaction_if_all_registrations_canceled
-     * cycles thru related registrations and checks their statuses
-     * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @param    string         $new_TXN_status
-     * @param    array          $registration_query_params - array of query WHERE params to use when
-     *                                                     retrieving cached registrations from a transaction
-     * @param    array          $closed_reg_statuses
-     * @param    bool           $update_txn
-     * @return    bool            true if TXN status was updated, false if not
-     */
-    public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
-        EE_Transaction $transaction,
-        $new_TXN_status = '',
-        $registration_query_params = array(),
-        $closed_reg_statuses = array(),
-        $update_txn = true
-    ) {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), $closed_reg_statuses)
-            ) {
-                return false;
-            }
-        }
-        if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
-            $transaction->set_status($new_TXN_status);
-        }
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _call_method_on_registrations_via_Registration_Processor
-     * cycles thru related registrations and calls the requested method on each
-     *
-     * @access private
-     * @param string         $method_name
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @param string         $additional_param
-     * @throws \EE_Error
-     * @return boolean
-     */
-    private function _call_method_on_registrations_via_Registration_Processor(
-        $method_name,
-        EE_Transaction $transaction,
-        $registration_query_params = array(),
-        $additional_param = null
-    ) {
-        $response = false;
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
-            throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
-        }
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if ($registration instanceof EE_Registration) {
-                if ($additional_param) {
-                    $response = $registration_processor->{$method_name}($registration, $additional_param)
-                        ? true
-                        : $response;
-                } else {
-                    $response = $registration_processor->{$method_name}($registration)
-                        ? true
-                        : $response;
-                }
-            }
-        }
-        return $response;
-    }
-
-
-    /**
-     * set_transaction_payment_method_based_on_registration_statuses
-     * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
-     * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
-     * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
-     *        the first "default" Payment Method
-     *        the first active Payment Method
-     *    whichever is found first.
-     *
-     * @param  EE_Registration $edited_registration
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_transaction_payment_method_based_on_registration_statuses(
-        EE_Registration $edited_registration
-    ) {
-        if ($edited_registration instanceof EE_Registration) {
-            $transaction = $edited_registration->transaction();
-            if ($transaction instanceof EE_Transaction) {
-                $all_not_approved = true;
-                foreach ($transaction->registrations() as $registration) {
-                    if ($registration instanceof EE_Registration) {
-                        // if any REG != "Not Approved" then toggle to false
-                        $all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
-                    }
-                }
-                // if ALL Registrations are "Not Approved"
-                if ($all_not_approved) {
-                    $transaction->set_payment_method_ID(null);
-                    $transaction->save();
-                } else {
-                    $available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-                        $transaction,
-                        EEM_Payment_Method::scope_cart
-                    );
-                    if (! empty($available_payment_methods)) {
-                        $PMD_ID = 0;
-                        foreach ($available_payment_methods as $available_payment_method) {
-                            if (
-                                $available_payment_method instanceof EE_Payment_Method
-                                && $available_payment_method->open_by_default()
-                            ) {
-                                $PMD_ID = $available_payment_method->ID();
-                                break;
-                            }
-                        }
-                        if (! $PMD_ID) {
-                            $first_payment_method = reset($available_payment_methods);
-                            if ($first_payment_method instanceof EE_Payment_Method) {
-                                $PMD_ID = $first_payment_method->ID();
-                            } else {
-                                EE_Error::add_error(
-                                    esc_html__(
-                                        'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
-                                        'event_espresso'
-                                    ),
-                                    __FILE__,
-                                    __LINE__,
-                                    __FUNCTION__
-                                );
-                            }
-                        }
-                        $transaction->set_payment_method_ID($PMD_ID);
-                        $transaction->save();
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'Please activate at least one Payment Method in order for things to operate correctly.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __LINE__,
-                            __FUNCTION__
-                        );
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function new_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $new_txn_status
-     */
-    public function set_new_txn_status($new_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        $this->_new_txn_status = $new_txn_status;
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @deprecated 4.9.12
-     * @return bool
-     */
-    public function txn_status_updated()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
-    }
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean
-     */
-    public function all_reg_steps_completed(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed();
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @param string         $exception
-     * @return boolean
-     */
-    public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed_except($exception);
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean
-     */
-    public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed_except_final_step();
-    }
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @param string         $reg_step_slug
-     * @return boolean | int
-     */
-    public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->reg_step_completed($reg_step_slug);
-    }
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean | int
-     */
-    public function final_reg_step_completed(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->final_reg_step_completed();
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_initiated($reg_step_slug);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_completed($reg_step_slug);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_not_completed($reg_step_slug);
-    }
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return void
-     */
-    public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        $transaction->remove_reg_step($reg_step_slug);
-    }
-
-
-    /**
-     *    toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param EE_Transaction $transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_failed_transaction_status(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->toggle_failed_transaction_status();
-    }
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param  EE_Transaction $transaction
-     * @return boolean
-     */
-    public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->toggle_abandoned_transaction_status();
-    }
+	/**
+	 * @var EE_Registration_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * array of query WHERE params to use when retrieving cached registrations from a transaction
+	 *
+	 * @var array $registration_query_params
+	 * @access private
+	 */
+	private $_registration_query_params = array();
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_new_txn_status;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param array $registration_query_params
+	 * @return EE_Transaction_Processor instance
+	 */
+	public static function instance($registration_query_params = array())
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Processor) {
+			self::$_instance = new self($registration_query_params);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param array $registration_query_params
+	 */
+	private function __construct($registration_query_params = array())
+	{
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+	}
+
+
+	/**
+	 * @access private
+	 * @param array $registration_query_params
+	 */
+	private function _set_registration_query_params($registration_query_params)
+	{
+		$this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params
+			: array('order_by' => array('REG_count' => 'ASC'));
+	}
+
+
+	/**
+	 * manually_update_registration_statuses
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param string         $new_reg_status
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function manually_update_registration_statuses(
+		EE_Transaction $transaction,
+		$new_reg_status = '',
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'manually_update_registration_status',
+			$transaction,
+			$registration_query_params,
+			$new_reg_status
+		);
+		// send messages
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->trigger_registration_update_notifications(
+			$transaction->primary_registration(),
+			array('manually_updated' => true)
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_for_default_approved_events
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_registration_statuses_for_default_approved_events(
+		EE_Transaction $transaction,
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_for_default_approved_events',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_registration_statuses_if_no_monies_owing(
+		EE_Transaction $transaction,
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_if_no_monies_owing',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * update_transaction_and_registrations_after_checkout_or_payment
+	 * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
+	 *
+	 * @param EE_Transaction     $transaction
+	 * @param \EE_Payment | NULL $payment
+	 * @param array              $registration_query_params    array of query WHERE params to use
+	 *                                                         when retrieving cached registrations from a transaction
+	 * @param bool               $trigger_notifications        whether or not to call
+	 *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_and_registrations_after_checkout_or_payment(
+		EE_Transaction $transaction,
+		$payment = null,
+		$registration_query_params = array(),
+		$trigger_notifications = true
+	) {
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// get final reg step status
+		$finalized = $transaction->final_reg_step_completed();
+		// if the 'finalize_registration' step has been initiated (has a timestamp)
+		// but has not yet been fully completed (TRUE)
+		if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+			$transaction->set_reg_step_completed('finalize_registration');
+			$finalized = true;
+		}
+		$transaction->save();
+		// array of details to aid in decision making by systems
+		$update_params = array(
+			'old_txn_status'  => $transaction->old_txn_status(),
+			'new_txn_status'  => $transaction->status_ID(),
+			'finalized'       => $finalized,
+			'revisit'         => $this->_revisit,
+			'payment_updates' => $payment instanceof EE_Payment ? true : false,
+			'last_payment'    => $payment,
+		);
+		// now update the registrations and add the results to our $update_params
+		$update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
+			'update_registration_after_checkout_or_payment',
+			$transaction,
+			$this->_registration_query_params,
+			$update_params
+		);
+		if ($trigger_notifications) {
+			// send messages
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->trigger_registration_update_notifications(
+				$transaction->primary_registration(),
+				$update_params
+			);
+		}
+		do_action(
+			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
+			$transaction,
+			$update_params
+		);
+		return $update_params;
+	}
+
+
+	/**
+	 * update_transaction_after_registration_reopened
+	 * readjusts TXN and Line Item totals after a registration is changed from
+	 * cancelled or declined to another reg status such as pending payment or approved
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_after_reinstating_canceled_registration(
+		EE_Registration $registration,
+		$closed_reg_statuses = array(),
+		$update_txn = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		try {
+			$transaction = $this->get_transaction_for_registration($registration);
+			$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
+				$transaction,
+				$registration
+			);
+			// un-cancel the ticket
+			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save() ? $success : false;
+		}
+		return $success;
+	}
+
+
+	/**
+	 * update_transaction_after_canceled_or_declined_registration
+	 * readjusts TXN and Line Item totals after a registration is cancelled or declined
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_after_canceled_or_declined_registration(
+		EE_Registration $registration,
+		$closed_reg_statuses = array(),
+		$update_txn = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		try {
+			$transaction = $this->get_transaction_for_registration($registration);
+			if (
+				apply_filters(
+					'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
+					true,
+					$registration,
+					$transaction
+				)
+			) {
+				$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
+					$transaction,
+					$registration
+				);
+				EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * get_transaction_for_registration
+	 *
+	 * @access    public
+	 * @param    EE_Registration $registration
+	 * @return    EE_Transaction
+	 * @throws    EE_Error
+	 */
+	public function get_transaction_for_registration(EE_Registration $registration)
+	{
+		$transaction = $registration->transaction();
+		if (! $transaction instanceof EE_Transaction) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
+					$registration->ID()
+				)
+			);
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction_registration
+	 *
+	 * @access    public
+	 * @param    EE_Transaction  $transaction
+	 * @param    EE_Registration $registration
+	 * @return    EE_Line_Item
+	 * @throws    EE_Error
+	 */
+	public function get_ticket_line_item_for_transaction_registration(
+		EE_Transaction $transaction,
+		EE_Registration $registration
+	) {
+		EE_Registry::instance()->load_helper('Line_Item');
+		$ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
+			$transaction->ID(),
+			$registration->ticket_ID()
+		);
+		if (! $ticket_line_item instanceof EE_Line_Item) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
+						'event_espresso'
+					),
+					$transaction->ID(),
+					$registration->ticket_ID()
+				)
+			);
+		}
+		return $ticket_line_item;
+	}
+
+
+	/**
+	 * cancel_transaction_if_all_registrations_canceled
+	 * cycles thru related registrations and checks their statuses
+	 * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @param    string         $new_TXN_status
+	 * @param    array          $registration_query_params - array of query WHERE params to use when
+	 *                                                     retrieving cached registrations from a transaction
+	 * @param    array          $closed_reg_statuses
+	 * @param    bool           $update_txn
+	 * @return    bool            true if TXN status was updated, false if not
+	 */
+	public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
+		EE_Transaction $transaction,
+		$new_TXN_status = '',
+		$registration_query_params = array(),
+		$closed_reg_statuses = array(),
+		$update_txn = true
+	) {
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), $closed_reg_statuses)
+			) {
+				return false;
+			}
+		}
+		if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
+			$transaction->set_status($new_TXN_status);
+		}
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _call_method_on_registrations_via_Registration_Processor
+	 * cycles thru related registrations and calls the requested method on each
+	 *
+	 * @access private
+	 * @param string         $method_name
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @param string         $additional_param
+	 * @throws \EE_Error
+	 * @return boolean
+	 */
+	private function _call_method_on_registrations_via_Registration_Processor(
+		$method_name,
+		EE_Transaction $transaction,
+		$registration_query_params = array(),
+		$additional_param = null
+	) {
+		$response = false;
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		// check that method exists
+		if (! method_exists($registration_processor, $method_name)) {
+			throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
+		}
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration) {
+				if ($additional_param) {
+					$response = $registration_processor->{$method_name}($registration, $additional_param)
+						? true
+						: $response;
+				} else {
+					$response = $registration_processor->{$method_name}($registration)
+						? true
+						: $response;
+				}
+			}
+		}
+		return $response;
+	}
+
+
+	/**
+	 * set_transaction_payment_method_based_on_registration_statuses
+	 * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
+	 * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
+	 * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
+	 *        the first "default" Payment Method
+	 *        the first active Payment Method
+	 *    whichever is found first.
+	 *
+	 * @param  EE_Registration $edited_registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_transaction_payment_method_based_on_registration_statuses(
+		EE_Registration $edited_registration
+	) {
+		if ($edited_registration instanceof EE_Registration) {
+			$transaction = $edited_registration->transaction();
+			if ($transaction instanceof EE_Transaction) {
+				$all_not_approved = true;
+				foreach ($transaction->registrations() as $registration) {
+					if ($registration instanceof EE_Registration) {
+						// if any REG != "Not Approved" then toggle to false
+						$all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
+					}
+				}
+				// if ALL Registrations are "Not Approved"
+				if ($all_not_approved) {
+					$transaction->set_payment_method_ID(null);
+					$transaction->save();
+				} else {
+					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+						$transaction,
+						EEM_Payment_Method::scope_cart
+					);
+					if (! empty($available_payment_methods)) {
+						$PMD_ID = 0;
+						foreach ($available_payment_methods as $available_payment_method) {
+							if (
+								$available_payment_method instanceof EE_Payment_Method
+								&& $available_payment_method->open_by_default()
+							) {
+								$PMD_ID = $available_payment_method->ID();
+								break;
+							}
+						}
+						if (! $PMD_ID) {
+							$first_payment_method = reset($available_payment_methods);
+							if ($first_payment_method instanceof EE_Payment_Method) {
+								$PMD_ID = $first_payment_method->ID();
+							} else {
+								EE_Error::add_error(
+									esc_html__(
+										'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
+										'event_espresso'
+									),
+									__FILE__,
+									__LINE__,
+									__FUNCTION__
+								);
+							}
+						}
+						$transaction->set_payment_method_ID($PMD_ID);
+						$transaction->save();
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'Please activate at least one Payment Method in order for things to operate correctly.',
+								'event_espresso'
+							),
+							__FILE__,
+							__LINE__,
+							__FUNCTION__
+						);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function new_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $new_txn_status
+	 */
+	public function set_new_txn_status($new_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		$this->_new_txn_status = $new_txn_status;
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @deprecated 4.9.12
+	 * @return bool
+	 */
+	public function txn_status_updated()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
+	}
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed();
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @param string         $exception
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed_except($exception);
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed_except_final_step();
+	}
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @param string         $reg_step_slug
+	 * @return boolean | int
+	 */
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->reg_step_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean | int
+	 */
+	public function final_reg_step_completed(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->final_reg_step_completed();
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_initiated($reg_step_slug);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_not_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return void
+	 */
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		$transaction->remove_reg_step($reg_step_slug);
+	}
+
+
+	/**
+	 *    toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param EE_Transaction $transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_failed_transaction_status(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->toggle_failed_transaction_status();
+	}
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param  EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->toggle_abandoned_transaction_status();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -53,7 +53,7 @@ 
     public static function instance($registration_query_params = array())
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
+        if ( ! self::$_instance instanceof EE_Transaction_Processor) {
             self::$_instance = new self($registration_query_params);
         }
         return self::$_instance;
@@ -311,7 +311,7 @@ 
         // these reg statuses should not be considered in any calculations involving monies owing
         $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
             : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         try {
@@ -365,7 +365,7 @@ 
     public function get_transaction_for_registration(EE_Registration $registration)
     {
         $transaction = $registration->transaction();
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
@@ -395,7 +395,7 @@ 
             $transaction->ID(),
             $registration->ticket_ID()
         );
-        if (! $ticket_line_item instanceof EE_Line_Item) {
+        if ( ! $ticket_line_item instanceof EE_Line_Item) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -479,7 +479,7 @@ 
         /** @type EE_Registration_Processor $registration_processor */
         $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
         // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
+        if ( ! method_exists($registration_processor, $method_name)) {
             throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
         }
         // make sure some query params are set for retrieving registrations
@@ -537,7 +537,7 @@ 
                         $transaction,
                         EEM_Payment_Method::scope_cart
                     );
-                    if (! empty($available_payment_methods)) {
+                    if ( ! empty($available_payment_methods)) {
                         $PMD_ID = 0;
                         foreach ($available_payment_methods as $available_payment_method) {
                             if (
@@ -548,7 +548,7 @@ 
                                 break;
                             }
                         }
-                        if (! $PMD_ID) {
+                        if ( ! $PMD_ID) {
                             $first_payment_method = reset($available_payment_methods);
                             if ($first_payment_method instanceof EE_Payment_Method) {
                                 $PMD_ID = $first_payment_method->ID();

core/business/EE_Transaction_Payments.class.php

Indentation +420 added lines, -420 removed lines

@@ -15,424 +15,424 @@
 class EE_Transaction_Payments
 {
 
-    /**
-     * @var EE_Transaction_Payments $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_new_txn_status;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Transaction_Payments instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * recalculate_transaction_total
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @param bool           $update_txn
-     * @return bool true if TXN total was updated, false if not
-     * @throws \EE_Error
-     */
-    public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
-    {
-        $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
-                    $transaction->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $new_total = $total_line_item->recalculate_total_including_taxes();
-        $transaction->set_total($new_total);
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * returns a boolean for whether the TXN was saved to the db
-     * (meaning a status change occurred)
-     * or not saved (which could **still** mean that
-     * the TXN status changed, but just was not yet saved).
-     * So if passing a value of false for the $update_txn param,
-     * then client code needs to take responsibility for saving the TXN
-     * regardless of what happens within EE_Transaction_Payments;
-     *
-     * @param            EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID
-     * @param    boolean $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws \EE_Error
-     */
-    public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
-    {
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // calculate total paid
-        $total_paid = $this->recalculate_total_payments_for_transaction($transaction);
-        // if total paid has changed
-        if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
-            $transaction->set_paid($total_paid);
-            // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
-                if ($update_txn) {
-                    return $transaction->save() ? true : false;
-                }
-            } else {
-                // the status got updated and was saved by
-                // update_transaction_status_based_on_total_paid()
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * recalculate_total_payments_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
-     *                                       By default, searches for approved payments
-     * @return float|false   float on success, false on fail
-     * @throws \EE_Error
-     */
-    public function recalculate_total_payments_for_transaction(
-        EE_Transaction $transaction,
-        $payment_status = EEM_Payment::status_id_approved
-    ) {
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // ensure Payment model is loaded
-        EE_Registry::instance()->load_model('Payment');
-        // calls EEM_Base::sum()
-        return EEM_Payment::instance()->sum(
-            // query params
-            array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
-            // field to sum
-            'PAY_amount'
-        );
-    }
-
-
-    /**
-     * delete_payment_and_update_transaction
-     * Before deleting the selected payment, we fetch it's transaction,
-     * then delete the payment, and update the transactions' amount paid.
-     *
-     * @param EE_Payment $payment
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function delete_payment_and_update_transaction(EE_Payment $payment)
-    {
-        // verify payment
-        if (! $payment instanceof EE_Payment) {
-            EE_Error::add_error(
-                esc_html__('A valid Payment object was not received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
-            return false;
-        }
-        if (! $payment->delete()) {
-            EE_Error::add_error(
-                esc_html__('The payment could not be deleted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        $transaction = $payment->transaction();
-        $TXN_status = $transaction->status_ID();
-        if (
-            $TXN_status === EEM_Transaction::abandoned_status_code
-            || $TXN_status === EEM_Transaction::failed_status_code
-            || $payment->amount() === 0
-        ) {
-            EE_Error::add_success(esc_html__('The Payment was successfully deleted.', 'event_espresso'));
-            return true;
-        }
-
-
-        // if this fails, that just means that the transaction didn't get its status changed and/or updated.
-        // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_attention(
-                esc_html__(
-                    'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return true;
-        }
-
-        EE_Error::add_success(
-            esc_html__(
-                'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
-                'event_espresso'
-            )
-        );
-        return true;
-    }
-
-
-    /**
-     * delete_registration_payments_and_update_registrations
-     *
-     * removes all registration payment records associated with a payment
-     * and subtracts their amounts from the corresponding registrations REG_paid field
-     *
-     * @param EE_Payment $payment
-     * @param array      $reg_payment_query_params
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function delete_registration_payments_and_update_registrations(
-        EE_Payment $payment,
-        $reg_payment_query_params = array()
-    ) {
-        $save_payment = false;
-        $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
-            : array(array('PAY_ID' => $payment->ID()));
-        $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
-            foreach ($registration_payments as $registration_payment) {
-                if ($registration_payment instanceof EE_Registration_Payment) {
-                    $amount_paid = $registration_payment->amount();
-                    $registration = $registration_payment->registration();
-                    if ($registration instanceof EE_Registration) {
-                        $registration->set_paid($registration->paid() - $amount_paid);
-                        if ($registration->save() !== false) {
-                            $registration_payment->delete_permanently();
-                            $save_payment = true;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'An invalid Registration object was associated with Registration Payment ID# %1$d.',
-                                    'event_espresso'
-                                ),
-                                $registration_payment->ID()
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'An invalid Registration Payment object was associated with payment ID# %1$d.',
-                                'event_espresso'
-                            ),
-                            $payment->ID()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        if ($save_payment) {
-            $payment->save();
-        }
-        return true;
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @deprecated 4.9.1
-     * @param EE_Transaction $transaction
-     * @param    boolean     $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws \EE_Error
-     */
-    public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction::update_status_based_on_total_paid()'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        return $transaction->update_status_based_on_total_paid($update_txn);
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function new_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $new_txn_status
-     */
-    public function set_new_txn_status($new_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        $this->_new_txn_status = $new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return bool
-     */
-    public function txn_status_updated()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
-    }
+	/**
+	 * @var EE_Transaction_Payments $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_new_txn_status;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Transaction_Payments instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Payments) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * recalculate_transaction_total
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @param bool           $update_txn
+	 * @return bool true if TXN total was updated, false if not
+	 * @throws \EE_Error
+	 */
+	public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
+	{
+		$total_line_item = $transaction->total_line_item();
+		if (! $total_line_item instanceof EE_Line_Item) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
+					$transaction->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$new_total = $total_line_item->recalculate_total_including_taxes();
+		$transaction->set_total($new_total);
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * returns a boolean for whether the TXN was saved to the db
+	 * (meaning a status change occurred)
+	 * or not saved (which could **still** mean that
+	 * the TXN status changed, but just was not yet saved).
+	 * So if passing a value of false for the $update_txn param,
+	 * then client code needs to take responsibility for saving the TXN
+	 * regardless of what happens within EE_Transaction_Payments;
+	 *
+	 * @param            EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID
+	 * @param    boolean $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws \EE_Error
+	 */
+	public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
+	{
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// calculate total paid
+		$total_paid = $this->recalculate_total_payments_for_transaction($transaction);
+		// if total paid has changed
+		if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
+			$transaction->set_paid($total_paid);
+			// maybe update status, and make sure to save transaction if not done already
+			if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+				if ($update_txn) {
+					return $transaction->save() ? true : false;
+				}
+			} else {
+				// the status got updated and was saved by
+				// update_transaction_status_based_on_total_paid()
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * recalculate_total_payments_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
+	 *                                       By default, searches for approved payments
+	 * @return float|false   float on success, false on fail
+	 * @throws \EE_Error
+	 */
+	public function recalculate_total_payments_for_transaction(
+		EE_Transaction $transaction,
+		$payment_status = EEM_Payment::status_id_approved
+	) {
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// ensure Payment model is loaded
+		EE_Registry::instance()->load_model('Payment');
+		// calls EEM_Base::sum()
+		return EEM_Payment::instance()->sum(
+			// query params
+			array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
+			// field to sum
+			'PAY_amount'
+		);
+	}
+
+
+	/**
+	 * delete_payment_and_update_transaction
+	 * Before deleting the selected payment, we fetch it's transaction,
+	 * then delete the payment, and update the transactions' amount paid.
+	 *
+	 * @param EE_Payment $payment
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function delete_payment_and_update_transaction(EE_Payment $payment)
+	{
+		// verify payment
+		if (! $payment instanceof EE_Payment) {
+			EE_Error::add_error(
+				esc_html__('A valid Payment object was not received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+			return false;
+		}
+		if (! $payment->delete()) {
+			EE_Error::add_error(
+				esc_html__('The payment could not be deleted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		$transaction = $payment->transaction();
+		$TXN_status = $transaction->status_ID();
+		if (
+			$TXN_status === EEM_Transaction::abandoned_status_code
+			|| $TXN_status === EEM_Transaction::failed_status_code
+			|| $payment->amount() === 0
+		) {
+			EE_Error::add_success(esc_html__('The Payment was successfully deleted.', 'event_espresso'));
+			return true;
+		}
+
+
+		// if this fails, that just means that the transaction didn't get its status changed and/or updated.
+		// however the payment was still deleted.
+		if (! $this->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_attention(
+				esc_html__(
+					'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return true;
+		}
+
+		EE_Error::add_success(
+			esc_html__(
+				'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
+				'event_espresso'
+			)
+		);
+		return true;
+	}
+
+
+	/**
+	 * delete_registration_payments_and_update_registrations
+	 *
+	 * removes all registration payment records associated with a payment
+	 * and subtracts their amounts from the corresponding registrations REG_paid field
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $reg_payment_query_params
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function delete_registration_payments_and_update_registrations(
+		EE_Payment $payment,
+		$reg_payment_query_params = array()
+	) {
+		$save_payment = false;
+		$reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
+			: array(array('PAY_ID' => $payment->ID()));
+		$registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
+		if (! empty($registration_payments)) {
+			foreach ($registration_payments as $registration_payment) {
+				if ($registration_payment instanceof EE_Registration_Payment) {
+					$amount_paid = $registration_payment->amount();
+					$registration = $registration_payment->registration();
+					if ($registration instanceof EE_Registration) {
+						$registration->set_paid($registration->paid() - $amount_paid);
+						if ($registration->save() !== false) {
+							$registration_payment->delete_permanently();
+							$save_payment = true;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'An invalid Registration object was associated with Registration Payment ID# %1$d.',
+									'event_espresso'
+								),
+								$registration_payment->ID()
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'An invalid Registration Payment object was associated with payment ID# %1$d.',
+								'event_espresso'
+							),
+							$payment->ID()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		if ($save_payment) {
+			$payment->save();
+		}
+		return true;
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @deprecated 4.9.1
+	 * @param EE_Transaction $transaction
+	 * @param    boolean     $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction::update_status_based_on_total_paid()'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		return $transaction->update_status_based_on_total_paid($update_txn);
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function new_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $new_txn_status
+	 */
+	public function set_new_txn_status($new_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		$this->_new_txn_status = $new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return bool
+	 */
+	public function txn_status_updated()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -42,7 +42,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
+        if ( ! self::$_instance instanceof EE_Transaction_Payments) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -61,7 +61,7 @@ 
     public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
     {
         $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
+        if ( ! $total_line_item instanceof EE_Line_Item) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
@@ -100,7 +100,7 @@ 
     public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
     {
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,
@@ -115,7 +115,7 @@ 
         if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
             $transaction->set_paid($total_paid);
             // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+            if ( ! $transaction->update_status_based_on_total_paid($update_txn)) {
                 if ($update_txn) {
                     return $transaction->save() ? true : false;
                 }
@@ -144,7 +144,7 @@ 
         $payment_status = EEM_Payment::status_id_approved
     ) {
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,
@@ -177,7 +177,7 @@ 
     public function delete_payment_and_update_transaction(EE_Payment $payment)
     {
         // verify payment
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             EE_Error::add_error(
                 esc_html__('A valid Payment object was not received.', 'event_espresso'),
                 __FILE__,
@@ -186,10 +186,10 @@ 
             );
             return false;
         }
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+        if ( ! $this->delete_registration_payments_and_update_registrations($payment)) {
             return false;
         }
-        if (! $payment->delete()) {
+        if ( ! $payment->delete()) {
             EE_Error::add_error(
                 esc_html__('The payment could not be deleted.', 'event_espresso'),
                 __FILE__,
@@ -213,7 +213,7 @@ 
 
         // if this fails, that just means that the transaction didn't get its status changed and/or updated.
         // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
+        if ( ! $this->calculate_total_payments_and_update_status($transaction)) {
             EE_Error::add_attention(
                 esc_html__(
                     'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
@@ -255,7 +255,7 @@ 
         $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
             : array(array('PAY_ID' => $payment->ID()));
         $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
+        if ( ! empty($registration_payments)) {
             foreach ($registration_payments as $registration_payment) {
                 if ($registration_payment instanceof EE_Registration_Payment) {
                     $amount_paid = $registration_payment->amount();
@@ -321,7 +321,7 @@ 
     public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction::update_status_based_on_total_paid()'
@@ -330,7 +330,7 @@ 
             '5.0.0'
         );
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,

core/domain/entities/DbSafeDateTime.php

Indentation +184 added lines, -184 removed lines

@@ -18,188 +18,188 @@
 class DbSafeDateTime extends DateTime
 {
 
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    /**
-     * @type string db_safe_timestamp_format
-     */
-    const db_safe_timestamp_format = 'Y-m-d H:i:s O e';
-    // phpcs:enable
-
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * DateTime object converted to a string that includes the date, time, UTC offset, and timezone identifier
-     *
-     * @type string $_datetime_string
-     */
-    protected $_datetime_string = '';
-
-    /**
-     * where to write the error log to
-     *
-     * @type string $_error_log_dir
-     */
-    protected $_error_log_dir = '';
-    // phpcs:enable
-
-
-    /**
-     * @param string $error_log_dir
-     */
-    public function setErrorLogDir($error_log_dir)
-    {
-        // if the folder path is writable, then except the path + filename, else keep empty
-        $this->_error_log_dir = is_writable(str_replace(basename($error_log_dir), '', $error_log_dir))
-            ? $error_log_dir
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->format(DbSafeDateTime::db_safe_timestamp_format);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function __sleep()
-    {
-        $this->_datetime_string = $this->format(DbSafeDateTime::db_safe_timestamp_format);
-        $date = DateTime::createFromFormat(
-            DbSafeDateTime::db_safe_timestamp_format,
-            $this->_datetime_string
-        );
-        if (! $date instanceof DateTime) {
-            try {
-                // we want a stack trace to determine where the malformed date came from, so...
-                throw new DomainException('');
-            } catch (DomainException $e) {
-                $stack_trace = $e->getTraceAsString();
-            }
-            $this->writeToErrorLog(
-                sprintf(
-                    esc_html__(
-                        'A valid DateTime could not be generated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s %2$s Stack Trace: %5$s',
-                        'event_espresso'
-                    ),
-                    $this->_datetime_string,
-                    '<br />',
-                    print_r(DateTime::getLastErrors(), true),
-                    PHP_VERSION,
-                    $stack_trace
-                )
-            );
-        }
-        return array('_datetime_string');
-    }
-
-
-    /**
-     * if an empty or null value got saved to the db for a datetime,
-     * then some servers and/or PHP itself will incorrectly convert that date string
-     * resulting in "-0001-11-30" for the year-month-day.
-     * see the Notes section
-     *
-     * @link http://php.net/manual/en/datetime.formats.date.php
-     * We'll replace those with "0000-00-00" which will allow a valid DateTime object to be created,
-     * but still result in the internal date for that object being set to "-0001-11-30 10:00:00.000000".
-     * so we're no better off, but at least things won't go fatal on us.
-     */
-    public function __wakeup()
-    {
-        $date = self::createFromFormat(
-            DbSafeDateTime::db_safe_timestamp_format,
-            $this->_datetime_string
-        );
-        if (! $date instanceof DateTime) {
-            $this->writeToErrorLog(
-                sprintf(
-                    esc_html__(
-                        'A valid DateTime could not be recreated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s',
-                        'event_espresso'
-                    ),
-                    $this->_datetime_string,
-                    '<br />',
-                    print_r(DateTime::getLastErrors(), true),
-                    PHP_VERSION
-                )
-            );
-        } else {
-            $this->__construct(
-                $date->format(\EE_Datetime_Field::mysql_timestamp_format),
-                new DateTimeZone($date->format('e'))
-            );
-        }
-    }
-
-
-    /**
-     * Normalizes incoming date string so that it is a bit more stable for use.
-     * @param string $date_string
-     * @return string
-     */
-    public static function normalizeInvalidDate($date_string)
-    {
-        return str_replace(
-            array('-0001-11-29', '-0001-11-30', '0000-00-00'),
-            '0000-01-03',
-            $date_string
-        );
-    }
-
-
-    /**
-     * Creates a DbSafeDateTime from ye old DateTime
-     *
-     * @param DateTime $datetime
-     * @return \EventEspresso\core\domain\entities\DbSafeDateTime
-     */
-    public static function createFromDateTime(DateTime $datetime)
-    {
-        return new DbSafeDateTime(
-            $datetime->format(\EE_Datetime_Field::mysql_timestamp_format),
-            new DateTimeZone($datetime->format('e'))
-        );
-    }
-
-
-    /**
-     * Parse a string into a new DateTime object according to the specified format
-     *
-     * @param string       $format   Format accepted by date().
-     * @param string       $time     String representing the time.
-     * @param DateTimeZone $timezone A DateTimeZone object representing the desired time zone.
-     * @return DbSafeDateTime|boolean
-     * @link https://php.net/manual/en/datetime.createfromformat.php
-     */
-    public static function createFromFormat($format, $time, $timezone = null)
-    {
-        $time = self::normalizeInvalidDate($time);
-        // Various php versions handle the third argument differently.  This conditional accounts for that.
-        $DateTime = $timezone === null
-            ? parent::createFromFormat($format, $time)
-            : parent::createFromFormat($format, $time, $timezone);
-        return $DateTime instanceof DateTime
-            ? self::createFromDateTime($DateTime)
-            : $DateTime;
-    }
-
-
-    /**
-     * @param string $message
-     */
-    private function writeToErrorLog($message)
-    {
-        if (! empty($this->_error_log_dir)) {
-            /** @noinspection ForgottenDebugOutputInspection */
-            error_log($message, 3, $this->_error_log_dir);
-        } else {
-            /** @noinspection ForgottenDebugOutputInspection */
-            error_log($message);
-        }
-    }
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	/**
+	 * @type string db_safe_timestamp_format
+	 */
+	const db_safe_timestamp_format = 'Y-m-d H:i:s O e';
+	// phpcs:enable
+
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * DateTime object converted to a string that includes the date, time, UTC offset, and timezone identifier
+	 *
+	 * @type string $_datetime_string
+	 */
+	protected $_datetime_string = '';
+
+	/**
+	 * where to write the error log to
+	 *
+	 * @type string $_error_log_dir
+	 */
+	protected $_error_log_dir = '';
+	// phpcs:enable
+
+
+	/**
+	 * @param string $error_log_dir
+	 */
+	public function setErrorLogDir($error_log_dir)
+	{
+		// if the folder path is writable, then except the path + filename, else keep empty
+		$this->_error_log_dir = is_writable(str_replace(basename($error_log_dir), '', $error_log_dir))
+			? $error_log_dir
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->format(DbSafeDateTime::db_safe_timestamp_format);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$this->_datetime_string = $this->format(DbSafeDateTime::db_safe_timestamp_format);
+		$date = DateTime::createFromFormat(
+			DbSafeDateTime::db_safe_timestamp_format,
+			$this->_datetime_string
+		);
+		if (! $date instanceof DateTime) {
+			try {
+				// we want a stack trace to determine where the malformed date came from, so...
+				throw new DomainException('');
+			} catch (DomainException $e) {
+				$stack_trace = $e->getTraceAsString();
+			}
+			$this->writeToErrorLog(
+				sprintf(
+					esc_html__(
+						'A valid DateTime could not be generated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s %2$s Stack Trace: %5$s',
+						'event_espresso'
+					),
+					$this->_datetime_string,
+					'<br />',
+					print_r(DateTime::getLastErrors(), true),
+					PHP_VERSION,
+					$stack_trace
+				)
+			);
+		}
+		return array('_datetime_string');
+	}
+
+
+	/**
+	 * if an empty or null value got saved to the db for a datetime,
+	 * then some servers and/or PHP itself will incorrectly convert that date string
+	 * resulting in "-0001-11-30" for the year-month-day.
+	 * see the Notes section
+	 *
+	 * @link http://php.net/manual/en/datetime.formats.date.php
+	 * We'll replace those with "0000-00-00" which will allow a valid DateTime object to be created,
+	 * but still result in the internal date for that object being set to "-0001-11-30 10:00:00.000000".
+	 * so we're no better off, but at least things won't go fatal on us.
+	 */
+	public function __wakeup()
+	{
+		$date = self::createFromFormat(
+			DbSafeDateTime::db_safe_timestamp_format,
+			$this->_datetime_string
+		);
+		if (! $date instanceof DateTime) {
+			$this->writeToErrorLog(
+				sprintf(
+					esc_html__(
+						'A valid DateTime could not be recreated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s',
+						'event_espresso'
+					),
+					$this->_datetime_string,
+					'<br />',
+					print_r(DateTime::getLastErrors(), true),
+					PHP_VERSION
+				)
+			);
+		} else {
+			$this->__construct(
+				$date->format(\EE_Datetime_Field::mysql_timestamp_format),
+				new DateTimeZone($date->format('e'))
+			);
+		}
+	}
+
+
+	/**
+	 * Normalizes incoming date string so that it is a bit more stable for use.
+	 * @param string $date_string
+	 * @return string
+	 */
+	public static function normalizeInvalidDate($date_string)
+	{
+		return str_replace(
+			array('-0001-11-29', '-0001-11-30', '0000-00-00'),
+			'0000-01-03',
+			$date_string
+		);
+	}
+
+
+	/**
+	 * Creates a DbSafeDateTime from ye old DateTime
+	 *
+	 * @param DateTime $datetime
+	 * @return \EventEspresso\core\domain\entities\DbSafeDateTime
+	 */
+	public static function createFromDateTime(DateTime $datetime)
+	{
+		return new DbSafeDateTime(
+			$datetime->format(\EE_Datetime_Field::mysql_timestamp_format),
+			new DateTimeZone($datetime->format('e'))
+		);
+	}
+
+
+	/**
+	 * Parse a string into a new DateTime object according to the specified format
+	 *
+	 * @param string       $format   Format accepted by date().
+	 * @param string       $time     String representing the time.
+	 * @param DateTimeZone $timezone A DateTimeZone object representing the desired time zone.
+	 * @return DbSafeDateTime|boolean
+	 * @link https://php.net/manual/en/datetime.createfromformat.php
+	 */
+	public static function createFromFormat($format, $time, $timezone = null)
+	{
+		$time = self::normalizeInvalidDate($time);
+		// Various php versions handle the third argument differently.  This conditional accounts for that.
+		$DateTime = $timezone === null
+			? parent::createFromFormat($format, $time)
+			: parent::createFromFormat($format, $time, $timezone);
+		return $DateTime instanceof DateTime
+			? self::createFromDateTime($DateTime)
+			: $DateTime;
+	}
+
+
+	/**
+	 * @param string $message
+	 */
+	private function writeToErrorLog($message)
+	{
+		if (! empty($this->_error_log_dir)) {
+			/** @noinspection ForgottenDebugOutputInspection */
+			error_log($message, 3, $this->_error_log_dir);
+		} else {
+			/** @noinspection ForgottenDebugOutputInspection */
+			error_log($message);
+		}
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
             DbSafeDateTime::db_safe_timestamp_format,
             $this->_datetime_string
         );
-        if (! $date instanceof DateTime) {
+        if ( ! $date instanceof DateTime) {
             try {
                 // we want a stack trace to determine where the malformed date came from, so...
                 throw new DomainException('');
@@ -115,7 +115,7 @@ 
             DbSafeDateTime::db_safe_timestamp_format,
             $this->_datetime_string
         );
-        if (! $date instanceof DateTime) {
+        if ( ! $date instanceof DateTime) {
             $this->writeToErrorLog(
                 sprintf(
                     esc_html__(
@@ -194,7 +194,7 @@ 
      */
     private function writeToErrorLog($message)
     {
-        if (! empty($this->_error_log_dir)) {
+        if ( ! empty($this->_error_log_dir)) {
             /** @noinspection ForgottenDebugOutputInspection */
             error_log($message, 3, $this->_error_log_dir);
         } else {

core/domain/entities/shortcodes/EspressoCancelled.php

Indentation +68 added lines, -68 removed lines

@@ -20,78 +20,78 @@
 {
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_CANCELLED';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_CANCELLED';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    public function processShortcode($attributes = array())
-    {
-        $transaction = EE_Registry::instance()->SSN->get_session_data('transaction');
-        if ($transaction instanceof EE_Transaction) {
-            do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction);
-            $registrations = $transaction->registrations();
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration);
-                }
-            }
-        }
-        do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session');
-        // remove all unwanted records from the db
-        if (EE_Registry::instance()->CART instanceof EE_Cart) {
-            EE_Registry::instance()->CART->delete_cart();
-        }
-        // phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        return sprintf(
-            esc_html__(
-                '%sAll unsaved registration information entered during this session has been deleted.%s',
-                'event_espresso'
-            ),
-            '<p class="ee-registrations-cancelled-pg ee-attention">',
-            '</p>'
-        );
-        // phpcs:enable
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function processShortcode($attributes = array())
+	{
+		$transaction = EE_Registry::instance()->SSN->get_session_data('transaction');
+		if ($transaction instanceof EE_Transaction) {
+			do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction);
+			$registrations = $transaction->registrations();
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration);
+				}
+			}
+		}
+		do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session');
+		// remove all unwanted records from the db
+		if (EE_Registry::instance()->CART instanceof EE_Cart) {
+			EE_Registry::instance()->CART->delete_cart();
+		}
+		// phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		return sprintf(
+			esc_html__(
+				'%sAll unsaved registration information entered during this session has been deleted.%s',
+				'event_espresso'
+			),
+			'<p class="ee-registrations-cancelled-pg ee-attention">',
+			'</p>'
+		);
+		// phpcs:enable
+	}
 }

core/domain/entities/custom_post_types/CustomTaxonomyDefinitions.php

Indentation +131 added lines, -131 removed lines

@@ -15,145 +15,145 @@
 class CustomTaxonomyDefinitions
 {
 
-    /**
-     * @var array $taxonomies
-     */
-    private $taxonomies;
+	/**
+	 * @var array $taxonomies
+	 */
+	private $taxonomies;
 
 
-    /**
-     * EspressoCustomPostTypeDefinitions constructor.
-     */
-    public function __construct()
-    {
-        $this->setTaxonomies();
-        add_filter('pre_term_description', array($this, 'filterCustomTermDescription'), 1, 2);
-    }
+	/**
+	 * EspressoCustomPostTypeDefinitions constructor.
+	 */
+	public function __construct()
+	{
+		$this->setTaxonomies();
+		add_filter('pre_term_description', array($this, 'filterCustomTermDescription'), 1, 2);
+	}
 
 
-    private function setTaxonomies()
-    {
-        $this->taxonomies = array(
-            'espresso_event_categories' => array(
-                'singular_name' => esc_html__('Event Category', 'event_espresso'),
-                'plural_name'   => esc_html__('Event Categories', 'event_espresso'),
-                'args'          => array(
-                    'public'            => true,
-                    'show_in_nav_menus' => true,
-                    'show_in_rest'      => true,
-                    'capabilities'      => array(
-                        'manage_terms' => 'ee_manage_event_categories',
-                        'edit_terms'   => 'ee_edit_event_category',
-                        'delete_terms' => 'ee_delete_event_category',
-                        'assign_terms' => 'ee_assign_event_category',
-                    ),
-                    'rewrite'           => array(
-                        'slug' => EEH_URL::slugify(
-                            esc_html__('event-category', 'event_espresso'),
-                            'event-category'
-                        )
-                    ),
-                ),
-            ),
-            'espresso_venue_categories' => array(
-                'singular_name' => esc_html__('Venue Category', 'event_espresso'),
-                'plural_name'   => esc_html__('Venue Categories', 'event_espresso'),
-                'args'          => array(
-                    'public'            => true,
-                    'show_in_nav_menus' => false, // by default this doesn't show for decaf
-                    'show_in_rest'      => true,
-                    'capabilities'      => array(
-                        'manage_terms' => 'ee_manage_venue_categories',
-                        'edit_terms'   => 'ee_edit_venue_category',
-                        'delete_terms' => 'ee_delete_venue_category',
-                        'assign_terms' => 'ee_assign_venue_category',
-                    ),
-                    'rewrite'           => array(
-                        'slug' => EEH_URL::slugify(
-                            esc_html__('venue-category', 'event_espresso'),
-                            'venue-category'
-                        )
-                    ),
-                ),
-            ),
-            'espresso_event_type'       => array(
-                'singular_name' => esc_html__('Event Type', 'event_espresso'),
-                'plural_name'   => esc_html__('Event Types', 'event_espresso'),
-                'args'          => array(
-                    'public'       => true,
-                    'show_ui'      => false,
-                    'show_in_rest' => true,
-                    'capabilities' => array(
-                        'manage_terms' => 'ee_read_event_type',
-                        'edit_terms'   => 'ee_edit_event_type',
-                        'delete_terms' => 'ee_delete_event_type',
-                        'assign_terms' => 'ee_assign_event_type',
-                    ),
-                    'rewrite'      => array(
-                        'slug' => EEH_URL::slugify(
-                            esc_html__('event-type', 'event_espresso'),
-                            'event-type'
-                        )
-                    ),
-                    'hierarchical' => true,
-                ),
-            ),
-        );
-    }
+	private function setTaxonomies()
+	{
+		$this->taxonomies = array(
+			'espresso_event_categories' => array(
+				'singular_name' => esc_html__('Event Category', 'event_espresso'),
+				'plural_name'   => esc_html__('Event Categories', 'event_espresso'),
+				'args'          => array(
+					'public'            => true,
+					'show_in_nav_menus' => true,
+					'show_in_rest'      => true,
+					'capabilities'      => array(
+						'manage_terms' => 'ee_manage_event_categories',
+						'edit_terms'   => 'ee_edit_event_category',
+						'delete_terms' => 'ee_delete_event_category',
+						'assign_terms' => 'ee_assign_event_category',
+					),
+					'rewrite'           => array(
+						'slug' => EEH_URL::slugify(
+							esc_html__('event-category', 'event_espresso'),
+							'event-category'
+						)
+					),
+				),
+			),
+			'espresso_venue_categories' => array(
+				'singular_name' => esc_html__('Venue Category', 'event_espresso'),
+				'plural_name'   => esc_html__('Venue Categories', 'event_espresso'),
+				'args'          => array(
+					'public'            => true,
+					'show_in_nav_menus' => false, // by default this doesn't show for decaf
+					'show_in_rest'      => true,
+					'capabilities'      => array(
+						'manage_terms' => 'ee_manage_venue_categories',
+						'edit_terms'   => 'ee_edit_venue_category',
+						'delete_terms' => 'ee_delete_venue_category',
+						'assign_terms' => 'ee_assign_venue_category',
+					),
+					'rewrite'           => array(
+						'slug' => EEH_URL::slugify(
+							esc_html__('venue-category', 'event_espresso'),
+							'venue-category'
+						)
+					),
+				),
+			),
+			'espresso_event_type'       => array(
+				'singular_name' => esc_html__('Event Type', 'event_espresso'),
+				'plural_name'   => esc_html__('Event Types', 'event_espresso'),
+				'args'          => array(
+					'public'       => true,
+					'show_ui'      => false,
+					'show_in_rest' => true,
+					'capabilities' => array(
+						'manage_terms' => 'ee_read_event_type',
+						'edit_terms'   => 'ee_edit_event_type',
+						'delete_terms' => 'ee_delete_event_type',
+						'assign_terms' => 'ee_assign_event_type',
+					),
+					'rewrite'      => array(
+						'slug' => EEH_URL::slugify(
+							esc_html__('event-type', 'event_espresso'),
+							'event-type'
+						)
+					),
+					'hierarchical' => true,
+				),
+			),
+		);
+	}
 
 
-    /**
-     * @return array
-     */
-    public function getCustomTaxonomyDefinitions()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
-            // legacy filter applied for now,
-            // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
-            apply_filters(
-                'FHEE__EE_Register_CPTs__get_taxonomies__taxonomies',
-                $this->taxonomies
-            )
-        );
-    }
+	/**
+	 * @return array
+	 */
+	public function getCustomTaxonomyDefinitions()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
+			// legacy filter applied for now,
+			// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
+			apply_filters(
+				'FHEE__EE_Register_CPTs__get_taxonomies__taxonomies',
+				$this->taxonomies
+			)
+		);
+	}
 
 
-    /**
-     * @return array
-     */
-    public function getCustomTaxonomySlugs()
-    {
-        return array_keys($this->getCustomTaxonomyDefinitions());
-    }
+	/**
+	 * @return array
+	 */
+	public function getCustomTaxonomySlugs()
+	{
+		return array_keys($this->getCustomTaxonomyDefinitions());
+	}
 
 
-    /**
-     * By default, WordPress strips all html from term taxonomy description content.
-     * The purpose of this method is to remove that restriction
-     * and ensure that we still run ee term taxonomy descriptions
-     * through some full html sanitization equivalent to the post content field.
-     * So first we remove default filter for term description
-     * but we have to do this earlier before wp sets their own filter
-     * because they just set a global filter on all term descriptions
-     * before the custom term description filter.
-     * Really sux.
-     *
-     * @param string $description The description content.
-     * @param string $taxonomy    The taxonomy name for the taxonomy being filtered.
-     * @return string
-     */
-    public function filterCustomTermDescription($description, $taxonomy)
-    {
-        // get a list of EE taxonomies
-        $custom_taxonomies = $this->getCustomTaxonomySlugs();
-        // only do our own thing if the taxonomy listed is an ee taxonomy.
-        if (in_array($taxonomy, $custom_taxonomies, true)) {
-            // remove default wp filter
-            remove_filter('pre_term_description', 'wp_filter_kses');
-            // sanitize THIS content.
-            $description = wp_kses($description, wp_kses_allowed_html('post'));
-        }
-        return $description;
-    }
+	/**
+	 * By default, WordPress strips all html from term taxonomy description content.
+	 * The purpose of this method is to remove that restriction
+	 * and ensure that we still run ee term taxonomy descriptions
+	 * through some full html sanitization equivalent to the post content field.
+	 * So first we remove default filter for term description
+	 * but we have to do this earlier before wp sets their own filter
+	 * because they just set a global filter on all term descriptions
+	 * before the custom term description filter.
+	 * Really sux.
+	 *
+	 * @param string $description The description content.
+	 * @param string $taxonomy    The taxonomy name for the taxonomy being filtered.
+	 * @return string
+	 */
+	public function filterCustomTermDescription($description, $taxonomy)
+	{
+		// get a list of EE taxonomies
+		$custom_taxonomies = $this->getCustomTaxonomySlugs();
+		// only do our own thing if the taxonomy listed is an ee taxonomy.
+		if (in_array($taxonomy, $custom_taxonomies, true)) {
+			// remove default wp filter
+			remove_filter('pre_term_description', 'wp_filter_kses');
+			// sanitize THIS content.
+			$description = wp_kses($description, wp_kses_allowed_html('post'));
+		}
+		return $description;
+	}
 }

core/domain/services/admin/registrations/list_table/page_header/TicketFilterHeader.php

Indentation +56 added lines, -56 removed lines

@@ -23,64 +23,64 @@
 class TicketFilterHeader extends AdminPageHeaderDecorator
 {
 
-    /**
-     * @var EEM_Ticket $ticket_model
-     */
-    private $ticket_model;
+	/**
+	 * @var EEM_Ticket $ticket_model
+	 */
+	private $ticket_model;
 
 
-    /**
-     * TicketFilterHeader constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Ticket       $ticket_model
-     */
-    public function __construct(RequestInterface $request, EEM_Ticket $ticket_model)
-    {
-        parent::__construct($request);
-        $this->ticket_model = $ticket_model;
-    }
+	/**
+	 * TicketFilterHeader constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Ticket       $ticket_model
+	 */
+	public function __construct(RequestInterface $request, EEM_Ticket $ticket_model)
+	{
+		parent::__construct($request);
+		$this->ticket_model = $ticket_model;
+	}
 
 
-    /**
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    public function getHeaderText($text = '')
-    {
-        $TKT_ID = $this->request->getRequestParam('TKT_ID');
-        $TKT_ID = $this->request->getRequestParam('ticket_id', $TKT_ID, 'int');
-        if ($TKT_ID) {
-            $ticket = $this->ticket_model->get_one_by_ID($TKT_ID);
-            if ($ticket instanceof EE_Ticket) {
-                $ticket_details = '<span class="ee-ticket-name">' . $ticket->name() . '</span> ';
-                $ticket_details .= ! $ticket->is_free()
-                    ? '<span class="ee-ticket-price">' . $ticket->pretty_price() . '</span>'
-                    : '<span class="reg-overview-free-event-spn">'
-                      . esc_html__('free', 'event_espresso')
-                      . '</span>';
-                // remove the closing h3 heading tag if it exists
-                $text = str_replace(
-                    '</h3>',
-                    '',
-                    $text
-                );
-                if (empty($text)) {
-                    $text = '<h3 style="line-height:1.5em;">';
-                    $text .= esc_html__('Viewing registrations for ticket:', 'event_espresso');
-                }
-                $text .= '&nbsp; &nbsp; ';
-                $text .= '<span class="drk-grey-text" style="font-size:.9em;">';
-                $text .= '<span class="dashicons dashicons-tickets-alt"></span>';
-                $text .= $ticket_details . '</span></h3>';
-            }
-        }
-        return $text;
-    }
+	/**
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	public function getHeaderText($text = '')
+	{
+		$TKT_ID = $this->request->getRequestParam('TKT_ID');
+		$TKT_ID = $this->request->getRequestParam('ticket_id', $TKT_ID, 'int');
+		if ($TKT_ID) {
+			$ticket = $this->ticket_model->get_one_by_ID($TKT_ID);
+			if ($ticket instanceof EE_Ticket) {
+				$ticket_details = '<span class="ee-ticket-name">' . $ticket->name() . '</span> ';
+				$ticket_details .= ! $ticket->is_free()
+					? '<span class="ee-ticket-price">' . $ticket->pretty_price() . '</span>'
+					: '<span class="reg-overview-free-event-spn">'
+					  . esc_html__('free', 'event_espresso')
+					  . '</span>';
+				// remove the closing h3 heading tag if it exists
+				$text = str_replace(
+					'</h3>',
+					'',
+					$text
+				);
+				if (empty($text)) {
+					$text = '<h3 style="line-height:1.5em;">';
+					$text .= esc_html__('Viewing registrations for ticket:', 'event_espresso');
+				}
+				$text .= '&nbsp; &nbsp; ';
+				$text .= '<span class="drk-grey-text" style="font-size:.9em;">';
+				$text .= '<span class="dashicons dashicons-tickets-alt"></span>';
+				$text .= $ticket_details . '</span></h3>';
+			}
+		}
+		return $text;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -59,9 +59,9 @@ 
         if ($TKT_ID) {
             $ticket = $this->ticket_model->get_one_by_ID($TKT_ID);
             if ($ticket instanceof EE_Ticket) {
-                $ticket_details = '<span class="ee-ticket-name">' . $ticket->name() . '</span> ';
+                $ticket_details = '<span class="ee-ticket-name">'.$ticket->name().'</span> ';
                 $ticket_details .= ! $ticket->is_free()
-                    ? '<span class="ee-ticket-price">' . $ticket->pretty_price() . '</span>'
+                    ? '<span class="ee-ticket-price">'.$ticket->pretty_price().'</span>'
                     : '<span class="reg-overview-free-event-spn">'
                       . esc_html__('free', 'event_espresso')
                       . '</span>';
@@ -78,7 +78,7 @@ 
                 $text .= '&nbsp; &nbsp; ';
                 $text .= '<span class="drk-grey-text" style="font-size:.9em;">';
                 $text .= '<span class="dashicons dashicons-tickets-alt"></span>';
-                $text .= $ticket_details . '</span></h3>';
+                $text .= $ticket_details.'</span></h3>';
             }
         }
         return $text;

core/domain/services/admin/ExitModal.php

Indentation +78 added lines, -78 removed lines

@@ -19,90 +19,90 @@
 class ExitModal
 {
 
-    /**
-     * @var Registry
-     */
-    private $assets_registry;
+	/**
+	 * @var Registry
+	 */
+	private $assets_registry;
 
-    /**
-     * ExitModal constructor.
-     *
-     * @param Registry $assets_registry
-     */
-    public function __construct(Registry $assets_registry)
-    {
-        $this->assets_registry = $assets_registry;
-        add_action('in_admin_footer', array($this, 'modalContainer'));
-        add_action('admin_enqueue_scripts', array($this, 'enqueues'));
-    }
+	/**
+	 * ExitModal constructor.
+	 *
+	 * @param Registry $assets_registry
+	 */
+	public function __construct(Registry $assets_registry)
+	{
+		$this->assets_registry = $assets_registry;
+		add_action('in_admin_footer', array($this, 'modalContainer'));
+		add_action('admin_enqueue_scripts', array($this, 'enqueues'));
+	}
 
 
-    /**
-     * Callback on in_admin_footer that is used to output the exit modal container.
-     */
-    public function modalContainer()
-    {
-        echo '<div id="ee-exit-survey-modal"></div>';
-    }
+	/**
+	 * Callback on in_admin_footer that is used to output the exit modal container.
+	 */
+	public function modalContainer()
+	{
+		echo '<div id="ee-exit-survey-modal"></div>';
+	}
 
 
-    /**
-     * Callback for `admin_enqueue_scripts` to take care of enqueueing scripts and styles specific to the modal.
-     *
-     * @throws InvalidArgumentException
-     */
-    public function enqueues()
-    {
-        $current_user = new WP_User(get_current_user_id());
-        $this->assets_registry->addData(
-            'exitModali18n',
-            array(
-                'introText' => htmlspecialchars(
-                    wp_strip_all_tags(
-                        __(
-                            'Do you have a moment to share why you are deactivating Event Espresso?',
-                            'event_espresso'
-                        )
-                    ),
-                    ENT_NOQUOTES
-                ),
-                'doSurveyButtonText' => htmlspecialchars(
-                    wp_strip_all_tags(__('Sure I\'ll help', 'event_espresso')),
-                    ENT_NOQUOTES
-                ),
-                'skipButtonText' => htmlspecialchars(
-                    wp_strip_all_tags(__('Skip', 'event_espresso')),
-                    ENT_NOQUOTES
-                )
-            )
-        );
-        $this->assets_registry->addData(
-            'exitModalInfo',
-            array(
-                'firstname' => htmlspecialchars($current_user->user_firstname),
-                'emailaddress' => htmlspecialchars($current_user->user_email),
-                'website' => htmlspecialchars(site_url()),
-                'isModalActive' => $this->isModalActive()
-            )
-        );
+	/**
+	 * Callback for `admin_enqueue_scripts` to take care of enqueueing scripts and styles specific to the modal.
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	public function enqueues()
+	{
+		$current_user = new WP_User(get_current_user_id());
+		$this->assets_registry->addData(
+			'exitModali18n',
+			array(
+				'introText' => htmlspecialchars(
+					wp_strip_all_tags(
+						__(
+							'Do you have a moment to share why you are deactivating Event Espresso?',
+							'event_espresso'
+						)
+					),
+					ENT_NOQUOTES
+				),
+				'doSurveyButtonText' => htmlspecialchars(
+					wp_strip_all_tags(__('Sure I\'ll help', 'event_espresso')),
+					ENT_NOQUOTES
+				),
+				'skipButtonText' => htmlspecialchars(
+					wp_strip_all_tags(__('Skip', 'event_espresso')),
+					ENT_NOQUOTES
+				)
+			)
+		);
+		$this->assets_registry->addData(
+			'exitModalInfo',
+			array(
+				'firstname' => htmlspecialchars($current_user->user_firstname),
+				'emailaddress' => htmlspecialchars($current_user->user_email),
+				'website' => htmlspecialchars(site_url()),
+				'isModalActive' => $this->isModalActive()
+			)
+		);
 
-        wp_enqueue_script('ee-wp-plugins-page');
-        wp_enqueue_style('ee-wp-plugins-page');
-    }
+		wp_enqueue_script('ee-wp-plugins-page');
+		wp_enqueue_style('ee-wp-plugins-page');
+	}
 
 
-    /**
-     * Exposes a filter switch for turning off the enqueueing of the modal script.
-     * @return bool
-     */
-    private function isModalActive()
-    {
-        return filter_var(
-            apply_filters(
-                'FHEE__EventEspresso_core_domain_services_admin_ExitModal__isModalActive',
-                true
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
+	/**
+	 * Exposes a filter switch for turning off the enqueueing of the modal script.
+	 * @return bool
+	 */
+	private function isModalActive()
+	{
+		return filter_var(
+			apply_filters(
+				'FHEE__EventEspresso_core_domain_services_admin_ExitModal__isModalActive',
+				true
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
 }

core/domain/services/admin/ajax/ThankYouPageIpnMonitor.php

Indentation +219 added lines, -219 removed lines

@@ -22,239 +22,239 @@
 class ThankYouPageIpnMonitor
 {
 
-    /**
-     * @var string $heartbeat
-     */
-    private $heartbeat;
+	/**
+	 * @var string $heartbeat
+	 */
+	private $heartbeat;
 
-    /**
-     * @var EED_Thank_You_Page $thank_you_page
-     */
-    private $thank_you_page;
+	/**
+	 * @var EED_Thank_You_Page $thank_you_page
+	 */
+	private $thank_you_page;
 
-    /**
-     * @var EE_Transaction $transaction
-     */
-    private $transaction;
+	/**
+	 * @var EE_Transaction $transaction
+	 */
+	private $transaction;
 
 
-    /**
-     * EventEditorHeartbeat constructor.
-     */
-    public function __construct()
-    {
-        $this->heartbeat = WordpressHeartbeat::RESPONSE_KEY_THANK_YOU_PAGE;
-        add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 3);
-        add_filter('heartbeat_nopriv_received', array($this, 'heartbeatResponse'), 10, 3);
-    }
+	/**
+	 * EventEditorHeartbeat constructor.
+	 */
+	public function __construct()
+	{
+		$this->heartbeat = WordpressHeartbeat::RESPONSE_KEY_THANK_YOU_PAGE;
+		add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 3);
+		add_filter('heartbeat_nopriv_received', array($this, 'heartbeatResponse'), 10, 3);
+	}
 
 
-    /**
-     * thank_you_page_IPN_monitor
-     * this basically just pulls the TXN based on the reg_url_link sent from the server,
-     * then checks that the TXN status is not failed, and that no other errors have been generated.
-     * it also calculates the IPN wait time since the Thank You page was first loaded
-     *
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function heartbeatResponse($response = array(), $data = array())
-    {
-        // does this heartbeat contain our data ?
-        if (! isset($data[ $this->heartbeat ])) {
-            return $response;
-        }
-        // check for reg_url_link in the incoming heartbeat data
-        if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
-            $response[ $this->heartbeat ] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : esc_html__(
-                        'No transaction information could be retrieved because the registration URL link is missing or invalid.',
-                        'event_espresso'
-                    ),
-            );
-            return $response;
-        }
-        // kk heartbeat has our data
-        $response = $this->initializeThankYouPageAndTransaction($response, $data);
-        // if something went wrong...
-        if (isset($response[ $this->heartbeat ]['errors'])) {
-            return $response;
-        }
-        // grab transient of Transaction's status
-        $txn_status = isset($data[ $this->heartbeat ]['txn_status'])
-            ? $data[ $this->heartbeat ]['txn_status']
-            : null;
-        $response = $this->getTransactionDetails($txn_status, $response, $data);
-        // no payment data yet?
-        if (isset($response[ $this->heartbeat ]['still_waiting'])) {
-            return $response;
-        }
-        // TXN is happening so let's get the payments now
-        // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data[ $this->heartbeat ]['get_payments_since'])
-            ? $data[ $this->heartbeat ]['get_payments_since']
-            : 0;
-        return $this->paymentDetails($response, $since);
-    }
+	/**
+	 * thank_you_page_IPN_monitor
+	 * this basically just pulls the TXN based on the reg_url_link sent from the server,
+	 * then checks that the TXN status is not failed, and that no other errors have been generated.
+	 * it also calculates the IPN wait time since the Thank You page was first loaded
+	 *
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function heartbeatResponse($response = array(), $data = array())
+	{
+		// does this heartbeat contain our data ?
+		if (! isset($data[ $this->heartbeat ])) {
+			return $response;
+		}
+		// check for reg_url_link in the incoming heartbeat data
+		if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
+			$response[ $this->heartbeat ] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: esc_html__(
+						'No transaction information could be retrieved because the registration URL link is missing or invalid.',
+						'event_espresso'
+					),
+			);
+			return $response;
+		}
+		// kk heartbeat has our data
+		$response = $this->initializeThankYouPageAndTransaction($response, $data);
+		// if something went wrong...
+		if (isset($response[ $this->heartbeat ]['errors'])) {
+			return $response;
+		}
+		// grab transient of Transaction's status
+		$txn_status = isset($data[ $this->heartbeat ]['txn_status'])
+			? $data[ $this->heartbeat ]['txn_status']
+			: null;
+		$response = $this->getTransactionDetails($txn_status, $response, $data);
+		// no payment data yet?
+		if (isset($response[ $this->heartbeat ]['still_waiting'])) {
+			return $response;
+		}
+		// TXN is happening so let's get the payments now
+		// if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
+		$since = isset($data[ $this->heartbeat ]['get_payments_since'])
+			? $data[ $this->heartbeat ]['get_payments_since']
+			: 0;
+		return $this->paymentDetails($response, $since);
+	}
 
 
-    /**
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function initializeThankYouPageAndTransaction($response, $data)
-    {
-        require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
-        // set_definitions, instantiate the thank you page class, and get the ball rolling
-        EED_Thank_You_Page::set_definitions();
-        $this->thank_you_page = EED_Thank_You_Page::instance();
-        $this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
-        $this->thank_you_page->init();
-        // get TXN
-        $transaction = $this->thank_you_page->get_txn();
-        // no TXN? then get out
-        if (! $transaction instanceof EE_Transaction) {
-            $notices = EE_Error::get_notices();
-            $response[ $this->heartbeat ] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : sprintf(
-                        esc_html__(
-                            'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
-                            'event_espresso'
-                        ),
-                        __LINE__
-                    ),
-            );
-            return $response;
-        }
-        $this->transaction = $transaction;
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function initializeThankYouPageAndTransaction($response, $data)
+	{
+		require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
+		// set_definitions, instantiate the thank you page class, and get the ball rolling
+		EED_Thank_You_Page::set_definitions();
+		$this->thank_you_page = EED_Thank_You_Page::instance();
+		$this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
+		$this->thank_you_page->init();
+		// get TXN
+		$transaction = $this->thank_you_page->get_txn();
+		// no TXN? then get out
+		if (! $transaction instanceof EE_Transaction) {
+			$notices = EE_Error::get_notices();
+			$response[ $this->heartbeat ] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: sprintf(
+						esc_html__(
+							'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
+							'event_espresso'
+						),
+						__LINE__
+					),
+			);
+			return $response;
+		}
+		$this->transaction = $transaction;
+		return $response;
+	}
 
 
-    /**
-     * @param string $txn_status
-     * @param array  $response
-     * @param array  $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function getTransactionDetails($txn_status, $response, $data)
-    {
-        // has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
-        if ($txn_status !== $this->transaction->status_ID()) {
-            // switch between two possible basic outcomes
-            switch ($this->transaction->status_ID()) {
-                // TXN has been updated in some way
-                case EEM_Transaction::overpaid_status_code:
-                case EEM_Transaction::complete_status_code:
-                case EEM_Transaction::incomplete_status_code:
-                    // send updated TXN results back to client,
-                    return $this->setTransactionDetails($response);
-                // or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
-                case EEM_Transaction::failed_status_code:
-                default:
-                    // keep on waiting...
-                    return $this->updateServerWaitTime($data[ $this->heartbeat ]);
-            }
-            // or is the TXN still failed (never been updated) ???
-        } elseif ($this->transaction->failed()) {
-            // keep on waiting...
-            return $this->updateServerWaitTime($data[ $this->heartbeat ]);
-        }
-        return $response;
-    }
+	/**
+	 * @param string $txn_status
+	 * @param array  $response
+	 * @param array  $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function getTransactionDetails($txn_status, $response, $data)
+	{
+		// has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
+		if ($txn_status !== $this->transaction->status_ID()) {
+			// switch between two possible basic outcomes
+			switch ($this->transaction->status_ID()) {
+				// TXN has been updated in some way
+				case EEM_Transaction::overpaid_status_code:
+				case EEM_Transaction::complete_status_code:
+				case EEM_Transaction::incomplete_status_code:
+					// send updated TXN results back to client,
+					return $this->setTransactionDetails($response);
+				// or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
+				case EEM_Transaction::failed_status_code:
+				default:
+					// keep on waiting...
+					return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+			}
+			// or is the TXN still failed (never been updated) ???
+		} elseif ($this->transaction->failed()) {
+			// keep on waiting...
+			return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $response
-     * @param boolean $status_only
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function setTransactionDetails($response, $status_only = false)
-    {
-        if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
-            $response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
-        }
-        if (! isset($response[ $this->heartbeat ]['txn_status'])) {
-            $response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
-        }
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param boolean $status_only
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function setTransactionDetails($response, $status_only = false)
+	{
+		if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
+			$response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
+		}
+		if (! isset($response[ $this->heartbeat ]['txn_status'])) {
+			$response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $response
-     * @param int $since
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function paymentDetails($response, $since)
-    {
-        // then check for payments
-        $payments = $this->thank_you_page->get_txn_payments($since);
-        // has a payment been processed ?
-        if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
-            if ($since) {
-                $response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
-                $response = $this->setTransactionDetails($response);
-            } else {
-                $response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
-                    $payments
-                );
-            }
-            // reset time to check for payments
-            $response[ $this->heartbeat ]['get_payments_since'] = time();
-        } else {
-            $response[ $this->heartbeat ]['get_payments_since'] = $since;
-        }
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param int $since
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function paymentDetails($response, $since)
+	{
+		// then check for payments
+		$payments = $this->thank_you_page->get_txn_payments($since);
+		// has a payment been processed ?
+		if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
+			if ($since) {
+				$response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
+				$response = $this->setTransactionDetails($response);
+			} else {
+				$response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
+					$payments
+				);
+			}
+			// reset time to check for payments
+			$response[ $this->heartbeat ]['get_payments_since'] = time();
+		} else {
+			$response[ $this->heartbeat ]['get_payments_since'] = $since;
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $thank_you_page_data    thank you page portion of the incoming JSON array
-     *                                      from the WP heartbeat data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateServerWaitTime($thank_you_page_data)
-    {
-        $response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
-            ? time() - $thank_you_page_data['initial_access']
-            : 0;
-        $response = $this->setTransactionDetails($response, true);
-        return $response;
-    }
+	/**
+	 * @param array $thank_you_page_data    thank you page portion of the incoming JSON array
+	 *                                      from the WP heartbeat data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateServerWaitTime($thank_you_page_data)
+	{
+		$response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
+			? time() - $thank_you_page_data['initial_access']
+			: 0;
+		$response = $this->setTransactionDetails($response, true);
+		return $response;
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -67,12 +67,12 @@ 
     public function heartbeatResponse($response = array(), $data = array())
     {
         // does this heartbeat contain our data ?
-        if (! isset($data[ $this->heartbeat ])) {
+        if ( ! isset($data[$this->heartbeat])) {
             return $response;
         }
         // check for reg_url_link in the incoming heartbeat data
-        if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
-            $response[ $this->heartbeat ] = array(
+        if ( ! isset($data[$this->heartbeat]['e_reg_url_link'])) {
+            $response[$this->heartbeat] = array(
                 'errors' => ! empty($notices['errors'])
                     ? $notices['errors']
                     : esc_html__(
@@ -85,22 +85,22 @@ 
         // kk heartbeat has our data
         $response = $this->initializeThankYouPageAndTransaction($response, $data);
         // if something went wrong...
-        if (isset($response[ $this->heartbeat ]['errors'])) {
+        if (isset($response[$this->heartbeat]['errors'])) {
             return $response;
         }
         // grab transient of Transaction's status
-        $txn_status = isset($data[ $this->heartbeat ]['txn_status'])
-            ? $data[ $this->heartbeat ]['txn_status']
+        $txn_status = isset($data[$this->heartbeat]['txn_status'])
+            ? $data[$this->heartbeat]['txn_status']
             : null;
         $response = $this->getTransactionDetails($txn_status, $response, $data);
         // no payment data yet?
-        if (isset($response[ $this->heartbeat ]['still_waiting'])) {
+        if (isset($response[$this->heartbeat]['still_waiting'])) {
             return $response;
         }
         // TXN is happening so let's get the payments now
         // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data[ $this->heartbeat ]['get_payments_since'])
-            ? $data[ $this->heartbeat ]['get_payments_since']
+        $since = isset($data[$this->heartbeat]['get_payments_since'])
+            ? $data[$this->heartbeat]['get_payments_since']
             : 0;
         return $this->paymentDetails($response, $since);
     }
@@ -117,18 +117,18 @@ 
      */
     private function initializeThankYouPageAndTransaction($response, $data)
     {
-        require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
+        require_once EE_MODULES.'thank_you_page/EED_Thank_You_Page.module.php';
         // set_definitions, instantiate the thank you page class, and get the ball rolling
         EED_Thank_You_Page::set_definitions();
         $this->thank_you_page = EED_Thank_You_Page::instance();
-        $this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
+        $this->thank_you_page->set_reg_url_link($data[$this->heartbeat]['e_reg_url_link']);
         $this->thank_you_page->init();
         // get TXN
         $transaction = $this->thank_you_page->get_txn();
         // no TXN? then get out
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             $notices = EE_Error::get_notices();
-            $response[ $this->heartbeat ] = array(
+            $response[$this->heartbeat] = array(
                 'errors' => ! empty($notices['errors'])
                     ? $notices['errors']
                     : sprintf(
@@ -173,12 +173,12 @@ 
                 case EEM_Transaction::failed_status_code:
                 default:
                     // keep on waiting...
-                    return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+                    return $this->updateServerWaitTime($data[$this->heartbeat]);
             }
             // or is the TXN still failed (never been updated) ???
         } elseif ($this->transaction->failed()) {
             // keep on waiting...
-            return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+            return $this->updateServerWaitTime($data[$this->heartbeat]);
         }
         return $response;
     }
@@ -196,11 +196,11 @@ 
      */
     private function setTransactionDetails($response, $status_only = false)
     {
-        if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
-            $response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
+        if ( ! $status_only && ! isset($response[$this->heartbeat]['transaction_details'])) {
+            $response[$this->heartbeat]['transaction_details'] = $this->thank_you_page->get_transaction_details();
         }
-        if (! isset($response[ $this->heartbeat ]['txn_status'])) {
-            $response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
+        if ( ! isset($response[$this->heartbeat]['txn_status'])) {
+            $response[$this->heartbeat]['txn_status'] = $this->transaction->status_ID();
         }
         return $response;
     }
@@ -221,19 +221,19 @@ 
         // then check for payments
         $payments = $this->thank_you_page->get_txn_payments($since);
         // has a payment been processed ?
-        if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
+        if ( ! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
             if ($since) {
-                $response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
+                $response[$this->heartbeat]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
                 $response = $this->setTransactionDetails($response);
             } else {
-                $response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
+                $response[$this->heartbeat]['payment_details'] = $this->thank_you_page->get_payment_details(
                     $payments
                 );
             }
             // reset time to check for payments
-            $response[ $this->heartbeat ]['get_payments_since'] = time();
+            $response[$this->heartbeat]['get_payments_since'] = time();
         } else {
-            $response[ $this->heartbeat ]['get_payments_since'] = $since;
+            $response[$this->heartbeat]['get_payments_since'] = $since;
         }
         return $response;
     }
@@ -251,7 +251,7 @@ 
      */
     private function updateServerWaitTime($thank_you_page_data)
     {
-        $response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
+        $response[$this->heartbeat]['still_waiting'] = isset($thank_you_page_data['initial_access'])
             ? time() - $thank_you_page_data['initial_access']
             : 0;
         $response = $this->setTransactionDetails($response, true);