eventespresso / event-espresso-core

core/libraries/form_sections/inputs/EE_Select_Ajax_Model_Rest_Input.input.php

Spacing +7 added lines, -7 removed lines

@@ -74,7 +74,7 @@ 
         );
         // make sure limit and caps are always set
         $query_params = array_merge(
-            array( 'limit' => 10, 'caps' => EEM_Base::caps_read_admin ),
+            array('limit' => 10, 'caps' => EEM_Base::caps_read_admin),
             $query_params
         );
         $this->_value_field_name = EEH_Array::is_set(
@@ -155,12 +155,12 @@ 
         $values_for_options = (array) $value;
         $value_field = $this->_get_model()->field_settings_for($this->_value_field_name);
         $display_field = $this->_get_model()->field_settings_for($this->_display_field_name);
-        $this->_extra_select_columns[] = $value_field->get_qualified_column() . ' AS ' . $this->_value_field_name;
-        $this->_extra_select_columns[] = $display_field->get_qualified_column() . ' AS ' . $this->_display_field_name;
+        $this->_extra_select_columns[] = $value_field->get_qualified_column().' AS '.$this->_value_field_name;
+        $this->_extra_select_columns[] = $display_field->get_qualified_column().' AS '.$this->_display_field_name;
         $display_values = $this->_get_model()->get_all_wpdb_results(
             array(
                 array(
-                    $this->_value_field_name => array( 'IN', $values_for_options )
+                    $this->_value_field_name => array('IN', $values_for_options)
                 )
             ),
             ARRAY_A,
@@ -170,9 +170,9 @@ 
         if (is_array($select_options)) {
             foreach ($display_values as $db_rows) {
                 $db_rows = (array) $db_rows;
-                $select_options[ $db_rows[ $this->_value_field_name ] ] = apply_filters(
+                $select_options[$db_rows[$this->_value_field_name]] = apply_filters(
                     'FHEE__EE_Select_Ajax_Model_Rest_Input___set_raw_value__select_option_value',
-                    $db_rows[ $this->_display_field_name ],
+                    $db_rows[$this->_display_field_name],
                     $db_rows
                 );
             }
@@ -188,7 +188,7 @@ 
      */
     protected function _get_model()
     {
-        if (! EE_Registry::instance()->is_model_name($this->_model_name)) {
+        if ( ! EE_Registry::instance()->is_model_name($this->_model_name)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(

Indentation +176 added lines, -176 removed lines

@@ -16,189 +16,189 @@
  */
 class EE_Select_Ajax_Model_Rest_Input extends EE_Form_Input_With_Options_Base
 {
-    /**
-     * @var string $_model_name
-     */
-    protected $_model_name;
+	/**
+	 * @var string $_model_name
+	 */
+	protected $_model_name;
 
-    /**
-     * @var string $_display_field_name
-     */
-    protected $_display_field_name;
+	/**
+	 * @var string $_display_field_name
+	 */
+	protected $_display_field_name;
 
-    /**
-     * @var string $_value_field_name
-     */
-    protected $_value_field_name;
+	/**
+	 * @var string $_value_field_name
+	 */
+	protected $_value_field_name;
 
-    /**
-     * @var array $_extra_select_columns
-     */
-    protected $_extra_select_columns = array();
+	/**
+	 * @var array $_extra_select_columns
+	 */
+	protected $_extra_select_columns = array();
 
 
-    /**
-     * @param array $input_settings     {
-     * @type string $model_name         the name of model to be used for searching, both via the REST API and server-side model queries
-     * @type array  $query_params       default query parameters which will apply to both REST API queries and server-side queries. This should be
-     *                                  in the exact format that will be used for server-side model usage (eg use index 0 for where conditions, not
-     *                                  the string "where")
-     * @type string $value_field_name   the name of the model field on this model to
-     *                                  be used for the HTML select's option's values
-     * @type string $display_field_name the name of the model field on this model
-     *                                  to be used for the HTML select's option's display text
-     * @type array  $select2_args       arguments to be passed directly into the select2's JS constructor
-     *                                  }
-     *                                  And the arguments accepted by EE_Form_Input_With_Options_Base
-     * }
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($input_settings = array())
-    {
-        // needed input settings:
-        // select2_args
-        $this->_model_name = EEH_Array::is_set(
-            $input_settings,
-            'model_name',
-            null
-        );
-        $model = $this->_get_model();
-        $query_params = EEH_Array::is_set(
-            $input_settings,
-            'query_params',
-            array()
-        );
-        // make sure limit and caps are always set
-        $query_params = array_merge(
-            array( 'limit' => 10, 'caps' => EEM_Base::caps_read_admin ),
-            $query_params
-        );
-        $this->_value_field_name = EEH_Array::is_set(
-            $input_settings,
-            'value_field_name',
-            $model->primary_key_name()
-        );
-        $this->_display_field_name = EEH_Array::is_set(
-            $input_settings,
-            'display_field_name',
-            $model->get_a_field_of_type('EE_Text_Field_Base')->get_name()
-        );
-        $this->_extra_select_columns = EEH_Array::is_set(
-            $input_settings,
-            'extra_select_columns',
-            array()
-        );
-        $this->_add_validation_strategy(
-            new EE_Model_Matching_Query_Validation_Strategy(
-                '',
-                $this->_model_name,
-                $query_params,
-                $this->_value_field_name
-            )
-        );
-        // get resource endpoint
-        $rest_controller = LoaderFactory::getLoader()->getNew(
-            'EventEspresso\core\libraries\rest_api\controllers\model\Read'
-        );
-        $rest_controller->setRequestedVersion(EED_Core_Rest_Api::latest_rest_api_version());
-        $default_select2_args = array(
-            'ajax' => array(
-                'url' => $rest_controller->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($this->_model_name)
-                ),
-                'dataType' => 'json',
-                'delay' => '250',
-                'data_interface' => 'EE_Select2_REST_API_Interface',
-                'data_interface_args' => array(
-                    'default_query_params' => (object) ModelDataTranslator::prepareQueryParamsForRestApi(
-                        $query_params,
-                        $model
-                    ),
-                    'display_field' => $this->_display_field_name,
-                    'value_field' => $this->_value_field_name,
-                    'nonce' => wp_create_nonce('wp_rest'),
-                    'locale' => str_replace('_', '-', strtolower(get_locale()))
-                ),
-            ),
-            'cache' => true,
-            'width' => 'resolve'
-        );
-        $select2_args = array_replace_recursive(
-            $default_select2_args,
-            (array) EEH_Array::is_set($input_settings, 'select2_args', array())
-        );
-        $this->set_display_strategy(new EE_Select2_Display_Strategy($select2_args));
-        parent::__construct(array(), $input_settings);
-    }
+	/**
+	 * @param array $input_settings     {
+	 * @type string $model_name         the name of model to be used for searching, both via the REST API and server-side model queries
+	 * @type array  $query_params       default query parameters which will apply to both REST API queries and server-side queries. This should be
+	 *                                  in the exact format that will be used for server-side model usage (eg use index 0 for where conditions, not
+	 *                                  the string "where")
+	 * @type string $value_field_name   the name of the model field on this model to
+	 *                                  be used for the HTML select's option's values
+	 * @type string $display_field_name the name of the model field on this model
+	 *                                  to be used for the HTML select's option's display text
+	 * @type array  $select2_args       arguments to be passed directly into the select2's JS constructor
+	 *                                  }
+	 *                                  And the arguments accepted by EE_Form_Input_With_Options_Base
+	 * }
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($input_settings = array())
+	{
+		// needed input settings:
+		// select2_args
+		$this->_model_name = EEH_Array::is_set(
+			$input_settings,
+			'model_name',
+			null
+		);
+		$model = $this->_get_model();
+		$query_params = EEH_Array::is_set(
+			$input_settings,
+			'query_params',
+			array()
+		);
+		// make sure limit and caps are always set
+		$query_params = array_merge(
+			array( 'limit' => 10, 'caps' => EEM_Base::caps_read_admin ),
+			$query_params
+		);
+		$this->_value_field_name = EEH_Array::is_set(
+			$input_settings,
+			'value_field_name',
+			$model->primary_key_name()
+		);
+		$this->_display_field_name = EEH_Array::is_set(
+			$input_settings,
+			'display_field_name',
+			$model->get_a_field_of_type('EE_Text_Field_Base')->get_name()
+		);
+		$this->_extra_select_columns = EEH_Array::is_set(
+			$input_settings,
+			'extra_select_columns',
+			array()
+		);
+		$this->_add_validation_strategy(
+			new EE_Model_Matching_Query_Validation_Strategy(
+				'',
+				$this->_model_name,
+				$query_params,
+				$this->_value_field_name
+			)
+		);
+		// get resource endpoint
+		$rest_controller = LoaderFactory::getLoader()->getNew(
+			'EventEspresso\core\libraries\rest_api\controllers\model\Read'
+		);
+		$rest_controller->setRequestedVersion(EED_Core_Rest_Api::latest_rest_api_version());
+		$default_select2_args = array(
+			'ajax' => array(
+				'url' => $rest_controller->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($this->_model_name)
+				),
+				'dataType' => 'json',
+				'delay' => '250',
+				'data_interface' => 'EE_Select2_REST_API_Interface',
+				'data_interface_args' => array(
+					'default_query_params' => (object) ModelDataTranslator::prepareQueryParamsForRestApi(
+						$query_params,
+						$model
+					),
+					'display_field' => $this->_display_field_name,
+					'value_field' => $this->_value_field_name,
+					'nonce' => wp_create_nonce('wp_rest'),
+					'locale' => str_replace('_', '-', strtolower(get_locale()))
+				),
+			),
+			'cache' => true,
+			'width' => 'resolve'
+		);
+		$select2_args = array_replace_recursive(
+			$default_select2_args,
+			(array) EEH_Array::is_set($input_settings, 'select2_args', array())
+		);
+		$this->set_display_strategy(new EE_Select2_Display_Strategy($select2_args));
+		parent::__construct(array(), $input_settings);
+	}
 
 
 
-    /**
-     * Before setting the raw value (usually because we're setting the default,
-     * or we've received a form submission and this might be re-displayed to the user),
-     * sets the options so that the current selections appear on initial display.
-     *
-     * Note: because this input uses EE_Model_Matching_Query_Validation_Strategy
-     * for validation, this input's options only affect DISPLAY and NOT validation,
-     * which is why its ok to just assume the provided $value to be in the list of acceptable values
-     *
-     * @param mixed $value
-     * @return void
-     * @throws \EE_Error
-     */
-    public function _set_raw_value($value)
-    {
-        $values_for_options = (array) $value;
-        $value_field = $this->_get_model()->field_settings_for($this->_value_field_name);
-        $display_field = $this->_get_model()->field_settings_for($this->_display_field_name);
-        $this->_extra_select_columns[] = $value_field->get_qualified_column() . ' AS ' . $this->_value_field_name;
-        $this->_extra_select_columns[] = $display_field->get_qualified_column() . ' AS ' . $this->_display_field_name;
-        $display_values = $this->_get_model()->get_all_wpdb_results(
-            array(
-                array(
-                    $this->_value_field_name => array( 'IN', $values_for_options )
-                )
-            ),
-            ARRAY_A,
-            implode(',', $this->_extra_select_columns)
-        );
-        $select_options = array();
-        if (is_array($select_options)) {
-            foreach ($display_values as $db_rows) {
-                $db_rows = (array) $db_rows;
-                $select_options[ $db_rows[ $this->_value_field_name ] ] = apply_filters(
-                    'FHEE__EE_Select_Ajax_Model_Rest_Input___set_raw_value__select_option_value',
-                    $db_rows[ $this->_display_field_name ],
-                    $db_rows
-                );
-            }
-        }
-        $this->set_select_options($select_options);
-        parent::_set_raw_value($value);
-    }
+	/**
+	 * Before setting the raw value (usually because we're setting the default,
+	 * or we've received a form submission and this might be re-displayed to the user),
+	 * sets the options so that the current selections appear on initial display.
+	 *
+	 * Note: because this input uses EE_Model_Matching_Query_Validation_Strategy
+	 * for validation, this input's options only affect DISPLAY and NOT validation,
+	 * which is why its ok to just assume the provided $value to be in the list of acceptable values
+	 *
+	 * @param mixed $value
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function _set_raw_value($value)
+	{
+		$values_for_options = (array) $value;
+		$value_field = $this->_get_model()->field_settings_for($this->_value_field_name);
+		$display_field = $this->_get_model()->field_settings_for($this->_display_field_name);
+		$this->_extra_select_columns[] = $value_field->get_qualified_column() . ' AS ' . $this->_value_field_name;
+		$this->_extra_select_columns[] = $display_field->get_qualified_column() . ' AS ' . $this->_display_field_name;
+		$display_values = $this->_get_model()->get_all_wpdb_results(
+			array(
+				array(
+					$this->_value_field_name => array( 'IN', $values_for_options )
+				)
+			),
+			ARRAY_A,
+			implode(',', $this->_extra_select_columns)
+		);
+		$select_options = array();
+		if (is_array($select_options)) {
+			foreach ($display_values as $db_rows) {
+				$db_rows = (array) $db_rows;
+				$select_options[ $db_rows[ $this->_value_field_name ] ] = apply_filters(
+					'FHEE__EE_Select_Ajax_Model_Rest_Input___set_raw_value__select_option_value',
+					$db_rows[ $this->_display_field_name ],
+					$db_rows
+				);
+			}
+		}
+		$this->set_select_options($select_options);
+		parent::_set_raw_value($value);
+	}
 
-    /**
-     * Returns the model, or throws an exception if the model name provided in constructor doesn't exist
-     * @return EEM_Base
-     * @throws EE_Error
-     */
-    protected function _get_model()
-    {
-        if (! EE_Registry::instance()->is_model_name($this->_model_name)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        '%1$s is not a proper model name. Please provide a model name in the "model_name" form input argument',
-                        'event_espresso'
-                    ),
-                    $this->_model_name
-                )
-            );
-        } else {
-            return EE_Registry::instance()->load_model($this->_model_name);
-        }
-    }
+	/**
+	 * Returns the model, or throws an exception if the model name provided in constructor doesn't exist
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 */
+	protected function _get_model()
+	{
+		if (! EE_Registry::instance()->is_model_name($this->_model_name)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'%1$s is not a proper model name. Please provide a model name in the "model_name" form input argument',
+						'event_espresso'
+					),
+					$this->_model_name
+				)
+			);
+		} else {
+			return EE_Registry::instance()->load_model($this->_model_name);
+		}
+	}
 }

core/EE_Configurable.core.php

Spacing +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
     public function _update_config(EE_Config_Base $config_obj = null)
     {
         $config_class = $this->config_class();
-        if (! $config_obj instanceof $config_class) {
+        if ( ! $config_obj instanceof $config_class) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The "%1$s" class is not an instance of %2$s.', 'event_espresso'),

Indentation +139 added lines, -139 removed lines

@@ -9,143 +9,143 @@
  */
 abstract class EE_Configurable extends EE_Base
 {
-    /**
-     * @var $_config
-     * @type EE_Config_Base
-     */
-    protected $_config;
-
-    /**
-     * @var $_config_section
-     * @type string
-     */
-    protected $_config_section = '';
-
-    /**
-     * @var $_config_class
-     * @type string
-     */
-    protected $_config_class = '';
-
-    /**
-     * @var $_config_name
-     * @type string
-     */
-    protected $_config_name = '';
-
-
-    /**
-     * @param string $config_section
-     */
-    public function set_config_section($config_section = '')
-    {
-        $this->_config_section = ! empty($config_section) ? $config_section : 'modules';
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function config_section()
-    {
-        return $this->_config_section;
-    }
-
-
-    /**
-     * @param string $config_class
-     */
-    public function set_config_class($config_class = '')
-    {
-        $this->_config_class = $config_class;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function config_class()
-    {
-        return $this->_config_class;
-    }
-
-
-    /**
-     * @param mixed $config_name
-     */
-    public function set_config_name($config_name)
-    {
-        $this->_config_name = ! empty($config_name) ? $config_name : get_called_class();
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function config_name()
-    {
-        return $this->_config_name;
-    }
-
-
-    /**
-     *    set_config
-     *    this method integrates directly with EE_Config to set up the config object for this class
-     *
-     * @access    protected
-     * @param    EE_Config_Base $config_obj
-     * @return    mixed    EE_Config_Base | NULL
-     */
-    protected function _set_config(EE_Config_Base $config_obj = null)
-    {
-        return EE_Config::instance()->set_config(
-            $this->config_section(),
-            $this->config_name(),
-            $this->config_class(),
-            $config_obj
-        );
-    }
-
-
-    /**
-     *    _update_config
-     *    this method integrates directly with EE_Config to update an existing config object for this class
-     *
-     * @access    protected
-     * @param    EE_Config_Base $config_obj
-     * @throws \EE_Error
-     * @return    mixed    EE_Config_Base | NULL
-     */
-    public function _update_config(EE_Config_Base $config_obj = null)
-    {
-        $config_class = $this->config_class();
-        if (! $config_obj instanceof $config_class) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The "%1$s" class is not an instance of %2$s.', 'event_espresso'),
-                    print_r($config_obj, true),
-                    $config_class
-                )
-            );
-        }
-        return EE_Config::instance()->update_config($this->config_section(), $this->config_name(), $config_obj);
-    }
-
-
-    /**
-     * gets the class's config object
-     *
-     * @return EE_Config_Base
-     */
-    public function config()
-    {
-        if (empty($this->_config)) {
-            $this->_config = EE_Config::instance()->get_config(
-                $this->config_section(),
-                $this->config_name(),
-                $this->config_class()
-            );
-        }
-        return $this->_config;
-    }
+	/**
+	 * @var $_config
+	 * @type EE_Config_Base
+	 */
+	protected $_config;
+
+	/**
+	 * @var $_config_section
+	 * @type string
+	 */
+	protected $_config_section = '';
+
+	/**
+	 * @var $_config_class
+	 * @type string
+	 */
+	protected $_config_class = '';
+
+	/**
+	 * @var $_config_name
+	 * @type string
+	 */
+	protected $_config_name = '';
+
+
+	/**
+	 * @param string $config_section
+	 */
+	public function set_config_section($config_section = '')
+	{
+		$this->_config_section = ! empty($config_section) ? $config_section : 'modules';
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function config_section()
+	{
+		return $this->_config_section;
+	}
+
+
+	/**
+	 * @param string $config_class
+	 */
+	public function set_config_class($config_class = '')
+	{
+		$this->_config_class = $config_class;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function config_class()
+	{
+		return $this->_config_class;
+	}
+
+
+	/**
+	 * @param mixed $config_name
+	 */
+	public function set_config_name($config_name)
+	{
+		$this->_config_name = ! empty($config_name) ? $config_name : get_called_class();
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function config_name()
+	{
+		return $this->_config_name;
+	}
+
+
+	/**
+	 *    set_config
+	 *    this method integrates directly with EE_Config to set up the config object for this class
+	 *
+	 * @access    protected
+	 * @param    EE_Config_Base $config_obj
+	 * @return    mixed    EE_Config_Base | NULL
+	 */
+	protected function _set_config(EE_Config_Base $config_obj = null)
+	{
+		return EE_Config::instance()->set_config(
+			$this->config_section(),
+			$this->config_name(),
+			$this->config_class(),
+			$config_obj
+		);
+	}
+
+
+	/**
+	 *    _update_config
+	 *    this method integrates directly with EE_Config to update an existing config object for this class
+	 *
+	 * @access    protected
+	 * @param    EE_Config_Base $config_obj
+	 * @throws \EE_Error
+	 * @return    mixed    EE_Config_Base | NULL
+	 */
+	public function _update_config(EE_Config_Base $config_obj = null)
+	{
+		$config_class = $this->config_class();
+		if (! $config_obj instanceof $config_class) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The "%1$s" class is not an instance of %2$s.', 'event_espresso'),
+					print_r($config_obj, true),
+					$config_class
+				)
+			);
+		}
+		return EE_Config::instance()->update_config($this->config_section(), $this->config_name(), $config_obj);
+	}
+
+
+	/**
+	 * gets the class's config object
+	 *
+	 * @return EE_Config_Base
+	 */
+	public function config()
+	{
+		if (empty($this->_config)) {
+			$this->_config = EE_Config::instance()->get_config(
+				$this->config_section(),
+				$this->config_name(),
+				$this->config_class()
+			);
+		}
+		return $this->_config;
+	}
 }

core/db_models/EEM_Transaction.model.php

Spacing +13 added lines, -13 removed lines

@@ -143,7 +143,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Registration'   => new EE_Has_Many_Relation(),
             'Payment'        => new EE_Has_Many_Relation(),
             'Status'         => new EE_Belongs_To_Relation(),
@@ -211,7 +211,7 @@ 
             ],
             OBJECT,
             [
-                'txnDate' => ['DATE(' . $query_interval . ')', '%s'],
+                'txnDate' => ['DATE('.$query_interval.')', '%s'],
                 'revenue' => ['SUM(TransactionTable.TXN_paid)', '%d'],
             ]
         );
@@ -230,17 +230,17 @@ 
     public function get_revenue_per_event_report($period = '-1 month')
     {
         global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+        $transaction_table          = $wpdb->prefix.'esp_transaction';
+        $registration_table         = $wpdb->prefix.'esp_registration';
+        $registration_payment_table = $wpdb->prefix.'esp_registration_payment';
         $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
+        $payment_table              = $wpdb->prefix.'esp_payment';
         $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
         $approved_payment_status    = EEM_Payment::status_id_approved;
         $extra_event_on_join        = '';
         // exclude events not authored by user if permissions in effect
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+            $extra_event_on_join = ' AND Event.post_author = '.get_current_user_id();
         }
 
         return $wpdb->get_results(
@@ -318,7 +318,7 @@ 
     public function update_based_on_payments($transaction_obj_or_id, $save_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_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
@@ -390,7 +390,7 @@ 
             $time_to_leave_alone
         );
         // now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
+        if ( ! empty($txn_ids) && is_array($txn_ids)) {
             // first, make sure these TXN's are removed the "ee_locked_transactions" array
             EEM_Transaction::unset_locked_transactions($txn_ids);
 
@@ -403,7 +403,7 @@ 
             // let's get deleting...
             // We got the ids from the original query to get them FROM
             // the db (which is sanitized) so no need to prepare them again.
-            $query   = $wpdb->prepare("DELETE FROM " . $this->table() . " WHERE TXN_ID IN ( $format )", $txn_ids);
+            $query   = $wpdb->prepare("DELETE FROM ".$this->table()." WHERE TXN_ID IN ( $format )", $txn_ids);
             $deleted = $wpdb->query($query);
         }
         if ($deleted) {
@@ -427,8 +427,8 @@ 
         $locked_transactions = get_option('ee_locked_transactions', []);
         $update              = false;
         foreach ($transaction_IDs as $TXN_ID) {
-            if (isset($locked_transactions[ $TXN_ID ])) {
-                unset($locked_transactions[ $TXN_ID ]);
+            if (isset($locked_transactions[$TXN_ID])) {
+                unset($locked_transactions[$TXN_ID]);
                 $update = true;
             }
         }

Indentation +448 added lines, -448 removed lines

@@ -18,226 +18,226 @@ 
  */
 class EEM_Transaction extends EEM_Base
 {
-    // private instance of the Transaction object
-    protected static $_instance;
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
-     * but payment is pending. This is the state for transactions where payment is promised
-     * from an offline gateway.
-     */
-    //  const open_status_code = 'TPN';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
-     * either due to a technical reason (server or computer crash during registration),
-     *  or some other reason that prevent the collection of any useful contact information from any of the registrants
-     */
-    const failed_status_code = 'TFL';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
-     * either due to a technical reason (server or computer crash during registration),
-     * or due to an abandoned cart after registrant chose not to complete the registration process
-     * HOWEVER...
-     * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
-     * registrant
-     */
-    const abandoned_status_code = 'TAB';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
-     * meaning that monies are still owing: TXN_paid < TXN_total
-     */
-    const incomplete_status_code = 'TIN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
-     * meaning that NO monies are owing: TXN_paid == TXN_total
-     */
-    const complete_status_code = 'TCM';
-
-    /**
-     *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
-     *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
-     */
-    const overpaid_status_code = 'TOP';
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $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)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Transaction', 'event_espresso');
-        $this->plural_item   = esc_html__('Transactions', 'event_espresso');
-
-        $this->_tables                 = [
-            'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID'),
-        ];
-        $this->_fields                 = [
-            'TransactionTable' => [
-                'TXN_ID'           => new EE_Primary_Key_Int_Field(
-                    'TXN_ID', esc_html__('Transaction ID', 'event_espresso')
-                ),
-                'TXN_timestamp'    => new EE_Datetime_Field(
-                    'TXN_timestamp',
-                    esc_html__('date when transaction was created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TXN_total'        => new EE_Money_Field(
-                    'TXN_total',
-                    esc_html__('Total value of Transaction', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TXN_paid'         => new EE_Money_Field(
-                    'TXN_paid',
-                    esc_html__('Amount paid towards transaction to date', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'STS_ID'           => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status ID', 'event_espresso'),
-                    false,
-                    EEM_Transaction::failed_status_code,
-                    'Status'
-                ),
-                'TXN_session_data' => new EE_Serialized_Text_Field(
-                    'TXN_session_data',
-                    esc_html__('Serialized session data', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'TXN_hash_salt'    => new EE_Plain_Text_Field(
-                    'TXN_hash_salt',
-                    esc_html__('Transaction Hash Salt', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PMD_ID'           => new EE_Foreign_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__("Last Used Payment Method", 'event_espresso'),
-                    true,
-                    null,
-                    'Payment_Method'
-                ),
-                'TXN_reg_steps'    => new EE_Serialized_Text_Field(
-                    'TXN_reg_steps',
-                    esc_html__('Registration Steps', 'event_espresso'),
-                    false,
-                    []
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Registration'   => new EE_Has_Many_Relation(),
-            'Payment'        => new EE_Has_Many_Relation(),
-            'Status'         => new EE_Belongs_To_Relation(),
-            'Line_Item'      => new EE_Has_Many_Relation(false),
-            // you can delete a transaction without needing to delete its line items
-            'Payment_Method' => new EE_Belongs_To_Relation(),
-            'Message'        => new EE_Has_Many_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     *    txn_status_array
-     * get list of transaction statuses
-     *
-     * @access public
-     * @return array
-     */
-    public static function txn_status_array()
-    {
-        return apply_filters(
-            'FHEE__EEM_Transaction__txn_status_array',
-            [
-                EEM_Transaction::overpaid_status_code,
-                EEM_Transaction::complete_status_code,
-                EEM_Transaction::incomplete_status_code,
-                EEM_Transaction::abandoned_status_code,
-                EEM_Transaction::failed_status_code,
-            ]
-        );
-    }
-
-
-    /**
-     *        get the revenue per day  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     * @param string $period
-     * @return stdClass[]
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_revenue_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
-
-        return $this->_get_all_wpdb_results(
-            [
-                [
-                    'TXN_timestamp' => ['>=', $sql_date],
-                ],
-                'group_by' => 'txnDate',
-                'order_by' => ['TXN_timestamp' => 'ASC'],
-            ],
-            OBJECT,
-            [
-                'txnDate' => ['DATE(' . $query_interval . ')', '%s'],
-                'revenue' => ['SUM(TransactionTable.TXN_paid)', '%d'],
-            ]
-        );
-    }
-
-
-    /**
-     *        get the revenue per event  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     * @param string $period
-     * @return EE_Transaction[]
-     */
-    public function get_revenue_per_event_report($period = '-1 month')
-    {
-        global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
-        $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
-        $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
-        $approved_payment_status    = EEM_Payment::status_id_approved;
-        $extra_event_on_join        = '';
-        // exclude events not authored by user if permissions in effect
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
-        }
-
-        return $wpdb->get_results(
-            "SELECT
+	// private instance of the Transaction object
+	protected static $_instance;
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
+	 * but payment is pending. This is the state for transactions where payment is promised
+	 * from an offline gateway.
+	 */
+	//  const open_status_code = 'TPN';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
+	 * either due to a technical reason (server or computer crash during registration),
+	 *  or some other reason that prevent the collection of any useful contact information from any of the registrants
+	 */
+	const failed_status_code = 'TFL';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
+	 * either due to a technical reason (server or computer crash during registration),
+	 * or due to an abandoned cart after registrant chose not to complete the registration process
+	 * HOWEVER...
+	 * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
+	 * registrant
+	 */
+	const abandoned_status_code = 'TAB';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
+	 * meaning that monies are still owing: TXN_paid < TXN_total
+	 */
+	const incomplete_status_code = 'TIN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
+	 * meaning that NO monies are owing: TXN_paid == TXN_total
+	 */
+	const complete_status_code = 'TCM';
+
+	/**
+	 *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
+	 *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
+	 */
+	const overpaid_status_code = 'TOP';
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $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)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Transaction', 'event_espresso');
+		$this->plural_item   = esc_html__('Transactions', 'event_espresso');
+
+		$this->_tables                 = [
+			'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID'),
+		];
+		$this->_fields                 = [
+			'TransactionTable' => [
+				'TXN_ID'           => new EE_Primary_Key_Int_Field(
+					'TXN_ID', esc_html__('Transaction ID', 'event_espresso')
+				),
+				'TXN_timestamp'    => new EE_Datetime_Field(
+					'TXN_timestamp',
+					esc_html__('date when transaction was created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TXN_total'        => new EE_Money_Field(
+					'TXN_total',
+					esc_html__('Total value of Transaction', 'event_espresso'),
+					false,
+					0
+				),
+				'TXN_paid'         => new EE_Money_Field(
+					'TXN_paid',
+					esc_html__('Amount paid towards transaction to date', 'event_espresso'),
+					false,
+					0
+				),
+				'STS_ID'           => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status ID', 'event_espresso'),
+					false,
+					EEM_Transaction::failed_status_code,
+					'Status'
+				),
+				'TXN_session_data' => new EE_Serialized_Text_Field(
+					'TXN_session_data',
+					esc_html__('Serialized session data', 'event_espresso'),
+					true,
+					''
+				),
+				'TXN_hash_salt'    => new EE_Plain_Text_Field(
+					'TXN_hash_salt',
+					esc_html__('Transaction Hash Salt', 'event_espresso'),
+					true,
+					''
+				),
+				'PMD_ID'           => new EE_Foreign_Key_Int_Field(
+					'PMD_ID',
+					esc_html__("Last Used Payment Method", 'event_espresso'),
+					true,
+					null,
+					'Payment_Method'
+				),
+				'TXN_reg_steps'    => new EE_Serialized_Text_Field(
+					'TXN_reg_steps',
+					esc_html__('Registration Steps', 'event_espresso'),
+					false,
+					[]
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Registration'   => new EE_Has_Many_Relation(),
+			'Payment'        => new EE_Has_Many_Relation(),
+			'Status'         => new EE_Belongs_To_Relation(),
+			'Line_Item'      => new EE_Has_Many_Relation(false),
+			// you can delete a transaction without needing to delete its line items
+			'Payment_Method' => new EE_Belongs_To_Relation(),
+			'Message'        => new EE_Has_Many_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 *    txn_status_array
+	 * get list of transaction statuses
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function txn_status_array()
+	{
+		return apply_filters(
+			'FHEE__EEM_Transaction__txn_status_array',
+			[
+				EEM_Transaction::overpaid_status_code,
+				EEM_Transaction::complete_status_code,
+				EEM_Transaction::incomplete_status_code,
+				EEM_Transaction::abandoned_status_code,
+				EEM_Transaction::failed_status_code,
+			]
+		);
+	}
+
+
+	/**
+	 *        get the revenue per day  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 * @param string $period
+	 * @return stdClass[]
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_revenue_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
+
+		return $this->_get_all_wpdb_results(
+			[
+				[
+					'TXN_timestamp' => ['>=', $sql_date],
+				],
+				'group_by' => 'txnDate',
+				'order_by' => ['TXN_timestamp' => 'ASC'],
+			],
+			OBJECT,
+			[
+				'txnDate' => ['DATE(' . $query_interval . ')', '%s'],
+				'revenue' => ['SUM(TransactionTable.TXN_paid)', '%d'],
+			]
+		);
+	}
+
+
+	/**
+	 *        get the revenue per event  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 * @param string $period
+	 * @return EE_Transaction[]
+	 */
+	public function get_revenue_per_event_report($period = '-1 month')
+	{
+		global $wpdb;
+		$transaction_table          = $wpdb->prefix . 'esp_transaction';
+		$registration_table         = $wpdb->prefix . 'esp_registration';
+		$registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+		$event_table                = $wpdb->posts;
+		$payment_table              = $wpdb->prefix . 'esp_payment';
+		$sql_date                   = date('Y-m-d H:i:s', strtotime($period));
+		$approved_payment_status    = EEM_Payment::status_id_approved;
+		$extra_event_on_join        = '';
+		// exclude events not authored by user if permissions in effect
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+		}
+
+		return $wpdb->get_results(
+			"SELECT
 			Transaction_Event.event_name AS event_name,
 			SUM(Transaction_Event.paid) AS revenue
 			FROM
@@ -265,232 +265,232 @@ 
 					$extra_event_on_join
 				) AS Transaction_Event
 			GROUP BY event_name"
-        );
-    }
-
-
-    /**
-     * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
-     * request global variable. Either way, tries to find the current transaction (through
-     * the registration pointed to by reg_url_link), if not returns null
-     *
-     * @param string $reg_url_link
-     * @return EE_Transaction
-     * @throws EE_Error
-     */
-    public function get_transaction_from_reg_url_link($reg_url_link = '')
-    {
-        if (empty($reg_url_link)) {
-            $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $reg_url_link = $request->getRequestParam('e_reg_url_link');
-        }
-        return $this->get_one(
-            [
-                [
-                    'Registration.REG_url_link' => $reg_url_link,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * (or fetch the EE_Transaction from its ID)
-     *
-     * @param EE_Transaction|int $transaction_obj_or_id
-     * @param boolean            $save_txn whether or not to save the transaction during this function call
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
-            ),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-            $this->ensure_is_obj($transaction_obj_or_id)
-        );
-    }
-
-
-    /**
-     * Deletes "junk" transactions that were probably added by bots. There might be TONS
-     * of these, so we are very careful to NOT select (which the models do even when deleting),
-     * and so we only use wpdb directly and only do minimal joins.
-     * Transactions are considered "junk" if they're failed for longer than a week.
-     * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
-     * it, it's probably not junk (regardless of what status it has).
-     * The downside to this approach is that is addons are listening for object deletions
-     * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
-     * to catch these types of deletions.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     * @global WPDB $wpdb
-     */
-    public function delete_junk_transactions()
-    {
-        global $wpdb;
-        $deleted             = false;
-        $time_to_leave_alone = (int) apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone',
-            WEEK_IN_SECONDS
-        );
-
-
-        /**
-         * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
-         * Useful for plugins that want to exclude transactions matching certain query parameters.
-         * The query parameters should be in the format accepted by the EEM_Base model queries.
-         */
-        $ids_query = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
-            [
-                0          => [
-                    'STS_ID'         => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => ['IS NULL'],
-                    'TXN_timestamp'  => ['<', time() - $time_to_leave_alone],
-                ],
-                'order_by' => ['TXN_timestamp' => 'ASC'],
-                'limit'    => 1000,
-            ],
-            $time_to_leave_alone
-        );
-
-
-        /**
-         * This filter is for when code needs to filter the list of transaction ids that represent transactions
-         * about to be deleted based on some other criteria that isn't easily done via the query args filter.
-         */
-        $txn_ids = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
-            EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
-            $time_to_leave_alone
-        );
-        // now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
-            // first, make sure these TXN's are removed the "ee_locked_transactions" array
-            EEM_Transaction::unset_locked_transactions($txn_ids);
-
-            // Create IDs placeholder.
-            $placeholders = array_fill(0, count($txn_ids), '%d');
-
-            // Glue it together to use inside $wpdb->prepare.
-            $format = implode(', ', $placeholders);
-
-            // let's get deleting...
-            // We got the ids from the original query to get them FROM
-            // the db (which is sanitized) so no need to prepare them again.
-            $query   = $wpdb->prepare("DELETE FROM " . $this->table() . " WHERE TXN_ID IN ( $format )", $txn_ids);
-            $deleted = $wpdb->query($query);
-        }
-        if ($deleted) {
-            /**
-             * Allows code to do something after the transactions have been deleted.
-             */
-            do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
-        }
-
-        return $deleted;
-    }
-
-
-    /**
-     * @param array $transaction_IDs
-     * @return bool
-     */
-    public static function unset_locked_transactions(array $transaction_IDs)
-    {
-        $locked_transactions = get_option('ee_locked_transactions', []);
-        $update              = false;
-        foreach ($transaction_IDs as $TXN_ID) {
-            if (isset($locked_transactions[ $TXN_ID ])) {
-                unset($locked_transactions[ $TXN_ID ]);
-                $update = true;
-            }
-        }
-        if ($update) {
-            update_option('ee_locked_transactions', $locked_transactions);
-        }
-
-        return $update;
-    }
-
-
-    /**
-     * returns an array of EE_Transaction objects whose timestamp is greater than
-     * the current time minus the session lifespan, which defaults to 60 minutes
-     *
-     * @return EE_Base_Class[]|EE_Transaction[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transactions_in_progress()
-    {
-        return $this->_get_transactions_in_progress();
-    }
-
-
-    /**
-     * returns an array of EE_Transaction objects whose timestamp is less than
-     * the current time minus the session lifespan, which defaults to 60 minutes
-     *
-     * @return EE_Base_Class[]|EE_Transaction[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transactions_not_in_progress()
-    {
-        return $this->_get_transactions_in_progress('<=');
-    }
-
-
-    /**
-     * @param string $comparison
-     * @return EE_Transaction[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_transactions_in_progress($comparison = '>=')
-    {
-        $comparison = $comparison === '>=' || $comparison === '<='
-            ? $comparison
-            : '>=';
-        /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-        $session_lifespan = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\values\session\SessionLifespan'
-        );
-        return $this->get_all(
-            [
-                [
-                    'TXN_timestamp' => [
-                        $comparison,
-                        $session_lifespan->expiration(),
-                    ],
-                    'STS_ID'        => [
-                        '!=',
-                        EEM_Transaction::complete_status_code,
-                    ],
-                ],
-            ]
-        );
-    }
+		);
+	}
+
+
+	/**
+	 * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
+	 * request global variable. Either way, tries to find the current transaction (through
+	 * the registration pointed to by reg_url_link), if not returns null
+	 *
+	 * @param string $reg_url_link
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 */
+	public function get_transaction_from_reg_url_link($reg_url_link = '')
+	{
+		if (empty($reg_url_link)) {
+			$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$reg_url_link = $request->getRequestParam('e_reg_url_link');
+		}
+		return $this->get_one(
+			[
+				[
+					'Registration.REG_url_link' => $reg_url_link,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * (or fetch the EE_Transaction from its ID)
+	 *
+	 * @param EE_Transaction|int $transaction_obj_or_id
+	 * @param boolean            $save_txn whether or not to save the transaction during this function call
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
+			),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+			$this->ensure_is_obj($transaction_obj_or_id)
+		);
+	}
+
+
+	/**
+	 * Deletes "junk" transactions that were probably added by bots. There might be TONS
+	 * of these, so we are very careful to NOT select (which the models do even when deleting),
+	 * and so we only use wpdb directly and only do minimal joins.
+	 * Transactions are considered "junk" if they're failed for longer than a week.
+	 * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
+	 * it, it's probably not junk (regardless of what status it has).
+	 * The downside to this approach is that is addons are listening for object deletions
+	 * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
+	 * to catch these types of deletions.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @global WPDB $wpdb
+	 */
+	public function delete_junk_transactions()
+	{
+		global $wpdb;
+		$deleted             = false;
+		$time_to_leave_alone = (int) apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone',
+			WEEK_IN_SECONDS
+		);
+
+
+		/**
+		 * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
+		 * Useful for plugins that want to exclude transactions matching certain query parameters.
+		 * The query parameters should be in the format accepted by the EEM_Base model queries.
+		 */
+		$ids_query = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
+			[
+				0          => [
+					'STS_ID'         => EEM_Transaction::failed_status_code,
+					'Payment.PAY_ID' => ['IS NULL'],
+					'TXN_timestamp'  => ['<', time() - $time_to_leave_alone],
+				],
+				'order_by' => ['TXN_timestamp' => 'ASC'],
+				'limit'    => 1000,
+			],
+			$time_to_leave_alone
+		);
+
+
+		/**
+		 * This filter is for when code needs to filter the list of transaction ids that represent transactions
+		 * about to be deleted based on some other criteria that isn't easily done via the query args filter.
+		 */
+		$txn_ids = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
+			EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
+			$time_to_leave_alone
+		);
+		// now that we have the ids to delete
+		if (! empty($txn_ids) && is_array($txn_ids)) {
+			// first, make sure these TXN's are removed the "ee_locked_transactions" array
+			EEM_Transaction::unset_locked_transactions($txn_ids);
+
+			// Create IDs placeholder.
+			$placeholders = array_fill(0, count($txn_ids), '%d');
+
+			// Glue it together to use inside $wpdb->prepare.
+			$format = implode(', ', $placeholders);
+
+			// let's get deleting...
+			// We got the ids from the original query to get them FROM
+			// the db (which is sanitized) so no need to prepare them again.
+			$query   = $wpdb->prepare("DELETE FROM " . $this->table() . " WHERE TXN_ID IN ( $format )", $txn_ids);
+			$deleted = $wpdb->query($query);
+		}
+		if ($deleted) {
+			/**
+			 * Allows code to do something after the transactions have been deleted.
+			 */
+			do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
+		}
+
+		return $deleted;
+	}
+
+
+	/**
+	 * @param array $transaction_IDs
+	 * @return bool
+	 */
+	public static function unset_locked_transactions(array $transaction_IDs)
+	{
+		$locked_transactions = get_option('ee_locked_transactions', []);
+		$update              = false;
+		foreach ($transaction_IDs as $TXN_ID) {
+			if (isset($locked_transactions[ $TXN_ID ])) {
+				unset($locked_transactions[ $TXN_ID ]);
+				$update = true;
+			}
+		}
+		if ($update) {
+			update_option('ee_locked_transactions', $locked_transactions);
+		}
+
+		return $update;
+	}
+
+
+	/**
+	 * returns an array of EE_Transaction objects whose timestamp is greater than
+	 * the current time minus the session lifespan, which defaults to 60 minutes
+	 *
+	 * @return EE_Base_Class[]|EE_Transaction[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transactions_in_progress()
+	{
+		return $this->_get_transactions_in_progress();
+	}
+
+
+	/**
+	 * returns an array of EE_Transaction objects whose timestamp is less than
+	 * the current time minus the session lifespan, which defaults to 60 minutes
+	 *
+	 * @return EE_Base_Class[]|EE_Transaction[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transactions_not_in_progress()
+	{
+		return $this->_get_transactions_in_progress('<=');
+	}
+
+
+	/**
+	 * @param string $comparison
+	 * @return EE_Transaction[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_transactions_in_progress($comparison = '>=')
+	{
+		$comparison = $comparison === '>=' || $comparison === '<='
+			? $comparison
+			: '>=';
+		/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+		$session_lifespan = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\values\session\SessionLifespan'
+		);
+		return $this->get_all(
+			[
+				[
+					'TXN_timestamp' => [
+						$comparison,
+						$session_lifespan->expiration(),
+					],
+					'STS_ID'        => [
+						'!=',
+						EEM_Transaction::complete_status_code,
+					],
+				],
+			]
+		);
+	}
 }

core/db_models/fields/EE_Foreign_Key_Int_Field.php

Indentation +29 added lines, -29 removed lines

@@ -3,36 +3,36 @@
 class EE_Foreign_Key_Int_Field extends EE_Foreign_Key_Field_Base
 {
 
-    /**
-     * @param string  $table_column  name fo column for field
-     * @param string  $nicename      should eb internationalized with esc_html__('blah','event_espresso')
-     * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
-     *                               dbe a string
-     * @param string|string[]  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
-     *                               "EEM_"
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
-        $this->setSchemaType('integer');
-    }
+	/**
+	 * @param string  $table_column  name fo column for field
+	 * @param string  $nicename      should eb internationalized with esc_html__('blah','event_espresso')
+	 * @param boolean $nullable
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+	 *                               dbe a string
+	 * @param string|string[]  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
+	 *                               "EEM_"
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
+		$this->setSchemaType('integer');
+	}
 
 
-    /**
-     * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
-     * @return int
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return absint($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
+	 * @return int
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return absint($value_inputted_for_field_on_model_object);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return intval($value_found_in_db_for_model_object);
-    }
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return intval($value_found_in_db_for_model_object);
+	}
 }

core/db_models/fields/EE_WP_User_Field.php

Indentation +34 added lines, -34 removed lines

@@ -13,39 +13,39 @@
  */
 class EE_WP_User_Field extends EE_Foreign_Key_Int_Field
 {
-    /**
-     * No need to provide a default or the model pointed to- the default is
-     * always get_current_user_id() and the model pointed to is always WP_User
-     *
-     * @param string  $table_column name fo column for field
-     * @param string  $nicename     should eb internationalized with esc_html__('blah','event_espresso')
-     * @param boolean $nullable
-     */
-    public function __construct($table_column, $nicename, $nullable)
-    {
-        parent::__construct($table_column, $nicename, $nullable, null, 'WP_User');
-    }
+	/**
+	 * No need to provide a default or the model pointed to- the default is
+	 * always get_current_user_id() and the model pointed to is always WP_User
+	 *
+	 * @param string  $table_column name fo column for field
+	 * @param string  $nicename     should eb internationalized with esc_html__('blah','event_espresso')
+	 * @param boolean $nullable
+	 */
+	public function __construct($table_column, $nicename, $nullable)
+	{
+		parent::__construct($table_column, $nicename, $nullable, null, 'WP_User');
+	}
 
-    /**
-     * Gets the default which is always the current user. This can't be set when initially
-     * constructing the model field because that's done before $current_user is set
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        if (did_action('init')) {
-            return get_current_user_id();
-        } else {
-            EE_Error::doing_it_wrong(
-                'EE_WP_User_Field::get_default_value',
-                esc_html__(
-                    'You cant get a default value for a wp_User_Field because the "init" action is called, because current_user global hasnt yet been setup. Consider doing your business logic on the "init" hook or later.',
-                    'event_espresso'
-                ),
-                '4.6.20'
-            );
-            return 1;
-        }
-    }
+	/**
+	 * Gets the default which is always the current user. This can't be set when initially
+	 * constructing the model field because that's done before $current_user is set
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		if (did_action('init')) {
+			return get_current_user_id();
+		} else {
+			EE_Error::doing_it_wrong(
+				'EE_WP_User_Field::get_default_value',
+				esc_html__(
+					'You cant get a default value for a wp_User_Field because the "init" action is called, because current_user global hasnt yet been setup. Consider doing your business logic on the "init" hook or later.',
+					'event_espresso'
+				),
+				'4.6.20'
+			);
+			return 1;
+		}
+	}
 }

core/business/EE_Transaction_Payments.class.php

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__,

Indentation +420 added lines, -420 removed lines

@@ -14,424 +14,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;
+	}
 }

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

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;

Indentation +56 added lines, -56 removed lines

@@ -22,64 +22,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;
+	}
 }

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

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

Indentation +219 added lines, -219 removed lines

@@ -21,239 +21,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;
+	}
 }

core/domain/services/ticket/CancelTicketLineItemService.php

Spacing +2 added lines, -2 removed lines

@@ -88,7 +88,7 @@ 
             );
             $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new \RuntimeException(
                 sprintf(
                     esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
@@ -125,7 +125,7 @@ 
                 break;
             }
         }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+        if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
             throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
         }
         return $line_item;

Indentation +106 added lines, -106 removed lines

@@ -18,114 +18,114 @@
  */
 class CancelTicketLineItemService extends DomainService
 {
-    /**
-     * @param \EE_Registration $registration
-     * @param int              $quantity
-     * @return bool|int
-     */
-    public function forRegistration(\EE_Registration $registration, $quantity = 1)
-    {
-        return $this->cancel(
-            $registration->transaction(),
-            $registration->ticket(),
-            $quantity,
-            $registration->ticket_line_item()
-        );
-    }
+	/**
+	 * @param \EE_Registration $registration
+	 * @param int              $quantity
+	 * @return bool|int
+	 */
+	public function forRegistration(\EE_Registration $registration, $quantity = 1)
+	{
+		return $this->cancel(
+			$registration->transaction(),
+			$registration->ticket(),
+			$quantity,
+			$registration->ticket_line_item()
+		);
+	}
 
 
-    /**
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @param int             $quantity
-     * @param \EE_Line_Item   $ticket_line_item
-     * @return bool|int
-     */
-    public function cancel(
-        \EE_Transaction $transaction,
-        \EE_Ticket $ticket,
-        $quantity = 1,
-        \EE_Line_Item $ticket_line_item = null
-    ) {
-        $ticket_line_item = $ticket_line_item instanceof \EE_Line_Item
-            ? $ticket_line_item
-            : $this->getTicketLineItem($transaction, $ticket);
-        // first we need to decrement the ticket quantity
-        \EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity);
-        // no tickets left for this line item ?
-        if ((int) $ticket_line_item->quantity() === 0) {
-            // then just set this line item as cancelled, save, and get out
-            $ticket_line_item->set_type(\EEM_Line_Item::type_cancellation);
-            $success = $ticket_line_item->save();
-        } else {
-            // otherwise create a new cancelled line item, so that we have a record of the cancellation
-            $items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal(
-                \EEH_Line_Item::get_event_line_item_for_ticket(
-                    $transaction->total_line_item(),
-                    $ticket
-                )
-            );
-            $cancelled_line_item = \EE_Line_Item::new_instance(
-                array(
-                    'LIN_name'       => $ticket_line_item->name(),
-                    'LIN_desc'       => sprintf(
-                        esc_html__('%1$s Cancelled: %2$s', 'event_espresso'),
-                        $ticket_line_item->desc(),
-                        date('Y-m-d h:i a')
-                    ),
-                    'LIN_unit_price' => (float) $ticket_line_item->unit_price(),
-                    'LIN_quantity'   => $quantity,
-                    'LIN_percent'    => null,
-                    'LIN_is_taxable' => false,
-                    'LIN_order'      => $items_subtotal instanceof \EE_Line_Item
-                        ? count($items_subtotal->children())
-                        : 0,
-                    'LIN_total'      => (float) $ticket_line_item->unit_price(),
-                    'LIN_type'       => \EEM_Line_Item::type_cancellation,
-                )
-            );
-            $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
-        }
-        if (! $success) {
-            throw new \RuntimeException(
-                sprintf(
-                    esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
-                    $ticket_line_item->ID()
-                )
-            );
-        }
-        return $success;
-    }
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @param int             $quantity
+	 * @param \EE_Line_Item   $ticket_line_item
+	 * @return bool|int
+	 */
+	public function cancel(
+		\EE_Transaction $transaction,
+		\EE_Ticket $ticket,
+		$quantity = 1,
+		\EE_Line_Item $ticket_line_item = null
+	) {
+		$ticket_line_item = $ticket_line_item instanceof \EE_Line_Item
+			? $ticket_line_item
+			: $this->getTicketLineItem($transaction, $ticket);
+		// first we need to decrement the ticket quantity
+		\EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity);
+		// no tickets left for this line item ?
+		if ((int) $ticket_line_item->quantity() === 0) {
+			// then just set this line item as cancelled, save, and get out
+			$ticket_line_item->set_type(\EEM_Line_Item::type_cancellation);
+			$success = $ticket_line_item->save();
+		} else {
+			// otherwise create a new cancelled line item, so that we have a record of the cancellation
+			$items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal(
+				\EEH_Line_Item::get_event_line_item_for_ticket(
+					$transaction->total_line_item(),
+					$ticket
+				)
+			);
+			$cancelled_line_item = \EE_Line_Item::new_instance(
+				array(
+					'LIN_name'       => $ticket_line_item->name(),
+					'LIN_desc'       => sprintf(
+						esc_html__('%1$s Cancelled: %2$s', 'event_espresso'),
+						$ticket_line_item->desc(),
+						date('Y-m-d h:i a')
+					),
+					'LIN_unit_price' => (float) $ticket_line_item->unit_price(),
+					'LIN_quantity'   => $quantity,
+					'LIN_percent'    => null,
+					'LIN_is_taxable' => false,
+					'LIN_order'      => $items_subtotal instanceof \EE_Line_Item
+						? count($items_subtotal->children())
+						: 0,
+					'LIN_total'      => (float) $ticket_line_item->unit_price(),
+					'LIN_type'       => \EEM_Line_Item::type_cancellation,
+				)
+			);
+			$success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
+		}
+		if (! $success) {
+			throw new \RuntimeException(
+				sprintf(
+					esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
+					$ticket_line_item->ID()
+				)
+			);
+		}
+		return $success;
+	}
 
 
-    /**
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws \EE_Error
-     */
-    protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket)
-    {
-        $line_item = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            array($ticket->ID())
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws \EE_Error
+	 */
+	protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket)
+	{
+		$line_item = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			array($ticket->ID())
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
 }