eventespresso / event-espresso-core

core/db_models/EEM_Checkin.model.php

Spacing +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Registration' => new EE_Belongs_To_Relation(),
             'Datetime'     => new EE_Belongs_To_Relation(),
         ];

Indentation +61 added lines, -61 removed lines

@@ -10,68 +10,68 @@
  */
 class EEM_Checkin extends EEM_Base
 {
-    // private instance of the EEM_Checkin object
-    protected static $_instance;
+	// private instance of the EEM_Checkin object
+	protected static $_instance;
 
 
-    /**
-     * 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
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Check-In', 'event_espresso');
-        $this->plural_item   = esc_html__('Check-Ins', 'event_espresso');
+	/**
+	 * 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
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Check-In', 'event_espresso');
+		$this->plural_item   = esc_html__('Check-Ins', 'event_espresso');
 
-        $this->_tables                 = [
-            'Checkin' => new EE_Primary_Table('esp_checkin', 'CHK_ID'),
-        ];
-        $this->_fields                 = [
-            'Checkin' => [
-                'CHK_ID'        => new EE_Primary_Key_Int_Field(
-                    'CHK_ID',
-                    esc_html__('Check-in ID', 'event_espresso')
-                ),
-                'REG_ID'        => new EE_Foreign_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Registration'
-                ),
-                'DTT_ID'        => new EE_Foreign_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('Datetime Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Datetime'
-                ),
-                'CHK_in'        => new EE_Boolean_Field(
-                    'CHK_in',
-                    esc_html__('Whether a person has checked in or checked out', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CHK_timestamp' => new EE_Datetime_Field(
-                    'CHK_timestamp',
-                    esc_html__('When the row was modified', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Registration' => new EE_Belongs_To_Relation(),
-            'Datetime'     => new EE_Belongs_To_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        parent::__construct($timezone);
-    }
+		$this->_tables                 = [
+			'Checkin' => new EE_Primary_Table('esp_checkin', 'CHK_ID'),
+		];
+		$this->_fields                 = [
+			'Checkin' => [
+				'CHK_ID'        => new EE_Primary_Key_Int_Field(
+					'CHK_ID',
+					esc_html__('Check-in ID', 'event_espresso')
+				),
+				'REG_ID'        => new EE_Foreign_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration Id', 'event_espresso'),
+					false,
+					0,
+					'Registration'
+				),
+				'DTT_ID'        => new EE_Foreign_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('Datetime Id', 'event_espresso'),
+					false,
+					0,
+					'Datetime'
+				),
+				'CHK_in'        => new EE_Boolean_Field(
+					'CHK_in',
+					esc_html__('Whether a person has checked in or checked out', 'event_espresso'),
+					false,
+					true
+				),
+				'CHK_timestamp' => new EE_Datetime_Field(
+					'CHK_timestamp',
+					esc_html__('When the row was modified', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Registration' => new EE_Belongs_To_Relation(),
+			'Datetime'     => new EE_Belongs_To_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Term_Relationship.model.php

Spacing +14 added lines, -14 removed lines

@@ -54,61 +54,61 @@ 
                 ),
             ],
         ];
-        $this->_model_relations    = [
+        $this->_model_relations = [
             'Term_Taxonomy' => new EE_Belongs_To_Relation(),
         ];
         foreach ($models_this_can_attach_to as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
+            $this->_model_relations[$model_name] = new EE_Belongs_To_Relation();
         }
         $this->_wp_core_model                                           = true;
         $this->_indexes                                                 = [
             'PRIMARY' => new EE_Primary_Key_Index(['object_id', 'term_taxonomy_id']),
         ];
         $path_to_event_model                                            = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       =
             new EE_Restriction_Generator_Event_Related_Public(
                 $path_to_event_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event_model,
                 EEM_Base::caps_edit
             );
-        $path_to_tax_model                                              = 'Term_Taxonomy.';
+        $path_to_tax_model = 'Term_Taxonomy.';
         // add cap restrictions for editing term relations to the "ee_assign_*"
         // and for deleting term relations too
         $cap_contexts_affected = [EEM_Base::caps_edit, EEM_Base::caps_delete];
         foreach ($cap_contexts_affected as $cap_context_affected) {
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_event_category'] =
                 new EE_Default_Where_Conditions(
                     [
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
+                        $path_to_tax_model.'taxonomy*ee_assign_event_category' => [
                             '!=',
                             'espresso_event_categories',
                         ],
                     ]
                 );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_venue_category'] =
                 new EE_Default_Where_Conditions(
                     [
-                        $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
+                        $path_to_tax_model.'taxonomy*ee_assign_venue_category' => [
                             '!=',
                             'espresso_venue_categories',
                         ],
                     ]
                 );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']     =
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_event_type'] =
                 new EE_Default_Where_Conditions(
                     [
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
+                        $path_to_tax_model.'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
                     ]
                 );
         }
@@ -251,7 +251,7 @@ 
     {
         if ($model === EEM_Term_Relationship::instance()) {
             $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
             }
         }

Indentation +211 added lines, -211 removed lines

@@ -9,234 +9,234 @@
  */
 class EEM_Term_Relationship extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * EEM_Term_Relationship constructor.
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item       = esc_html__('Term Relationship', 'event_espresso');
-        $this->plural_item         = esc_html__('Term Relationships', 'event_espresso');
-        $this->_tables             = [
-            'Term_Relationship' => new EE_Primary_Table('term_relationships'),
-        ];
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields             = [
-            'Term_Relationship' => [
-                'object_id'        => new EE_Foreign_Key_Int_Field(
-                    'object_id',
-                    esc_html__('Object(Post) ID', 'event_espresso'),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
-                    'term_taxonomy_id',
-                    esc_html__(
-                        'Term (in context of a taxonomy) ID',
-                        'event_espresso'
-                    ),
-                    false,
-                    0,
-                    'Term_Taxonomy'
-                ),
-                'term_order'       => new EE_Integer_Field(
-                    'term_order',
-                    esc_html__('Term Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations    = [
-            'Term_Taxonomy' => new EE_Belongs_To_Relation(),
-        ];
-        foreach ($models_this_can_attach_to as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
-        }
-        $this->_wp_core_model                                           = true;
-        $this->_indexes                                                 = [
-            'PRIMARY' => new EE_Primary_Key_Index(['object_id', 'term_taxonomy_id']),
-        ];
-        $path_to_event_model                                            = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Event_Related_Public(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model,
-                EEM_Base::caps_edit
-            );
-        $path_to_tax_model                                              = 'Term_Taxonomy.';
-        // add cap restrictions for editing term relations to the "ee_assign_*"
-        // and for deleting term relations too
-        $cap_contexts_affected = [EEM_Base::caps_edit, EEM_Base::caps_delete];
-        foreach ($cap_contexts_affected as $cap_context_affected) {
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
-                new EE_Default_Where_Conditions(
-                    [
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
-                            '!=',
-                            'espresso_event_categories',
-                        ],
-                    ]
-                );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
-                new EE_Default_Where_Conditions(
-                    [
-                        $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
-                            '!=',
-                            'espresso_venue_categories',
-                        ],
-                    ]
-                );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']     =
-                new EE_Default_Where_Conditions(
-                    [
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
-                    ]
-                );
-        }
-        parent::__construct($timezone);
-        add_filter(
-            'FHEE__Read__create_model_query_params',
-            ['EEM_Term_Relationship', 'rest_api_query_params'],
-            10,
-            3
-        );
-    }
+	/**
+	 * EEM_Term_Relationship constructor.
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item       = esc_html__('Term Relationship', 'event_espresso');
+		$this->plural_item         = esc_html__('Term Relationships', 'event_espresso');
+		$this->_tables             = [
+			'Term_Relationship' => new EE_Primary_Table('term_relationships'),
+		];
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields             = [
+			'Term_Relationship' => [
+				'object_id'        => new EE_Foreign_Key_Int_Field(
+					'object_id',
+					esc_html__('Object(Post) ID', 'event_espresso'),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
+					'term_taxonomy_id',
+					esc_html__(
+						'Term (in context of a taxonomy) ID',
+						'event_espresso'
+					),
+					false,
+					0,
+					'Term_Taxonomy'
+				),
+				'term_order'       => new EE_Integer_Field(
+					'term_order',
+					esc_html__('Term Order', 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations    = [
+			'Term_Taxonomy' => new EE_Belongs_To_Relation(),
+		];
+		foreach ($models_this_can_attach_to as $model_name) {
+			$this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
+		}
+		$this->_wp_core_model                                           = true;
+		$this->_indexes                                                 = [
+			'PRIMARY' => new EE_Primary_Key_Index(['object_id', 'term_taxonomy_id']),
+		];
+		$path_to_event_model                                            = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Event_Related_Public(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model,
+				EEM_Base::caps_edit
+			);
+		$path_to_tax_model                                              = 'Term_Taxonomy.';
+		// add cap restrictions for editing term relations to the "ee_assign_*"
+		// and for deleting term relations too
+		$cap_contexts_affected = [EEM_Base::caps_edit, EEM_Base::caps_delete];
+		foreach ($cap_contexts_affected as $cap_context_affected) {
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
+				new EE_Default_Where_Conditions(
+					[
+						$path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
+							'!=',
+							'espresso_event_categories',
+						],
+					]
+				);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
+				new EE_Default_Where_Conditions(
+					[
+						$path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
+							'!=',
+							'espresso_venue_categories',
+						],
+					]
+				);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']     =
+				new EE_Default_Where_Conditions(
+					[
+						$path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
+					]
+				);
+		}
+		parent::__construct($timezone);
+		add_filter(
+			'FHEE__Read__create_model_query_params',
+			['EEM_Term_Relationship', 'rest_api_query_params'],
+			10,
+			3
+		);
+	}
 
 
-    /**
-     * Makes sure all term-taxonomy counts are correct
-     *
-     * @param int   $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
-     * @return int the number of rows affected
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    public function update_term_taxonomy_counts($term_taxonomy_id = null)
-    {
-        // because this uses a subquery and sometimes assigning to column to be another column's
-        // value, we just write the SQL directly.
-        global $wpdb;
+	/**
+	 * Makes sure all term-taxonomy counts are correct
+	 *
+	 * @param int   $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
+	 * @return int the number of rows affected
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	public function update_term_taxonomy_counts($term_taxonomy_id = null)
+	{
+		// because this uses a subquery and sometimes assigning to column to be another column's
+		// value, we just write the SQL directly.
+		global $wpdb;
 
-        $query = "
+		$query = "
                 UPDATE {$wpdb->term_taxonomy} AS tt 
                 SET count = (
                     select count(*) as proper_count from {$wpdb->term_relationships} AS tr 
                     WHERE tt.term_taxonomy_id = tr.term_taxonomy_id
                 )";
 
-        if ($term_taxonomy_id) {
-            $query .= ' WHERE tt.term_taxonomy_id = %d';
-            $query = $wpdb->prepare(
-                $query,
-                $term_taxonomy_id
-            );
-        }
-        $rows_affected = $this->_do_wpdb_query(
-            'query',
-            [
-                $query,
-            ]
-        );
-        return $rows_affected;
-    }
+		if ($term_taxonomy_id) {
+			$query .= ' WHERE tt.term_taxonomy_id = %d';
+			$query = $wpdb->prepare(
+				$query,
+				$term_taxonomy_id
+			);
+		}
+		$rows_affected = $this->_do_wpdb_query(
+			'query',
+			[
+				$query,
+			]
+		);
+		return $rows_affected;
+	}
 
 
-    /**
-     * Overrides the parent to also make sure term-taxonomy counts are up-to-date after
-     * inserting
-     *
-     * @param array $field_n_values @see EEM_Base::insert
-     * @return boolean
-     */
-    public function insert($field_n_values)
-    {
-        $return = parent::insert($field_n_values);
-        if (isset($field_n_values['term_taxonomy_id'])) {
-            $this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']);
-        }
-        return $return;
-    }
+	/**
+	 * Overrides the parent to also make sure term-taxonomy counts are up-to-date after
+	 * inserting
+	 *
+	 * @param array $field_n_values @see EEM_Base::insert
+	 * @return boolean
+	 */
+	public function insert($field_n_values)
+	{
+		$return = parent::insert($field_n_values);
+		if (isset($field_n_values['term_taxonomy_id'])) {
+			$this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']);
+		}
+		return $return;
+	}
 
 
-    /**
-     * Overrides parent so that after an update, we also check the term_taxonomy_counts are
-     * all ok
-     *
-     * @param array   $fields_n_values         see EEM_Base::update
-     * @param array   $query_params            @see
-     *                                         https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match
-     *                                         $query_params. This obviously has some overhead, so you can disable it
-     *                                         by setting this to FALSE, but be aware that model objects being used
-     *                                         could get out-of-sync with the database
-     * @return int
-     */
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-        if ($count) {
-            $this->update_term_taxonomy_counts();
-        }
-        return $count;
-    }
+	/**
+	 * Overrides parent so that after an update, we also check the term_taxonomy_counts are
+	 * all ok
+	 *
+	 * @param array   $fields_n_values         see EEM_Base::update
+	 * @param array   $query_params            @see
+	 *                                         https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
+	 *                                         by setting this to FALSE, but be aware that model objects being used
+	 *                                         could get out-of-sync with the database
+	 * @return int
+	 */
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+		if ($count) {
+			$this->update_term_taxonomy_counts();
+		}
+		return $count;
+	}
 
 
-    /**
-     * Overrides parent so that after running this, we also double-check
-     * the term taxonomy counts are up-to-date
-     *
-     * @param array   $query_params @see
-     *                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean $allow_blocking
-     * @return int @see EEM_Base::delete
-     */
-    public function delete($query_params, $allow_blocking = true)
-    {
-        $count = parent::delete($query_params, $allow_blocking);
-        if ($count) {
-            $this->update_term_taxonomy_counts();
-        }
-        return $count;
-    }
+	/**
+	 * Overrides parent so that after running this, we also double-check
+	 * the term taxonomy counts are up-to-date
+	 *
+	 * @param array   $query_params @see
+	 *                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean $allow_blocking
+	 * @return int @see EEM_Base::delete
+	 */
+	public function delete($query_params, $allow_blocking = true)
+	{
+		$count = parent::delete($query_params, $allow_blocking);
+		if ($count) {
+			$this->update_term_taxonomy_counts();
+		}
+		return $count;
+	}
 
 
-    /**
-     * Makes sure that during REST API queries, we only return term relationships
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     */
-    public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
-    {
-        if ($model === EEM_Term_Relationship::instance()) {
-            $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
-            }
-        }
-        return $model_query_params;
-    }
+	/**
+	 * Makes sure that during REST API queries, we only return term relationships
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
+	{
+		if ($model === EEM_Term_Relationship::instance()) {
+			$taxonomies = get_taxonomies(['show_in_rest' => true]);
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
+			}
+		}
+		return $model_query_params;
+	}
 }

ui/browser/checkins/entities/CheckinStatusDashicon.php

Indentation +137 added lines, -137 removed lines

@@ -17,141 +17,141 @@
  */
 class CheckinStatusDashicon
 {
-    private int $checkin_status;
-
-
-    /**
-     * CheckinStatusDashicon constructor.
-     *
-     * @param int $checkin_status
-     */
-    public function __construct(int $checkin_status = EE_Checkin::status_checked_never)
-    {
-        $this->checkin_status = $checkin_status;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function checkinStatus(): int
-    {
-        return $this->checkin_status;
-    }
-
-
-    /**
-     * @param EE_Checkin $checkin
-     * @return CheckinStatusDashicon
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function fromCheckin(EE_Checkin $checkin): CheckinStatusDashicon
-    {
-        return new CheckinStatusDashicon(
-            $checkin->status()
-                ? EE_Checkin::status_checked_in
-                : EE_Checkin::status_checked_out
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Datetime     $datetime
-     * @return CheckinStatusDashicon
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function fromRegistrationAndDatetime(
-        EE_Registration $registration,
-        EE_Datetime $datetime
-    ): CheckinStatusDashicon {
-        return new CheckinStatusDashicon(
-            $registration->check_in_status_for_datetime(
-                $datetime->ID()
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param int             $DTT_ID
-     * @return CheckinStatusDashicon
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function fromRegistrationAndDatetimeId(
-        EE_Registration $registration,
-        int $DTT_ID = 0
-    ): CheckinStatusDashicon {
-        return new CheckinStatusDashicon(
-            $registration->check_in_status_for_datetime(
-                absint($DTT_ID)
-            )
-        );
-    }
-
-
-    /**
-     * Will return the correct set of dashicon css classes for the set checkin status
-     *
-     * @return string
-     */
-    public function cssClasses(): string
-    {
-        switch ($this->checkinStatus()) {
-            case EE_Checkin::status_checked_in:
-                return "dashicons dashicons-yes-alt checkin-icons checkedin-status-{$this->checkinStatus()}";
-            case EE_Checkin::status_checked_out:
-                return "dashicons dashicons-marker checkin-icons checkedin-status-{$this->checkinStatus()}";
-            case EE_Checkin::status_checked_never:
-                return "dashicons dashicons-no checkin-icons checkedin-status-{$this->checkinStatus()}";
-            default:
-                return 'dashicons dashicons-warning ee-status--warning';
-        }
-    }
-
-
-    /**
-     * returns a description for the Checkin Status Dashicon that can be used in List Table Legends
-     *
-     * @return string
-     */
-    public function legendLabel(): string
-    {
-        switch ($this->checkinStatus()) {
-            case EE_Checkin::status_checked_in:
-                return esc_html__('This Registrant has been Checked In', 'event_espresso');
-            case EE_Checkin::status_checked_out:
-                return esc_html__('This Registrant has been Checked Out', 'event_espresso');
-            case EE_Checkin::status_checked_never:
-                return esc_html__('No Check-in Record has been Created for this Registrant', 'event_espresso');
-            default:
-                return esc_html__('Can not perform Registrant Check-in.', 'event_espresso');
-        }
-    }
-
-
-    /**
-     * returns a description for the Checkin Status Dashicon that can be used as a button aria label
-     *
-     * @return string
-     */
-    public function ariaLabel(): string
-    {
-        switch ($this->checkinStatus()) {
-            case EE_Checkin::status_checked_in:
-                return esc_html__('click to change status to Checked Out', 'event_espresso');
-            case EE_Checkin::status_checked_out:
-            case EE_Checkin::status_checked_never:
-                return esc_html__('click to change status to Checked In', 'event_espresso');
-            default:
-                return esc_html__(
-                    'Can not perform Registrant Check-in because there are either no event dates currently active for this ticket option (event has not yet started) or there are multiple dates to choose from. Please use the filters above to select a single, currently active event date in order to perform check-ins.',
-                    'event_espresso'
-                );
-        }
-    }
+	private int $checkin_status;
+
+
+	/**
+	 * CheckinStatusDashicon constructor.
+	 *
+	 * @param int $checkin_status
+	 */
+	public function __construct(int $checkin_status = EE_Checkin::status_checked_never)
+	{
+		$this->checkin_status = $checkin_status;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function checkinStatus(): int
+	{
+		return $this->checkin_status;
+	}
+
+
+	/**
+	 * @param EE_Checkin $checkin
+	 * @return CheckinStatusDashicon
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function fromCheckin(EE_Checkin $checkin): CheckinStatusDashicon
+	{
+		return new CheckinStatusDashicon(
+			$checkin->status()
+				? EE_Checkin::status_checked_in
+				: EE_Checkin::status_checked_out
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Datetime     $datetime
+	 * @return CheckinStatusDashicon
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function fromRegistrationAndDatetime(
+		EE_Registration $registration,
+		EE_Datetime $datetime
+	): CheckinStatusDashicon {
+		return new CheckinStatusDashicon(
+			$registration->check_in_status_for_datetime(
+				$datetime->ID()
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param int             $DTT_ID
+	 * @return CheckinStatusDashicon
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function fromRegistrationAndDatetimeId(
+		EE_Registration $registration,
+		int $DTT_ID = 0
+	): CheckinStatusDashicon {
+		return new CheckinStatusDashicon(
+			$registration->check_in_status_for_datetime(
+				absint($DTT_ID)
+			)
+		);
+	}
+
+
+	/**
+	 * Will return the correct set of dashicon css classes for the set checkin status
+	 *
+	 * @return string
+	 */
+	public function cssClasses(): string
+	{
+		switch ($this->checkinStatus()) {
+			case EE_Checkin::status_checked_in:
+				return "dashicons dashicons-yes-alt checkin-icons checkedin-status-{$this->checkinStatus()}";
+			case EE_Checkin::status_checked_out:
+				return "dashicons dashicons-marker checkin-icons checkedin-status-{$this->checkinStatus()}";
+			case EE_Checkin::status_checked_never:
+				return "dashicons dashicons-no checkin-icons checkedin-status-{$this->checkinStatus()}";
+			default:
+				return 'dashicons dashicons-warning ee-status--warning';
+		}
+	}
+
+
+	/**
+	 * returns a description for the Checkin Status Dashicon that can be used in List Table Legends
+	 *
+	 * @return string
+	 */
+	public function legendLabel(): string
+	{
+		switch ($this->checkinStatus()) {
+			case EE_Checkin::status_checked_in:
+				return esc_html__('This Registrant has been Checked In', 'event_espresso');
+			case EE_Checkin::status_checked_out:
+				return esc_html__('This Registrant has been Checked Out', 'event_espresso');
+			case EE_Checkin::status_checked_never:
+				return esc_html__('No Check-in Record has been Created for this Registrant', 'event_espresso');
+			default:
+				return esc_html__('Can not perform Registrant Check-in.', 'event_espresso');
+		}
+	}
+
+
+	/**
+	 * returns a description for the Checkin Status Dashicon that can be used as a button aria label
+	 *
+	 * @return string
+	 */
+	public function ariaLabel(): string
+	{
+		switch ($this->checkinStatus()) {
+			case EE_Checkin::status_checked_in:
+				return esc_html__('click to change status to Checked Out', 'event_espresso');
+			case EE_Checkin::status_checked_out:
+			case EE_Checkin::status_checked_never:
+				return esc_html__('click to change status to Checked In', 'event_espresso');
+			default:
+				return esc_html__(
+					'Can not perform Registrant Check-in because there are either no event dates currently active for this ticket option (event has not yet started) or there are multiple dates to choose from. Please use the filters above to select a single, currently active event date in order to perform check-ins.',
+					'event_espresso'
+				);
+		}
+	}
 }

PaymentMethods/PayPalCommerce/modules/EED_PayPalOnboard.module.php

Indentation +689 added lines, -689 removed lines

@@ -16,693 +16,693 @@
  */
 class EED_PayPalOnboard extends EED_Module
 {
-    /**
-     * @return EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Module
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Run - initial module setup.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-        // TODO: Implement run() method.
-    }
-
-
-    /**
-     * For hooking into EE Core, other modules, etc.
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-    }
-
-
-    /**
-     * For hooking into EE Admin Core, other modules, etc.
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            // Get onboarding URL.
-            add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
-            // Get the seller access token.
-            add_action('wp_ajax_eeaPpGetSellerAccessToken', [__CLASS__, 'getSellerAccessToken']);
-            // Return the connection/onboard status.
-            add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
-            // Revoke access.
-            add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
-        }
-    }
-
-
-    /**
-     * Get the onboarding URL.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function getOnboardingUrl()
-    {
-        $signup_link = '';
-        try {
-            $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
-                PayPalLogger::errorLogAndExit(
-                    esc_html__('No payment method.', 'event_espresso'),
-                    EED_Module::getRequest()->postParams(),
-                    $paypal_pm
-                );
-            }
-            PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
-            $signup_link = self::getSignUpLink($paypal_pm);
-        } catch (Exception $exception) {
-            self::exitWithError($exception->getMessage());
-        }
-        // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
-        echo json_encode(
-            [
-                'signup_link' => $signup_link,
-            ]
-        );
-        exit();
-    }
-
-
-    /**
-     * Get the URL to redirect the seller to and start the onboarding.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function getSignUpLink(EE_Payment_Method $paypal_pm): string
-    {
-        $signup_link   = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
-        $token_expired = self::partnerAccessTokenExpired($paypal_pm);
-        if (! $signup_link || $token_expired) {
-            // Generate sign-up link and save.
-            $signup_link = self::requestOnboardingUrl($paypal_pm);
-            if (! $signup_link) {
-                $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
-                PayPalLogger::errorLog($err_msg, ['signup_link' => $signup_link], $paypal_pm);
-                return '';
-            }
-            PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL, $signup_link);
-        }
-        return $signup_link;
-    }
-
-
-    /**
-     * Request the sign-up link from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm): string
-    {
-        $signup_link = '';
-        // Get the access token.
-        $access_token = self::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
-            $err_msg = esc_html__('Error! No access token.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
-            return $signup_link;
-        }
-        $identifier_string = new OneTimeString($paypal_pm->debug_mode());
-        $seller_nonce      = $identifier_string->value();
-        // Save the identifier for future use.
-        PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_SELLER_NONCE, $seller_nonce);
-        // Request the access token.
-        $body_params = json_encode(
-            [
-                'products'       => ['EXPRESS_CHECKOUT'],
-                'legal_consents' => [
-                    [
-                        'type'    => 'SHARE_DATA_CONSENT',
-                        'granted' => true,
-                    ],
-                ],
-                'operations'     => [
-                    [
-                        'operation'                  => 'API_INTEGRATION',
-                        'api_integration_preference' => [
-                            'rest_api_integration' => [
-                                'integration_method'  => 'PAYPAL',
-                                'integration_type'    => 'FIRST_PARTY',
-                                'first_party_details' => [
-                                    'features'     => ['PAYMENT', 'REFUND', 'PARTNER_FEE'],
-                                    'seller_nonce' => $seller_nonce,
-                                ],
-                            ],
-                        ],
-                    ],
-                ],
-            ]
-        );
-        $bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        $post_args   = [
-            'method'  => 'POST',
-            'headers' => [
-                'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-                'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
-                'PayPal-Partner-Attribution-Id' => $bn_code,
-            ],
-            'body'    => $body_params,
-        ];
-        $request_url = self::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
-        $response    = self::sendRequest($paypal_pm, $request_url, $post_args);
-        if (isset($response['error'])) {
-            return '';
-        }
-        // Check the data we received.
-        if (empty($response['links'])) {
-            $err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
-            return '';
-        }
-        // Now retrieve that sign-up link.
-        foreach ($response['links'] as $link) {
-            if ($link['rel'] === 'action_url') {
-                return $link['href'] ?? '';
-            }
-        }
-        return $signup_link;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        // Do we have it saved ?
-        $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
-        $expired      = self::partnerAccessTokenExpired($paypal_pm);
-        // If we don't have it, request/update it.
-        if (! $access_token || $expired) {
-            return self::requestPartnerAccessToken($paypal_pm);
-        }
-        // Access token is saved as encrypted, so return decrypted.
-        return $access_token;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws Exception
-     */
-    public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
-    {
-        $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
-        if (! $expires_at) {
-            return true;
-        }
-        // Validate the token. Do a health check.
-        $now          = time();
-        $minutes_left = round(($expires_at - $now) / 60);
-        // Count as expired if less than 60 minutes till expiration left.
-        if ($minutes_left <= 60) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Request the partner access token from PayPal and save/update it.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     */
-    public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        $nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
-        // Request the access token.
-        $post_args = [
-            'method' => 'POST',
-            'body'   => [
-                'nonce'                       => $nonce,
-                'api_version'                 => 'v1',
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-        ];
-        if (defined('LOCAL_MIDDLEMAN_SERVER')) {
-            $post_args['sslverify'] = false;
-        }
-        $post_url = self::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
-        $response = self::sendRequest($paypal_pm, $post_url, $post_args);
-        if (isset($response['error'])) {
-            return '';
-        }
-        // Check the data we received.
-        if (! self::partnerTokenResponseValid($response, $paypal_pm)) {
-            return '';
-        }
-        // If we are here all seems to be ok. Save the token and it's data.
-        $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
-            return '';
-        }
-        return $response['access_token'];
-    }
-
-
-    /**
-     * Get the seller access token.
-     * (AJAX)
-     *
-     * @return void
-     * @throws Exception
-     */
-    public static function getSellerAccessToken()
-    {
-        $paypal_pm   = EED_PayPalCommerce::getPaymentMethod();
-        $post_params = EED_Module::getRequest()->postParams();
-        $bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            PayPalLogger::errorLogAndExit(
-                esc_html__('No payment method.', 'event_espresso'),
-                $post_params,
-                $paypal_pm
-            );
-        }
-        $seller_nonce = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_NONCE);
-        // Look for mandatory parameters.
-        if (
-            empty($post_params[ Domain::API_KEY_AUTH_CODE ])
-            || empty($post_params[ Domain::API_KEY_SHARED_ID ])
-            || ! $seller_nonce
-            || ! $bn_code
-        ) {
-            $error_message = esc_html__('Missing authCode and sharedId.', 'event_espresso');
-            PayPalLogger::errorLogAndExit($error_message, $post_params, $paypal_pm);
-        }
-        $nonce = wp_create_nonce('eea_pp_commerce_get_seller_access_token');
-        // Request the access token.
-        $post_args = [
-            'method'  => 'POST',
-            'headers' => [
-                'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-                'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Basic ' . base64_encode($post_params[ Domain::API_KEY_SHARED_ID ]),
-                'PayPal-Partner-Attribution-Id' => $bn_code,
-            ],
-            'body'    => [
-                'nonce'         => $nonce,
-                'grant_type'    => 'authorization_code',
-                'code'          => $post_params[ Domain::API_KEY_AUTH_CODE ],
-                'code_verifier' => $seller_nonce,
-            ],
-        ];
-        $post_url  = self::getPayPalApiUrl($paypal_pm) . '/v1/oauth2/token';
-        $response  = self::sendRequest($paypal_pm, $post_url, $post_args);
-        if (isset($response['error'])) {
-            self::exitWithError($response['message']);
-        }
-        // Check the data we received.
-        if (
-            empty($response['access_token'])
-            || empty($response['expires_in'])
-            || empty($response['refresh_token'])
-        ) {
-            // This is an error.
-            $err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLogAndExit($err_msg, $response, $paypal_pm);
-        }
-        // Now we can request the seller API credentials.
-        $credentials_saved = self::requestApiCredentials($paypal_pm, $response['access_token']);
-        if (isset($credentials_saved['error'])) {
-            echo json_encode(
-                [
-                    'error'   => $credentials_saved['error'],
-                    'message' => $credentials_saved['message'],
-                ]
-            );
-        } else {
-            echo json_encode(
-                [
-                    'success'  => true,
-                    'on_board' => true,
-                ]
-            );
-        }
-        exit();
-    }
-
-
-    /**
-     * Get the seller API credentials.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $seller_token
-     * @return array
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function requestApiCredentials(EE_Payment_Method $paypal_pm, string $seller_token): array
-    {
-        $partner_merchant_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
-        $bn_code             = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        $get_params          = [
-            'method'  => 'GET',
-            'headers' => [
-                'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-                'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $seller_token,
-                'PayPal-Partner-Attribution-Id' => $bn_code,
-            ],
-        ];
-        $request_url = self::getPayPalApiUrl($paypal_pm)
-                        . '/v1/customer/partners/'
-                        . $partner_merchant_id
-                        . '/merchant-integrations/credentials/';
-        $response = self::sendRequest($paypal_pm, $request_url, $get_params);
-        // Check the data we received.
-        if (empty($response['client_id']) || empty($response['client_secret'])) {
-            // This is an error.
-            if (isset($response['message'])) {
-                $err_msg  = $response['message'];
-                $err_name = $response['name'] ?? 'UNRECOGNIZED_ERROR';
-            } else {
-                $err_msg  = esc_html__('Incoming parameter validation failed.', 'event_espresso');
-                $err_name = 'INCOMING_PARAMETER_INVALID';
-            }
-            PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
-            return ['error' => $err_name, 'message' => $err_msg];
-        }
-        // Finally, track seller onboarding status.
-        $onboarding_status = self::trackSellerOnboarding(
-            $paypal_pm,
-            $partner_merchant_id,
-            $response[ Domain::META_KEY_PAYER_ID ],
-            $response[ Domain::META_KEY_CLIENT_ID ],
-            $response[ Domain::META_KEY_CLIENT_SECRET ]
-        );
-        if (isset($onboarding_status['error'])) {
-            return $onboarding_status;
-        }
-        // If onboarded successfully, remove the onetime onboarding URL.
-        if (PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $response)) {
-            PayPalExtraMetaManager::deletePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
-            return ['success' => true];
-        } else {
-            return [
-                'error'   => 'SELLER_CREDENTIALS_NOT_SAVED',
-                'message' => esc_html__('Seller credentials were not saved.', 'event_espresso'),
-            ];
-        }
-    }
-
-
-    /**
-     * Request seller onboarding status from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $partner_id
-     * @param                   $seller_id
-     * @param string            $client_id
-     * @param string            $client_secret
-     * @return array
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function trackSellerOnboarding(
-        EE_Payment_Method $paypal_pm,
-        string $partner_id,
-        $seller_id,
-        string $client_id,
-        string $client_secret
-    ): array {
-        $track_onboarding = self::getTrackOnboardingApi(
-            $paypal_pm,
-            $partner_id,
-            $seller_id,
-            $client_id,
-            $client_secret
-        );
-        return $track_onboarding->isValid();
-    }
-
-
-    /**
-     * Returns the Track Seller Onboarding API.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $partner_id
-     * @param string            $seller_id
-     * @param string            $client_id
-     * @param string            $client_secret
-     * @return TrackSellerOnboarding|null
-     * @throws Exception
-     */
-    public static function getTrackOnboardingApi(
-        EE_Payment_Method $paypal_pm,
-        string $partner_id,
-        string $seller_id,
-        string $client_id,
-        string $client_secret
-    ): ?TrackSellerOnboarding {
-        $paypal_api = self::getPayPalApi($paypal_pm, $client_id, $client_secret);
-        if (! $paypal_api) {
-            return null;
-        }
-        return new TrackSellerOnboarding($paypal_api, $partner_id, $seller_id, $paypal_pm->debug_mode());
-    }
-
-
-    /**
-     * Return a PayPal API object, or false on failure.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $client_id
-     * @param string            $client_secret
-     * @return PayPalApi|null
-     * @throws Exception
-     */
-    public static function getPayPalApi(
-        EE_Payment_Method $paypal_pm,
-        string $client_id,
-        string $client_secret
-    ): ?PayPalApi {
-        $bn_code = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        if (! $client_id || ! $client_secret || ! $bn_code) {
-            return null;
-        }
-        return new PayPalApi($client_id, $client_secret, $bn_code, $paypal_pm->debug_mode());
-    }
-
-
-    /**
-     * Check the onboard status and return the result.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function getOnboardStatus()
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
-            echo json_encode(['on_board' => false]);
-            exit();
-        }
-        try {
-            $seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PAYER_ID) ?? '--';
-        } catch (Exception $e) {
-            $seller_id = '--';
-        }
-        echo json_encode(
-            [
-                'on_board'  => self::isOnboard($paypal_pm),
-                'seller_id' => $seller_id,
-            ]
-        );
-        exit();
-    }
-
-
-    /**
-     * Deauthorize the seller. Remove all API credentials.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function offboard()
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        PayPalExtraMetaManager::deleteAllData($paypal_pm);
-        echo json_encode(
-            [
-                'success' => true,
-            ]
-        );
-        exit();
-    }
-
-
-    /**
-     * Send a request and return a decoded response body.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $request_url
-     * @param array             $request_args
-     * @return array
-     * @throws EE_Error
-     */
-    public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
-    {
-        $error_return = ['error' => true];
-        $response     = wp_remote_request($request_url, $request_args);
-        if (is_wp_error($response)) {
-            $message = $response->get_error_message();
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        $response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
-        if (empty($response_body) || isset($response_body['error'])) {
-            $message = $response_body['error_description']
-                ?? sprintf(
-                    esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
-                    $request_url
-                );
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        return $response_body;
-    }
-
-
-    /**
-     * Check the response for a partner token request.
-     *
-     * @param                   $response
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function partnerTokenResponseValid($response, EE_Payment_Method $paypal_pm): bool
-    {
-        // Check the data we received.
-        if (
-            empty($response['nonce'])
-            || ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
-            || empty($response['access_token'])
-            || empty($response['app_id'])
-            || empty($response['expires_in'])
-            || empty($response['partner_client_id'])
-            || empty($response['partner_merchant_id'])
-        ) {
-            // This is an error.
-            $err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, (array) $response, $paypal_pm);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Returns the base URL to the middleman server.
-     * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     */
-    public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
-    {
-        $target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
-        // If this PM is used under different provider accounts, you might need an account indicator.
-        $account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
-        $postfix = $payment_method->debug_mode() ? '_sandbox' : '';
-        $path    = 'paypal_commerce' . $account . $postfix;
-        return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
-    }
-
-
-    /**
-     * Returns the base PayPal API URL.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     */
-    public static function getPayPalApiUrl(EE_Payment_Method $payment_method): string
-    {
-        return $payment_method->debug_mode() ? 'https://api-m.sandbox.paypal.com' : 'https://api-m.paypal.com';
-    }
-
-
-    /**
-     * Checks if already onboard.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return boolean
-     * @throws EE_Error
-     */
-    public static function isOnboard(EE_Payment_Method $payment_method): bool
-    {
-        $pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
-        if (
-            $pp_meta_data
-            && isset($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-            && $pp_meta_data[ Domain::META_KEY_CLIENT_ID ]
-            && isset($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-            && $pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ]
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Return error message as json allowing to show an alert on the front-end.
-     *
-     * @param string $error_message
-     * @param bool   $show_alert
-     * @return void
-     */
-    public static function exitWithError(string $error_message = '', bool $show_alert = false)
-    {
-        echo json_encode(
-            [
-                'error'   => $error_message,
-                'message' => $error_message,
-                'alert'   => $show_alert,
-            ]
-        );
-        exit();
-    }
+	/**
+	 * @return EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Module
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Run - initial module setup.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+		// TODO: Implement run() method.
+	}
+
+
+	/**
+	 * For hooking into EE Core, other modules, etc.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+
+	/**
+	 * For hooking into EE Admin Core, other modules, etc.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			// Get onboarding URL.
+			add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
+			// Get the seller access token.
+			add_action('wp_ajax_eeaPpGetSellerAccessToken', [__CLASS__, 'getSellerAccessToken']);
+			// Return the connection/onboard status.
+			add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
+			// Revoke access.
+			add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
+		}
+	}
+
+
+	/**
+	 * Get the onboarding URL.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function getOnboardingUrl()
+	{
+		$signup_link = '';
+		try {
+			$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+			if (! $paypal_pm instanceof EE_Payment_Method) {
+				PayPalLogger::errorLogAndExit(
+					esc_html__('No payment method.', 'event_espresso'),
+					EED_Module::getRequest()->postParams(),
+					$paypal_pm
+				);
+			}
+			PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
+			$signup_link = self::getSignUpLink($paypal_pm);
+		} catch (Exception $exception) {
+			self::exitWithError($exception->getMessage());
+		}
+		// Is it empty (can happen if we didn't get the URL through the API).
+		$signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+		echo json_encode(
+			[
+				'signup_link' => $signup_link,
+			]
+		);
+		exit();
+	}
+
+
+	/**
+	 * Get the URL to redirect the seller to and start the onboarding.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function getSignUpLink(EE_Payment_Method $paypal_pm): string
+	{
+		$signup_link   = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
+		$token_expired = self::partnerAccessTokenExpired($paypal_pm);
+		if (! $signup_link || $token_expired) {
+			// Generate sign-up link and save.
+			$signup_link = self::requestOnboardingUrl($paypal_pm);
+			if (! $signup_link) {
+				$err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
+				PayPalLogger::errorLog($err_msg, ['signup_link' => $signup_link], $paypal_pm);
+				return '';
+			}
+			PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL, $signup_link);
+		}
+		return $signup_link;
+	}
+
+
+	/**
+	 * Request the sign-up link from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm): string
+	{
+		$signup_link = '';
+		// Get the access token.
+		$access_token = self::getPartnerAccessToken($paypal_pm);
+		if (! $access_token) {
+			$err_msg = esc_html__('Error! No access token.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
+			return $signup_link;
+		}
+		$identifier_string = new OneTimeString($paypal_pm->debug_mode());
+		$seller_nonce      = $identifier_string->value();
+		// Save the identifier for future use.
+		PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_SELLER_NONCE, $seller_nonce);
+		// Request the access token.
+		$body_params = json_encode(
+			[
+				'products'       => ['EXPRESS_CHECKOUT'],
+				'legal_consents' => [
+					[
+						'type'    => 'SHARE_DATA_CONSENT',
+						'granted' => true,
+					],
+				],
+				'operations'     => [
+					[
+						'operation'                  => 'API_INTEGRATION',
+						'api_integration_preference' => [
+							'rest_api_integration' => [
+								'integration_method'  => 'PAYPAL',
+								'integration_type'    => 'FIRST_PARTY',
+								'first_party_details' => [
+									'features'     => ['PAYMENT', 'REFUND', 'PARTNER_FEE'],
+									'seller_nonce' => $seller_nonce,
+								],
+							],
+						],
+					],
+				],
+			]
+		);
+		$bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		$post_args   = [
+			'method'  => 'POST',
+			'headers' => [
+				'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+				'Content-Type'                  => 'application/json',
+				'Authorization'                 => 'Bearer ' . $access_token,
+				'PayPal-Partner-Attribution-Id' => $bn_code,
+			],
+			'body'    => $body_params,
+		];
+		$request_url = self::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+		$response    = self::sendRequest($paypal_pm, $request_url, $post_args);
+		if (isset($response['error'])) {
+			return '';
+		}
+		// Check the data we received.
+		if (empty($response['links'])) {
+			$err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
+			return '';
+		}
+		// Now retrieve that sign-up link.
+		foreach ($response['links'] as $link) {
+			if ($link['rel'] === 'action_url') {
+				return $link['href'] ?? '';
+			}
+		}
+		return $signup_link;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		// Do we have it saved ?
+		$access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
+		$expired      = self::partnerAccessTokenExpired($paypal_pm);
+		// If we don't have it, request/update it.
+		if (! $access_token || $expired) {
+			return self::requestPartnerAccessToken($paypal_pm);
+		}
+		// Access token is saved as encrypted, so return decrypted.
+		return $access_token;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws Exception
+	 */
+	public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
+	{
+		$expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
+		if (! $expires_at) {
+			return true;
+		}
+		// Validate the token. Do a health check.
+		$now          = time();
+		$minutes_left = round(($expires_at - $now) / 60);
+		// Count as expired if less than 60 minutes till expiration left.
+		if ($minutes_left <= 60) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Request the partner access token from PayPal and save/update it.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		$nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
+		// Request the access token.
+		$post_args = [
+			'method' => 'POST',
+			'body'   => [
+				'nonce'                       => $nonce,
+				'api_version'                 => 'v1',
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+		];
+		if (defined('LOCAL_MIDDLEMAN_SERVER')) {
+			$post_args['sslverify'] = false;
+		}
+		$post_url = self::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+		$response = self::sendRequest($paypal_pm, $post_url, $post_args);
+		if (isset($response['error'])) {
+			return '';
+		}
+		// Check the data we received.
+		if (! self::partnerTokenResponseValid($response, $paypal_pm)) {
+			return '';
+		}
+		// If we are here all seems to be ok. Save the token and it's data.
+		$saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
+		if (! $saved) {
+			return '';
+		}
+		return $response['access_token'];
+	}
+
+
+	/**
+	 * Get the seller access token.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public static function getSellerAccessToken()
+	{
+		$paypal_pm   = EED_PayPalCommerce::getPaymentMethod();
+		$post_params = EED_Module::getRequest()->postParams();
+		$bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			PayPalLogger::errorLogAndExit(
+				esc_html__('No payment method.', 'event_espresso'),
+				$post_params,
+				$paypal_pm
+			);
+		}
+		$seller_nonce = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_NONCE);
+		// Look for mandatory parameters.
+		if (
+			empty($post_params[ Domain::API_KEY_AUTH_CODE ])
+			|| empty($post_params[ Domain::API_KEY_SHARED_ID ])
+			|| ! $seller_nonce
+			|| ! $bn_code
+		) {
+			$error_message = esc_html__('Missing authCode and sharedId.', 'event_espresso');
+			PayPalLogger::errorLogAndExit($error_message, $post_params, $paypal_pm);
+		}
+		$nonce = wp_create_nonce('eea_pp_commerce_get_seller_access_token');
+		// Request the access token.
+		$post_args = [
+			'method'  => 'POST',
+			'headers' => [
+				'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+				'Content-Type'                  => 'application/json',
+				'Authorization'                 => 'Basic ' . base64_encode($post_params[ Domain::API_KEY_SHARED_ID ]),
+				'PayPal-Partner-Attribution-Id' => $bn_code,
+			],
+			'body'    => [
+				'nonce'         => $nonce,
+				'grant_type'    => 'authorization_code',
+				'code'          => $post_params[ Domain::API_KEY_AUTH_CODE ],
+				'code_verifier' => $seller_nonce,
+			],
+		];
+		$post_url  = self::getPayPalApiUrl($paypal_pm) . '/v1/oauth2/token';
+		$response  = self::sendRequest($paypal_pm, $post_url, $post_args);
+		if (isset($response['error'])) {
+			self::exitWithError($response['message']);
+		}
+		// Check the data we received.
+		if (
+			empty($response['access_token'])
+			|| empty($response['expires_in'])
+			|| empty($response['refresh_token'])
+		) {
+			// This is an error.
+			$err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLogAndExit($err_msg, $response, $paypal_pm);
+		}
+		// Now we can request the seller API credentials.
+		$credentials_saved = self::requestApiCredentials($paypal_pm, $response['access_token']);
+		if (isset($credentials_saved['error'])) {
+			echo json_encode(
+				[
+					'error'   => $credentials_saved['error'],
+					'message' => $credentials_saved['message'],
+				]
+			);
+		} else {
+			echo json_encode(
+				[
+					'success'  => true,
+					'on_board' => true,
+				]
+			);
+		}
+		exit();
+	}
+
+
+	/**
+	 * Get the seller API credentials.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $seller_token
+	 * @return array
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function requestApiCredentials(EE_Payment_Method $paypal_pm, string $seller_token): array
+	{
+		$partner_merchant_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
+		$bn_code             = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		$get_params          = [
+			'method'  => 'GET',
+			'headers' => [
+				'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+				'Content-Type'                  => 'application/json',
+				'Authorization'                 => 'Bearer ' . $seller_token,
+				'PayPal-Partner-Attribution-Id' => $bn_code,
+			],
+		];
+		$request_url = self::getPayPalApiUrl($paypal_pm)
+						. '/v1/customer/partners/'
+						. $partner_merchant_id
+						. '/merchant-integrations/credentials/';
+		$response = self::sendRequest($paypal_pm, $request_url, $get_params);
+		// Check the data we received.
+		if (empty($response['client_id']) || empty($response['client_secret'])) {
+			// This is an error.
+			if (isset($response['message'])) {
+				$err_msg  = $response['message'];
+				$err_name = $response['name'] ?? 'UNRECOGNIZED_ERROR';
+			} else {
+				$err_msg  = esc_html__('Incoming parameter validation failed.', 'event_espresso');
+				$err_name = 'INCOMING_PARAMETER_INVALID';
+			}
+			PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
+			return ['error' => $err_name, 'message' => $err_msg];
+		}
+		// Finally, track seller onboarding status.
+		$onboarding_status = self::trackSellerOnboarding(
+			$paypal_pm,
+			$partner_merchant_id,
+			$response[ Domain::META_KEY_PAYER_ID ],
+			$response[ Domain::META_KEY_CLIENT_ID ],
+			$response[ Domain::META_KEY_CLIENT_SECRET ]
+		);
+		if (isset($onboarding_status['error'])) {
+			return $onboarding_status;
+		}
+		// If onboarded successfully, remove the onetime onboarding URL.
+		if (PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $response)) {
+			PayPalExtraMetaManager::deletePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
+			return ['success' => true];
+		} else {
+			return [
+				'error'   => 'SELLER_CREDENTIALS_NOT_SAVED',
+				'message' => esc_html__('Seller credentials were not saved.', 'event_espresso'),
+			];
+		}
+	}
+
+
+	/**
+	 * Request seller onboarding status from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $partner_id
+	 * @param                   $seller_id
+	 * @param string            $client_id
+	 * @param string            $client_secret
+	 * @return array
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function trackSellerOnboarding(
+		EE_Payment_Method $paypal_pm,
+		string $partner_id,
+		$seller_id,
+		string $client_id,
+		string $client_secret
+	): array {
+		$track_onboarding = self::getTrackOnboardingApi(
+			$paypal_pm,
+			$partner_id,
+			$seller_id,
+			$client_id,
+			$client_secret
+		);
+		return $track_onboarding->isValid();
+	}
+
+
+	/**
+	 * Returns the Track Seller Onboarding API.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $partner_id
+	 * @param string            $seller_id
+	 * @param string            $client_id
+	 * @param string            $client_secret
+	 * @return TrackSellerOnboarding|null
+	 * @throws Exception
+	 */
+	public static function getTrackOnboardingApi(
+		EE_Payment_Method $paypal_pm,
+		string $partner_id,
+		string $seller_id,
+		string $client_id,
+		string $client_secret
+	): ?TrackSellerOnboarding {
+		$paypal_api = self::getPayPalApi($paypal_pm, $client_id, $client_secret);
+		if (! $paypal_api) {
+			return null;
+		}
+		return new TrackSellerOnboarding($paypal_api, $partner_id, $seller_id, $paypal_pm->debug_mode());
+	}
+
+
+	/**
+	 * Return a PayPal API object, or false on failure.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $client_id
+	 * @param string            $client_secret
+	 * @return PayPalApi|null
+	 * @throws Exception
+	 */
+	public static function getPayPalApi(
+		EE_Payment_Method $paypal_pm,
+		string $client_id,
+		string $client_secret
+	): ?PayPalApi {
+		$bn_code = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		if (! $client_id || ! $client_secret || ! $bn_code) {
+			return null;
+		}
+		return new PayPalApi($client_id, $client_secret, $bn_code, $paypal_pm->debug_mode());
+	}
+
+
+	/**
+	 * Check the onboard status and return the result.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function getOnboardStatus()
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			$err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
+			echo json_encode(['on_board' => false]);
+			exit();
+		}
+		try {
+			$seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PAYER_ID) ?? '--';
+		} catch (Exception $e) {
+			$seller_id = '--';
+		}
+		echo json_encode(
+			[
+				'on_board'  => self::isOnboard($paypal_pm),
+				'seller_id' => $seller_id,
+			]
+		);
+		exit();
+	}
+
+
+	/**
+	 * Deauthorize the seller. Remove all API credentials.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function offboard()
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		PayPalExtraMetaManager::deleteAllData($paypal_pm);
+		echo json_encode(
+			[
+				'success' => true,
+			]
+		);
+		exit();
+	}
+
+
+	/**
+	 * Send a request and return a decoded response body.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $request_url
+	 * @param array             $request_args
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
+	{
+		$error_return = ['error' => true];
+		$response     = wp_remote_request($request_url, $request_args);
+		if (is_wp_error($response)) {
+			$message = $response->get_error_message();
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		$response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
+		if (empty($response_body) || isset($response_body['error'])) {
+			$message = $response_body['error_description']
+				?? sprintf(
+					esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
+					$request_url
+				);
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		return $response_body;
+	}
+
+
+	/**
+	 * Check the response for a partner token request.
+	 *
+	 * @param                   $response
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function partnerTokenResponseValid($response, EE_Payment_Method $paypal_pm): bool
+	{
+		// Check the data we received.
+		if (
+			empty($response['nonce'])
+			|| ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
+			|| empty($response['access_token'])
+			|| empty($response['app_id'])
+			|| empty($response['expires_in'])
+			|| empty($response['partner_client_id'])
+			|| empty($response['partner_merchant_id'])
+		) {
+			// This is an error.
+			$err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, (array) $response, $paypal_pm);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Returns the base URL to the middleman server.
+	 * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 */
+	public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
+	{
+		$target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
+		// If this PM is used under different provider accounts, you might need an account indicator.
+		$account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
+		$postfix = $payment_method->debug_mode() ? '_sandbox' : '';
+		$path    = 'paypal_commerce' . $account . $postfix;
+		return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
+	}
+
+
+	/**
+	 * Returns the base PayPal API URL.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 */
+	public static function getPayPalApiUrl(EE_Payment_Method $payment_method): string
+	{
+		return $payment_method->debug_mode() ? 'https://api-m.sandbox.paypal.com' : 'https://api-m.paypal.com';
+	}
+
+
+	/**
+	 * Checks if already onboard.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public static function isOnboard(EE_Payment_Method $payment_method): bool
+	{
+		$pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
+		if (
+			$pp_meta_data
+			&& isset($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
+			&& $pp_meta_data[ Domain::META_KEY_CLIENT_ID ]
+			&& isset($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
+			&& $pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ]
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Return error message as json allowing to show an alert on the front-end.
+	 *
+	 * @param string $error_message
+	 * @param bool   $show_alert
+	 * @return void
+	 */
+	public static function exitWithError(string $error_message = '', bool $show_alert = false)
+	{
+		echo json_encode(
+			[
+				'error'   => $error_message,
+				'message' => $error_message,
+				'alert'   => $show_alert,
+			]
+		);
+		exit();
+	}
 }

PaymentMethods/PayPalCommerce/api/orders/CreateOrder.php

Indentation +243 added lines, -243 removed lines

@@ -23,269 +23,269 @@
  */
 class CreateOrder extends OrdersApi
 {
-    /**
-     * Line items total.
-     *
-     * @var float
-     */
-    protected $items_total = 0;
+	/**
+	 * Line items total.
+	 *
+	 * @var float
+	 */
+	protected $items_total = 0;
 
-    /**
-     * Promotions total.
-     *
-     * @var float
-     */
-    protected $promos_total = 0;
+	/**
+	 * Promotions total.
+	 *
+	 * @var float
+	 */
+	protected $promos_total = 0;
 
-    /**
-     * Tax total.
-     *
-     * @var float
-     */
-    protected $tax_total = 0;
+	/**
+	 * Tax total.
+	 *
+	 * @var float
+	 */
+	protected $tax_total = 0;
 
-    /**
-     * Currency.
-     *
-     * @var string
-     */
-    protected $currency_code;
+	/**
+	 * Currency.
+	 *
+	 * @var string
+	 */
+	protected $currency_code;
 
-    /**
-     * Billing info.
-     *
-     * @var array
-     */
-    protected $billing_info;
+	/**
+	 * Billing info.
+	 *
+	 * @var array
+	 */
+	protected $billing_info;
 
-    /**
-     * Transaction this order is for.
-     *
-     * @var EE_Transaction
-     */
-    protected $transaction;
+	/**
+	 * Transaction this order is for.
+	 *
+	 * @var EE_Transaction
+	 */
+	protected $transaction;
 
 
-    /**
-     * CreateOrder constructor.
-     *
-     * @param PayPalApi      $api
-     * @param EE_Transaction $transaction
-     * @param array          $billing_info
-     */
-    public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info)
-    {
-        parent::__construct($api);
-        $this->transaction   = $transaction;
-        $this->currency_code = CurrencyManager::currencyCode();
-        $this->sanitizeRequestParameters($billing_info);
-    }
+	/**
+	 * CreateOrder constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param EE_Transaction $transaction
+	 * @param array          $billing_info
+	 */
+	public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info)
+	{
+		parent::__construct($api);
+		$this->transaction   = $transaction;
+		$this->currency_code = CurrencyManager::currencyCode();
+		$this->sanitizeRequestParameters($billing_info);
+	}
 
 
-    /**
-     * Sanitize the array of billing form data.
-     *
-     * @param array $billing_info
-     * @return void
-     */
-    public function sanitizeRequestParameters(array $billing_info)
-    {
-        $sanitizer = new RequestSanitizer(new Basic());
-        foreach ($billing_info as $item => $value) {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
-        }
-    }
+	/**
+	 * Sanitize the array of billing form data.
+	 *
+	 * @param array $billing_info
+	 * @return void
+	 */
+	public function sanitizeRequestParameters(array $billing_info)
+	{
+		$sanitizer = new RequestSanitizer(new Basic());
+		foreach ($billing_info as $item => $value) {
+			$this->billing_info[ $item ] = $sanitizer->clean($value);
+		}
+	}
 
 
-    /**
-     * Create PayPal Order.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create(): array
-    {
-        $order_parameters = $this->getParameters();
-        // Create Order request.
-        $create_response = $this->api->sendRequest($order_parameters, $this->request_url);
-        return $this->validateOrder($create_response, $order_parameters);
-    }
+	/**
+	 * Create PayPal Order.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create(): array
+	{
+		$order_parameters = $this->getParameters();
+		// Create Order request.
+		$create_response = $this->api->sendRequest($order_parameters, $this->request_url);
+		return $this->validateOrder($create_response, $order_parameters);
+	}
 
 
-    /**
-     * Form order parameters.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function getParameters(): array
-    {
-        $registrant  = $this->transaction->primary_registration();
-        $event       = $registrant->event();
-        $description = $event->name() ?? esc_html__('Tickets for an event', 'event_espresso');
-        $state       = EEM_State::instance()->get_col(
-            [
-                ['STA_ID' => $this->billing_info['bill_state']],
-                'limit' => 1,
-            ],
-            'STA_abbrev'
-        )[0];
-        $params      = [
-            'intent'              => 'CAPTURE',
-            'purchase_units'      => [
-                [
-                    'custom_id'   => $this->transaction->ID(),
-                    'description' => substr(wp_strip_all_tags($description), 0, 125),
-                    'items'       => $this->getLineItems(),
-                    'amount'      => [
-                        'value'         => $this->transaction->total(),
-                        'currency_code' => $this->currency_code,
-                        'breakdown'     => $this->getBreakdown(),
-                    ],
-                ],
-            ],
-            'application_context' => [
-                'shipping_preference' => 'NO_SHIPPING',
-                'user_action'         => 'PAY_NOW',
-            ],
-            'payer'               => [
-                'email_address' => $this->billing_info['bill_email'],
-                'name'          => [
-                    'given_name' => substr($this->billing_info['bill_first_name'], 0, 139),
-                    'surname'    => substr($this->billing_info['bill_last_name'], 0, 139),
+	/**
+	 * Form order parameters.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function getParameters(): array
+	{
+		$registrant  = $this->transaction->primary_registration();
+		$event       = $registrant->event();
+		$description = $event->name() ?? esc_html__('Tickets for an event', 'event_espresso');
+		$state       = EEM_State::instance()->get_col(
+			[
+				['STA_ID' => $this->billing_info['bill_state']],
+				'limit' => 1,
+			],
+			'STA_abbrev'
+		)[0];
+		$params      = [
+			'intent'              => 'CAPTURE',
+			'purchase_units'      => [
+				[
+					'custom_id'   => $this->transaction->ID(),
+					'description' => substr(wp_strip_all_tags($description), 0, 125),
+					'items'       => $this->getLineItems(),
+					'amount'      => [
+						'value'         => $this->transaction->total(),
+						'currency_code' => $this->currency_code,
+						'breakdown'     => $this->getBreakdown(),
+					],
+				],
+			],
+			'application_context' => [
+				'shipping_preference' => 'NO_SHIPPING',
+				'user_action'         => 'PAY_NOW',
+			],
+			'payer'               => [
+				'email_address' => $this->billing_info['bill_email'],
+				'name'          => [
+					'given_name' => substr($this->billing_info['bill_first_name'], 0, 139),
+					'surname'    => substr($this->billing_info['bill_last_name'], 0, 139),
 
-                ],
-                'address'       => [
-                    'country_code'   => $this->billing_info['bill_country'],
-                    'address_line_1' => substr($this->billing_info['bill_address'], 0, 299),
-                    'admin_area_1'   => $state ?? '',
-                    'admin_area_2'   => substr($this->billing_info['bill_city'], 0, 119),
-                    'postal_code'    => substr($this->billing_info['bill_zip'], 0, 59),
-                ],
-            ],
-        ];
-        if (isset($this->billing_info['bill_address_2']) && $this->billing_info['bill_address_2']) {
-            $params['payer']['address']['address_line_2'] = substr($this->billing_info['bill_address_2'], 0, 299);
-        }
-        if (isset($this->billing_info['bill_phone']) && $this->billing_info['bill_phone']) {
-            $params['payer']['phone_number'] = $this->billing_info['bill_phone'];
-        }
-        return $params;
-    }
+				],
+				'address'       => [
+					'country_code'   => $this->billing_info['bill_country'],
+					'address_line_1' => substr($this->billing_info['bill_address'], 0, 299),
+					'admin_area_1'   => $state ?? '',
+					'admin_area_2'   => substr($this->billing_info['bill_city'], 0, 119),
+					'postal_code'    => substr($this->billing_info['bill_zip'], 0, 59),
+				],
+			],
+		];
+		if (isset($this->billing_info['bill_address_2']) && $this->billing_info['bill_address_2']) {
+			$params['payer']['address']['address_line_2'] = substr($this->billing_info['bill_address_2'], 0, 299);
+		}
+		if (isset($this->billing_info['bill_phone']) && $this->billing_info['bill_phone']) {
+			$params['payer']['phone_number'] = $this->billing_info['bill_phone'];
+		}
+		return $params;
+	}
 
 
-    /**
-     * Itemize the payment. List all the line items, discounts and taxes.
-     *
-     * @return array
-     * @throws EE_Error|ReflectionException
-     */
-    protected function getLineItems(): array
-    {
-        // Order line items.
-        $line_items       = [];
-        $event_line_items = $this->transaction->items_purchased();
-        // List actual line items.
-        foreach ($event_line_items as $line_item) {
-            if ($line_item instanceof EE_Line_Item && $line_item->OBJ_type() !== 'Promotion') {
-                $item_money     = $line_item->unit_price();
-                $li_description = $line_item->desc() ?? esc_html__('Event Ticket', 'event_espresso');
-                $line_items []  = [
-                    'name'        => substr(wp_strip_all_tags($line_item->name()), 0, 126),
-                    'quantity'    => $line_item->quantity(),
-                    'description' => substr(wp_strip_all_tags($li_description), 0, 125),
-                    'unit_amount' => [
-                        'currency_code' => $this->currency_code,
-                        'value'         => $item_money,
-                    ],
-                    'category'    => 'DIGITAL_GOODS',
-                ];
-                // Line item total.
-                $this->items_total += $line_item->pretaxTotal();
-            } elseif ($line_item->OBJ_type() === 'Promotion') {
-                // Promotions total.
-                $this->promos_total += $line_item->total();
-            }
-        }
-        // Make sure we have an absolute number with only two decimal laces.
-        $this->items_total  = CurrencyManager::normalizeValue($this->items_total);
-        $this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
-        $this->countTaxTotal();
-        return $line_items;
-    }
+	/**
+	 * Itemize the payment. List all the line items, discounts and taxes.
+	 *
+	 * @return array
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function getLineItems(): array
+	{
+		// Order line items.
+		$line_items       = [];
+		$event_line_items = $this->transaction->items_purchased();
+		// List actual line items.
+		foreach ($event_line_items as $line_item) {
+			if ($line_item instanceof EE_Line_Item && $line_item->OBJ_type() !== 'Promotion') {
+				$item_money     = $line_item->unit_price();
+				$li_description = $line_item->desc() ?? esc_html__('Event Ticket', 'event_espresso');
+				$line_items []  = [
+					'name'        => substr(wp_strip_all_tags($line_item->name()), 0, 126),
+					'quantity'    => $line_item->quantity(),
+					'description' => substr(wp_strip_all_tags($li_description), 0, 125),
+					'unit_amount' => [
+						'currency_code' => $this->currency_code,
+						'value'         => $item_money,
+					],
+					'category'    => 'DIGITAL_GOODS',
+				];
+				// Line item total.
+				$this->items_total += $line_item->pretaxTotal();
+			} elseif ($line_item->OBJ_type() === 'Promotion') {
+				// Promotions total.
+				$this->promos_total += $line_item->total();
+			}
+		}
+		// Make sure we have an absolute number with only two decimal laces.
+		$this->items_total  = CurrencyManager::normalizeValue($this->items_total);
+		$this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
+		$this->countTaxTotal();
+		return $line_items;
+	}
 
 
-    /**
-     * Count the tax total.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    protected function countTaxTotal()
-    {
-        // List taxes.
-        $this->tax_total = 0;
-        $tax_items       = $this->transaction->tax_items();
-        foreach ($tax_items as $tax_item) {
-            $this->tax_total += $tax_item->total();
-        }
-        $this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
-    }
+	/**
+	 * Count the tax total.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function countTaxTotal()
+	{
+		// List taxes.
+		$this->tax_total = 0;
+		$tax_items       = $this->transaction->tax_items();
+		foreach ($tax_items as $tax_item) {
+			$this->tax_total += $tax_item->total();
+		}
+		$this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
+	}
 
 
-    /**
-     * Itemize the payment the breakdown list.
-     *
-     * @return array
-     */
-    protected function getBreakdown(): array
-    {
-        $breakdown['item_total'] = [
-            'currency_code' => $this->currency_code,
-            'value'         => $this->items_total,
-        ];
-        $breakdown['tax_total']  = [
-            'currency_code' => $this->currency_code,
-            'value'         => $this->tax_total,
-        ];
-        $breakdown['discount']   = [
-            'currency_code' => $this->currency_code,
-            'value'         => abs($this->promos_total),
-        ];
-        return $breakdown;
-    }
+	/**
+	 * Itemize the payment the breakdown list.
+	 *
+	 * @return array
+	 */
+	protected function getBreakdown(): array
+	{
+		$breakdown['item_total'] = [
+			'currency_code' => $this->currency_code,
+			'value'         => $this->items_total,
+		];
+		$breakdown['tax_total']  = [
+			'currency_code' => $this->currency_code,
+			'value'         => $this->tax_total,
+		];
+		$breakdown['discount']   = [
+			'currency_code' => $this->currency_code,
+			'value'         => abs($this->promos_total),
+		];
+		return $breakdown;
+	}
 
 
-    /**
-     * Makes sure that we have received an Order back from the API call.
-     *
-     * @param $response
-     * @param $parameters
-     * @return array
-     */
-    public function validateOrder($response, $parameters): array
-    {
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        if (! isset($response['id'])) {
-            $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
-            try {
-                PayPalLogger::errorLog(
-                    $message,
-                    [$this->request_url, $parameters, $response],
-                    $this->transaction->payment_method()
-                );
-            } catch (EE_Error|ReflectionException $e) {
-                // Just continue.
-            }
-            return [
-                'error'   => $response['error'] ?? 'missing_order',
-                'message' => $response['message'] ?? $message,
-            ];
-        }
-        return $response;
-    }
+	/**
+	 * Makes sure that we have received an Order back from the API call.
+	 *
+	 * @param $response
+	 * @param $parameters
+	 * @return array
+	 */
+	public function validateOrder($response, $parameters): array
+	{
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		if (! isset($response['id'])) {
+			$message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
+			try {
+				PayPalLogger::errorLog(
+					$message,
+					[$this->request_url, $parameters, $response],
+					$this->transaction->payment_method()
+				);
+			} catch (EE_Error|ReflectionException $e) {
+				// Just continue.
+			}
+			return [
+				'error'   => $response['error'] ?? 'missing_order',
+				'message' => $response['message'] ?? $message,
+			];
+		}
+		return $response;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -92,7 +92,7 @@ 
     {
         $sanitizer = new RequestSanitizer(new Basic());
         foreach ($billing_info as $item => $value) {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
+            $this->billing_info[$item] = $sanitizer->clean($value);
         }
     }
 
@@ -132,7 +132,7 @@ 
             ],
             'STA_abbrev'
         )[0];
-        $params      = [
+        $params = [
             'intent'              => 'CAPTURE',
             'purchase_units'      => [
                 [
@@ -246,11 +246,11 @@ 
             'currency_code' => $this->currency_code,
             'value'         => $this->items_total,
         ];
-        $breakdown['tax_total']  = [
+        $breakdown['tax_total'] = [
             'currency_code' => $this->currency_code,
             'value'         => $this->tax_total,
         ];
-        $breakdown['discount']   = [
+        $breakdown['discount'] = [
             'currency_code' => $this->currency_code,
             'value'         => abs($this->promos_total),
         ];
@@ -267,10 +267,10 @@ 
      */
     public function validateOrder($response, $parameters): array
     {
-        if (! empty($response['error'])) {
+        if ( ! empty($response['error'])) {
             return $response;
         }
-        if (! isset($response['id'])) {
+        if ( ! isset($response['id'])) {
             $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
             try {
                 PayPalLogger::errorLog(
@@ -278,7 +278,7 @@ 
                     [$this->request_url, $parameters, $response],
                     $this->transaction->payment_method()
                 );
-            } catch (EE_Error|ReflectionException $e) {
+            } catch (EE_Error | ReflectionException $e) {
                 // Just continue.
             }
             return [

modules/ticket_selector/DisplayTicketSelector.php

Indentation +866 added lines, -866 removed lines

@@ -40,873 +40,873 @@
  */
 class DisplayTicketSelector
 {
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-    /**
-     * @var EE_Ticket_Selector_Config
-     */
-    protected $config;
-
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected $iframe = false;
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @var int $max_attendees
-     */
-    private $max_attendees = EE_INF;
-
-    /**
-     * @var string $date_format
-     */
-    private $date_format;
-
-    /**
-     * @var string $time_format
-     */
-    private $time_format;
-
-    /**
-     * @var boolean $display_full_ui
-     */
-    private $display_full_ui;
-
-    /**
-     * @var CurrentUser
-     */
-    private $current_user;
-
-
-    /**
-     * DisplayTicketSelector constructor.
-     *
-     * @param CurrentUser $current_user
-     * @param RequestInterface          $request
-     * @param EE_Ticket_Selector_Config $config
-     * @param bool                      $iframe
-     */
-    public function __construct(
-        CurrentUser $current_user,
-        RequestInterface $request,
-        EE_Ticket_Selector_Config $config,
-        bool $iframe = false
-    ) {
-        $this->current_user = $current_user;
-        $this->request     = $request;
-        $this->config      = $config;
-        $this->setIframe($iframe);
-        $this->date_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format')
-        );
-        $this->time_format  = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format')
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe(): bool
-    {
-        return $this->iframe;
-    }
-
-
-    /**
-     * @param boolean $iframe
-     */
-    public function setIframe(bool $iframe = true)
-    {
-        $this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * finds and sets the \EE_Event object for use throughout class
-     *
-     * @param mixed $event
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function setEvent($event = null): bool
-    {
-        if ($event === null) {
-            global $post;
-            $event = $post;
-        }
-        if ($event instanceof EE_Event) {
-            $this->event = $event;
-        } elseif ($event instanceof WP_Post) {
-            if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
-                $this->event = $event->EE_Event;
-            } elseif ($event->post_type === 'espresso_events') {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
-                $this->event     = $event->EE_Event;
-            }
-        } else {
-            $user_msg = esc_html__('No Event object or an invalid Event object was supplied.', 'event_espresso');
-            $dev_msg  = $user_msg . esc_html__(
-                'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                'event_espresso'
-            );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getMaxAttendees(): int
-    {
-        return $this->max_attendees;
-    }
-
-
-    /**
-     * @param int $max_attendees
-     */
-    public function setMaxAttendees(int $max_attendees)
-    {
-        $this->max_attendees = absint(
-            apply_filters(
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-                $max_attendees
-            )
-        );
-    }
-
-
-    /**
-     * Returns whether or not the full ticket selector should be shown or not.
-     * Currently, it displays on the frontend (including ajax requests) but not the backend
-     *
-     * @return bool
-     */
-    private function display_full_ui(): bool
-    {
-        if ($this->display_full_ui === null) {
-            $this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
-        }
-        return $this->display_full_ui;
-    }
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param WP_Post|int $event
-     * @param bool        $view_details
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function display($event = null, bool $view_details = false)
-    {
-        // reset filter for displaying submit button
-        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        // poke and prod incoming event till it tells us what it is
-        if (! $this->setEvent($event)) {
-            return $this->handleMissingEvent();
-        }
-        // is the event expired ?
-        $template_args['event_is_expired'] = ! is_admin() && $this->event->is_expired();
-        if ($template_args['event_is_expired']) {
-            return is_single()
-                ? $this->expiredEventMessage()
-                : $this->expiredEventMessage() . $this->displayViewDetailsButton();
-        }
-        // begin gathering template arguments by getting event status
-        $template_args = ['event_status' => $this->event->get_active_status()];
-        if (
-            $this->activeEventAndShowTicketSelector(
-                $event,
-                $template_args['event_status'],
-                $view_details
-            )
-        ) {
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        $this->setMaxAttendees($this->event->additional_limit());
-        if ($this->getMaxAttendees() < 1) {
-            return $this->ticketSalesClosedMessage();
-        }
-        // get all tickets for this event ordered by the datetime
-        $tickets = $this->getTickets();
-        if (count($tickets) < 1) {
-            return $this->noTicketAvailableMessage();
-        }
-        // redirecting to another site for registration ??
-        $external_url = (string) $this->event->external_url()
-                        && $this->event->external_url() !== get_the_permalink()
-            ? $this->event->external_url()
-            : '';
-        // if redirecting to another site for registration, then we don't load the TS
-        $ticket_selector = $external_url
-            ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets, $template_args);
-        // now set up the form (but not for the admin)
-        $ticket_selector = $this->display_full_ui()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
-        return $ticket_selector;
-    }
-
-
-    /**
-     * displayTicketSelector
-     * examines the event properties and determines whether a Ticket Selector should be displayed
-     *
-     * @param WP_Post|int $event
-     * @param string      $_event_active_status
-     * @param bool        $view_details
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function activeEventAndShowTicketSelector($event, string $_event_active_status, bool $view_details): bool
-    {
-        $event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
-        return $this->display_full_ui()
-               && (
-                   ! $this->event->display_ticket_selector()
-                   || $view_details
-                   || post_password_required($event_post)
-                   || (
-                       $_event_active_status !== EE_Datetime::active
-                       && $_event_active_status !== EE_Datetime::upcoming
-                       && $_event_active_status !== EE_Datetime::sold_out
-                       && ! (
-                           $_event_active_status === EE_Datetime::inactive
-                           && is_user_logged_in()
-                       )
-                   )
-               );
-    }
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event is expired
-     *
-     * @return string
-     */
-    protected function expiredEventMessage(): string
-    {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">'
-           . esc_html__(
-               'We\'re sorry, but all tickets sales have ended because the event is expired.',
-               'event_espresso'
-           )
-           . '</span></div><!-- .ee-event-expired-notice -->';
-    }
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event has no more tickets available
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function noTicketAvailableMessage(): string
-    {
-        $no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $no_ticket_available_msg .= sprintf(
-                esc_html__(
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'
-                . get_edit_post_link($this->event->ID())
-                . '">',
-                '</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
-            );
-        }
-        return '
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+	/**
+	 * @var EE_Ticket_Selector_Config
+	 */
+	protected $config;
+
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected $iframe = false;
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @var int $max_attendees
+	 */
+	private $max_attendees = EE_INF;
+
+	/**
+	 * @var string $date_format
+	 */
+	private $date_format;
+
+	/**
+	 * @var string $time_format
+	 */
+	private $time_format;
+
+	/**
+	 * @var boolean $display_full_ui
+	 */
+	private $display_full_ui;
+
+	/**
+	 * @var CurrentUser
+	 */
+	private $current_user;
+
+
+	/**
+	 * DisplayTicketSelector constructor.
+	 *
+	 * @param CurrentUser $current_user
+	 * @param RequestInterface          $request
+	 * @param EE_Ticket_Selector_Config $config
+	 * @param bool                      $iframe
+	 */
+	public function __construct(
+		CurrentUser $current_user,
+		RequestInterface $request,
+		EE_Ticket_Selector_Config $config,
+		bool $iframe = false
+	) {
+		$this->current_user = $current_user;
+		$this->request     = $request;
+		$this->config      = $config;
+		$this->setIframe($iframe);
+		$this->date_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format')
+		);
+		$this->time_format  = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format')
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe(): bool
+	{
+		return $this->iframe;
+	}
+
+
+	/**
+	 * @param boolean $iframe
+	 */
+	public function setIframe(bool $iframe = true)
+	{
+		$this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * finds and sets the \EE_Event object for use throughout class
+	 *
+	 * @param mixed $event
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function setEvent($event = null): bool
+	{
+		if ($event === null) {
+			global $post;
+			$event = $post;
+		}
+		if ($event instanceof EE_Event) {
+			$this->event = $event;
+		} elseif ($event instanceof WP_Post) {
+			if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
+				$this->event = $event->EE_Event;
+			} elseif ($event->post_type === 'espresso_events') {
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
+				$this->event     = $event->EE_Event;
+			}
+		} else {
+			$user_msg = esc_html__('No Event object or an invalid Event object was supplied.', 'event_espresso');
+			$dev_msg  = $user_msg . esc_html__(
+				'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+				'event_espresso'
+			);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getMaxAttendees(): int
+	{
+		return $this->max_attendees;
+	}
+
+
+	/**
+	 * @param int $max_attendees
+	 */
+	public function setMaxAttendees(int $max_attendees)
+	{
+		$this->max_attendees = absint(
+			apply_filters(
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+				$max_attendees
+			)
+		);
+	}
+
+
+	/**
+	 * Returns whether or not the full ticket selector should be shown or not.
+	 * Currently, it displays on the frontend (including ajax requests) but not the backend
+	 *
+	 * @return bool
+	 */
+	private function display_full_ui(): bool
+	{
+		if ($this->display_full_ui === null) {
+			$this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
+		}
+		return $this->display_full_ui;
+	}
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param WP_Post|int $event
+	 * @param bool        $view_details
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function display($event = null, bool $view_details = false)
+	{
+		// reset filter for displaying submit button
+		remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		// poke and prod incoming event till it tells us what it is
+		if (! $this->setEvent($event)) {
+			return $this->handleMissingEvent();
+		}
+		// is the event expired ?
+		$template_args['event_is_expired'] = ! is_admin() && $this->event->is_expired();
+		if ($template_args['event_is_expired']) {
+			return is_single()
+				? $this->expiredEventMessage()
+				: $this->expiredEventMessage() . $this->displayViewDetailsButton();
+		}
+		// begin gathering template arguments by getting event status
+		$template_args = ['event_status' => $this->event->get_active_status()];
+		if (
+			$this->activeEventAndShowTicketSelector(
+				$event,
+				$template_args['event_status'],
+				$view_details
+			)
+		) {
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		$this->setMaxAttendees($this->event->additional_limit());
+		if ($this->getMaxAttendees() < 1) {
+			return $this->ticketSalesClosedMessage();
+		}
+		// get all tickets for this event ordered by the datetime
+		$tickets = $this->getTickets();
+		if (count($tickets) < 1) {
+			return $this->noTicketAvailableMessage();
+		}
+		// redirecting to another site for registration ??
+		$external_url = (string) $this->event->external_url()
+						&& $this->event->external_url() !== get_the_permalink()
+			? $this->event->external_url()
+			: '';
+		// if redirecting to another site for registration, then we don't load the TS
+		$ticket_selector = $external_url
+			? $this->externalEventRegistration()
+			: $this->loadTicketSelector($tickets, $template_args);
+		// now set up the form (but not for the admin)
+		$ticket_selector = $this->display_full_ui()
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
+		return $ticket_selector;
+	}
+
+
+	/**
+	 * displayTicketSelector
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
+	 *
+	 * @param WP_Post|int $event
+	 * @param string      $_event_active_status
+	 * @param bool        $view_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function activeEventAndShowTicketSelector($event, string $_event_active_status, bool $view_details): bool
+	{
+		$event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
+		return $this->display_full_ui()
+			   && (
+				   ! $this->event->display_ticket_selector()
+				   || $view_details
+				   || post_password_required($event_post)
+				   || (
+					   $_event_active_status !== EE_Datetime::active
+					   && $_event_active_status !== EE_Datetime::upcoming
+					   && $_event_active_status !== EE_Datetime::sold_out
+					   && ! (
+						   $_event_active_status === EE_Datetime::inactive
+						   && is_user_logged_in()
+					   )
+				   )
+			   );
+	}
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event is expired
+	 *
+	 * @return string
+	 */
+	protected function expiredEventMessage(): string
+	{
+		return '<div class="ee-event-expired-notice"><span class="important-notice">'
+		   . esc_html__(
+			   'We\'re sorry, but all tickets sales have ended because the event is expired.',
+			   'event_espresso'
+		   )
+		   . '</span></div><!-- .ee-event-expired-notice -->';
+	}
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event has no more tickets available
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function noTicketAvailableMessage(): string
+	{
+		$no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$no_ticket_available_msg .= sprintf(
+				esc_html__(
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'
+				. get_edit_post_link($this->event->ID())
+				. '">',
+				'</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
+			);
+		}
+		return '
             <div class="ee-event-expired-notice">
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
             </div><!-- .ee-event-expired-notice -->';
-    }
-
-
-    /**
-     * ticketSalesClosed
-     * notice displayed if event ticket sales are turned off
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketSalesClosedMessage(): string
-    {
-        $sales_closed_msg = esc_html__(
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-            'event_espresso'
-        );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $sales_closed_msg .= sprintf(
-                esc_html__(
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'
-                . get_edit_post_link($this->event->ID())
-                . '">',
-                '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
-            );
-        }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-    }
-
-
-    /**
-     * getTickets
-     *
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function getTickets()
-    {
-        $show_expired_tickets = is_admin() || $this->config->show_expired_tickets;
-
-        $ticket_query_args = [
-            [
-                'Datetime.EVT_ID' => $this->event->ID(),
-                'TKT_visibility'  => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-            ],
-            'order_by' => [
-                'TKT_required'           => 'DESC',
-                'TKT_order'              => 'ASC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ],
-        ];
-
-        $datetime_id = $this->request->getRequestParam('datetime', 0, 'int');
-        if ($datetime_id) {
-            $ticket_query_args[0]['Datetime.DTT_ID'] = $datetime_id;
-        }
-
-        if (! $show_expired_tickets) {
-            // use the correct applicable time query depending on what version of core is being run.
-            $current_time                         = method_exists('EEM_Datetime', 'current_time_for_query')
-                ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = ['>', $current_time];
-        }
-        /** @var EE_Ticket[] $tickets */
-        $tickets = EEM_Ticket::instance()->get_all($ticket_query_args);
-        // remove tickets based on their visibility and the current user's allowed access (crudely based on roles)
-        // and filter the returned results
-         $tickets = array_filter($tickets, [$this, 'ticketVisibilityFilter']);
-        return (array) apply_filters(
-            'FHEE__EventEspresso_modules_ticketSelector_DisplayTicketSelector__getTickets',
-            $tickets,
-            $ticket_query_args,
-            $this
-        );
-    }
-
-
-    /**
-     * returns true if any of the following is true:
-     *  - ticket visibility is PUBLIC
-     *  - ticket visibility is MEMBERS_ONLY and user is logged in
-     *  - ticket visibility is ADMINS_ONLY when user IS logged in as an admin
-     *  - ticket visibility is ADMIN_UI_ONLY when ticket selector is being viewed via an admin page UI
-     *
-     * @param EE_Ticket $ticket
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function ticketVisibilityFilter(EE_Ticket $ticket): bool
-    {
-        return $ticket->isPublicOnly()
-               || ($ticket->isMembersOnly() && $this->current_user->isLoggedIn())
-               || (
-                   $ticket->isAdminsOnly()
-                   && ($this->current_user->isEventManager() || $this->current_user->isSuperAdmin())
-               )
-               || ($ticket->isAdminUiOnly() && is_admin());
-    }
-
-
-    /**
-     * loadTicketSelector
-     * begins to assemble template arguments
-     * and decides whether to load a "simple" ticket selector, or the standard
-     *
-     * @param EE_Ticket[] $tickets
-     * @param array       $template_args
-     * @return TicketSelectorSimple|TicketSelectorStandard
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function loadTicketSelector(array $tickets, array $template_args)
-    {
-        $template_args['event']            = $this->event;
-        $template_args['EVT_ID']           = $this->event->ID();
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        $template_args['max_atndz']        = $this->getMaxAttendees();
-        $template_args['date_format']      = $this->date_format;
-        $template_args['time_format']      = $this->time_format;
-        /**
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
-         *
-         * @param string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
-         * @param int $EVT_ID The Event ID
-         * @since 4.9.13
-         */
-        $template_args['anchor_id']    = apply_filters(
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
-            $this->event->ID()
-        );
-        $template_args['tickets']      = $tickets;
-        $template_args['ticket_count'] = count($tickets);
-        $ticket_selector               = $this->simpleTicketSelector($tickets, $template_args);
-        if ($ticket_selector instanceof TicketSelectorSimple) {
-            return $ticket_selector;
-        }
-        return new TicketSelectorStandard(
-            $this->config,
-            $this->getTaxConfig(),
-            $this->event,
-            $tickets,
-            $this->getMaxAttendees(),
-            $template_args,
-            $this->date_format,
-            $this->time_format
-        );
-    }
-
-
-    /**
-     * simpleTicketSelector
-     * there's one ticket, and max attendees is set to one,
-     * so if the event is free, then this is a "simple" ticket selector
-     * a.k.a. "Dude Where's my Ticket Selector?"
-     *
-     * @param EE_Ticket[] $tickets
-     * @param array       $template_args
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function simpleTicketSelector(array $tickets, array $template_args)
-    {
-        // if there is only ONE ticket with a max qty of ONE
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
-            return '';
-        }
-        /** @var EE_Ticket $ticket */
-        $ticket = reset($tickets);
-        // if the ticket is free... then not much need for the ticket selector
-        if (
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__hide_ticket_selector',
-                $ticket->is_free(),
-                $this->event->ID()
-            )
-        ) {
-            return new TicketSelectorSimple(
-                $this->event,
-                $ticket,
-                $this->getMaxAttendees(),
-                $template_args
-            );
-        }
-        return '';
-    }
-
-
-    /**
-     * externalEventRegistration
-     *
-     * @return string
-     */
-    public function externalEventRegistration(): string
-    {
-        // if not we still need to trigger the display of the submit button
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        // display notice to admin that registration is external
-        return $this->display_full_ui()
-            ? esc_html__(
-                'Registration is at an external URL for this event.',
-                'event_espresso'
-            )
-            : '';
-    }
-
-
-    /**
-     * formOpen
-     *
-     * @param int    $ID
-     * @param string $external_url
-     * @return        string
-     */
-    public function formOpen(int $ID = 0, string $external_url = ''): string
-    {
-        // if redirecting, we don't need any anything else
-        if ($external_url) {
-            $html = '<form method="GET" ';
-            $html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
-            $html .= 'name="ticket-selector-form-' . $ID . '"';
-            // open link in new window ?
-            $html       .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                $this->isIframe(),
-                $this
-            )
-                ? ' target="_blank"'
-                : '';
-            $html       .= '>';
-            $query_args = EEH_URL::get_query_string($external_url);
-            foreach ((array) $query_args as $query_arg => $value) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-            return '';
-        }
-        $checkout_url = EEH_Event_View::event_link_url($ID);
-        if (! $checkout_url) {
-            EE_Error::add_error(
-                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-        $html = '<form method="POST" ';
-        $html .= 'action="' . $checkout_url . '" ';
-        $html .= 'name="ticket-selector-form-' . $ID . '"';
-        $html .= $this->iframe ? ' target="_blank"' : '';
-        $html .= '>';
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        return apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
-    }
-
-
-    /**
-     * displaySubmitButton
-     *
-     * @param string $external_url
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function displaySubmitButton(string $external_url = ''): string
-    {
-        $html = '';
-        if ($this->display_full_ui()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= $this->displayRegisterNowButton();
-                $html .= empty($external_url)
-                    ? $this->ticketSelectorEndDiv()
-                    : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
-            } elseif ($this->getMaxAttendees() === 1) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ($this->event->is_sold_out()) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            esc_html__(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            $this->event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        $this->event
-                    );
-                    if (
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                            false,
-                            $this->event
-                        )
-                    ) {
-                        $html .= $this->displayRegisterNowButton();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .= $this->ticketSelectorEndDiv();
-                } elseif (
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                    && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= $this->displayViewDetailsButton(true);
-                } else {
-                    $html .= $this->ticketSelectorEndDiv();
-                }
-            } elseif (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= $this->ticketSelectorEndDiv();
-                $html .= $this->displayViewDetailsButton();
-            } else {
-                if (
-                    apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        $this->event
-                    )
-                ) {
-                    $html .= $this->displayRegisterNowButton();
-                }
-                // no submit or view details button, and no additional content
-                $html .= $this->ticketSelectorEndDiv();
-            }
-            if (! $this->iframe && ! is_archive()) {
-                $html .= EEH_Template::powered_by_event_espresso('', '', ['utm_content' => 'ticket_selector']);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
-            $html,
-            $this->event,
-            $this
-        );
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function displayRegisterNowButton(): string
-    {
-        $btn_text     = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            esc_html__('Register Now', 'event_espresso'),
-            $this->event
-        );
-        $external_url = (string) $this->event->external_url()
-                        && $this->event->external_url() !== get_the_permalink()
-            ? $this->event->external_url()
-            : '';
-        $html         = EEH_HTML::div(
-            '',
-            'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
-            'ticket-selector-submit-btn-wrap'
-        );
-        $html         .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
-        $html         .= ' class="ticket-selector-submit-btn ';
-        $html         .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html         .= ' type="submit" value="' . $btn_text . '" data-ee-disable-after-recaptcha="true" />';
-        $html         .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
-        $html         .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            $this->event,
-            $this->iframe
-        );
-        return $html;
-    }
-
-
-    /**
-     * displayViewDetailsButton
-     *
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function displayViewDetailsButton(bool $DWMTS = false): string
-    {
-        if (! $this->event->get_permalink()) {
-            EE_Error::add_error(
-                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $view_details_btn = '<form method="GET" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            $this->event->get_permalink(),
-            $this->event
-        );
-        $view_details_btn .= '"';
-        // open link in new window ?
-        $view_details_btn .= apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
-            $this->isIframe(),
-            $this
-        )
-            ? ' target="_blank"'
-            : '';
-        $view_details_btn .= '>';
-        $btn_text         = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            esc_html__('View Details', 'event_espresso'),
-            $this->event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . $this->event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
-        if ($DWMTS) {
-            $view_details_btn .= $this->formClose();
-            $view_details_btn .= $this->ticketSelectorEndDiv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= $this->clearTicketSelector();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= $this->formClose();
-        }
-        return $view_details_btn;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ticketSelectorEndDiv(): string
-    {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function clearTicketSelector(): string
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div><!-- clearTicketSelector -->';
-    }
-
-
-    /**
-     * @access        public
-     * @return        string
-     */
-    public function formClose(): string
-    {
-        return '</form>';
-    }
-
-
-    /**
-     * handleMissingEvent
-     * Returns either false or an error to display when no valid event is passed.
-     *
-     * @return string
-     * @throws ExceptionStackTraceDisplay
-     * @throws InvalidInterfaceException
-     * @throws Exception
-     */
-    protected function handleMissingEvent()
-    {
-        // If this is not an iFrame request, simply return false.
-        if (! $this->isIframe()) {
-            return '';
-        }
-        // This is an iFrame so return an error.
-        // Display stack trace if WP_DEBUG is enabled.
-        if (WP_DEBUG === true && current_user_can('edit_pages')) {
-            $event_id = $this->request->getRequestParam('event', 0, 'int');
-            new ExceptionStackTraceDisplay(
-                new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'A valid Event ID is required to display the ticket selector.%3$sAn Event with an ID of "%1$s" could not be found.%3$sPlease verify that the embed code added to this post\'s content includes an "%2$s" argument and that its value corresponds to a valid Event ID.',
-                            'event_espresso'
-                        ),
-                        $event_id,
-                        'event',
-                        '<br />'
-                    )
-                )
-            );
-            return '';
-        }
-        // If WP_DEBUG is not enabled, display a message stating the event could not be found.
-        return EEH_HTML::p(
-            esc_html__(
-                'A valid Event could not be found. Please contact the event administrator for assistance.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Tax_Config
-     * @since   4.10.14.p
-     */
-    protected function getTaxConfig()
-    {
-        return isset(EE_Registry::instance()->CFG->tax_settings)
-               && EE_Registry::instance()->CFG->tax_settings instanceof EE_Tax_Config
-            ? EE_Registry::instance()->CFG->tax_settings
-            : new EE_Tax_Config();
-    }
+	}
+
+
+	/**
+	 * ticketSalesClosed
+	 * notice displayed if event ticket sales are turned off
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketSalesClosedMessage(): string
+	{
+		$sales_closed_msg = esc_html__(
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+			'event_espresso'
+		);
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$sales_closed_msg .= sprintf(
+				esc_html__(
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'
+				. get_edit_post_link($this->event->ID())
+				. '">',
+				'</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
+			);
+		}
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+	}
+
+
+	/**
+	 * getTickets
+	 *
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function getTickets()
+	{
+		$show_expired_tickets = is_admin() || $this->config->show_expired_tickets;
+
+		$ticket_query_args = [
+			[
+				'Datetime.EVT_ID' => $this->event->ID(),
+				'TKT_visibility'  => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+			],
+			'order_by' => [
+				'TKT_required'           => 'DESC',
+				'TKT_order'              => 'ASC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			],
+		];
+
+		$datetime_id = $this->request->getRequestParam('datetime', 0, 'int');
+		if ($datetime_id) {
+			$ticket_query_args[0]['Datetime.DTT_ID'] = $datetime_id;
+		}
+
+		if (! $show_expired_tickets) {
+			// use the correct applicable time query depending on what version of core is being run.
+			$current_time                         = method_exists('EEM_Datetime', 'current_time_for_query')
+				? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = ['>', $current_time];
+		}
+		/** @var EE_Ticket[] $tickets */
+		$tickets = EEM_Ticket::instance()->get_all($ticket_query_args);
+		// remove tickets based on their visibility and the current user's allowed access (crudely based on roles)
+		// and filter the returned results
+		 $tickets = array_filter($tickets, [$this, 'ticketVisibilityFilter']);
+		return (array) apply_filters(
+			'FHEE__EventEspresso_modules_ticketSelector_DisplayTicketSelector__getTickets',
+			$tickets,
+			$ticket_query_args,
+			$this
+		);
+	}
+
+
+	/**
+	 * returns true if any of the following is true:
+	 *  - ticket visibility is PUBLIC
+	 *  - ticket visibility is MEMBERS_ONLY and user is logged in
+	 *  - ticket visibility is ADMINS_ONLY when user IS logged in as an admin
+	 *  - ticket visibility is ADMIN_UI_ONLY when ticket selector is being viewed via an admin page UI
+	 *
+	 * @param EE_Ticket $ticket
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function ticketVisibilityFilter(EE_Ticket $ticket): bool
+	{
+		return $ticket->isPublicOnly()
+			   || ($ticket->isMembersOnly() && $this->current_user->isLoggedIn())
+			   || (
+				   $ticket->isAdminsOnly()
+				   && ($this->current_user->isEventManager() || $this->current_user->isSuperAdmin())
+			   )
+			   || ($ticket->isAdminUiOnly() && is_admin());
+	}
+
+
+	/**
+	 * loadTicketSelector
+	 * begins to assemble template arguments
+	 * and decides whether to load a "simple" ticket selector, or the standard
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @param array       $template_args
+	 * @return TicketSelectorSimple|TicketSelectorStandard
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function loadTicketSelector(array $tickets, array $template_args)
+	{
+		$template_args['event']            = $this->event;
+		$template_args['EVT_ID']           = $this->event->ID();
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		$template_args['max_atndz']        = $this->getMaxAttendees();
+		$template_args['date_format']      = $this->date_format;
+		$template_args['time_format']      = $this->time_format;
+		/**
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
+		 *
+		 * @param string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
+		 * @param int $EVT_ID The Event ID
+		 * @since 4.9.13
+		 */
+		$template_args['anchor_id']    = apply_filters(
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
+			'#tkt-slctr-tbl-' . $this->event->ID(),
+			$this->event->ID()
+		);
+		$template_args['tickets']      = $tickets;
+		$template_args['ticket_count'] = count($tickets);
+		$ticket_selector               = $this->simpleTicketSelector($tickets, $template_args);
+		if ($ticket_selector instanceof TicketSelectorSimple) {
+			return $ticket_selector;
+		}
+		return new TicketSelectorStandard(
+			$this->config,
+			$this->getTaxConfig(),
+			$this->event,
+			$tickets,
+			$this->getMaxAttendees(),
+			$template_args,
+			$this->date_format,
+			$this->time_format
+		);
+	}
+
+
+	/**
+	 * simpleTicketSelector
+	 * there's one ticket, and max attendees is set to one,
+	 * so if the event is free, then this is a "simple" ticket selector
+	 * a.k.a. "Dude Where's my Ticket Selector?"
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @param array       $template_args
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function simpleTicketSelector(array $tickets, array $template_args)
+	{
+		// if there is only ONE ticket with a max qty of ONE
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
+			return '';
+		}
+		/** @var EE_Ticket $ticket */
+		$ticket = reset($tickets);
+		// if the ticket is free... then not much need for the ticket selector
+		if (
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__hide_ticket_selector',
+				$ticket->is_free(),
+				$this->event->ID()
+			)
+		) {
+			return new TicketSelectorSimple(
+				$this->event,
+				$ticket,
+				$this->getMaxAttendees(),
+				$template_args
+			);
+		}
+		return '';
+	}
+
+
+	/**
+	 * externalEventRegistration
+	 *
+	 * @return string
+	 */
+	public function externalEventRegistration(): string
+	{
+		// if not we still need to trigger the display of the submit button
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		// display notice to admin that registration is external
+		return $this->display_full_ui()
+			? esc_html__(
+				'Registration is at an external URL for this event.',
+				'event_espresso'
+			)
+			: '';
+	}
+
+
+	/**
+	 * formOpen
+	 *
+	 * @param int    $ID
+	 * @param string $external_url
+	 * @return        string
+	 */
+	public function formOpen(int $ID = 0, string $external_url = ''): string
+	{
+		// if redirecting, we don't need any anything else
+		if ($external_url) {
+			$html = '<form method="GET" ';
+			$html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
+			$html .= 'name="ticket-selector-form-' . $ID . '"';
+			// open link in new window ?
+			$html       .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				$this->isIframe(),
+				$this
+			)
+				? ' target="_blank"'
+				: '';
+			$html       .= '>';
+			$query_args = EEH_URL::get_query_string($external_url);
+			foreach ((array) $query_args as $query_arg => $value) {
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+			return '';
+		}
+		$checkout_url = EEH_Event_View::event_link_url($ID);
+		if (! $checkout_url) {
+			EE_Error::add_error(
+				esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+		$html = '<form method="POST" ';
+		$html .= 'action="' . $checkout_url . '" ';
+		$html .= 'name="ticket-selector-form-' . $ID . '"';
+		$html .= $this->iframe ? ' target="_blank"' : '';
+		$html .= '>';
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		return apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
+	}
+
+
+	/**
+	 * displaySubmitButton
+	 *
+	 * @param string $external_url
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function displaySubmitButton(string $external_url = ''): string
+	{
+		$html = '';
+		if ($this->display_full_ui()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= $this->displayRegisterNowButton();
+				$html .= empty($external_url)
+					? $this->ticketSelectorEndDiv()
+					: $this->clearTicketSelector();
+				$html .= '<br/>' . $this->formClose();
+			} elseif ($this->getMaxAttendees() === 1) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ($this->event->is_sold_out()) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							esc_html__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							$this->event->name(),
+							'</p>',
+							'<br />'
+						),
+						$this->event
+					);
+					if (
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+							false,
+							$this->event
+						)
+					) {
+						$html .= $this->displayRegisterNowButton();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .= $this->ticketSelectorEndDiv();
+				} elseif (
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+					&& ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= $this->displayViewDetailsButton(true);
+				} else {
+					$html .= $this->ticketSelectorEndDiv();
+				}
+			} elseif (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= $this->ticketSelectorEndDiv();
+				$html .= $this->displayViewDetailsButton();
+			} else {
+				if (
+					apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						$this->event
+					)
+				) {
+					$html .= $this->displayRegisterNowButton();
+				}
+				// no submit or view details button, and no additional content
+				$html .= $this->ticketSelectorEndDiv();
+			}
+			if (! $this->iframe && ! is_archive()) {
+				$html .= EEH_Template::powered_by_event_espresso('', '', ['utm_content' => 'ticket_selector']);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
+			$html,
+			$this->event,
+			$this
+		);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function displayRegisterNowButton(): string
+	{
+		$btn_text     = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			esc_html__('Register Now', 'event_espresso'),
+			$this->event
+		);
+		$external_url = (string) $this->event->external_url()
+						&& $this->event->external_url() !== get_the_permalink()
+			? $this->event->external_url()
+			: '';
+		$html         = EEH_HTML::div(
+			'',
+			'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
+			'ticket-selector-submit-btn-wrap'
+		);
+		$html         .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+		$html         .= ' class="ticket-selector-submit-btn ';
+		$html         .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html         .= ' type="submit" value="' . $btn_text . '" data-ee-disable-after-recaptcha="true" />';
+		$html         .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+		$html         .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			$this->event,
+			$this->iframe
+		);
+		return $html;
+	}
+
+
+	/**
+	 * displayViewDetailsButton
+	 *
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function displayViewDetailsButton(bool $DWMTS = false): string
+	{
+		if (! $this->event->get_permalink()) {
+			EE_Error::add_error(
+				esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$view_details_btn = '<form method="GET" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			$this->event->get_permalink(),
+			$this->event
+		);
+		$view_details_btn .= '"';
+		// open link in new window ?
+		$view_details_btn .= apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
+			$this->isIframe(),
+			$this
+		)
+			? ' target="_blank"'
+			: '';
+		$view_details_btn .= '>';
+		$btn_text         = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			esc_html__('View Details', 'event_espresso'),
+			$this->event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . $this->event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
+		if ($DWMTS) {
+			$view_details_btn .= $this->formClose();
+			$view_details_btn .= $this->ticketSelectorEndDiv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= $this->clearTicketSelector();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= $this->formClose();
+		}
+		return $view_details_btn;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ticketSelectorEndDiv(): string
+	{
+		return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function clearTicketSelector(): string
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div><!-- clearTicketSelector -->';
+	}
+
+
+	/**
+	 * @access        public
+	 * @return        string
+	 */
+	public function formClose(): string
+	{
+		return '</form>';
+	}
+
+
+	/**
+	 * handleMissingEvent
+	 * Returns either false or an error to display when no valid event is passed.
+	 *
+	 * @return string
+	 * @throws ExceptionStackTraceDisplay
+	 * @throws InvalidInterfaceException
+	 * @throws Exception
+	 */
+	protected function handleMissingEvent()
+	{
+		// If this is not an iFrame request, simply return false.
+		if (! $this->isIframe()) {
+			return '';
+		}
+		// This is an iFrame so return an error.
+		// Display stack trace if WP_DEBUG is enabled.
+		if (WP_DEBUG === true && current_user_can('edit_pages')) {
+			$event_id = $this->request->getRequestParam('event', 0, 'int');
+			new ExceptionStackTraceDisplay(
+				new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'A valid Event ID is required to display the ticket selector.%3$sAn Event with an ID of "%1$s" could not be found.%3$sPlease verify that the embed code added to this post\'s content includes an "%2$s" argument and that its value corresponds to a valid Event ID.',
+							'event_espresso'
+						),
+						$event_id,
+						'event',
+						'<br />'
+					)
+				)
+			);
+			return '';
+		}
+		// If WP_DEBUG is not enabled, display a message stating the event could not be found.
+		return EEH_HTML::p(
+			esc_html__(
+				'A valid Event could not be found. Please contact the event administrator for assistance.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Tax_Config
+	 * @since   4.10.14.p
+	 */
+	protected function getTaxConfig()
+	{
+		return isset(EE_Registry::instance()->CFG->tax_settings)
+			   && EE_Registry::instance()->CFG->tax_settings instanceof EE_Tax_Config
+			? EE_Registry::instance()->CFG->tax_settings
+			: new EE_Tax_Config();
+	}
 }

modules/ticket_selector/ProcessTicketSelectorPostData.php

Indentation +255 added lines, -255 removed lines

@@ -20,259 +20,259 @@
  */
 class ProcessTicketSelectorPostData
 {
-    const DATA_KEY_EVENT_ID      = 'id';
-
-    const DATA_KEY_MAX_ATNDZ     = 'max_atndz';
-
-    const DATA_KEY_QUANTITY      = 'ticket-selections';
-
-    const DATA_KEY_RETURN_URL    = 'return_url';
-
-    const DATA_KEY_ROWS          = 'rows';
-
-    const DATA_KEY_TICKET_ID     = 'ticket_id';
-
-    const DATA_KEY_TOTAL_TICKETS = 'total_tickets';
-
-    const INPUT_KEY_EVENT_ID     = 'tkt-slctr-event-id';
-
-    const INPUT_KEY_MAX_ATNDZ    = 'tkt-slctr-max-atndz-';
-
-    const INPUT_KEY_ROWS         = 'tkt-slctr-rows-';
-
-    const INPUT_KEY_QTY          = 'tkt-slctr-qty-';
-
-    const INPUT_KEY_TICKET_ID    = 'tkt-slctr-ticket-id-';
-
-    const INPUT_KEY_RETURN_URL   = 'tkt-slctr-return-url-';
-
-
-    /**
-     * @var int
-     */
-    protected $event_id;
-
-    /**
-     * @var EEM_Event
-     */
-    protected $event_model;
-
-    /**
-     * @var array
-     */
-    protected $inputs_to_clean = [];
-
-    /**
-     * @var array
-     */
-    protected $valid_data = [];
-
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-
-    /**
-     * @param RequestInterface $request
-     * @param EEM_Event        $event_model
-     */
-    public function __construct(RequestInterface $request, EEM_Event $event_model)
-    {
-        $this->request         = $request;
-        $this->event_model     = $event_model;
-        $this->inputs_to_clean = [
-            self::DATA_KEY_MAX_ATNDZ     => self::INPUT_KEY_MAX_ATNDZ,
-            self::DATA_KEY_RETURN_URL    => self::INPUT_KEY_RETURN_URL,
-            self::DATA_KEY_ROWS          => self::INPUT_KEY_ROWS,
-            self::DATA_KEY_TOTAL_TICKETS => self::INPUT_KEY_TICKET_ID,
-            self::DATA_KEY_QUANTITY      => self::INPUT_KEY_QTY,
-        ];
-    }
-
-
-    /**
-     * @return int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getEventId(): int
-    {
-        // do we have an event id?
-        if ($this->event_id === null) {
-            $this->event_id = $this->request->getRequestParam(self::INPUT_KEY_EVENT_ID, 0, DataType::INTEGER);
-            if (! $this->event_id) {
-                // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
-                throw new DomainException(
-                    sprintf(
-                        esc_html__(
-                            'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
-                            'event_espresso'
-                        ),
-                        '<br/>'
-                    )
-                );
-            }
-        }
-        // let's pull the event so we can get the REAL max attendees per order value
-        /** @var EE_Event $event */
-        $event = $this->event_model->get_one_by_ID($this->event_id);
-        if (! $event instanceof EE_Event) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'A valid event could not be retrieved for the supplied event id (%1$s).%2$sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    $this->event_id,
-                    '<br/>'
-                )
-            );
-        }
-        $this->valid_data[ self::DATA_KEY_MAX_ATNDZ ] = $event->additional_limit();
-        // event id is valid
-        return $this->event_id;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validatePostData(): array
-    {
-        // grab valid id
-        $this->valid_data[ self::DATA_KEY_EVENT_ID ] = $this->getEventId();
-        // let's track the total number of tickets ordered.'
-        $this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] = 0;
-        // cycle through $inputs_to_clean array
-        foreach ($this->inputs_to_clean as $what => $input_to_clean) {
-            $input_key = "$input_to_clean$this->event_id";
-            // check for POST data
-            if ($this->request->requestParamIsSet($input_key)) {
-                switch ($what) {
-                    // integers
-                    case self::DATA_KEY_ROWS:
-                    case self::DATA_KEY_MAX_ATNDZ:
-                        $this->processInteger($what, $input_key);
-                        break;
-                    // arrays of integers
-                    case self::DATA_KEY_QUANTITY:
-                        $this->processQuantity($input_key);
-                        break;
-                    // array of integers
-                    case self::DATA_KEY_TOTAL_TICKETS:
-                        $this->processTicketIDs($input_key);
-                        break;
-                    case self::DATA_KEY_RETURN_URL:
-                        $this->processReturnURL($input_key);
-                        break;
-                }
-            }
-        }
-        return $this->valid_data;
-    }
-
-
-    /**
-     * @param string $what
-     * @param string $input_key
-     */
-    protected function processInteger(string $what, string $input_key)
-    {
-        $this->valid_data[ $what ] = $this->request->getRequestParam($input_key, 0, DataType::INTEGER);
-    }
-
-
-    /**
-     * @param string $input_key
-     * @throws DomainException
-     */
-    protected function processQuantity(string $input_key)
-    {
-        /** @var array $row_qty */
-        $row_qty = $this->request->getRequestParam($input_key, [], DataType::INTEGER, true);
-        if (empty($row_qty) || ! is_array($row_qty)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An error occurred while trying to retrieve the ticket selections for the event.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                )
-            );
-        }
-        $max_atndz = $this->valid_data[ self::DATA_KEY_MAX_ATNDZ ];
-        // if max attendees is 1 then the incoming row qty array
-        // will only have one element and the value will be the ticket ID
-        // ex: row qty = [ 0 => TKT_ID ]
-        if ($max_atndz === 1 && count($row_qty) === 1) {
-            // if the TS used radio buttons, then the ticket ID is stored differently in the request data
-            $raw_qty = $this->request->getRequestParam($input_key);
-            // explode integers by the dash if qty is a string
-            $delimiter = is_string($raw_qty) && strpos($raw_qty, '-') ? '-' : '';
-            if ($delimiter !== '') {
-                $row_qty = explode($delimiter, $raw_qty);
-            }
-            // grab that ticket ID regardless of where it is
-            $ticket_id = $row_qty[0] ?? key($row_qty);
-            // use it as the key, and set the value to 1
-            // ex: row qty = [ TKT_ID => 1 ]
-            $row_qty = [$ticket_id => 1];
-        }
-        foreach ($this->valid_data[ self::DATA_KEY_TICKET_ID ] as $ticket_id) {
-            $qty                                                       = $row_qty[ $ticket_id ] ?? 0;
-            $this->valid_data[ self::DATA_KEY_QUANTITY ][ $ticket_id ] = $qty;
-            $this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ]         += $qty;
-        }
-    }
-
-
-    /**
-     * @param string $input_key
-     */
-    protected function processReturnURL(string $input_key)
-    {
-        // grab and sanitize return-url
-        $input_value = $this->request->getRequestParam($input_key, '', DataType::URL);
-        // was the request coming from an iframe ? if so, then:
-        if (strpos($input_value, 'event_list=iframe')) {
-            // get anchor fragment
-            $input_value = explode('#', $input_value);
-            $input_value = end($input_value);
-            // use event list url instead, but append anchor
-            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
-        }
-        $this->valid_data[ self::DATA_KEY_RETURN_URL ] = $input_value;
-    }
-
-
-    /**
-     * @param string $input_key
-     * @throws DomainException
-     */
-    protected function processTicketIDs(string $input_key)
-    {
-        $ticket_ids          = (array) $this->request->getRequestParam($input_key, [], DataType::INTEGER, true);
-        $filtered_ticket_ids = array_filter($ticket_ids);
-        if (empty($filtered_ticket_ids)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An error occurred while trying to retrieve the ticket IDs for the event.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                )
-            );
-        }
-        // cycle thru values
-        foreach ($ticket_ids as $key => $value) {
-            // allow only integers
-            $this->valid_data[ self::DATA_KEY_TICKET_ID ][ $key ] = absint($value);
-        }
-    }
+	const DATA_KEY_EVENT_ID      = 'id';
+
+	const DATA_KEY_MAX_ATNDZ     = 'max_atndz';
+
+	const DATA_KEY_QUANTITY      = 'ticket-selections';
+
+	const DATA_KEY_RETURN_URL    = 'return_url';
+
+	const DATA_KEY_ROWS          = 'rows';
+
+	const DATA_KEY_TICKET_ID     = 'ticket_id';
+
+	const DATA_KEY_TOTAL_TICKETS = 'total_tickets';
+
+	const INPUT_KEY_EVENT_ID     = 'tkt-slctr-event-id';
+
+	const INPUT_KEY_MAX_ATNDZ    = 'tkt-slctr-max-atndz-';
+
+	const INPUT_KEY_ROWS         = 'tkt-slctr-rows-';
+
+	const INPUT_KEY_QTY          = 'tkt-slctr-qty-';
+
+	const INPUT_KEY_TICKET_ID    = 'tkt-slctr-ticket-id-';
+
+	const INPUT_KEY_RETURN_URL   = 'tkt-slctr-return-url-';
+
+
+	/**
+	 * @var int
+	 */
+	protected $event_id;
+
+	/**
+	 * @var EEM_Event
+	 */
+	protected $event_model;
+
+	/**
+	 * @var array
+	 */
+	protected $inputs_to_clean = [];
+
+	/**
+	 * @var array
+	 */
+	protected $valid_data = [];
+
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+
+	/**
+	 * @param RequestInterface $request
+	 * @param EEM_Event        $event_model
+	 */
+	public function __construct(RequestInterface $request, EEM_Event $event_model)
+	{
+		$this->request         = $request;
+		$this->event_model     = $event_model;
+		$this->inputs_to_clean = [
+			self::DATA_KEY_MAX_ATNDZ     => self::INPUT_KEY_MAX_ATNDZ,
+			self::DATA_KEY_RETURN_URL    => self::INPUT_KEY_RETURN_URL,
+			self::DATA_KEY_ROWS          => self::INPUT_KEY_ROWS,
+			self::DATA_KEY_TOTAL_TICKETS => self::INPUT_KEY_TICKET_ID,
+			self::DATA_KEY_QUANTITY      => self::INPUT_KEY_QTY,
+		];
+	}
+
+
+	/**
+	 * @return int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getEventId(): int
+	{
+		// do we have an event id?
+		if ($this->event_id === null) {
+			$this->event_id = $this->request->getRequestParam(self::INPUT_KEY_EVENT_ID, 0, DataType::INTEGER);
+			if (! $this->event_id) {
+				// $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
+				throw new DomainException(
+					sprintf(
+						esc_html__(
+							'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
+							'event_espresso'
+						),
+						'<br/>'
+					)
+				);
+			}
+		}
+		// let's pull the event so we can get the REAL max attendees per order value
+		/** @var EE_Event $event */
+		$event = $this->event_model->get_one_by_ID($this->event_id);
+		if (! $event instanceof EE_Event) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'A valid event could not be retrieved for the supplied event id (%1$s).%2$sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					$this->event_id,
+					'<br/>'
+				)
+			);
+		}
+		$this->valid_data[ self::DATA_KEY_MAX_ATNDZ ] = $event->additional_limit();
+		// event id is valid
+		return $this->event_id;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validatePostData(): array
+	{
+		// grab valid id
+		$this->valid_data[ self::DATA_KEY_EVENT_ID ] = $this->getEventId();
+		// let's track the total number of tickets ordered.'
+		$this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] = 0;
+		// cycle through $inputs_to_clean array
+		foreach ($this->inputs_to_clean as $what => $input_to_clean) {
+			$input_key = "$input_to_clean$this->event_id";
+			// check for POST data
+			if ($this->request->requestParamIsSet($input_key)) {
+				switch ($what) {
+					// integers
+					case self::DATA_KEY_ROWS:
+					case self::DATA_KEY_MAX_ATNDZ:
+						$this->processInteger($what, $input_key);
+						break;
+					// arrays of integers
+					case self::DATA_KEY_QUANTITY:
+						$this->processQuantity($input_key);
+						break;
+					// array of integers
+					case self::DATA_KEY_TOTAL_TICKETS:
+						$this->processTicketIDs($input_key);
+						break;
+					case self::DATA_KEY_RETURN_URL:
+						$this->processReturnURL($input_key);
+						break;
+				}
+			}
+		}
+		return $this->valid_data;
+	}
+
+
+	/**
+	 * @param string $what
+	 * @param string $input_key
+	 */
+	protected function processInteger(string $what, string $input_key)
+	{
+		$this->valid_data[ $what ] = $this->request->getRequestParam($input_key, 0, DataType::INTEGER);
+	}
+
+
+	/**
+	 * @param string $input_key
+	 * @throws DomainException
+	 */
+	protected function processQuantity(string $input_key)
+	{
+		/** @var array $row_qty */
+		$row_qty = $this->request->getRequestParam($input_key, [], DataType::INTEGER, true);
+		if (empty($row_qty) || ! is_array($row_qty)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An error occurred while trying to retrieve the ticket selections for the event.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				)
+			);
+		}
+		$max_atndz = $this->valid_data[ self::DATA_KEY_MAX_ATNDZ ];
+		// if max attendees is 1 then the incoming row qty array
+		// will only have one element and the value will be the ticket ID
+		// ex: row qty = [ 0 => TKT_ID ]
+		if ($max_atndz === 1 && count($row_qty) === 1) {
+			// if the TS used radio buttons, then the ticket ID is stored differently in the request data
+			$raw_qty = $this->request->getRequestParam($input_key);
+			// explode integers by the dash if qty is a string
+			$delimiter = is_string($raw_qty) && strpos($raw_qty, '-') ? '-' : '';
+			if ($delimiter !== '') {
+				$row_qty = explode($delimiter, $raw_qty);
+			}
+			// grab that ticket ID regardless of where it is
+			$ticket_id = $row_qty[0] ?? key($row_qty);
+			// use it as the key, and set the value to 1
+			// ex: row qty = [ TKT_ID => 1 ]
+			$row_qty = [$ticket_id => 1];
+		}
+		foreach ($this->valid_data[ self::DATA_KEY_TICKET_ID ] as $ticket_id) {
+			$qty                                                       = $row_qty[ $ticket_id ] ?? 0;
+			$this->valid_data[ self::DATA_KEY_QUANTITY ][ $ticket_id ] = $qty;
+			$this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ]         += $qty;
+		}
+	}
+
+
+	/**
+	 * @param string $input_key
+	 */
+	protected function processReturnURL(string $input_key)
+	{
+		// grab and sanitize return-url
+		$input_value = $this->request->getRequestParam($input_key, '', DataType::URL);
+		// was the request coming from an iframe ? if so, then:
+		if (strpos($input_value, 'event_list=iframe')) {
+			// get anchor fragment
+			$input_value = explode('#', $input_value);
+			$input_value = end($input_value);
+			// use event list url instead, but append anchor
+			$input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+		}
+		$this->valid_data[ self::DATA_KEY_RETURN_URL ] = $input_value;
+	}
+
+
+	/**
+	 * @param string $input_key
+	 * @throws DomainException
+	 */
+	protected function processTicketIDs(string $input_key)
+	{
+		$ticket_ids          = (array) $this->request->getRequestParam($input_key, [], DataType::INTEGER, true);
+		$filtered_ticket_ids = array_filter($ticket_ids);
+		if (empty($filtered_ticket_ids)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An error occurred while trying to retrieve the ticket IDs for the event.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				)
+			);
+		}
+		// cycle thru values
+		foreach ($ticket_ids as $key => $value) {
+			// allow only integers
+			$this->valid_data[ self::DATA_KEY_TICKET_ID ][ $key ] = absint($value);
+		}
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -102,7 +102,7 @@ 
         // do we have an event id?
         if ($this->event_id === null) {
             $this->event_id = $this->request->getRequestParam(self::INPUT_KEY_EVENT_ID, 0, DataType::INTEGER);
-            if (! $this->event_id) {
+            if ( ! $this->event_id) {
                 // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
                 throw new DomainException(
                     sprintf(
@@ -118,7 +118,7 @@ 
         // let's pull the event so we can get the REAL max attendees per order value
         /** @var EE_Event $event */
         $event = $this->event_model->get_one_by_ID($this->event_id);
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -130,7 +130,7 @@ 
                 )
             );
         }
-        $this->valid_data[ self::DATA_KEY_MAX_ATNDZ ] = $event->additional_limit();
+        $this->valid_data[self::DATA_KEY_MAX_ATNDZ] = $event->additional_limit();
         // event id is valid
         return $this->event_id;
     }
@@ -144,9 +144,9 @@ 
     public function validatePostData(): array
     {
         // grab valid id
-        $this->valid_data[ self::DATA_KEY_EVENT_ID ] = $this->getEventId();
+        $this->valid_data[self::DATA_KEY_EVENT_ID] = $this->getEventId();
         // let's track the total number of tickets ordered.'
-        $this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] = 0;
+        $this->valid_data[self:: DATA_KEY_TOTAL_TICKETS] = 0;
         // cycle through $inputs_to_clean array
         foreach ($this->inputs_to_clean as $what => $input_to_clean) {
             $input_key = "$input_to_clean$this->event_id";
@@ -182,7 +182,7 @@ 
      */
     protected function processInteger(string $what, string $input_key)
     {
-        $this->valid_data[ $what ] = $this->request->getRequestParam($input_key, 0, DataType::INTEGER);
+        $this->valid_data[$what] = $this->request->getRequestParam($input_key, 0, DataType::INTEGER);
     }
 
 
@@ -205,7 +205,7 @@ 
                 )
             );
         }
