eventespresso / event-espresso-core

modules/single_page_checkout/inc/EE_Checkout.class.php

Indentation +1417 added lines, -1417 removed lines

@@ -14,1422 +14,1422 @@
  */
 class EE_Checkout
 {
-    /**
-     *    whether current request originated from the EE admin
-     *
-     * @var bool
-     */
-    public $admin_request = false;
-
-    /**
-     * whether returning to edit attendee information or to retry a payment
-     *
-     * @var bool
-     */
-    public $revisit = false;
-
-    /**
-     * whether the primary registrant is returning to edit attendee information or to retry a payment
-     *
-     * @var bool
-     */
-    public $primary_revisit = false;
-
-    /**
-     * is registration allowed to progress or halted for some reason such as failing to pass recaptcha?
-     *
-     * @var bool
-     */
-    public $continue_reg = true;
-
-    /**
-     * redirect to thank you page ?
-     *
-     * @var bool
-     */
-    public $redirect = false;
-
-    /**
-     * generate the reg form or not ?
-     *
-     * @var bool
-     */
-    public $generate_reg_form = true;
-
-    /**
-     * process a reg form submission or not ?
-     *
-     * @var bool
-     */
-    public $process_form_submission = false;
-
-    /**
-     * tracks whether the TXN status modified during this checkout
-     *
-     * @var bool
-     */
-    public $txn_status_updated = false;
-
-    /**
-     * only triggered to true after absolutely everything has finished.
-     *
-     * @var bool
-     */
-    protected $exit_spco = false;
-
-    /**
-     * tracks whether any of the TXN's Registrations statuses modified during this checkout
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $reg_status_updated = array();
-
-    /**
-     * timestamp when redirected from Ticket Selector to the checkout
-     *
-     * @var int
-     */
-    public $uts = 0;
-
-    /**
-     * total number of tickets that were in the cart
-     *
-     * @var int
-     */
-    public $total_ticket_count = 0;
-
-    /**
-     * corresponds loosely to EE_Transaction::remaining()
-     * but can be modified by SPCO
-     *
-     * @var float
-     */
-    public $amount_owing = 0;
-
-    /**
-     * the reg step slug from the incoming request
-     *
-     * @var string
-     */
-    public $step = '';
-
-    /**
-     * the reg step slug for a step being edited
-     *
-     * @var string
-     */
-    public $edit_step = '';
-
-    /**
-     * the action being performed on the current step
-     *
-     * @var string
-     */
-    public $action = '';
-
-    /**
-     * reg_url_link for a previously saved registration
-     *
-     * @var string
-     */
-    public $reg_url_link = '';
-
-    /**
-     * string slug for the payment method that was selected during the payment options step
-     *
-     * @var string
-     */
-    public $selected_method_of_payment = '';
-
-    /**
-     * base url for the site's registration checkout page - additional url params will be added to this
-     *
-     * @var string
-     */
-    public $reg_page_base_url = '';
-
-    /**
-     * base url for the site's registration cancelled page - additional url params will be added to this
-     *
-     * @var string
-     */
-    public $cancel_page_url = '';
-
-    /**
-     * base url for the site's thank you page - additional url params will be added to this
-     *
-     * @var string
-     */
-    public $thank_you_page_url = '';
-
-    /**
-     * base url for any redirects - additional url params will be added to this
-     *
-     * @var string
-     */
-    public $redirect_url = '';
-
-    /**
-     * form of POST data for use with off-site gateways
-     *
-     * @var string
-     */
-    public $redirect_form = '';
-
-    /**
-     * array of query where params to use when retrieving cached registrations from $this->checkout->transaction
-     *
-     * @var array
-     */
-    public $reg_cache_where_params = array();
-
-    /**
-     * a class for managing and creating the JSON encoded array of data that gets passed back to the client during AJAX
-     * requests
-     *
-     * @var EE_SPCO_JSON_Response
-     */
-    public $json_response;
-
-    /**
-     * where we are going next in the reg process
-     *
-     * @var EE_SPCO_Reg_Step
-     */
-    public $next_step;
-
-    /**
-     * where we are in the reg process
-     *
-     * @var EE_SPCO_Reg_Step
-     */
-    public $current_step;
-
-    /**
-     *    $_cart - the current cart object
-     *
-     * @var EE_CART
-     */
-    public $cart;
-
-    /**
-     *    $_transaction - the current transaction object
-     *
-     * @var EE_Transaction
-     */
-    public $transaction;
-
-    /**
-     *    the related attendee object for the primary registrant
-     *
-     * @var EE_Attendee
-     */
-    public $primary_attendee_obj;
-
-    /**
-     *    $payment_method - the payment method object for the selected method of payment
-     *
-     * @var EE_Payment_Method
-     */
-    public $payment_method;
-
-    /**
-     *    $payment - if a payment was successfully made during the reg process,
-     *    then here it is !!!
-     *
-     * @var EE_Payment
-     */
-    public $payment;
-
-    /**
-     *    if a payment method was selected that uses an on-site gateway, then this is the billing form
-     *
-     * @var EE_Billing_Info_Form|EE_Billing_Attendee_Info_Form
-     */
-    public $billing_form;
-
-    /**
-     *    the entire registration form composed of ALL of the subsections generated by the various reg steps
-     *
-     * @var EE_Form_Section_Proper
-     */
-    public $registration_form;
-
-    /**
-     * array of EE_SPCO_Reg_Step objects
-     *
-     * @var EE_SPCO_Reg_Step[]
-     */
-    public $reg_steps = array();
-
-    /**
-     * array of EE_Payment_Method objects
-     *
-     * @var EE_Payment_Method[]
-     */
-    public $available_payment_methods = array();
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        $this->reg_page_base_url = EE_Registry::instance()->CFG->core->reg_page_url();
-        $this->thank_you_page_url = EE_Registry::instance()->CFG->core->thank_you_page_url();
-        $this->cancel_page_url = EE_Registry::instance()->CFG->core->cancel_page_url();
-        $this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
-
-        $this->admin_request = is_admin() && ! EED_Single_Page_Checkout::getRequest()->isAjax();
-        $this->reg_cache_where_params = array(
-            0          => array('REG_deleted' => false),
-            'order_by' => array('REG_count' => 'ASC'),
-        );
-    }
-
-
-    /**
-     * returns true if ANY reg status was updated during checkout
-     *
-     * @return boolean
-     */
-    public function any_reg_status_updated()
-    {
-        foreach ($this->reg_status_updated as $reg_status) {
-            if ($reg_status) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @param $REG_ID
-     * @return boolean
-     */
-    public function reg_status_updated($REG_ID)
-    {
-        return isset($this->reg_status_updated[ $REG_ID ]) ? $this->reg_status_updated[ $REG_ID ] : false;
-    }
-
-
-    /**
-     * @param $REG_ID
-     * @param $reg_status
-     */
-    public function set_reg_status_updated($REG_ID, $reg_status)
-    {
-        $this->reg_status_updated[ $REG_ID ] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * exit_spco
-     *
-     * @return bool
-     */
-    public function exit_spco()
-    {
-        return $this->exit_spco;
-    }
-
-
-    /**
-     * set_exit_spco
-     * can ONLY be set by the  Finalize_Registration reg step
-     */
-    public function set_exit_spco()
-    {
-        if ($this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
-            $this->exit_spco = true;
-        }
-    }
-
-
-    /**
-     *    reset_for_current_request
-     *
-     * @access    public
-     * @return    void
-     */
-    public function reset_for_current_request()
-    {
-        $this->process_form_submission = false;
-        $this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
-        $this->admin_request = is_admin() && ! EED_Single_Page_Checkout::getRequest()->isFrontAjax();
-        $this->continue_reg = true;
-        $this->redirect = false;
-        // don't reset the cached redirect form if we're about to be asked to display it !!!
-        $action = EED_Single_Page_Checkout::getRequest()->getRequestParam('action', 'display_spco_reg_step');
-        if ($action !== 'redirect_form') {
-            $this->redirect_form = '';
-        }
-        $this->redirect_url = '';
-        $this->json_response = new EE_SPCO_JSON_Response();
-        EE_Form_Section_Proper::reset_js_localization();
-    }
-
-
-    /**
-     *    add_reg_step
-     *
-     * @access    public
-     * @param EE_SPCO_Reg_Step $reg_step_obj
-     * @return    void
-     */
-    public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj)
-    {
-        $this->reg_steps[ $reg_step_obj->slug() ] = $reg_step_obj;
-    }
-
-
-    /**
-     * skip_reg_step
-     * if the current reg step does not need to run for some reason,
-     * then this will advance SPCO to the next reg step,
-     * and mark the skipped step as completed
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function skip_reg_step($reg_step_slug = '')
-    {
-        $step_to_skip = $this->find_reg_step($reg_step_slug);
-        if ($step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step()) {
-            $step_to_skip->set_is_current_step(false);
-            $step_to_skip->set_completed();
-            // advance to the next step
-            $this->set_current_step($this->next_step->slug());
-            // also reset the step param in the request in case any other code references that directly
-            EED_Single_Page_Checkout::getRequest()->setRequestParam('step', $this->current_step->slug());
-            // since we are skipping a step and setting the current step to be what was previously the next step,
-            // we need to check that the next step is now correct, and not still set to the current step.
-            if ($this->current_step->slug() === $this->next_step->slug()) {
-                // correctly setup the next step
-                $this->set_next_step();
-            }
-            $this->set_reg_step_initiated($this->current_step);
-        }
-    }
-
-
-    /**
-     *    remove_reg_step
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @param bool   $reset whether to reset reg steps after removal
-     * @throws EE_Error
-     */
-    public function remove_reg_step($reg_step_slug = '', $reset = true)
-    {
-        unset($this->reg_steps[ $reg_step_slug ]);
-        if ($this->transaction instanceof EE_Transaction) {
-            // now remove reg step from TXN and save
-            $this->transaction->remove_reg_step($reg_step_slug);
-            $this->transaction->save();
-        }
-        if ($reset) {
-            $this->reset_reg_steps();
-        }
-    }
-
-
-    /**
-     *    set_reg_step_order
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @param int    $order
-     * @return    void
-     */
-    public function set_reg_step_order($reg_step_slug = '', $order = 100)
-    {
-        if (isset($this->reg_steps[ $reg_step_slug ])) {
-            $this->reg_steps[ $reg_step_slug ]->set_order($order);
-        }
-    }
-
-
-    /**
-     * @param string $current_step
-     * @return void
-     */
-    public function set_current_step(string $current_step)
-    {
-        // grab what step we're on
-        $this->current_step = $this->reg_steps[ $current_step ] ?? reset($this->reg_steps);
-        // verify instance
-        if (! $this->current_step instanceof EE_SPCO_Reg_Step) {
-            EE_Error::add_error(
-                esc_html__('The current step could not be set.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // we don't want to repeat completed steps if this is the first time through SPCO
-        if ($this->continue_reg && ! $this->revisit && $this->current_step->completed()) {
-            // so advance to the next step
-            $this->set_next_step();
-            if ($this->next_step instanceof EE_SPCO_Reg_Step) {
-                // and attempt to set it as the current step
-                $this->set_current_step($this->next_step->slug());
-            }
-            return;
-        }
-        $this->current_step->set_is_current_step(true);
-        $this->current_step->setRequest(EED_Single_Page_Checkout::getRequest());
-    }
-
-
-    /**
-     *    set_next_step
-     * advances the reg_steps array pointer and sets the next step, then reverses pointer back to the current step
-     *
-     * @access    public
-     * @return    void
-     */
-    public function set_next_step()
-    {
-        // set pointer to start of array
-        reset($this->reg_steps);
-        // if there is more than one step
-        if (count($this->reg_steps) > 1) {
-            // advance to the current step and set pointer
-            while (key($this->reg_steps) !== $this->current_step->slug() && key($this->reg_steps) !== '') {
-                next($this->reg_steps);
-            }
-        }
-        // advance one more spot ( if it exists )
-        $this->next_step = next($this->reg_steps);
-        // verify instance
-        $this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step : null;
-        // then back to current step to reset
-        prev($this->reg_steps);
-    }
-
-
-    /**
-     *    get_next_reg_step
-     *    this simply returns the next step from reg_steps array
-     *
-     * @access    public
-     * @return    EE_SPCO_Reg_Step | null
-     */
-    public function get_next_reg_step()
-    {
-        $next = next($this->reg_steps);
-        prev($this->reg_steps);
-        return $next instanceof EE_SPCO_Reg_Step ? $next : null;
-    }
-
-
-    /**
-     * get_prev_reg_step
-     *    this simply returns the previous step from reg_steps array
-     *
-     * @access    public
-     * @return    EE_SPCO_Reg_Step | null
-     */
-    public function get_prev_reg_step()
-    {
-        $prev = prev($this->reg_steps);
-        next($this->reg_steps);
-        return $prev instanceof EE_SPCO_Reg_Step ? $prev : null;
-    }
-
-
-    /**
-     * sort_reg_steps
-     *
-     * @access public
-     * @return void
-     */
-    public function sort_reg_steps()
-    {
-        $reg_step_sorting_callback = apply_filters(
-            'FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback',
-            'reg_step_sorting_callback'
-        );
-        uasort($this->reg_steps, array($this, $reg_step_sorting_callback));
-    }
-
-
-    /**
-     * find_reg_step
-     * finds a reg step by the given slug
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @return EE_SPCO_Reg_Step|null
-     */
-    public function find_reg_step($reg_step_slug = '')
-    {
-        if (! empty($reg_step_slug)) {
-            // copy reg step array
-            $reg_steps = $this->reg_steps;
-            // set pointer to start of array
-            reset($reg_steps);
-            // if there is more than one step
-            if (count($reg_steps) > 1) {
-                // advance to the current step and set pointer
-                while (key($reg_steps) !== $reg_step_slug && key($reg_steps) !== '') {
-                    next($reg_steps);
-                }
-                return current($reg_steps);
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * reg_step_sorting_callback
-     *
-     * @access public
-     * @param EE_SPCO_Reg_Step $reg_step_A
-     * @param EE_SPCO_Reg_Step $reg_step_B
-     * @return int
-     */
-    public function reg_step_sorting_callback(EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B)
-    {
-        // send finalize_registration step to the end of the array
-        if ($reg_step_A->slug() === 'finalize_registration') {
-            return 1;
-        } elseif ($reg_step_B->slug() === 'finalize_registration') {
-            return -1;
-        }
-        if ($reg_step_A->order() === $reg_step_B->order()) {
-            return 0;
-        }
-        return ($reg_step_A->order() > $reg_step_B->order()) ? 1 : -1;
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     *
-     * @access    public
-     * @param    EE_SPCO_Reg_Step $reg_step
-     * @throws \EE_Error
-     */
-    public function set_reg_step_initiated(EE_SPCO_Reg_Step $reg_step)
-    {
-        // call set_reg_step_initiated ???
-        if (
+	/**
+	 *    whether current request originated from the EE admin
+	 *
+	 * @var bool
+	 */
+	public $admin_request = false;
+
+	/**
+	 * whether returning to edit attendee information or to retry a payment
+	 *
+	 * @var bool
+	 */
+	public $revisit = false;
+
+	/**
+	 * whether the primary registrant is returning to edit attendee information or to retry a payment
+	 *
+	 * @var bool
+	 */
+	public $primary_revisit = false;
+
+	/**
+	 * is registration allowed to progress or halted for some reason such as failing to pass recaptcha?
+	 *
+	 * @var bool
+	 */
+	public $continue_reg = true;
+
+	/**
+	 * redirect to thank you page ?
+	 *
+	 * @var bool
+	 */
+	public $redirect = false;
+
+	/**
+	 * generate the reg form or not ?
+	 *
+	 * @var bool
+	 */
+	public $generate_reg_form = true;
+
+	/**
+	 * process a reg form submission or not ?
+	 *
+	 * @var bool
+	 */
+	public $process_form_submission = false;
+
+	/**
+	 * tracks whether the TXN status modified during this checkout
+	 *
+	 * @var bool
+	 */
+	public $txn_status_updated = false;
+
+	/**
+	 * only triggered to true after absolutely everything has finished.
+	 *
+	 * @var bool
+	 */
+	protected $exit_spco = false;
+
+	/**
+	 * tracks whether any of the TXN's Registrations statuses modified during this checkout
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $reg_status_updated = array();
+
+	/**
+	 * timestamp when redirected from Ticket Selector to the checkout
+	 *
+	 * @var int
+	 */
+	public $uts = 0;
+
+	/**
+	 * total number of tickets that were in the cart
+	 *
+	 * @var int
+	 */
+	public $total_ticket_count = 0;
+
+	/**
+	 * corresponds loosely to EE_Transaction::remaining()
+	 * but can be modified by SPCO
+	 *
+	 * @var float
+	 */
+	public $amount_owing = 0;
+
+	/**
+	 * the reg step slug from the incoming request
+	 *
+	 * @var string
+	 */
+	public $step = '';
+
+	/**
+	 * the reg step slug for a step being edited
+	 *
+	 * @var string
+	 */
+	public $edit_step = '';
+
+	/**
+	 * the action being performed on the current step
+	 *
+	 * @var string
+	 */
+	public $action = '';
+
+	/**
+	 * reg_url_link for a previously saved registration
+	 *
+	 * @var string
+	 */
+	public $reg_url_link = '';
+
+	/**
+	 * string slug for the payment method that was selected during the payment options step
+	 *
+	 * @var string
+	 */
+	public $selected_method_of_payment = '';
+
+	/**
+	 * base url for the site's registration checkout page - additional url params will be added to this
+	 *
+	 * @var string
+	 */
+	public $reg_page_base_url = '';
+
+	/**
+	 * base url for the site's registration cancelled page - additional url params will be added to this
+	 *
+	 * @var string
+	 */
+	public $cancel_page_url = '';
+
+	/**
+	 * base url for the site's thank you page - additional url params will be added to this
+	 *
+	 * @var string
+	 */
+	public $thank_you_page_url = '';
+
+	/**
+	 * base url for any redirects - additional url params will be added to this
+	 *
+	 * @var string
+	 */
+	public $redirect_url = '';
+
+	/**
+	 * form of POST data for use with off-site gateways
+	 *
+	 * @var string
+	 */
+	public $redirect_form = '';
+
+	/**
+	 * array of query where params to use when retrieving cached registrations from $this->checkout->transaction
+	 *
+	 * @var array
+	 */
+	public $reg_cache_where_params = array();
+
+	/**
+	 * a class for managing and creating the JSON encoded array of data that gets passed back to the client during AJAX
+	 * requests
+	 *
+	 * @var EE_SPCO_JSON_Response
+	 */
+	public $json_response;
+
+	/**
+	 * where we are going next in the reg process
+	 *
+	 * @var EE_SPCO_Reg_Step
+	 */
+	public $next_step;
+
+	/**
+	 * where we are in the reg process
+	 *
+	 * @var EE_SPCO_Reg_Step
+	 */
+	public $current_step;
+
+	/**
+	 *    $_cart - the current cart object
+	 *
+	 * @var EE_CART
+	 */
+	public $cart;
+
+	/**
+	 *    $_transaction - the current transaction object
+	 *
+	 * @var EE_Transaction
+	 */
+	public $transaction;
+
+	/**
+	 *    the related attendee object for the primary registrant
+	 *
+	 * @var EE_Attendee
+	 */
+	public $primary_attendee_obj;
+
+	/**
+	 *    $payment_method - the payment method object for the selected method of payment
+	 *
+	 * @var EE_Payment_Method
+	 */
+	public $payment_method;
+
+	/**
+	 *    $payment - if a payment was successfully made during the reg process,
+	 *    then here it is !!!
+	 *
+	 * @var EE_Payment
+	 */
+	public $payment;
+
+	/**
+	 *    if a payment method was selected that uses an on-site gateway, then this is the billing form
+	 *
+	 * @var EE_Billing_Info_Form|EE_Billing_Attendee_Info_Form
+	 */
+	public $billing_form;
+
+	/**
+	 *    the entire registration form composed of ALL of the subsections generated by the various reg steps
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	public $registration_form;
+
+	/**
+	 * array of EE_SPCO_Reg_Step objects
+	 *
+	 * @var EE_SPCO_Reg_Step[]
+	 */
+	public $reg_steps = array();
+
+	/**
+	 * array of EE_Payment_Method objects
+	 *
+	 * @var EE_Payment_Method[]
+	 */
+	public $available_payment_methods = array();
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		$this->reg_page_base_url = EE_Registry::instance()->CFG->core->reg_page_url();
+		$this->thank_you_page_url = EE_Registry::instance()->CFG->core->thank_you_page_url();
+		$this->cancel_page_url = EE_Registry::instance()->CFG->core->cancel_page_url();
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
+
+		$this->admin_request = is_admin() && ! EED_Single_Page_Checkout::getRequest()->isAjax();
+		$this->reg_cache_where_params = array(
+			0          => array('REG_deleted' => false),
+			'order_by' => array('REG_count' => 'ASC'),
+		);
+	}
+
+
+	/**
+	 * returns true if ANY reg status was updated during checkout
+	 *
+	 * @return boolean
+	 */
+	public function any_reg_status_updated()
+	{
+		foreach ($this->reg_status_updated as $reg_status) {
+			if ($reg_status) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param $REG_ID
+	 * @return boolean
+	 */
+	public function reg_status_updated($REG_ID)
+	{
+		return isset($this->reg_status_updated[ $REG_ID ]) ? $this->reg_status_updated[ $REG_ID ] : false;
+	}
+
+
+	/**
+	 * @param $REG_ID
+	 * @param $reg_status
+	 */
+	public function set_reg_status_updated($REG_ID, $reg_status)
+	{
+		$this->reg_status_updated[ $REG_ID ] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * exit_spco
+	 *
+	 * @return bool
+	 */
+	public function exit_spco()
+	{
+		return $this->exit_spco;
+	}
+
+
+	/**
+	 * set_exit_spco
+	 * can ONLY be set by the  Finalize_Registration reg step
+	 */
+	public function set_exit_spco()
+	{
+		if ($this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
+			$this->exit_spco = true;
+		}
+	}
+
+
+	/**
+	 *    reset_for_current_request
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function reset_for_current_request()
+	{
+		$this->process_form_submission = false;
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
+		$this->admin_request = is_admin() && ! EED_Single_Page_Checkout::getRequest()->isFrontAjax();
+		$this->continue_reg = true;
+		$this->redirect = false;
+		// don't reset the cached redirect form if we're about to be asked to display it !!!
+		$action = EED_Single_Page_Checkout::getRequest()->getRequestParam('action', 'display_spco_reg_step');
+		if ($action !== 'redirect_form') {
+			$this->redirect_form = '';
+		}
+		$this->redirect_url = '';
+		$this->json_response = new EE_SPCO_JSON_Response();
+		EE_Form_Section_Proper::reset_js_localization();
+	}
+
+
+	/**
+	 *    add_reg_step
+	 *
+	 * @access    public
+	 * @param EE_SPCO_Reg_Step $reg_step_obj
+	 * @return    void
+	 */
+	public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj)
+	{
+		$this->reg_steps[ $reg_step_obj->slug() ] = $reg_step_obj;
+	}
+
+
+	/**
+	 * skip_reg_step
+	 * if the current reg step does not need to run for some reason,
+	 * then this will advance SPCO to the next reg step,
+	 * and mark the skipped step as completed
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function skip_reg_step($reg_step_slug = '')
+	{
+		$step_to_skip = $this->find_reg_step($reg_step_slug);
+		if ($step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step()) {
+			$step_to_skip->set_is_current_step(false);
+			$step_to_skip->set_completed();
+			// advance to the next step
+			$this->set_current_step($this->next_step->slug());
+			// also reset the step param in the request in case any other code references that directly
+			EED_Single_Page_Checkout::getRequest()->setRequestParam('step', $this->current_step->slug());
+			// since we are skipping a step and setting the current step to be what was previously the next step,
+			// we need to check that the next step is now correct, and not still set to the current step.
+			if ($this->current_step->slug() === $this->next_step->slug()) {
+				// correctly setup the next step
+				$this->set_next_step();
+			}
+			$this->set_reg_step_initiated($this->current_step);
+		}
+	}
+
+
+	/**
+	 *    remove_reg_step
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @param bool   $reset whether to reset reg steps after removal
+	 * @throws EE_Error
+	 */
+	public function remove_reg_step($reg_step_slug = '', $reset = true)
+	{
+		unset($this->reg_steps[ $reg_step_slug ]);
+		if ($this->transaction instanceof EE_Transaction) {
+			// now remove reg step from TXN and save
+			$this->transaction->remove_reg_step($reg_step_slug);
+			$this->transaction->save();
+		}
+		if ($reset) {
+			$this->reset_reg_steps();
+		}
+	}
+
+
+	/**
+	 *    set_reg_step_order
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @param int    $order
+	 * @return    void
+	 */
+	public function set_reg_step_order($reg_step_slug = '', $order = 100)
+	{
+		if (isset($this->reg_steps[ $reg_step_slug ])) {
+			$this->reg_steps[ $reg_step_slug ]->set_order($order);
+		}
+	}
+
+
+	/**
+	 * @param string $current_step
+	 * @return void
+	 */
+	public function set_current_step(string $current_step)
+	{
+		// grab what step we're on
+		$this->current_step = $this->reg_steps[ $current_step ] ?? reset($this->reg_steps);
+		// verify instance
+		if (! $this->current_step instanceof EE_SPCO_Reg_Step) {
+			EE_Error::add_error(
+				esc_html__('The current step could not be set.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// we don't want to repeat completed steps if this is the first time through SPCO
+		if ($this->continue_reg && ! $this->revisit && $this->current_step->completed()) {
+			// so advance to the next step
+			$this->set_next_step();
+			if ($this->next_step instanceof EE_SPCO_Reg_Step) {
+				// and attempt to set it as the current step
+				$this->set_current_step($this->next_step->slug());
+			}
+			return;
+		}
+		$this->current_step->set_is_current_step(true);
+		$this->current_step->setRequest(EED_Single_Page_Checkout::getRequest());
+	}
+
+
+	/**
+	 *    set_next_step
+	 * advances the reg_steps array pointer and sets the next step, then reverses pointer back to the current step
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function set_next_step()
+	{
+		// set pointer to start of array
+		reset($this->reg_steps);
+		// if there is more than one step
+		if (count($this->reg_steps) > 1) {
+			// advance to the current step and set pointer
+			while (key($this->reg_steps) !== $this->current_step->slug() && key($this->reg_steps) !== '') {
+				next($this->reg_steps);
+			}
+		}
+		// advance one more spot ( if it exists )
+		$this->next_step = next($this->reg_steps);
+		// verify instance
+		$this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step : null;
+		// then back to current step to reset
+		prev($this->reg_steps);
+	}
+
+
+	/**
+	 *    get_next_reg_step
+	 *    this simply returns the next step from reg_steps array
+	 *
+	 * @access    public
+	 * @return    EE_SPCO_Reg_Step | null
+	 */
+	public function get_next_reg_step()
+	{
+		$next = next($this->reg_steps);
+		prev($this->reg_steps);
+		return $next instanceof EE_SPCO_Reg_Step ? $next : null;
+	}
+
+
+	/**
+	 * get_prev_reg_step
+	 *    this simply returns the previous step from reg_steps array
+	 *
+	 * @access    public
+	 * @return    EE_SPCO_Reg_Step | null
+	 */
+	public function get_prev_reg_step()
+	{
+		$prev = prev($this->reg_steps);
+		next($this->reg_steps);
+		return $prev instanceof EE_SPCO_Reg_Step ? $prev : null;
+	}
+
+
+	/**
+	 * sort_reg_steps
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function sort_reg_steps()
+	{
+		$reg_step_sorting_callback = apply_filters(
+			'FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback',
+			'reg_step_sorting_callback'
+		);
+		uasort($this->reg_steps, array($this, $reg_step_sorting_callback));
+	}
+
+
+	/**
+	 * find_reg_step
+	 * finds a reg step by the given slug
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @return EE_SPCO_Reg_Step|null
+	 */
+	public function find_reg_step($reg_step_slug = '')
+	{
+		if (! empty($reg_step_slug)) {
+			// copy reg step array
+			$reg_steps = $this->reg_steps;
+			// set pointer to start of array
+			reset($reg_steps);
+			// if there is more than one step
+			if (count($reg_steps) > 1) {
+				// advance to the current step and set pointer
+				while (key($reg_steps) !== $reg_step_slug && key($reg_steps) !== '') {
+					next($reg_steps);
+				}
+				return current($reg_steps);
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * reg_step_sorting_callback
+	 *
+	 * @access public
+	 * @param EE_SPCO_Reg_Step $reg_step_A
+	 * @param EE_SPCO_Reg_Step $reg_step_B
+	 * @return int
+	 */
+	public function reg_step_sorting_callback(EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B)
+	{
+		// send finalize_registration step to the end of the array
+		if ($reg_step_A->slug() === 'finalize_registration') {
+			return 1;
+		} elseif ($reg_step_B->slug() === 'finalize_registration') {
+			return -1;
+		}
+		if ($reg_step_A->order() === $reg_step_B->order()) {
+			return 0;
+		}
+		return ($reg_step_A->order() > $reg_step_B->order()) ? 1 : -1;
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 *
+	 * @access    public
+	 * @param    EE_SPCO_Reg_Step $reg_step
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_initiated(EE_SPCO_Reg_Step $reg_step)
+	{
+		// call set_reg_step_initiated ???
+		if (
 // first time visiting SPCO ?
-            ! $this->revisit
-            && (
-                // and displaying the reg step form for the first time ?
-                $this->action === 'display_spco_reg_step'
-                // or initializing the final step
-                || $reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration
-            )
-        ) {
-            // set the start time for this reg step
-            if (! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__('The "%1$s" registration step was not initialized properly.', 'event_espresso'),
-                            $reg_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    set_reg_step_JSON_info
-     *
-     * @access public
-     * @return    void
-     */
-    public function set_reg_step_JSON_info()
-    {
-        EE_Registry::$i18n_js_strings['reg_steps'] = array();
-        // pass basic reg step data to JS
-        foreach ($this->reg_steps as $reg_step) {
-            EE_Registry::$i18n_js_strings['reg_steps'][] = $reg_step->slug();
-        }
-        // reset reg step html
-        // $this->json_response->set_reg_step_html('');
-    }
-
-
-    /**
-     *    reset_reg_steps
-     *
-     * @access public
-     * @return void
-     */
-    public function reset_reg_steps()
-    {
-        $this->sort_reg_steps();
-        $this->set_current_step(EED_Single_Page_Checkout::getRequest()->getRequestParam('step'));
-        $this->set_next_step();
-        // the text that appears on the reg step form submit button
-        $this->current_step->set_submit_button_text();
-        $this->set_reg_step_JSON_info();
-    }
-
-
-    /**
-     *    get_registration_time_limit
-     *
-     * @access    public
-     * @return        string
-     */
-    public function get_registration_time_limit()
-    {
-        $registration_time_limit = (float) (EE_Registry::instance()->SSN->expiration() - time());
-        $time_limit_format = $registration_time_limit > 60 * MINUTE_IN_SECONDS ? 'H:i:s' : 'i:s';
-        $registration_time_limit = date($time_limit_format, $registration_time_limit);
-        return apply_filters(
-            'FHEE__EE_Checkout__get_registration_time_limit__registration_time_limit',
-            $registration_time_limit
-        );
-    }
-
-
-    /**
-     * payment_required
-     *
-     * @return boolean
-     */
-    public function payment_required()
-    {
-        // if NOT:
-        //     registration via admin
-        //      completed TXN
-        //      overpaid TXN
-        //      free TXN(total = 0.00)
-        //      then payment required is TRUE
-        return ! ($this->admin_request
-                  || $this->transaction->is_completed()
-                  || $this->transaction->is_overpaid()
-                  || $this->transaction->is_free()) ? true : false;
-    }
-
-
-    /**
-     * get_cart_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    public function get_cart_for_transaction($transaction)
-    {
-        $session = EE_Registry::instance()->load_core('Session');
-        $cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
-        // verify cart
-        if (! $cart instanceof EE_Cart) {
-            $cart = EE_Registry::instance()->load_core('Cart');
-        }
-
-        return $cart;
-    }
-
-
-    /**
-     *    initialize_txn_reg_steps_array
-     *
-     * @access public
-     * @return    array
-     */
-    public function initialize_txn_reg_steps_array()
-    {
-        $txn_reg_steps_array = array();
-        foreach ($this->reg_steps as $reg_step) {
-            $txn_reg_steps_array[ $reg_step->slug() ] = false;
-        }
-        return $txn_reg_steps_array;
-    }
-
-
-    /**
-     *    update_txn_reg_steps_array
-     *
-     * @access public
-     * @return    bool
-     * @throws \EE_Error
-     */
-    public function update_txn_reg_steps_array()
-    {
-        $updated = false;
-        foreach ($this->reg_steps as $reg_step) {
-            if ($reg_step->completed()) {
-                $updated = $this->transaction->set_reg_step_completed($reg_step->slug())
-                    ? true
-                    : $updated;
-            }
-        }
-        if ($updated) {
-            $this->transaction->save();
-        }
-        return $updated;
-    }
-
-
-    /**
-     *    stash_transaction_and_checkout
-     *
-     * @access public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function stash_transaction_and_checkout()
-    {
-        if (! $this->revisit) {
-            $this->update_txn_reg_steps_array();
-        }
-        $this->track_transaction_and_registration_status_updates();
-        // save all data to the db, but suppress errors
-        // $this->save_all_data( FALSE );
-        // cache the checkout in the session
-        EE_Registry::instance()->SSN->set_checkout($this);
-    }
-
-
-    /**
-     *    track_transaction_and_registration_status_updates
-     *    stores whether any updates were made to the TXN or it's related registrations
-     *
-     * @access public
-     * @return void
-     * @throws \EE_Error
-     */
-    public function track_transaction_and_registration_status_updates()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction) {
-            // has there been a TXN status change during this checkout?
-            $this->txn_status_updated = $this->transaction->txn_status_updated();
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
-                if ($registration_processor->reg_status_updated($registration->ID())) {
-                    $this->set_reg_status_updated($registration->ID(), true);
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    visit_allows_processing_of_this_registration
-     *    determines if the current SPCO visit should allow the passed EE_Registration to be used in processing.
-     *    one of the following conditions must be met:
-     *        EITHER:    A) first time thru SPCO -> process ALL registrations ( NOT a revisit )
-     *        OR :        B) primary registrant is editing info -> process ALL registrations ( primary_revisit )
-     *        OR :        C) another registrant is editing info -> ONLY process their registration ( revisit AND their
-     *        reg_url_link matches )
-     *
-     * @access public
-     * @param    EE_Registration $registration
-     * @return    bool
-     * @throws \EE_Error
-     */
-    public function visit_allows_processing_of_this_registration(EE_Registration $registration)
-    {
-        return ! $this->revisit
-               || $this->primary_revisit
-               || (
-                   $this->revisit && $this->reg_url_link === $registration->reg_url_link()
-               )
-            ? true
-            : false;
-    }
-
-
-    /**
-     *    _transaction_has_primary_registration
-     *
-     * @access        private
-     * @return        bool
-     */
-    public function transaction_has_primary_registrant()
-    {
-        return $this->primary_attendee_obj instanceof EE_Attendee ? true : false;
-    }
-
-
-    /**
-     *    save_all_data
-     *    simply loops through the current transaction and saves all data for each registration
-     *
-     * @access public
-     * @param bool $show_errors
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function save_all_data($show_errors = true)
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction) {
-            // save to ensure that TXN has ID
-            $this->transaction->save();
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
-                $this->_save_registration($registration, $show_errors);
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Transaction was not found when attempting to save your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration($registration, $show_errors = true)
-    {
-        // verify object
-        if ($registration instanceof EE_Registration) {
-            // should this registration be processed during this visit ?
-            if ($this->visit_allows_processing_of_this_registration($registration)) {
-                // set TXN ID
-                if (! $registration->transaction_ID()) {
-                    $registration->set_transaction_id($this->transaction->ID());
-                }
-                // verify and save the attendee
-                $this->_save_registration_attendee($registration, $show_errors);
-                // save answers to reg form questions
-                $this->_save_registration_answers($registration, $show_errors);
-                // save changes
-                $registration->save();
-                // update txn cache
-                if (! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
-                    if ($show_errors) {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'The newly saved Registration object could not be cached on the Transaction.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to save your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration_attendee($registration, $show_errors = true)
-    {
-        if ($registration->attendee() instanceof EE_Attendee) {
-            // save so that ATT has ID
-            $registration->attendee()->save();
-            if (! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
-                if ($show_errors) {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'The newly saved Attendee object could not be cached on the registration.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    sprintf(
-                        '%1$s||%1$s $attendee = %2$s',
-                        esc_html__(
-                            'Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.',
-                            'event_espresso'
-                        ),
-                        var_export($registration->attendee(), true)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * _save_question_answers
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration_answers($registration, $show_errors = true)
-    {
-        // now save the answers
-        foreach ($registration->answers() as $cache_key => $answer) {
-            // verify object
-            if ($answer instanceof EE_Answer) {
-                $answer->set_registration($registration->ID());
-                $answer->save();
-                if (! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
-                    if ($show_errors) {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'The newly saved Answer object could not be cached on the registration.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            } else {
-                if ($show_errors) {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'An invalid Answer object was discovered when attempting to save your registration information.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    refresh_all_entities
-     *   will either refresh the entity map with objects form the db or from the checkout cache
-     *
-     * @access public
-     * @param bool $from_db
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function refresh_all_entities($from_db = false)
-    {
-        $this->current_step->setRequest(EED_Single_Page_Checkout::getRequest());
-        $from_db = $this->current_step->is_final_step() || $this->action === 'process_gateway_response'
-            ? true
-            : $from_db;
-        // $this->log(
-        //     __CLASS__,
-        //     __FUNCTION__,
-        //     __LINE__,
-        //     array('from_db' => $from_db)
-        // );
-        return $from_db ? $this->refresh_from_db() : $this->refresh_entity_map();
-    }
-
-
-    /**
-     *  refresh_entity_map
-     *  simply loops through the current transaction and updates each
-     *  model's entity map using EEM_Base::refresh_entity_map_from_db()
-     *
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    protected function refresh_from_db()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            // pull fresh TXN data from the db
-            $this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db($this->transaction->ID());
-            // update EE_Checkout's cached primary_attendee object
-            $this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db($this->transaction);
-            // update EE_Checkout's cached payment object
-            $payment = $this->transaction->last_payment();
-            $this->payment = $payment instanceof EE_Payment ? $payment : $this->payment;
-            // update EE_Checkout's cached payment_method object
-            $payment_method = $this->payment instanceof EE_Payment ? $this->payment->payment_method() : null;
-            $this->payment_method = $payment_method instanceof EE_Payment_Method ? $payment_method
-                : $this->payment_method;
-            // now refresh the cart, based on the TXN
-            $this->cart = $this->get_cart_for_transaction($this->transaction);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid Transaction was not found when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _refresh_primary_attendee_obj_from_db
-     *
-     * @param   EE_Transaction $transaction
-     * @return  EE_Attendee | null
-     * @throws \EE_Error
-     */
-    protected function _refresh_primary_attendee_obj_from_db(EE_Transaction $transaction)
-    {
-        $primary_attendee_obj = null;
-        // grab the saved registrations from the transaction
-        foreach ($transaction->registrations($this->reg_cache_where_params, true) as $registration) {
-            // verify object
-            if ($registration instanceof EE_Registration) {
-                $attendee = $registration->attendee();
-                // verify object && maybe cache primary_attendee_obj ?
-                if ($attendee instanceof EE_Attendee && $registration->is_primary_registrant()) {
-                    $primary_attendee_obj = $attendee;
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return $primary_attendee_obj;
-    }
-
-
-    /**
-     *  refresh_entity_map
-     *  simply loops through the current transaction and updates
-     *  each model's entity map using EEM_Base::refresh_entity_map_with()
-     *
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    protected function refresh_entity_map()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            // never cache payment info
-            $this->transaction->clear_cache('Payment');
-            // is the Payment Options Reg Step completed ?
-            if ($this->transaction->reg_step_completed('payment_options')) {
-                // then check for payments and update TXN accordingly
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                $transaction_payments->calculate_total_payments_and_update_status($this->transaction);
-            }
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $reg_cache_ID => $registration) {
-                $this->_refresh_registration($reg_cache_ID, $registration);
-            }
-            // make sure our cached TXN is added to the model entity mapper
-            $this->transaction = $this->transaction->get_model()->refresh_entity_map_with(
-                $this->transaction->ID(),
-                $this->transaction
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid Transaction was not found when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // verify and update the cart because inaccurate totals are not so much fun
-        if ($this->cart instanceof EE_Cart) {
-            $grand_total = $this->cart->get_grand_total();
-            if ($grand_total instanceof EE_Line_Item && $grand_total->ID()) {
-                $grand_total->recalculate_total_including_taxes();
-                $grand_total = $grand_total->get_model()->refresh_entity_map_with(
-                    $this->cart->get_grand_total()->ID(),
-                    $this->cart->get_grand_total()
-                );
-            }
-            if ($grand_total instanceof EE_Line_Item) {
-                $this->cart = EE_Cart::instance($grand_total);
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Cart was not found when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * _refresh_registration
-     *
-     * @param    string | int    $reg_cache_ID
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration($reg_cache_ID, $registration)
-    {
-
-        // verify object
-        if ($registration instanceof EE_Registration) {
-            // update the entity mapper attendee
-            $this->_refresh_registration_attendee($registration);
-            // update the entity mapper answers for reg form questions
-            $this->_refresh_registration_answers($registration);
-            // make sure the cached registration is added to the model entity mapper
-            $registration->get_model()->refresh_entity_map_with($reg_cache_ID, $registration);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'An invalid Registration object was discovered when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration_attendee($registration)
-    {
-        $attendee = $registration->attendee();
-        // verify object
-        if ($attendee instanceof EE_Attendee && $attendee->ID()) {
-            // make sure the cached attendee is added to the model entity mapper
-            $registration->attendee()->get_model()->refresh_entity_map_with($attendee->ID(), $attendee);
-            // maybe cache primary_attendee_obj ?
-            if ($registration->is_primary_registrant()) {
-                $this->primary_attendee_obj = $attendee;
-            }
-        }
-    }
-
-
-    /**
-     * _refresh_registration_answers
-     *
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration_answers($registration)
-    {
-
-        // now update the answers
-        foreach ($registration->answers() as $cache_key => $answer) {
-            // verify object
-            if ($answer instanceof EE_Answer) {
-                if ($answer->ID()) {
-                    // make sure the cached answer is added to the model entity mapper
-                    $answer->get_model()->refresh_entity_map_with($answer->ID(), $answer);
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Answer object was discovered when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function __sleep()
-    {
-        if ($this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID()) {
-            $this->primary_attendee_obj = $this->primary_attendee_obj->ID();
-        }        // remove the reg form and the checkout
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            $this->transaction = $this->transaction->ID();
-        }        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('billing_form', 'registration_form'));
-    }
-
-
-    /**
-     *    __wakeup
-     * to conserve db space, we are removing the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
-     * this will reinstate the EE_Checkout object on each EE_SPCO_Reg_Step object
-     */
-    public function __wakeup()
-    {
-        if (! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
-            // $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
-            $this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
-        }
-        if (! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
-            // $this->transaction is actually just an ID, so use it to get the object from the db
-            $this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
-        }
-        foreach ($this->reg_steps as $reg_step) {
-            $reg_step->checkout = $this;
-        }
-    }
-
-
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @throws \EE_Error
-     */
-    public function log($class = '', $func = '', $line = '', $info = array(), $display_request = false)
-    {
-        $disabled = true;
-        if (WP_DEBUG && ! $disabled) {
-            $debug_data = get_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array());
-            $default_data = array(
-                $class                    => $func . '() : ' . $line,
-                'request->step'           => $this->step,
-                'request->action'         => $this->action,
-                'current_step->slug'      => $this->current_step instanceof EE_SPCO_Reg_Step ?
-                    $this->current_step->slug() : '',
-                'current_step->completed' => $this->current_step instanceof EE_SPCO_Reg_Step ?
-                    $this->current_step->completed() : '',
-                'txn_status_updated'      => $this->transaction->txn_status_updated(),
-                'reg_status_updated'      => $this->reg_status_updated,
-                'reg_url_link'            => $this->reg_url_link,
-            );
-            if ($this->transaction instanceof EE_Transaction) {
-                $default_data['TXN_status'] = $this->transaction->status_ID();
-                $default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
-                foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
-                    $default_data['registrations'][ $REG_ID ] = $registration->status_ID();
-                }
-                if ($this->transaction->ID()) {
-                    $TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
-                    // don't serialize objects
-                    $info = $this->_strip_objects($info);
-                    if (! isset($debug_data[ $TXN_ID ])) {
-                        $debug_data[ $TXN_ID ] = array();
-                    }
-                    $debug_data[ $TXN_ID ][ microtime() ] = array_merge(
-                        $default_data,
-                        $info
-                    );
-                    update_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * _strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public function _strip_objects($info = array())
-    {
-        foreach ((array) $info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = $this->_strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
+			! $this->revisit
+			&& (
+				// and displaying the reg step form for the first time ?
+				$this->action === 'display_spco_reg_step'
+				// or initializing the final step
+				|| $reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration
+			)
+		) {
+			// set the start time for this reg step
+			if (! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
+				if (WP_DEBUG) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__('The "%1$s" registration step was not initialized properly.', 'event_espresso'),
+							$reg_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    set_reg_step_JSON_info
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function set_reg_step_JSON_info()
+	{
+		EE_Registry::$i18n_js_strings['reg_steps'] = array();
+		// pass basic reg step data to JS
+		foreach ($this->reg_steps as $reg_step) {
+			EE_Registry::$i18n_js_strings['reg_steps'][] = $reg_step->slug();
+		}
+		// reset reg step html
+		// $this->json_response->set_reg_step_html('');
+	}
+
+
+	/**
+	 *    reset_reg_steps
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function reset_reg_steps()
+	{
+		$this->sort_reg_steps();
+		$this->set_current_step(EED_Single_Page_Checkout::getRequest()->getRequestParam('step'));
+		$this->set_next_step();
+		// the text that appears on the reg step form submit button
+		$this->current_step->set_submit_button_text();
+		$this->set_reg_step_JSON_info();
+	}
+
+
+	/**
+	 *    get_registration_time_limit
+	 *
+	 * @access    public
+	 * @return        string
+	 */
+	public function get_registration_time_limit()
+	{
+		$registration_time_limit = (float) (EE_Registry::instance()->SSN->expiration() - time());
+		$time_limit_format = $registration_time_limit > 60 * MINUTE_IN_SECONDS ? 'H:i:s' : 'i:s';
+		$registration_time_limit = date($time_limit_format, $registration_time_limit);
+		return apply_filters(
+			'FHEE__EE_Checkout__get_registration_time_limit__registration_time_limit',
+			$registration_time_limit
+		);
+	}
+
+
+	/**
+	 * payment_required
+	 *
+	 * @return boolean
+	 */
+	public function payment_required()
+	{
+		// if NOT:
+		//     registration via admin
+		//      completed TXN
+		//      overpaid TXN
+		//      free TXN(total = 0.00)
+		//      then payment required is TRUE
+		return ! ($this->admin_request
+				  || $this->transaction->is_completed()
+				  || $this->transaction->is_overpaid()
+				  || $this->transaction->is_free()) ? true : false;
+	}
+
+
+	/**
+	 * get_cart_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	public function get_cart_for_transaction($transaction)
+	{
+		$session = EE_Registry::instance()->load_core('Session');
+		$cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
+		// verify cart
+		if (! $cart instanceof EE_Cart) {
+			$cart = EE_Registry::instance()->load_core('Cart');
+		}
+
+		return $cart;
+	}
+
+
+	/**
+	 *    initialize_txn_reg_steps_array
+	 *
+	 * @access public
+	 * @return    array
+	 */
+	public function initialize_txn_reg_steps_array()
+	{
+		$txn_reg_steps_array = array();
+		foreach ($this->reg_steps as $reg_step) {
+			$txn_reg_steps_array[ $reg_step->slug() ] = false;
+		}
+		return $txn_reg_steps_array;
+	}
+
+
+	/**
+	 *    update_txn_reg_steps_array
+	 *
+	 * @access public
+	 * @return    bool
+	 * @throws \EE_Error
+	 */
+	public function update_txn_reg_steps_array()
+	{
+		$updated = false;
+		foreach ($this->reg_steps as $reg_step) {
+			if ($reg_step->completed()) {
+				$updated = $this->transaction->set_reg_step_completed($reg_step->slug())
+					? true
+					: $updated;
+			}
+		}
+		if ($updated) {
+			$this->transaction->save();
+		}
+		return $updated;
+	}
+
+
+	/**
+	 *    stash_transaction_and_checkout
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function stash_transaction_and_checkout()
+	{
+		if (! $this->revisit) {
+			$this->update_txn_reg_steps_array();
+		}
+		$this->track_transaction_and_registration_status_updates();
+		// save all data to the db, but suppress errors
+		// $this->save_all_data( FALSE );
+		// cache the checkout in the session
+		EE_Registry::instance()->SSN->set_checkout($this);
+	}
+
+
+	/**
+	 *    track_transaction_and_registration_status_updates
+	 *    stores whether any updates were made to the TXN or it's related registrations
+	 *
+	 * @access public
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function track_transaction_and_registration_status_updates()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction) {
+			// has there been a TXN status change during this checkout?
+			$this->txn_status_updated = $this->transaction->txn_status_updated();
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
+				if ($registration_processor->reg_status_updated($registration->ID())) {
+					$this->set_reg_status_updated($registration->ID(), true);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    visit_allows_processing_of_this_registration
+	 *    determines if the current SPCO visit should allow the passed EE_Registration to be used in processing.
+	 *    one of the following conditions must be met:
+	 *        EITHER:    A) first time thru SPCO -> process ALL registrations ( NOT a revisit )
+	 *        OR :        B) primary registrant is editing info -> process ALL registrations ( primary_revisit )
+	 *        OR :        C) another registrant is editing info -> ONLY process their registration ( revisit AND their
+	 *        reg_url_link matches )
+	 *
+	 * @access public
+	 * @param    EE_Registration $registration
+	 * @return    bool
+	 * @throws \EE_Error
+	 */
+	public function visit_allows_processing_of_this_registration(EE_Registration $registration)
+	{
+		return ! $this->revisit
+			   || $this->primary_revisit
+			   || (
+				   $this->revisit && $this->reg_url_link === $registration->reg_url_link()
+			   )
+			? true
+			: false;
+	}
+
+
+	/**
+	 *    _transaction_has_primary_registration
+	 *
+	 * @access        private
+	 * @return        bool
+	 */
+	public function transaction_has_primary_registrant()
+	{
+		return $this->primary_attendee_obj instanceof EE_Attendee ? true : false;
+	}
+
+
+	/**
+	 *    save_all_data
+	 *    simply loops through the current transaction and saves all data for each registration
+	 *
+	 * @access public
+	 * @param bool $show_errors
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function save_all_data($show_errors = true)
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction) {
+			// save to ensure that TXN has ID
+			$this->transaction->save();
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
+				$this->_save_registration($registration, $show_errors);
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Transaction was not found when attempting to save your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration($registration, $show_errors = true)
+	{
+		// verify object
+		if ($registration instanceof EE_Registration) {
+			// should this registration be processed during this visit ?
+			if ($this->visit_allows_processing_of_this_registration($registration)) {
+				// set TXN ID
+				if (! $registration->transaction_ID()) {
+					$registration->set_transaction_id($this->transaction->ID());
+				}
+				// verify and save the attendee
+				$this->_save_registration_attendee($registration, $show_errors);
+				// save answers to reg form questions
+				$this->_save_registration_answers($registration, $show_errors);
+				// save changes
+				$registration->save();
+				// update txn cache
+				if (! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
+					if ($show_errors) {
+						EE_Error::add_error(
+							esc_html__(
+								'The newly saved Registration object could not be cached on the Transaction.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to save your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration_attendee($registration, $show_errors = true)
+	{
+		if ($registration->attendee() instanceof EE_Attendee) {
+			// save so that ATT has ID
+			$registration->attendee()->save();
+			if (! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
+				if ($show_errors) {
+					EE_Error::add_error(
+						esc_html__(
+							'The newly saved Attendee object could not be cached on the registration.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					sprintf(
+						'%1$s||%1$s $attendee = %2$s',
+						esc_html__(
+							'Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.',
+							'event_espresso'
+						),
+						var_export($registration->attendee(), true)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * _save_question_answers
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration_answers($registration, $show_errors = true)
+	{
+		// now save the answers
+		foreach ($registration->answers() as $cache_key => $answer) {
+			// verify object
+			if ($answer instanceof EE_Answer) {
+				$answer->set_registration($registration->ID());
+				$answer->save();
+				if (! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
+					if ($show_errors) {
+						EE_Error::add_error(
+							esc_html__(
+								'The newly saved Answer object could not be cached on the registration.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			} else {
+				if ($show_errors) {
+					EE_Error::add_error(
+						esc_html__(
+							'An invalid Answer object was discovered when attempting to save your registration information.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    refresh_all_entities
+	 *   will either refresh the entity map with objects form the db or from the checkout cache
+	 *
+	 * @access public
+	 * @param bool $from_db
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function refresh_all_entities($from_db = false)
+	{
+		$this->current_step->setRequest(EED_Single_Page_Checkout::getRequest());
+		$from_db = $this->current_step->is_final_step() || $this->action === 'process_gateway_response'
+			? true
+			: $from_db;
+		// $this->log(
+		//     __CLASS__,
+		//     __FUNCTION__,
+		//     __LINE__,
+		//     array('from_db' => $from_db)
+		// );
+		return $from_db ? $this->refresh_from_db() : $this->refresh_entity_map();
+	}
+
+
+	/**
+	 *  refresh_entity_map
+	 *  simply loops through the current transaction and updates each
+	 *  model's entity map using EEM_Base::refresh_entity_map_from_db()
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	protected function refresh_from_db()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			// pull fresh TXN data from the db
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db($this->transaction->ID());
+			// update EE_Checkout's cached primary_attendee object
+			$this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db($this->transaction);
+			// update EE_Checkout's cached payment object
+			$payment = $this->transaction->last_payment();
+			$this->payment = $payment instanceof EE_Payment ? $payment : $this->payment;
+			// update EE_Checkout's cached payment_method object
+			$payment_method = $this->payment instanceof EE_Payment ? $this->payment->payment_method() : null;
+			$this->payment_method = $payment_method instanceof EE_Payment_Method ? $payment_method
+				: $this->payment_method;
+			// now refresh the cart, based on the TXN
+			$this->cart = $this->get_cart_for_transaction($this->transaction);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid Transaction was not found when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _refresh_primary_attendee_obj_from_db
+	 *
+	 * @param   EE_Transaction $transaction
+	 * @return  EE_Attendee | null
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_primary_attendee_obj_from_db(EE_Transaction $transaction)
+	{
+		$primary_attendee_obj = null;
+		// grab the saved registrations from the transaction
+		foreach ($transaction->registrations($this->reg_cache_where_params, true) as $registration) {
+			// verify object
+			if ($registration instanceof EE_Registration) {
+				$attendee = $registration->attendee();
+				// verify object && maybe cache primary_attendee_obj ?
+				if ($attendee instanceof EE_Attendee && $registration->is_primary_registrant()) {
+					$primary_attendee_obj = $attendee;
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return $primary_attendee_obj;
+	}
+
+
+	/**
+	 *  refresh_entity_map
+	 *  simply loops through the current transaction and updates
+	 *  each model's entity map using EEM_Base::refresh_entity_map_with()
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	protected function refresh_entity_map()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			// never cache payment info
+			$this->transaction->clear_cache('Payment');
+			// is the Payment Options Reg Step completed ?
+			if ($this->transaction->reg_step_completed('payment_options')) {
+				// then check for payments and update TXN accordingly
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				$transaction_payments->calculate_total_payments_and_update_status($this->transaction);
+			}
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $reg_cache_ID => $registration) {
+				$this->_refresh_registration($reg_cache_ID, $registration);
+			}
+			// make sure our cached TXN is added to the model entity mapper
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_with(
+				$this->transaction->ID(),
+				$this->transaction
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid Transaction was not found when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// verify and update the cart because inaccurate totals are not so much fun
+		if ($this->cart instanceof EE_Cart) {
+			$grand_total = $this->cart->get_grand_total();
+			if ($grand_total instanceof EE_Line_Item && $grand_total->ID()) {
+				$grand_total->recalculate_total_including_taxes();
+				$grand_total = $grand_total->get_model()->refresh_entity_map_with(
+					$this->cart->get_grand_total()->ID(),
+					$this->cart->get_grand_total()
+				);
+			}
+			if ($grand_total instanceof EE_Line_Item) {
+				$this->cart = EE_Cart::instance($grand_total);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Cart was not found when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * _refresh_registration
+	 *
+	 * @param    string | int    $reg_cache_ID
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration($reg_cache_ID, $registration)
+	{
+
+		// verify object
+		if ($registration instanceof EE_Registration) {
+			// update the entity mapper attendee
+			$this->_refresh_registration_attendee($registration);
+			// update the entity mapper answers for reg form questions
+			$this->_refresh_registration_answers($registration);
+			// make sure the cached registration is added to the model entity mapper
+			$registration->get_model()->refresh_entity_map_with($reg_cache_ID, $registration);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'An invalid Registration object was discovered when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration_attendee($registration)
+	{
+		$attendee = $registration->attendee();
+		// verify object
+		if ($attendee instanceof EE_Attendee && $attendee->ID()) {
+			// make sure the cached attendee is added to the model entity mapper
+			$registration->attendee()->get_model()->refresh_entity_map_with($attendee->ID(), $attendee);
+			// maybe cache primary_attendee_obj ?
+			if ($registration->is_primary_registrant()) {
+				$this->primary_attendee_obj = $attendee;
+			}
+		}
+	}
+
+
+	/**
+	 * _refresh_registration_answers
+	 *
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration_answers($registration)
+	{
+
+		// now update the answers
+		foreach ($registration->answers() as $cache_key => $answer) {
+			// verify object
+			if ($answer instanceof EE_Answer) {
+				if ($answer->ID()) {
+					// make sure the cached answer is added to the model entity mapper
+					$answer->get_model()->refresh_entity_map_with($answer->ID(), $answer);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Answer object was discovered when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function __sleep()
+	{
+		if ($this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID()) {
+			$this->primary_attendee_obj = $this->primary_attendee_obj->ID();
+		}        // remove the reg form and the checkout
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			$this->transaction = $this->transaction->ID();
+		}        // remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('billing_form', 'registration_form'));
+	}
+
+
+	/**
+	 *    __wakeup
+	 * to conserve db space, we are removing the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
+	 * this will reinstate the EE_Checkout object on each EE_SPCO_Reg_Step object
+	 */
+	public function __wakeup()
+	{
+		if (! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
+			// $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
+			$this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
+		}
+		if (! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
+			// $this->transaction is actually just an ID, so use it to get the object from the db
+			$this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
+		}
+		foreach ($this->reg_steps as $reg_step) {
+			$reg_step->checkout = $this;
+		}
+	}
+
+
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @throws \EE_Error
+	 */
+	public function log($class = '', $func = '', $line = '', $info = array(), $display_request = false)
+	{
+		$disabled = true;
+		if (WP_DEBUG && ! $disabled) {
+			$debug_data = get_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array());
+			$default_data = array(
+				$class                    => $func . '() : ' . $line,
+				'request->step'           => $this->step,
+				'request->action'         => $this->action,
+				'current_step->slug'      => $this->current_step instanceof EE_SPCO_Reg_Step ?
+					$this->current_step->slug() : '',
+				'current_step->completed' => $this->current_step instanceof EE_SPCO_Reg_Step ?
+					$this->current_step->completed() : '',
+				'txn_status_updated'      => $this->transaction->txn_status_updated(),
+				'reg_status_updated'      => $this->reg_status_updated,
+				'reg_url_link'            => $this->reg_url_link,
+			);
+			if ($this->transaction instanceof EE_Transaction) {
+				$default_data['TXN_status'] = $this->transaction->status_ID();
+				$default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
+				foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
+					$default_data['registrations'][ $REG_ID ] = $registration->status_ID();
+				}
+				if ($this->transaction->ID()) {
+					$TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
+					// don't serialize objects
+					$info = $this->_strip_objects($info);
+					if (! isset($debug_data[ $TXN_ID ])) {
+						$debug_data[ $TXN_ID ] = array();
+					}
+					$debug_data[ $TXN_ID ][ microtime() ] = array_merge(
+						$default_data,
+						$info
+					);
+					update_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * _strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public function _strip_objects($info = array())
+	{
+		foreach ((array) $info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = $this->_strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
 }

Spacing +33 added lines, -33 removed lines

@@ -313,7 +313,7 @@ 
      */
     public function reg_status_updated($REG_ID)
     {
-        return isset($this->reg_status_updated[ $REG_ID ]) ? $this->reg_status_updated[ $REG_ID ] : false;
+        return isset($this->reg_status_updated[$REG_ID]) ? $this->reg_status_updated[$REG_ID] : false;
     }
 
 
@@ -323,7 +323,7 @@ 
      */
     public function set_reg_status_updated($REG_ID, $reg_status)
     {
-        $this->reg_status_updated[ $REG_ID ] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
+        $this->reg_status_updated[$REG_ID] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
     }
 
 
@@ -383,7 +383,7 @@ 
      */
     public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj)
     {
-        $this->reg_steps[ $reg_step_obj->slug() ] = $reg_step_obj;
+        $this->reg_steps[$reg_step_obj->slug()] = $reg_step_obj;
     }
 
 
@@ -429,7 +429,7 @@ 
      */
     public function remove_reg_step($reg_step_slug = '', $reset = true)
     {
-        unset($this->reg_steps[ $reg_step_slug ]);
+        unset($this->reg_steps[$reg_step_slug]);
         if ($this->transaction instanceof EE_Transaction) {
             // now remove reg step from TXN and save
             $this->transaction->remove_reg_step($reg_step_slug);
@@ -451,8 +451,8 @@ 
      */
     public function set_reg_step_order($reg_step_slug = '', $order = 100)
     {
-        if (isset($this->reg_steps[ $reg_step_slug ])) {
-            $this->reg_steps[ $reg_step_slug ]->set_order($order);
+        if (isset($this->reg_steps[$reg_step_slug])) {
+            $this->reg_steps[$reg_step_slug]->set_order($order);
         }
     }
 
@@ -464,9 +464,9 @@ 
     public function set_current_step(string $current_step)
     {
         // grab what step we're on
-        $this->current_step = $this->reg_steps[ $current_step ] ?? reset($this->reg_steps);
+        $this->current_step = $this->reg_steps[$current_step] ?? reset($this->reg_steps);
         // verify instance
-        if (! $this->current_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->current_step instanceof EE_SPCO_Reg_Step) {
             EE_Error::add_error(
                 esc_html__('The current step could not be set.', 'event_espresso'),
                 __FILE__,
@@ -572,7 +572,7 @@ 
      */
     public function find_reg_step($reg_step_slug = '')
     {
-        if (! empty($reg_step_slug)) {
+        if ( ! empty($reg_step_slug)) {
             // copy reg step array
             $reg_steps = $this->reg_steps;
             // set pointer to start of array
@@ -634,7 +634,7 @@ 
             )
         ) {
             // set the start time for this reg step
-            if (! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
+            if ( ! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
                 if (WP_DEBUG) {
                     EE_Error::add_error(
                         sprintf(
@@ -736,7 +736,7 @@ 
         $session = EE_Registry::instance()->load_core('Session');
         $cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
         // verify cart
-        if (! $cart instanceof EE_Cart) {
+        if ( ! $cart instanceof EE_Cart) {
             $cart = EE_Registry::instance()->load_core('Cart');
         }
 
@@ -754,7 +754,7 @@ 
     {
         $txn_reg_steps_array = array();
         foreach ($this->reg_steps as $reg_step) {
-            $txn_reg_steps_array[ $reg_step->slug() ] = false;
+            $txn_reg_steps_array[$reg_step->slug()] = false;
         }
         return $txn_reg_steps_array;
     }
@@ -793,7 +793,7 @@ 
      */
     public function stash_transaction_and_checkout()
     {
-        if (! $this->revisit) {
+        if ( ! $this->revisit) {
             $this->update_txn_reg_steps_array();
         }
         $this->track_transaction_and_registration_status_updates();
@@ -920,7 +920,7 @@ 
             // should this registration be processed during this visit ?
             if ($this->visit_allows_processing_of_this_registration($registration)) {
                 // set TXN ID
-                if (! $registration->transaction_ID()) {
+                if ( ! $registration->transaction_ID()) {
                     $registration->set_transaction_id($this->transaction->ID());
                 }
                 // verify and save the attendee
@@ -930,7 +930,7 @@ 
                 // save changes
                 $registration->save();
                 // update txn cache
-                if (! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
+                if ( ! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
                     if ($show_errors) {
                         EE_Error::add_error(
                             esc_html__(
@@ -973,7 +973,7 @@ 
         if ($registration->attendee() instanceof EE_Attendee) {
             // save so that ATT has ID
             $registration->attendee()->save();
-            if (! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
+            if ( ! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
                 if ($show_errors) {
                     EE_Error::add_error(
                         esc_html__(
@@ -1022,7 +1022,7 @@ 
             if ($answer instanceof EE_Answer) {
                 $answer->set_registration($registration->ID());
                 $answer->save();
-                if (! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
+                if ( ! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
                     if ($show_errors) {
                         EE_Error::add_error(
                             esc_html__(
@@ -1342,11 +1342,11 @@ 
      */
     public function __wakeup()
     {
-        if (! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
+        if ( ! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
             // $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
             $this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
         }
-        if (! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
+        if ( ! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
             // $this->transaction is actually just an ID, so use it to get the object from the db
             $this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
         }
@@ -1370,9 +1370,9 @@ 
     {
         $disabled = true;
         if (WP_DEBUG && ! $disabled) {
-            $debug_data = get_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array());
+            $debug_data = get_option('EE_DEBUG_SPCO_'.EE_Session::instance()->id(), array());
             $default_data = array(
-                $class                    => $func . '() : ' . $line,
+                $class                    => $func.'() : '.$line,
                 'request->step'           => $this->step,
                 'request->action'         => $this->action,
                 'current_step->slug'      => $this->current_step instanceof EE_SPCO_Reg_Step ?
@@ -1387,20 +1387,20 @@ 
                 $default_data['TXN_status'] = $this->transaction->status_ID();
                 $default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
                 foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
-                    $default_data['registrations'][ $REG_ID ] = $registration->status_ID();
+                    $default_data['registrations'][$REG_ID] = $registration->status_ID();
                 }
                 if ($this->transaction->ID()) {
-                    $TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
+                    $TXN_ID = 'EE_Transaction: '.$this->transaction->ID();
                     // don't serialize objects
                     $info = $this->_strip_objects($info);
-                    if (! isset($debug_data[ $TXN_ID ])) {
-                        $debug_data[ $TXN_ID ] = array();
+                    if ( ! isset($debug_data[$TXN_ID])) {
+                        $debug_data[$TXN_ID] = array();
                     }
-                    $debug_data[ $TXN_ID ][ microtime() ] = array_merge(
+                    $debug_data[$TXN_ID][microtime()] = array_merge(
                         $default_data,
                         $info
                     );
-                    update_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data);
+                    update_option('EE_DEBUG_SPCO_'.EE_Session::instance()->id(), $debug_data);
                 }
             }
         }
@@ -1417,17 +1417,17 @@ 
     {
         foreach ((array) $info as $key => $value) {
             if (is_array($value)) {
-                $info[ $key ] = $this->_strip_objects($value);
+                $info[$key] = $this->_strip_objects($value);
             } elseif (is_object($value)) {
                 $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
+                $info[$object_class] = array();
+                $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
                 if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
+                    $info[$object_class]['status'] = $value->status();
                 } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
+                    $info[$object_class]['status'] = $value->status_ID();
                 }
-                unset($info[ $key ]);
+                unset($info[$key]);
             }
         }
         return (array) $info;

modules/venues_archive/EED_Venues_Archive.module.php

Indentation +174 added lines, -174 removed lines

@@ -29,178 +29,178 @@
  */
 class EED_Venues_Archive extends EED_Module
 {
-    /**
-     * @return EED_Venues_Archive
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $custom_post_types = $custom_post_type_definitions->getDefinitions();
-        EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::VENUES ]['plural_slug'],
-            'Venues_Archive',
-            'run'
-        );
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     * run - initial module setup
-     *
-     * @access    public
-     * @param \WP $WP
-     */
-    public function run($WP)
-    {
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-    }
-
-
-    /**
-     * template_include
-     *
-     * @access public
-     * @param  string $template
-     * @return string
-     */
-    public function template_include($template)
-    {
-        // not a custom template?
-        if (
-            EE_Registry::instance()->load_core('Front_Controller', array(), false, true)
-                                   ->get_selected_template() != 'archive-espresso_venues.php'
-        ) {
-            EEH_Template::load_espresso_theme_functions();
-            // then add extra event data via hooks
-            add_filter('the_title', array($this, 'the_title'), 100, 1);
-            // don't know if theme uses the_excerpt
-            add_filter('the_excerpt', array($this, 'venue_details'), 100);
-            // or the_content
-            add_filter('the_content', array($this, 'venue_details'), 100);
-            // don't display entry meta because the existing theme will take care of that
-            add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false');
-        }
-        return $template;
-    }
-
-
-    /**
-     * the_title
-     *
-     * @access public
-     * @param  string $title
-     * @return string
-     */
-    public function the_title($title = '')
-    {
-        return $title;
-    }
-
-
-    /**
-     *    venue_details
-     *
-     * @access public
-     * @param  string $content
-     * @return string
-     */
-    public function venue_details($content)
-    {
-        global $post;
-        if (
-            $post->post_type == EspressoPostType::VENUES
-            && ! post_password_required()
-        ) {
-            // since the 'content-espresso_venues-details.php' template might be used directly from within a theme,
-            // it uses the_content() for displaying the $post->post_content
-            // so in order to load a template that uses the_content() from within a callback being used to filter the_content(),
-            // we need to first remove this callback from being applied to the_content() (otherwise it will recurse and blow up the interweb)
-            remove_filter('the_excerpt', array($this, 'venue_details'), 100);
-            remove_filter('the_content', array($this, 'venue_details'), 100);
-            // add filters we want
-            add_filter('the_content', array($this, 'venue_location'), 110);
-            add_filter('the_excerpt', array($this, 'venue_location'), 110);
-            // now load our template
-            $template = EEH_Template::locate_template('content-espresso_venues-details.php');
-            // now add our filter back in, plus some others
-            add_filter('the_excerpt', array($this, 'venue_details'), 100);
-            add_filter('the_content', array($this, 'venue_details'), 100);
-            // remove other filters we added so they won't get applied to the next post
-            remove_filter('the_content', array($this, 'venue_location'), 110);
-            remove_filter('the_excerpt', array($this, 'venue_location'), 110);
-            // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        }
-        return ! empty($template) ? $template : $content;
-    }
-
-
-    /**
-     * venue_location
-     *
-     * @access public
-     * @param  string $content
-     * @return string
-     */
-    public function venue_location($content)
-    {
-        return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
-    }
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', true) && is_archive()) {
-            // first check theme folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            }
-            wp_enqueue_style($this->theme);
-        }
-    }
+	/**
+	 * @return EED_Venues_Archive
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$custom_post_types = $custom_post_type_definitions->getDefinitions();
+		EED_Module::registerRoute(
+			$custom_post_types[ EspressoPostType::VENUES ]['plural_slug'],
+			'Venues_Archive',
+			'run'
+		);
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 * run - initial module setup
+	 *
+	 * @access    public
+	 * @param \WP $WP
+	 */
+	public function run($WP)
+	{
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+	}
+
+
+	/**
+	 * template_include
+	 *
+	 * @access public
+	 * @param  string $template
+	 * @return string
+	 */
+	public function template_include($template)
+	{
+		// not a custom template?
+		if (
+			EE_Registry::instance()->load_core('Front_Controller', array(), false, true)
+								   ->get_selected_template() != 'archive-espresso_venues.php'
+		) {
+			EEH_Template::load_espresso_theme_functions();
+			// then add extra event data via hooks
+			add_filter('the_title', array($this, 'the_title'), 100, 1);
+			// don't know if theme uses the_excerpt
+			add_filter('the_excerpt', array($this, 'venue_details'), 100);
+			// or the_content
+			add_filter('the_content', array($this, 'venue_details'), 100);
+			// don't display entry meta because the existing theme will take care of that
+			add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false');
+		}
+		return $template;
+	}
+
+
+	/**
+	 * the_title
+	 *
+	 * @access public
+	 * @param  string $title
+	 * @return string
+	 */
+	public function the_title($title = '')
+	{
+		return $title;
+	}
+
+
+	/**
+	 *    venue_details
+	 *
+	 * @access public
+	 * @param  string $content
+	 * @return string
+	 */
+	public function venue_details($content)
+	{
+		global $post;
+		if (
+			$post->post_type == EspressoPostType::VENUES
+			&& ! post_password_required()
+		) {
+			// since the 'content-espresso_venues-details.php' template might be used directly from within a theme,
+			// it uses the_content() for displaying the $post->post_content
+			// so in order to load a template that uses the_content() from within a callback being used to filter the_content(),
+			// we need to first remove this callback from being applied to the_content() (otherwise it will recurse and blow up the interweb)
+			remove_filter('the_excerpt', array($this, 'venue_details'), 100);
+			remove_filter('the_content', array($this, 'venue_details'), 100);
+			// add filters we want
+			add_filter('the_content', array($this, 'venue_location'), 110);
+			add_filter('the_excerpt', array($this, 'venue_location'), 110);
+			// now load our template
+			$template = EEH_Template::locate_template('content-espresso_venues-details.php');
+			// now add our filter back in, plus some others
+			add_filter('the_excerpt', array($this, 'venue_details'), 100);
+			add_filter('the_content', array($this, 'venue_details'), 100);
+			// remove other filters we added so they won't get applied to the next post
+			remove_filter('the_content', array($this, 'venue_location'), 110);
+			remove_filter('the_excerpt', array($this, 'venue_location'), 110);
+			// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		}
+		return ! empty($template) ? $template : $content;
+	}
+
+
+	/**
+	 * venue_location
+	 *
+	 * @access public
+	 * @param  string $content
+	 * @return string
+	 */
+	public function venue_location($content)
+	{
+		return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
+	}
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', true) && is_archive()) {
+			// first check theme folder
+			if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			} elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					EE_TEMPLATES_URL . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			}
+			wp_enqueue_style($this->theme);
+		}
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -54,7 +54,7 @@ 
         );
         $custom_post_types = $custom_post_type_definitions->getDefinitions();
         EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::VENUES ]['plural_slug'],
+            $custom_post_types[EspressoPostType::VENUES]['plural_slug'],
             'Venues_Archive',
             'run'
         );
@@ -172,7 +172,7 @@ 
      */
     public function venue_location($content)
     {
-        return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
+        return $content.EEH_Template::locate_template('content-espresso_venues-location.php');
     }
 
 
@@ -187,16 +187,16 @@ 
         // get some style
         if (apply_filters('FHEE_enable_default_espresso_css', true) && is_archive()) {
             // first check theme folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
-            } elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
+            } elseif (is_readable(EE_TEMPLATES.$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
+                    EE_TEMPLATES_URL.$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             }

modules/events_archive/EED_Events_Archive.module.php

Indentation +1052 added lines, -1052 removed lines

@@ -17,1047 +17,1047 @@ 
  */
 class EED_Events_Archive extends EED_Module
 {
-    const EVENT_DETAILS_PRIORITY   = 100;
-
-    const EVENT_DATETIMES_PRIORITY = 110;
-
-    const EVENT_TICKETS_PRIORITY   = 120;
-
-    const EVENT_VENUES_PRIORITY    = 130;
-
-
-    public static $espresso_event_list_ID    = 0;
-
-    public static $espresso_grid_event_lists = [];
-
-    /**
-     * @type bool $using_get_the_excerpt
-     */
-    protected static $using_get_the_excerpt = false;
-
-    /**
-     * Used to flag when the event list is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected static $iframe = false;
-
-    /**
-     * @var EventListIframeEmbedButton $_iframe_embed_button
-     */
-    private static $_iframe_embed_button;
-
-    /**
-     * @type EE_Template_Part_Manager $template_parts
-     */
-    protected $template_parts;
-
-
-    /**
-     * @return EED_Events_Archive
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        /** @var CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(CustomPostTypeDefinitions::class);
-        $custom_post_types            = $custom_post_type_definitions->getDefinitions();
-        EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::EVENTS ]['plural_slug'],
-            'Events_Archive',
-            'run'
-        );
-        EED_Module::registerRoute(
-            'event_list',
-            'Events_Archive',
-            'event_list'
-        );
-        EED_Module::registerRoute(
-            'iframe',
-            'Events_Archive',
-            'event_list_iframe',
-            'event_list'
-        );
-        add_action('wp_loaded', ['EED_Events_Archive', 'set_definitions'], 2);
-    }
-
-
-    /**
-     * for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', ['EED_Events_Archive', 'set_definitions'], 2);
-        // hook into the end of the \EE_Admin_Page::_load_page_dependencies()
-        // to load assets for "espresso_events" page on the "default" route (action)
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
-            ['EED_Events_Archive', 'event_list_iframe_embed_button'],
-            10
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
-    }
-
-
-    /**
-     * set up EE_Events_Archive_Config
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Events_Archive_Config');
-        $this->set_config_name('EED_Events_Archive');
-    }
-
-
-    /**
-     * @return EventListIframeEmbedButton
-     */
-    public static function get_iframe_embed_button()
-    {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
-            self::$_iframe_embed_button = new EventListIframeEmbedButton();
-        }
-        return self::$_iframe_embed_button;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function event_list_iframe_embed_button()
-    {
-        $iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
-        $iframe_embed_button->addEmbedButton();
-    }
-
-
-    /**
-     * @param EE_Events_Archive_Config|null $config
-     * @return EE_Template_Part_Manager
-     * @throws EE_Error
-     */
-    public function initialize_template_parts(EE_Events_Archive_Config $config = null)
-    {
-        $config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
-        EEH_Autoloader::register_template_part_autoloaders();
-        $template_parts = new EE_Template_Part_Manager();
-        $template_parts->add_template_part(
-            'tickets',
-            esc_html__('Ticket Selector', 'event_espresso'),
-            'content-espresso_events-tickets.php',
-            $config->display_order_tickets
-        );
-        $template_parts->add_template_part(
-            'datetimes',
-            esc_html__('Dates and Times', 'event_espresso'),
-            'content-espresso_events-datetimes.php',
-            $config->display_order_datetimes
-        );
-        $template_parts->add_template_part(
-            'event',
-            esc_html__('Event Description', 'event_espresso'),
-            'content-espresso_events-details.php',
-            $config->display_order_event
-        );
-        $template_parts->add_template_part(
-            'venue',
-            esc_html__('Venue Information', 'event_espresso'),
-            'content-espresso_events-venues.php',
-            $config->display_order_venue
-        );
-        do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
-        return $template_parts;
-    }
-
-
-    /**
-     * initial module setup
-     * this gets called by the EE_Front_Controller if the module route is found in the incoming request
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-        do_action('AHEE__EED_Events_Archive__before_run');
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        /** @type EE_Events_Archive_Config $config */
-        $config = $this->config();
-        // load other required components
-        $this->load_event_list_assets();
-        // filter the WP posts_join, posts_where, and posts_orderby SQL clauses
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            '',                             // month
-            '',                             // category
-            $config->display_expired_events // show_expired
-        );
-        // check what template is loaded
-        add_filter('template_include', [$this, 'template_include'], 999, 1);
-    }
-
-
-    /**
-     * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
-     *
-     * @return void
-     */
-    public function event_list()
-    {
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        // load other required components
-        $this->load_event_list_assets();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function event_list_iframe()
-    {
-        EED_Events_Archive::$iframe = true;
-        $event_list_iframe          = new EventsArchiveIframe($this);
-        $event_list_iframe->display();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public static function is_iframe()
-    {
-        return EED_Events_Archive::$iframe;
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function link_target()
-    {
-        return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
-    }
-
-
-    /**
-     * @param string $template
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function template_include($template = '')
-    {
-        // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
-            /** @type EE_Events_Archive_Config $config */
-            $config = $this->config();
-            // add status banner ?
-            if ($config->display_status_banner) {
-                add_filter('the_title', ['EED_Events_Archive', 'the_title'], 100, 2);
-            }
-            // if NOT a custom template
-            if (
-                apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
-                || EE_Registry::instance()
-                              ->load_core('Front_Controller')
-                              ->get_selected_template() !== 'archive-espresso_events.php'
-            ) {
-                add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
-                // load functions.php file for the theme (loaded by WP if using child theme)
-                EEH_Template::load_espresso_theme_functions();
-                EED_Events_Archive::addEventDetailsFilters();
-                // don't display entry meta because the existing theme will take care of that
-                add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
-            }
-        }
-        return $template;
-    }
-
-
-    /**
-     * kinda hacky, but if a theme is using get_the_excerpt(),
-     * then we need to remove our filters on the_content()
-     *
-     * @param string $excerpt
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_the_excerpt($excerpt = '')
-    {
-        if (post_password_required()) {
-            return $excerpt;
-        }
-        if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
-            EED_Events_Archive::removeEventDetailsFilters(false);
-            $excerpt = EED_Events_Archive::event_details($excerpt);
-        } else {
-            EED_Events_Archive::$using_get_the_excerpt = true;
-            add_filter('wp_trim_excerpt', ['EED_Events_Archive', 'end_get_the_excerpt'], 999, 1);
-        }
-        return $excerpt;
-    }
-
-
-    /**
-     * @param string $text
-     * @return string
-     */
-    public static function end_get_the_excerpt($text = '')
-    {
-        EED_Events_Archive::$using_get_the_excerpt = false;
-        return $text;
-    }
-
-
-    /**
-     * @param string $title
-     * @param string $id
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_title($title = '', $id = '')
-    {
-        global $post;
-        if ($post instanceof WP_Post) {
-            return (EED_Events_Archive::isBlockTheme() || in_the_loop()) && $post->ID == $id
-                ? espresso_event_status_banner($post->ID) . $title
-                : $title;
-        }
-        return $title;
-    }
-
-
-    /**
-     * @param string $content
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_details($content)
-    {
-        global $post;
-        static $current_post_ID = 0;
-        if (
-            $current_post_ID !== $post->ID
-            && $post->post_type === EspressoPostType::EVENTS
-            && ! EED_Events_Archive::$using_get_the_excerpt
-            && ! post_password_required()
-            && (
-                apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
-                || ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
-            )
-        ) {
-            // Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
-            // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
-            // BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
-            // We want to allow those plugins to still do their thing and have access to our content, but depending on
-            // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
-            // so the following allows this filter to be applied multiple times, but only once for real
-            $current_post_ID = did_action('loop_start') ? $post->ID : 0;
-            if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
-                $content = EED_Events_Archive::use_sortable_display_order();
-            } else {
-                $content = EED_Events_Archive::use_filterable_display_order();
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function use_sortable_display_order()
-    {
-        // no further password checks required atm
-        add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
-        // remove this callback from being applied to the_content()
-        EED_Events_Archive::removeEventDetailsFilters();
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        $content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
-        // re-add our main filters (or else the next event won't have them)
-        EED_Events_Archive::addEventDetailsFilters();
-        remove_filter(
-            'FHEE__EED_Events_Archive__event_details__no_post_password_required',
-            '__return_true'
-        );
-        return $content;
-    }
-
-
-    /**
-     * @return string
-     */
-    protected static function use_filterable_display_order()
-    {
-        // remove this callback from being applied to the_content()
-        EED_Events_Archive::removeEventDetailsFilters();
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::_add_additional_excerpt_filters();
-        EED_Events_Archive::_add_additional_content_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
-        // now load our template
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        // re-add our main filters (or else the next event won't have them)
-        EED_Events_Archive::addEventDetailsFilters();
-        // but remove the other filters so that they don't get applied to the next post
-        EED_Events_Archive::_remove_additional_events_archive_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        // return ! empty( $template ) ? $template : $content;
-        return $content;
-    }
-
-
-    /**
-     * adds datetimes ABOVE content
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function event_datetimes($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
-    }
-
-
-    /**
-     * adds tickets ABOVE content (which includes datetimes)
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function event_tickets($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
-    }
-
-
-    /**
-     * adds venues BELOW content
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function event_venue($content)
-    {
-        return EED_Events_Archive::event_venues($content);
-    }
-
-
-    /**
-     * adds venues BELOW content
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function event_venues($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
-    }
-
-
-    /**
-     * @return bool
-     * @since 4.10.33.p
-     */
-    public static function isBlockTheme()
-    {
-        return function_exists('wp_is_block_theme') && wp_is_block_theme();
-    }
-
-
-    /**
-     * @return string
-     * @since 4.10.33.p
-     */
-    public static function getExcerptFilter()
-    {
-        static $excerpt_filter = null;
-        if ($excerpt_filter === null) {
-            $excerpt_filter = EED_Events_Archive::isBlockTheme() ? 'get_the_excerpt' : 'the_excerpt';
-        }
-        return $excerpt_filter;
-    }
-
-
-    /**
-     * @since 4.10.33.p
-     */
-    protected static function addEventDetailsFilters()
-    {
-        add_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        // but because we don't know if the theme is using the_excerpt()
-        add_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        // and just in case they are running get_the_excerpt() which DESTROYS things
-        add_filter('get_the_excerpt', ['EED_Events_Archive', 'get_the_excerpt'], 1, 1);
-    }
-
-
-    /**
-     * @param bool $and_get_the_excerpt
-     * @since 4.10.33.p
-     */
-    protected static function removeEventDetailsFilters($and_get_the_excerpt = true)
-    {
-        // we need to first remove all callbacks from being applied to the_content()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        if ($and_get_the_excerpt) {
-            remove_filter('get_the_excerpt', ['EED_Events_Archive', 'get_the_excerpt'], 1);
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private static function _add_additional_excerpt_filters()
-    {
-        add_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private static function _add_additional_content_filters()
-    {
-        add_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private static function _remove_additional_events_archive_filters()
-    {
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function remove_all_events_archive_filters()
-    {
-        // remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
-        remove_filter('the_title', ['EED_Events_Archive', 'the_title'], 1);
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        // don't display entry meta because the existing theme will take care of that
-        remove_filter(
-            'FHEE__content_espresso_events_details_template__display_entry_meta',
-            '__return_false'
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_event_list_assets()
-    {
-        do_action('AHEE__EED_Events_Archive__before_load_assets');
-        add_filter('FHEE_load_EE_Session', '__return_true');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        add_action('wp_enqueue_scripts', [$this, 'wp_enqueue_scripts'], 10);
-        if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-            add_action('wp_enqueue_scripts', ['EEH_Maps', 'espresso_google_map_js'], 11);
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', false)) {
-            // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    ['dashicons', 'espresso_default']
-                );
-            }
-            wp_enqueue_style($this->theme);
-        }
-    }
-
-
-    /**
-     * @static
-     * @return void
-     */
-    public static function template_settings_form()
-    {
-        $template_settings                     = EE_Registry::instance()->CFG->template_settings;
-        $template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
-            ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
-        $template_settings->EED_Events_Archive = apply_filters(
-            'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
-            $template_settings->EED_Events_Archive
-        );
-        $events_archive_settings               = [
-            'display_status_banner'   => 0,
-            'display_description'     => 1,
-            'display_ticket_selector' => 0,
-            'display_datetimes'       => 1,
-            'display_venue'           => 0,
-            'display_expired_events'  => 0,
-        ];
-        $events_archive_settings               = array_merge(
-            $events_archive_settings,
-            (array) $template_settings->EED_Events_Archive
-        );
-        EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
-            $events_archive_settings
-        );
-    }
-
-
-    /**
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ
-     * @return EE_Template_Config
-     */
-    public static function update_template_settings(EE_Template_Config $CFG, array $REQ): EE_Template_Config
-    {
-        $CFG->EED_Events_Archive = new EE_Events_Archive_Config();
-        // unless we are resetting the config...
-        if (
-            ! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
-            || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
-        ) {
-            $CFG->EED_Events_Archive->display_status_banner   = isset($REQ['EED_Events_Archive_display_status_banner'])
-                ? absint($REQ['EED_Events_Archive_display_status_banner'])
-                : 0;
-            $CFG->EED_Events_Archive->display_description     = isset($REQ['EED_Events_Archive_display_description'])
-                ? absint($REQ['EED_Events_Archive_display_description'])
-                : 1;
-            $CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
-                ? absint($REQ['EED_Events_Archive_display_ticket_selector'])
-                : 0;
-            $CFG->EED_Events_Archive->display_datetimes       = isset($REQ['EED_Events_Archive_display_datetimes'])
-                ? absint($REQ['EED_Events_Archive_display_datetimes'])
-                : 1;
-            $CFG->EED_Events_Archive->display_venue           = isset($REQ['EED_Events_Archive_display_venue'])
-                ? absint($REQ['EED_Events_Archive_display_venue'])
-                : 0;
-            $CFG->EED_Events_Archive->display_expired_events  = isset($REQ['EED_Events_Archive_display_expired_events'])
-                ? absint($REQ['EED_Events_Archive_display_expired_events'])
-                : 0;
-        }
-        return $CFG;
-    }
-
-
-    /**
-     * @param string $extra_class
-     * @return string
-     */
-    public static function event_list_css($extra_class = '')
-    {
-        $event_list_css   = ! empty($extra_class) ? [$extra_class] : [];
-        $event_list_css[] = 'espresso-event-list-event';
-        return implode(' ', $event_list_css);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_categories()
-    {
-        return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
-    }
-
-
-    /**
-     * @param $value
-     * @return bool
-     */
-    public static function display_description($value)
-    {
-        $config              = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        $display_description = isset($config->display_description) ? $config->display_description : 1;
-        return $display_description === $value;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public static function display_ticket_selector()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_ticket_selector) && $config->display_ticket_selector;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function display_venue()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public static function display_datetimes()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_datetimes) && $config->display_datetimes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function event_list_title()
-    {
-        return apply_filters(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            esc_html__('Upcoming Events', 'event_espresso')
-        );
-    }
-
-
-    // GRAVEYARD
-
-
-    /**
-     * @since 4.4.0
-     */
-    public static function _doing_it_wrong_notice($function = '')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
-                    'event_espresso'
-                ),
-                $function,
-                '<br />',
-                '4.6.0'
-            ),
-            '4.4.0'
-        );
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function get_post_data()
-    {
-        EEH_Event_Query::set_query_params();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_fields_sql_for_orderby($orderby_params = [])
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_join_sql_for_terms($join_terms = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_join_for_orderby($orderby_params = [])
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_orderby_sql($orderby_params = [], $sort = 'ASC')
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
-    }
+	const EVENT_DETAILS_PRIORITY   = 100;
+
+	const EVENT_DATETIMES_PRIORITY = 110;
+
+	const EVENT_TICKETS_PRIORITY   = 120;
+
+	const EVENT_VENUES_PRIORITY    = 130;
+
+
+	public static $espresso_event_list_ID    = 0;
+
+	public static $espresso_grid_event_lists = [];
+
+	/**
+	 * @type bool $using_get_the_excerpt
+	 */
+	protected static $using_get_the_excerpt = false;
+
+	/**
+	 * Used to flag when the event list is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected static $iframe = false;
+
+	/**
+	 * @var EventListIframeEmbedButton $_iframe_embed_button
+	 */
+	private static $_iframe_embed_button;
+
+	/**
+	 * @type EE_Template_Part_Manager $template_parts
+	 */
+	protected $template_parts;
+
+
+	/**
+	 * @return EED_Events_Archive
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		/** @var CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(CustomPostTypeDefinitions::class);
+		$custom_post_types            = $custom_post_type_definitions->getDefinitions();
+		EED_Module::registerRoute(
+			$custom_post_types[ EspressoPostType::EVENTS ]['plural_slug'],
+			'Events_Archive',
+			'run'
+		);
+		EED_Module::registerRoute(
+			'event_list',
+			'Events_Archive',
+			'event_list'
+		);
+		EED_Module::registerRoute(
+			'iframe',
+			'Events_Archive',
+			'event_list_iframe',
+			'event_list'
+		);
+		add_action('wp_loaded', ['EED_Events_Archive', 'set_definitions'], 2);
+	}
+
+
+	/**
+	 * for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', ['EED_Events_Archive', 'set_definitions'], 2);
+		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
+		// to load assets for "espresso_events" page on the "default" route (action)
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
+			['EED_Events_Archive', 'event_list_iframe_embed_button'],
+			10
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+	}
+
+
+	/**
+	 * set up EE_Events_Archive_Config
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Events_Archive_Config');
+		$this->set_config_name('EED_Events_Archive');
+	}
+
+
+	/**
+	 * @return EventListIframeEmbedButton
+	 */
+	public static function get_iframe_embed_button()
+	{
+		if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+			self::$_iframe_embed_button = new EventListIframeEmbedButton();
+		}
+		return self::$_iframe_embed_button;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function event_list_iframe_embed_button()
+	{
+		$iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
+		$iframe_embed_button->addEmbedButton();
+	}
+
+
+	/**
+	 * @param EE_Events_Archive_Config|null $config
+	 * @return EE_Template_Part_Manager
+	 * @throws EE_Error
+	 */
+	public function initialize_template_parts(EE_Events_Archive_Config $config = null)
+	{
+		$config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
+		EEH_Autoloader::register_template_part_autoloaders();
+		$template_parts = new EE_Template_Part_Manager();
+		$template_parts->add_template_part(
+			'tickets',
+			esc_html__('Ticket Selector', 'event_espresso'),
+			'content-espresso_events-tickets.php',
+			$config->display_order_tickets
+		);
+		$template_parts->add_template_part(
+			'datetimes',
+			esc_html__('Dates and Times', 'event_espresso'),
+			'content-espresso_events-datetimes.php',
+			$config->display_order_datetimes
+		);
+		$template_parts->add_template_part(
+			'event',
+			esc_html__('Event Description', 'event_espresso'),
+			'content-espresso_events-details.php',
+			$config->display_order_event
+		);
+		$template_parts->add_template_part(
+			'venue',
+			esc_html__('Venue Information', 'event_espresso'),
+			'content-espresso_events-venues.php',
+			$config->display_order_venue
+		);
+		do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
+		return $template_parts;
+	}
+
+
+	/**
+	 * initial module setup
+	 * this gets called by the EE_Front_Controller if the module route is found in the incoming request
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+		do_action('AHEE__EED_Events_Archive__before_run');
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		/** @type EE_Events_Archive_Config $config */
+		$config = $this->config();
+		// load other required components
+		$this->load_event_list_assets();
+		// filter the WP posts_join, posts_where, and posts_orderby SQL clauses
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			'',                             // month
+			'',                             // category
+			$config->display_expired_events // show_expired
+		);
+		// check what template is loaded
+		add_filter('template_include', [$this, 'template_include'], 999, 1);
+	}
+
+
+	/**
+	 * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
+	 *
+	 * @return void
+	 */
+	public function event_list()
+	{
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		// load other required components
+		$this->load_event_list_assets();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function event_list_iframe()
+	{
+		EED_Events_Archive::$iframe = true;
+		$event_list_iframe          = new EventsArchiveIframe($this);
+		$event_list_iframe->display();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public static function is_iframe()
+	{
+		return EED_Events_Archive::$iframe;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function link_target()
+	{
+		return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
+	}
+
+
+	/**
+	 * @param string $template
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function template_include($template = '')
+	{
+		// don't add content filter for dedicated EE child themes or private posts
+		if (! EEH_Template::is_espresso_theme()) {
+			/** @type EE_Events_Archive_Config $config */
+			$config = $this->config();
+			// add status banner ?
+			if ($config->display_status_banner) {
+				add_filter('the_title', ['EED_Events_Archive', 'the_title'], 100, 2);
+			}
+			// if NOT a custom template
+			if (
+				apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
+				|| EE_Registry::instance()
+							  ->load_core('Front_Controller')
+							  ->get_selected_template() !== 'archive-espresso_events.php'
+			) {
+				add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
+				// load functions.php file for the theme (loaded by WP if using child theme)
+				EEH_Template::load_espresso_theme_functions();
+				EED_Events_Archive::addEventDetailsFilters();
+				// don't display entry meta because the existing theme will take care of that
+				add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
+			}
+		}
+		return $template;
+	}
+
+
+	/**
+	 * kinda hacky, but if a theme is using get_the_excerpt(),
+	 * then we need to remove our filters on the_content()
+	 *
+	 * @param string $excerpt
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_the_excerpt($excerpt = '')
+	{
+		if (post_password_required()) {
+			return $excerpt;
+		}
+		if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
+			EED_Events_Archive::removeEventDetailsFilters(false);
+			$excerpt = EED_Events_Archive::event_details($excerpt);
+		} else {
+			EED_Events_Archive::$using_get_the_excerpt = true;
+			add_filter('wp_trim_excerpt', ['EED_Events_Archive', 'end_get_the_excerpt'], 999, 1);
+		}
+		return $excerpt;
+	}
+
+
+	/**
+	 * @param string $text
+	 * @return string
+	 */
+	public static function end_get_the_excerpt($text = '')
+	{
+		EED_Events_Archive::$using_get_the_excerpt = false;
+		return $text;
+	}
+
+
+	/**
+	 * @param string $title
+	 * @param string $id
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_title($title = '', $id = '')
+	{
+		global $post;
+		if ($post instanceof WP_Post) {
+			return (EED_Events_Archive::isBlockTheme() || in_the_loop()) && $post->ID == $id
+				? espresso_event_status_banner($post->ID) . $title
+				: $title;
+		}
+		return $title;
+	}
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_details($content)
+	{
+		global $post;
+		static $current_post_ID = 0;
+		if (
+			$current_post_ID !== $post->ID
+			&& $post->post_type === EspressoPostType::EVENTS
+			&& ! EED_Events_Archive::$using_get_the_excerpt
+			&& ! post_password_required()
+			&& (
+				apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
+				|| ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
+			)
+		) {
+			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
+			// Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
+			// BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
+			// We want to allow those plugins to still do their thing and have access to our content, but depending on
+			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
+			// so the following allows this filter to be applied multiple times, but only once for real
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
+				$content = EED_Events_Archive::use_sortable_display_order();
+			} else {
+				$content = EED_Events_Archive::use_filterable_display_order();
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function use_sortable_display_order()
+	{
+		// no further password checks required atm
+		add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
+		// remove this callback from being applied to the_content()
+		EED_Events_Archive::removeEventDetailsFilters();
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
+		// re-add our main filters (or else the next event won't have them)
+		EED_Events_Archive::addEventDetailsFilters();
+		remove_filter(
+			'FHEE__EED_Events_Archive__event_details__no_post_password_required',
+			'__return_true'
+		);
+		return $content;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected static function use_filterable_display_order()
+	{
+		// remove this callback from being applied to the_content()
+		EED_Events_Archive::removeEventDetailsFilters();
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::_add_additional_excerpt_filters();
+		EED_Events_Archive::_add_additional_content_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
+		// now load our template
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		// re-add our main filters (or else the next event won't have them)
+		EED_Events_Archive::addEventDetailsFilters();
+		// but remove the other filters so that they don't get applied to the next post
+		EED_Events_Archive::_remove_additional_events_archive_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		// return ! empty( $template ) ? $template : $content;
+		return $content;
+	}
+
+
+	/**
+	 * adds datetimes ABOVE content
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function event_datetimes($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+	}
+
+
+	/**
+	 * adds tickets ABOVE content (which includes datetimes)
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function event_tickets($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+	}
+
+
+	/**
+	 * adds venues BELOW content
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function event_venue($content)
+	{
+		return EED_Events_Archive::event_venues($content);
+	}
+
+
+	/**
+	 * adds venues BELOW content
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function event_venues($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+	}
+
+
+	/**
+	 * @return bool
+	 * @since 4.10.33.p
+	 */
+	public static function isBlockTheme()
+	{
+		return function_exists('wp_is_block_theme') && wp_is_block_theme();
+	}
+
+
+	/**
+	 * @return string
+	 * @since 4.10.33.p
+	 */
+	public static function getExcerptFilter()
+	{
+		static $excerpt_filter = null;
+		if ($excerpt_filter === null) {
+			$excerpt_filter = EED_Events_Archive::isBlockTheme() ? 'get_the_excerpt' : 'the_excerpt';
+		}
+		return $excerpt_filter;
+	}
+
+
+	/**
+	 * @since 4.10.33.p
+	 */
+	protected static function addEventDetailsFilters()
+	{
+		add_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		// but because we don't know if the theme is using the_excerpt()
+		add_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		// and just in case they are running get_the_excerpt() which DESTROYS things
+		add_filter('get_the_excerpt', ['EED_Events_Archive', 'get_the_excerpt'], 1, 1);
+	}
+
+
+	/**
+	 * @param bool $and_get_the_excerpt
+	 * @since 4.10.33.p
+	 */
+	protected static function removeEventDetailsFilters($and_get_the_excerpt = true)
+	{
+		// we need to first remove all callbacks from being applied to the_content()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		if ($and_get_the_excerpt) {
+			remove_filter('get_the_excerpt', ['EED_Events_Archive', 'get_the_excerpt'], 1);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private static function _add_additional_excerpt_filters()
+	{
+		add_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private static function _add_additional_content_filters()
+	{
+		add_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private static function _remove_additional_events_archive_filters()
+	{
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function remove_all_events_archive_filters()
+	{
+		// remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('the_title', ['EED_Events_Archive', 'the_title'], 1);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		// don't display entry meta because the existing theme will take care of that
+		remove_filter(
+			'FHEE__content_espresso_events_details_template__display_entry_meta',
+			'__return_false'
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_event_list_assets()
+	{
+		do_action('AHEE__EED_Events_Archive__before_load_assets');
+		add_filter('FHEE_load_EE_Session', '__return_true');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		add_action('wp_enqueue_scripts', [$this, 'wp_enqueue_scripts'], 10);
+		if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+			add_action('wp_enqueue_scripts', ['EEH_Maps', 'espresso_google_map_js'], 11);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', false)) {
+			// first check uploads folder
+			if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					['dashicons', 'espresso_default']
+				);
+			}
+			wp_enqueue_style($this->theme);
+		}
+	}
+
+
+	/**
+	 * @static
+	 * @return void
+	 */
+	public static function template_settings_form()
+	{
+		$template_settings                     = EE_Registry::instance()->CFG->template_settings;
+		$template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
+			? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
+		$template_settings->EED_Events_Archive = apply_filters(
+			'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
+			$template_settings->EED_Events_Archive
+		);
+		$events_archive_settings               = [
+			'display_status_banner'   => 0,
+			'display_description'     => 1,
+			'display_ticket_selector' => 0,
+			'display_datetimes'       => 1,
+			'display_venue'           => 0,
+			'display_expired_events'  => 0,
+		];
+		$events_archive_settings               = array_merge(
+			$events_archive_settings,
+			(array) $template_settings->EED_Events_Archive
+		);
+		EEH_Template::display_template(
+			EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+			$events_archive_settings
+		);
+	}
+
+
+	/**
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ
+	 * @return EE_Template_Config
+	 */
+	public static function update_template_settings(EE_Template_Config $CFG, array $REQ): EE_Template_Config
+	{
+		$CFG->EED_Events_Archive = new EE_Events_Archive_Config();
+		// unless we are resetting the config...
+		if (
+			! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
+			|| absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
+		) {
+			$CFG->EED_Events_Archive->display_status_banner   = isset($REQ['EED_Events_Archive_display_status_banner'])
+				? absint($REQ['EED_Events_Archive_display_status_banner'])
+				: 0;
+			$CFG->EED_Events_Archive->display_description     = isset($REQ['EED_Events_Archive_display_description'])
+				? absint($REQ['EED_Events_Archive_display_description'])
+				: 1;
+			$CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
+				? absint($REQ['EED_Events_Archive_display_ticket_selector'])
+				: 0;
+			$CFG->EED_Events_Archive->display_datetimes       = isset($REQ['EED_Events_Archive_display_datetimes'])
+				? absint($REQ['EED_Events_Archive_display_datetimes'])
+				: 1;
+			$CFG->EED_Events_Archive->display_venue           = isset($REQ['EED_Events_Archive_display_venue'])
+				? absint($REQ['EED_Events_Archive_display_venue'])
+				: 0;
+			$CFG->EED_Events_Archive->display_expired_events  = isset($REQ['EED_Events_Archive_display_expired_events'])
+				? absint($REQ['EED_Events_Archive_display_expired_events'])
+				: 0;
+		}
+		return $CFG;
+	}
+
+
+	/**
+	 * @param string $extra_class
+	 * @return string
+	 */
+	public static function event_list_css($extra_class = '')
+	{
+		$event_list_css   = ! empty($extra_class) ? [$extra_class] : [];
+		$event_list_css[] = 'espresso-event-list-event';
+		return implode(' ', $event_list_css);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_categories()
+	{
+		return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
+	}
+
+
+	/**
+	 * @param $value
+	 * @return bool
+	 */
+	public static function display_description($value)
+	{
+		$config              = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		$display_description = isset($config->display_description) ? $config->display_description : 1;
+		return $display_description === $value;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public static function display_ticket_selector()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_ticket_selector) && $config->display_ticket_selector;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function display_venue()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public static function display_datetimes()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_datetimes) && $config->display_datetimes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function event_list_title()
+	{
+		return apply_filters(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			esc_html__('Upcoming Events', 'event_espresso')
+		);
+	}
+
+
+	// GRAVEYARD
+
+
+	/**
+	 * @since 4.4.0
+	 */
+	public static function _doing_it_wrong_notice($function = '')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
+					'event_espresso'
+				),
+				$function,
+				'<br />',
+				'4.6.0'
+			),
+			'4.4.0'
+		);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function get_post_data()
+	{
+		EEH_Event_Query::set_query_params();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_fields_sql_for_orderby($orderby_params = [])
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_join_sql_for_terms($join_terms = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_join_for_orderby($orderby_params = [])
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_orderby_sql($orderby_params = [], $sort = 'ASC')
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
+	}
 }
 
 
@@ -1066,9 +1066,9 @@ 
  */
 function espresso_get_event_list_ID()
 {
-    EED_Events_Archive::$espresso_event_list_ID++;
-    EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
-    return EED_Events_Archive::$espresso_event_list_ID;
+	EED_Events_Archive::$espresso_event_list_ID++;
+	EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
+	return EED_Events_Archive::$espresso_event_list_ID;
 }
 
 
@@ -1077,7 +1077,7 @@ 
  */
 function espresso_event_list_title()
 {
-    return EED_Events_Archive::event_list_title();
+	return EED_Events_Archive::event_list_title();
 }
 
 
@@ -1087,7 +1087,7 @@ 
  */
 function espresso_event_list_css($extra_class = '')
 {
-    return EED_Events_Archive::event_list_css($extra_class);
+	return EED_Events_Archive::event_list_css($extra_class);
 }
 
 
@@ -1098,7 +1098,7 @@ 
  */
 function espresso_get_event_categories()
 {
-    return EED_Events_Archive::event_categories();
+	return EED_Events_Archive::event_categories();
 }
 
 
@@ -1107,7 +1107,7 @@ 
  */
 function espresso_display_full_description_in_event_list()
 {
-    return EED_Events_Archive::display_description(2);
+	return EED_Events_Archive::display_description(2);
 }
 
 
@@ -1116,7 +1116,7 @@ 
  */
 function espresso_display_excerpt_in_event_list()
 {
-    return EED_Events_Archive::display_description(1);
+	return EED_Events_Archive::display_description(1);
 }
 
 
@@ -1125,7 +1125,7 @@ 
  */
 function espresso_display_ticket_selector_in_event_list()
 {
-    return EED_Events_Archive::display_ticket_selector();
+	return EED_Events_Archive::display_ticket_selector();
 }
 
 
@@ -1136,7 +1136,7 @@ 
  */
 function espresso_display_venue_in_event_list()
 {
-    return EED_Events_Archive::display_venue();
+	return EED_Events_Archive::display_venue();
 }
 
 
@@ -1145,5 +1145,5 @@ 
  */
 function espresso_display_datetimes_in_event_list()
 {
-    return EED_Events_Archive::display_datetimes();
+	return EED_Events_Archive::display_datetimes();
 }

Spacing +16 added lines, -16 removed lines

@@ -78,7 +78,7 @@ 
         $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(CustomPostTypeDefinitions::class);
         $custom_post_types            = $custom_post_type_definitions->getDefinitions();
         EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::EVENTS ]['plural_slug'],
+            $custom_post_types[EspressoPostType::EVENTS]['plural_slug'],
             'Events_Archive',
             'run'
         );
@@ -120,8 +120,8 @@ 
      */
     public static function set_definitions()
     {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
+        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/');
     }
 
 
@@ -141,7 +141,7 @@ 
      */
     public static function get_iframe_embed_button()
     {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+        if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
             self::$_iframe_embed_button = new EventListIframeEmbedButton();
         }
         return self::$_iframe_embed_button;
@@ -218,8 +218,8 @@ 
         EEH_Event_Query::add_query_filters();
         // set params that will get used by the filters
         EEH_Event_Query::set_query_params(
-            '',                             // month
-            '',                             // category
+            '', // month
+            '', // category
             $config->display_expired_events // show_expired
         );
         // check what template is loaded
@@ -281,7 +281,7 @@ 
     public function template_include($template = '')
     {
         // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
+        if ( ! EEH_Template::is_espresso_theme()) {
             /** @type EE_Events_Archive_Config $config */
             $config = $this->config();
             // add status banner ?
@@ -355,7 +355,7 @@ 
         global $post;
         if ($post instanceof WP_Post) {
             return (EED_Events_Archive::isBlockTheme() || in_the_loop()) && $post->ID == $id
-                ? espresso_event_status_banner($post->ID) . $title
+                ? espresso_event_status_banner($post->ID).$title
                 : $title;
         }
         return $title;
@@ -459,7 +459,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
     }
 
 
@@ -474,7 +474,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
     }
 
 
@@ -501,7 +501,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+        return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
     }
 
 
@@ -737,10 +737,10 @@ 
         // get some style
         if (apply_filters('FHEE_enable_default_espresso_css', false)) {
             // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (EEH_File::is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     ['dashicons', 'espresso_default']
                 );
             }
@@ -762,7 +762,7 @@ 
             'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
             $template_settings->EED_Events_Archive
         );
-        $events_archive_settings               = [
+        $events_archive_settings = [
             'display_status_banner'   => 0,
             'display_description'     => 1,
             'display_ticket_selector' => 0,
@@ -770,12 +770,12 @@ 
             'display_venue'           => 0,
             'display_expired_events'  => 0,
         ];
-        $events_archive_settings               = array_merge(
+        $events_archive_settings = array_merge(
             $events_archive_settings,
             (array) $template_settings->EED_Events_Archive
         );
         EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+            EVENTS_ARCHIVE_TEMPLATES_PATH.'admin-event-list-settings.template.php',
             $events_archive_settings
         );
     }

modules/venue_single/EED_Venue_Single.module.php

Indentation +169 added lines, -169 removed lines

@@ -29,173 +29,173 @@
  */
 class EED_Venue_Single extends EED_Module
 {
-    /**
-     * @return EED_Venue_Single
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $custom_post_types = $custom_post_type_definitions->getDefinitions();
-        EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::VENUES ]['singular_slug'],
-            'Venue_Single',
-            'run'
-        );
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     * run - initial module setup
-     *
-     * @access    public
-     * @param \WP $WP
-     */
-    public function run($WP)
-    {
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-    }
-
-
-    /**
-     * template_include
-     *
-     * @access public
-     * @param  string $template
-     * @return string
-     */
-    public function template_include($template)
-    {
-        // not a custom template?
-        if (
-            EE_Registry::instance()
-                       ->load_core('Front_Controller', array(), false, true)
-                       ->get_selected_template() != 'single-espresso_venues.php'
-        ) {
-            EEH_Template::load_espresso_theme_functions();
-            // then add extra event data via hooks
-            add_filter('the_title', array($this, 'the_title'), 100, 1);
-            add_filter('the_content', array($this, 'venue_details'), 100);
-            // don't display entry meta because the existing theme will take car of that
-            add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false');
-        }
-        return $template;
-    }
-
-
-    /**
-     * the_title
-     *
-     * @access public
-     * @param  string $title
-     * @return string
-     */
-    public function the_title($title = '')
-    {
-        return $title;
-    }
-
-
-    /**
-     *    venue_details
-     *
-     * @access public
-     * @param  string $content
-     * @return string
-     */
-    public function venue_details($content)
-    {
-        global $post;
-        if (
-            $post->post_type == EspressoPostType::VENUES
-            && ! post_password_required()
-        ) {
-            // since the 'content-espresso_venues-details.php' template might be used directly from within a theme,
-            // it uses the_content() for displaying the $post->post_content
-            // so in order to load a template that uses the_content() from within a callback being used to filter the_content(),
-            // we need to first remove this callback from being applied to the_content() (otherwise it will recurse and blow up the interweb)
-            remove_filter('the_content', array($this, 'venue_details'), 100);
-            // add filters we want
-            add_filter('the_content', array($this, 'venue_location'), 110);
-            // now load our template
-            $template = EEH_Template::locate_template('content-espresso_venues-details.php');
-            // remove other filters we added so they won't get applied to the next post
-            remove_filter('the_content', array($this, 'venue_location'), 110);
-        }
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        return ! empty($template) ? $template : $content;
-    }
-
-
-    /**
-     * venue_location
-     *
-     * @access public
-     * @param  string $content
-     * @return string
-     */
-    public function venue_location($content)
-    {
-        return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
-    }
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access public
-     * @return void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', true) && is_single()) {
-            // first check theme folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            }
-            wp_enqueue_style($this->theme);
-            if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-                add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
-            }
-        }
-    }
+	/**
+	 * @return EED_Venue_Single
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$custom_post_types = $custom_post_type_definitions->getDefinitions();
+		EED_Module::registerRoute(
+			$custom_post_types[ EspressoPostType::VENUES ]['singular_slug'],
+			'Venue_Single',
+			'run'
+		);
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 * run - initial module setup
+	 *
+	 * @access    public
+	 * @param \WP $WP
+	 */
+	public function run($WP)
+	{
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+	}
+
+
+	/**
+	 * template_include
+	 *
+	 * @access public
+	 * @param  string $template
+	 * @return string
+	 */
+	public function template_include($template)
+	{
+		// not a custom template?
+		if (
+			EE_Registry::instance()
+					   ->load_core('Front_Controller', array(), false, true)
+					   ->get_selected_template() != 'single-espresso_venues.php'
+		) {
+			EEH_Template::load_espresso_theme_functions();
+			// then add extra event data via hooks
+			add_filter('the_title', array($this, 'the_title'), 100, 1);
+			add_filter('the_content', array($this, 'venue_details'), 100);
+			// don't display entry meta because the existing theme will take car of that
+			add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false');
+		}
+		return $template;
+	}
+
+
+	/**
+	 * the_title
+	 *
+	 * @access public
+	 * @param  string $title
+	 * @return string
+	 */
+	public function the_title($title = '')
+	{
+		return $title;
+	}
+
+
+	/**
+	 *    venue_details
+	 *
+	 * @access public
+	 * @param  string $content
+	 * @return string
+	 */
+	public function venue_details($content)
+	{
+		global $post;
+		if (
+			$post->post_type == EspressoPostType::VENUES
+			&& ! post_password_required()
+		) {
+			// since the 'content-espresso_venues-details.php' template might be used directly from within a theme,
+			// it uses the_content() for displaying the $post->post_content
+			// so in order to load a template that uses the_content() from within a callback being used to filter the_content(),
+			// we need to first remove this callback from being applied to the_content() (otherwise it will recurse and blow up the interweb)
+			remove_filter('the_content', array($this, 'venue_details'), 100);
+			// add filters we want
+			add_filter('the_content', array($this, 'venue_location'), 110);
+			// now load our template
+			$template = EEH_Template::locate_template('content-espresso_venues-details.php');
+			// remove other filters we added so they won't get applied to the next post
+			remove_filter('the_content', array($this, 'venue_location'), 110);
+		}
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		return ! empty($template) ? $template : $content;
+	}
+
+
+	/**
+	 * venue_location
+	 *
+	 * @access public
+	 * @param  string $content
+	 * @return string
+	 */
+	public function venue_location($content)
+	{
+		return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
+	}
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', true) && is_single()) {
+			// first check theme folder
+			if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			} elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					EE_TEMPLATES_URL . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			}
+			wp_enqueue_style($this->theme);
+			if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+				add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
+			}
+		}
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -54,7 +54,7 @@ 
         );
         $custom_post_types = $custom_post_type_definitions->getDefinitions();
         EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::VENUES ]['singular_slug'],
+            $custom_post_types[EspressoPostType::VENUES]['singular_slug'],
             'Venue_Single',
             'run'
         );
@@ -164,7 +164,7 @@ 
      */
     public function venue_location($content)
     {
-        return $content . EEH_Template::locate_template('content-espresso_venues-location.php');
+        return $content.EEH_Template::locate_template('content-espresso_venues-location.php');
     }
 
 
@@ -179,16 +179,16 @@ 
         // get some style
         if (apply_filters('FHEE_enable_default_espresso_css', true) && is_single()) {
             // first check theme folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
-            } elseif (is_readable(EE_TEMPLATES . $this->theme . '/style.css')) {
+            } elseif (is_readable(EE_TEMPLATES.$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
+                    EE_TEMPLATES_URL.$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             }

modules/event_single/EED_Event_Single.module.php

Indentation +470 added lines, -470 removed lines

@@ -14,475 +14,475 @@ 
  */
 class EED_Event_Single extends EED_Module
 {
-    const EVENT_DETAILS_PRIORITY = 100;
-    const EVENT_DATETIMES_PRIORITY = 110;
-    const EVENT_TICKETS_PRIORITY = 120;
-    const EVENT_VENUES_PRIORITY = 130;
-
-    /**
-     * @type bool $using_get_the_excerpt
-     */
-    protected static $using_get_the_excerpt = false;
-
-
-    /**
-     * @type EE_Template_Part_Manager $template_parts
-     */
-    protected $template_parts;
-
-
-    /**
-     * @return EED_Module|EED_Event_Single
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        add_filter('FHEE_run_EE_wp', '__return_true');
-        add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $custom_post_types = $custom_post_type_definitions->getDefinitions();
-        EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::EVENTS ]['singular_slug'],
-            'Event_Single',
-            'run'
-        );
-    }
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
-    }
-
-
-    /**
-     * set_definitions
-     *
-     * @static
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-    }
-
-
-    /**
-     * set_config
-     *
-     * @void
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Event_Single_Config');
-        $this->set_config_name('EED_Event_Single');
-    }
-
-
-    /**
-     * initialize_template_parts
-     *
-     * @param EE_Config_Base|EE_Event_Single_Config $config
-     * @return EE_Template_Part_Manager
-     * @throws EE_Error
-     */
-    public function initialize_template_parts(EE_Event_Single_Config $config = null)
-    {
-        /** @type EE_Event_Single_Config $config */
-        $config = $config instanceof EE_Event_Single_Config ? $config : $this->config();
-        EEH_Autoloader::register_template_part_autoloaders();
-        $template_parts = new EE_Template_Part_Manager();
-        $template_parts->add_template_part(
-            'tickets',
-            esc_html__('Ticket Selector', 'event_espresso'),
-            'content-espresso_events-tickets.php',
-            $config->display_order_tickets
-        );
-        $template_parts->add_template_part(
-            'datetimes',
-            esc_html__('Dates and Times', 'event_espresso'),
-            'content-espresso_events-datetimes.php',
-            $config->display_order_datetimes
-        );
-        $template_parts->add_template_part(
-            'event',
-            esc_html__('Event Description', 'event_espresso'),
-            'content-espresso_events-details.php',
-            $config->display_order_event
-        );
-        $template_parts->add_template_part(
-            'venue',
-            esc_html__('Venue Information', 'event_espresso'),
-            'content-espresso_events-venues.php',
-            $config->display_order_venue
-        );
-        do_action('AHEE__EED_Event_Single__initialize_template_parts', $template_parts);
-        return $template_parts;
-    }
-
-
-    /**
-     * run - initial module setup
-     *
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-        // ensure valid EE_Events_Single_Config() object exists
-        $this->set_config();
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        // load css
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-    }
-
-
-    /**
-     * template_include
-     *
-     * @param    string $template
-     * @return    string
-     */
-    public function template_include($template)
-    {
-        global $post;
-        /** @type EE_Event_Single_Config $config */
-        $config = $this->config();
-        if ($config->display_status_banner_single) {
-            add_filter('the_title', array('EED_Event_Single', 'the_title'), 100, 2);
-        }
-        // not a custom template?
-        if (
-            ! post_password_required($post)
-            && (
-                apply_filters('FHEE__EED_Event_Single__template_include__allow_custom_selected_template', false)
-                || EE_Registry::instance()
-                              ->load_core('Front_Controller')
-                              ->get_selected_template() !== 'single-espresso_events.php'
-            )
-        ) {
-            EEH_Template::load_espresso_theme_functions();
-            // then add extra event data via hooks
-            add_action('loop_start', array('EED_Event_Single', 'loop_start'));
-            add_filter('get_the_excerpt', array('EED_Event_Single', 'get_the_excerpt'), 1, 1);
-            add_filter(
-                'the_content',
-                array('EED_Event_Single', 'event_details'),
-                EED_Event_Single::EVENT_DETAILS_PRIORITY
-            );
-            add_action('loop_end', array('EED_Event_Single', 'loop_end'));
-            // don't display entry meta because the existing theme will take car of that
-            add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
-        }
-        return $template;
-    }
-
-
-    /**
-     * loop_start
-     *
-     * @param    array $wp_query_array an array containing the WP_Query object
-     * @return    void
-     */
-    public static function loop_start($wp_query_array)
-    {
-        global $post;
-        do_action('AHEE_event_details_before_post', $post, $wp_query_array);
-    }
-
-
-    /**
-     * the_title
-     *
-     * @param    string $title
-     * @param    int    $id
-     * @return    string
-     */
-    public static function the_title($title = '', $id = 0)
-    {
-        global $post;
-        return ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || in_the_loop()) && $post->ID === (int) $id
-            ? espresso_event_status_banner($post->ID) . $title
-            : $title;
-    }
-
-
-    /**
-     * get_the_excerpt
-     * kinda hacky, but if a theme is using get_the_excerpt(),
-     * then we need to remove our filters on the_content()
-     *
-     * @param        string $excerpt
-     * @return        string
-     */
-    public static function get_the_excerpt($excerpt = '')
-    {
-        EED_Event_Single::$using_get_the_excerpt = true;
-        add_filter('wp_trim_excerpt', array('EED_Event_Single', 'end_get_the_excerpt'), 999, 1);
-        return $excerpt;
-    }
-
-
-    /**
-     * end_get_the_excerpt
-     *
-     * @param  string $text
-     * @return string
-     */
-    public static function end_get_the_excerpt($text = '')
-    {
-        EED_Event_Single::$using_get_the_excerpt = false;
-        return $text;
-    }
-
-
-    /**
-     * event_details
-     *
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_details($content)
-    {
-        global $post;
-        static $current_post_ID = 0;
-        if (
-            $current_post_ID !== $post->ID
-            && $post->post_type === EspressoPostType::EVENTS
-            && ! EED_Event_Single::$using_get_the_excerpt
-            && ! post_password_required()
-        ) {
-            // Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
-            // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
-            // BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
-            // We want to allow those plugins to still do their thing and have access to our content, but depending on
-            // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
-            // so the following allows this filter to be applied multiple times, but only once for real
-            $current_post_ID = did_action('loop_start') ? $post->ID : 0;
-            if (EE_Registry::instance()->CFG->template_settings->EED_Event_Single->use_sortable_display_order) {
-                // we need to first remove this callback from being applied to the_content()
-                // (otherwise it will recurse and blow up the interweb)
-                remove_filter(
-                    'the_content',
-                    array('EED_Event_Single', 'event_details'),
-                    EED_Event_Single::EVENT_DETAILS_PRIORITY
-                );
-                EED_Event_Single::instance()->template_parts = EED_Event_Single::instance()->initialize_template_parts(
-                );
-                $content = EEH_Template::locate_template('content-espresso_events-details.php');
-                $content = EED_Event_Single::instance()->template_parts->apply_template_part_filters($content);
-                add_filter(
-                    'the_content',
-                    array('EED_Event_Single', 'event_details'),
-                    EED_Event_Single::EVENT_DETAILS_PRIORITY
-                );
-            } else {
-                $content = EED_Event_Single::use_filterable_display_order();
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     * use_filterable_display_order
-     *
-     * @return string
-     */
-    protected static function use_filterable_display_order()
-    {
-        // since the 'content-espresso_events-details.php' template might be used directly from within a theme,
-        // it uses the_content() for displaying the $post->post_content
-        // so in order to load a template that uses the_content()
-        // from within a callback being used to filter the_content(),
-        // we need to first remove this callback from being applied to the_content()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_details'),
-            EED_Event_Single::EVENT_DETAILS_PRIORITY
-        );
-        // now add additional content
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_datetimes'),
-            EED_Event_Single::EVENT_DATETIMES_PRIORITY,
-            1
-        );
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_tickets'),
-            EED_Event_Single::EVENT_TICKETS_PRIORITY,
-            1
-        );
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_venues'),
-            EED_Event_Single::EVENT_VENUES_PRIORITY,
-            1
-        );
-        do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_add_filters');
-        // now load our template
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        // now add our filter back in, plus some others
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_details'),
-            EED_Event_Single::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_datetimes'),
-            EED_Event_Single::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_tickets'),
-            EED_Event_Single::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_venues'),
-            EED_Event_Single::EVENT_VENUES_PRIORITY
-        );
-        do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_remove_filters');
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        return $content;
-    }
-
-
-    /**
-     * event_datetimes - adds datetimes ABOVE content
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_datetimes($content)
-    {
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
-    }
-
-
-    /**
-     * event_tickets - adds tickets ABOVE content (which includes datetimes)
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_tickets($content)
-    {
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
-    }
-
-
-    /**
-     * event_venues
-     *
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_venue($content)
-    {
-        return EED_Event_Single::event_venues($content);
-    }
-
-
-    /**
-     * event_venues - adds venues BELOW content
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_venues($content)
-    {
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
-    }
-
-
-    /**
-     * loop_end
-     *
-     * @param        array $wp_query_array an array containing the WP_Query object
-     * @return        void
-     */
-    public static function loop_end($wp_query_array)
-    {
-        global $post;
-        do_action('AHEE_event_details_after_post', $post, $wp_query_array);
-    }
-
-
-    /**
-     * wp_enqueue_scripts
-     *
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (
-            apply_filters('FHEE_enable_default_espresso_css', true)
-            && apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
-        ) {
-            // first check uploads folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } else {
-                wp_register_style(
-                    $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            }
-            wp_enqueue_script($this->theme);
-            if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-                add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
-            }
-        }
-    }
-
-
-    /**
-     * display_venue
-     *
-     * @return    bool
-     */
-    public static function display_venue()
-    {
-        /** @type EE_Event_Single_Config $config */
-        $config = EED_Event_Single::instance()->config();
-        $display_venue = $config->display_venue === null ? true : $config->display_venue;
-        $venue_name = EEH_Venue_View::venue_name();
-        return $display_venue && ! empty($venue_name);
-    }
+	const EVENT_DETAILS_PRIORITY = 100;
+	const EVENT_DATETIMES_PRIORITY = 110;
+	const EVENT_TICKETS_PRIORITY = 120;
+	const EVENT_VENUES_PRIORITY = 130;
+
+	/**
+	 * @type bool $using_get_the_excerpt
+	 */
+	protected static $using_get_the_excerpt = false;
+
+
+	/**
+	 * @type EE_Template_Part_Manager $template_parts
+	 */
+	protected $template_parts;
+
+
+	/**
+	 * @return EED_Module|EED_Event_Single
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		add_filter('FHEE_run_EE_wp', '__return_true');
+		add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$custom_post_types = $custom_post_type_definitions->getDefinitions();
+		EED_Module::registerRoute(
+			$custom_post_types[ EspressoPostType::EVENTS ]['singular_slug'],
+			'Event_Single',
+			'run'
+		);
+	}
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
+	}
+
+
+	/**
+	 * set_definitions
+	 *
+	 * @static
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+	}
+
+
+	/**
+	 * set_config
+	 *
+	 * @void
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Event_Single_Config');
+		$this->set_config_name('EED_Event_Single');
+	}
+
+
+	/**
+	 * initialize_template_parts
+	 *
+	 * @param EE_Config_Base|EE_Event_Single_Config $config
+	 * @return EE_Template_Part_Manager
+	 * @throws EE_Error
+	 */
+	public function initialize_template_parts(EE_Event_Single_Config $config = null)
+	{
+		/** @type EE_Event_Single_Config $config */
+		$config = $config instanceof EE_Event_Single_Config ? $config : $this->config();
+		EEH_Autoloader::register_template_part_autoloaders();
+		$template_parts = new EE_Template_Part_Manager();
+		$template_parts->add_template_part(
+			'tickets',
+			esc_html__('Ticket Selector', 'event_espresso'),
+			'content-espresso_events-tickets.php',
+			$config->display_order_tickets
+		);
+		$template_parts->add_template_part(
+			'datetimes',
+			esc_html__('Dates and Times', 'event_espresso'),
+			'content-espresso_events-datetimes.php',
+			$config->display_order_datetimes
+		);
+		$template_parts->add_template_part(
+			'event',
+			esc_html__('Event Description', 'event_espresso'),
+			'content-espresso_events-details.php',
+			$config->display_order_event
+		);
+		$template_parts->add_template_part(
+			'venue',
+			esc_html__('Venue Information', 'event_espresso'),
+			'content-espresso_events-venues.php',
+			$config->display_order_venue
+		);
+		do_action('AHEE__EED_Event_Single__initialize_template_parts', $template_parts);
+		return $template_parts;
+	}
+
+
+	/**
+	 * run - initial module setup
+	 *
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+		// ensure valid EE_Events_Single_Config() object exists
+		$this->set_config();
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		// load css
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+	}
+
+
+	/**
+	 * template_include
+	 *
+	 * @param    string $template
+	 * @return    string
+	 */
+	public function template_include($template)
+	{
+		global $post;
+		/** @type EE_Event_Single_Config $config */
+		$config = $this->config();
+		if ($config->display_status_banner_single) {
+			add_filter('the_title', array('EED_Event_Single', 'the_title'), 100, 2);
+		}
+		// not a custom template?
+		if (
+			! post_password_required($post)
+			&& (
+				apply_filters('FHEE__EED_Event_Single__template_include__allow_custom_selected_template', false)
+				|| EE_Registry::instance()
+							  ->load_core('Front_Controller')
+							  ->get_selected_template() !== 'single-espresso_events.php'
+			)
+		) {
+			EEH_Template::load_espresso_theme_functions();
+			// then add extra event data via hooks
+			add_action('loop_start', array('EED_Event_Single', 'loop_start'));
+			add_filter('get_the_excerpt', array('EED_Event_Single', 'get_the_excerpt'), 1, 1);
+			add_filter(
+				'the_content',
+				array('EED_Event_Single', 'event_details'),
+				EED_Event_Single::EVENT_DETAILS_PRIORITY
+			);
+			add_action('loop_end', array('EED_Event_Single', 'loop_end'));
+			// don't display entry meta because the existing theme will take car of that
+			add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
+		}
+		return $template;
+	}
+
+
+	/**
+	 * loop_start
+	 *
+	 * @param    array $wp_query_array an array containing the WP_Query object
+	 * @return    void
+	 */
+	public static function loop_start($wp_query_array)
+	{
+		global $post;
+		do_action('AHEE_event_details_before_post', $post, $wp_query_array);
+	}
+
+
+	/**
+	 * the_title
+	 *
+	 * @param    string $title
+	 * @param    int    $id
+	 * @return    string
+	 */
+	public static function the_title($title = '', $id = 0)
+	{
+		global $post;
+		return ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || in_the_loop()) && $post->ID === (int) $id
+			? espresso_event_status_banner($post->ID) . $title
+			: $title;
+	}
+
+
+	/**
+	 * get_the_excerpt
+	 * kinda hacky, but if a theme is using get_the_excerpt(),
+	 * then we need to remove our filters on the_content()
+	 *
+	 * @param        string $excerpt
+	 * @return        string
+	 */
+	public static function get_the_excerpt($excerpt = '')
+	{
+		EED_Event_Single::$using_get_the_excerpt = true;
+		add_filter('wp_trim_excerpt', array('EED_Event_Single', 'end_get_the_excerpt'), 999, 1);
+		return $excerpt;
+	}
+
+
+	/**
+	 * end_get_the_excerpt
+	 *
+	 * @param  string $text
+	 * @return string
+	 */
+	public static function end_get_the_excerpt($text = '')
+	{
+		EED_Event_Single::$using_get_the_excerpt = false;
+		return $text;
+	}
+
+
+	/**
+	 * event_details
+	 *
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_details($content)
+	{
+		global $post;
+		static $current_post_ID = 0;
+		if (
+			$current_post_ID !== $post->ID
+			&& $post->post_type === EspressoPostType::EVENTS
+			&& ! EED_Event_Single::$using_get_the_excerpt
+			&& ! post_password_required()
+		) {
+			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
+			// Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
+			// BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
+			// We want to allow those plugins to still do their thing and have access to our content, but depending on
+			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
+			// so the following allows this filter to be applied multiple times, but only once for real
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Event_Single->use_sortable_display_order) {
+				// we need to first remove this callback from being applied to the_content()
+				// (otherwise it will recurse and blow up the interweb)
+				remove_filter(
+					'the_content',
+					array('EED_Event_Single', 'event_details'),
+					EED_Event_Single::EVENT_DETAILS_PRIORITY
+				);
+				EED_Event_Single::instance()->template_parts = EED_Event_Single::instance()->initialize_template_parts(
+				);
+				$content = EEH_Template::locate_template('content-espresso_events-details.php');
+				$content = EED_Event_Single::instance()->template_parts->apply_template_part_filters($content);
+				add_filter(
+					'the_content',
+					array('EED_Event_Single', 'event_details'),
+					EED_Event_Single::EVENT_DETAILS_PRIORITY
+				);
+			} else {
+				$content = EED_Event_Single::use_filterable_display_order();
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 * use_filterable_display_order
+	 *
+	 * @return string
+	 */
+	protected static function use_filterable_display_order()
+	{
+		// since the 'content-espresso_events-details.php' template might be used directly from within a theme,
+		// it uses the_content() for displaying the $post->post_content
+		// so in order to load a template that uses the_content()
+		// from within a callback being used to filter the_content(),
+		// we need to first remove this callback from being applied to the_content()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_details'),
+			EED_Event_Single::EVENT_DETAILS_PRIORITY
+		);
+		// now add additional content
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_datetimes'),
+			EED_Event_Single::EVENT_DATETIMES_PRIORITY,
+			1
+		);
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_tickets'),
+			EED_Event_Single::EVENT_TICKETS_PRIORITY,
+			1
+		);
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_venues'),
+			EED_Event_Single::EVENT_VENUES_PRIORITY,
+			1
+		);
+		do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_add_filters');
+		// now load our template
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		// now add our filter back in, plus some others
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_details'),
+			EED_Event_Single::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_datetimes'),
+			EED_Event_Single::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_tickets'),
+			EED_Event_Single::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_venues'),
+			EED_Event_Single::EVENT_VENUES_PRIORITY
+		);
+		do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_remove_filters');
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		return $content;
+	}
+
+
+	/**
+	 * event_datetimes - adds datetimes ABOVE content
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_datetimes($content)
+	{
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+	}
+
+
+	/**
+	 * event_tickets - adds tickets ABOVE content (which includes datetimes)
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_tickets($content)
+	{
+		return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+	}
+
+
+	/**
+	 * event_venues
+	 *
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_venue($content)
+	{
+		return EED_Event_Single::event_venues($content);
+	}
+
+
+	/**
+	 * event_venues - adds venues BELOW content
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_venues($content)
+	{
+		return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+	}
+
+
+	/**
+	 * loop_end
+	 *
+	 * @param        array $wp_query_array an array containing the WP_Query object
+	 * @return        void
+	 */
+	public static function loop_end($wp_query_array)
+	{
+		global $post;
+		do_action('AHEE_event_details_after_post', $post, $wp_query_array);
+	}
+
+
+	/**
+	 * wp_enqueue_scripts
+	 *
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (
+			apply_filters('FHEE_enable_default_espresso_css', true)
+			&& apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
+		) {
+			// first check uploads folder
+			if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			} else {
+				wp_register_style(
+					$this->theme,
+					EE_TEMPLATES_URL . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			}
+			wp_enqueue_script($this->theme);
+			if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+				add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
+			}
+		}
+	}
+
+
+	/**
+	 * display_venue
+	 *
+	 * @return    bool
+	 */
+	public static function display_venue()
+	{
+		/** @type EE_Event_Single_Config $config */
+		$config = EED_Event_Single::instance()->config();
+		$display_venue = $config->display_venue === null ? true : $config->display_venue;
+		$venue_name = EEH_Venue_View::venue_name();
+		return $display_venue && ! empty($venue_name);
+	}
 }
 
 
@@ -494,5 +494,5 @@ 
  */
 function espresso_display_venue_in_event_details()
 {
-    return EED_Event_Single::display_venue();
+	return EED_Event_Single::display_venue();
 }

Spacing +10 added lines, -10 removed lines

@@ -58,7 +58,7 @@ 
         );
         $custom_post_types = $custom_post_type_definitions->getDefinitions();
         EED_Module::registerRoute(
-            $custom_post_types[ EspressoPostType::EVENTS ]['singular_slug'],
+            $custom_post_types[EspressoPostType::EVENTS]['singular_slug'],
             'Event_Single',
             'run'
         );
@@ -83,8 +83,8 @@ 
      */
     public static function set_definitions()
     {
-        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
+        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__).'templates/');
     }
 
 
@@ -226,7 +226,7 @@ 
     {
         global $post;
         return ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || in_the_loop()) && $post->ID === (int) $id
-            ? espresso_event_status_banner($post->ID) . $title
+            ? espresso_event_status_banner($post->ID).$title
             : $title;
     }
 
@@ -383,7 +383,7 @@ 
      */
     public static function event_datetimes($content)
     {
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
     }
 
 
@@ -395,7 +395,7 @@ 
      */
     public static function event_tickets($content)
     {
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
     }
 
 
@@ -419,7 +419,7 @@ 
      */
     public static function event_venues($content)
     {
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+        return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
     }
 
 
@@ -449,16 +449,16 @@ 
             && apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
         ) {
             // first check uploads folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             } else {
                 wp_register_style(
                     $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
+                    EE_TEMPLATES_URL.$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             }

admin_pages/venues/Venues_Admin_Page.core.php

Indentation +1548 added lines, -1548 removed lines

@@ -14,1558 +14,1558 @@
  */
 class Venues_Admin_Page extends EE_Admin_Page_CPT
 {
-    /**
-     * primary key for the venue model
-     */
-    private int $VNU_ID = 0;
-
-    /**
-     * This will hold the venue object for venue_details screen.
-     *
-     * @var EE_Venue|EE_CPT_Base|null $_cpt_model_obj
-     */
-    protected $_cpt_model_obj;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass|null $_category
-     */
-    protected ?stdClass $_category = null;
-
-
-    /**
-     * This property will hold the venue model instance
-     *
-     * @var EEM_Venue|null $_venue_model
-     */
-    protected ?EEM_Venue $_venue_model = null;
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _init_page_props()
-    {
-        // is there a vnu_id in the request?
-        $this->VNU_ID = $this->request->getRequestParam('VNU_ID', 0, DataType::INT);
-        $this->VNU_ID = $this->request->getRequestParam('post', $this->VNU_ID, DataType::INT);
-        $this->VNU_ID = $this->request->getRequestParam('post_ID', $this->VNU_ID, DataType::INT);
-
-        $this->page_slug        = EE_VENUES_PG_SLUG;
-        $this->_admin_base_url  = EE_VENUES_ADMIN_URL;
-        $this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
-        $this->page_label       = esc_html__('Event Venues', 'event_espresso');
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Venue',
-            'edit'       => 'EEM_Venue',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_venues' => 'edit',
-        ];
-        $this->_venue_model     = EEM_Venue::instance();
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ee_venues ajax goes in here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Venue', 'event_espresso'),
-                'edit'            => esc_html__('Edit Venue', 'event_espresso'),
-                'delete'          => esc_html__('Delete Venue', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ],
-            'editor_title' => [
-                'espresso_venues' => esc_html__('Edit Venue', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'          => esc_html__('Save New Venue', 'event_espresso'),
-                'edit'                => esc_html__('Update Venue', 'event_espresso'),
-                'add_category'        => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'       => esc_html__('Update Category', 'event_espresso'),
-                'google_map_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    protected function _set_page_routes()
-    {
-        // load formatter helper
-        // load field generator helper
-
-
-        $this->_page_routes = [
-            'default'                    => [
-                'func'       => [$this, '_overview_list_table'],
-                'capability' => 'ee_read_venues',
-            ],
-            'create_new'                 => [
-                'func'       => [$this, '_create_new_cpt_item'],
-                'capability' => 'ee_edit_venues',
-            ],
-            'edit'                       => [
-                'func'       => [$this, '_edit_cpt_item'],
-                'capability' => 'ee_edit_venue',
-                'obj_id'     => $this->VNU_ID,
-            ],
-            'trash_venue'                => [
-                'func'       => [$this, '_trash_or_restore_venue'],
-                'args'       => ['venue_status' => 'trash'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $this->VNU_ID,
-            ],
-            'trash_venues'               => [
-                'func'       => [$this, '_trash_or_restore_venues'],
-                'args'       => ['venue_status' => 'trash'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'restore_venue'              => [
-                'func'       => [$this, '_trash_or_restore_venue'],
-                'args'       => ['venue_status' => 'draft'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $this->VNU_ID,
-            ],
-            'restore_venues'             => [
-                'func'       => [$this, '_trash_or_restore_venues'],
-                'args'       => ['venue_status' => 'draft'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'delete_venues'              => [
-                'func'       => [$this, '_delete_venues'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'delete_venue'               => [
-                'func'       => [$this, '_delete_venue'],
-                'args'       => ['redirect_after' => true],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $this->VNU_ID,
-            ],
-            // settings related
-            'google_map_settings'        => [
-                'func'       => [$this, '_google_map_settings'],
-                'capability' => 'manage_options',
-            ],
-            'update_google_map_settings' => [
-                'func'       => [$this, '_update_google_map_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            // venue category tab related
-            'add_category'               => [
-                'func'       => [$this, '_category_details'],
-                'args'       => ['add'],
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'edit_category'              => [
-                'func'       => [$this, '_category_details'],
-                'args'       => ['edit'],
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'delete_categories'          => [
-                'func'       => [$this, '_delete_categories'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ],
-
-            'delete_category' => [
-                'func'       => [$this, '_delete_categories'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ],
-
-            'insert_category' => [
-                'func'       => [$this, '_insert_or_update_category'],
-                'args'       => ['new_category' => true],
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ],
-
-            'update_category'   => [
-                'func'       => [$this, '_insert_or_update_category'],
-                'args'       => ['new_category' => false],
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'export_categories' => [
-                'func'       => [$this, '_categories_export'],
-                'noheader'   => true,
-                'capability' => 'export',
-            ],
-            'import_categories' => [
-                'func'       => [$this, '_import_categories'],
-                'capability' => 'import',
-            ],
-            'category_list'     => [
-                'func'       => [$this, '_category_list_table'],
-                'capability' => 'ee_manage_venue_categories',
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $EVT_CAT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        $help_tabs  = [
-            'venues_editor_help_tab'                                               => [
-                'title'    => esc_html__('Venue Editor', 'event_espresso'),
-                'filename' => 'venues_editor',
-            ],
-            'venues_editor_title_richtexteditor_help_tab'                          => [
-                'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
-                'filename' => 'venues_editor_title_richtexteditor',
-            ],
-            'venues_editor_tags_categories_help_tab'                               => [
-                'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
-                'filename' => 'venues_editor_tags_categories',
-            ],
-            'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
-                'title'    => esc_html__(
-                    'Venue Editor Physical Location & Google Map & Virtual Location',
-                    'event_espresso'
-                ),
-                'filename' => 'venues_editor_physical_location_google_map_virtual_location',
-            ],
-            'venues_editor_save_new_venue_help_tab'                                => [
-                'title'    => esc_html__('Save New Venue', 'event_espresso'),
-                'filename' => 'venues_editor_save_new_venue',
-            ],
-            'venues_editor_other_help_tab'                                         => [
-                'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
-                'filename' => 'venues_editor_other',
-            ],
-        ];
-
-        $this->_page_config = [
-            'default'             => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'icon'  => 'dashicons-list-view',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Venues_Admin_List_Table',
-                'help_tabs'     => [
-                    'venues_overview_help_tab'                           => [
-                        'title'    => esc_html__('Venues Overview', 'event_espresso'),
-                        'filename' => 'venues_overview',
-                    ],
-                    'venues_overview_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Venues Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_overview_table_column_headings',
-                    ],
-                    'venues_overview_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'venues_overview_views_bulk_actions_search',
-                    ],
-                ],
-                'metaboxes'     => ['_espresso_news_post_box', '_espresso_links_post_box'],
-                'require_nonce' => false,
-            ],
-            'create_new'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Venue', 'event_espresso'),
-                    'icon'       => 'dashicons-plus-alt',
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => $help_tabs,
-                'metaboxes'     => ['_venue_editor_metaboxes'],
-                'require_nonce' => false,
-            ],
-            'edit'                => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Venue', 'event_espresso'),
-                    'icon'       => 'dashicons-edit-large',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => $this->VNU_ID
-                        ? add_query_arg(['post' => $this->VNU_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => $help_tabs,
-                'metaboxes'     => ['_venue_editor_metaboxes'],
-                'require_nonce' => false,
-            ],
-            'google_map_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Google Maps', 'event_espresso'),
-                    'icon'  => 'dashicons-location-alt',
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'general_settings_google_maps_help_tab' => [
-                        'title'    => esc_html__('Google Maps', 'event_espresso'),
-                        'filename' => 'general_settings_google_maps',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // venue category stuff
-            'add_category'        => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'icon'       => 'dashicons-plus-alt',
-                    'order'      => 25,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'help_tabs'     => [
-                    'venues_add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Venue Category', 'event_espresso'),
-                        'filename' => 'venues_add_category',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'edit_category'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'icon'       => 'dashicons-edit-large',
-                    'order'      => 25,
-                    'persistent' => false,
-                    'url'        => $EVT_CAT_ID
-                        ? add_query_arg(['EVT_CAT_ID' => $EVT_CAT_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'help_tabs'     => [
-                    'venues_edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Venue Category', 'event_espresso'),
-                        'filename' => 'venues_edit_category',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'category_list'       => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'icon'  => 'dashicons-networking',
-                    'order' => 20,
-                ],
-                'list_table'    => 'Venue_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'venues_categories_help_tab'                       => [
-                        'title'    => esc_html__('Venue Categories', 'event_espresso'),
-                        'filename' => 'venues_categories',
-                    ],
-                    'venues_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Venue Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_categories_table_column_headings',
-                    ],
-                    'venues_categories_views_help_tab'                 => [
-                        'title'    => esc_html__('Venue Categories Views', 'event_espresso'),
-                        'filename' => 'venues_categories_views',
-                    ],
-                    'venues_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Venue Categories Other', 'event_espresso'),
-                        'filename' => 'venues_categories_other',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_category_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Venue Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Venues
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('ee-cat-admin');
-    }
-
-
-    public function load_scripts_styles_add_category()
-    {
-        $this->load_scripts_styles_edit_category();
-    }
-
-
-    public function load_scripts_styles_edit_category()
-    {
-        wp_enqueue_style('editor-buttons');
-    }
-
-
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_venues',
-            EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_venues');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Venues', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [],
-            ],
-        ];
-
-        if ($this->capabilities->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
-            $this->_views['all']['bulk_action'] = [
-                'trash_venues' => esc_html__('Move to Trash', 'event_espresso'),
-            ];
-            $this->_views['trash']              = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_venues' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_venues'  => esc_html__('Delete', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
-            get_post_type_archive_link(EspressoPostType::VENUES),
-            esc_html__("View Venue Archive Page", "event_espresso"),
-            'button'
-        );
-
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'create_new',
-            'add',
-            [],
-            'add-new-h2'
-        );
-
-        $this->_search_btn_label = esc_html__('Venues', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $extra_rows = [
-            'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
-            'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
-            'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
-        ];
-        $template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
-        EEH_Template::display_template($template, $extra_rows);
-    }
-
-
-    /*************        Google Maps        *************
+	/**
+	 * primary key for the venue model
+	 */
+	private int $VNU_ID = 0;
+
+	/**
+	 * This will hold the venue object for venue_details screen.
+	 *
+	 * @var EE_Venue|EE_CPT_Base|null $_cpt_model_obj
+	 */
+	protected $_cpt_model_obj;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass|null $_category
+	 */
+	protected ?stdClass $_category = null;
+
+
+	/**
+	 * This property will hold the venue model instance
+	 *
+	 * @var EEM_Venue|null $_venue_model
+	 */
+	protected ?EEM_Venue $_venue_model = null;
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _init_page_props()
+	{
+		// is there a vnu_id in the request?
+		$this->VNU_ID = $this->request->getRequestParam('VNU_ID', 0, DataType::INT);
+		$this->VNU_ID = $this->request->getRequestParam('post', $this->VNU_ID, DataType::INT);
+		$this->VNU_ID = $this->request->getRequestParam('post_ID', $this->VNU_ID, DataType::INT);
+
+		$this->page_slug        = EE_VENUES_PG_SLUG;
+		$this->_admin_base_url  = EE_VENUES_ADMIN_URL;
+		$this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
+		$this->page_label       = esc_html__('Event Venues', 'event_espresso');
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Venue',
+			'edit'       => 'EEM_Venue',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_venues' => 'edit',
+		];
+		$this->_venue_model     = EEM_Venue::instance();
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ee_venues ajax goes in here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Venue', 'event_espresso'),
+				'edit'            => esc_html__('Edit Venue', 'event_espresso'),
+				'delete'          => esc_html__('Delete Venue', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			],
+			'editor_title' => [
+				'espresso_venues' => esc_html__('Edit Venue', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'          => esc_html__('Save New Venue', 'event_espresso'),
+				'edit'                => esc_html__('Update Venue', 'event_espresso'),
+				'add_category'        => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'       => esc_html__('Update Category', 'event_espresso'),
+				'google_map_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	protected function _set_page_routes()
+	{
+		// load formatter helper
+		// load field generator helper
+
+
+		$this->_page_routes = [
+			'default'                    => [
+				'func'       => [$this, '_overview_list_table'],
+				'capability' => 'ee_read_venues',
+			],
+			'create_new'                 => [
+				'func'       => [$this, '_create_new_cpt_item'],
+				'capability' => 'ee_edit_venues',
+			],
+			'edit'                       => [
+				'func'       => [$this, '_edit_cpt_item'],
+				'capability' => 'ee_edit_venue',
+				'obj_id'     => $this->VNU_ID,
+			],
+			'trash_venue'                => [
+				'func'       => [$this, '_trash_or_restore_venue'],
+				'args'       => ['venue_status' => 'trash'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $this->VNU_ID,
+			],
+			'trash_venues'               => [
+				'func'       => [$this, '_trash_or_restore_venues'],
+				'args'       => ['venue_status' => 'trash'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'restore_venue'              => [
+				'func'       => [$this, '_trash_or_restore_venue'],
+				'args'       => ['venue_status' => 'draft'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $this->VNU_ID,
+			],
+			'restore_venues'             => [
+				'func'       => [$this, '_trash_or_restore_venues'],
+				'args'       => ['venue_status' => 'draft'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'delete_venues'              => [
+				'func'       => [$this, '_delete_venues'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'delete_venue'               => [
+				'func'       => [$this, '_delete_venue'],
+				'args'       => ['redirect_after' => true],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $this->VNU_ID,
+			],
+			// settings related
+			'google_map_settings'        => [
+				'func'       => [$this, '_google_map_settings'],
+				'capability' => 'manage_options',
+			],
+			'update_google_map_settings' => [
+				'func'       => [$this, '_update_google_map_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			// venue category tab related
+			'add_category'               => [
+				'func'       => [$this, '_category_details'],
+				'args'       => ['add'],
+				'capability' => 'ee_edit_venue_category',
+			],
+			'edit_category'              => [
+				'func'       => [$this, '_category_details'],
+				'args'       => ['edit'],
+				'capability' => 'ee_edit_venue_category',
+			],
+			'delete_categories'          => [
+				'func'       => [$this, '_delete_categories'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			],
+
+			'delete_category' => [
+				'func'       => [$this, '_delete_categories'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			],
+
+			'insert_category' => [
+				'func'       => [$this, '_insert_or_update_category'],
+				'args'       => ['new_category' => true],
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			],
+
+			'update_category'   => [
+				'func'       => [$this, '_insert_or_update_category'],
+				'args'       => ['new_category' => false],
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			],
+			'export_categories' => [
+				'func'       => [$this, '_categories_export'],
+				'noheader'   => true,
+				'capability' => 'export',
+			],
+			'import_categories' => [
+				'func'       => [$this, '_import_categories'],
+				'capability' => 'import',
+			],
+			'category_list'     => [
+				'func'       => [$this, '_category_list_table'],
+				'capability' => 'ee_manage_venue_categories',
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$EVT_CAT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		$help_tabs  = [
+			'venues_editor_help_tab'                                               => [
+				'title'    => esc_html__('Venue Editor', 'event_espresso'),
+				'filename' => 'venues_editor',
+			],
+			'venues_editor_title_richtexteditor_help_tab'                          => [
+				'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
+				'filename' => 'venues_editor_title_richtexteditor',
+			],
+			'venues_editor_tags_categories_help_tab'                               => [
+				'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
+				'filename' => 'venues_editor_tags_categories',
+			],
+			'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
+				'title'    => esc_html__(
+					'Venue Editor Physical Location & Google Map & Virtual Location',
+					'event_espresso'
+				),
+				'filename' => 'venues_editor_physical_location_google_map_virtual_location',
+			],
+			'venues_editor_save_new_venue_help_tab'                                => [
+				'title'    => esc_html__('Save New Venue', 'event_espresso'),
+				'filename' => 'venues_editor_save_new_venue',
+			],
+			'venues_editor_other_help_tab'                                         => [
+				'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
+				'filename' => 'venues_editor_other',
+			],
+		];
+
+		$this->_page_config = [
+			'default'             => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'icon'  => 'dashicons-list-view',
+					'order' => 10,
+				],
+				'list_table'    => 'Venues_Admin_List_Table',
+				'help_tabs'     => [
+					'venues_overview_help_tab'                           => [
+						'title'    => esc_html__('Venues Overview', 'event_espresso'),
+						'filename' => 'venues_overview',
+					],
+					'venues_overview_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Venues Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_overview_table_column_headings',
+					],
+					'venues_overview_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'venues_overview_views_bulk_actions_search',
+					],
+				],
+				'metaboxes'     => ['_espresso_news_post_box', '_espresso_links_post_box'],
+				'require_nonce' => false,
+			],
+			'create_new'          => [
+				'nav'           => [
+					'label'      => esc_html__('Add Venue', 'event_espresso'),
+					'icon'       => 'dashicons-plus-alt',
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'help_tabs'     => $help_tabs,
+				'metaboxes'     => ['_venue_editor_metaboxes'],
+				'require_nonce' => false,
+			],
+			'edit'                => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Venue', 'event_espresso'),
+					'icon'       => 'dashicons-edit-large',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => $this->VNU_ID
+						? add_query_arg(['post' => $this->VNU_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => $help_tabs,
+				'metaboxes'     => ['_venue_editor_metaboxes'],
+				'require_nonce' => false,
+			],
+			'google_map_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Google Maps', 'event_espresso'),
+					'icon'  => 'dashicons-location-alt',
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'general_settings_google_maps_help_tab' => [
+						'title'    => esc_html__('Google Maps', 'event_espresso'),
+						'filename' => 'general_settings_google_maps',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// venue category stuff
+			'add_category'        => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'icon'       => 'dashicons-plus-alt',
+					'order'      => 25,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'help_tabs'     => [
+					'venues_add_category_help_tab' => [
+						'title'    => esc_html__('Add New Venue Category', 'event_espresso'),
+						'filename' => 'venues_add_category',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'edit_category'       => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'icon'       => 'dashicons-edit-large',
+					'order'      => 25,
+					'persistent' => false,
+					'url'        => $EVT_CAT_ID
+						? add_query_arg(['EVT_CAT_ID' => $EVT_CAT_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'help_tabs'     => [
+					'venues_edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Venue Category', 'event_espresso'),
+						'filename' => 'venues_edit_category',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'category_list'       => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'icon'  => 'dashicons-networking',
+					'order' => 20,
+				],
+				'list_table'    => 'Venue_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'venues_categories_help_tab'                       => [
+						'title'    => esc_html__('Venue Categories', 'event_espresso'),
+						'filename' => 'venues_categories',
+					],
+					'venues_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Venue Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_categories_table_column_headings',
+					],
+					'venues_categories_views_help_tab'                 => [
+						'title'    => esc_html__('Venue Categories Views', 'event_espresso'),
+						'filename' => 'venues_categories_views',
+					],
+					'venues_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Venue Categories Other', 'event_espresso'),
+						'filename' => 'venues_categories_other',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_category_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Venue Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Venues
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('ee-cat-admin');
+	}
+
+
+	public function load_scripts_styles_add_category()
+	{
+		$this->load_scripts_styles_edit_category();
+	}
+
+
+	public function load_scripts_styles_edit_category()
+	{
+		wp_enqueue_style('editor-buttons');
+	}
+
+
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_venues',
+			EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_venues');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Venues', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [],
+			],
+		];
+
+		if ($this->capabilities->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
+			$this->_views['all']['bulk_action'] = [
+				'trash_venues' => esc_html__('Move to Trash', 'event_espresso'),
+			];
+			$this->_views['trash']              = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_venues' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_venues'  => esc_html__('Delete', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
+			get_post_type_archive_link(EspressoPostType::VENUES),
+			esc_html__("View Venue Archive Page", "event_espresso"),
+			'button'
+		);
+
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'create_new',
+			'add',
+			[],
+			'add-new-h2'
+		);
+
+		$this->_search_btn_label = esc_html__('Venues', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$extra_rows = [
+			'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
+			'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
+			'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
+		];
+		$template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
+		EEH_Template::display_template($template, $extra_rows);
+	}
+
+
+	/*************        Google Maps        *************
      *
      * @throws EE_Error
      * @throws EE_Error
      */
 
 
-    protected function _google_map_settings()
-    {
-        $this->_template_args['values']           = $this->_yes_no_values;
-        $default_map_settings                     = new stdClass();
-        $default_map_settings->use_google_maps    = true;
-        $default_map_settings->google_map_api_key = '';
-        // for event details pages (reg page)
-        $default_map_settings->event_details_map_width = 585;
-        // ee_map_width_single
-        $default_map_settings->event_details_map_height = 362;
-        // ee_map_height_single
-        $default_map_settings->event_details_map_zoom = 14;
-        // ee_map_zoom_single
-        $default_map_settings->event_details_display_nav = true;
-        // ee_map_nav_display_single
-        $default_map_settings->event_details_nav_size = false;
-        // ee_map_nav_size_single
-        $default_map_settings->event_details_control_type = 'default';
-        // ee_map_type_control_single
-        $default_map_settings->event_details_map_align = 'center';
-        // ee_map_align_single
-
-        // for event list pages
-        $default_map_settings->event_list_map_width = 300;
-        // ee_map_width
-        $default_map_settings->event_list_map_height = 185;
-        // ee_map_height
-        $default_map_settings->event_list_map_zoom = 12;
-        // ee_map_zoom
-        $default_map_settings->event_list_display_nav = false;
-        // ee_map_nav_display
-        $default_map_settings->event_list_nav_size = true;
-        // ee_map_nav_size
-        $default_map_settings->event_list_control_type = 'dropdown';
-        // ee_map_type_control
-        $default_map_settings->event_list_map_align = 'center';
-        // ee_map_align
-
-        $this->_template_args['map_settings'] =
-            isset(EE_Registry::instance()->CFG->map_settings)
-            && ! empty(EE_Registry::instance()->CFG->map_settings)
-                ? (object) array_merge(
-                    (array) $default_map_settings,
-                    (array) EE_Registry::instance()->CFG->map_settings
-                )
-                : $default_map_settings;
-
-        $this->_set_add_edit_form_tags('update_google_map_settings');
-        $this->_set_publish_post_box_vars();
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _update_google_map_settings()
-    {
-        $map_settings = EE_Registry::instance()->CFG->map_settings;
-
-        $settings = [
-            'use_google_maps'            => 'int',
-            'google_map_api_key'         => 'string',
-            'event_details_map_width'    => 'int',
-            'event_details_map_zoom'     => 'int',
-            'event_details_display_nav'  => 'int',
-            'event_details_nav_size'     => 'int',
-            'event_details_control_type' => 'string',
-            'event_details_map_align'    => 'string',
-            'event_list_map_width'       => 'int',
-            'event_list_map_height'      => 'int',
-            'event_list_map_zoom'        => 'int',
-            'event_list_display_nav'     => 'int',
-            'event_list_nav_size'        => 'int',
-            'event_list_control_type'    => 'string',
-            'event_list_map_align'       => 'string',
-        ];
-
-        foreach ($settings as $setting => $type) {
-            $map_settings->{$setting} = $this->request->getRequestParam($setting, $map_settings->{$setting}, $type);
-        }
-
-        EE_Registry::instance()->CFG->map_settings = apply_filters(
-            'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
-            $map_settings
-        );
-
-        $what    = 'Google Map Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->map_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action($success, $what, 'updated', ['action' => 'google_map_settings']);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _venue_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-
-        $this->addMetaBox(
-            'espresso_venue_address_options',
-            esc_html__('Physical Location', 'event_espresso'),
-            [$this, 'venue_address_metabox'],
-            $this->page_slug,
-            'side',
-            'core'
-        );
-        $this->addMetaBox(
-            'espresso_venue_gmap_options',
-            esc_html__('Google Map', 'event_espresso'),
-            [$this, 'venue_gmap_metabox'],
-            $this->page_slug,
-            'side'
-        );
-        $this->addMetaBox(
-            'espresso_venue_virtual_loc_options',
-            esc_html__('Virtual Location', 'event_espresso'),
-            [$this, 'venue_virtual_loc_metabox'],
-            $this->page_slug,
-            'side'
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_gmap_metabox()
-    {
-        $template_args = [
-            'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
-                'vnu_enable_for_gmap',
-                $this->get_yes_no_values(),
-                $this->_cpt_model_obj instanceof EE_Venue && $this->_cpt_model_obj->enable_for_gmap()
-            ),
-            'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
-        ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_address_metabox()
-    {
-        $template_args['_venue'] = $this->_cpt_model_obj;
-
-        $template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    ['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
-                            ? $this->_cpt_model_obj->state_ID()
-                            : 0,
-                    ]
-                ),
-                [
-                    'input_name'     => 'sta_id',
-                    'input_id'       => 'sta_id',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-        $template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    ['QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country']
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
-                            ? $this->_cpt_model_obj->country_ID()
-                            : 0,
-                    ]
-                ),
-                [
-                    'input_name'     => 'cnt_iso',
-                    'input_id'       => 'cnt_iso',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function venue_virtual_loc_metabox()
-    {
-        $template_args = [
-            '_venue' => $this->_cpt_model_obj,
-        ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        $this->_cpt_model_obj = $this->_venue_model->get_one_by_ID($post_id);
-        // meta revision restore
-        $this->_cpt_model_obj->restore_revision($revision_id);
-    }
-
-
-    /**
-     * Handles updates for venue cpts
-     *
-     * @param int     $post_id ID of Venue CPT
-     * @param WP_Post $post    Post object (with "blessed" WP properties)
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
-            return;// get out we're not processing the saving of venues.
-        }
-
-        $wheres = [$this->_venue_model->primary_key_name() => $post_id];
-
-        $venue_values = [
-            'VNU_address'         => $this->request->getRequestParam('vnu_address'),
-            'VNU_address2'        => $this->request->getRequestParam('vnu_address2'),
-            'VNU_city'            => $this->request->getRequestParam('vnu_city'),
-            'STA_ID'              => $this->request->getRequestParam('sta_id'),
-            'CNT_ISO'             => $this->request->getRequestParam('cnt_iso'),
-            'VNU_zip'             => $this->request->getRequestParam('vnu_zip'),
-            'VNU_phone'           => $this->request->getRequestParam('vnu_phone'),
-            'VNU_capacity'        => $this->request->requestParamIsSet('vnu_capacity')
-                ? str_replace(',', '', $this->request->getRequestParam('vnu_capacity'))
-                : EE_INF,
-            'VNU_url'             => $this->request->getRequestParam('vnu_url'),
-            'VNU_virtual_phone'   => $this->request->getRequestParam('vnu_virtual_phone'),
-            'VNU_virtual_url'     => $this->request->getRequestParam('vnu_virtual_url'),
-            'VNU_enable_for_gmap' => $this->request->getRequestParam('vnu_enable_for_gmap', false, 'bool'),
-            'VNU_google_map_link' => $this->request->getRequestParam('vnu_google_map_link'),
-        ];
-
-        // update venue
-        $success = $this->_venue_model->update($venue_values, [$wheres]);
-
-        // get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_model->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
-        $get_one_where = [$this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status];
-        $venue         = $this->_venue_model->get_one([$get_one_where]);
-
-        // notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
-        $venue_update_callbacks = apply_filters(
-            'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
-            []
-        );
-        $att_success            = true;
-        foreach ($venue_update_callbacks as $v_callback) {
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
-                ? $att_success
-                : false;
-        }
-
-        // any errors?
-        if ($success && ! $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Venue Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Venue Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_trash_or_restore_venue('trash', false);
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_trash_or_restore_venue('draft', false);
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_delete_venue(false);
-    }
-
-
-    public function get_venue_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-    /**
-     * @param string    $venue_status
-     * @param bool|null $redirect_after
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_venue(string $venue_status = 'trash', ?bool $redirect_after = true)
-    {
-        // loop thru venues
-        if ($this->VNU_ID) {
-            // clean status
-            $venue_status = sanitize_key($venue_status);
-            // grab status
-            if (! empty($venue_status)) {
-                $success = $this->_change_venue_status($this->VNU_ID, $venue_status);
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The venue could not be moved to the trash because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @param string $venue_status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_venues(string $venue_status = 'trash')
-    {
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! empty($venue_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
-            // loop thru events
-            foreach ($VNU_IDs as $VNU_ID) {
-                if ($VNU_ID = absint($VNU_ID)) {
-                    $results = $this->_change_venue_status($VNU_ID, $venue_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $VNU_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action  = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Venues', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * _trash_or_restore_venues
-     * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
-     * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
-     * accepting a certain number of params.
-     *
-     * @param int|null $VNU_ID
-     * @param string   $venue_status
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _change_venue_status(?int $VNU_ID = 0, string $venue_status = ''): bool
-    {
-        // grab venue id
-        if (! $VNU_ID) {
-            $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        $this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! $venue_status) {
-            $msg = esc_html__(
-                'An error occurred. No Venue Status or an invalid Venue Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // was event trashed or restored ?
-        switch ($venue_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook   = 'AHEE_venue_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook   = 'AHEE_venue_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook   = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($venue_status);
-        $success = $this->_cpt_model_obj->save();
-
-        if ($success === false) {
-            $msg = sprintf(esc_html__('An error occurred. The venue could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param bool $redirect_after
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_venue(bool $redirect_after = true)
-    {
-        // loop thru venues
-        if ($this->VNU_ID) {
-            $success = $this->_delete_or_trash_venue($this->VNU_ID);
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', 'deleted', ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_venues()
-    {
-        $success = true;
-        // determine the event id and set to array.
-        $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
-        // loop thru events
-        foreach ($VNU_IDs as $VNU_ID) {
-            if ($VNU_ID = absint($VNU_ID)) {
-                $results = $this->_delete_or_trash_venue($VNU_ID);
-                $success = $results !== false ? $success : false;
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Venues', 'event_espresso'),
-            esc_html__('deleted', 'event_espresso'),
-            ['action' => 'default']
-        );
-    }
-
-
-    // todo: put in parent
-
-
-    /**
-     * @param int|null $VNU_ID
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _delete_or_trash_venue(?int $VNU_ID = 0): bool
-    {
-        // grab event id
-        if (! $VNU_ID = absint($VNU_ID)) {
-            $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-        // first need to remove all term relationships
-        $venue->_remove_relations('Term_Taxonomy');
-        $success = $venue->delete_permanently();
-        // did it all go as planned ?
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
-                    $VNU_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        EE_Error::add_success(
-            sprintf(esc_html__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID)
-        );
-        do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
-        return true;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_venues($per_page = 10, $count = false)
-    {
-        $orderby = $this->request->getRequestParam('orderby', '');
-
-        switch ($orderby) {
-            case 'id':
-                $orderby = 'VNU_ID';
-                break;
-
-            case 'capacity':
-                $orderby = 'VNU_capacity';
-                break;
-
-            case 'city':
-                $orderby = 'VNU_city';
-                break;
-
-            default:
-                $orderby = 'VNU_name';
-        }
-
-        $sort         = $this->request->getRequestParam('order', 'ASC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = ! empty($per_page) ? $per_page : 10;
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $category = $this->request->getRequestParam('category');
-        $category = $category > 0 ? $category : null;
-
-        $where = [];
-
-        // only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
-        $status = $this->request->getRequestParam('status');
-        if ($status && $status !== 'all') {
-            $where['status'] = $status;
-        }
-
-        $venue_status = $this->request->getRequestParam('venue_status');
-        if ($venue_status) {
-            $where['status'] = $venue_status;
-        }
-
-
-        if ($category) {
-            $where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
-            $where['Term_Taxonomy.term_id']  = $category;
-        }
-
-
-        if (! $this->capabilities->current_user_can('ee_read_others_venues', 'get_venues')) {
-            $where['VNU_wp_user'] = get_current_user_id();
-        } else {
-            if (! $this->capabilities->current_user_can('ee_read_private_venues', 'get_venues')) {
-                $where['OR'] = [
-                    'status*restrict_private' => ['!=', 'private'],
-                    'AND'                     => [
-                        'status*inclusive' => ['=', 'private'],
-                        'VNU_wp_user'      => get_current_user_id(),
-                    ],
-                ];
-            }
-        }
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'VNU_name'               => ['LIKE', $search_term],
-                'VNU_desc'               => ['LIKE', $search_term],
-                'VNU_short_desc'         => ['LIKE', $search_term],
-                'VNU_address'            => ['LIKE', $search_term],
-                'VNU_address2'           => ['LIKE', $search_term],
-                'VNU_city'               => ['LIKE', $search_term],
-                'VNU_zip'                => ['LIKE', $search_term],
-                'VNU_phone'              => ['LIKE', $search_term],
-                'VNU_url'                => ['LIKE', $search_term],
-                'VNU_virtual_phone'      => ['LIKE', $search_term],
-                'VNU_virtual_url'        => ['LIKE', $search_term],
-                'VNU_google_map_link'    => ['LIKE', $search_term],
-                'Event.EVT_name'         => ['LIKE', $search_term],
-                'Event.EVT_desc'         => ['LIKE', $search_term],
-                'Event.EVT_phone'        => ['LIKE', $search_term],
-                'Event.EVT_external_URL' => ['LIKE', $search_term],
-            ];
-        }
-
-
-        return $count
-            ? $this->_venue_model->count([$where], 'VNU_ID')
-            : $this->_venue_model->get_all(
-                [$where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort]
-            );
-    }
-
-
-
-
-    /** Venue Category Stuff **/
-
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } // already have the category object so get out.
-
-        // set default category object
-        $this->_set_empty_category_object();
-
-        // only set if we've got an id
-        $category_ID = $this->request->getRequestParam('VEN_CAT_ID', 0, 'int');
-        if (! $category_ID) {
-            return;
-        }
-
-        $term = get_term($category_ID, 'espresso_venue_categories');
-
-
-        if (! empty($term)) {
-            $this->_category->category_name       = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc       = $term->description;
-            $this->_category->id                  = $term->term_id;
-            $this->_category->parent              = $term->parent;
-        }
-    }
-
-
-    private function _set_empty_category_object()
-    {
-        $this->_category                = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id            = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            [],
-            'add-new-h2'
-        );
-        $this->_search_btn_label = esc_html__('Venue Categories', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_details($view)
-    {
-        // load formatter helper
-        // load field generator helper
-
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-
-        $this->_set_category_object();
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
-
-        $delete_action = 'delete_category';
-
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(['action' => 'category_list'], $this->_admin_base_url);
-
-        $this->_set_publish_post_box_vars('VEN_CAT_ID', $id, $delete_action, $redirect);
-
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _category_details_content(): string
-    {
-        $editor_args['category_desc'] = [
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => ['media_buttons' => false],
-        ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
-
-        $all_terms = get_terms(
-            ['espresso_venue_categories'],
-            ['hide_empty' => 0, 'exclude' => [$this->_category->id]]
-        );
-
-        // setup category select for term parents.
-        $category_select_values[] = [
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        ];
-        foreach ($all_terms as $term) {
-            $category_select_values[] = [
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            ];
-        }
-
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args   = [
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _delete_categories()
-    {
-        $category_ID  = $this->request->getRequestParam('category_id', 0, 'int');
-        $category_IDs = $this->request->getRequestParam('VEN_CAT_ID', [$category_ID], 'int', true);
-
-        foreach ($category_IDs as $cat_id) {
-            $this->_delete_category($cat_id);
-        }
-
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = [
-            'action' => 'category_list',
-        ];
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, 'espresso_venue_categories');
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = [
-                'action'     => 'edit_category',
-                'VEN_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    private function _insert_category($update = false)
-    {
-        $category_ID     = $update ? $this->request->getRequestParam('VEN_CAT_ID', '', 'int') : '';
-        $category_name   = $this->request->getRequestParam('category_name', '');
-        $category_desc   = $this->request->getRequestParam('category_desc', '', 'html');
-        $category_parent = $this->request->getRequestParam('category_parent', 0, 'int');
-
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $term_args = [
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        ];
-
-        $insert_ids = $update
-            ? wp_update_term($category_ID, 'espresso_venue_categories', $term_args)
-            : wp_insert_term(
-                $category_name,
-                'espresso_venue_categories',
-                $term_args
-            );
-
-        if (! is_array($insert_ids)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            $category_ID = $insert_ids['term_id'];
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__('The category %s was successfully created', 'event_espresso'),
-                    $category_name
-                )
-            );
-        }
-
-        return $category_ID;
-    }
-
-
-    /**
-     * TODO handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $this->request->mergeRequestParams(
-            [
-                'export'       => 'report',
-                'action'       => 'categories',
-                'category_ids' => $this->request->getRequestParam('VEN_CAT_ID', 0, 'int'),
-            ]
-        );
-
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->request->requestParams());
-            $EE_Export->export();
-        }
-    }
-
-
-    protected function _import_categories()
-    {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        EE_Import::instance()->import();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        // testing term stuff
-        $orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $limit       = ($current_page - 1) * $per_page;
-        $where       = ['taxonomy' => 'espresso_venue_categories'];
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'Term.name'   => ['LIKE', $search_term],
-                'description' => ['LIKE', $search_term],
-            ];
-        }
-
-        $query_params = [
-            $where,
-            'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => ['Term'],
-        ];
-
-        return $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-    }
-
-
-    /* end category stuff */
-    /**************/
+	protected function _google_map_settings()
+	{
+		$this->_template_args['values']           = $this->_yes_no_values;
+		$default_map_settings                     = new stdClass();
+		$default_map_settings->use_google_maps    = true;
+		$default_map_settings->google_map_api_key = '';
+		// for event details pages (reg page)
+		$default_map_settings->event_details_map_width = 585;
+		// ee_map_width_single
+		$default_map_settings->event_details_map_height = 362;
+		// ee_map_height_single
+		$default_map_settings->event_details_map_zoom = 14;
+		// ee_map_zoom_single
+		$default_map_settings->event_details_display_nav = true;
+		// ee_map_nav_display_single
+		$default_map_settings->event_details_nav_size = false;
+		// ee_map_nav_size_single
+		$default_map_settings->event_details_control_type = 'default';
+		// ee_map_type_control_single
+		$default_map_settings->event_details_map_align = 'center';
+		// ee_map_align_single
+
+		// for event list pages
+		$default_map_settings->event_list_map_width = 300;
+		// ee_map_width
+		$default_map_settings->event_list_map_height = 185;
+		// ee_map_height
+		$default_map_settings->event_list_map_zoom = 12;
+		// ee_map_zoom
+		$default_map_settings->event_list_display_nav = false;
+		// ee_map_nav_display
+		$default_map_settings->event_list_nav_size = true;
+		// ee_map_nav_size
+		$default_map_settings->event_list_control_type = 'dropdown';
+		// ee_map_type_control
+		$default_map_settings->event_list_map_align = 'center';
+		// ee_map_align
+
+		$this->_template_args['map_settings'] =
+			isset(EE_Registry::instance()->CFG->map_settings)
+			&& ! empty(EE_Registry::instance()->CFG->map_settings)
+				? (object) array_merge(
+					(array) $default_map_settings,
+					(array) EE_Registry::instance()->CFG->map_settings
+				)
+				: $default_map_settings;
+
+		$this->_set_add_edit_form_tags('update_google_map_settings');
+		$this->_set_publish_post_box_vars();
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _update_google_map_settings()
+	{
+		$map_settings = EE_Registry::instance()->CFG->map_settings;
+
+		$settings = [
+			'use_google_maps'            => 'int',
+			'google_map_api_key'         => 'string',
+			'event_details_map_width'    => 'int',
+			'event_details_map_zoom'     => 'int',
+			'event_details_display_nav'  => 'int',
+			'event_details_nav_size'     => 'int',
+			'event_details_control_type' => 'string',
+			'event_details_map_align'    => 'string',
+			'event_list_map_width'       => 'int',
+			'event_list_map_height'      => 'int',
+			'event_list_map_zoom'        => 'int',
+			'event_list_display_nav'     => 'int',
+			'event_list_nav_size'        => 'int',
+			'event_list_control_type'    => 'string',
+			'event_list_map_align'       => 'string',
+		];
+
+		foreach ($settings as $setting => $type) {
+			$map_settings->{$setting} = $this->request->getRequestParam($setting, $map_settings->{$setting}, $type);
+		}
+
+		EE_Registry::instance()->CFG->map_settings = apply_filters(
+			'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
+			$map_settings
+		);
+
+		$what    = 'Google Map Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->map_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action($success, $what, 'updated', ['action' => 'google_map_settings']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _venue_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+
+		$this->addMetaBox(
+			'espresso_venue_address_options',
+			esc_html__('Physical Location', 'event_espresso'),
+			[$this, 'venue_address_metabox'],
+			$this->page_slug,
+			'side',
+			'core'
+		);
+		$this->addMetaBox(
+			'espresso_venue_gmap_options',
+			esc_html__('Google Map', 'event_espresso'),
+			[$this, 'venue_gmap_metabox'],
+			$this->page_slug,
+			'side'
+		);
+		$this->addMetaBox(
+			'espresso_venue_virtual_loc_options',
+			esc_html__('Virtual Location', 'event_espresso'),
+			[$this, 'venue_virtual_loc_metabox'],
+			$this->page_slug,
+			'side'
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_gmap_metabox()
+	{
+		$template_args = [
+			'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
+				'vnu_enable_for_gmap',
+				$this->get_yes_no_values(),
+				$this->_cpt_model_obj instanceof EE_Venue && $this->_cpt_model_obj->enable_for_gmap()
+			),
+			'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
+		];
+		$template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_address_metabox()
+	{
+		$template_args['_venue'] = $this->_cpt_model_obj;
+
+		$template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
+							? $this->_cpt_model_obj->state_ID()
+							: 0,
+					]
+				),
+				[
+					'input_name'     => 'sta_id',
+					'input_id'       => 'sta_id',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+		$template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					['QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country']
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
+							? $this->_cpt_model_obj->country_ID()
+							: 0,
+					]
+				),
+				[
+					'input_name'     => 'cnt_iso',
+					'input_id'       => 'cnt_iso',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+
+		$template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function venue_virtual_loc_metabox()
+	{
+		$template_args = [
+			'_venue' => $this->_cpt_model_obj,
+		];
+		$template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		$this->_cpt_model_obj = $this->_venue_model->get_one_by_ID($post_id);
+		// meta revision restore
+		$this->_cpt_model_obj->restore_revision($revision_id);
+	}
+
+
+	/**
+	 * Handles updates for venue cpts
+	 *
+	 * @param int     $post_id ID of Venue CPT
+	 * @param WP_Post $post    Post object (with "blessed" WP properties)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
+			return;// get out we're not processing the saving of venues.
+		}
+
+		$wheres = [$this->_venue_model->primary_key_name() => $post_id];
+
+		$venue_values = [
+			'VNU_address'         => $this->request->getRequestParam('vnu_address'),
+			'VNU_address2'        => $this->request->getRequestParam('vnu_address2'),
+			'VNU_city'            => $this->request->getRequestParam('vnu_city'),
+			'STA_ID'              => $this->request->getRequestParam('sta_id'),
+			'CNT_ISO'             => $this->request->getRequestParam('cnt_iso'),
+			'VNU_zip'             => $this->request->getRequestParam('vnu_zip'),
+			'VNU_phone'           => $this->request->getRequestParam('vnu_phone'),
+			'VNU_capacity'        => $this->request->requestParamIsSet('vnu_capacity')
+				? str_replace(',', '', $this->request->getRequestParam('vnu_capacity'))
+				: EE_INF,
+			'VNU_url'             => $this->request->getRequestParam('vnu_url'),
+			'VNU_virtual_phone'   => $this->request->getRequestParam('vnu_virtual_phone'),
+			'VNU_virtual_url'     => $this->request->getRequestParam('vnu_virtual_url'),
+			'VNU_enable_for_gmap' => $this->request->getRequestParam('vnu_enable_for_gmap', false, 'bool'),
+			'VNU_google_map_link' => $this->request->getRequestParam('vnu_google_map_link'),
+		];
+
+		// update venue
+		$success = $this->_venue_model->update($venue_values, [$wheres]);
+
+		// get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_model->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
+		$get_one_where = [$this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status];
+		$venue         = $this->_venue_model->get_one([$get_one_where]);
+
+		// notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
+		$venue_update_callbacks = apply_filters(
+			'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
+			[]
+		);
+		$att_success            = true;
+		foreach ($venue_update_callbacks as $v_callback) {
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
+				? $att_success
+				: false;
+		}
+
+		// any errors?
+		if ($success && ! $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Venue Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Venue Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_trash_or_restore_venue('trash', false);
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_trash_or_restore_venue('draft', false);
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_delete_venue(false);
+	}
+
+
+	public function get_venue_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+	/**
+	 * @param string    $venue_status
+	 * @param bool|null $redirect_after
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_venue(string $venue_status = 'trash', ?bool $redirect_after = true)
+	{
+		// loop thru venues
+		if ($this->VNU_ID) {
+			// clean status
+			$venue_status = sanitize_key($venue_status);
+			// grab status
+			if (! empty($venue_status)) {
+				$success = $this->_change_venue_status($this->VNU_ID, $venue_status);
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The venue could not be moved to the trash because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @param string $venue_status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_venues(string $venue_status = 'trash')
+	{
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! empty($venue_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
+			// loop thru events
+			foreach ($VNU_IDs as $VNU_ID) {
+				if ($VNU_ID = absint($VNU_ID)) {
+					$results = $this->_change_venue_status($VNU_ID, $venue_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
+							'event_espresso'
+						),
+						$VNU_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action  = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Venues', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * _trash_or_restore_venues
+	 * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
+	 * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
+	 * accepting a certain number of params.
+	 *
+	 * @param int|null $VNU_ID
+	 * @param string   $venue_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _change_venue_status(?int $VNU_ID = 0, string $venue_status = ''): bool
+	{
+		// grab venue id
+		if (! $VNU_ID) {
+			$msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		$this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! $venue_status) {
+			$msg = esc_html__(
+				'An error occurred. No Venue Status or an invalid Venue Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// was event trashed or restored ?
+		switch ($venue_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook   = 'AHEE_venue_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook   = 'AHEE_venue_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook   = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($venue_status);
+		$success = $this->_cpt_model_obj->save();
+
+		if ($success === false) {
+			$msg = sprintf(esc_html__('An error occurred. The venue could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param bool $redirect_after
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_venue(bool $redirect_after = true)
+	{
+		// loop thru venues
+		if ($this->VNU_ID) {
+			$success = $this->_delete_or_trash_venue($this->VNU_ID);
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', 'deleted', ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_venues()
+	{
+		$success = true;
+		// determine the event id and set to array.
+		$VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
+		// loop thru events
+		foreach ($VNU_IDs as $VNU_ID) {
+			if ($VNU_ID = absint($VNU_ID)) {
+				$results = $this->_delete_or_trash_venue($VNU_ID);
+				$success = $results !== false ? $success : false;
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Venues', 'event_espresso'),
+			esc_html__('deleted', 'event_espresso'),
+			['action' => 'default']
+		);
+	}
+
+
+	// todo: put in parent
+
+
+	/**
+	 * @param int|null $VNU_ID
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _delete_or_trash_venue(?int $VNU_ID = 0): bool
+	{
+		// grab event id
+		if (! $VNU_ID = absint($VNU_ID)) {
+			$msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+		// first need to remove all term relationships
+		$venue->_remove_relations('Term_Taxonomy');
+		$success = $venue->delete_permanently();
+		// did it all go as planned ?
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
+					$VNU_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		EE_Error::add_success(
+			sprintf(esc_html__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID)
+		);
+		do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
+		return true;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_venues($per_page = 10, $count = false)
+	{
+		$orderby = $this->request->getRequestParam('orderby', '');
+
+		switch ($orderby) {
+			case 'id':
+				$orderby = 'VNU_ID';
+				break;
+
+			case 'capacity':
+				$orderby = 'VNU_capacity';
+				break;
+
+			case 'city':
+				$orderby = 'VNU_city';
+				break;
+
+			default:
+				$orderby = 'VNU_name';
+		}
+
+		$sort         = $this->request->getRequestParam('order', 'ASC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = ! empty($per_page) ? $per_page : 10;
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$category = $this->request->getRequestParam('category');
+		$category = $category > 0 ? $category : null;
+
+		$where = [];
+
+		// only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
+		$status = $this->request->getRequestParam('status');
+		if ($status && $status !== 'all') {
+			$where['status'] = $status;
+		}
+
+		$venue_status = $this->request->getRequestParam('venue_status');
+		if ($venue_status) {
+			$where['status'] = $venue_status;
+		}
+
+
+		if ($category) {
+			$where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
+			$where['Term_Taxonomy.term_id']  = $category;
+		}
+
+
+		if (! $this->capabilities->current_user_can('ee_read_others_venues', 'get_venues')) {
+			$where['VNU_wp_user'] = get_current_user_id();
+		} else {
+			if (! $this->capabilities->current_user_can('ee_read_private_venues', 'get_venues')) {
+				$where['OR'] = [
+					'status*restrict_private' => ['!=', 'private'],
+					'AND'                     => [
+						'status*inclusive' => ['=', 'private'],
+						'VNU_wp_user'      => get_current_user_id(),
+					],
+				];
+			}
+		}
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'VNU_name'               => ['LIKE', $search_term],
+				'VNU_desc'               => ['LIKE', $search_term],
+				'VNU_short_desc'         => ['LIKE', $search_term],
+				'VNU_address'            => ['LIKE', $search_term],
+				'VNU_address2'           => ['LIKE', $search_term],
+				'VNU_city'               => ['LIKE', $search_term],
+				'VNU_zip'                => ['LIKE', $search_term],
+				'VNU_phone'              => ['LIKE', $search_term],
+				'VNU_url'                => ['LIKE', $search_term],
+				'VNU_virtual_phone'      => ['LIKE', $search_term],
+				'VNU_virtual_url'        => ['LIKE', $search_term],
+				'VNU_google_map_link'    => ['LIKE', $search_term],
+				'Event.EVT_name'         => ['LIKE', $search_term],
+				'Event.EVT_desc'         => ['LIKE', $search_term],
+				'Event.EVT_phone'        => ['LIKE', $search_term],
+				'Event.EVT_external_URL' => ['LIKE', $search_term],
+			];
+		}
+
+
+		return $count
+			? $this->_venue_model->count([$where], 'VNU_ID')
+			: $this->_venue_model->get_all(
+				[$where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort]
+			);
+	}
+
+
+
+
+	/** Venue Category Stuff **/
+
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} // already have the category object so get out.
+
+		// set default category object
+		$this->_set_empty_category_object();
+
+		// only set if we've got an id
+		$category_ID = $this->request->getRequestParam('VEN_CAT_ID', 0, 'int');
+		if (! $category_ID) {
+			return;
+		}
+
+		$term = get_term($category_ID, 'espresso_venue_categories');
+
+
+		if (! empty($term)) {
+			$this->_category->category_name       = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc       = $term->description;
+			$this->_category->id                  = $term->term_id;
+			$this->_category->parent              = $term->parent;
+		}
+	}
+
+
+	private function _set_empty_category_object()
+	{
+		$this->_category                = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id            = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			[],
+			'add-new-h2'
+		);
+		$this->_search_btn_label = esc_html__('Venue Categories', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_details($view)
+	{
+		// load formatter helper
+		// load field generator helper
+
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+
+		$this->_set_category_object();
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
+
+		$delete_action = 'delete_category';
+
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(['action' => 'category_list'], $this->_admin_base_url);
+
+		$this->_set_publish_post_box_vars('VEN_CAT_ID', $id, $delete_action, $redirect);
+
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _category_details_content(): string
+	{
+		$editor_args['category_desc'] = [
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => ['media_buttons' => false],
+		];
+		$_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+
+		$all_terms = get_terms(
+			['espresso_venue_categories'],
+			['hide_empty' => 0, 'exclude' => [$this->_category->id]]
+		);
+
+		// setup category select for term parents.
+		$category_select_values[] = [
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		];
+		foreach ($all_terms as $term) {
+			$category_select_values[] = [
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			];
+		}
+
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args   = [
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		];
+		$template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _delete_categories()
+	{
+		$category_ID  = $this->request->getRequestParam('category_id', 0, 'int');
+		$category_IDs = $this->request->getRequestParam('VEN_CAT_ID', [$category_ID], 'int', true);
+
+		foreach ($category_IDs as $cat_id) {
+			$this->_delete_category($cat_id);
+		}
+
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = [
+			'action' => 'category_list',
+		];
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, 'espresso_venue_categories');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = [
+				'action'     => 'edit_category',
+				'VEN_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	private function _insert_category($update = false)
+	{
+		$category_ID     = $update ? $this->request->getRequestParam('VEN_CAT_ID', '', 'int') : '';
+		$category_name   = $this->request->getRequestParam('category_name', '');
+		$category_desc   = $this->request->getRequestParam('category_desc', '', 'html');
+		$category_parent = $this->request->getRequestParam('category_parent', 0, 'int');
+
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$term_args = [
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		];
+
+		$insert_ids = $update
+			? wp_update_term($category_ID, 'espresso_venue_categories', $term_args)
+			: wp_insert_term(
+				$category_name,
+				'espresso_venue_categories',
+				$term_args
+			);
+
+		if (! is_array($insert_ids)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			$category_ID = $insert_ids['term_id'];
+			EE_Error::add_success(
+				sprintf(
+					esc_html__('The category %s was successfully created', 'event_espresso'),
+					$category_name
+				)
+			);
+		}
+
+		return $category_ID;
+	}
+
+
+	/**
+	 * TODO handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$this->request->mergeRequestParams(
+			[
+				'export'       => 'report',
+				'action'       => 'categories',
+				'category_ids' => $this->request->getRequestParam('VEN_CAT_ID', 0, 'int'),
+			]
+		);
+
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->request->requestParams());
+			$EE_Export->export();
+		}
+	}
+
+
+	protected function _import_categories()
+	{
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		EE_Import::instance()->import();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		// testing term stuff
+		$orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$limit       = ($current_page - 1) * $per_page;
+		$where       = ['taxonomy' => 'espresso_venue_categories'];
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'Term.name'   => ['LIKE', $search_term],
+				'description' => ['LIKE', $search_term],
+			];
+		}
+
+		$query_params = [
+			$where,
+			'order_by'   => [$orderby => $order],
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => ['Term'],
+		];
+
+		return $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+	}
+
+
+	/* end category stuff */
+	/**************/
 }

Spacing +33 added lines, -33 removed lines

@@ -56,7 +56,7 @@ 
 
         $this->page_slug        = EE_VENUES_PG_SLUG;
         $this->_admin_base_url  = EE_VENUES_ADMIN_URL;
-        $this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
+        $this->_admin_base_path = EE_ADMIN_PAGES.'venues';
         $this->page_label       = esc_html__('Event Venues', 'event_espresso');
         $this->_cpt_model_names = [
             'create_new' => 'EEM_Venue',
@@ -438,7 +438,7 @@ 
 
     public function load_scripts_styles()
     {
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL.'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('ee-cat-admin');
     }
 
@@ -461,7 +461,7 @@ 
         wp_enqueue_style('espresso-ui-theme');
         wp_register_style(
             'espresso_venues',
-            EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
+            EE_VENUES_ASSETS_URL.'ee-venues-admin.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -524,7 +524,7 @@ 
             'button'
         );
 
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
             'create_new',
             'add',
             [],
@@ -547,7 +547,7 @@ 
             'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
             'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
         ];
-        $template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_publish_box_extras.template.php';
         EEH_Template::display_template($template, $extra_rows);
     }
 
@@ -609,7 +609,7 @@ 
         $this->_set_add_edit_form_tags('update_google_map_settings');
         $this->_set_publish_post_box_vars();
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
+            EE_VENUES_TEMPLATE_PATH.'google_map.template.php',
             $this->_template_args,
             true
         );
@@ -710,7 +710,7 @@ 
             ),
             'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
         ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_gmap_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -723,7 +723,7 @@ 
     {
         $template_args['_venue'] = $this->_cpt_model_obj;
 
-        $template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
+        $template_args['states_dropdown'] = EEH_Form_Fields::generate_form_input(
             new EE_Question_Form_Input(
                 EE_Question::new_instance(
                     ['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
@@ -766,7 +766,7 @@ 
             )
         );
 
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_address_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -776,7 +776,7 @@ 
         $template_args = [
             '_venue' => $this->_cpt_model_obj,
         ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
+        $template      = EE_VENUES_TEMPLATE_PATH.'venue_virtual_location_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -805,7 +805,7 @@ 
     protected function _insert_update_cpt_item($post_id, $post)
     {
         if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
-            return;// get out we're not processing the saving of venues.
+            return; // get out we're not processing the saving of venues.
         }
 
         $wheres = [$this->_venue_model->primary_key_name() => $post_id];
@@ -840,7 +840,7 @@ 
             'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
             []
         );
-        $att_success            = true;
+        $att_success = true;
         foreach ($venue_update_callbacks as $v_callback) {
             // if ANY of these updates fail then we want the appropriate global error message
             $att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
@@ -925,7 +925,7 @@ 
             // clean status
             $venue_status = sanitize_key($venue_status);
             // grab status
-            if (! empty($venue_status)) {
+            if ( ! empty($venue_status)) {
                 $success = $this->_change_venue_status($this->VNU_ID, $venue_status);
             } else {
                 $success = false;
@@ -961,7 +961,7 @@ 
         // clean status
         $venue_status = sanitize_key($venue_status);
         // grab status
-        if (! empty($venue_status)) {
+        if ( ! empty($venue_status)) {
             $success = true;
             // determine the event id and set to array.
             $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
@@ -1012,7 +1012,7 @@ 
     private function _change_venue_status(?int $VNU_ID = 0, string $venue_status = ''): bool
     {
         // grab venue id
-        if (! $VNU_ID) {
+        if ( ! $VNU_ID) {
             $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
@@ -1023,7 +1023,7 @@ 
         // clean status
         $venue_status = sanitize_key($venue_status);
         // grab status
-        if (! $venue_status) {
+        if ( ! $venue_status) {
             $msg = esc_html__(
                 'An error occurred. No Venue Status or an invalid Venue Status was received.',
                 'event_espresso'
@@ -1133,7 +1133,7 @@ 
     private function _delete_or_trash_venue(?int $VNU_ID = 0): bool
     {
         // grab event id
-        if (! $VNU_ID = absint($VNU_ID)) {
+        if ( ! $VNU_ID = absint($VNU_ID)) {
             $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
@@ -1145,7 +1145,7 @@ 
         $venue->_remove_relations('Term_Taxonomy');
         $success = $venue->delete_permanently();
         // did it all go as planned ?
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
@@ -1227,10 +1227,10 @@ 
         }
 
 
-        if (! $this->capabilities->current_user_can('ee_read_others_venues', 'get_venues')) {
+        if ( ! $this->capabilities->current_user_can('ee_read_others_venues', 'get_venues')) {
             $where['VNU_wp_user'] = get_current_user_id();
         } else {
-            if (! $this->capabilities->current_user_can('ee_read_private_venues', 'get_venues')) {
+            if ( ! $this->capabilities->current_user_can('ee_read_private_venues', 'get_venues')) {
                 $where['OR'] = [
                     'status*restrict_private' => ['!=', 'private'],
                     'AND'                     => [
@@ -1243,7 +1243,7 @@ 
 
         $search_term = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term = '%' . $search_term . '%';
+            $search_term = '%'.$search_term.'%';
             $where['OR'] = [
                 'VNU_name'               => ['LIKE', $search_term],
                 'VNU_desc'               => ['LIKE', $search_term],
@@ -1294,14 +1294,14 @@ 
 
         // only set if we've got an id
         $category_ID = $this->request->getRequestParam('VEN_CAT_ID', 0, 'int');
-        if (! $category_ID) {
+        if ( ! $category_ID) {
             return;
         }
 
         $term = get_term($category_ID, 'espresso_venue_categories');
 
 
-        if (! empty($term)) {
+        if ( ! empty($term)) {
             $this->_category->category_name       = $term->name;
             $this->_category->category_identifier = $term->slug;
             $this->_category->category_desc       = $term->description;
@@ -1325,7 +1325,7 @@ 
     protected function _category_list_table()
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
             'add_category',
             'add_category',
             [],
@@ -1370,7 +1370,7 @@ 
             'class'         => 'my_editor_custom',
             'wpeditor_args' => ['media_buttons' => false],
         ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+        $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
 
         $all_terms = get_terms(
             ['espresso_venue_categories'],
@@ -1394,7 +1394,7 @@ 
             $category_select_values,
             $this->_category->parent
         );
-        $template_args   = [
+        $template_args = [
             'category'                 => $this->_category,
             'category_select'          => $category_select,
             'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
@@ -1402,7 +1402,7 @@ 
             'disable'                  => '',
             'disabled_message'         => false,
         ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+        $template = EVENTS_TEMPLATE_PATH.'event_category_details.template.php';
         return EEH_Template::display_template($template, $template_args, true);
     }
 
@@ -1481,7 +1481,7 @@ 
                 $term_args
             );
 
-        if (! is_array($insert_ids)) {
+        if ( ! is_array($insert_ids)) {
             EE_Error::add_error(
                 esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
                 __FILE__,
@@ -1518,8 +1518,8 @@ 
             ]
         );
 
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->request->requestParams());
             $EE_Export->export();
         }
@@ -1528,7 +1528,7 @@ 
 
     protected function _import_categories()
     {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
+        require_once(EE_CLASSES.'EE_Import.class.php');
         EE_Import::instance()->import();
     }
 
@@ -1546,7 +1546,7 @@ 
         $where       = ['taxonomy' => 'espresso_venue_categories'];
         $search_term = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term = '%' . $search_term . '%';
+            $search_term = '%'.$search_term.'%';
             $where['OR'] = [
                 'Term.name'   => ['LIKE', $search_term],
                 'description' => ['LIKE', $search_term],
@@ -1556,7 +1556,7 @@ 
         $query_params = [
             $where,
             'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
+            'limit'      => $limit.','.$per_page,
             'force_join' => ['Term'],
         ];
 

admin_pages/payments/templates/payment_log_details.template.php

Braces +5 added lines, -2 removed lines

@@ -75,14 +75,17 @@
     </table>
 </div>
 
-<?php else : ?>
+<?php else {
+	: ?>
 <div class="padding">
     <table class="ee-payment-log-details widefat">
         <tbody>
             <tr>
                 <td>
                     <p class="ee-status-outline ee-status-bg--attention">
-                        <?php esc_html_e("Payment Log No Longer Exists", 'event_espresso'); ?>
+                        <?php esc_html_e("Payment Log No Longer Exists", 'event_espresso');
+}
+?>
                     </p>
                 </td>
             </tr>

admin_pages/payments/Payments_Admin_Page.core.php

Indentation +1295 added lines, -1295 removed lines

@@ -18,286 +18,286 @@ 
  */
 class Payments_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * Variables used for when we're re-sorting the logs results,
-     * in case we needed to do two queries, and we need to resort
-     *
-     * @var string
-     */
-    private $_sort_logs_again_direction;
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EE_PAYMENTS_PG_SLUG;
-        $this->page_label       = esc_html__('Payment Methods', 'event_espresso');
-        $this->_admin_base_url  = EE_PAYMENTS_ADMIN_URL;
-        $this->_admin_base_path = EE_PAYMENTS_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ajax goes here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * @param string $sort_logs_again_direction
-     */
-    public function setSortLogsAgainDirection(string $sort_logs_again_direction): void
-    {
-        $this->_sort_logs_again_direction = $sort_logs_again_direction;
-    }
-
-
-    protected function _set_page_routes()
-    {
-        /**
-         * note that with payment method capabilities, although we've implemented
-         * capability mapping which will be used for accessing payment methods owned by
-         * other users.  This is not fully implemented yet in the payment method ui.
-         * Currently, only the "plural" caps are in active use.
-         * When cap mapping is implemented, some routes will need to use the singular form of
-         * capability method and also include the $id of the payment method for the route.
-         **/
-        $this->_page_routes = [
-            'default'                   => [
-                'func'       => '_payment_methods_list',
-                'capability' => 'ee_edit_payment_methods',
-            ],
-            'payment_settings'          => [
-                'func'       => '_payment_settings',
-                'capability' => 'ee_manage_gateways',
-            ],
-            'activate_payment_method'   => [
-                'func'       => '_activate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payment_methods',
-            ],
-            'deactivate_payment_method' => [
-                'func'       => '_deactivate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payment_methods',
-            ],
-            'update_payment_method'     => [
-                'func'               => '_update_payment_method',
-                'noheader'           => true,
-                'headers_sent_route' => 'default',
-                'capability'         => 'ee_edit_payment_methods',
-            ],
-            'update_payment_settings'   => [
-                'func'       => '_update_payment_settings',
-                'noheader'   => true,
-                'capability' => 'ee_manage_gateways',
-            ],
-            'payment_log'               => [
-                'func'       => '_payment_log_overview_list_table',
-                'capability' => 'ee_read_payment_methods',
-            ],
-            'payment_log_details'       => [
-                'func'       => '_payment_log_details',
-                'capability' => 'ee_read_payment_methods',
-            ],
-        ];
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_page_config()
-    {
-        $payment_method_list_config = [
-            'nav'           => [
-                'label' => esc_html__('Payment Methods', 'event_espresso'),
-                'icon'  => 'dashicons-bank',
-                'order' => 10,
-            ],
-            'metaboxes'     => $this->_default_espresso_metaboxes,
-            'help_tabs'     => array_merge(
-                [
-                    'payment_methods_overview_help_tab' => [
-                        'title'    => esc_html__('Payment Methods Overview', 'event_espresso'),
-                        'filename' => 'payment_methods_overview',
-                    ],
-                ],
-                $this->_add_payment_method_help_tabs()
-            ),
-            'require_nonce' => false,
-        ];
-        $this->_page_config         = [
-            'default'          => $payment_method_list_config,
-            'payment_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Settings', 'event_espresso'),
-                    'icon'  => 'dashicons-admin-generic',
-                    'order' => 20,
-                ],
-                'help_tabs'     => [
-                    'payment_methods_settings_help_tab' => [
-                        'title'    => esc_html__('Payment Method Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_settings',
-                    ],
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'require_nonce' => false,
-            ],
-            'payment_log'      => [
-                'nav'           => [
-                    'label' => esc_html__("Logs", 'event_espresso'),
-                    'icon'  => 'dashicons-text-page',
-                    'order' => 30,
-                ],
-                'list_table'    => 'Payment_Log_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _add_payment_method_help_tabs(): array
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_method_types     = EE_Payment_Method_Manager::instance()->payment_method_types();
-        $all_pmt_help_tabs_config = [];
-        foreach ($payment_method_types as $payment_method_type) {
-            if (
-                ! $this->capabilities->current_user_can(
-                    $payment_method_type->cap_name(),
-                    'specific_payment_method_type_access'
-                )
-            ) {
-                continue;
-            }
-            foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
-                $template_args                              = $config['template_args'] ?? [];
-                $template_args['admin_page_obj']            = $this;
-                $all_pmt_help_tabs_config[ $help_tab_name ] = [
-                    'title'   => $config['title'],
-                    'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs/' . $config['filename'] . '.help_tab.php',
-                        $template_args,
-                        true
-                    ),
-                ];
-            }
-        }
-        return $all_pmt_help_tabs_config;
-    }
-
-
-    // none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-text-links');
-        wp_enqueue_script(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
-            ['ee-datepicker'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_style('espresso_payments');
-        wp_enqueue_style('ee-text-links');
-    }
-
-
-    public function load_scripts_styles_payment_log_details()
-    {
-        wp_enqueue_style('espresso_payments');
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    private function veryifyTablesExist()
-    {
-        /** @var TableAnalysis $table_analysis */
-        $table_analysis = LoaderFactory::getShared(TableAnalysis::class);
-        /** @var TableManager $table_manager */
-        $table_manager = LoaderFactory::getShared(TableManager::class);
-        if (! $table_analysis->tableExists('esp_payment_method')) {
-            $table_manager->createTable(
-                'esp_payment_method',
-                "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+	/**
+	 * Variables used for when we're re-sorting the logs results,
+	 * in case we needed to do two queries, and we need to resort
+	 *
+	 * @var string
+	 */
+	private $_sort_logs_again_direction;
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_PAYMENTS_PG_SLUG;
+		$this->page_label       = esc_html__('Payment Methods', 'event_espresso');
+		$this->_admin_base_url  = EE_PAYMENTS_ADMIN_URL;
+		$this->_admin_base_path = EE_PAYMENTS_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ajax goes here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * @param string $sort_logs_again_direction
+	 */
+	public function setSortLogsAgainDirection(string $sort_logs_again_direction): void
+	{
+		$this->_sort_logs_again_direction = $sort_logs_again_direction;
+	}
+
+
+	protected function _set_page_routes()
+	{
+		/**
+		 * note that with payment method capabilities, although we've implemented
+		 * capability mapping which will be used for accessing payment methods owned by
+		 * other users.  This is not fully implemented yet in the payment method ui.
+		 * Currently, only the "plural" caps are in active use.
+		 * When cap mapping is implemented, some routes will need to use the singular form of
+		 * capability method and also include the $id of the payment method for the route.
+		 **/
+		$this->_page_routes = [
+			'default'                   => [
+				'func'       => '_payment_methods_list',
+				'capability' => 'ee_edit_payment_methods',
+			],
+			'payment_settings'          => [
+				'func'       => '_payment_settings',
+				'capability' => 'ee_manage_gateways',
+			],
+			'activate_payment_method'   => [
+				'func'       => '_activate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payment_methods',
+			],
+			'deactivate_payment_method' => [
+				'func'       => '_deactivate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payment_methods',
+			],
+			'update_payment_method'     => [
+				'func'               => '_update_payment_method',
+				'noheader'           => true,
+				'headers_sent_route' => 'default',
+				'capability'         => 'ee_edit_payment_methods',
+			],
+			'update_payment_settings'   => [
+				'func'       => '_update_payment_settings',
+				'noheader'   => true,
+				'capability' => 'ee_manage_gateways',
+			],
+			'payment_log'               => [
+				'func'       => '_payment_log_overview_list_table',
+				'capability' => 'ee_read_payment_methods',
+			],
+			'payment_log_details'       => [
+				'func'       => '_payment_log_details',
+				'capability' => 'ee_read_payment_methods',
+			],
+		];
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_page_config()
+	{
+		$payment_method_list_config = [
+			'nav'           => [
+				'label' => esc_html__('Payment Methods', 'event_espresso'),
+				'icon'  => 'dashicons-bank',
+				'order' => 10,
+			],
+			'metaboxes'     => $this->_default_espresso_metaboxes,
+			'help_tabs'     => array_merge(
+				[
+					'payment_methods_overview_help_tab' => [
+						'title'    => esc_html__('Payment Methods Overview', 'event_espresso'),
+						'filename' => 'payment_methods_overview',
+					],
+				],
+				$this->_add_payment_method_help_tabs()
+			),
+			'require_nonce' => false,
+		];
+		$this->_page_config         = [
+			'default'          => $payment_method_list_config,
+			'payment_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Settings', 'event_espresso'),
+					'icon'  => 'dashicons-admin-generic',
+					'order' => 20,
+				],
+				'help_tabs'     => [
+					'payment_methods_settings_help_tab' => [
+						'title'    => esc_html__('Payment Method Settings', 'event_espresso'),
+						'filename' => 'payment_methods_settings',
+					],
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'require_nonce' => false,
+			],
+			'payment_log'      => [
+				'nav'           => [
+					'label' => esc_html__("Logs", 'event_espresso'),
+					'icon'  => 'dashicons-text-page',
+					'order' => 30,
+				],
+				'list_table'    => 'Payment_Log_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _add_payment_method_help_tabs(): array
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_method_types     = EE_Payment_Method_Manager::instance()->payment_method_types();
+		$all_pmt_help_tabs_config = [];
+		foreach ($payment_method_types as $payment_method_type) {
+			if (
+				! $this->capabilities->current_user_can(
+					$payment_method_type->cap_name(),
+					'specific_payment_method_type_access'
+				)
+			) {
+				continue;
+			}
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
+				$template_args                              = $config['template_args'] ?? [];
+				$template_args['admin_page_obj']            = $this;
+				$all_pmt_help_tabs_config[ $help_tab_name ] = [
+					'title'   => $config['title'],
+					'content' => EEH_Template::display_template(
+						$payment_method_type->file_folder() . 'help_tabs/' . $config['filename'] . '.help_tab.php',
+						$template_args,
+						true
+					),
+				];
+			}
+		}
+		return $all_pmt_help_tabs_config;
+	}
+
+
+	// none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-text-links');
+		wp_enqueue_script(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+			['ee-datepicker'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_style('espresso_payments');
+		wp_enqueue_style('ee-text-links');
+	}
+
+
+	public function load_scripts_styles_payment_log_details()
+	{
+		wp_enqueue_style('espresso_payments');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private function veryifyTablesExist()
+	{
+		/** @var TableAnalysis $table_analysis */
+		$table_analysis = LoaderFactory::getShared(TableAnalysis::class);
+		/** @var TableManager $table_manager */
+		$table_manager = LoaderFactory::getShared(TableManager::class);
+		if (! $table_analysis->tableExists('esp_payment_method')) {
+			$table_manager->createTable(
+				'esp_payment_method',
+				"PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -313,1023 +313,1023 @@ 
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug),
 				KEY PMD_type (PMD_type)",
-                'InnoDB'
-            );
-        }
-        if (! $table_analysis->tableExists('esp_currency_payment_method')) {
-            $table_manager->createTable(
-                'esp_currency_payment_method',
-                "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+				'InnoDB'
+			);
+		}
+		if (! $table_analysis->tableExists('esp_currency_payment_method')) {
+			$table_manager->createTable(
+				'esp_currency_payment_method',
+				"CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID),
 				KEY PMD_ID (PMD_ID)",
-                'InnoDB'
-            );
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _payment_methods_list()
-    {
-        $this->veryifyTablesExist();
-        /**
-         * first let's ensure payment methods have been set up.
-         * We do this here because when people activate a payment method for the first time (as an addon),
-         * it may not set up its capabilities or get registered correctly due to the loading process.
-         * However, people MUST set up the details for the payment method,
-         * so it's safe to do a recheck here.
-         */
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        EEM_Payment_Method::instance()->verify_button_urls();
-        // set up tabs, one for each payment method type
-        $tabs            = [];
-        $payment_methods = [];
-        foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
-            // we don't want to show admin-only PMTs for now
-            if ($pmt_obj instanceof EE_PMT_Admin_Only) {
-                continue;
-            }
-            // check access
-            if (
-                ! $this->capabilities->current_user_can(
-                    $pmt_obj->cap_name(),
-                    'specific_payment_method_type_access'
-                )
-            ) {
-                continue;
-            }
-            // check for any active pms of that type
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
-                $payment_method = EE_Payment_Method::new_instance(
-                    [
-                        'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
-                        'PMD_type'       => $pmt_obj->system_name(),
-                        'PMD_name'       => $pmt_obj->pretty_name(),
-                        'PMD_admin_name' => $pmt_obj->pretty_name(),
-                    ]
-                );
-            }
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
-        }
-        $payment_methods = apply_filters(
-            'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-            $payment_methods
-        );
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $this->addMetaBox(
-                // html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
-                    // title
-                    sprintf(esc_html__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
-                    // callback
-                    [$this, 'payment_method_settings_meta_box'],
-                    // post type
-                    null,
-                    // context
-                    'normal',
-                    // priority
-                    'default',
-                    // callback args
-                    ['payment_method' => $payment_method]
-                );
-                // setup for tabbed content
-                $tabs[ $payment_method->slug() ] = [
-                    'label' => $payment_method->admin_name(),
-                    'class' => $payment_method->active()
-                        ? 'gateway-active'
-                        : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
-                    'title' => esc_html__('Modify this Payment Method', 'event_espresso'),
-                    'slug'  => $payment_method->slug(),
-                    'icon'  => $payment_method->active()
-                        ? '<span class="dashicons dashicons-yes-alt"></span>'
-                        : '<span class="dashicons dashicons-remove"></span>',
-                ];
-            }
-        }
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
-            $tabs,
-            'payment_method_links',
-            '',
-            $this->_get_active_payment_method_slug()
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *   _get_active_payment_method_slug
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_active_payment_method_slug()
-    {
-        $payment_method_slug = false;
-        // decide which payment method tab to open first, as dictated by the request's 'payment_method'
-        if (isset($this->_req_data['payment_method'])) {
-            // if they provided the current payment method, use it
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-        }
-        /** @var EE_Payment_Method $payment_method */
-        $payment_method = EEM_Payment_Method::instance()->get_one([['PMD_slug' => $payment_method_slug]]);
-        // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
-            // like, looking for an active one
-            $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
-            // test that one as well
-            if ($this->_verify_payment_method($payment_method)) {
-                $payment_method_slug = $payment_method->slug();
-            } else {
-                $payment_method_slug = 'paypal_standard';
-            }
-        }
-        return $payment_method_slug;
-    }
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *    returns TRUE if the passed payment method is properly constructed and the logged-in user has the correct
-     *    capabilities to access it
-     *
-     * @param EE_Payment_Method|null $payment_method
-     * @return boolean
-     * @throws EE_Error
-     */
-    protected function _verify_payment_method(?EE_Payment_Method $payment_method): bool
-    {
-        return $payment_method instanceof EE_Payment_Method
-               && $payment_method->type_obj() instanceof EE_PMT_Base
-               && $this->capabilities->current_user_can(
-                   $payment_method->type_obj()->cap_name(),
-                   'specific_payment_method_type_access'
-               );
-    }
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *
-     * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
-     * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
-     *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function payment_method_settings_meta_box($post_obj_which_is_null, array $metabox)
-    {
-        $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
-            ? $metabox['args']['payment_method']
-            : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
-            throw new EE_Error(
-                esc_html__(
-                    'Payment method metabox setup incorrectly. No Payment method object was supplied',
-                    'event_espresso'
-                )
-            );
-        }
-        $payment_method_scopes = $payment_method->active();
-        // if the payment method really exists show its form, otherwise the activation template
-        if ($payment_method->ID() && ! empty($payment_method_scopes)) {
-            $form = $this->_generate_payment_method_settings_form($payment_method);
-            if ($form->form_data_present_in($this->_req_data)) {
-                $form->receive_form_submission($this->_req_data);
-            }
-            echo wp_kses(
-                $form->form_open() . $form->get_html_and_js() . $form->form_close(),
-                AllowedTags::getWithFormTags()
-            );
-        } else {
-            echo wp_kses(
-                $this->_activate_payment_method_button($payment_method)->get_html_and_js(),
-                AllowedTags::getWithFormTags()
-            );
-        }
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @access protected
-     * @param EE_Payment_Method|null $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _generate_payment_method_settings_form(
-        ?EE_Payment_Method $payment_method
-    ): EE_Form_Section_Proper {
-        if (! $payment_method instanceof EE_Payment_Method) {
-            return new EE_Form_Section_Proper();
-        }
-        $subsections = apply_filters(
-            'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
-            [
-                'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
-                'currency_support'        => $this->_currency_support($payment_method),
-                'payment_method_settings' => $this->_payment_method_settings($payment_method),
-                'update'                  => $this->_update_payment_method_button($payment_method),
-                'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
-                'fine_print'              => $this->_fine_print(),
-            ],
-            $payment_method
-        );
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
-                'action'          => EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action'         => 'update_payment_method',
-                        'payment_method' => $payment_method->slug(),
-                    ],
-                    EE_PAYMENTS_ADMIN_URL
-                ),
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => array_filter($subsections),
-            ]
-        );
-    }
-
-
-    /**
-     * _pci_dss_compliance
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML|null
-     * @throws EE_Error
-     */
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
-    {
-        if (! $payment_method->type_obj()->requires_https()) {
-            return null;
-        }
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th(
-                    EEH_HTML::label(
-                        EEH_HTML::strong(
-                            esc_html__('IMPORTANT', 'event_espresso'),
-                            '',
-                            'important-notice'
-                        )
-                    )
-                ) .
-                EEH_HTML::td(
-                    EEH_HTML::div(
-                        EEH_HTML::strong(
-                            esc_html__(
-                                'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
-                                'event_espresso'
-                            )
-                        ),
-                        '',
-                        'ee-status-outline ee-status-bg--warning'
-                    )
-                    . EEH_HTML::br()
-
-                    . EEH_HTML::div(
-                        esc_html__('Learn more about ', 'event_espresso')
-                        . EEH_HTML::link(
-                            'https://www.pcisecuritystandards.org/merchants/index.php',
-                            esc_html__('PCI DSS compliance', 'event_espresso')
-                        ),
-                        '',
-                        'ee-status-outline ee-status-bg--info'
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _currency_support
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML|null
-     * @throws EE_Error
-     */
-    protected function _currency_support(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
-    {
-        if ($payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
-            return null;
-        }
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th(
-                    EEH_HTML::label(
-                        EEH_HTML::strong(
-                            esc_html__('IMPORTANT', 'event_espresso'),
-                            '',
-                            'important-notice'
-                        )
-                    )
-                ) .
-                EEH_HTML::td(
-                    EEH_HTML::div(
-                        EEH_HTML::strong(
-                            sprintf(
-                                esc_html__(
-                                    'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
-                                    'event_espresso'
-                                ),
-                                EE_Config::instance()->currency->code
-                            )
-                        ),
-                        '',
-                        'ee-status-outline ee-status-bg--warning'
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _payment_method_settings(EE_Payment_Method $payment_method): EE_Payment_Method_Form
-    {
-        // modify the form, so we only have/show fields that will be implemented for this version
-        return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
-    }
-
-
-    /**
-     * Simplifies the form to merely reproduce 4.1's gateway settings functionality
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @param string                 $payment_method_name
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     */
-    protected function _simplify_form(
-        EE_Form_Section_Proper $form_section,
-        string $payment_method_name = ''
-    ): EE_Payment_Method_Form {
-        if ($form_section instanceof EE_Payment_Method_Form) {
-            $form_section->exclude(
-                [
-                    'PMD_type', // don't want them changing the type
-                    'PMD_slug', // or the slug (probably never)
-                    'PMD_wp_user', // or the user's ID
-                    'Currency', // or the currency, until the rest of EE supports simultaneous currencies
-                ]
-            );
-            return $form_section;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
-                    'event_espresso'
-                ),
-                $payment_method_name
-            )
-        );
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML
-     * @throws EE_Error
-     */
-    protected function _update_payment_method_button(EE_Payment_Method $payment_method): EE_Form_Section_HTML
-    {
-        $update_button = new EE_Submit_Input(
-            [
-                'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
-                'default'    => sprintf(
-                    esc_html__('Update %s Payment Settings', 'event_espresso'),
-                    $payment_method->admin_name()
-                ),
-                'html_label' => EEH_HTML::nbsp(),
-            ]
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th(
-                // esc_html__('Update Settings', 'event_espresso'),
-                    '&nbsp;',
-                    '',
-                    'ee-update-' . $payment_method->slug() . '-settings__label'
-                ) .
-                EEH_HTML::td(
-                    $update_button->get_html_for_input(),
-                    '',
-                    'ee-update-' . $payment_method->slug() . '-settings__input'
-                ),
-                '',
-                'ee-update-' . $payment_method->slug() . '-settings'
-            )
-        );
-    }
-
-
-    /**
-     * _deactivate_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML
-     */
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method): EE_Form_Section_HTML
-    {
-        $link_text_and_title = sprintf(
-            esc_html__('Deactivate %1$s Payments?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th(
-                // esc_html__('Deactivate Payment Method', 'event_espresso'),
-                    '&nbsp;',
-                    '',
-                    'ee-deactivate-' . $payment_method->slug() . '-settings__label'
-                ) .
-                EEH_HTML::td(
-                    EEH_HTML::link(
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            [
-                                'action'         => 'deactivate_payment_method',
-                                'payment_method' => $payment_method->slug(),
-                            ],
-                            EE_PAYMENTS_ADMIN_URL
-                        ),
-                        $link_text_and_title,
-                        $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
-                        'button button--secondary'
-                    ),
-                    '',
-                    'ee-deactivate-' . $payment_method->slug() . '-settings__input'
-                ),
-                '',
-                'ee-deactivate-' . $payment_method->slug() . '-settings'
-            )
-        );
-    }
-
-
-    /**
-     * _activate_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method): EE_Form_Section_Proper
-    {
-        $link_text_and_title = sprintf(
-            esc_html__('Activate %1$s Payment Method?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
-                'action'          => '#',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
-                    [
-                        new EE_Form_Section_HTML(
-                            EEH_HTML::table(
-                                EEH_HTML::tr(
-                                    EEH_HTML::td(
-                                        $payment_method->type_obj()->introductory_html(),
-                                        '',
-                                        '',
-                                        '',
-                                        'colspan="2"'
-                                    )
-                                ) .
-                                EEH_HTML::tr(
-                                    EEH_HTML::th(
-                                        EEH_HTML::label(esc_html__('Click to Activate ', 'event_espresso'))
-                                    ) .
-                                    EEH_HTML::td(
-                                        EEH_HTML::link(
-                                            EE_Admin_Page::add_query_args_and_nonce(
-                                                [
-                                                    'action'              => 'activate_payment_method',
-                                                    'payment_method_type' => $payment_method->type(),
-                                                ],
-                                                EE_PAYMENTS_ADMIN_URL
-                                            ),
-                                            $link_text_and_title,
-                                            $link_text_and_title,
-                                            'activate_' . $payment_method->slug(),
-                                            'button button--primary-alt'
-                                        )
-                                    )
-                                )
-                            )
-                        ),
-                    ],
-                    $payment_method
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _fine_print
-     *
-     * @access protected
-     * @return EE_Form_Section_HTML
-     */
-    protected function _fine_print(): EE_Form_Section_HTML
-    {
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th()
-                . EEH_HTML::thx()
-                . EEH_HTML::td(
-                    EEH_HTML::p(
-                        esc_html__('All fields marked with a * are required fields', 'event_espresso'),
-                        '',
-                        'grey-text'
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @global WP_User $current_user
-     */
-    protected function _activate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method_type'])) {
-            $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
-            // see if one exists
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $payment_method = EE_Payment_Method_Manager::instance()
-                                                       ->activate_a_payment_method_of_type($payment_method_type);
-            $this->_redirect_after_action(
-                1,
-                'Payment Method',
-                'activated',
-                ['action' => 'default', 'payment_method' => $payment_method->slug()]
-            );
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'activated', ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _deactivate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method'])) {
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-            // deactivate it
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
-            $this->_redirect_after_action(
-                $count_updated,
-                'Payment Method',
-                'deactivated',
-                ['action' => 'default', 'payment_method' => $payment_method_slug]
-            );
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'deactivated', ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * Processes the payment method form that was submitted. This is slightly trickier than usual form
-     * processing because we first need to identify WHICH form was processed and which payment method
-     * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
-     * form's data is saved, and we redirect to the default payment methods page, setting the updated payment method
-     * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
-     * subsequently called 'headers_sent_func' which is _payment_methods_list)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _update_payment_method()
-    {
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            // ok let's find which gateway form to use based on the form input
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
-            $correct_pmt_form_to_use = null;
-            $payment_method          = null;
-            foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
-                if ($payment_method instanceof EE_Payment_Method) {
-                    // get the form and simplify it, like what we do when we display it
-                    $pmt_form = $this->_generate_payment_method_settings_form($payment_method);
-                    if ($pmt_form->form_data_present_in($this->_req_data)) {
-                        $correct_pmt_form_to_use = $pmt_form;
-                        break;
-                    }
-                }
-            }
-            // if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
-                EE_Error::add_error(
-                    esc_html__(
-                        "We could not find which payment method type your form submission related to. Please contact support",
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_redirect_after_action(false, 'Payment Method', 'activated', ['action' => 'default']);
-            }
-            $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
-            if ($correct_pmt_form_to_use->is_valid()) {
-                $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
-                                'event_espresso'
-                            ),
-                            'payment_method_settings'
-                        )
-                    );
-                }
-                $payment_settings_subform->save();
-                /** @var $pm EE_Payment_Method */
-                $this->_redirect_after_action(
-                    true,
-                    'Payment Method',
-                    'updated',
-                    ['action' => 'default', 'payment_method' => $payment_method->slug()]
-                );
-            } else {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
-                            'event_espresso'
-                        ),
-                        $payment_method instanceof EE_Payment_Method
-                            ? $payment_method->type_obj()->pretty_name()
-                            : esc_html__('"(unknown)"', 'event_espresso')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _payment_settings()
-    {
-        $form = $this->getPaymentSettingsForm();
-        $this->_set_add_edit_form_tags('update_payment_settings');
-        $this->_set_publish_post_box_vars();
-        $this->_template_args['admin_page_content'] = EEH_HTML::div(
-            $form->get_html_and_js(),
-            '',
-            'padding'
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *        _update_payment_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_payment_settings()
-    {
-        $form = $this->getPaymentSettingsForm();
-        if ($form->was_submitted($this->_req_data)) {
-            $form->receive_form_submission($this->_req_data);
-            if ($form->is_valid()) {
-                /**
-                 * @var $reg_config EE_Registration_Config
-                 */
-                $loader                                   = LoaderFactory::getLoader();
-                $reg_config                               = $loader->getShared('EE_Registration_Config');
-                $valid_data                               = $form->valid_data();
-                $show_pending_payment_options             = $valid_data['show_pending_payment_options'] ?? null;
-                $reg_config->show_pending_payment_options = $show_pending_payment_options === 'ON';
-                $reg_config->gateway_log_lifespan         = $valid_data['gateway_log_lifespan'];
-            }
-        }
-        EE_Registry::instance()->CFG = apply_filters(
-            'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
-            EE_Registry::instance()->CFG
-        );
-
-        $what    = esc_html__('Payment Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            esc_html__('updated', 'event_espresso'),
-            ['action' => 'payment_settings']
-        );
-    }
-
-
-    /**
-     * Gets the form used for updating payment settings
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getPaymentSettingsForm(): EE_Form_Section_Proper
-    {
-        /**
-         * @var $reg_config EE_Registration_Config
-         */
-        $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'payment-settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => [
-                    'show_pending_payment_options' => new EE_Switch_Input(
-                        [
-                            'default'        => $reg_config->show_pending_payment_options
-                                ? EE_Switch_Input::OPTION_ON
-                                : EE_Switch_Input::OPTION_OFF,
-                            'html_name'      => 'show_pending_payment_options',
-                            'html_help_text' => esc_html__(
-                                "If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
-                                'event_espresso'
-                            ),
-                        ],
-                        [
-                            EE_Switch_Input::OPTION_OFF => esc_html__(
-                                'pending payment options are NOT displayed',
-                                'event_espresso'
-                            ),
-                            EE_Switch_Input::OPTION_ON  => esc_html__(
-                                'pending payment options are displayed',
-                                'event_espresso'
-                            ),
-                        ]
-                    ),
-                    'gateway_log_lifespan'         => new EE_Select_Input(
-                        $reg_config->gatewayLogLifespanOptions(),
-                        [
-                            'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.',
-                                'event_espresso'
-                            ),
-                            'default'         => $reg_config->gateway_log_lifespan,
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _payment_log_overview_list_table()
-    {
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    protected function _set_list_table_views_payment_log()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'  => 'all',
-                'label' => esc_html__('View All Logs', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return array|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        // we may need to do multiple queries (joining differently), so we actually want an array of query params
-        $query_params = [['LOG_type' => EEM_Change_Log::type_gateway]];
-        // check if they've selected a specific payment method
-        if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
-            $query_params[0]['OR*pm_or_pay_pm'] = [
-                'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
-                'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
-            ];
-        }
-        // take into account search
-        if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string                                                              =
-                ['LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%'];
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name']                     = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name']               = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type']                     = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_name']                             = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_admin_name']                       = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_type']                             = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message']                                         = $similarity_string;
-        }
-        if (
-            isset($this->_req_data['payment-filter-start-date'])
-            && isset($this->_req_data['payment-filter-end-date'])
-        ) {
-            // add date
-            $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
-            $end_date   = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
-            // 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 for query
-            $start_date                  = EEM_Change_Log::instance()->convert_datetime_for_query(
-                'LOG_time',
-                date('Y-m-d H:i:s', $start_date),
-                'Y-m-d H:i:s'
-            );
-            $end_date                    = EEM_Change_Log::instance()->convert_datetime_for_query(
-                'LOG_time',
-                date('Y-m-d H:i:s', $end_date),
-                'Y-m-d H:i:s'
-            );
-            $query_params[0]['LOG_time'] = ['BETWEEN', [$start_date, $end_date]];
-        }
-        if ($count) {
-            return EEM_Change_Log::instance()->count($query_params);
-        }
-        if (isset($this->_req_data['order'])) {
-            $sort                     = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-                ? $this->_req_data['order']
-                : 'DESC';
-            $query_params['order_by'] = ['LOG_time' => $sort];
-        } else {
-            $query_params['order_by'] = ['LOG_time' => 'DESC'];
-        }
-        $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
-            $query_params['limit'] = [$offset, $per_page];
-        }
-        // now they've requested to instead just download the file instead of viewing it.
-        if (isset($this->_req_data['download_results'])) {
-            $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
-            header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo '<h1> '
-                 . sprintf(
-                     esc_html__('Payment Logs for %1$s', 'event_espresso'),
-                     esc_url_raw(site_url())
-                 )
-                 . '</h1 >';
-            echo '<h3>' . esc_html__('Query:', 'event_espresso') . '</h3>';
-            echo esc_html(var_export($query_params, true));
-            echo '<h3>' . esc_html__('Results:', 'event_espresso') . '</h3>';
-            echo esc_html(var_export($wpdb_results, true));
-            die;
-        }
-        return EEM_Change_Log::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Used by usort to RE-sort log query results, because we lose the ordering
-     * because we're possibly combining the results from two queries
-     *
-     * @param EE_Change_Log $logA
-     * @param EE_Change_Log $logB
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _sort_logs_again($logA, $logB)
-    {
-        $timeA = $logA->get_raw('LOG_time');
-        $timeB = $logB->get_raw('LOG_time');
-        if ($timeA == $timeB) {
-            return 0;
-        }
-        $comparison = $timeA < $timeB
-            ? -1
-            : 1;
-        if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
-            return $comparison * -1;
-        }
-        return $comparison;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _payment_log_details()
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        /** @var $payment_log EE_Change_Log */
-        $payment_log    = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
-        $payment_method = null;
-        $transaction    = null;
-        if ($payment_log instanceof EE_Change_Log) {
-            if ($payment_log->object() instanceof EE_Payment) {
-                $payment_method = $payment_log->object()->payment_method();
-                $transaction    = $payment_log->object()->transaction();
-            } elseif ($payment_log->object() instanceof EE_Payment_Method) {
-                $payment_method = $payment_log->object();
-            } elseif ($payment_log->object() instanceof EE_Transaction) {
-                $transaction    = $payment_log->object();
-                $payment_method = $transaction->payment_method();
-            }
-        }
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
-            [
-                'payment_log'    => $payment_log,
-                'payment_method' => $payment_method,
-                'transaction'    => $transaction,
-            ],
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
+				'InnoDB'
+			);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _payment_methods_list()
+	{
+		$this->veryifyTablesExist();
+		/**
+		 * first let's ensure payment methods have been set up.
+		 * We do this here because when people activate a payment method for the first time (as an addon),
+		 * it may not set up its capabilities or get registered correctly due to the loading process.
+		 * However, people MUST set up the details for the payment method,
+		 * so it's safe to do a recheck here.
+		 */
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		EEM_Payment_Method::instance()->verify_button_urls();
+		// set up tabs, one for each payment method type
+		$tabs            = [];
+		$payment_methods = [];
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
+			// we don't want to show admin-only PMTs for now
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
+				continue;
+			}
+			// check access
+			if (
+				! $this->capabilities->current_user_can(
+					$pmt_obj->cap_name(),
+					'specific_payment_method_type_access'
+				)
+			) {
+				continue;
+			}
+			// check for any active pms of that type
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
+			if (! $payment_method instanceof EE_Payment_Method) {
+				$payment_method = EE_Payment_Method::new_instance(
+					[
+						'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
+						'PMD_type'       => $pmt_obj->system_name(),
+						'PMD_name'       => $pmt_obj->pretty_name(),
+						'PMD_admin_name' => $pmt_obj->pretty_name(),
+					]
+				);
+			}
+			$payment_methods[ $payment_method->slug() ] = $payment_method;
+		}
+		$payment_methods = apply_filters(
+			'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+			$payment_methods
+		);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$this->addMetaBox(
+				// html id
+					'espresso_' . $payment_method->slug() . '_payment_settings',
+					// title
+					sprintf(esc_html__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
+					// callback
+					[$this, 'payment_method_settings_meta_box'],
+					// post type
+					null,
+					// context
+					'normal',
+					// priority
+					'default',
+					// callback args
+					['payment_method' => $payment_method]
+				);
+				// setup for tabbed content
+				$tabs[ $payment_method->slug() ] = [
+					'label' => $payment_method->admin_name(),
+					'class' => $payment_method->active()
+						? 'gateway-active'
+						: '',
+					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+					'title' => esc_html__('Modify this Payment Method', 'event_espresso'),
+					'slug'  => $payment_method->slug(),
+					'icon'  => $payment_method->active()
+						? '<span class="dashicons dashicons-yes-alt"></span>'
+						: '<span class="dashicons dashicons-remove"></span>',
+				];
+			}
+		}
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
+			$tabs,
+			'payment_method_links',
+			'',
+			$this->_get_active_payment_method_slug()
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *   _get_active_payment_method_slug
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_active_payment_method_slug()
+	{
+		$payment_method_slug = false;
+		// decide which payment method tab to open first, as dictated by the request's 'payment_method'
+		if (isset($this->_req_data['payment_method'])) {
+			// if they provided the current payment method, use it
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+		}
+		/** @var EE_Payment_Method $payment_method */
+		$payment_method = EEM_Payment_Method::instance()->get_one([['PMD_slug' => $payment_method_slug]]);
+		// if that didn't work or wasn't provided, find another way to select the current pm
+		if (! $this->_verify_payment_method($payment_method)) {
+			// like, looking for an active one
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
+			// test that one as well
+			if ($this->_verify_payment_method($payment_method)) {
+				$payment_method_slug = $payment_method->slug();
+			} else {
+				$payment_method_slug = 'paypal_standard';
+			}
+		}
+		return $payment_method_slug;
+	}
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *    returns TRUE if the passed payment method is properly constructed and the logged-in user has the correct
+	 *    capabilities to access it
+	 *
+	 * @param EE_Payment_Method|null $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	protected function _verify_payment_method(?EE_Payment_Method $payment_method): bool
+	{
+		return $payment_method instanceof EE_Payment_Method
+			   && $payment_method->type_obj() instanceof EE_PMT_Base
+			   && $this->capabilities->current_user_can(
+				   $payment_method->type_obj()->cap_name(),
+				   'specific_payment_method_type_access'
+			   );
+	}
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *
+	 * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
+	 * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
+	 *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function payment_method_settings_meta_box($post_obj_which_is_null, array $metabox)
+	{
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
+			? $metabox['args']['payment_method']
+			: null;
+		if (! $payment_method instanceof EE_Payment_Method) {
+			throw new EE_Error(
+				esc_html__(
+					'Payment method metabox setup incorrectly. No Payment method object was supplied',
+					'event_espresso'
+				)
+			);
+		}
+		$payment_method_scopes = $payment_method->active();
+		// if the payment method really exists show its form, otherwise the activation template
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
+			$form = $this->_generate_payment_method_settings_form($payment_method);
+			if ($form->form_data_present_in($this->_req_data)) {
+				$form->receive_form_submission($this->_req_data);
+			}
+			echo wp_kses(
+				$form->form_open() . $form->get_html_and_js() . $form->form_close(),
+				AllowedTags::getWithFormTags()
+			);
+		} else {
+			echo wp_kses(
+				$this->_activate_payment_method_button($payment_method)->get_html_and_js(),
+				AllowedTags::getWithFormTags()
+			);
+		}
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method|null $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _generate_payment_method_settings_form(
+		?EE_Payment_Method $payment_method
+	): EE_Form_Section_Proper {
+		if (! $payment_method instanceof EE_Payment_Method) {
+			return new EE_Form_Section_Proper();
+		}
+		$subsections = apply_filters(
+			'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
+			[
+				'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
+				'currency_support'        => $this->_currency_support($payment_method),
+				'payment_method_settings' => $this->_payment_method_settings($payment_method),
+				'update'                  => $this->_update_payment_method_button($payment_method),
+				'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
+				'fine_print'              => $this->_fine_print(),
+			],
+			$payment_method
+		);
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => $payment_method->slug() . '_settings_form',
+				'html_id'         => $payment_method->slug() . '_settings_form',
+				'action'          => EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action'         => 'update_payment_method',
+						'payment_method' => $payment_method->slug(),
+					],
+					EE_PAYMENTS_ADMIN_URL
+				),
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => array_filter($subsections),
+			]
+		);
+	}
+
+
+	/**
+	 * _pci_dss_compliance
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML|null
+	 * @throws EE_Error
+	 */
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
+	{
+		if (! $payment_method->type_obj()->requires_https()) {
+			return null;
+		}
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th(
+					EEH_HTML::label(
+						EEH_HTML::strong(
+							esc_html__('IMPORTANT', 'event_espresso'),
+							'',
+							'important-notice'
+						)
+					)
+				) .
+				EEH_HTML::td(
+					EEH_HTML::div(
+						EEH_HTML::strong(
+							esc_html__(
+								'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
+								'event_espresso'
+							)
+						),
+						'',
+						'ee-status-outline ee-status-bg--warning'
+					)
+					. EEH_HTML::br()
+
+					. EEH_HTML::div(
+						esc_html__('Learn more about ', 'event_espresso')
+						. EEH_HTML::link(
+							'https://www.pcisecuritystandards.org/merchants/index.php',
+							esc_html__('PCI DSS compliance', 'event_espresso')
+						),
+						'',
+						'ee-status-outline ee-status-bg--info'
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _currency_support
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML|null
+	 * @throws EE_Error
+	 */
+	protected function _currency_support(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
+	{
+		if ($payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+			return null;
+		}
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th(
+					EEH_HTML::label(
+						EEH_HTML::strong(
+							esc_html__('IMPORTANT', 'event_espresso'),
+							'',
+							'important-notice'
+						)
+					)
+				) .
+				EEH_HTML::td(
+					EEH_HTML::div(
+						EEH_HTML::strong(
+							sprintf(
+								esc_html__(
+									'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
+									'event_espresso'
+								),
+								EE_Config::instance()->currency->code
+							)
+						),
+						'',
+						'ee-status-outline ee-status-bg--warning'
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _payment_method_settings(EE_Payment_Method $payment_method): EE_Payment_Method_Form
+	{
+		// modify the form, so we only have/show fields that will be implemented for this version
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
+	}
+
+
+	/**
+	 * Simplifies the form to merely reproduce 4.1's gateway settings functionality
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @param string                 $payment_method_name
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 */
+	protected function _simplify_form(
+		EE_Form_Section_Proper $form_section,
+		string $payment_method_name = ''
+	): EE_Payment_Method_Form {
+		if ($form_section instanceof EE_Payment_Method_Form) {
+			$form_section->exclude(
+				[
+					'PMD_type', // don't want them changing the type
+					'PMD_slug', // or the slug (probably never)
+					'PMD_wp_user', // or the user's ID
+					'Currency', // or the currency, until the rest of EE supports simultaneous currencies
+				]
+			);
+			return $form_section;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
+					'event_espresso'
+				),
+				$payment_method_name
+			)
+		);
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML
+	 * @throws EE_Error
+	 */
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method): EE_Form_Section_HTML
+	{
+		$update_button = new EE_Submit_Input(
+			[
+				'name'       => 'submit',
+				'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+				'default'    => sprintf(
+					esc_html__('Update %s Payment Settings', 'event_espresso'),
+					$payment_method->admin_name()
+				),
+				'html_label' => EEH_HTML::nbsp(),
+			]
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th(
+				// esc_html__('Update Settings', 'event_espresso'),
+					'&nbsp;',
+					'',
+					'ee-update-' . $payment_method->slug() . '-settings__label'
+				) .
+				EEH_HTML::td(
+					$update_button->get_html_for_input(),
+					'',
+					'ee-update-' . $payment_method->slug() . '-settings__input'
+				),
+				'',
+				'ee-update-' . $payment_method->slug() . '-settings'
+			)
+		);
+	}
+
+
+	/**
+	 * _deactivate_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML
+	 */
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method): EE_Form_Section_HTML
+	{
+		$link_text_and_title = sprintf(
+			esc_html__('Deactivate %1$s Payments?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th(
+				// esc_html__('Deactivate Payment Method', 'event_espresso'),
+					'&nbsp;',
+					'',
+					'ee-deactivate-' . $payment_method->slug() . '-settings__label'
+				) .
+				EEH_HTML::td(
+					EEH_HTML::link(
+						EE_Admin_Page::add_query_args_and_nonce(
+							[
+								'action'         => 'deactivate_payment_method',
+								'payment_method' => $payment_method->slug(),
+							],
+							EE_PAYMENTS_ADMIN_URL
+						),
+						$link_text_and_title,
+						$link_text_and_title,
+						'deactivate_' . $payment_method->slug(),
+						'button button--secondary'
+					),
+					'',
+					'ee-deactivate-' . $payment_method->slug() . '-settings__input'
+				),
+				'',
+				'ee-deactivate-' . $payment_method->slug() . '-settings'
+			)
+		);
+	}
+
+
+	/**
+	 * _activate_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method): EE_Form_Section_Proper
+	{
+		$link_text_and_title = sprintf(
+			esc_html__('Activate %1$s Payment Method?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
+				'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+				'action'          => '#',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
+					[
+						new EE_Form_Section_HTML(
+							EEH_HTML::table(
+								EEH_HTML::tr(
+									EEH_HTML::td(
+										$payment_method->type_obj()->introductory_html(),
+										'',
+										'',
+										'',
+										'colspan="2"'
+									)
+								) .
+								EEH_HTML::tr(
+									EEH_HTML::th(
+										EEH_HTML::label(esc_html__('Click to Activate ', 'event_espresso'))
+									) .
+									EEH_HTML::td(
+										EEH_HTML::link(
+											EE_Admin_Page::add_query_args_and_nonce(
+												[
+													'action'              => 'activate_payment_method',
+													'payment_method_type' => $payment_method->type(),
+												],
+												EE_PAYMENTS_ADMIN_URL
+											),
+											$link_text_and_title,
+											$link_text_and_title,
+											'activate_' . $payment_method->slug(),
+											'button button--primary-alt'
+										)
+									)
+								)
+							)
+						),
+					],
+					$payment_method
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _fine_print
+	 *
+	 * @access protected
+	 * @return EE_Form_Section_HTML
+	 */
+	protected function _fine_print(): EE_Form_Section_HTML
+	{
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th()
+				. EEH_HTML::thx()
+				. EEH_HTML::td(
+					EEH_HTML::p(
+						esc_html__('All fields marked with a * are required fields', 'event_espresso'),
+						'',
+						'grey-text'
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @global WP_User $current_user
+	 */
+	protected function _activate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method_type'])) {
+			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
+			// see if one exists
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$payment_method = EE_Payment_Method_Manager::instance()
+													   ->activate_a_payment_method_of_type($payment_method_type);
+			$this->_redirect_after_action(
+				1,
+				'Payment Method',
+				'activated',
+				['action' => 'default', 'payment_method' => $payment_method->slug()]
+			);
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'activated', ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _deactivate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method'])) {
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+			// deactivate it
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
+			$this->_redirect_after_action(
+				$count_updated,
+				'Payment Method',
+				'deactivated',
+				['action' => 'default', 'payment_method' => $payment_method_slug]
+			);
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'deactivated', ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * Processes the payment method form that was submitted. This is slightly trickier than usual form
+	 * processing because we first need to identify WHICH form was processed and which payment method
+	 * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
+	 * form's data is saved, and we redirect to the default payment methods page, setting the updated payment method
+	 * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
+	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _update_payment_method()
+	{
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			// ok let's find which gateway form to use based on the form input
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
+			$correct_pmt_form_to_use = null;
+			$payment_method          = null;
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
+				if ($payment_method instanceof EE_Payment_Method) {
+					// get the form and simplify it, like what we do when we display it
+					$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
+					if ($pmt_form->form_data_present_in($this->_req_data)) {
+						$correct_pmt_form_to_use = $pmt_form;
+						break;
+					}
+				}
+			}
+			// if we couldn't find the correct payment method type...
+			if (! $correct_pmt_form_to_use) {
+				EE_Error::add_error(
+					esc_html__(
+						"We could not find which payment method type your form submission related to. Please contact support",
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_redirect_after_action(false, 'Payment Method', 'activated', ['action' => 'default']);
+			}
+			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
+			if ($correct_pmt_form_to_use->is_valid()) {
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
+				if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
+								'event_espresso'
+							),
+							'payment_method_settings'
+						)
+					);
+				}
+				$payment_settings_subform->save();
+				/** @var $pm EE_Payment_Method */
+				$this->_redirect_after_action(
+					true,
+					'Payment Method',
+					'updated',
+					['action' => 'default', 'payment_method' => $payment_method->slug()]
+				);
+			} else {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
+							'event_espresso'
+						),
+						$payment_method instanceof EE_Payment_Method
+							? $payment_method->type_obj()->pretty_name()
+							: esc_html__('"(unknown)"', 'event_espresso')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _payment_settings()
+	{
+		$form = $this->getPaymentSettingsForm();
+		$this->_set_add_edit_form_tags('update_payment_settings');
+		$this->_set_publish_post_box_vars();
+		$this->_template_args['admin_page_content'] = EEH_HTML::div(
+			$form->get_html_and_js(),
+			'',
+			'padding'
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *        _update_payment_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_payment_settings()
+	{
+		$form = $this->getPaymentSettingsForm();
+		if ($form->was_submitted($this->_req_data)) {
+			$form->receive_form_submission($this->_req_data);
+			if ($form->is_valid()) {
+				/**
+				 * @var $reg_config EE_Registration_Config
+				 */
+				$loader                                   = LoaderFactory::getLoader();
+				$reg_config                               = $loader->getShared('EE_Registration_Config');
+				$valid_data                               = $form->valid_data();
+				$show_pending_payment_options             = $valid_data['show_pending_payment_options'] ?? null;
+				$reg_config->show_pending_payment_options = $show_pending_payment_options === 'ON';
+				$reg_config->gateway_log_lifespan         = $valid_data['gateway_log_lifespan'];
+			}
+		}
+		EE_Registry::instance()->CFG = apply_filters(
+			'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
+			EE_Registry::instance()->CFG
+		);
+
+		$what    = esc_html__('Payment Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			esc_html__('updated', 'event_espresso'),
+			['action' => 'payment_settings']
+		);
+	}
+
+
+	/**
+	 * Gets the form used for updating payment settings
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getPaymentSettingsForm(): EE_Form_Section_Proper
+	{
+		/**
+		 * @var $reg_config EE_Registration_Config
+		 */
+		$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'payment-settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => [
+					'show_pending_payment_options' => new EE_Switch_Input(
+						[
+							'default'        => $reg_config->show_pending_payment_options
+								? EE_Switch_Input::OPTION_ON
+								: EE_Switch_Input::OPTION_OFF,
+							'html_name'      => 'show_pending_payment_options',
+							'html_help_text' => esc_html__(
+								"If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
+								'event_espresso'
+							),
+						],
+						[
+							EE_Switch_Input::OPTION_OFF => esc_html__(
+								'pending payment options are NOT displayed',
+								'event_espresso'
+							),
+							EE_Switch_Input::OPTION_ON  => esc_html__(
+								'pending payment options are displayed',
+								'event_espresso'
+							),
+						]
+					),
+					'gateway_log_lifespan'         => new EE_Select_Input(
+						$reg_config->gatewayLogLifespanOptions(),
+						[
+							'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.',
+								'event_espresso'
+							),
+							'default'         => $reg_config->gateway_log_lifespan,
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _payment_log_overview_list_table()
+	{
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	protected function _set_list_table_views_payment_log()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'  => 'all',
+				'label' => esc_html__('View All Logs', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return array|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		// we may need to do multiple queries (joining differently), so we actually want an array of query params
+		$query_params = [['LOG_type' => EEM_Change_Log::type_gateway]];
+		// check if they've selected a specific payment method
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
+			$query_params[0]['OR*pm_or_pay_pm'] = [
+				'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
+				'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
+			];
+		}
+		// take into account search
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
+			$similarity_string                                                              =
+				['LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%'];
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_name']                     = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name']               = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_type']                     = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_name']                             = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_admin_name']                       = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_type']                             = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message']                                         = $similarity_string;
+		}
+		if (
+			isset($this->_req_data['payment-filter-start-date'])
+			&& isset($this->_req_data['payment-filter-end-date'])
+		) {
+			// add date
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
+			$end_date   = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
+			// 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 for query
+			$start_date                  = EEM_Change_Log::instance()->convert_datetime_for_query(
+				'LOG_time',
+				date('Y-m-d H:i:s', $start_date),
+				'Y-m-d H:i:s'
+			);
+			$end_date                    = EEM_Change_Log::instance()->convert_datetime_for_query(
+				'LOG_time',
+				date('Y-m-d H:i:s', $end_date),
+				'Y-m-d H:i:s'
+			);
+			$query_params[0]['LOG_time'] = ['BETWEEN', [$start_date, $end_date]];
+		}
+		if ($count) {
+			return EEM_Change_Log::instance()->count($query_params);
+		}
+		if (isset($this->_req_data['order'])) {
+			$sort                     = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+				? $this->_req_data['order']
+				: 'DESC';
+			$query_params['order_by'] = ['LOG_time' => $sort];
+		} else {
+			$query_params['order_by'] = ['LOG_time' => 'DESC'];
+		}
+		$offset = ($current_page - 1) * $per_page;
+		if (! isset($this->_req_data['download_results'])) {
+			$query_params['limit'] = [$offset, $per_page];
+		}
+		// now they've requested to instead just download the file instead of viewing it.
+		if (isset($this->_req_data['download_results'])) {
+			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
+			header('Content-Disposition: attachment');
+			header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
+			echo '<h1> '
+				 . sprintf(
+					 esc_html__('Payment Logs for %1$s', 'event_espresso'),
+					 esc_url_raw(site_url())
+				 )
+				 . '</h1 >';
+			echo '<h3>' . esc_html__('Query:', 'event_espresso') . '</h3>';
+			echo esc_html(var_export($query_params, true));
+			echo '<h3>' . esc_html__('Results:', 'event_espresso') . '</h3>';
+			echo esc_html(var_export($wpdb_results, true));
+			die;
+		}
+		return EEM_Change_Log::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Used by usort to RE-sort log query results, because we lose the ordering
+	 * because we're possibly combining the results from two queries
+	 *
+	 * @param EE_Change_Log $logA
+	 * @param EE_Change_Log $logB
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _sort_logs_again($logA, $logB)
+	{
+		$timeA = $logA->get_raw('LOG_time');
+		$timeB = $logB->get_raw('LOG_time');
+		if ($timeA == $timeB) {
+			return 0;
+		}
+		$comparison = $timeA < $timeB
+			? -1
+			: 1;
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
+			return $comparison * -1;
+		}
+		return $comparison;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _payment_log_details()
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		/** @var $payment_log EE_Change_Log */
+		$payment_log    = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
+		$payment_method = null;
+		$transaction    = null;
+		if ($payment_log instanceof EE_Change_Log) {
+			if ($payment_log->object() instanceof EE_Payment) {
+				$payment_method = $payment_log->object()->payment_method();
+				$transaction    = $payment_log->object()->transaction();
+			} elseif ($payment_log->object() instanceof EE_Payment_Method) {
+				$payment_method = $payment_log->object();
+			} elseif ($payment_log->object() instanceof EE_Transaction) {
+				$transaction    = $payment_log->object();
+				$payment_method = $transaction->payment_method();
+			}
+		}
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+			[
+				'payment_log'    => $payment_log,
+				'payment_method' => $payment_method,
+				'transaction'    => $transaction,
+			],
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
 }

admin_pages/maintenance/templates/ee_migration_page.template.php

Indentation +115 added lines, -115 removed lines

@@ -36,55 +36,55 @@ 
             <h3 class="espresso-header ee-status-bg--info">
                 <span class="dashicons dashicons-flag ee-icon-size-22"></span>
                 <?php
-                echo esc_html(
-                    apply_filters(
-                        'FHEE__ee_migration_page__header',
-                        sprintf(
-                            __("Your Event Espresso data needs to be updated.", "event_espresso"),
-                            $current_db_state,
-                            $next_db_state
-                        ),
-                        $current_db_state,
-                        $next_db_state
-                    )
-                );
-                ?>
+				echo esc_html(
+					apply_filters(
+						'FHEE__ee_migration_page__header',
+						sprintf(
+							__("Your Event Espresso data needs to be updated.", "event_espresso"),
+							$current_db_state,
+							$next_db_state
+						),
+						$current_db_state,
+						$next_db_state
+					)
+				);
+				?>
             </h3>
         <?php } elseif ($show_most_recent_migration) { ?>
             <h3 class="espresso-header ee-status-bg--info">
                 <span class="dashicons dashicons-awards ee-icon-size-22"></span>
                 <?php echo esc_html(
-                    apply_filters(
-                        'FHEE__ee_migration_page__done_migration_header',
-                        sprintf(
-                            __(
-                                'Congratulations! Your database is "up-to-date" and you are ready to begin using %s',
-                                "event_espresso"
-                            ),
-                            $ultimate_db_state
-                        )
-                    )
-                ); ?>
+					apply_filters(
+						'FHEE__ee_migration_page__done_migration_header',
+						sprintf(
+							__(
+								'Congratulations! Your database is "up-to-date" and you are ready to begin using %s',
+								"event_espresso"
+							),
+							$ultimate_db_state
+						)
+					)
+				); ?>
             </h3>
             <p>
                 <?php echo esc_html(
-                    apply_filters(
-                        'FHEE__ee_migration_page__p_after_done_migration_header',
-                        sprintf(
-                            __(
-                                "Time to find out about all the great new features %s has to offer.",
-                                "event_espresso"
-                            ),
-                            $ultimate_db_state
-                        )
-                    )
-                ); ?> &nbsp;
+					apply_filters(
+						'FHEE__ee_migration_page__p_after_done_migration_header',
+						sprintf(
+							__(
+								"Time to find out about all the great new features %s has to offer.",
+								"event_espresso"
+							),
+							$ultimate_db_state
+						)
+					)
+				); ?> &nbsp;
                 <b>
                     <a class="button--primary"
                        id='get-started-after-migrate'
                        href="<?php
-                        echo esc_url_raw(add_query_arg(['page' => 'espresso_about'], admin_url('admin.php')));
-                        ?>"
+						echo esc_url_raw(add_query_arg(['page' => 'espresso_about'], admin_url('admin.php')));
+						?>"
                     >
                         <?php esc_html_e("Let's Get Started", "event_espresso"); ?>&nbsp;
                         <span class="dashicons dashicons-arrow-right ee-icon-size-22" style="margin:0;"></span>
@@ -95,46 +95,46 @@ 
 
 
         <?php
-        if ($show_backup_db_text) {
-            echo wp_kses($migration_options_html, AllowedTags::getAllowedTags());
-        } ?>
+		if ($show_backup_db_text) {
+			echo wp_kses($migration_options_html, AllowedTags::getAllowedTags());
+		} ?>
 
         <?php
-        if ($show_most_recent_migration) {
-            if ($most_recent_migration instanceof EE_Data_Migration_Script_Base) {
-                if ($most_recent_migration->can_continue()) {
-                    // tell the user they should continue their migration because it appears to be unfinished... well, assuming there were no errors ?>
+		if ($show_most_recent_migration) {
+			if ($most_recent_migration instanceof EE_Data_Migration_Script_Base) {
+				if ($most_recent_migration->can_continue()) {
+					// tell the user they should continue their migration because it appears to be unfinished... well, assuming there were no errors ?>
                     <h3 class="espresso-header ee-status-bg--info">
                         <span class="dashicons dashicons-star-half ee-icon-size-22"></span>
                         <?php printf(
-                            esc_html__(
-                                "It appears that your previous Database Update (%s) is incomplete, and should be resumed",
-                                "event_espresso"
-                            ),
-                            $most_recent_migration->pretty_name()
-                        ); ?>
+							esc_html__(
+								"It appears that your previous Database Update (%s) is incomplete, and should be resumed",
+								"event_espresso"
+							),
+							$most_recent_migration->pretty_name()
+						); ?>
                     </h3>
                     <?php
-                } elseif ($most_recent_migration->is_broken()) {
-                    // tell the user the migration failed, and they should notify EE?>
+				} elseif ($most_recent_migration->is_broken()) {
+					// tell the user the migration failed, and they should notify EE?>
                     <h3 class="espresso-header ee-status-bg--info">
                         <span class="dashicons dashicons-no ee-icon-size-22"></span>
                         <?php echo esc_html($most_recent_migration->get_feedback_message()) ?>
                     </h3>
                     <?php
-                }
-                // display errors or not of the most recent migration ran
-                if ($most_recent_migration->get_errors()) {
-                    ?>
+				}
+				// display errors or not of the most recent migration ran
+				if ($most_recent_migration->get_errors()) {
+					?>
                     <div class="ee-attention">
                         <strong>
                             <?php printf(
-                                esc_html__(
-                                    "Warnings occurred during your last Database Update (%s):",
-                                    'event_espresso'
-                                ),
-                                $most_recent_migration->pretty_name()
-                            ); ?>
+								esc_html__(
+									"Warnings occurred during your last Database Update (%s):",
+									'event_espresso'
+								),
+								$most_recent_migration->pretty_name()
+							); ?>
                         </strong>
                         <a id="show-hide-migration-warnings" class="display-the-hidden">
                             <?php esc_html_e("Show Warnings", 'event_espresso'); ?>
@@ -146,32 +146,32 @@ 
                         </ul>
                     </div>
                     <?php
-                } else {
-                    // there were no errors during the last migration, just say so?>
+				} else {
+					// there were no errors during the last migration, just say so?>
                     <h2>
                         <?php printf(
-                            esc_html__(
-                                "The last Database Update (%s) ran successfully without errors.",
-                                "event_espresso"
-                            ),
-                            $most_recent_migration->pretty_name()
-                        ); ?>
+							esc_html__(
+								"The last Database Update (%s) ran successfully without errors.",
+								"event_espresso"
+							),
+							$most_recent_migration->pretty_name()
+						); ?>
                     </h2>
                     <?php
-                }
-            }
-        }
-        // end of: if ( $show_most_recent_migration )
-        ?>
+				}
+			}
+		}
+		// end of: if ( $show_most_recent_migration )
+		?>
 
     </div>
     <!--end of #migration-prep-->
 
     <?php
-    if ($show_migration_progress) { ?>
+	if ($show_migration_progress) { ?>
         <div id='migration-monitor' <?php if ($show_backup_db_text) :
-            ?>style="display:none"<?php
-                                    endif; ?>>
+			?>style="display:none"<?php
+									endif; ?>>
             <?php if ($show_backup_db_text) { ?>
                 <p>
                     <a class="toggle-migration-monitor small-text" style="cursor: pointer;">
@@ -182,19 +182,19 @@ 
 
                 </p>
                 <?php
-            } ?>
+			} ?>
             <div id='progress-area'>
                 <h3 class="espresso-header ee-status-bg--info">
                     <?php
-                    echo sprintf(
-                        _n(
-                            "The following task needs to be performed:",
-                            "The following %s tasks need to be performed:",
-                            count($script_names),
-                            "event_espresso"
-                        ),
-                        count($script_names)
-                    ); ?>
+					echo sprintf(
+						_n(
+							"The following task needs to be performed:",
+							"The following %s tasks need to be performed:",
+							count($script_names),
+							"event_espresso"
+						),
+						count($script_names)
+					); ?>
                 </h3>
                 <ul style="list-style: inside;">
                     <?php foreach ($script_names as $script_name) { ?>
@@ -205,9 +205,9 @@ 
                 <?php if (count($script_names) > 1) { ?>
                     <p>
                         <?php esc_html_e(
-                            "Please note: after each task is completed you will need to continue the Database Update, or report an error to Event Espresso.",
-                            "event_espresso"
-                        ); ?>
+							"Please note: after each task is completed you will need to continue the Database Update, or report an error to Event Espresso.",
+							"event_espresso"
+						); ?>
                     </p>
                 <?php } ?>
 
@@ -218,19 +218,19 @@ 
                         </span>
                         <br />
                         <?php esc_html_e(
-                            "Depending on the number of events and the complexity of the information in your database, this could take a few minutes.",
-                            "event_espresso"
-                        ); ?>
+							"Depending on the number of events and the complexity of the information in your database, this could take a few minutes.",
+							"event_espresso"
+						); ?>
                     </p>
                     <p>
                         <?php printf(
-                            esc_html__(
-                                "%sPlease be patient and do NOT navigate away from this page once the migration has begun%s. If any issues arise due to existing malformed data, an itemized report will be made available to you after the migration has completed.",
-                                "event_espresso"
-                            ),
-                            '<strong>',
-                            '</strong>'
-                        ); ?>
+							esc_html__(
+								"%sPlease be patient and do NOT navigate away from this page once the migration has begun%s. If any issues arise due to existing malformed data, an itemized report will be made available to you after the migration has completed.",
+								"event_espresso"
+							),
+							'<strong>',
+							'</strong>'
+						); ?>
                     </p>
                     <p>
                         <?php esc_html_e("Click the button below to begin the migration process.", "event_espresso") ?>
@@ -246,10 +246,10 @@ 
 
                 <button id='start-migration' class='button button--primary'>
                     <?php echo esc_html(
-                        $show_continue_current_migration_script
-                            ? __("Continue Database Update", "event_espresso")
-                            : __("Begin Database Update", "event_espresso")
-                    ); ?>
+						$show_continue_current_migration_script
+							? __("Continue Database Update", "event_espresso")
+							: __("Begin Database Update", "event_espresso")
+					); ?>
                 </button>
                 <br class="clear" />
 
@@ -265,9 +265,9 @@ 
         </div>
 
         <?php
-    }
-    if ($show_maintenance_switch) {
-        ?>
+	}
+	if ($show_maintenance_switch) {
+		?>
         <h2>
             <span class="dashicons dashicons-admin-tools"></span>
             <?php esc_html_e('Set Event Espresso Maintenance Mode', 'event_espresso'); ?>
@@ -290,9 +290,9 @@ 
                             </label>
                             <p class='description' style="font-weight: normal;">
                                 <?php esc_html_e(
-                                    "This is the normal operating mode for Event Espresso and allows all functionality to be viewed by all site visitors.",
-                                    "event_espresso"
-                                ); ?>
+									"This is the normal operating mode for Event Espresso and allows all functionality to be viewed by all site visitors.",
+									"event_espresso"
+								); ?>
                             </p>
                         </th>
                     </tr>
@@ -311,9 +311,9 @@ 
                             </label>
                             <p class='description' style="font-weight: normal;">
                                 <?php esc_html_e(
-                                    "This disables Event Espresso frontend functionality for all site visitors that are not administrators, and allows you to configure and/or test things on the frontend of your website before others can see.",
-                                    "event_espresso"
-                                ); ?>
+									"This disables Event Espresso frontend functionality for all site visitors that are not administrators, and allows you to configure and/or test things on the frontend of your website before others can see.",
+									"event_espresso"
+								); ?>
                             </p>
                         </th>
                     </tr>
@@ -327,6 +327,6 @@ 
             </p>
         </form>
         <?php
-    } ?>
+	} ?>
 
 </div>