-        $max_atndz = $this->valid_data[ self::DATA_KEY_MAX_ATNDZ ];
+        $max_atndz = $this->valid_data[self::DATA_KEY_MAX_ATNDZ];
         // if max attendees is 1 then the incoming row qty array
         // will only have one element and the value will be the ticket ID
         // ex: row qty = [ 0 => TKT_ID ]
@@ -223,10 +223,10 @@ 
             // ex: row qty = [ TKT_ID => 1 ]
             $row_qty = [$ticket_id => 1];
         }
-        foreach ($this->valid_data[ self::DATA_KEY_TICKET_ID ] as $ticket_id) {
-            $qty                                                       = $row_qty[ $ticket_id ] ?? 0;
-            $this->valid_data[ self::DATA_KEY_QUANTITY ][ $ticket_id ] = $qty;
-            $this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ]         += $qty;
+        foreach ($this->valid_data[self::DATA_KEY_TICKET_ID] as $ticket_id) {
+            $qty                                                       = $row_qty[$ticket_id] ?? 0;
+            $this->valid_data[self::DATA_KEY_QUANTITY][$ticket_id] = $qty;
+            $this->valid_data[self:: DATA_KEY_TOTAL_TICKETS] += $qty;
         }
     }
 
@@ -244,9 +244,9 @@ 
             $input_value = explode('#', $input_value);
             $input_value = end($input_value);
             // use event list url instead, but append anchor
-            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+            $input_value = EEH_Event_View::event_archive_url().'#'.$input_value;
         }
-        $this->valid_data[ self::DATA_KEY_RETURN_URL ] = $input_value;
+        $this->valid_data[self::DATA_KEY_RETURN_URL] = $input_value;
     }
 
 
@@ -272,7 +272,7 @@ 
         // cycle thru values
         foreach ($ticket_ids as $key => $value) {
             // allow only integers
-            $this->valid_data[ self::DATA_KEY_TICKET_ID ][ $key ] = absint($value);
+            $this->valid_data[self::DATA_KEY_TICKET_ID][$key] = absint($value);
         }
     }
 }

admin_pages/transactions/Transactions_Admin_Page.core.php

Indentation +2540 added lines, -2540 removed lines

@@ -13,2544 +13,2544 @@
  */
 class Transactions_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * @var EE_Transaction
-     */
-    private $_transaction;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    /**
-     * @var array $_txn_status
-     */
-    private static $_txn_status;
-
-    /**
-     * @var array $_pay_status
-     */
-    private static $_pay_status;
-
-    /**
-     * @var array $_existing_reg_payment_REG_IDs
-     */
-    protected $_existing_reg_payment_REG_IDs;
-
-
-    /**
-     *    _init_page_props
-     *
-     * @return void
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = TXN_PG_SLUG;
-        $this->page_label       = esc_html__('Transactions', 'event_espresso');
-        $this->_admin_base_url  = TXN_ADMIN_URL;
-        $this->_admin_base_path = TXN_ADMIN;
-    }
-
-
-    /**
-     *    _ajax_hooks
-     *
-     * @return void
-     */
-    protected function _ajax_hooks()
-    {
-        // add_action('wp_ajax_espresso_apply_payment', [$this, 'apply_payments_or_refunds']);
-        // add_action('wp_ajax_espresso_apply_refund', [$this, 'apply_payments_or_refunds']);
-        // add_action('wp_ajax_espresso_delete_payment', [$this, 'delete_payment']);
-    }
-
-
-    /**
-     *    _define_page_props
-     *
-     * @return void
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons' => [
-                'add'    => esc_html__('Add New Transaction', 'event_espresso'),
-                'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
-                'delete' => esc_html__('Delete Transaction', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     *        grab url requests and route them
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function _set_page_routes()
-    {
-        $this->_set_transaction_status_array();
-        $TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
-
-        $this->_page_routes = [
-
-            'default' => [
-                'func'       => '_transactions_overview_list_table',
-                'capability' => 'ee_read_transactions',
-            ],
-
-            'view_transaction' => [
-                'func'       => '_transaction_details',
-                'capability' => 'ee_read_transaction',
-                'obj_id'     => $TXN_ID,
-            ],
-
-            'send_payment_reminder' => [
-                'func'       => '_send_payment_reminder',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ],
-
-            'espresso_apply_payment' => [
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ],
-
-            'espresso_apply_refund' => [
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ],
-
-            'espresso_delete_payment' => [
-                'func'       => [$this, 'delete_payment'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_payments',
-            ],
-
-            'espresso_recalculate_line_items' => [
-                'func'       => 'recalculateLineItems',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ],
-
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $TXN_ID             = $this->request->getRequestParam('TXN_ID', 0, 'int');
-        $this->_page_config = [
-            'default'          => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'icon'  => 'dashicons-list-view',
-                    'order' => 10,
-                ],
-                'list_table'    => 'EE_Admin_Transactions_List_Table',
-                'help_tabs'     => [
-                    'transactions_overview_help_tab'                       => [
-                        'title'    => esc_html__('Transactions Overview', 'event_espresso'),
-                        'filename' => 'transactions_overview',
-                    ],
-                    'transactions_overview_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
-                        'filename' => 'transactions_overview_table_column_headings',
-                    ],
-                    'transactions_overview_views_filters_help_tab'         => [
-                        'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
-                        'filename' => 'transactions_overview_views_filters_search',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'view_transaction' => [
-                'nav'       => [
-                    'label'      => esc_html__('View Transaction', 'event_espresso'),
-                    'icon'       => 'dashicons-cart',
-                    'order'      => 5,
-                    'url'        => $TXN_ID
-                        ? add_query_arg(['TXN_ID' => $TXN_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ],
-                'help_tabs' => [
-                    'transactions_view_transaction_help_tab'                                              => [
-                        'title'    => esc_html__('View Transaction', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction',
-                    ],
-                    'transactions_view_transaction_transaction_details_table_help_tab'                    => [
-                        'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_transaction_details_table',
-                    ],
-                    'transactions_view_transaction_attendees_registered_help_tab'                         => [
-                        'title'    => esc_html__('Attendees Registered', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_attendees_registered',
-                    ],
-                    'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => [
-                        'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_primary_registrant_billing_information',
-                    ],
-                ],
-                'qtips'     => ['Transaction_Details_Tips'],
-                'metaboxes' => ['_transaction_details_metaboxes'],
-
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-        // noop
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-        // noop
-    }
-
-
-    public function admin_init()
-    {
-        $EVT_ID        = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $event_name    = $this->request->getRequestParam('event_name');
-        $redirect_from = $this->request->getRequestParam('redirect_from', '', 'url');
-        // IF a registration was JUST added via the admin...
-        if ($EVT_ID && $event_name && $redirect_from) {
-            // then set a cookie so that we can block any attempts to use
-            // the back button as a way to enter another registration.
-            setcookie('ee_registration_added', $EVT_ID, time() + WEEK_IN_SECONDS, '/');
-            // and update the global
-            $_COOKIE['ee_registration_added'] = $EVT_ID;
-        }
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__(
-            'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__(
-            'An error occurred! Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['txn_status_array']        = self::$_txn_status;
-        EE_Registry::$i18n_js_strings['pay_status_array']        = self::$_pay_status;
-        EE_Registry::$i18n_js_strings['payments_total']          = esc_html__('Payments Total', 'event_espresso');
-        EE_Registry::$i18n_js_strings['transaction_overpaid']    = esc_html__(
-            'This transaction has been overpaid ! Payments Total',
-            'event_espresso'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-        // noop
-    }
-
-
-    public function admin_footer_scripts()
-    {
-        // noop
-    }
-
-
-    /**
-     * _set_transaction_status_array
-     * sets list of transaction statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_transaction_status_array()
-    {
-        self::$_txn_status = EEM_Transaction::instance()->status_array(true);
-    }
-
-
-    /**
-     * get_transaction_status_array
-     * return the transaction status array for wp_list_table
-     *
-     * @access public
-     * @return array
-     */
-    public function get_transaction_status_array()
-    {
-        return self::$_txn_status;
-    }
-
-
-    /**
-     *    get list of payment statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _get_payment_status_array()
-    {
-        self::$_pay_status                      = EEM_Payment::instance()->status_array(true);
-        $this->_template_args['payment_status'] = self::$_pay_status;
-    }
-
-
-    /**
-     *    _add_screen_options_default
-     *
-     * @access protected
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * load_scripts_styles
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles()
-    {
-        // enqueue style
-        wp_register_style(
-            'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_txn');
-        // scripts
-        wp_register_script(
-            'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.js',
-            [
-                'ee_admin_js',
-                'ee-datepicker',
-                'jquery-ui-datepicker',
-                'jquery-ui-draggable',
-                'ee-dialog',
-                'ee-accounting',
-                'ee-serialize-full-array',
-            ],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_txn');
-    }
-
-
-    /**
-     *    load_scripts_styles_view_transaction
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_view_transaction()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    load_scripts_styles_default
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_default()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    _set_list_table_views_default
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all'        => [
-                'slug'  => 'all',
-                'label' => esc_html__('View All Transactions', 'event_espresso'),
-                'count' => 0,
-            ],
-            'abandoned'  => [
-                'slug'  => 'abandoned',
-                'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
-                'count' => 0,
-            ],
-            'incomplete' => [
-                'slug'  => 'incomplete',
-                'label' => esc_html__('Incomplete Transactions', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-        if (
-            /**
-             * Filters whether a link to the "Failed Transactions" list table
-             * appears on the Transactions Admin Page list table.
-             * List display can be turned back on via the following:
-             * add_filter(
-             *     'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list',
-             *     '__return_true'
-             * );
-             *
-             * @param boolean                 $display_failed_txns_list
-             * @param Transactions_Admin_Page $this
-             * @since 4.9.70.p
-             */
-        apply_filters(
-            'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list',
-            false,
-            $this
-        )
-        ) {
-            $this->_views['failed'] = [
-                'slug'  => 'failed',
-                'label' => esc_html__('Failed Transactions', 'event_espresso'),
-                'count' => 0,
-            ];
-        }
-    }
-
-
-    /**
-     * _set_transaction_object
-     * This sets the _transaction property for the transaction details screen
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_transaction_object()
-    {
-        if ($this->_transaction instanceof EE_Transaction) {
-            return;
-        } //get out we've already set the object
-
-        $TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
-
-        // get transaction object
-        $this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $this->_session     = $this->_transaction instanceof EE_Transaction
-            ? $this->_transaction->session_data()
-            : null;
-        if ($this->_transaction instanceof EE_Transaction) {
-            $this->_transaction->verify_abandoned_transaction_status();
-        }
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            $error_msg = sprintf(
-                esc_html__(
-                    'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
-                    'event_espresso'
-                ),
-                $TXN_ID
-            );
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     *    _transaction_legend_items
-     *
-     * @access protected
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _transaction_legend_items()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $items = [];
-
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_global_messages',
-                'view_filtered_messages'
-            )
-        ) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (
-                is_array($related_for_icon)
-                && isset($related_for_icon['css_class'], $related_for_icon['label'])
-            ) {
-                $items['view_related_messages'] = [
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                ];
-            }
-        }
-
-        $items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
-            array_merge(
-                $items,
-                [
-                    'view_details'          => [
-                        'class' => 'dashicons dashicons-cart',
-                        'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-                    ],
-                    'view_invoice'          => [
-                        'class' => 'dashicons dashicons-media-spreadsheet',
-                        'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-                    ],
-                    'view_receipt'          => [
-                        'class' => 'dashicons dashicons-text-page',
-                        'desc'  => esc_html__('View Transaction Receipt', 'event_espresso'),
-                    ],
-                    'view_registration'     => [
-                        'class' => 'dashicons dashicons-clipboard',
-                        'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-                    ],
-                    'payment_overview_link' => [
-                        'class' => 'dashicons dashicons-money',
-                        'desc'  => esc_html__('Make Payment on Frontend', 'event_espresso'),
-                    ],
-                ]
-            )
-        );
-
-        if (
-            EEH_MSG_Template::is_mt_active('payment_reminder')
-            && $this->capabilities->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $items['send_payment_reminder'] = [
-                'class' => 'dashicons dashicons-email-alt',
-                'desc'  => esc_html__('Send Payment Reminder', 'event_espresso'),
-            ];
-        } else {
-            $items['blank*'] = [
-                'class' => '',
-                'desc'  => '',
-            ];
-        }
-        $more_items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
-            [
-                'overpaid'   => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::overpaid_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::overpaid_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-                'complete'   => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::complete_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::complete_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-                'incomplete' => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::incomplete_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::incomplete_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-                'abandoned'  => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::abandoned_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::abandoned_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-                'failed'     => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::failed_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::failed_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-            ]
-        );
-
-        return array_merge($items, $more_items);
-    }
-
-
-    /**
-     *    _transactions_overview_list_table
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _transactions_overview_list_table()
-    {
-        $this->_admin_page_title = esc_html__('Transactions', 'event_espresso');
-
-        $EVT_ID                                    = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $event                                     = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        $this->_template_args['admin_page_header'] = $event instanceof EE_Event
-            ? sprintf(
-                esc_html__('%sViewing Transactions for the Event: %s%s', 'event_espresso'),
-                '<h3>',
-                '<a href="'
-                . EE_Admin_Page::add_query_args_and_nonce(
-                    ['action' => 'edit', 'post' => $event->ID()],
-                    EVENTS_ADMIN_URL
-                )
-                . '" aria-label="'
-                . esc_attr__('Click to Edit event', 'event_espresso')
-                . '">' . $event->name() . '</a>',
-                '</h3>'
-            )
-            : '';
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *    _transaction_details
-     * generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _transaction_details()
-    {
-        do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
-
-        $this->_set_transaction_status_array();
-
-        $this->_template_args                      = [];
-        $this->_template_args['transactions_page'] = $this->_wp_page_slug;
-
-        $this->_set_transaction_object();
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            return;
-        }
-
-        $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
-        $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
-
-        $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
-        $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
-
-        $this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->status_ID() ];
-        $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
-        $this->_template_args['txn_status']['class'] = $this->_transaction->status_ID();
-
-        $txn_total  = $this->_transaction->total();
-        $total_paid = $this->_transaction->paid();
-        $amount_due = $txn_total - $total_paid;
-
-        $this->_template_args['grand_total'] = $txn_total;
-        $this->_template_args['total_paid']  = $total_paid;
-
-        $this->_template_args['amount_due']     = EEH_Template::format_currency($amount_due, false, false);
-        $this->_template_args['amount_due_raw'] = $amount_due;
-
-        $this->_template_args['amount_due_class'] = '';
-
-        if ($txn_total === (float) 0) {
-            // free event
-            $this->_template_args['amount_due'] = false;
-        } elseif ($amount_due < (float) 0) {
-            // overpaid
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        } elseif ($amount_due > (float) 0) {
-            // monies owing
-            $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn ee-txn-amount-owing';
-        } elseif ($total_paid === (float) 0) {
-            // no payments made yet
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        }
-
-        $payment_method = $this->_transaction->payment_method();
-
-        $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        // link back to overview
-        $this->_template_args['txn_overview_url'] = $this->request->getServerParam(
-            'HTTP_REFERER',
-            TXN_ADMIN_URL
-        );
-
-
-        // next link
-        $next_txn                                 = $this->_transaction->next(
-            null,
-            [['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
-            'TXN_ID'
-        );
-        $this->_template_args['next_transaction'] = $next_txn
-            ? $this->_next_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    ['action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']],
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-right ee-icon-size-22'
-            )
-            : '';
-        // previous link
-        $previous_txn                                 = $this->_transaction->previous(
-            null,
-            [['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
-            'TXN_ID'
-        );
-        $this->_template_args['previous_transaction'] = $previous_txn
-            ? $this->_previous_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    ['action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']],
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-left ee-icon-size-22'
-            )
-            : '';
-
-        $EVT_ID        = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $event_name    = $this->request->getRequestParam('event_name');
-        $redirect_from = $this->request->getRequestParam('redirect_from', '', 'url');
-
-        // were we just redirected here after adding a new registration ???
-        if ($EVT_ID && $event_name && $redirect_from) {
-            if (
-                $this->capabilities->current_user_can(
-                    'ee_edit_registrations',
-                    'espresso_registrations_new_registration',
-                    $EVT_ID
-                )
-            ) {
-                $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button--primary" href="';
-                $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'page'     => 'espresso_registrations',
-                        'action'   => 'new_registration',
-                        'return'   => 'default',
-                        'TXN_ID'   => $this->_transaction->ID(),
-                        'event_id' => $EVT_ID,
-                    ],
-                    REG_ADMIN_URL
-                );
-                $this->_admin_page_title .= '">';
-
-                $this->_admin_page_title .= sprintf(
-                    esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
-                    htmlentities(urldecode($event_name), ENT_QUOTES, 'UTF-8')
-                );
-                $this->_admin_page_title .= '</a>';
-            }
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // grab messages at the last second
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        // path to template
-        $template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
-        $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *        _transaction_details_metaboxes
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _transaction_details_metaboxes()
-    {
-        $this->_set_transaction_object();
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->addMetaBox(
-            'edit-txn-details-mbox',
-            '<span>' . esc_html__('Transaction Details', 'event_espresso')
-            . '&nbsp;<span class="dashicons dashicons-cart" ></span></span>',
-            [$this, 'txn_details_meta_box'],
-            $this->_wp_page_slug
-        );
-        $this->addMetaBox(
-            'edit-txn-attendees-mbox',
-            '<span>' . esc_html__('Attendees Registered in this Transaction', 'event_espresso')
-            . '&nbsp;<span class="dashicons dashicons-groups" ></span></span>',
-            [$this, 'txn_attendees_meta_box'],
-            $this->_wp_page_slug,
-            'normal',
-            'high',
-            ['TXN_ID' => $this->_transaction->ID()]
-        );
-        $this->addMetaBox(
-            'edit-txn-registrant-mbox',
-            esc_html__('Primary Contact', 'event_espresso'),
-            [$this, 'txn_registrant_side_meta_box'],
-            $this->_wp_page_slug,
-            'side'
-        );
-        $this->addMetaBox(
-            'edit-txn-billing-info-mbox',
-            esc_html__('Billing Information', 'event_espresso'),
-            [$this, 'txn_billing_info_side_meta_box'],
-            $this->_wp_page_slug,
-            'side'
-        );
-    }
-
-
-    /**
-     * Callback for transaction actions metabox.
-     *
-     * @param EE_Transaction|null $transaction
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function getActionButtons(EE_Transaction $transaction = null)
-    {
-        $content = '';
-        $actions = [];
-        if (! $transaction instanceof EE_Transaction) {
-            return $content;
-        }
-        /** @var EE_Registration $primary_registration */
-        $primary_registration = $transaction->primary_registration();
-        $attendee             = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : null;
-
-        if (
-            $attendee instanceof EE_Attendee
-            && $this->capabilities->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $actions['payment_reminder'] =
-                EEH_MSG_Template::is_mt_active('payment_reminder')
-                && $this->_transaction->status_ID() !== EEM_Transaction::complete_status_code
-                && $this->_transaction->status_ID() !== EEM_Transaction::overpaid_status_code
-                    ? EEH_Template::get_button_or_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'action'      => 'send_payment_reminder',
-                            'TXN_ID'      => $this->_transaction->ID(),
-                            'redirect_to' => 'view_transaction',
-                        ],
-                        TXN_ADMIN_URL
-                    ),
-                    esc_html__(' Send Payment Reminder', 'event_espresso'),
-                    'button button--secondary',
-                    'dashicons dashicons-email-alt'
-                )
-                    : '';
-        }
-
-        if (
-            $this->capabilities->current_user_can(
-                'ee_edit_payments',
-                'espresso_transactions_recalculate_line_items'
-            )
-        ) {
-            $actions['recalculate_line_items'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action'      => 'espresso_recalculate_line_items',
-                        'TXN_ID'      => $this->_transaction->ID(),
-                        'redirect_to' => 'view_transaction',
-                    ],
-                    TXN_ADMIN_URL
-                ),
-                esc_html__(' Recalculate Taxes and Total', 'event_espresso'),
-                'button button--secondary',
-                'dashicons dashicons-update'
-            );
-        }
-
-        if (
-            $primary_registration instanceof EE_Registration
-            && EEH_MSG_Template::is_mt_active('receipt')
-        ) {
-            $actions['receipt'] = EEH_Template::get_button_or_link(
-                $primary_registration->receipt_url(),
-                esc_html__('View Receipt', 'event_espresso'),
-                'button button--secondary',
-                'dashicons dashicons-text-page'
-            );
-        }
-
-        if (
-            $primary_registration instanceof EE_Registration
-            && EEH_MSG_Template::is_mt_active('invoice')
-        ) {
-            $actions['invoice'] = EEH_Template::get_button_or_link(
-                $primary_registration->invoice_url(),
-                esc_html__('View Invoice', 'event_espresso'),
-                'button button--secondary',
-                'dashicons dashicons-media-spreadsheet'
-            );
-        }
-        $actions = array_filter(
-            apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction)
-        );
-        if ($actions) {
-            $content .= implode('', $actions);
-        }
-        return $content;
-    }
-
-
-    /**
-     * txn_details_meta_box
-     * generates HTML for the Transaction main meta box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function txn_details_meta_box()
-    {
-        $this->_set_transaction_object();
-        $this->_template_args['TXN_ID']              = $this->_transaction->ID();
-        $this->_template_args['attendee']            =
-            $this->_transaction->primary_registration() instanceof EE_Registration
-                ? $this->_transaction->primary_registration()->attendee()
-                : null;
-        $this->_template_args['can_edit_payments']   = $this->capabilities->current_user_can(
-            'ee_edit_payments',
-            'apply_payment_or_refund_from_registration_details'
-        );
-        $this->_template_args['can_delete_payments'] = $this->capabilities->current_user_can(
-            'ee_delete_payments',
-            'delete_payment_from_registration_details'
-        );
-
-        // get line table
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display                       = new EE_Line_Item_Display(
-            'admin_table',
-            'EE_Admin_Table_Line_Item_Display_Strategy'
-        );
-        $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item(
-            $this->_transaction->total_line_item()
-        );
-        $this->_template_args['REG_code']        =
-            $this->_transaction->primary_registration() instanceof EE_Registration
-                ? $this->_transaction->primary_registration()->reg_code()
-                : null;
-        // process taxes
-        $taxes                         = $this->_transaction->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
-        $this->_template_args['taxes'] = ! empty($taxes)
-            ? $taxes
-            : false;
-
-        $this->_template_args['grand_total']     = EEH_Template::format_currency(
-            $this->_transaction->total(),
-            false,
-            false
-        );
-        $this->_template_args['grand_raw_total'] = $this->_transaction->total();
-        $this->_template_args['TXN_status']      = $this->_transaction->status_ID();
-
-        // process payment details
-        $payments = $this->_transaction->payments();
-        if (! empty($payments)) {
-            $this->_template_args['payments']              = $payments;
-            $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
-        } else {
-            $this->_template_args['payments']              = false;
-            $this->_template_args['existing_reg_payments'] = [];
-        }
-
-        $this->_template_args['edit_payment_url']   = add_query_arg(['action' => 'edit_payment'], TXN_ADMIN_URL);
-        $this->_template_args['delete_payment_url'] = add_query_arg(
-            ['action' => 'espresso_delete_payment'],
-            TXN_ADMIN_URL
-        );
-
-        if (isset($txn_details['invoice_number'])) {
-            $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
-            $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__(
-                'Invoice Number',
-                'event_espresso'
-            );
-        }
-
-        $this->_template_args['txn_details']['registration_session']['value'] =
-            $this->_transaction->primary_registration() instanceof EE_Registration
-                ? $this->_transaction->primary_registration()->session_ID()
-                : null;
-        $this->_template_args['txn_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-
-        $this->_template_args['txn_details']['ip_address']['value'] = $this->_session['ip_address'] ?? '';
-        $this->_template_args['txn_details']['ip_address']['label'] = esc_html__(
-            'Transaction placed from IP',
-            'event_espresso'
-        );
-
-        $this->_template_args['txn_details']['user_agent']['value'] = $this->_session['user_agent'] ?? '';
-        $this->_template_args['txn_details']['user_agent']['label'] = esc_html__(
-            'Registrant User Agent',
-            'event_espresso'
-        );
-
-        $reg_steps = '<div class="ee-txn-reg-step-status-steps ee-layout-row">';
-        foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
-            if ($reg_step_status === true) {
-                $reg_steps .= '<div class="ee-status-pill ee-status-bg--success">'
-                              . sprintf(
-                                  esc_html__('%1$s : Completed', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step))
-                              )
-                              . '</div>';
-            } elseif ($reg_step_status !== false && is_numeric($reg_step_status)) {
-                $reg_steps .= '<div class="ee-status-pill ee-status-bg--attention">'
-                              . sprintf(
-                                  esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step)),
-                                  date(
-                                      get_option('date_format') . ' ' . get_option('time_format'),
-                                      $reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-                                  )
-                              )
-                              . '</div>';
-            } else {
-                $reg_steps .= '<div class="ee-status-pill ee-status-bg--error">'
-                              . sprintf(
-                                  esc_html__('%1$s : Never Initiated', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step))
-                              )
-                              . '</div>';
-            }
-        }
-        $reg_steps                                                 .= '</ul>';
-        $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
-        $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
-            'Registration Step Progress',
-            'event_espresso'
-        );
-
-
-        $this->_get_registrations_to_apply_payment_to();
-        $this->_get_payment_methods($payments);
-        $this->_get_payment_status_array();
-        $this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction.
-
-        $this->_template_args['transaction_form_url']    = add_query_arg(
-            [
-                'action'  => 'edit_transaction',
-                'process' => 'transaction',
-            ],
-            TXN_ADMIN_URL
-        );
-        $this->_template_args['apply_payment_form_url']  = add_query_arg(
-            [
-                'page'   => 'espresso_transactions',
-                'action' => 'espresso_apply_payment',
-            ],
-            TXN_ADMIN_URL
-        );
-        $this->_template_args['delete_payment_form_url'] = add_query_arg(
-            [
-                'page'   => 'espresso_transactions',
-                'action' => 'espresso_delete_payment',
-            ],
-            TXN_ADMIN_URL
-        );
-
-        $this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction);
-
-        // 'espresso_delete_payment_nonce'
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * _get_registration_payment_IDs
-     *    generates an array of Payment IDs and their corresponding Registration IDs
-     *
-     * @access protected
-     * @param EE_Payment[] $payments
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_registration_payment_IDs($payments = [])
-    {
-        $existing_reg_payments = [];
-        // get all reg payments for these payments
-        $reg_payments = EEM_Registration_Payment::instance()->get_all(
-            [
-                [
-                    'PAY_ID' => [
-                        'IN',
-                        array_keys($payments),
-                    ],
-                ],
-            ]
-        );
-        if (! empty($reg_payments)) {
-            foreach ($payments as $payment) {
-                if (! $payment instanceof EE_Payment) {
-                    continue;
-                } elseif (! isset($existing_reg_payments[ $payment->ID() ])) {
-                    $existing_reg_payments[ $payment->ID() ] = [];
-                }
-                foreach ($reg_payments as $reg_payment) {
-                    if (
-                        $reg_payment instanceof EE_Registration_Payment
-                        && $reg_payment->payment_ID() === $payment->ID()
-                    ) {
-                        $existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID();
-                    }
-                }
-            }
-        }
-
-        return $existing_reg_payments;
-    }
-
-
-    /**
-     * _get_registrations_to_apply_payment_to
-     *    generates HTML for displaying a series of checkboxes in the admin payment modal window
-     * which allows the admin to only apply the payment to the specific registrations
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_registrations_to_apply_payment_to()
-    {
-        // we want any registration with an active status (ie: not deleted or cancelled)
-        $query_params                      = [
-            [
-                'STS_ID' => [
-                    'IN',
-                    [
-                        EEM_Registration::status_id_approved,
-                        EEM_Registration::status_id_pending_payment,
-                        EEM_Registration::status_id_not_approved,
-                    ],
-                ],
-            ],
-        ];
-        $registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div(
-                '',
-                'txn-admin-apply-payment-to-registrations-dv',
-                '',
-                'clear: both; margin: 1.5em 0 0; display: none;'
-            );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
-        $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl striped');
-        $registrations_to_apply_payment_to .= EEH_HTML::thead(
-            EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
-            )
-        );
-        $registrations_to_apply_payment_to .= EEH_HTML::tbody();
-        // get registrations for TXN
-        $registrations         = $this->_transaction->registrations($query_params);
-        $existing_reg_payments = $this->_template_args['existing_reg_payments'];
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $attendee_name                     = $registration->attendee() instanceof EE_Attendee
-                    ? $registration->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $owing                             = $registration->final_price() - $registration->paid();
-                $taxable                           = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
-                    : '';
-                $checked                           = empty($existing_reg_payments)
-                                                     || in_array($registration->ID(), $existing_reg_payments, true)
-                    ? ' checked'
-                    : '';
-                $disabled                          = $registration->final_price() > 0
-                    ? ''
-                    : ' disabled';
-                $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
-                    EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
-                    EEH_HTML::td(
-                        EEH_Template::format_currency($owing),
-                        '',
-                        'txn-admin-payment-owing-td jst-cntr'
-                    ) .
-                    EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
-                        . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
-                        '',
-                        'jst-cntr'
-                    ),
-                    'apply-payment-registration-row-' . $registration->ID()
-                );
-            }
-        }
-        $registrations_to_apply_payment_to                         .= EEH_HTML::tbodyx();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::tablex();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::divx();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::p(
-            esc_html__(
-                'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
-                'event_espresso'
-            ),
-            '',
-            'clear description'
-        );
-        $registrations_to_apply_payment_to                         .= EEH_HTML::divx();
-        $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
-    }
-
-
-    /**
-     * _get_reg_status_selection
-     *
-     * @return void
-     * @throws EE_Error
-     * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
-     *         instead of events.
-     * @access protected
-     */
-    protected function _get_reg_status_selection()
-    {
-        // first get all possible statuses
-        $statuses = EEM_Registration::reg_status_array([], true);
-        // let's add a "don't change" option.
-        $status_array['NAN']                                 = esc_html__('Leave the Same', 'event_espresso');
-        $status_array                                        = array_merge($status_array, $statuses);
-        $this->_template_args['status_change_select']        = EEH_Form_Fields::select_input(
-            'txn_reg_status_change[reg_status]',
-            $status_array,
-            'NAN',
-            'id="txn-admin-payment-reg-status-inp"',
-            'txn-reg-status-change-reg-status'
-        );
-        $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input(
-            'delete_txn_reg_status_change[reg_status]',
-            $status_array,
-            'NAN',
-            'delete-txn-admin-payment-reg-status-inp',
-            'delete-txn-reg-status-change-reg-status'
-        );
-    }
-
-
-    /**
-     *    _get_payment_methods
-     * Gets all the payment methods available generally, or the ones that are already
-     * selected on these payments (in case their payment methods are no longer active).
-     * Has the side-effect of updating the template args' payment_methods item
-     *
-     * @access private
-     * @param EE_Payment[] to show on this page
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _get_payment_methods($payments = [])
-    {
-        $payment_methods_of_payments = [];
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment) {
-                $payment_methods_of_payments[] = $payment->ID();
-            }
-        }
-        if ($payment_methods_of_payments) {
-            $query_args = [
-                [
-                    'OR*payment_method_for_payment' => [
-                        'PMD_ID'    => ['IN', $payment_methods_of_payments],
-                        'PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%'],
-                    ],
-                ],
-            ];
-        } else {
-            $query_args = [['PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%']]];
-        }
-        $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
-    }
-
-
-    /**
-     * txn_attendees_meta_box
-     *    generates HTML for the Attendees Transaction main meta box
-     *
-     * @access public
-     * @param WP_Post $post
-     * @param array   $metabox
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_attendees_meta_box($post, $metabox = ['args' => []])
-    {
-        /** @noinspection NonSecureExtractUsageInspection */
-        extract($metabox['args']);
-        $this->_template_args['post']            = $post;
-        $this->_template_args['event_attendees'] = [];
-        // process items in cart
-        $line_items = $this->_transaction->get_many_related(
-            'Line_Item',
-            [['LIN_type' => 'line-item']]
-        );
-        if (! empty($line_items)) {
-            foreach ($line_items as $item) {
-                if ($item instanceof EE_Line_Item) {
-                    switch ($item->OBJ_type()) {
-                        case 'Event':
-                            break;
-                        case 'Ticket':
-                            $ticket = $item->ticket();
-                            // right now we're only handling tickets here.
-                            // Cause its expected that only tickets will have attendees right?
-                            if (! $ticket instanceof EE_Ticket) {
-                                break;
-                            }
-                            try {
-                                $event_name = $ticket->get_event_name();
-                            } catch (Exception $e) {
-                                EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                                $event_name = esc_html__('Unknown Event', 'event_espresso');
-                            }
-                            $event_name   .= ' - ' . $item->name();
-                            $ticket_price = EEH_Template::format_currency($item->unit_price());
-                            // now get all of the registrations for this transaction that use this ticket
-                            $registrations = $ticket->registrations(
-                                [['TXN_ID' => $this->_transaction->ID()]]
-                            );
-                            foreach ($registrations as $registration) {
-                                if (! $registration instanceof EE_Registration) {
-                                    break;
-                                }
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID']
-                                    = $registration->status_ID();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['att_num']
-                                    = $registration->count();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name']
-                                    = $event_name;
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price']
-                                    = $ticket_price;
-                                // attendee info
-                                $attendee = $registration->get_first_related('Attendee');
-                                if ($attendee instanceof EE_Attendee) {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id']
-                                        = $attendee->ID();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee']
-                                        = $attendee->full_name();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email']
-                                        = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
-                                          . esc_html__(
-                                              ' Event',
-                                              'event_espresso'
-                                          )
-                                          . '">' . $attendee->email() . '</a>';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address']
-                                        = EEH_Address::format($attendee, 'inline', false, false);
-                                } else {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id']   = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email']    = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address']  = '';
-                                }
-                            }
-                            break;
-                    }
-                }
-            }
-
-            $this->_template_args['transaction_form_url'] = add_query_arg(
-                [
-                    'action'  => 'edit_transaction',
-                    'process' => 'attendees',
-                ],
-                TXN_ADMIN_URL
-            );
-            echo EEH_Template::display_template(
-                TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
-                $this->_template_args,
-                true
-            );
-        } else {
-            printf(
-                esc_html__(
-                    '%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
-                    'event_espresso'
-                ),
-                '<p class="important-notice">',
-                '</p>'
-            );
-        }
-    }
-
-
-    /**
-     * txn_registrant_side_meta_box
-     * generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_registrant_side_meta_box()
-    {
-        $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
-            ? $this->_transaction->primary_registration()->get_first_related('Attendee')
-            : null;
-        if (! $primary_att instanceof EE_Attendee) {
-            $this->_template_args['no_attendee_message'] = esc_html__(
-                'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
-                'event_espresso'
-            );
-            $primary_att                                 = EEM_Attendee::instance()->create_default_object();
-        }
-        $this->_template_args['ATT_ID']            = $primary_att->ID();
-        $this->_template_args['prime_reg_fname']   = $primary_att->fname();
-        $this->_template_args['prime_reg_lname']   = $primary_att->lname();
-        $this->_template_args['prime_reg_email']   = $primary_att->email();
-        $this->_template_args['prime_reg_phone']   = $primary_att->phone();
-        $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action' => 'edit_attendee',
-                'post'   => $primary_att->ID(),
-            ],
-            REG_ADMIN_URL
-        );
-        // get formatted address for registrant
-        $formatted_address                         = EEH_Address::format($primary_att);
-        $formatted_address                         =
-            $formatted_address !== '<div class="espresso-address-dv"><div></div></div>'
-                ? $formatted_address
-                : '';
-        $this->_template_args['formatted_address'] = $formatted_address;
-        echo EEH_Template::display_template(
-            TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * txn_billing_info_side_meta_box
-     *    generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function txn_billing_info_side_meta_box()
-    {
-        $this->_template_args['billing_form']     = $this->_transaction->billing_info();
-        $this->_template_args['billing_form_url'] = add_query_arg(
-            ['action' => 'edit_transaction', 'process' => 'billing'],
-            TXN_ADMIN_URL
-        );
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * apply_payments_or_refunds
-     *    registers a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function apply_payments_or_refunds()
-    {
-        $valid_data = $this->_validate_payment_request_data();
-        $has_access = $this->capabilities->current_user_can(
-            'ee_edit_payments',
-            'apply_payment_or_refund_from_registration_details'
-        );
-        $TXD_ID     = $this->request->getRequestParam('txn_admin_payment[TXN_ID]', 0, 'int');
-        $amount     = 0;
-        if (! empty($valid_data) && $has_access) {
-            $PAY_ID = $valid_data['PAY_ID'];
-            // save  the new payment
-            $payment = $this->_create_payment_from_request_data($valid_data);
-            $amount  = $payment->amount();
-            // get the TXN for this payment
-            $transaction = $payment->transaction();
-            // verify transaction
-            if ($transaction instanceof EE_Transaction) {
-                // calculate_total_payments_and_update_status
-                $this->_process_transaction_payments($transaction);
-                $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
-                $this->_remove_existing_registration_payments($payment, $PAY_ID);
-                // apply payment to registrations (if applicable)
-                if (! empty($REG_IDs)) {
-                    $this->_update_registration_payments($transaction, $payment, $REG_IDs);
-                    $this->_maybe_send_notifications();
-                    // now process status changes for the same registrations
-                    $this->_process_registration_status_change($transaction, $REG_IDs);
-                }
-                $this->_maybe_send_notifications($payment);
-                // prepare to render page
-                do_action(
-                    'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording',
-                    $transaction,
-                    $payment
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Transaction for this payment could not be retrieved.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } elseif ($has_access) {
-            EE_Error::add_error(
-                esc_html__(
-                    'The payment form data could not be processed. Please try again.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'You do not have access to apply payments or refunds to a registration.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $query_args = [
-            'page'   => 'espresso_transactions',
-            'action' => 'view_transaction',
-            'TXN_ID' => $TXD_ID,
-        ];
-
-        $this->_redirect_after_action(
-            ! EE_Error::has_error(),
-            $amount > 0
-                ? esc_html__('payment', 'event_espresso')
-                : esc_html__('refund', 'event_espresso'),
-            esc_html__('processed', 'event_espresso'),
-            $query_args
-        );
-    }
-
-
-    /**
-     * _validate_payment_request_data
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _validate_payment_request_data()
-    {
-        if (! $this->request->requestParamIsSet('txn_admin_payment')) {
-            return [];
-        }
-        $payment_form = $this->_generate_payment_form_section();
-        try {
-            if ($payment_form->was_submitted()) {
-                $payment_form->receive_form_submission();
-                if (! $payment_form->is_valid()) {
-                    $submission_error_messages = [];
-                    foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
-                        if ($validation_error instanceof EE_Validation_Error) {
-                            $form_input                  = $validation_error->get_form_section();
-                            $submission_error_messages[] = sprintf(
-                                _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
-                                $form_input instanceof EE_Form_Input_Base
-                                    ? $form_input->html_label_text()
-                                    : '',
-                                $validation_error->getMessage()
-                            );
-                        }
-                    }
-                    EE_Error::add_error(
-                        implode('<br />', $submission_error_messages),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return [];
-                }
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return [];
-        }
-
-        return $payment_form->valid_data();
-    }
-
-
-    /**
-     * _generate_payment_form_section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _generate_payment_form_section()
-    {
-        return new EE_Form_Section_Proper(
-            [
-                'name'        => 'txn_admin_payment',
-                'subsections' => [
-                    'PAY_ID'          => new EE_Text_Input(
-                        [
-                            'default'               => 0,
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
-                            'validation_strategies' => [new EE_Int_Normalization()],
-                        ]
-                    ),
-                    'TXN_ID'          => new EE_Text_Input(
-                        [
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
-                            'validation_strategies' => [new EE_Int_Normalization()],
-                        ]
-                    ),
-                    'type'            => new EE_Text_Input(
-                        [
-                            'default'               => 1,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
-                            'validation_strategies' => [new EE_Int_Normalization()],
-                        ]
-                    ),
-                    'amount'          => new EE_Text_Input(
-                        [
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
-                            'validation_strategies' => [new EE_Float_Normalization()],
-                        ]
-                    ),
-                    'status'          => new EE_Text_Input(
-                        [
-                            'default'         => EEM_Payment::status_id_approved,
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment status', 'event_espresso'),
-                        ]
-                    ),
-                    'PMD_ID'          => new EE_Text_Input(
-                        [
-                            'default'               => 2,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
-                            'validation_strategies' => [new EE_Int_Normalization()],
-                        ]
-                    ),
-                    'date'            => new EE_Text_Input(
-                        [
-                            'default'         => time(),
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment date', 'event_espresso'),
-                        ]
-                    ),
-                    'txn_id_chq_nmbr' => new EE_Text_Input(
-                        [
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
-                            'validation_strategies' => [
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ],
-                        ]
-                    ),
-                    'po_number'       => new EE_Text_Input(
-                        [
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
-                            'validation_strategies' => [
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ],
-                        ]
-                    ),
-                    'accounting'      => new EE_Text_Input(
-                        [
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
-                            'validation_strategies' => [
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ],
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * _create_payment_from_request_data
-     *
-     * @param array $valid_data
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _create_payment_from_request_data($valid_data)
-    {
-        $PAY_ID = $valid_data['PAY_ID'];
-        // get payment amount
-        $amount = $valid_data['amount']
-            ? abs($valid_data['amount'])
-            : 0;
-        // payments have a type value of 1 and refunds have a type value of -1
-        // so multiplying amount by type will give a positive value for payments, and negative values for refunds
-        $amount = $valid_data['type'] < 0
-            ? $amount * -1
-            : $amount;
-        // for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
-        $date    = $valid_data['date']
-            ? preg_replace('/\s+/', ' ', $valid_data['date'])
-            : date('Y-m-d g:i a', current_time('timestamp'));
-        $payment = EE_Payment::new_instance(
-            [
-                'TXN_ID'              => $valid_data['TXN_ID'],
-                'STS_ID'              => $valid_data['status'],
-                'PAY_timestamp'       => $date,
-                'PAY_source'          => EEM_Payment_Method::scope_admin,
-                'PMD_ID'              => $valid_data['PMD_ID'],
-                'PAY_amount'          => $amount,
-                'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
-                'PAY_po_number'       => $valid_data['po_number'],
-                'PAY_extra_accntng'   => $valid_data['accounting'],
-                'PAY_details'         => $valid_data,
-                'PAY_ID'              => $PAY_ID,
-            ],
-            '',
-            ['Y-m-d', 'g:i a']
-        );
-
-        if (! $payment->save()) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
-                    $payment->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        return $payment;
-    }
-
-
-    /**
-     * _process_transaction_payments
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_transaction_payments(EE_Transaction $transaction)
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        // update the transaction with this payment
-        if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_success(
-                esc_html__(
-                    'The payment has been processed successfully.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'The payment was processed successfully but the amount paid for the transaction was not updated.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * _get_REG_IDs_to_apply_payment_to
-     * returns a list of registration IDs that the payment will apply to
-     *
-     * @param EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
-    {
-        // grab array of IDs for specific registrations to apply changes to
-        $apply_to_all = $this->request->getRequestParam(
-            'txn_admin_payment[apply_to_all_registrations]',
-            false,
-            DataType::BOOL
-        );
-        $REG_IDs      = ! $apply_to_all
-            ? $this->request->getRequestParam(
-                'txn_admin_payment[registrations]',
-                [],
-                DataType::INT,
-                true
-            )
-            : [];
-        // nothing specified ? then get all reg IDs
-        if ($apply_to_all || empty($REG_IDs)) {
-            $registrations = $payment->transaction()->registrations();
-            $REG_IDs       = ! empty($registrations)
-                ? array_keys($registrations)
-                : $this->_get_existing_reg_payment_REG_IDs($payment);
-        }
-        // ensure that REG_IDs are integers and NOT strings
-        return array_map('absint', $REG_IDs);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function existing_reg_payment_REG_IDs()
-    {
-        return $this->_existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * @param array $existing_reg_payment_REG_IDs
-     */
-    public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
-    {
-        $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * _get_existing_reg_payment_REG_IDs
-     * returns a list of registration IDs that the payment is currently related to
-     * as recorded in the database
-     *
-     * @param EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
-    {
-        if ($this->existing_reg_payment_REG_IDs() === null) {
-            // let's get any existing reg payment records for this payment
-            $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
-            // but we only want the REG IDs, so grab the array keys
-            $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs)
-                ? array_keys($existing_reg_payment_REG_IDs)
-                : [];
-            $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
-        }
-
-        return $this->existing_reg_payment_REG_IDs();
-    }
-
-
-    /**
-     * _remove_existing_registration_payments
-     * this calculates the difference between existing relations
-     * to the supplied payment and the new list registration IDs,
-     * removes any related registrations that no longer apply,
-     * and then updates the registration paid fields
-     *
-     * @param EE_Payment $payment
-     * @param int        $PAY_ID
-     * @return bool;
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
-    {
-        // newly created payments will have nothing recorded for $PAY_ID
-        if (absint($PAY_ID) === 0) {
-            return false;
-        }
-        $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-        if (empty($existing_reg_payment_REG_IDs)) {
-            return false;
-        }
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-
-        return $transaction_payments->delete_registration_payments_and_update_registrations(
-            $payment,
-            [
-                [
-                    'PAY_ID' => $payment->ID(),
-                    'REG_ID' => ['IN', $existing_reg_payment_REG_IDs],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * _update_registration_payments
-     * this applies the payments to the selected registrations
-     * but only if they have not already been paid for
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param array          $REG_IDs
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        $REG_IDs = []
-    ) {
-        // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
-        // so let's do that using our set of REG_IDs from the form
-        $registration_query_where_params = [
-            'REG_ID' => ['IN', $REG_IDs],
-        ];
-        // but add in some conditions regarding payment,
-        // so that we don't apply payments to registrations that are free or have already been paid for
-        // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
-        if (! $payment->is_a_refund()) {
-            $registration_query_where_params['REG_final_price']  = ['!=', 0];
-            $registration_query_where_params['REG_final_price*'] = ['!=', 'REG_paid', true];
-        }
-        $registrations = $transaction->registrations([$registration_query_where_params]);
-        if (! empty($registrations)) {
-            /** @type EE_Payment_Processor $payment_processor */
-            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-            $payment_processor->process_registration_payments($transaction, $payment, $registrations);
-        }
-    }
-
-
-    /**
-     * _process_registration_status_change
-     * This processes requested registration status changes for all the registrations
-     * on a given transaction and (optionally) sends out notifications for the changes.
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $REG_IDs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = [], $reg_status = '')
-    {
-        // first if there is no change in status then we get out.
-        $reg_status = $reg_status
-            ?: $this->request->getRequestParam('txn_reg_status_change[reg_status]', 'NAN');
-        if ($reg_status === 'NAN') {
-            // no error message, no change requested, just nothing to do man.
-            return false;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        // made it here dude?  Oh WOW.  K, let's take care of changing the statuses
-        return $transaction_processor->manually_update_registration_statuses(
-            $transaction,
-            $reg_status,
-            [['REG_ID' => ['IN', $REG_IDs]]]
-        );
-    }
-
-
-    /**
-     * _build_payment_json_response
-     *
-     * @access public
-     * @param EE_Payment  $payment
-     * @param array       $REG_IDs
-     * @param bool | null $delete_txn_reg_status_change
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _build_payment_json_response(
-        EE_Payment $payment,
-        $REG_IDs = [],
-        $delete_txn_reg_status_change = null
-    ) {
-        // was the payment deleted ?
-        if (is_bool($delete_txn_reg_status_change)) {
-            return [
-                'PAY_ID'                       => $payment->ID(),
-                'amount'                       => $payment->amount(),
-                'total_paid'                   => $payment->transaction()->paid(),
-                'txn_status'                   => $payment->transaction()->status_ID(),
-                'pay_status'                   => $payment->STS_ID(),
-                'registrations'                => $this->_registration_payment_data_array($REG_IDs),
-                'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
-            ];
-        }
-
-        $this->_get_payment_status_array();
-        $payment_method = $payment->payment_method();
-        return [
-            'amount'           => $payment->amount(),
-            'total_paid'       => $payment->transaction()->paid(),
-            'txn_status'       => $payment->transaction()->status_ID(),
-            'pay_status'       => $payment->STS_ID(),
-            'PAY_ID'           => $payment->ID(),
-            'STS_ID'           => $payment->STS_ID(),
-            'status'           => self::$_pay_status[ $payment->STS_ID() ],
-            'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
-            'method'           => strtoupper($payment->source()),
-            'PM_ID'            => $payment_method instanceof EE_Payment_Method
-                ? $payment_method->ID()
-                : 1,
-            'gateway'          => $payment_method instanceof EE_Payment_Method
-                ? $payment_method->admin_name()
-                : esc_html__('Unknown', 'event_espresso'),
-            'gateway_response' => $payment->gateway_response(),
-            'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
-            'po_number'        => $payment->po_number(),
-            'extra_accntng'    => $payment->extra_accntng(),
-            'registrations'    => $this->_registration_payment_data_array($REG_IDs),
-        ];
-    }
-
-
-    /**
-     * delete_payment
-     *    delete a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_payment()
-    {
-        $TXD_ID = $this->request->getRequestParam('delete_txn_admin_payment[TXN_ID]', 0, 'int');
-        // $json_response_data = ['return_data' => false];
-        $PAY_ID     = $this->request->getRequestParam('delete_txn_admin_payment[PAY_ID]', 0, 'int');
-        $amount     = 0;
-        $can_delete = $this->capabilities->current_user_can(
-            'ee_delete_payments',
-            'delete_payment_from_registration_details'
-        );
-        if ($PAY_ID && $can_delete) {
-            $delete_txn_reg_status_change = $this->request->getRequestParam('delete_txn_reg_status_change[reg_status]');
-            $payment                      = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            if ($payment instanceof EE_Payment) {
-                $amount  = $payment->amount();
-                $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
-                    if ($delete_txn_reg_status_change) {
-                        $this->_maybe_send_notifications();
-                        $this->_process_registration_status_change(
-                            $payment->transaction(),
-                            $REG_IDs,
-                            $delete_txn_reg_status_change
-                        );
-                    }
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } elseif ($can_delete) {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid Payment ID was not received, therefore payment form data could not be loaded.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'You do not have access to delete a payment.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $query_args = [
-            'page'   => 'espresso_transactions',
-            'action' => 'view_transaction',
-            'TXN_ID' => $TXD_ID,
-        ];
-        $this->_redirect_after_action(
-            ! EE_Error::has_error(),
-            $amount > 0
-                ? esc_html__('payment', 'event_espresso')
-                : esc_html__('refund', 'event_espresso'),
-            esc_html__('deleted', 'event_espresso'),
-            $query_args
-        );
-    }
-
-
-    /**
-     * _registration_payment_data_array
-     * adds info for 'owing' and 'paid' for each registration to the json response
-     *
-     * @access protected
-     * @param array $REG_IDs
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _registration_payment_data_array($REG_IDs)
-    {
-        $registration_payment_data = [];
-        // if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
-        if (! empty($REG_IDs)) {
-            $registrations = EEM_Registration::instance()->get_all([['REG_ID' => ['IN', $REG_IDs]]]);
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    $registration_payment_data[ $registration->ID() ] = [
-                        'paid'  => $registration->pretty_paid(),
-                        'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
-                    ];
-                }
-            }
-        }
-
-        return $registration_payment_data;
-    }
-
-
-    /**
-     * _maybe_send_notifications
-     * determines whether or not the admin has indicated that notifications should be sent.
-     * If so, will toggle a filter switch for delivering registration notices.
-     * If passed an EE_Payment object, then it will trigger payment notifications instead.
-     *
-     * @access protected
-     * @param EE_Payment | null $payment
-     */
-    protected function _maybe_send_notifications($payment = null)
-    {
-        switch ($payment instanceof EE_Payment) {
-            // payment notifications
-            case true:
-                if ($this->request->getRequestParam('txn_payments[send_notifications]', false, 'bool')) {
-                    $this->_process_payment_notification($payment);
-                }
-                break;
-            // registration notifications
-            case false:
-                if ($this->request->getRequestParam('txn_reg_status_change[send_notifications]', false, 'bool')) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                }
-                break;
-        }
-    }
-
-
-    /**
-     * _send_payment_reminder
-     *    generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _send_payment_reminder()
-    {
-        $TXN_ID      = $this->request->getRequestParam('TXN_ID', 0, 'int');
-        $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $redirect_to = $this->request->getRequestParam('redirect_to');
-        $query_args  = $redirect_to
-            ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,]
-            : [];
-        do_action(
-            'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            $transaction
-        );
-        $this->_redirect_after_action(
-            false,
-            esc_html__('payment reminder', 'event_espresso'),
-            esc_html__('sent', 'event_espresso'),
-            $query_args,
-            true
-        );
-    }
-
-
-    /**
-     *  get_transactions
-     *    get transactions for given parameters (used by list table)
-     *
-     * @param int     $per_page how many transactions displayed per page
-     * @param boolean $count    return the count or objects
-     * @param string  $view
-     * @return EE_Transaction[]|int int = count || array of transaction objects
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_transactions($per_page, $count = false, $view = '')
-    {
-        $start_date = wp_strip_all_tags(
-            $this->request->getRequestParam('txn-filter-start-date', date('m/d/Y', strtotime('-10 year')))
-        );
-        $end_date   = wp_strip_all_tags(
-            $this->request->getRequestParam('txn-filter-end-date', date('m/d/Y'))
-        );
-
-        // make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-
-
-        // convert to timestamps
-        $start_date = strtotime($start_date);
-        $end_date   = strtotime($end_date);
-
-        // makes sure start date is the lowest value and vice versa
-        $start_date = min($start_date, $end_date);
-        $end_date   = max($start_date, $end_date);
-
-        // convert to correct format for query
-        $start_date = EEM_Transaction::instance()->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', $start_date),
-            'Y-m-d H:i:s'
-        );
-        $end_date   = EEM_Transaction::instance()->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', $end_date),
-            'Y-m-d H:i:s'
-        );
-
-
-        // set orderby
-        $orderby = $this->request->getRequestParam('orderby');
-
-        switch ($orderby) {
-            case 'TXN_ID':
-                break;
-            case 'ATT_fname':
-                $orderby = 'Registration.Attendee.ATT_fname';
-                break;
-            case 'event_name':
-                $orderby = 'Registration.Event.EVT_name';
-                break;
-            default: // 'TXN_timestamp'
-                $orderby = 'TXN_timestamp';
-        }
-
-        $sort         = $this->request->getRequestParam('order', 'DESC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-
-        $per_page = absint($per_page)
-            ? $per_page
-            : 10;
-        $per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $_where = [
-            'TXN_timestamp'          => ['BETWEEN', [$start_date, $end_date]],
-            'Registration.REG_count' => 1,
-        ];
-
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        if ($EVT_ID) {
-            $_where['Registration.EVT_ID'] = $EVT_ID;
-        }
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term  = '%' . $search_term . '%';
-            $_where['OR'] = [
-                'Registration.Event.EVT_name'         => ['LIKE', $search_term],
-                'Registration.Event.EVT_desc'         => ['LIKE', $search_term],
-                'Registration.Event.EVT_short_desc'   => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_full_name' => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_fname'     => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_lname'     => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_short_bio' => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_email'     => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_address'   => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_address2'  => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_city'      => ['LIKE', $search_term],
-                'Registration.REG_final_price'        => ['LIKE', $search_term],
-                'Registration.REG_code'               => ['LIKE', $search_term],
-                'Registration.REG_count'              => ['LIKE', $search_term],
-                'Registration.REG_group_size'         => ['LIKE', $search_term],
-                'Registration.Ticket.TKT_name'        => ['LIKE', $search_term],
-                'Registration.Ticket.TKT_description' => ['LIKE', $search_term],
-                'Payment.PAY_source'                  => ['LIKE', $search_term],
-                'Payment.Payment_Method.PMD_name'     => ['LIKE', $search_term],
-                'TXN_session_data'                    => ['LIKE', $search_term],
-                'Payment.PAY_txn_id_chq_nmbr'         => ['LIKE', $search_term],
-            ];
-        }
-
-        $status = $this->request->getRequestParam('status');
-        // failed transactions
-        $failed     = (! empty($status) && $status === 'failed' && ! $count) || ($count && $view === 'failed');
-        $abandoned  = (! empty($status) && $status === 'abandoned' && ! $count) || ($count && $view === 'abandoned');
-        $incomplete = (! empty($status) && $status === 'incomplete' && ! $count) || ($count && $view === 'incomplete');
-
-        if ($failed) {
-            $_where['STS_ID'] = EEM_Transaction::failed_status_code;
-        } elseif ($abandoned) {
-            $_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
-        } elseif ($incomplete) {
-            $_where['STS_ID'] = EEM_Transaction::incomplete_status_code;
-        } else {
-            $_where['STS_ID']  = ['!=', EEM_Transaction::failed_status_code];
-            $_where['STS_ID*'] = ['!=', EEM_Transaction::abandoned_status_code];
-        }
-
-        $query_params = apply_filters(
-            'FHEE__Transactions_Admin_Page___get_transactions_query_params',
-            [
-                $_where,
-                'order_by'                 => [$orderby => $sort],
-                'limit'                    => $limit,
-                'default_where_conditions' => EEM_Base::default_where_conditions_this_only,
-            ],
-            $this->request->requestParams(),
-            $view,
-            $count
-        );
-
-        return $count
-            ? EEM_Transaction::instance()->count([$query_params[0]], 'TXN_ID', true)
-            : EEM_Transaction::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @since 4.9.79.p
-     */
-    public function recalculateLineItems()
-    {
-        $TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
-        /** @var EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $success     = $transaction->recalculateLineItems();
-        $redirect_to = $this->request->getRequestParam('redirect_to');
-        $query_args  = $redirect_to
-            ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,]
-            : [];
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Transaction taxes and totals', 'event_espresso'),
-            esc_html__('recalculated', 'event_espresso'),
-            $query_args,
-            true
-        );
-    }
+	/**
+	 * @var EE_Transaction
+	 */
+	private $_transaction;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	/**
+	 * @var array $_txn_status
+	 */
+	private static $_txn_status;
+
+	/**
+	 * @var array $_pay_status
+	 */
+	private static $_pay_status;
+
+	/**
+	 * @var array $_existing_reg_payment_REG_IDs
+	 */
+	protected $_existing_reg_payment_REG_IDs;
+
+
+	/**
+	 *    _init_page_props
+	 *
+	 * @return void
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = TXN_PG_SLUG;
+		$this->page_label       = esc_html__('Transactions', 'event_espresso');
+		$this->_admin_base_url  = TXN_ADMIN_URL;
+		$this->_admin_base_path = TXN_ADMIN;
+	}
+
+
+	/**
+	 *    _ajax_hooks
+	 *
+	 * @return void
+	 */
+	protected function _ajax_hooks()
+	{
+		// add_action('wp_ajax_espresso_apply_payment', [$this, 'apply_payments_or_refunds']);
+		// add_action('wp_ajax_espresso_apply_refund', [$this, 'apply_payments_or_refunds']);
+		// add_action('wp_ajax_espresso_delete_payment', [$this, 'delete_payment']);
+	}
+
+
+	/**
+	 *    _define_page_props
+	 *
+	 * @return void
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons' => [
+				'add'    => esc_html__('Add New Transaction', 'event_espresso'),
+				'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
+				'delete' => esc_html__('Delete Transaction', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function _set_page_routes()
+	{
+		$this->_set_transaction_status_array();
+		$TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
+
+		$this->_page_routes = [
+
+			'default' => [
+				'func'       => '_transactions_overview_list_table',
+				'capability' => 'ee_read_transactions',
+			],
+
+			'view_transaction' => [
+				'func'       => '_transaction_details',
+				'capability' => 'ee_read_transaction',
+				'obj_id'     => $TXN_ID,
+			],
+
+			'send_payment_reminder' => [
+				'func'       => '_send_payment_reminder',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			],
+
+			'espresso_apply_payment' => [
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			],
+
+			'espresso_apply_refund' => [
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			],
+
+			'espresso_delete_payment' => [
+				'func'       => [$this, 'delete_payment'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_payments',
+			],
+
+			'espresso_recalculate_line_items' => [
+				'func'       => 'recalculateLineItems',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			],
+
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$TXN_ID             = $this->request->getRequestParam('TXN_ID', 0, 'int');
+		$this->_page_config = [
+			'default'          => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'icon'  => 'dashicons-list-view',
+					'order' => 10,
+				],
+				'list_table'    => 'EE_Admin_Transactions_List_Table',
+				'help_tabs'     => [
+					'transactions_overview_help_tab'                       => [
+						'title'    => esc_html__('Transactions Overview', 'event_espresso'),
+						'filename' => 'transactions_overview',
+					],
+					'transactions_overview_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
+						'filename' => 'transactions_overview_table_column_headings',
+					],
+					'transactions_overview_views_filters_help_tab'         => [
+						'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
+						'filename' => 'transactions_overview_views_filters_search',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'view_transaction' => [
+				'nav'       => [
+					'label'      => esc_html__('View Transaction', 'event_espresso'),
+					'icon'       => 'dashicons-cart',
+					'order'      => 5,
+					'url'        => $TXN_ID
+						? add_query_arg(['TXN_ID' => $TXN_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				],
+				'help_tabs' => [
+					'transactions_view_transaction_help_tab'                                              => [
+						'title'    => esc_html__('View Transaction', 'event_espresso'),
+						'filename' => 'transactions_view_transaction',
+					],
+					'transactions_view_transaction_transaction_details_table_help_tab'                    => [
+						'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_transaction_details_table',
+					],
+					'transactions_view_transaction_attendees_registered_help_tab'                         => [
+						'title'    => esc_html__('Attendees Registered', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_attendees_registered',
+					],
+					'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => [
+						'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_primary_registrant_billing_information',
+					],
+				],
+				'qtips'     => ['Transaction_Details_Tips'],
+				'metaboxes' => ['_transaction_details_metaboxes'],
+
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+		// noop
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+		// noop
+	}
+
+
+	public function admin_init()
+	{
+		$EVT_ID        = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$event_name    = $this->request->getRequestParam('event_name');
+		$redirect_from = $this->request->getRequestParam('redirect_from', '', 'url');
+		// IF a registration was JUST added via the admin...
+		if ($EVT_ID && $event_name && $redirect_from) {
+			// then set a cookie so that we can block any attempts to use
+			// the back button as a way to enter another registration.
+			setcookie('ee_registration_added', $EVT_ID, time() + WEEK_IN_SECONDS, '/');
+			// and update the global
+			$_COOKIE['ee_registration_added'] = $EVT_ID;
+		}
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__(
+			'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__(
+			'An error occurred! Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['txn_status_array']        = self::$_txn_status;
+		EE_Registry::$i18n_js_strings['pay_status_array']        = self::$_pay_status;
+		EE_Registry::$i18n_js_strings['payments_total']          = esc_html__('Payments Total', 'event_espresso');
+		EE_Registry::$i18n_js_strings['transaction_overpaid']    = esc_html__(
+			'This transaction has been overpaid ! Payments Total',
+			'event_espresso'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+		// noop
+	}
+
+
+	public function admin_footer_scripts()
+	{
+		// noop
+	}
+
+
+	/**
+	 * _set_transaction_status_array
+	 * sets list of transaction statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_transaction_status_array()
+	{
+		self::$_txn_status = EEM_Transaction::instance()->status_array(true);
+	}
+
+
+	/**
+	 * get_transaction_status_array
+	 * return the transaction status array for wp_list_table
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_transaction_status_array()
+	{
+		return self::$_txn_status;
+	}
+
+
+	/**
+	 *    get list of payment statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _get_payment_status_array()
+	{
+		self::$_pay_status                      = EEM_Payment::instance()->status_array(true);
+		$this->_template_args['payment_status'] = self::$_pay_status;
+	}
+
+
+	/**
+	 *    _add_screen_options_default
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * load_scripts_styles
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles()
+	{
+		// enqueue style
+		wp_register_style(
+			'espresso_txn',
+			TXN_ASSETS_URL . 'espresso_transactions_admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_txn');
+		// scripts
+		wp_register_script(
+			'espresso_txn',
+			TXN_ASSETS_URL . 'espresso_transactions_admin.js',
+			[
+				'ee_admin_js',
+				'ee-datepicker',
+				'jquery-ui-datepicker',
+				'jquery-ui-draggable',
+				'ee-dialog',
+				'ee-accounting',
+				'ee-serialize-full-array',
+			],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_txn');
+	}
+
+
+	/**
+	 *    load_scripts_styles_view_transaction
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_view_transaction()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    load_scripts_styles_default
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_default()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    _set_list_table_views_default
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all'        => [
+				'slug'  => 'all',
+				'label' => esc_html__('View All Transactions', 'event_espresso'),
+				'count' => 0,
+			],
+			'abandoned'  => [
+				'slug'  => 'abandoned',
+				'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
+				'count' => 0,
+			],
+			'incomplete' => [
+				'slug'  => 'incomplete',
+				'label' => esc_html__('Incomplete Transactions', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+		if (
+			/**
+			 * Filters whether a link to the "Failed Transactions" list table
+			 * appears on the Transactions Admin Page list table.
+			 * List display can be turned back on via the following:
+			 * add_filter(
+			 *     'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list',
+			 *     '__return_true'
+			 * );
+			 *
+			 * @param boolean                 $display_failed_txns_list
+			 * @param Transactions_Admin_Page $this
+			 * @since 4.9.70.p
+			 */
+		apply_filters(
+			'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list',
+			false,
+			$this
+		)
+		) {
+			$this->_views['failed'] = [
+				'slug'  => 'failed',
+				'label' => esc_html__('Failed Transactions', 'event_espresso'),
+				'count' => 0,
+			];
+		}
+	}
+
+
+	/**
+	 * _set_transaction_object
+	 * This sets the _transaction property for the transaction details screen
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_transaction_object()
+	{
+		if ($this->_transaction instanceof EE_Transaction) {
+			return;
+		} //get out we've already set the object
+
+		$TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
+
+		// get transaction object
+		$this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$this->_session     = $this->_transaction instanceof EE_Transaction
+			? $this->_transaction->session_data()
+			: null;
+		if ($this->_transaction instanceof EE_Transaction) {
+			$this->_transaction->verify_abandoned_transaction_status();
+		}
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			$error_msg = sprintf(
+				esc_html__(
+					'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
+					'event_espresso'
+				),
+				$TXN_ID
+			);
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 *    _transaction_legend_items
+	 *
+	 * @access protected
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _transaction_legend_items()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$items = [];
+
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_global_messages',
+				'view_filtered_messages'
+			)
+		) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (
+				is_array($related_for_icon)
+				&& isset($related_for_icon['css_class'], $related_for_icon['label'])
+			) {
+				$items['view_related_messages'] = [
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				];
+			}
+		}
+
+		$items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
+			array_merge(
+				$items,
+				[
+					'view_details'          => [
+						'class' => 'dashicons dashicons-cart',
+						'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+					],
+					'view_invoice'          => [
+						'class' => 'dashicons dashicons-media-spreadsheet',
+						'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+					],
+					'view_receipt'          => [
+						'class' => 'dashicons dashicons-text-page',
+						'desc'  => esc_html__('View Transaction Receipt', 'event_espresso'),
+					],
+					'view_registration'     => [
+						'class' => 'dashicons dashicons-clipboard',
+						'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+					],
+					'payment_overview_link' => [
+						'class' => 'dashicons dashicons-money',
+						'desc'  => esc_html__('Make Payment on Frontend', 'event_espresso'),
+					],
+				]
+			)
+		);
+
+		if (
+			EEH_MSG_Template::is_mt_active('payment_reminder')
+			&& $this->capabilities->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$items['send_payment_reminder'] = [
+				'class' => 'dashicons dashicons-email-alt',
+				'desc'  => esc_html__('Send Payment Reminder', 'event_espresso'),
+			];
+		} else {
+			$items['blank*'] = [
+				'class' => '',
+				'desc'  => '',
+			];
+		}
+		$more_items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
+			[
+				'overpaid'   => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::overpaid_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::overpaid_status_code,
+						false,
+						'sentence'
+					),
+				],
+				'complete'   => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::complete_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::complete_status_code,
+						false,
+						'sentence'
+					),
+				],
+				'incomplete' => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::incomplete_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::incomplete_status_code,
+						false,
+						'sentence'
+					),
+				],
+				'abandoned'  => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::abandoned_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::abandoned_status_code,
+						false,
+						'sentence'
+					),
+				],
+				'failed'     => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::failed_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::failed_status_code,
+						false,
+						'sentence'
+					),
+				],
+			]
+		);
+
+		return array_merge($items, $more_items);
+	}
+
+
+	/**
+	 *    _transactions_overview_list_table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _transactions_overview_list_table()
+	{
+		$this->_admin_page_title = esc_html__('Transactions', 'event_espresso');
+
+		$EVT_ID                                    = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$event                                     = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		$this->_template_args['admin_page_header'] = $event instanceof EE_Event
+			? sprintf(
+				esc_html__('%sViewing Transactions for the Event: %s%s', 'event_espresso'),
+				'<h3>',
+				'<a href="'
+				. EE_Admin_Page::add_query_args_and_nonce(
+					['action' => 'edit', 'post' => $event->ID()],
+					EVENTS_ADMIN_URL
+				)
+				. '" aria-label="'
+				. esc_attr__('Click to Edit event', 'event_espresso')
+				. '">' . $event->name() . '</a>',
+				'</h3>'
+			)
+			: '';
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *    _transaction_details
+	 * generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _transaction_details()
+	{
+		do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
+
+		$this->_set_transaction_status_array();
+
+		$this->_template_args                      = [];
+		$this->_template_args['transactions_page'] = $this->_wp_page_slug;
+
+		$this->_set_transaction_object();
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			return;
+		}
+
+		$this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
+		$this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
+
+		$this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
+		$this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
+
+		$this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->status_ID() ];
+		$this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
+		$this->_template_args['txn_status']['class'] = $this->_transaction->status_ID();
+
+		$txn_total  = $this->_transaction->total();
+		$total_paid = $this->_transaction->paid();
+		$amount_due = $txn_total - $total_paid;
+
+		$this->_template_args['grand_total'] = $txn_total;
+		$this->_template_args['total_paid']  = $total_paid;
+
+		$this->_template_args['amount_due']     = EEH_Template::format_currency($amount_due, false, false);
+		$this->_template_args['amount_due_raw'] = $amount_due;
+
+		$this->_template_args['amount_due_class'] = '';
+
+		if ($txn_total === (float) 0) {
+			// free event
+			$this->_template_args['amount_due'] = false;
+		} elseif ($amount_due < (float) 0) {
+			// overpaid
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		} elseif ($amount_due > (float) 0) {
+			// monies owing
+			$this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn ee-txn-amount-owing';
+		} elseif ($total_paid === (float) 0) {
+			// no payments made yet
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		}
+
+		$payment_method = $this->_transaction->payment_method();
+
+		$this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		// link back to overview
+		$this->_template_args['txn_overview_url'] = $this->request->getServerParam(
+			'HTTP_REFERER',
+			TXN_ADMIN_URL
+		);
+
+
+		// next link
+		$next_txn                                 = $this->_transaction->next(
+			null,
+			[['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
+			'TXN_ID'
+		);
+		$this->_template_args['next_transaction'] = $next_txn
+			? $this->_next_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					['action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']],
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-right ee-icon-size-22'
+			)
+			: '';
+		// previous link
+		$previous_txn                                 = $this->_transaction->previous(
+			null,
+			[['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
+			'TXN_ID'
+		);
+		$this->_template_args['previous_transaction'] = $previous_txn
+			? $this->_previous_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					['action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']],
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-left ee-icon-size-22'
+			)
+			: '';
+
+		$EVT_ID        = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$event_name    = $this->request->getRequestParam('event_name');
+		$redirect_from = $this->request->getRequestParam('redirect_from', '', 'url');
+
+		// were we just redirected here after adding a new registration ???
+		if ($EVT_ID && $event_name && $redirect_from) {
+			if (
+				$this->capabilities->current_user_can(
+					'ee_edit_registrations',
+					'espresso_registrations_new_registration',
+					$EVT_ID
+				)
+			) {
+				$this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button--primary" href="';
+				$this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'page'     => 'espresso_registrations',
+						'action'   => 'new_registration',
+						'return'   => 'default',
+						'TXN_ID'   => $this->_transaction->ID(),
+						'event_id' => $EVT_ID,
+					],
+					REG_ADMIN_URL
+				);
+				$this->_admin_page_title .= '">';
+
+				$this->_admin_page_title .= sprintf(
+					esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
+					htmlentities(urldecode($event_name), ENT_QUOTES, 'UTF-8')
+				);
+				$this->_admin_page_title .= '</a>';
+			}
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// grab messages at the last second
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		// path to template
+		$template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+		$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *        _transaction_details_metaboxes
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _transaction_details_metaboxes()
+	{
+		$this->_set_transaction_object();
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->addMetaBox(
+			'edit-txn-details-mbox',
+			'<span>' . esc_html__('Transaction Details', 'event_espresso')
+			. '&nbsp;<span class="dashicons dashicons-cart" ></span></span>',
+			[$this, 'txn_details_meta_box'],
+			$this->_wp_page_slug
+		);
+		$this->addMetaBox(
+			'edit-txn-attendees-mbox',
+			'<span>' . esc_html__('Attendees Registered in this Transaction', 'event_espresso')
+			. '&nbsp;<span class="dashicons dashicons-groups" ></span></span>',
+			[$this, 'txn_attendees_meta_box'],
+			$this->_wp_page_slug,
+			'normal',
+			'high',
+			['TXN_ID' => $this->_transaction->ID()]
+		);
+		$this->addMetaBox(
+			'edit-txn-registrant-mbox',
+			esc_html__('Primary Contact', 'event_espresso'),
+			[$this, 'txn_registrant_side_meta_box'],
+			$this->_wp_page_slug,
+			'side'
+		);
+		$this->addMetaBox(
+			'edit-txn-billing-info-mbox',
+			esc_html__('Billing Information', 'event_espresso'),
+			[$this, 'txn_billing_info_side_meta_box'],
+			$this->_wp_page_slug,
+			'side'
+		);
+	}
+
+
+	/**
+	 * Callback for transaction actions metabox.
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function getActionButtons(EE_Transaction $transaction = null)
+	{
+		$content = '';
+		$actions = [];
+		if (! $transaction instanceof EE_Transaction) {
+			return $content;
+		}
+		/** @var EE_Registration $primary_registration */
+		$primary_registration = $transaction->primary_registration();
+		$attendee             = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: null;
+
+		if (
+			$attendee instanceof EE_Attendee
+			&& $this->capabilities->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$actions['payment_reminder'] =
+				EEH_MSG_Template::is_mt_active('payment_reminder')
+				&& $this->_transaction->status_ID() !== EEM_Transaction::complete_status_code
+				&& $this->_transaction->status_ID() !== EEM_Transaction::overpaid_status_code
+					? EEH_Template::get_button_or_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'action'      => 'send_payment_reminder',
+							'TXN_ID'      => $this->_transaction->ID(),
+							'redirect_to' => 'view_transaction',
+						],
+						TXN_ADMIN_URL
+					),
+					esc_html__(' Send Payment Reminder', 'event_espresso'),
+					'button button--secondary',
+					'dashicons dashicons-email-alt'
+				)
+					: '';
+		}
+
+		if (
+			$this->capabilities->current_user_can(
+				'ee_edit_payments',
+				'espresso_transactions_recalculate_line_items'
+			)
+		) {
+			$actions['recalculate_line_items'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action'      => 'espresso_recalculate_line_items',
+						'TXN_ID'      => $this->_transaction->ID(),
+						'redirect_to' => 'view_transaction',
+					],
+					TXN_ADMIN_URL
+				),
+				esc_html__(' Recalculate Taxes and Total', 'event_espresso'),
+				'button button--secondary',
+				'dashicons dashicons-update'
+			);
+		}
+
+		if (
+			$primary_registration instanceof EE_Registration
+			&& EEH_MSG_Template::is_mt_active('receipt')
+		) {
+			$actions['receipt'] = EEH_Template::get_button_or_link(
+				$primary_registration->receipt_url(),
+				esc_html__('View Receipt', 'event_espresso'),
+				'button button--secondary',
+				'dashicons dashicons-text-page'
+			);
+		}
+
+		if (
+			$primary_registration instanceof EE_Registration
+			&& EEH_MSG_Template::is_mt_active('invoice')
+		) {
+			$actions['invoice'] = EEH_Template::get_button_or_link(
+				$primary_registration->invoice_url(),
+				esc_html__('View Invoice', 'event_espresso'),
+				'button button--secondary',
+				'dashicons dashicons-media-spreadsheet'
+			);
+		}
+		$actions = array_filter(
+			apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction)
+		);
+		if ($actions) {
+			$content .= implode('', $actions);
+		}
+		return $content;
+	}
+
+
+	/**
+	 * txn_details_meta_box
+	 * generates HTML for the Transaction main meta box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function txn_details_meta_box()
+	{
+		$this->_set_transaction_object();
+		$this->_template_args['TXN_ID']              = $this->_transaction->ID();
+		$this->_template_args['attendee']            =
+			$this->_transaction->primary_registration() instanceof EE_Registration
+				? $this->_transaction->primary_registration()->attendee()
+				: null;
+		$this->_template_args['can_edit_payments']   = $this->capabilities->current_user_can(
+			'ee_edit_payments',
+			'apply_payment_or_refund_from_registration_details'
+		);
+		$this->_template_args['can_delete_payments'] = $this->capabilities->current_user_can(
+			'ee_delete_payments',
+			'delete_payment_from_registration_details'
+		);
+
+		// get line table
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display                       = new EE_Line_Item_Display(
+			'admin_table',
+			'EE_Admin_Table_Line_Item_Display_Strategy'
+		);
+		$this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item(
+			$this->_transaction->total_line_item()
+		);
+		$this->_template_args['REG_code']        =
+			$this->_transaction->primary_registration() instanceof EE_Registration
+				? $this->_transaction->primary_registration()->reg_code()
+				: null;
+		// process taxes
+		$taxes                         = $this->_transaction->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
+		$this->_template_args['taxes'] = ! empty($taxes)
+			? $taxes
+			: false;
+
+		$this->_template_args['grand_total']     = EEH_Template::format_currency(
+			$this->_transaction->total(),
+			false,
+			false
+		);
+		$this->_template_args['grand_raw_total'] = $this->_transaction->total();
+		$this->_template_args['TXN_status']      = $this->_transaction->status_ID();
+
+		// process payment details
+		$payments = $this->_transaction->payments();
+		if (! empty($payments)) {
+			$this->_template_args['payments']              = $payments;
+			$this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
+		} else {
+			$this->_template_args['payments']              = false;
+			$this->_template_args['existing_reg_payments'] = [];
+		}
+
+		$this->_template_args['edit_payment_url']   = add_query_arg(['action' => 'edit_payment'], TXN_ADMIN_URL);
+		$this->_template_args['delete_payment_url'] = add_query_arg(
+			['action' => 'espresso_delete_payment'],
+			TXN_ADMIN_URL
+		);
+
+		if (isset($txn_details['invoice_number'])) {
+			$this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
+			$this->_template_args['txn_details']['invoice_number']['label'] = esc_html__(
+				'Invoice Number',
+				'event_espresso'
+			);
+		}
+
+		$this->_template_args['txn_details']['registration_session']['value'] =
+			$this->_transaction->primary_registration() instanceof EE_Registration
+				? $this->_transaction->primary_registration()->session_ID()
+				: null;
+		$this->_template_args['txn_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+
+		$this->_template_args['txn_details']['ip_address']['value'] = $this->_session['ip_address'] ?? '';
+		$this->_template_args['txn_details']['ip_address']['label'] = esc_html__(
+			'Transaction placed from IP',
+			'event_espresso'
+		);
+
+		$this->_template_args['txn_details']['user_agent']['value'] = $this->_session['user_agent'] ?? '';
+		$this->_template_args['txn_details']['user_agent']['label'] = esc_html__(
+			'Registrant User Agent',
+			'event_espresso'
+		);
+
+		$reg_steps = '<div class="ee-txn-reg-step-status-steps ee-layout-row">';
+		foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
+			if ($reg_step_status === true) {
+				$reg_steps .= '<div class="ee-status-pill ee-status-bg--success">'
+							  . sprintf(
+								  esc_html__('%1$s : Completed', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step))
+							  )
+							  . '</div>';
+			} elseif ($reg_step_status !== false && is_numeric($reg_step_status)) {
+				$reg_steps .= '<div class="ee-status-pill ee-status-bg--attention">'
+							  . sprintf(
+								  esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step)),
+								  date(
+									  get_option('date_format') . ' ' . get_option('time_format'),
+									  $reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)
+								  )
+							  )
+							  . '</div>';
+			} else {
+				$reg_steps .= '<div class="ee-status-pill ee-status-bg--error">'
+							  . sprintf(
+								  esc_html__('%1$s : Never Initiated', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step))
+							  )
+							  . '</div>';
+			}
+		}
+		$reg_steps                                                 .= '</ul>';
+		$this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
+		$this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
+			'Registration Step Progress',
+			'event_espresso'
+		);
+
+
+		$this->_get_registrations_to_apply_payment_to();
+		$this->_get_payment_methods($payments);
+		$this->_get_payment_status_array();
+		$this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction.
+
+		$this->_template_args['transaction_form_url']    = add_query_arg(
+			[
+				'action'  => 'edit_transaction',
+				'process' => 'transaction',
+			],
+			TXN_ADMIN_URL
+		);
+		$this->_template_args['apply_payment_form_url']  = add_query_arg(
+			[
+				'page'   => 'espresso_transactions',
+				'action' => 'espresso_apply_payment',
+			],
+			TXN_ADMIN_URL
+		);
+		$this->_template_args['delete_payment_form_url'] = add_query_arg(
+			[
+				'page'   => 'espresso_transactions',
+				'action' => 'espresso_delete_payment',
+			],
+			TXN_ADMIN_URL
+		);
+
+		$this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction);
+
+		// 'espresso_delete_payment_nonce'
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * _get_registration_payment_IDs
+	 *    generates an array of Payment IDs and their corresponding Registration IDs
+	 *
+	 * @access protected
+	 * @param EE_Payment[] $payments
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_registration_payment_IDs($payments = [])
+	{
+		$existing_reg_payments = [];
+		// get all reg payments for these payments
+		$reg_payments = EEM_Registration_Payment::instance()->get_all(
+			[
+				[
+					'PAY_ID' => [
+						'IN',
+						array_keys($payments),
+					],
+				],
+			]
+		);
+		if (! empty($reg_payments)) {
+			foreach ($payments as $payment) {
+				if (! $payment instanceof EE_Payment) {
+					continue;
+				} elseif (! isset($existing_reg_payments[ $payment->ID() ])) {
+					$existing_reg_payments[ $payment->ID() ] = [];
+				}
+				foreach ($reg_payments as $reg_payment) {
+					if (
+						$reg_payment instanceof EE_Registration_Payment
+						&& $reg_payment->payment_ID() === $payment->ID()
+					) {
+						$existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID();
+					}
+				}
+			}
+		}
+
+		return $existing_reg_payments;
+	}
+
+
+	/**
+	 * _get_registrations_to_apply_payment_to
+	 *    generates HTML for displaying a series of checkboxes in the admin payment modal window
+	 * which allows the admin to only apply the payment to the specific registrations
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_registrations_to_apply_payment_to()
+	{
+		// we want any registration with an active status (ie: not deleted or cancelled)
+		$query_params                      = [
+			[
+				'STS_ID' => [
+					'IN',
+					[
+						EEM_Registration::status_id_approved,
+						EEM_Registration::status_id_pending_payment,
+						EEM_Registration::status_id_not_approved,
+					],
+				],
+			],
+		];
+		$registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div(
+				'',
+				'txn-admin-apply-payment-to-registrations-dv',
+				'',
+				'clear: both; margin: 1.5em 0 0; display: none;'
+			);
+		$registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+		$registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl striped');
+		$registrations_to_apply_payment_to .= EEH_HTML::thead(
+			EEH_HTML::tr(
+				EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
+			)
+		);
+		$registrations_to_apply_payment_to .= EEH_HTML::tbody();
+		// get registrations for TXN
+		$registrations         = $this->_transaction->registrations($query_params);
+		$existing_reg_payments = $this->_template_args['existing_reg_payments'];
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$attendee_name                     = $registration->attendee() instanceof EE_Attendee
+					? $registration->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$owing                             = $registration->final_price() - $registration->paid();
+				$taxable                           = $registration->ticket()->taxable()
+					? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+					: '';
+				$checked                           = empty($existing_reg_payments)
+													 || in_array($registration->ID(), $existing_reg_payments, true)
+					? ' checked'
+					: '';
+				$disabled                          = $registration->final_price() > 0
+					? ''
+					: ' disabled';
+				$registrations_to_apply_payment_to .= EEH_HTML::tr(
+					EEH_HTML::td($registration->ID()) .
+					EEH_HTML::td($attendee_name) .
+					EEH_HTML::td(
+						$registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
+					) .
+					EEH_HTML::td($registration->event_name()) .
+					EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
+					EEH_HTML::td(
+						EEH_Template::format_currency($owing),
+						'',
+						'txn-admin-payment-owing-td jst-cntr'
+					) .
+					EEH_HTML::td(
+						'<input type="checkbox" value="' . $registration->ID()
+						. '" name="txn_admin_payment[registrations]"'
+						. $checked . $disabled . '>',
+						'',
+						'jst-cntr'
+					),
+					'apply-payment-registration-row-' . $registration->ID()
+				);
+			}
+		}
+		$registrations_to_apply_payment_to                         .= EEH_HTML::tbodyx();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::tablex();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::divx();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::p(
+			esc_html__(
+				'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
+				'event_espresso'
+			),
+			'',
+			'clear description'
+		);
+		$registrations_to_apply_payment_to                         .= EEH_HTML::divx();
+		$this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
+	}
+
+
+	/**
+	 * _get_reg_status_selection
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
+	 *         instead of events.
+	 * @access protected
+	 */
+	protected function _get_reg_status_selection()
+	{
+		// first get all possible statuses
+		$statuses = EEM_Registration::reg_status_array([], true);
+		// let's add a "don't change" option.
+		$status_array['NAN']                                 = esc_html__('Leave the Same', 'event_espresso');
+		$status_array                                        = array_merge($status_array, $statuses);
+		$this->_template_args['status_change_select']        = EEH_Form_Fields::select_input(
+			'txn_reg_status_change[reg_status]',
+			$status_array,
+			'NAN',
+			'id="txn-admin-payment-reg-status-inp"',
+			'txn-reg-status-change-reg-status'
+		);
+		$this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input(
+			'delete_txn_reg_status_change[reg_status]',
+			$status_array,
+			'NAN',
+			'delete-txn-admin-payment-reg-status-inp',
+			'delete-txn-reg-status-change-reg-status'
+		);
+	}
+
+
+	/**
+	 *    _get_payment_methods
+	 * Gets all the payment methods available generally, or the ones that are already
+	 * selected on these payments (in case their payment methods are no longer active).
+	 * Has the side-effect of updating the template args' payment_methods item
+	 *
+	 * @access private
+	 * @param EE_Payment[] to show on this page
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _get_payment_methods($payments = [])
+	{
+		$payment_methods_of_payments = [];
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment) {
+				$payment_methods_of_payments[] = $payment->ID();
+			}
+		}
+		if ($payment_methods_of_payments) {
+			$query_args = [
+				[
+					'OR*payment_method_for_payment' => [
+						'PMD_ID'    => ['IN', $payment_methods_of_payments],
+						'PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%'],
+					],
+				],
+			];
+		} else {
+			$query_args = [['PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%']]];
+		}
+		$this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
+	}
+
+
+	/**
+	 * txn_attendees_meta_box
+	 *    generates HTML for the Attendees Transaction main meta box
+	 *
+	 * @access public
+	 * @param WP_Post $post
+	 * @param array   $metabox
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_attendees_meta_box($post, $metabox = ['args' => []])
+	{
+		/** @noinspection NonSecureExtractUsageInspection */
+		extract($metabox['args']);
+		$this->_template_args['post']            = $post;
+		$this->_template_args['event_attendees'] = [];
+		// process items in cart
+		$line_items = $this->_transaction->get_many_related(
+			'Line_Item',
+			[['LIN_type' => 'line-item']]
+		);
+		if (! empty($line_items)) {
+			foreach ($line_items as $item) {
+				if ($item instanceof EE_Line_Item) {
+					switch ($item->OBJ_type()) {
+						case 'Event':
+							break;
+						case 'Ticket':
+							$ticket = $item->ticket();
+							// right now we're only handling tickets here.
+							// Cause its expected that only tickets will have attendees right?
+							if (! $ticket instanceof EE_Ticket) {
+								break;
+							}
+							try {
+								$event_name = $ticket->get_event_name();
+							} catch (Exception $e) {
+								EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+								$event_name = esc_html__('Unknown Event', 'event_espresso');
+							}
+							$event_name   .= ' - ' . $item->name();
+							$ticket_price = EEH_Template::format_currency($item->unit_price());
+							// now get all of the registrations for this transaction that use this ticket
+							$registrations = $ticket->registrations(
+								[['TXN_ID' => $this->_transaction->ID()]]
+							);
+							foreach ($registrations as $registration) {
+								if (! $registration instanceof EE_Registration) {
+									break;
+								}
+								$this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID']
+									= $registration->status_ID();
+								$this->_template_args['event_attendees'][ $registration->ID() ]['att_num']
+									= $registration->count();
+								$this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name']
+									= $event_name;
+								$this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price']
+									= $ticket_price;
+								// attendee info
+								$attendee = $registration->get_first_related('Attendee');
+								if ($attendee instanceof EE_Attendee) {
+									$this->_template_args['event_attendees'][ $registration->ID() ]['att_id']
+										= $attendee->ID();
+									$this->_template_args['event_attendees'][ $registration->ID() ]['attendee']
+										= $attendee->full_name();
+									$this->_template_args['event_attendees'][ $registration->ID() ]['email']
+										= '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
+										  . esc_html__(
+											  ' Event',
+											  'event_espresso'
+										  )
+										  . '">' . $attendee->email() . '</a>';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['address']
+										= EEH_Address::format($attendee, 'inline', false, false);
+								} else {
+									$this->_template_args['event_attendees'][ $registration->ID() ]['att_id']   = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['email']    = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['address']  = '';
+								}
+							}
+							break;
+					}
+				}
+			}
+
+			$this->_template_args['transaction_form_url'] = add_query_arg(
+				[
+					'action'  => 'edit_transaction',
+					'process' => 'attendees',
+				],
+				TXN_ADMIN_URL
+			);
+			echo EEH_Template::display_template(
+				TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+				$this->_template_args,
+				true
+			);
+		} else {
+			printf(
+				esc_html__(
+					'%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
+					'event_espresso'
+				),
+				'<p class="important-notice">',
+				'</p>'
+			);
+		}
+	}
+
+
+	/**
+	 * txn_registrant_side_meta_box
+	 * generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_registrant_side_meta_box()
+	{
+		$primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
+			? $this->_transaction->primary_registration()->get_first_related('Attendee')
+			: null;
+		if (! $primary_att instanceof EE_Attendee) {
+			$this->_template_args['no_attendee_message'] = esc_html__(
+				'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
+				'event_espresso'
+			);
+			$primary_att                                 = EEM_Attendee::instance()->create_default_object();
+		}
+		$this->_template_args['ATT_ID']            = $primary_att->ID();
+		$this->_template_args['prime_reg_fname']   = $primary_att->fname();
+		$this->_template_args['prime_reg_lname']   = $primary_att->lname();
+		$this->_template_args['prime_reg_email']   = $primary_att->email();
+		$this->_template_args['prime_reg_phone']   = $primary_att->phone();
+		$this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action' => 'edit_attendee',
+				'post'   => $primary_att->ID(),
+			],
+			REG_ADMIN_URL
+		);
+		// get formatted address for registrant
+		$formatted_address                         = EEH_Address::format($primary_att);
+		$formatted_address                         =
+			$formatted_address !== '<div class="espresso-address-dv"><div></div></div>'
+				? $formatted_address
+				: '';
+		$this->_template_args['formatted_address'] = $formatted_address;
+		echo EEH_Template::display_template(
+			TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * txn_billing_info_side_meta_box
+	 *    generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function txn_billing_info_side_meta_box()
+	{
+		$this->_template_args['billing_form']     = $this->_transaction->billing_info();
+		$this->_template_args['billing_form_url'] = add_query_arg(
+			['action' => 'edit_transaction', 'process' => 'billing'],
+			TXN_ADMIN_URL
+		);
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * apply_payments_or_refunds
+	 *    registers a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function apply_payments_or_refunds()
+	{
+		$valid_data = $this->_validate_payment_request_data();
+		$has_access = $this->capabilities->current_user_can(
+			'ee_edit_payments',
+			'apply_payment_or_refund_from_registration_details'
+		);
+		$TXD_ID     = $this->request->getRequestParam('txn_admin_payment[TXN_ID]', 0, 'int');
+		$amount     = 0;
+		if (! empty($valid_data) && $has_access) {
+			$PAY_ID = $valid_data['PAY_ID'];
+			// save  the new payment
+			$payment = $this->_create_payment_from_request_data($valid_data);
+			$amount  = $payment->amount();
+			// get the TXN for this payment
+			$transaction = $payment->transaction();
+			// verify transaction
+			if ($transaction instanceof EE_Transaction) {
+				// calculate_total_payments_and_update_status
+				$this->_process_transaction_payments($transaction);
+				$REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
+				$this->_remove_existing_registration_payments($payment, $PAY_ID);
+				// apply payment to registrations (if applicable)
+				if (! empty($REG_IDs)) {
+					$this->_update_registration_payments($transaction, $payment, $REG_IDs);
+					$this->_maybe_send_notifications();
+					// now process status changes for the same registrations
+					$this->_process_registration_status_change($transaction, $REG_IDs);
+				}
+				$this->_maybe_send_notifications($payment);
+				// prepare to render page
+				do_action(
+					'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording',
+					$transaction,
+					$payment
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Transaction for this payment could not be retrieved.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} elseif ($has_access) {
+			EE_Error::add_error(
+				esc_html__(
+					'The payment form data could not be processed. Please try again.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'You do not have access to apply payments or refunds to a registration.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$query_args = [
+			'page'   => 'espresso_transactions',
+			'action' => 'view_transaction',
+			'TXN_ID' => $TXD_ID,
+		];
+
+		$this->_redirect_after_action(
+			! EE_Error::has_error(),
+			$amount > 0
+				? esc_html__('payment', 'event_espresso')
+				: esc_html__('refund', 'event_espresso'),
+			esc_html__('processed', 'event_espresso'),
+			$query_args
+		);
+	}
+
+
+	/**
+	 * _validate_payment_request_data
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _validate_payment_request_data()
+	{
+		if (! $this->request->requestParamIsSet('txn_admin_payment')) {
+			return [];
+		}
+		$payment_form = $this->_generate_payment_form_section();
+		try {
+			if ($payment_form->was_submitted()) {
+				$payment_form->receive_form_submission();
+				if (! $payment_form->is_valid()) {
+					$submission_error_messages = [];
+					foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
+						if ($validation_error instanceof EE_Validation_Error) {
+							$form_input                  = $validation_error->get_form_section();
+							$submission_error_messages[] = sprintf(
+								_x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
+								$form_input instanceof EE_Form_Input_Base
+									? $form_input->html_label_text()
+									: '',
+								$validation_error->getMessage()
+							);
+						}
+					}
+					EE_Error::add_error(
+						implode('<br />', $submission_error_messages),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return [];
+				}
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return [];
+		}
+
+		return $payment_form->valid_data();
+	}
+
+
+	/**
+	 * _generate_payment_form_section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _generate_payment_form_section()
+	{
+		return new EE_Form_Section_Proper(
+			[
+				'name'        => 'txn_admin_payment',
+				'subsections' => [
+					'PAY_ID'          => new EE_Text_Input(
+						[
+							'default'               => 0,
+							'required'              => false,
+							'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
+							'validation_strategies' => [new EE_Int_Normalization()],
+						]
+					),
+					'TXN_ID'          => new EE_Text_Input(
+						[
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
+							'validation_strategies' => [new EE_Int_Normalization()],
+						]
+					),
+					'type'            => new EE_Text_Input(
+						[
+							'default'               => 1,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
+							'validation_strategies' => [new EE_Int_Normalization()],
+						]
+					),
+					'amount'          => new EE_Text_Input(
+						[
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
+							'validation_strategies' => [new EE_Float_Normalization()],
+						]
+					),
+					'status'          => new EE_Text_Input(
+						[
+							'default'         => EEM_Payment::status_id_approved,
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment status', 'event_espresso'),
+						]
+					),
+					'PMD_ID'          => new EE_Text_Input(
+						[
+							'default'               => 2,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
+							'validation_strategies' => [new EE_Int_Normalization()],
+						]
+					),
+					'date'            => new EE_Text_Input(
+						[
+							'default'         => time(),
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment date', 'event_espresso'),
+						]
+					),
+					'txn_id_chq_nmbr' => new EE_Text_Input(
+						[
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
+							'validation_strategies' => [
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							],
+						]
+					),
+					'po_number'       => new EE_Text_Input(
+						[
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
+							'validation_strategies' => [
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							],
+						]
+					),
+					'accounting'      => new EE_Text_Input(
+						[
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
+							'validation_strategies' => [
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							],
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * _create_payment_from_request_data
+	 *
+	 * @param array $valid_data
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _create_payment_from_request_data($valid_data)
+	{
+		$PAY_ID = $valid_data['PAY_ID'];
+		// get payment amount
+		$amount = $valid_data['amount']
+			? abs($valid_data['amount'])
+			: 0;
+		// payments have a type value of 1 and refunds have a type value of -1
+		// so multiplying amount by type will give a positive value for payments, and negative values for refunds
+		$amount = $valid_data['type'] < 0
+			? $amount * -1
+			: $amount;
+		// for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
+		$date    = $valid_data['date']
+			? preg_replace('/\s+/', ' ', $valid_data['date'])
+			: date('Y-m-d g:i a', current_time('timestamp'));
+		$payment = EE_Payment::new_instance(
+			[
+				'TXN_ID'              => $valid_data['TXN_ID'],
+				'STS_ID'              => $valid_data['status'],
+				'PAY_timestamp'       => $date,
+				'PAY_source'          => EEM_Payment_Method::scope_admin,
+				'PMD_ID'              => $valid_data['PMD_ID'],
+				'PAY_amount'          => $amount,
+				'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
+				'PAY_po_number'       => $valid_data['po_number'],
+				'PAY_extra_accntng'   => $valid_data['accounting'],
+				'PAY_details'         => $valid_data,
+				'PAY_ID'              => $PAY_ID,
+			],
+			'',
+			['Y-m-d', 'g:i a']
+		);
+
+		if (! $payment->save()) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
+					$payment->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		return $payment;
+	}
+
+
+	/**
+	 * _process_transaction_payments
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_transaction_payments(EE_Transaction $transaction)
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		// update the transaction with this payment
+		if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_success(
+				esc_html__(
+					'The payment has been processed successfully.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'The payment was processed successfully but the amount paid for the transaction was not updated.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * _get_REG_IDs_to_apply_payment_to
+	 * returns a list of registration IDs that the payment will apply to
+	 *
+	 * @param EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
+	{
+		// grab array of IDs for specific registrations to apply changes to
+		$apply_to_all = $this->request->getRequestParam(
+			'txn_admin_payment[apply_to_all_registrations]',
+			false,
+			DataType::BOOL
+		);
+		$REG_IDs      = ! $apply_to_all
+			? $this->request->getRequestParam(
+				'txn_admin_payment[registrations]',
+				[],
+				DataType::INT,
+				true
+			)
+			: [];
+		// nothing specified ? then get all reg IDs
+		if ($apply_to_all || empty($REG_IDs)) {
+			$registrations = $payment->transaction()->registrations();
+			$REG_IDs       = ! empty($registrations)
+				? array_keys($registrations)
+				: $this->_get_existing_reg_payment_REG_IDs($payment);
+		}
+		// ensure that REG_IDs are integers and NOT strings
+		return array_map('absint', $REG_IDs);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function existing_reg_payment_REG_IDs()
+	{
+		return $this->_existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * @param array $existing_reg_payment_REG_IDs
+	 */
+	public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
+	{
+		$this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * _get_existing_reg_payment_REG_IDs
+	 * returns a list of registration IDs that the payment is currently related to
+	 * as recorded in the database
+	 *
+	 * @param EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
+	{
+		if ($this->existing_reg_payment_REG_IDs() === null) {
+			// let's get any existing reg payment records for this payment
+			$existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
+			// but we only want the REG IDs, so grab the array keys
+			$existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs)
+				? array_keys($existing_reg_payment_REG_IDs)
+				: [];
+			$this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
+		}
+
+		return $this->existing_reg_payment_REG_IDs();
+	}
+
+
+	/**
+	 * _remove_existing_registration_payments
+	 * this calculates the difference between existing relations
+	 * to the supplied payment and the new list registration IDs,
+	 * removes any related registrations that no longer apply,
+	 * and then updates the registration paid fields
+	 *
+	 * @param EE_Payment $payment
+	 * @param int        $PAY_ID
+	 * @return bool;
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
+	{
+		// newly created payments will have nothing recorded for $PAY_ID
+		if (absint($PAY_ID) === 0) {
+			return false;
+		}
+		$existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+		if (empty($existing_reg_payment_REG_IDs)) {
+			return false;
+		}
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+
+		return $transaction_payments->delete_registration_payments_and_update_registrations(
+			$payment,
+			[
+				[
+					'PAY_ID' => $payment->ID(),
+					'REG_ID' => ['IN', $existing_reg_payment_REG_IDs],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * _update_registration_payments
+	 * this applies the payments to the selected registrations
+	 * but only if they have not already been paid for
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param array          $REG_IDs
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		$REG_IDs = []
+	) {
+		// we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
+		// so let's do that using our set of REG_IDs from the form
+		$registration_query_where_params = [
+			'REG_ID' => ['IN', $REG_IDs],
+		];
+		// but add in some conditions regarding payment,
+		// so that we don't apply payments to registrations that are free or have already been paid for
+		// but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
+		if (! $payment->is_a_refund()) {
+			$registration_query_where_params['REG_final_price']  = ['!=', 0];
+			$registration_query_where_params['REG_final_price*'] = ['!=', 'REG_paid', true];
+		}
+		$registrations = $transaction->registrations([$registration_query_where_params]);
+		if (! empty($registrations)) {
+			/** @type EE_Payment_Processor $payment_processor */
+			$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+			$payment_processor->process_registration_payments($transaction, $payment, $registrations);
+		}
+	}
+
+
+	/**
+	 * _process_registration_status_change
+	 * This processes requested registration status changes for all the registrations
+	 * on a given transaction and (optionally) sends out notifications for the changes.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $REG_IDs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = [], $reg_status = '')
+	{
+		// first if there is no change in status then we get out.
+		$reg_status = $reg_status
+			?: $this->request->getRequestParam('txn_reg_status_change[reg_status]', 'NAN');
+		if ($reg_status === 'NAN') {
+			// no error message, no change requested, just nothing to do man.
+			return false;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		// made it here dude?  Oh WOW.  K, let's take care of changing the statuses
+		return $transaction_processor->manually_update_registration_statuses(
+			$transaction,
+			$reg_status,
+			[['REG_ID' => ['IN', $REG_IDs]]]
+		);
+	}
+
+
+	/**
+	 * _build_payment_json_response
+	 *
+	 * @access public
+	 * @param EE_Payment  $payment
+	 * @param array       $REG_IDs
+	 * @param bool | null $delete_txn_reg_status_change
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _build_payment_json_response(
+		EE_Payment $payment,
+		$REG_IDs = [],
+		$delete_txn_reg_status_change = null
+	) {
+		// was the payment deleted ?
+		if (is_bool($delete_txn_reg_status_change)) {
+			return [
+				'PAY_ID'                       => $payment->ID(),
+				'amount'                       => $payment->amount(),
+				'total_paid'                   => $payment->transaction()->paid(),
+				'txn_status'                   => $payment->transaction()->status_ID(),
+				'pay_status'                   => $payment->STS_ID(),
+				'registrations'                => $this->_registration_payment_data_array($REG_IDs),
+				'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
+			];
+		}
+
+		$this->_get_payment_status_array();
+		$payment_method = $payment->payment_method();
+		return [
+			'amount'           => $payment->amount(),
+			'total_paid'       => $payment->transaction()->paid(),
+			'txn_status'       => $payment->transaction()->status_ID(),
+			'pay_status'       => $payment->STS_ID(),
+			'PAY_ID'           => $payment->ID(),
+			'STS_ID'           => $payment->STS_ID(),
+			'status'           => self::$_pay_status[ $payment->STS_ID() ],
+			'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
+			'method'           => strtoupper($payment->source()),
+			'PM_ID'            => $payment_method instanceof EE_Payment_Method
+				? $payment_method->ID()
+				: 1,
+			'gateway'          => $payment_method instanceof EE_Payment_Method
+				? $payment_method->admin_name()
+				: esc_html__('Unknown', 'event_espresso'),
+			'gateway_response' => $payment->gateway_response(),
+			'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
+			'po_number'        => $payment->po_number(),
+			'extra_accntng'    => $payment->extra_accntng(),
+			'registrations'    => $this->_registration_payment_data_array($REG_IDs),
+		];
+	}
+
+
+	/**
+	 * delete_payment
+	 *    delete a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_payment()
+	{
+		$TXD_ID = $this->request->getRequestParam('delete_txn_admin_payment[TXN_ID]', 0, 'int');
+		// $json_response_data = ['return_data' => false];
+		$PAY_ID     = $this->request->getRequestParam('delete_txn_admin_payment[PAY_ID]', 0, 'int');
+		$amount     = 0;
+		$can_delete = $this->capabilities->current_user_can(
+			'ee_delete_payments',
+			'delete_payment_from_registration_details'
+		);
+		if ($PAY_ID && $can_delete) {
+			$delete_txn_reg_status_change = $this->request->getRequestParam('delete_txn_reg_status_change[reg_status]');
+			$payment                      = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			if ($payment instanceof EE_Payment) {
+				$amount  = $payment->amount();
+				$REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
+					if ($delete_txn_reg_status_change) {
+						$this->_maybe_send_notifications();
+						$this->_process_registration_status_change(
+							$payment->transaction(),
+							$REG_IDs,
+							$delete_txn_reg_status_change
+						);
+					}
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} elseif ($can_delete) {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid Payment ID was not received, therefore payment form data could not be loaded.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'You do not have access to delete a payment.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$query_args = [
+			'page'   => 'espresso_transactions',
+			'action' => 'view_transaction',
+			'TXN_ID' => $TXD_ID,
+		];
+		$this->_redirect_after_action(
+			! EE_Error::has_error(),
+			$amount > 0
+				? esc_html__('payment', 'event_espresso')
+				: esc_html__('refund', 'event_espresso'),
+			esc_html__('deleted', 'event_espresso'),
+			$query_args
+		);
+	}
+
+
+	/**
+	 * _registration_payment_data_array
+	 * adds info for 'owing' and 'paid' for each registration to the json response
+	 *
+	 * @access protected
+	 * @param array $REG_IDs
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _registration_payment_data_array($REG_IDs)
+	{
+		$registration_payment_data = [];
+		// if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
+		if (! empty($REG_IDs)) {
+			$registrations = EEM_Registration::instance()->get_all([['REG_ID' => ['IN', $REG_IDs]]]);
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					$registration_payment_data[ $registration->ID() ] = [
+						'paid'  => $registration->pretty_paid(),
+						'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
+					];
+				}
+			}
+		}
+
+		return $registration_payment_data;
+	}
+
+
+	/**
+	 * _maybe_send_notifications
+	 * determines whether or not the admin has indicated that notifications should be sent.
+	 * If so, will toggle a filter switch for delivering registration notices.
+	 * If passed an EE_Payment object, then it will trigger payment notifications instead.
+	 *
+	 * @access protected
+	 * @param EE_Payment | null $payment
+	 */
+	protected function _maybe_send_notifications($payment = null)
+	{
+		switch ($payment instanceof EE_Payment) {
+			// payment notifications
+			case true:
+				if ($this->request->getRequestParam('txn_payments[send_notifications]', false, 'bool')) {
+					$this->_process_payment_notification($payment);
+				}
+				break;
+			// registration notifications
+			case false:
+				if ($this->request->getRequestParam('txn_reg_status_change[send_notifications]', false, 'bool')) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				}
+				break;
+		}
+	}
+
+
+	/**
+	 * _send_payment_reminder
+	 *    generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _send_payment_reminder()
+	{
+		$TXN_ID      = $this->request->getRequestParam('TXN_ID', 0, 'int');
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$redirect_to = $this->request->getRequestParam('redirect_to');
+		$query_args  = $redirect_to
+			? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,]
+			: [];
+		do_action(
+			'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			$transaction
+		);
+		$this->_redirect_after_action(
+			false,
+			esc_html__('payment reminder', 'event_espresso'),
+			esc_html__('sent', 'event_espresso'),
+			$query_args,
+			true
+		);
+	}
+
+
+	/**
+	 *  get_transactions
+	 *    get transactions for given parameters (used by list table)
+	 *
+	 * @param int     $per_page how many transactions displayed per page
+	 * @param boolean $count    return the count or objects
+	 * @param string  $view
+	 * @return EE_Transaction[]|int int = count || array of transaction objects
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_transactions($per_page, $count = false, $view = '')
+	{
+		$start_date = wp_strip_all_tags(
+			$this->request->getRequestParam('txn-filter-start-date', date('m/d/Y', strtotime('-10 year')))
+		);
+		$end_date   = wp_strip_all_tags(
+			$this->request->getRequestParam('txn-filter-end-date', date('m/d/Y'))
+		);
+
+		// make sure our timestamps start and end right at the boundaries for each day
+		$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+		$end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+
+
+		// convert to timestamps
+		$start_date = strtotime($start_date);
+		$end_date   = strtotime($end_date);
+
+		// makes sure start date is the lowest value and vice versa
+		$start_date = min($start_date, $end_date);
+		$end_date   = max($start_date, $end_date);
+
+		// convert to correct format for query
+		$start_date = EEM_Transaction::instance()->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', $start_date),
+			'Y-m-d H:i:s'
+		);
+		$end_date   = EEM_Transaction::instance()->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', $end_date),
+			'Y-m-d H:i:s'
+		);
+
+
+		// set orderby
+		$orderby = $this->request->getRequestParam('orderby');
+
+		switch ($orderby) {
+			case 'TXN_ID':
+				break;
+			case 'ATT_fname':
+				$orderby = 'Registration.Attendee.ATT_fname';
+				break;
+			case 'event_name':
+				$orderby = 'Registration.Event.EVT_name';
+				break;
+			default: // 'TXN_timestamp'
+				$orderby = 'TXN_timestamp';
+		}
+
+		$sort         = $this->request->getRequestParam('order', 'DESC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+
+		$per_page = absint($per_page)
+			? $per_page
+			: 10;
+		$per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$_where = [
+			'TXN_timestamp'          => ['BETWEEN', [$start_date, $end_date]],
+			'Registration.REG_count' => 1,
+		];
+
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		if ($EVT_ID) {
+			$_where['Registration.EVT_ID'] = $EVT_ID;
+		}
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term  = '%' . $search_term . '%';
+			$_where['OR'] = [
+				'Registration.Event.EVT_name'         => ['LIKE', $search_term],
+				'Registration.Event.EVT_desc'         => ['LIKE', $search_term],
+				'Registration.Event.EVT_short_desc'   => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_full_name' => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_fname'     => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_lname'     => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_short_bio' => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_email'     => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_address'   => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_address2'  => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_city'      => ['LIKE', $search_term],
+				'Registration.REG_final_price'        => ['LIKE', $search_term],
+				'Registration.REG_code'               => ['LIKE', $search_term],
+				'Registration.REG_count'              => ['LIKE', $search_term],
+				'Registration.REG_group_size'         => ['LIKE', $search_term],
+				'Registration.Ticket.TKT_name'        => ['LIKE', $search_term],
+				'Registration.Ticket.TKT_description' => ['LIKE', $search_term],
+				'Payment.PAY_source'                  => ['LIKE', $search_term],
+				'Payment.Payment_Method.PMD_name'     => ['LIKE', $search_term],
+				'TXN_session_data'                    => ['LIKE', $search_term],
+				'Payment.PAY_txn_id_chq_nmbr'         => ['LIKE', $search_term],
+			];
+		}
+
+		$status = $this->request->getRequestParam('status');
+		// failed transactions
+		$failed     = (! empty($status) && $status === 'failed' && ! $count) || ($count && $view === 'failed');
+		$abandoned  = (! empty($status) && $status === 'abandoned' && ! $count) || ($count && $view === 'abandoned');
+		$incomplete = (! empty($status) && $status === 'incomplete' && ! $count) || ($count && $view === 'incomplete');
+
+		if ($failed) {
+			$_where['STS_ID'] = EEM_Transaction::failed_status_code;
+		} elseif ($abandoned) {
+			$_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
+		} elseif ($incomplete) {
+			$_where['STS_ID'] = EEM_Transaction::incomplete_status_code;
+		} else {
+			$_where['STS_ID']  = ['!=', EEM_Transaction::failed_status_code];
+			$_where['STS_ID*'] = ['!=', EEM_Transaction::abandoned_status_code];
+		}
+
+		$query_params = apply_filters(
+			'FHEE__Transactions_Admin_Page___get_transactions_query_params',
+			[
+				$_where,
+				'order_by'                 => [$orderby => $sort],
+				'limit'                    => $limit,
+				'default_where_conditions' => EEM_Base::default_where_conditions_this_only,
+			],
+			$this->request->requestParams(),
+			$view,
+			$count
+		);
+
+		return $count
+			? EEM_Transaction::instance()->count([$query_params[0]], 'TXN_ID', true)
+			: EEM_Transaction::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @since 4.9.79.p
+	 */
+	public function recalculateLineItems()
+	{
+		$TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
+		/** @var EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$success     = $transaction->recalculateLineItems();
+		$redirect_to = $this->request->getRequestParam('redirect_to');
+		$query_args  = $redirect_to
+			? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,]
+			: [];
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Transaction taxes and totals', 'event_espresso'),
+			esc_html__('recalculated', 'event_espresso'),
+			$query_args,
+			true
+		);
+	}
 }

Spacing +101 added lines, -101 removed lines

@@ -243,7 +243,7 @@ 
             'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__(
+        EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__(
             'An error occurred! Please refresh the page and try again.',
             'event_espresso'
         );
@@ -344,7 +344,7 @@ 
         // enqueue style
         wp_register_style(
             'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.css',
+            TXN_ASSETS_URL.'espresso_transactions_admin.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -352,7 +352,7 @@ 
         // scripts
         wp_register_script(
             'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.js',
+            TXN_ASSETS_URL.'espresso_transactions_admin.js',
             [
                 'ee_admin_js',
                 'ee-datepicker',
@@ -479,7 +479,7 @@ 
             $this->_transaction->verify_abandoned_transaction_status();
         }
 
-        if (! $this->_transaction instanceof EE_Transaction) {
+        if ( ! $this->_transaction instanceof EE_Transaction) {
             $error_msg = sprintf(
                 esc_html__(
                     'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
@@ -576,7 +576,7 @@ 
             'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
             [
                 'overpaid'   => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::overpaid_status_code,
+                    'class' => 'ee-status-legend ee-status-bg--'.EEM_Transaction::overpaid_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::overpaid_status_code,
                         false,
@@ -584,7 +584,7 @@ 
                     ),
                 ],
                 'complete'   => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::complete_status_code,
+                    'class' => 'ee-status-legend ee-status-bg--'.EEM_Transaction::complete_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::complete_status_code,
                         false,
@@ -592,7 +592,7 @@ 
                     ),
                 ],
                 'incomplete' => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::incomplete_status_code,
+                    'class' => 'ee-status-legend ee-status-bg--'.EEM_Transaction::incomplete_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::incomplete_status_code,
                         false,
@@ -600,7 +600,7 @@ 
                     ),
                 ],
                 'abandoned'  => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::abandoned_status_code,
+                    'class' => 'ee-status-legend ee-status-bg--'.EEM_Transaction::abandoned_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::abandoned_status_code,
                         false,
@@ -608,7 +608,7 @@ 
                     ),
                 ],
                 'failed'     => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::failed_status_code,
+                    'class' => 'ee-status-legend ee-status-bg--'.EEM_Transaction::failed_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::failed_status_code,
                         false,
@@ -651,11 +651,11 @@ 
                 )
                 . '" aria-label="'
                 . esc_attr__('Click to Edit event', 'event_espresso')
-                . '">' . $event->name() . '</a>',
+                . '">'.$event->name().'</a>',
                 '</h3>'
             )
             : '';
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
+        $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items());
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -685,7 +685,7 @@ 
 
         $this->_set_transaction_object();
 
-        if (! $this->_transaction instanceof EE_Transaction) {
+        if ( ! $this->_transaction instanceof EE_Transaction) {
             return;
         }
 
@@ -695,7 +695,7 @@ 
         $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
         $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
 
-        $this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->status_ID() ];
+        $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->status_ID()];
         $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
         $this->_template_args['txn_status']['class'] = $this->_transaction->status_ID();
 
@@ -740,7 +740,7 @@ 
 
 
         // next link
-        $next_txn                                 = $this->_transaction->next(
+        $next_txn = $this->_transaction->next(
             null,
             [['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
             'TXN_ID'
@@ -755,7 +755,7 @@ 
             )
             : '';
         // previous link
-        $previous_txn                                 = $this->_transaction->previous(
+        $previous_txn = $this->_transaction->previous(
             null,
             [['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
             'TXN_ID'
@@ -807,7 +807,7 @@ 
         // grab messages at the last second
         $this->_template_args['notices'] = EE_Error::get_notices();
         // path to template
-        $template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+        $template_path                             = TXN_TEMPLATE_PATH.'txn_admin_details_header.template.php';
         $this->_template_args['admin_page_header'] = EEH_Template::display_template(
             $template_path,
             $this->_template_args,
@@ -835,19 +835,19 @@ 
     {
         $this->_set_transaction_object();
 
-        if (! $this->_transaction instanceof EE_Transaction) {
+        if ( ! $this->_transaction instanceof EE_Transaction) {
             return;
         }
         $this->addMetaBox(
             'edit-txn-details-mbox',
-            '<span>' . esc_html__('Transaction Details', 'event_espresso')
+            '<span>'.esc_html__('Transaction Details', 'event_espresso')
             . '&nbsp;<span class="dashicons dashicons-cart" ></span></span>',
             [$this, 'txn_details_meta_box'],
             $this->_wp_page_slug
         );
         $this->addMetaBox(
             'edit-txn-attendees-mbox',
-            '<span>' . esc_html__('Attendees Registered in this Transaction', 'event_espresso')
+            '<span>'.esc_html__('Attendees Registered in this Transaction', 'event_espresso')
             . '&nbsp;<span class="dashicons dashicons-groups" ></span></span>',
             [$this, 'txn_attendees_meta_box'],
             $this->_wp_page_slug,
@@ -889,7 +889,7 @@ 
     {
         $content = '';
         $actions = [];
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             return $content;
         }
         /** @var EE_Registration $primary_registration */
@@ -1000,7 +1000,7 @@ 
             $this->_transaction->primary_registration() instanceof EE_Registration
                 ? $this->_transaction->primary_registration()->attendee()
                 : null;
-        $this->_template_args['can_edit_payments']   = $this->capabilities->current_user_can(
+        $this->_template_args['can_edit_payments'] = $this->capabilities->current_user_can(
             'ee_edit_payments',
             'apply_payment_or_refund_from_registration_details'
         );
@@ -1011,7 +1011,7 @@ 
 
         // get line table
         EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display                       = new EE_Line_Item_Display(
+        $Line_Item_Display = new EE_Line_Item_Display(
             'admin_table',
             'EE_Admin_Table_Line_Item_Display_Strategy'
         );
@@ -1028,7 +1028,7 @@ 
             ? $taxes
             : false;
 
-        $this->_template_args['grand_total']     = EEH_Template::format_currency(
+        $this->_template_args['grand_total'] = EEH_Template::format_currency(
             $this->_transaction->total(),
             false,
             false
@@ -1038,7 +1038,7 @@ 
 
         // process payment details
         $payments = $this->_transaction->payments();
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             $this->_template_args['payments']              = $payments;
             $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
         } else {
@@ -1096,7 +1096,7 @@ 
                                   esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
                                   ucwords(str_replace('_', ' ', $reg_step)),
                                   date(
-                                      get_option('date_format') . ' ' . get_option('time_format'),
+                                      get_option('date_format').' '.get_option('time_format'),
                                       $reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)
                                   )
                               )
@@ -1110,7 +1110,7 @@ 
                               . '</div>';
             }
         }
-        $reg_steps                                                 .= '</ul>';
+        $reg_steps .= '</ul>';
         $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
         $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
             'Registration Step Progress',
@@ -1123,14 +1123,14 @@ 
         $this->_get_payment_status_array();
         $this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction.
 
-        $this->_template_args['transaction_form_url']    = add_query_arg(
+        $this->_template_args['transaction_form_url'] = add_query_arg(
             [
                 'action'  => 'edit_transaction',
                 'process' => 'transaction',
             ],
             TXN_ADMIN_URL
         );
-        $this->_template_args['apply_payment_form_url']  = add_query_arg(
+        $this->_template_args['apply_payment_form_url'] = add_query_arg(
             [
                 'page'   => 'espresso_transactions',
                 'action' => 'espresso_apply_payment',
@@ -1149,7 +1149,7 @@ 
 
         // 'espresso_delete_payment_nonce'
 
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_txn_details.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -1181,19 +1181,19 @@ 
                 ],
             ]
         );
-        if (! empty($reg_payments)) {
+        if ( ! empty($reg_payments)) {
             foreach ($payments as $payment) {
-                if (! $payment instanceof EE_Payment) {
+                if ( ! $payment instanceof EE_Payment) {
                     continue;
-                } elseif (! isset($existing_reg_payments[ $payment->ID() ])) {
-                    $existing_reg_payments[ $payment->ID() ] = [];
+                } elseif ( ! isset($existing_reg_payments[$payment->ID()])) {
+                    $existing_reg_payments[$payment->ID()] = [];
                 }
                 foreach ($reg_payments as $reg_payment) {
                     if (
                         $reg_payment instanceof EE_Registration_Payment
                         && $reg_payment->payment_ID() === $payment->ID()
                     ) {
-                        $existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID();
+                        $existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID();
                     }
                 }
             }
@@ -1219,7 +1219,7 @@ 
     protected function _get_registrations_to_apply_payment_to()
     {
         // we want any registration with an active status (ie: not deleted or cancelled)
-        $query_params                      = [
+        $query_params = [
             [
                 'STS_ID' => [
                     'IN',
@@ -1231,22 +1231,22 @@ 
                 ],
             ],
         ];
-        $registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div(
+        $registrations_to_apply_payment_to = EEH_HTML::br().EEH_HTML::div(
                 '',
                 'txn-admin-apply-payment-to-registrations-dv',
                 '',
                 'clear: both; margin: 1.5em 0 0; display: none;'
             );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+        $registrations_to_apply_payment_to .= EEH_HTML::br().EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
         $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl striped');
         $registrations_to_apply_payment_to .= EEH_HTML::thead(
             EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+                EEH_HTML::th(esc_html__('ID', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Event', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr').
+                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr').
                 EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
             )
         );
@@ -1261,36 +1261,36 @@ 
                     : esc_html__('Unknown Attendee', 'event_espresso');
                 $owing                             = $registration->final_price() - $registration->paid();
                 $taxable                           = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+                    ? ' <span class="smaller-text lt-grey-text"> '.esc_html__('+ tax', 'event_espresso').'</span>'
                     : '';
                 $checked                           = empty($existing_reg_payments)
                                                      || in_array($registration->ID(), $existing_reg_payments, true)
                     ? ' checked'
                     : '';
-                $disabled                          = $registration->final_price() > 0
+                $disabled = $registration->final_price() > 0
                     ? ''
                     : ' disabled';
                 $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
+                    EEH_HTML::td($registration->ID()).
+                    EEH_HTML::td($attendee_name).
                     EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
+                        $registration->ticket()->name().' : '.$registration->ticket()->pretty_price().$taxable
+                    ).
+                    EEH_HTML::td($registration->event_name()).
+                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr').
                     EEH_HTML::td(
                         EEH_Template::format_currency($owing),
                         '',
                         'txn-admin-payment-owing-td jst-cntr'
-                    ) .
+                    ).
                     EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
+                        '<input type="checkbox" value="'.$registration->ID()
                         . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
+                        . $checked.$disabled.'>',
                         '',
                         'jst-cntr'
                     ),
-                    'apply-payment-registration-row-' . $registration->ID()
+                    'apply-payment-registration-row-'.$registration->ID()
                 );
             }
         }
@@ -1305,7 +1305,7 @@ 
             '',
             'clear description'
         );
-        $registrations_to_apply_payment_to                         .= EEH_HTML::divx();
+        $registrations_to_apply_payment_to .= EEH_HTML::divx();
         $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
     }
 
@@ -1371,12 +1371,12 @@ 
                 [
                     'OR*payment_method_for_payment' => [
                         'PMD_ID'    => ['IN', $payment_methods_of_payments],
-                        'PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%'],
+                        'PMD_scope' => ['LIKE', '%'.EEM_Payment_Method::scope_admin.'%'],
                     ],
                 ],
             ];
         } else {
-            $query_args = [['PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%']]];
+            $query_args = [['PMD_scope' => ['LIKE', '%'.EEM_Payment_Method::scope_admin.'%']]];
         }
         $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
     }
@@ -1408,7 +1408,7 @@ 
             'Line_Item',
             [['LIN_type' => 'line-item']]
         );
-        if (! empty($line_items)) {
+        if ( ! empty($line_items)) {
             foreach ($line_items as $item) {
                 if ($item instanceof EE_Line_Item) {
                     switch ($item->OBJ_type()) {
@@ -1418,7 +1418,7 @@ 
                             $ticket = $item->ticket();
                             // right now we're only handling tickets here.
                             // Cause its expected that only tickets will have attendees right?
-                            if (! $ticket instanceof EE_Ticket) {
+                            if ( ! $ticket instanceof EE_Ticket) {
                                 break;
                             }
                             try {
@@ -1427,45 +1427,45 @@ 
                                 EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                                 $event_name = esc_html__('Unknown Event', 'event_espresso');
                             }
-                            $event_name   .= ' - ' . $item->name();
+                            $event_name   .= ' - '.$item->name();
                             $ticket_price = EEH_Template::format_currency($item->unit_price());
                             // now get all of the registrations for this transaction that use this ticket
                             $registrations = $ticket->registrations(
                                 [['TXN_ID' => $this->_transaction->ID()]]
                             );
                             foreach ($registrations as $registration) {
-                                if (! $registration instanceof EE_Registration) {
+                                if ( ! $registration instanceof EE_Registration) {
                                     break;
                                 }
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID']
+                                $this->_template_args['event_attendees'][$registration->ID()]['STS_ID']
                                     = $registration->status_ID();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['att_num']
+                                $this->_template_args['event_attendees'][$registration->ID()]['att_num']
                                     = $registration->count();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name']
+                                $this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name']
                                     = $event_name;
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price']
+                                $this->_template_args['event_attendees'][$registration->ID()]['ticket_price']
                                     = $ticket_price;
                                 // attendee info
                                 $attendee = $registration->get_first_related('Attendee');
                                 if ($attendee instanceof EE_Attendee) {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id']
+                                    $this->_template_args['event_attendees'][$registration->ID()]['att_id']
                                         = $attendee->ID();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee']
+                                    $this->_template_args['event_attendees'][$registration->ID()]['attendee']
                                         = $attendee->full_name();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email']
-                                        = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
+                                    $this->_template_args['event_attendees'][$registration->ID()]['email']
+                                        = '<a href="mailto:'.$attendee->email().'?subject='.$event_name
                                           . esc_html__(
                                               ' Event',
                                               'event_espresso'
                                           )
-                                          . '">' . $attendee->email() . '</a>';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address']
+                                          . '">'.$attendee->email().'</a>';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['address']
                                         = EEH_Address::format($attendee, 'inline', false, false);
                                 } else {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id']   = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email']    = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address']  = '';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['att_id']   = '';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = '';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['email']    = '';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['address']  = '';
                                 }
                             }
                             break;
@@ -1481,7 +1481,7 @@ 
                 TXN_ADMIN_URL
             );
             echo EEH_Template::display_template(
-                TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+                TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_attendees.template.php',
                 $this->_template_args,
                 true
             );
@@ -1516,12 +1516,12 @@ 
         $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
             ? $this->_transaction->primary_registration()->get_first_related('Attendee')
             : null;
-        if (! $primary_att instanceof EE_Attendee) {
+        if ( ! $primary_att instanceof EE_Attendee) {
             $this->_template_args['no_attendee_message'] = esc_html__(
                 'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
                 'event_espresso'
             );
-            $primary_att                                 = EEM_Attendee::instance()->create_default_object();
+            $primary_att = EEM_Attendee::instance()->create_default_object();
         }
         $this->_template_args['ATT_ID']            = $primary_att->ID();
         $this->_template_args['prime_reg_fname']   = $primary_att->fname();
@@ -1543,7 +1543,7 @@ 
                 : '';
         $this->_template_args['formatted_address'] = $formatted_address;
         echo EEH_Template::display_template(
-            TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+            TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_registrant.template.php',
             $this->_template_args,
             true
         );
@@ -1568,7 +1568,7 @@ 
             TXN_ADMIN_URL
         );
 
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_billing_info.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -1595,7 +1595,7 @@ 
         );
         $TXD_ID     = $this->request->getRequestParam('txn_admin_payment[TXN_ID]', 0, 'int');
         $amount     = 0;
-        if (! empty($valid_data) && $has_access) {
+        if ( ! empty($valid_data) && $has_access) {
             $PAY_ID = $valid_data['PAY_ID'];
             // save  the new payment
             $payment = $this->_create_payment_from_request_data($valid_data);
@@ -1609,7 +1609,7 @@ 
                 $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
                 $this->_remove_existing_registration_payments($payment, $PAY_ID);
                 // apply payment to registrations (if applicable)
-                if (! empty($REG_IDs)) {
+                if ( ! empty($REG_IDs)) {
                     $this->_update_registration_payments($transaction, $payment, $REG_IDs);
                     $this->_maybe_send_notifications();
                     // now process status changes for the same registrations
@@ -1682,14 +1682,14 @@ 
      */
     protected function _validate_payment_request_data()
     {
-        if (! $this->request->requestParamIsSet('txn_admin_payment')) {
+        if ( ! $this->request->requestParamIsSet('txn_admin_payment')) {
             return [];
         }
         $payment_form = $this->_generate_payment_form_section();
         try {
             if ($payment_form->was_submitted()) {
                 $payment_form->receive_form_submission();
-                if (! $payment_form->is_valid()) {
+                if ( ! $payment_form->is_valid()) {
                     $submission_error_messages = [];
                     foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
                         if ($validation_error instanceof EE_Validation_Error) {
@@ -1877,7 +1877,7 @@ 
             ['Y-m-d', 'g:i a']
         );
 
-        if (! $payment->save()) {
+        if ( ! $payment->save()) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
@@ -1953,7 +1953,7 @@ 
             false,
             DataType::BOOL
         );
-        $REG_IDs      = ! $apply_to_all
+        $REG_IDs = ! $apply_to_all
             ? $this->request->getRequestParam(
                 'txn_admin_payment[registrations]',
                 [],
@@ -2090,12 +2090,12 @@ 
         // but add in some conditions regarding payment,
         // so that we don't apply payments to registrations that are free or have already been paid for
         // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
-        if (! $payment->is_a_refund()) {
+        if ( ! $payment->is_a_refund()) {
             $registration_query_where_params['REG_final_price']  = ['!=', 0];
             $registration_query_where_params['REG_final_price*'] = ['!=', 'REG_paid', true];
         }
         $registrations = $transaction->registrations([$registration_query_where_params]);
-        if (! empty($registrations)) {
+        if ( ! empty($registrations)) {
             /** @type EE_Payment_Processor $payment_processor */
             $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
             $payment_processor->process_registration_payments($transaction, $payment, $registrations);
@@ -2179,7 +2179,7 @@ 
             'pay_status'       => $payment->STS_ID(),
             'PAY_ID'           => $payment->ID(),
             'STS_ID'           => $payment->STS_ID(),
-            'status'           => self::$_pay_status[ $payment->STS_ID() ],
+            'status'           => self::$_pay_status[$payment->STS_ID()],
             'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
             'method'           => strtoupper($payment->source()),
             'PM_ID'            => $payment_method instanceof EE_Payment_Method
@@ -2299,11 +2299,11 @@ 
     {
         $registration_payment_data = [];
         // if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
-        if (! empty($REG_IDs)) {
+        if ( ! empty($REG_IDs)) {
             $registrations = EEM_Registration::instance()->get_all([['REG_ID' => ['IN', $REG_IDs]]]);
             foreach ($registrations as $registration) {
                 if ($registration instanceof EE_Registration) {
-                    $registration_payment_data[ $registration->ID() ] = [
+                    $registration_payment_data[$registration->ID()] = [
                         'paid'  => $registration->pretty_paid(),
                         'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
                     ];
@@ -2360,7 +2360,7 @@ 
         $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
         $redirect_to = $this->request->getRequestParam('redirect_to');
         $query_args  = $redirect_to
-            ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,]
+            ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID, ]
             : [];
         do_action(
             'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
@@ -2400,8 +2400,8 @@ 
         );
 
         // make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+        $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
+        $end_date   = date('Y-m-d', strtotime($end_date)).' 23:59:59';
 
 
         // convert to timestamps
@@ -2418,7 +2418,7 @@ 
             date('Y-m-d H:i:s', $start_date),
             'Y-m-d H:i:s'
         );
-        $end_date   = EEM_Transaction::instance()->convert_datetime_for_query(
+        $end_date = EEM_Transaction::instance()->convert_datetime_for_query(
             'TXN_timestamp',
             date('Y-m-d H:i:s', $end_date),
             'Y-m-d H:i:s'
@@ -2464,7 +2464,7 @@ 
 
         $search_term = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term  = '%' . $search_term . '%';
+            $search_term  = '%'.$search_term.'%';
             $_where['OR'] = [
                 'Registration.Event.EVT_name'         => ['LIKE', $search_term],
                 'Registration.Event.EVT_desc'         => ['LIKE', $search_term],
@@ -2492,9 +2492,9 @@ 
 
         $status = $this->request->getRequestParam('status');
         // failed transactions
-        $failed     = (! empty($status) && $status === 'failed' && ! $count) || ($count && $view === 'failed');
-        $abandoned  = (! empty($status) && $status === 'abandoned' && ! $count) || ($count && $view === 'abandoned');
-        $incomplete = (! empty($status) && $status === 'incomplete' && ! $count) || ($count && $view === 'incomplete');
+        $failed     = ( ! empty($status) && $status === 'failed' && ! $count) || ($count && $view === 'failed');
+        $abandoned  = ( ! empty($status) && $status === 'abandoned' && ! $count) || ($count && $view === 'abandoned');
+        $incomplete = ( ! empty($status) && $status === 'incomplete' && ! $count) || ($count && $view === 'incomplete');
 
         if ($failed) {
             $_where['STS_ID'] = EEM_Transaction::failed_status_code;
@@ -2543,7 +2543,7 @@ 
         $success     = $transaction->recalculateLineItems();
         $redirect_to = $this->request->getRequestParam('redirect_to');
         $query_args  = $redirect_to
-            ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,]
+            ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID, ]
             : [];
         $this->_redirect_after_action(
             $success,

admin_pages/transactions/templates/txn_admin_wrapper.template.php

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 <div class="wrap">
 
 	<h2>
-		<?php echo esc_html__('Event Espresso', 'event_espresso') . ' ' . wp_kses($admin_page_title, AllowedTags::getWithFormTags()); ?>
+		<?php echo esc_html__('Event Espresso', 'event_espresso').' '.wp_kses($admin_page_title, AllowedTags::getWithFormTags()); ?>
 	</h2>
 
 	<h2 class="nav-tab-wrapper">