eventespresso / event-espresso-core

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +544 added lines, -544 removed lines

@@ -12,548 +12,548 @@
  */
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url = '';
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-    /**
-     * number of decimal places to round numbers to when performing calculations
-     *
-     * @var integer
-     */
-    protected $decimal_precision = 6;
-
-    /**
-     * @var ItemizedOrder
-     * @since $VID:$
-     */
-    protected $itemized_order;
-
-    /**
-     * @var TokenRequest
-     * @since $VID:$
-     */
-    protected $token_request;
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        require_once 'polyfills.php';
-        $this->_currencies_supported = [
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-            'INR',
-        ];
-        parent::__construct();
-        $this->decimal_precision = EE_Registry::instance()->CFG->currency->dec_plc;
-    }
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings(array $settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = [],
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $this->validatePayment($payment)) {
-            return $payment;
-        }
-        if (! $this->validateTransaction($payment)) {
-            return $payment;
-        }
-        $this->token_request = new TokenRequest($this->_get_gateway_formatter());
-        $token_request_details = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $this->token_request->generateDetails(
-                $payment,
-                $this->getOrderItems($payment),
-                $return_url ?? '',
-                $cancel_url ?? '',
-                $this->_image_url ?? '',
-                $this->_request_shipping_addr ?? ''
-            ),
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_details, 'Payment Token', $payment);
-        $token_request_status   = $this->_ppExpress_check_response($token_request_response);
-        $this->token_request->processResponse($payment, $token_request_status, $this->isInSandboxMode());
-
-        return $payment;
-    }
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string           $status      an EEMI_Payment status
-     *                                     }
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws Exception
-     */
-    public function handle_payment_update($update_info, $transaction): EE_Payment
-    {
-        // if the supplied transaction is valid, we'll retrieve the actual payment object from it
-        // but we'll use a temporary payment for now that we can return with errors if things go wrong
-        $payment = EE_Payment::new_instance();
-        if (! $this->validateTransaction($payment, $transaction)) {
-            return $payment;
-        }
-        $payment = $transaction->last_payment();
-        if (! $this->validatePayment($payment)) {
-            return $payment;
-        }
-        // payment appears to be good... so far
-        $this->log(['Return from Authorization' => $update_info], $payment);
-        $payment_token = $this->getPaymentToken($payment);
-        $customer_details = $this->requestCustomerDetails($payment, $payment_token);
-        // We got the PayerID so now we can Complete the transaction.
-        $this->processPayment($payment, $payment_token, $customer_details);
-
-        return $payment;
-    }
-
-
-    /**
-     * @throws Exception
-     */
-    private function getOrderItems(EE_Payment $payment, array $request_response_args = []): array
-    {
-        $this->itemized_order = new ItemizedOrder($this->_get_gateway_formatter());
-        try {
-            $itemized_order = $this->itemized_order->getExistingItemizedOrder($request_response_args);
-        } catch (Exception $exception) {
-            if (WP_DEBUG) {
-                throw $exception;
-            }
-            // Reset the list and log an error, maybe allow to try and generate a new list (below).
-            $itemized_order = [];
-            $this->log(
-                [
-                    esc_html__(
-                        'Could not generate a proper item list with:',
-                        'event_espresso'
-                    ) => $request_response_args,
-                ],
-                $payment
-            );
-        }
-        if (empty($itemized_order)) {
-            $itemized_order = $this->itemized_order->generateItemizedOrder($payment);
-        }
-        return $itemized_order;
-    }
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EE_Payment $payment
-     * @return array|WP_Error
-     */
-    public function _ppExpress_request(array $request_params, string $request_text, EE_Payment $payment)
-    {
-        $request_dtls = [
-            'VERSION'      => '204.0',
-            'USER'         => $this->_api_username,
-            'PWD'          => $this->_api_password,
-            'SIGNATURE'    => $this->_api_signature,
-            // EE will blow up if you change this
-            'BUTTONSOURCE' => 'EventEspresso_SP',
-        ];
-        $dtls         = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            [
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => [],
-                'headers'     => [],
-                'body'        => http_build_query($dtls),
-            ]
-        );
-        // Log the response.
-        $this->log([$request_text . ' Response' => $request_response], $payment);
-        return $request_response;
-    }
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response): array
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return ['status' => false, 'args' => $request_response];
-        }
-        $response_args = [];
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return ['status' => false, 'args' => $request_response];
-        }
-        if (
-            (
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], ['Success', 'SuccessWithWarning'], true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return ['status' => true, 'args' => $response_args];
-        }
-        $errors = $this->_get_errors($response_args);
-        return ['status' => false, 'args' => $errors];
-    }
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EE_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request(array $request, EE_Payment $payment, string $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log([$info => $cleaned_request_data], $payment);
-    }
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors(array $data_array): array
-    {
-        $errors = [];
-        $n      = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code    = $data_array[ "L_ERRORCODE{$n}" ] ?? '';
-            $l_severity_code = $data_array[ "L_SEVERITYCODE{$n}" ] ?? '';
-            $l_short_message = $data_array[ "L_SHORTMESSAGE{$n}" ] ?? '';
-            $l_long_message  = $data_array[ "L_LONGMESSAGE{$n}" ] ?? '';
-            if ($n === 0) {
-                $errors = [
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                ];
-            } else {
-                $errors['L_ERRORCODE']    .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE']  .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @return mixed|null
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function getPaymentToken(EE_Payment $payment)
-    {
-        $payment_details = $payment->details();
-        // Check if we still have the token.
-        if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-            $payment->set_status($this->_pay_model->failed_status());
-            return null;
-        }
-        return $payment_details['TOKEN'];
-    }
-
-    /**
-     * @param EE_Payment $payment
-     * @param array      $checkout_response
-     * @param array      $customer_data
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    private function paymentApproved(EE_Payment $payment, array $checkout_response, array $customer_data)
-    {
-        $primary_registrant = $payment->transaction()->primary_registration();
-        $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-            $primary_registrant->reg_code()
-            : '';
-        $payment->set_extra_accntng($primary_registration_code);
-        $payment_amount = $checkout_response['PAYMENTINFO_0_AMT'] ?? 0;
-        $payment->set_amount((float) $payment_amount);
-        $payment->set_txn_id_chq_nmbr($checkout_response['PAYMENTINFO_0_TRANSACTIONID'] ?? null);
-        $payment->set_details($customer_data);
-        $payment->set_gateway_response($checkout_response['PAYMENTINFO_0_ACK'] ?? '');
-        $payment->set_status($this->_pay_model->approved_status());
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param array      $checkout_response
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function paymentDeclined(EE_Payment $payment, array $checkout_response)
-    {
-        $gateway_response = isset($checkout_response['L_ERRORCODE'])
-            ? $checkout_response['L_ERRORCODE'] . '; ' . $checkout_response['L_SHORTMESSAGE']
-            : esc_html__('Error occurred while trying to Capture the funds.', 'event_espresso');
-
-        $payment->set_gateway_response($gateway_response);
-        $payment->set_details($checkout_response);
-        $payment->set_status($this->_pay_model->declined_status());
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param array $customer_data
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function paymentFailed(EE_Payment $payment, array $customer_data)
-    {
-        $gateway_response = isset($customer_data['L_ERRORCODE'])
-            ? $customer_data['L_ERRORCODE'] . '; ' . $customer_data['L_SHORTMESSAGE']
-            : esc_html__('Error occurred while trying to get payment Details from PayPal.', 'event_espresso');
-
-        $payment->set_gateway_response($gateway_response);
-        $payment->set_details($customer_data);
-        $payment->set_status($this->_pay_model->failed_status());
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param string     $payment_token
-     * @param array      $customer_details
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     * @since   $VID:$
-     */
-    private function processPayment(EE_Payment $payment, string $payment_token, array $customer_details)
-    {
-        $checkout_request_dtls = [
-            'METHOD'                         => 'DoExpressCheckoutPayment',
-            'PAYERID'                        => $customer_details['PAYERID'],
-            'TOKEN'                          => $payment_token,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-        ];
-        // Include itemized list.
-        $itemized_list         = $this->getOrderItems($payment, $customer_details);
-        $checkout_request_dtls = array_merge($checkout_request_dtls, $itemized_list);
-        // Payment Checkout/Capture.
-        $checkout_request_response = $this->_ppExpress_request(
-            $checkout_request_dtls,
-            'Do Payment',
-            $payment
-        );
-        $checkout_request_status   = $this->_ppExpress_check_response($checkout_request_response);
-        $checkout_response         =
-            isset($checkout_request_status['args']) && is_array($checkout_request_status['args'])
-                ? $checkout_request_status['args']
-                : [];
-        if ($checkout_request_status['status']) {
-            // All is well, payment approved.
-            $this->paymentApproved($payment, $checkout_response, $customer_details);
-        } else {
-            $this->paymentDeclined($payment, $checkout_response);
-        }
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param string $payment_token
-     * @return array
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function requestCustomerDetails(EE_Payment $payment, string $payment_token): array
-    {
-        $customer_details_request_dtls = [
-            'METHOD' => 'GetExpressCheckoutDetails',
-            'TOKEN'  => $payment_token,
-        ];
-        // Request Customer Details.
-        $customer_details_request_response = $this->_ppExpress_request(
-            $customer_details_request_dtls,
-            'Customer Details',
-            $payment
-        );
-        $customer_details_rstatus          = $this->_ppExpress_check_response($customer_details_request_response);
-        $customer_details = isset($customer_details_rstatus['args']) && is_array($customer_details_rstatus['args'])
-            ? $customer_details_rstatus['args']
-            : [];
-        if (! $customer_details_rstatus['status']) {
-            $this->paymentFailed($payment, $customer_details);
-        }
-        return $customer_details;
-    }
-
-
-
-    /**
-     * @param EE_Payment|null $payment
-     * @return bool
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function validatePayment(?EE_Payment $payment): bool
-    {
-        if (! $payment instanceof EE_Payment) {
-            $payment = EE_Payment::new_instance();
-            $payment->set_gateway_response(
-                esc_html__(
-                    'An error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Payment          $payment
-     * @param EE_Transaction|null $transaction
-     * @return bool
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function validateTransaction(EE_Payment $payment, ?EE_Transaction $transaction = null): bool
-    {
-        $transaction = $transaction ?? $payment->transaction();
-        if (! $transaction instanceof EE_Transaction) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url = '';
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+	/**
+	 * number of decimal places to round numbers to when performing calculations
+	 *
+	 * @var integer
+	 */
+	protected $decimal_precision = 6;
+
+	/**
+	 * @var ItemizedOrder
+	 * @since $VID:$
+	 */
+	protected $itemized_order;
+
+	/**
+	 * @var TokenRequest
+	 * @since $VID:$
+	 */
+	protected $token_request;
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		require_once 'polyfills.php';
+		$this->_currencies_supported = [
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+			'INR',
+		];
+		parent::__construct();
+		$this->decimal_precision = EE_Registry::instance()->CFG->currency->dec_plc;
+	}
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings(array $settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = [],
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $this->validatePayment($payment)) {
+			return $payment;
+		}
+		if (! $this->validateTransaction($payment)) {
+			return $payment;
+		}
+		$this->token_request = new TokenRequest($this->_get_gateway_formatter());
+		$token_request_details = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$this->token_request->generateDetails(
+				$payment,
+				$this->getOrderItems($payment),
+				$return_url ?? '',
+				$cancel_url ?? '',
+				$this->_image_url ?? '',
+				$this->_request_shipping_addr ?? ''
+			),
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_details, 'Payment Token', $payment);
+		$token_request_status   = $this->_ppExpress_check_response($token_request_response);
+		$this->token_request->processResponse($payment, $token_request_status, $this->isInSandboxMode());
+
+		return $payment;
+	}
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string           $status      an EEMI_Payment status
+	 *                                     }
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws Exception
+	 */
+	public function handle_payment_update($update_info, $transaction): EE_Payment
+	{
+		// if the supplied transaction is valid, we'll retrieve the actual payment object from it
+		// but we'll use a temporary payment for now that we can return with errors if things go wrong
+		$payment = EE_Payment::new_instance();
+		if (! $this->validateTransaction($payment, $transaction)) {
+			return $payment;
+		}
+		$payment = $transaction->last_payment();
+		if (! $this->validatePayment($payment)) {
+			return $payment;
+		}
+		// payment appears to be good... so far
+		$this->log(['Return from Authorization' => $update_info], $payment);
+		$payment_token = $this->getPaymentToken($payment);
+		$customer_details = $this->requestCustomerDetails($payment, $payment_token);
+		// We got the PayerID so now we can Complete the transaction.
+		$this->processPayment($payment, $payment_token, $customer_details);
+
+		return $payment;
+	}
+
+
+	/**
+	 * @throws Exception
+	 */
+	private function getOrderItems(EE_Payment $payment, array $request_response_args = []): array
+	{
+		$this->itemized_order = new ItemizedOrder($this->_get_gateway_formatter());
+		try {
+			$itemized_order = $this->itemized_order->getExistingItemizedOrder($request_response_args);
+		} catch (Exception $exception) {
+			if (WP_DEBUG) {
+				throw $exception;
+			}
+			// Reset the list and log an error, maybe allow to try and generate a new list (below).
+			$itemized_order = [];
+			$this->log(
+				[
+					esc_html__(
+						'Could not generate a proper item list with:',
+						'event_espresso'
+					) => $request_response_args,
+				],
+				$payment
+			);
+		}
+		if (empty($itemized_order)) {
+			$itemized_order = $this->itemized_order->generateItemizedOrder($payment);
+		}
+		return $itemized_order;
+	}
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EE_Payment $payment
+	 * @return array|WP_Error
+	 */
+	public function _ppExpress_request(array $request_params, string $request_text, EE_Payment $payment)
+	{
+		$request_dtls = [
+			'VERSION'      => '204.0',
+			'USER'         => $this->_api_username,
+			'PWD'          => $this->_api_password,
+			'SIGNATURE'    => $this->_api_signature,
+			// EE will blow up if you change this
+			'BUTTONSOURCE' => 'EventEspresso_SP',
+		];
+		$dtls         = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			[
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => [],
+				'headers'     => [],
+				'body'        => http_build_query($dtls),
+			]
+		);
+		// Log the response.
+		$this->log([$request_text . ' Response' => $request_response], $payment);
+		return $request_response;
+	}
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response): array
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return ['status' => false, 'args' => $request_response];
+		}
+		$response_args = [];
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return ['status' => false, 'args' => $request_response];
+		}
+		if (
+			(
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], ['Success', 'SuccessWithWarning'], true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return ['status' => true, 'args' => $response_args];
+		}
+		$errors = $this->_get_errors($response_args);
+		return ['status' => false, 'args' => $errors];
+	}
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EE_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request(array $request, EE_Payment $payment, string $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log([$info => $cleaned_request_data], $payment);
+	}
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors(array $data_array): array
+	{
+		$errors = [];
+		$n      = 0;
+		while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
+			$l_error_code    = $data_array[ "L_ERRORCODE{$n}" ] ?? '';
+			$l_severity_code = $data_array[ "L_SEVERITYCODE{$n}" ] ?? '';
+			$l_short_message = $data_array[ "L_SHORTMESSAGE{$n}" ] ?? '';
+			$l_long_message  = $data_array[ "L_LONGMESSAGE{$n}" ] ?? '';
+			if ($n === 0) {
+				$errors = [
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				];
+			} else {
+				$errors['L_ERRORCODE']    .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE']  .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @return mixed|null
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function getPaymentToken(EE_Payment $payment)
+	{
+		$payment_details = $payment->details();
+		// Check if we still have the token.
+		if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+			$payment->set_status($this->_pay_model->failed_status());
+			return null;
+		}
+		return $payment_details['TOKEN'];
+	}
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $checkout_response
+	 * @param array      $customer_data
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	private function paymentApproved(EE_Payment $payment, array $checkout_response, array $customer_data)
+	{
+		$primary_registrant = $payment->transaction()->primary_registration();
+		$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+			$primary_registrant->reg_code()
+			: '';
+		$payment->set_extra_accntng($primary_registration_code);
+		$payment_amount = $checkout_response['PAYMENTINFO_0_AMT'] ?? 0;
+		$payment->set_amount((float) $payment_amount);
+		$payment->set_txn_id_chq_nmbr($checkout_response['PAYMENTINFO_0_TRANSACTIONID'] ?? null);
+		$payment->set_details($customer_data);
+		$payment->set_gateway_response($checkout_response['PAYMENTINFO_0_ACK'] ?? '');
+		$payment->set_status($this->_pay_model->approved_status());
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $checkout_response
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function paymentDeclined(EE_Payment $payment, array $checkout_response)
+	{
+		$gateway_response = isset($checkout_response['L_ERRORCODE'])
+			? $checkout_response['L_ERRORCODE'] . '; ' . $checkout_response['L_SHORTMESSAGE']
+			: esc_html__('Error occurred while trying to Capture the funds.', 'event_espresso');
+
+		$payment->set_gateway_response($gateway_response);
+		$payment->set_details($checkout_response);
+		$payment->set_status($this->_pay_model->declined_status());
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array $customer_data
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function paymentFailed(EE_Payment $payment, array $customer_data)
+	{
+		$gateway_response = isset($customer_data['L_ERRORCODE'])
+			? $customer_data['L_ERRORCODE'] . '; ' . $customer_data['L_SHORTMESSAGE']
+			: esc_html__('Error occurred while trying to get payment Details from PayPal.', 'event_espresso');
+
+		$payment->set_gateway_response($gateway_response);
+		$payment->set_details($customer_data);
+		$payment->set_status($this->_pay_model->failed_status());
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param string     $payment_token
+	 * @param array      $customer_details
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 * @since   $VID:$
+	 */
+	private function processPayment(EE_Payment $payment, string $payment_token, array $customer_details)
+	{
+		$checkout_request_dtls = [
+			'METHOD'                         => 'DoExpressCheckoutPayment',
+			'PAYERID'                        => $customer_details['PAYERID'],
+			'TOKEN'                          => $payment_token,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+		];
+		// Include itemized list.
+		$itemized_list         = $this->getOrderItems($payment, $customer_details);
+		$checkout_request_dtls = array_merge($checkout_request_dtls, $itemized_list);
+		// Payment Checkout/Capture.
+		$checkout_request_response = $this->_ppExpress_request(
+			$checkout_request_dtls,
+			'Do Payment',
+			$payment
+		);
+		$checkout_request_status   = $this->_ppExpress_check_response($checkout_request_response);
+		$checkout_response         =
+			isset($checkout_request_status['args']) && is_array($checkout_request_status['args'])
+				? $checkout_request_status['args']
+				: [];
+		if ($checkout_request_status['status']) {
+			// All is well, payment approved.
+			$this->paymentApproved($payment, $checkout_response, $customer_details);
+		} else {
+			$this->paymentDeclined($payment, $checkout_response);
+		}
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param string $payment_token
+	 * @return array
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function requestCustomerDetails(EE_Payment $payment, string $payment_token): array
+	{
+		$customer_details_request_dtls = [
+			'METHOD' => 'GetExpressCheckoutDetails',
+			'TOKEN'  => $payment_token,
+		];
+		// Request Customer Details.
+		$customer_details_request_response = $this->_ppExpress_request(
+			$customer_details_request_dtls,
+			'Customer Details',
+			$payment
+		);
+		$customer_details_rstatus          = $this->_ppExpress_check_response($customer_details_request_response);
+		$customer_details = isset($customer_details_rstatus['args']) && is_array($customer_details_rstatus['args'])
+			? $customer_details_rstatus['args']
+			: [];
+		if (! $customer_details_rstatus['status']) {
+			$this->paymentFailed($payment, $customer_details);
+		}
+		return $customer_details;
+	}
+
+
+
+	/**
+	 * @param EE_Payment|null $payment
+	 * @return bool
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function validatePayment(?EE_Payment $payment): bool
+	{
+		if (! $payment instanceof EE_Payment) {
+			$payment = EE_Payment::new_instance();
+			$payment->set_gateway_response(
+				esc_html__(
+					'An error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Payment          $payment
+	 * @param EE_Transaction|null $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function validateTransaction(EE_Payment $payment, ?EE_Transaction $transaction = null): bool
+	{
+		$transaction = $transaction ?? $payment->transaction();
+		if (! $transaction instanceof EE_Transaction) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return false;
+		}
+		return true;
+	}
 }

modules/ticket_selector/DisplayTicketSelector.php

Indentation +863 added lines, -863 removed lines

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

core/EE_System.core.php

Indentation +1230 added lines, -1230 removed lines

@@ -24,1234 +24,1234 @@
  */
 final class EE_System implements ResettableInterface
 {
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we're in maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-    /**
-     * @var AddonManager $addon_manager
-     */
-    private $addon_manager;
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * @var Router $router
-     */
-    private $router;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
-     */
-    private $register_custom_post_types;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
-     */
-    private $register_custom_taxonomies;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
-     */
-    private $register_custom_taxonomy_terms;
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface|null     $loader
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @param EE_Registry|null         $registry
-     * @param RequestInterface|null    $request
-     * @param Router|null              $router
-     * @return EE_System
-     */
-    public static function instance(
-        LoaderInterface $loader = null,
-        EE_Maintenance_Mode $maintenance_mode = null,
-        EE_Registry $registry = null,
-        RequestInterface $request = null,
-        Router $router = null
-    ): EE_System {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset(): EE_System
-    {
-        self::$_instance->_req_type = null;
-        // make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        // we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param LoaderInterface     $loader
-     * @param EE_Maintenance_Mode $maintenance_mode
-     * @param EE_Registry         $registry
-     * @param RequestInterface    $request
-     * @param Router              $router
-     */
-    private function __construct(
-        LoaderInterface $loader,
-        EE_Maintenance_Mode $maintenance_mode,
-        EE_Registry $registry,
-        RequestInterface $request,
-        Router $router
-    ) {
-        $this->registry         = $registry;
-        $this->loader           = $loader;
-        $this->request          = $request;
-        $this->router           = $router;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadCapabilities'],
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadCommandBus'],
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadPluginApi'],
-            9
-        );
-        // give caff stuff a chance to play during the activation process too.
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'brewCaffeinated'],
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'load_espresso_addons']
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', [$this, 'load_espresso_addons'], 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            [$this, 'detect_activations_or_upgrades'],
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'load_core_configuration'],
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'loadRouteMatchSpecifications']
-        );
-        // load specifications for custom post types
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadCustomPostTypes')
-        );
-        // load specifications for custom post types
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadCustomPostTypes')
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            [$this, 'register_shortcodes_modules_and_widgets'],
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            [$this, 'brew_espresso'],
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            [$this, 'remove_pages_from_wp_list_pages'],
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
-                LoaderFactory::getLoader()->getShared('EventEspresso\PaymentMethods\Manager');
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     * CommandBus middleware operate FIFO - First In First Out
-     * so LocateMovedCommands will run first in order to return any new commands
-     *
-     * @return void
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            [
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    [
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws Exception
-     */
-    public function loadPluginApi()
-    {
-        $this->addon_manager = $this->loader->getShared(AddonManager::class);
-        $this->addon_manager->initialize();
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws EE_Error
-     */
-    public function brewCaffeinated()
-    {
-        static $brew;
-        /** @var Domain $domain */
-        $domain = DomainFactory::getEventEspressoCoreDomain();
-        if ($domain->isCaffeinated() && ! $brew instanceof EE_Brewing_Regular) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-            /** @var EE_Brewing_Regular $brew */
-            $brew = LoaderFactory::getLoader()->getShared(EE_Brewing_Regular::class);
-            $brew->initializePUE();
-            add_action(
-                'AHEE__EE_System__load_core_configuration__begin',
-                [$brew, 'caffeinated']
-            );
-        }
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function load_espresso_addons()
-    {
-        // looking for hooks? they've been moved into the AddonManager to maintain compatibility
-        $this->addon_manager->loadAddons();
-    }
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        // first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                // detect teh request type for that addon
-                $addon->detect_req_type();
-            }
-        }
-    }
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type       = $this->detect_req_type($espresso_db_update);
-        // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                // migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                // its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change(array $espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = [];
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = [$espresso_db_update => []];
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = [];
-            // if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    // the key is an int, and the value IS NOT an array
-                    // so it must be numerically-indexed, where values are versions installed...
-                    // fix it!
-                    $version_string                         = $should_be_array;
-                    $corrected_db_update[ $version_string ] = ['unknown-date'];
-                } else {
-                    // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return ! empty($espresso_db_update) ? $espresso_db_update : [];
-    }
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        // only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = $this->loader->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if (
-            $request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', [$this, 'redirect_to_about_ee'], 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_addons()
-    {
-        // foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param array  $version_history
-     * @param string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null): int
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update          = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type             = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation',
-                espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history): bool
-    {
-        $previous_version       = EE_System::getMostRecentlyActiveVersion($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts  = explode('.', espresso_version());
-        return isset(
-            $previous_version_parts[0],
-            $previous_version_parts[1],
-            $current_version_parts[0],
-            $current_version_parts[1]
-        ) && (
-            $previous_version_parts[0] !== $current_version_parts[0]
-            || $previous_version_parts[1] !== $current_version_parts[1]
-        );
-    }
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change(): bool
-    {
-        return $this->_major_version_change;
-    }
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array|null $activation_history             the option's value which stores the activation history for
-     *                                                 this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $current_version                  the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public static function detect_req_type_given_activation_history(
-        array $activation_history,
-        string $activation_indicator_option_name,
-        string $current_version
-    ): int {
-        $version_change = self::compareVersionWithPrevious($activation_history, $current_version);
-        $is_activation  = get_option($activation_indicator_option_name, false);
-        $req_type       = self::getRequestType($activation_history, $version_change, $is_activation);
-        if ($is_activation) {
-            // cleanup in aisle 6
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * @param array  $activation_history
-     * @param int    $version_change
-     * @param bool   $is_activation
-     * @return int
-     * @since $VID:$
-     */
-    private static function getRequestType(array $activation_history, int $version_change, bool $is_activation): int
-    {
-        // if no previous activation history exists, then this is a brand new install
-        if (empty($activation_history)) {
-            return EE_System::req_type_new_activation;
-        }
-        // current version is higher than previous version, so it's an upgrade
-        if ($version_change === 1) {
-            return EE_System::req_type_upgrade;
-        }
-        // current version is lower than previous version, so it's a downgrade
-        if ($version_change === -1) {
-            return EE_System::req_type_downgrade;
-        }
-        // version hasn't changed since last version so check if the activation indicator is set
-        // to determine if it's a reactivation, or just a normal request
-        return $is_activation
-            ? EE_System::req_type_reactivation
-            : EE_System::req_type_normal;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history    array where keys are versions,
-     *                                      values are arrays of times activated (sometimes 'unknown-date')
-     * @param string $current_version
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                      -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                      0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                      1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function compareVersionWithPrevious(array $activation_history, string $current_version): int
-    {
-        // find the most recently-activated version
-        $most_recently_active_version = EE_System::getMostRecentlyActiveVersion($activation_history);
-        return version_compare($current_version, $most_recently_active_version);
-    }
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function getMostRecentlyActiveVersion(array $activation_history): string
-    {
-        $most_recent_activation_date  = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $activation_dates) {
-                // check there is a record of when this version was activated.
-                // Otherwise, mark it as unknown
-                if (! $activation_dates) {
-                    $activation_dates = ['unknown-date'];
-                }
-                $activation_dates = is_string($activation_dates) ? [$activation_dates] : $activation_dates;
-                foreach ($activation_dates as $activation_date) {
-                    if ($activation_date !== 'unknown-date' && $activation_date > $most_recent_activation_date) {
-                        $most_recently_active_version = $version;
-                        $most_recent_activation_date  = $activation_date;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        // if current user is an admin and it's not an ajax or rest request
-        if (
-            ! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = ['page' => 'espresso_about'];
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            EEH_URL::safeRedirectAndExit($url);
-        }
-    }
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        // load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        $this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
-        if ($config->admin->use_remote_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        // configure custom post type definitions
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        // get all the files in the EE_MODELS folder that end in .model.php
-        $models                 = glob(EE_MODELS . '*.model.php');
-        $model_names            = [];
-        $non_abstract_db_models = [];
-        foreach ($models as $model) {
-            // get model classname
-            $classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name      = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-    /**
-     * @throws Exception
-     * @since 4.9.71.p
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared('EventEspresso\core\services\routing\RouteMatchSpecificationManager');
-            $this->loader->getShared('EventEspresso\core\services\routing\RouteCollection');
-            $this->router->loadPrimaryRoutes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * loading CPT related classes earlier so that their definitions are available
-     * but not performing any actual registration with WP core until load_CPTs_and_session() is called
-     *
-     * @since   4.10.21.p
-     */
-    public function loadCustomPostTypes()
-    {
-        $this->register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $this->register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $this->register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        // load legacy EE_Request_Handler in case add-ons still need it
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        $this->router->registerShortcodesModulesAndWidgets();
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = esc_html__(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - '
-                        . str_replace(
-                            ['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= esc_html__(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', [$this, 'set_hooks_for_core'], 1);
-        add_action('init', [$this, 'perform_activations_upgrades_and_migrations'], 3);
-        add_action('init', [$this, 'load_CPTs_and_session'], 5);
-        add_action('init', [$this, 'load_controllers'], 7);
-        add_action('init', [$this, 'core_loaded_and_ready'], 9);
-        add_action('init', [$this, 'initialize'], 10);
-        add_action('init', [$this, 'initialize_last'], 100);
-        $this->router->brewEspresso();
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        // caps need to be initialized on every request so that capability maps are set.
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', []);
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', []);
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        $this->request->unSetRequestParams(['activate'], true);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        $this->register_custom_taxonomies->registerCustomTaxonomies();
-        $this->register_custom_post_types->registerCustomPostTypes();
-        $this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
-        // load legacy Custom Post Types and Taxonomies
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        $this->router->loadControllers();
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function core_loaded_and_ready()
-    {
-        $this->router->coreLoadedAndReady();
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // always load template tags, because it's faster than checking if it's a front-end request, and many page
-        // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-    }
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-        add_filter(
-            'safe_style_css',
-            function ($styles) {
-                $styles[] = 'display';
-                $styles[] = 'visibility';
-                $styles[] = 'position';
-                $styles[] = 'top';
-                $styles[] = 'right';
-                $styles[] = 'bottom';
-                $styles[] = 'left';
-                $styles[] = 'resize';
-                $styles[] = 'max-width';
-                $styles[] = 'max-height';
-                return $styles;
-            }
-        );
-    }
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function initialize_last()
-    {
-        $this->router->initializeLast();
-        do_action('AHEE__EE_System__initialize_last');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-        $rewrite_rules = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-        );
-        $rewrite_rules->flushRewriteRules();
-        add_action('admin_bar_init', [$this, 'addEspressoToolbar']);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            [$this->registry->CAP]
-        );
-    }
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', ['EE_System', 'nocache_headers'], 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', ['EE_System', 'extra_nocache_headers'], 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers): array
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages(array $exclude_array): array
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we're in maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+	/**
+	 * @var AddonManager $addon_manager
+	 */
+	private $addon_manager;
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * @var Router $router
+	 */
+	private $router;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
+	 */
+	private $register_custom_post_types;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
+	 */
+	private $register_custom_taxonomies;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
+	 */
+	private $register_custom_taxonomy_terms;
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface|null     $loader
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @param EE_Registry|null         $registry
+	 * @param RequestInterface|null    $request
+	 * @param Router|null              $router
+	 * @return EE_System
+	 */
+	public static function instance(
+		LoaderInterface $loader = null,
+		EE_Maintenance_Mode $maintenance_mode = null,
+		EE_Registry $registry = null,
+		RequestInterface $request = null,
+		Router $router = null
+	): EE_System {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset(): EE_System
+	{
+		self::$_instance->_req_type = null;
+		// make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		// we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param LoaderInterface     $loader
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 * @param EE_Registry         $registry
+	 * @param RequestInterface    $request
+	 * @param Router              $router
+	 */
+	private function __construct(
+		LoaderInterface $loader,
+		EE_Maintenance_Mode $maintenance_mode,
+		EE_Registry $registry,
+		RequestInterface $request,
+		Router $router
+	) {
+		$this->registry         = $registry;
+		$this->loader           = $loader;
+		$this->request          = $request;
+		$this->router           = $router;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadCapabilities'],
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadCommandBus'],
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadPluginApi'],
+			9
+		);
+		// give caff stuff a chance to play during the activation process too.
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'brewCaffeinated'],
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'load_espresso_addons']
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', [$this, 'load_espresso_addons'], 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			[$this, 'detect_activations_or_upgrades'],
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'load_core_configuration'],
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'loadRouteMatchSpecifications']
+		);
+		// load specifications for custom post types
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadCustomPostTypes')
+		);
+		// load specifications for custom post types
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadCustomPostTypes')
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			[$this, 'register_shortcodes_modules_and_widgets'],
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			[$this, 'brew_espresso'],
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			[$this, 'remove_pages_from_wp_list_pages'],
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function () {
+				LoaderFactory::getLoader()->getShared('EventEspresso\PaymentMethods\Manager');
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 * CommandBus middleware operate FIFO - First In First Out
+	 * so LocateMovedCommands will run first in order to return any new commands
+	 *
+	 * @return void
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			[
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					[
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws Exception
+	 */
+	public function loadPluginApi()
+	{
+		$this->addon_manager = $this->loader->getShared(AddonManager::class);
+		$this->addon_manager->initialize();
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws EE_Error
+	 */
+	public function brewCaffeinated()
+	{
+		static $brew;
+		/** @var Domain $domain */
+		$domain = DomainFactory::getEventEspressoCoreDomain();
+		if ($domain->isCaffeinated() && ! $brew instanceof EE_Brewing_Regular) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+			/** @var EE_Brewing_Regular $brew */
+			$brew = LoaderFactory::getLoader()->getShared(EE_Brewing_Regular::class);
+			$brew->initializePUE();
+			add_action(
+				'AHEE__EE_System__load_core_configuration__begin',
+				[$brew, 'caffeinated']
+			);
+		}
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function load_espresso_addons()
+	{
+		// looking for hooks? they've been moved into the AddonManager to maintain compatibility
+		$this->addon_manager->loadAddons();
+	}
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		// first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				// detect teh request type for that addon
+				$addon->detect_req_type();
+			}
+		}
+	}
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type       = $this->detect_req_type($espresso_db_update);
+		// EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				// migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				// its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change(array $espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		// get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = [];
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = [$espresso_db_update => []];
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = [];
+			// if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					// the key is an int, and the value IS NOT an array
+					// so it must be numerically-indexed, where values are versions installed...
+					// fix it!
+					$version_string                         = $should_be_array;
+					$corrected_db_update[ $version_string ] = ['unknown-date'];
+				} else {
+					// ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return ! empty($espresso_db_update) ? $espresso_db_update : [];
+	}
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		// only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = $this->loader->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if (
+			$request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', [$this, 'redirect_to_about_ee'], 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_addons()
+	{
+		// foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param array  $version_history
+	 * @param string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null): int
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update          = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type             = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation',
+				espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history): bool
+	{
+		$previous_version       = EE_System::getMostRecentlyActiveVersion($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts  = explode('.', espresso_version());
+		return isset(
+			$previous_version_parts[0],
+			$previous_version_parts[1],
+			$current_version_parts[0],
+			$current_version_parts[1]
+		) && (
+			$previous_version_parts[0] !== $current_version_parts[0]
+			|| $previous_version_parts[1] !== $current_version_parts[1]
+		);
+	}
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change(): bool
+	{
+		return $this->_major_version_change;
+	}
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array|null $activation_history             the option's value which stores the activation history for
+	 *                                                 this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $current_version                  the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public static function detect_req_type_given_activation_history(
+		array $activation_history,
+		string $activation_indicator_option_name,
+		string $current_version
+	): int {
+		$version_change = self::compareVersionWithPrevious($activation_history, $current_version);
+		$is_activation  = get_option($activation_indicator_option_name, false);
+		$req_type       = self::getRequestType($activation_history, $version_change, $is_activation);
+		if ($is_activation) {
+			// cleanup in aisle 6
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * @param array  $activation_history
+	 * @param int    $version_change
+	 * @param bool   $is_activation
+	 * @return int
+	 * @since $VID:$
+	 */
+	private static function getRequestType(array $activation_history, int $version_change, bool $is_activation): int
+	{
+		// if no previous activation history exists, then this is a brand new install
+		if (empty($activation_history)) {
+			return EE_System::req_type_new_activation;
+		}
+		// current version is higher than previous version, so it's an upgrade
+		if ($version_change === 1) {
+			return EE_System::req_type_upgrade;
+		}
+		// current version is lower than previous version, so it's a downgrade
+		if ($version_change === -1) {
+			return EE_System::req_type_downgrade;
+		}
+		// version hasn't changed since last version so check if the activation indicator is set
+		// to determine if it's a reactivation, or just a normal request
+		return $is_activation
+			? EE_System::req_type_reactivation
+			: EE_System::req_type_normal;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history    array where keys are versions,
+	 *                                      values are arrays of times activated (sometimes 'unknown-date')
+	 * @param string $current_version
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                      -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                      0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                      1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function compareVersionWithPrevious(array $activation_history, string $current_version): int
+	{
+		// find the most recently-activated version
+		$most_recently_active_version = EE_System::getMostRecentlyActiveVersion($activation_history);
+		return version_compare($current_version, $most_recently_active_version);
+	}
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function getMostRecentlyActiveVersion(array $activation_history): string
+	{
+		$most_recent_activation_date  = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $activation_dates) {
+				// check there is a record of when this version was activated.
+				// Otherwise, mark it as unknown
+				if (! $activation_dates) {
+					$activation_dates = ['unknown-date'];
+				}
+				$activation_dates = is_string($activation_dates) ? [$activation_dates] : $activation_dates;
+				foreach ($activation_dates as $activation_date) {
+					if ($activation_date !== 'unknown-date' && $activation_date > $most_recent_activation_date) {
+						$most_recently_active_version = $version;
+						$most_recent_activation_date  = $activation_date;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		// if current user is an admin and it's not an ajax or rest request
+		if (
+			! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = ['page' => 'espresso_about'];
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			EEH_URL::safeRedirectAndExit($url);
+		}
+	}
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		// load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		$this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
+		if ($config->admin->use_remote_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		// configure custom post type definitions
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		// get all the files in the EE_MODELS folder that end in .model.php
+		$models                 = glob(EE_MODELS . '*.model.php');
+		$model_names            = [];
+		$non_abstract_db_models = [];
+		foreach ($models as $model) {
+			// get model classname
+			$classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name      = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+	/**
+	 * @throws Exception
+	 * @since 4.9.71.p
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared('EventEspresso\core\services\routing\RouteMatchSpecificationManager');
+			$this->loader->getShared('EventEspresso\core\services\routing\RouteCollection');
+			$this->router->loadPrimaryRoutes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * loading CPT related classes earlier so that their definitions are available
+	 * but not performing any actual registration with WP core until load_CPTs_and_session() is called
+	 *
+	 * @since   4.10.21.p
+	 */
+	public function loadCustomPostTypes()
+	{
+		$this->register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$this->register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$this->register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		// load legacy EE_Request_Handler in case add-ons still need it
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		$this->router->registerShortcodesModulesAndWidgets();
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = esc_html__(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - '
+						. str_replace(
+							['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= esc_html__(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', [$this, 'set_hooks_for_core'], 1);
+		add_action('init', [$this, 'perform_activations_upgrades_and_migrations'], 3);
+		add_action('init', [$this, 'load_CPTs_and_session'], 5);
+		add_action('init', [$this, 'load_controllers'], 7);
+		add_action('init', [$this, 'core_loaded_and_ready'], 9);
+		add_action('init', [$this, 'initialize'], 10);
+		add_action('init', [$this, 'initialize_last'], 100);
+		$this->router->brewEspresso();
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		// caps need to be initialized on every request so that capability maps are set.
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', []);
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', []);
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						$this->request->unSetRequestParams(['activate'], true);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		$this->register_custom_taxonomies->registerCustomTaxonomies();
+		$this->register_custom_post_types->registerCustomPostTypes();
+		$this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
+		// load legacy Custom Post Types and Taxonomies
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		$this->router->loadControllers();
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function core_loaded_and_ready()
+	{
+		$this->router->coreLoadedAndReady();
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// always load template tags, because it's faster than checking if it's a front-end request, and many page
+		// builders require these even on the front-end
+		require_once EE_PUBLIC . 'template_tags.php';
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+	}
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+		add_filter(
+			'safe_style_css',
+			function ($styles) {
+				$styles[] = 'display';
+				$styles[] = 'visibility';
+				$styles[] = 'position';
+				$styles[] = 'top';
+				$styles[] = 'right';
+				$styles[] = 'bottom';
+				$styles[] = 'left';
+				$styles[] = 'resize';
+				$styles[] = 'max-width';
+				$styles[] = 'max-height';
+				return $styles;
+			}
+		);
+	}
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initialize_last()
+	{
+		$this->router->initializeLast();
+		do_action('AHEE__EE_System__initialize_last');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+		$rewrite_rules = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+		);
+		$rewrite_rules->flushRewriteRules();
+		add_action('admin_bar_init', [$this, 'addEspressoToolbar']);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			[$this->registry->CAP]
+		);
+	}
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', ['EE_System', 'nocache_headers'], 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', ['EE_System', 'extra_nocache_headers'], 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers): array
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages(array $exclude_array): array
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 }

core/admin/EE_Admin_Page_CPT.core.php

Indentation +1421 added lines, -1421 removed lines

@@ -31,455 +31,455 @@ 
  */
 abstract class EE_Admin_Page_CPT extends EE_Admin_Page
 {
-    /**
-     * This gets set in _setup_cpt
-     * It will contain the object for the custom post type.
-     *
-     * @var EE_CPT_Base
-     */
-    protected $_cpt_object;
-
-
-    /**
-     * a boolean flag to set whether the current route is a cpt route or not.
-     *
-     * @var bool
-     */
-    protected $_cpt_route = false;
-
-
-    /**
-     * This property allows cpt classes to define multiple routes as cpt routes.
-     * //in this array we define what the custom post type for this route is.
-     * array(
-     * 'route_name' => 'custom_post_type_slug'
-     * )
-     *
-     * @var array
-     */
-    protected $_cpt_routes = [];
-
-
-    /**
-     * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
-     * in this format:
-     * array(
-     * 'post_type_slug' => 'edit_route'
-     * )
-     *
-     * @var array
-     */
-    protected $_cpt_edit_routes = [];
-
-
-    /**
-     * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
-     * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
-     * _cpt_model_names property should be in the following format: array(
-     * 'route_defined_by_action_param' => 'Model_Name')
-     *
-     * @var array $_cpt_model_names
-     */
-    protected $_cpt_model_names = [];
-
-
-    /**
-     * @var EE_CPT_Base
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
-     * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
-     * the _register_autosave_containers() method so that we don't override any other containers already registered.
-     * Registration of containers should be done before load_page_dependencies() is run.
-     *
-     * @var array()
-     */
-    protected $_autosave_containers = [];
-
-    protected $_autosave_fields     = [];
-
-    /**
-     * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
-     * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
-     *
-     * @var array
-     */
-    protected $_pagenow_map;
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
-     * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
-     * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
-     * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
-     *
-     * @abstract
-     * @param string  $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param WP_Post $post    The post object of the cpt that was saved.
-     * @return void
-     */
-    abstract protected function _insert_update_cpt_item($post_id, $post);
-
-
-    /**
-     * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
-     *
-     * @abstract
-     * @param string $post_id The ID of the cpt that was trashed
-     * @return void
-     */
-    abstract public function trash_cpt_item($post_id);
-
-
-    /**
-     * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
-     *
-     * @param string $post_id theID of the cpt that was untrashed
-     * @return void
-     */
-    abstract public function restore_cpt_item($post_id);
-
-
-    /**
-     * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
-     * from the db
-     *
-     * @param string $post_id the ID of the cpt that was deleted
-     * @return void
-     */
-    abstract public function delete_cpt_item($post_id);
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader(): LoaderInterface
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Just utilizing the method EE_Admin exposes for doing things before page setup.
-     *
-     * @return void
-     */
-    protected function _before_page_setup()
-    {
-        $this->raw_req_action = $this->request->getRequestParam('action');
-        $this->raw_req_page   = $this->request->getRequestParam('page');
-        $this->_cpt_routes    = array_merge(
-            [
-                'create_new' => $this->page_slug,
-                'edit'       => $this->page_slug,
-                'trash'      => $this->page_slug,
-            ],
-            $this->_cpt_routes
-        );
-        $cpt_route_action     = $this->_cpt_routes[ $this->raw_req_action ] ?? null;
-        // let's see if the current route has a value for cpt_object_slug. if it does, we use that instead of the page
-        $page              = $this->raw_req_page ?: $this->page_slug;
-        $page              = $cpt_route_action ?: $page;
-        $this->_cpt_object = get_post_type_object($page);
-        // tweak pagenow for page loading.
-        if (! $this->_pagenow_map) {
-            $this->_pagenow_map = [
-                'create_new' => 'post-new.php',
-                'edit'       => 'post.php',
-                'trash'      => 'post.php',
-            ];
-        }
-        add_action('current_screen', [$this, 'modify_pagenow']);
-        // TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
-        // get current page from autosave
-        $current_page        = $this->request->getRequestParam('ee_autosave_data[ee-cpt-hidden-inputs][current_page]');
-        $this->_current_page = $this->request->getRequestParam('current_page', $current_page);
-    }
-
-
-    /**
-     * Simply ensure that we simulate the correct post route for cpt screens
-     *
-     * @param WP_Screen|null $current_screen
-     * @return void
-     */
-    public function modify_pagenow(?WP_Screen $current_screen)
-    {
-        // possibly reset pagenow.
-        if (
-            $this->page_slug === $this->raw_req_page
-            && isset($this->_pagenow_map[ $this->raw_req_action ])
-        ) {
-            global $pagenow, $hook_suffix;
-            $pagenow     = $this->_pagenow_map[ $this->raw_req_action ];
-            $hook_suffix = $pagenow;
-        }
-    }
-
-
-    /**
-     * This method is used to register additional autosave containers to the _autosave_containers property.
-     *
-     * @param array $ids  an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
-     *                    you would send along the id of a metabox container.
-     * @return void
-     * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
-     *                    automatically register the id for the post metabox as a container.
-     */
-    protected function _register_autosave_containers($ids)
-    {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
-    }
-
-
-    /**
-     * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
-     * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
-     */
-    protected function _set_autosave_containers()
-    {
-        global $wp_meta_boxes;
-        $containers = [];
-        if (empty($wp_meta_boxes)) {
-            return;
-        }
-        $current_metaboxes = $wp_meta_boxes[ $this->page_slug ] ?? [];
-        foreach ($current_metaboxes as $box_context) {
-            foreach ($box_context as $box_details) {
-                foreach ($box_details as $box) {
-                    if (
-                        is_array($box) && is_array($box['callback'])
-                        && (
-                            $box['callback'][0] instanceof EE_Admin_Page
-                            || $box['callback'][0] instanceof EE_Admin_Hooks
-                        )
-                    ) {
-                        $containers[] = $box['id'];
-                    }
-                }
-            }
-        }
-        $this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
-        // add hidden inputs container
-        $this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
-    }
-
-
-    protected function _load_autosave_scripts_styles()
-    {
-        /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
+	/**
+	 * This gets set in _setup_cpt
+	 * It will contain the object for the custom post type.
+	 *
+	 * @var EE_CPT_Base
+	 */
+	protected $_cpt_object;
+
+
+	/**
+	 * a boolean flag to set whether the current route is a cpt route or not.
+	 *
+	 * @var bool
+	 */
+	protected $_cpt_route = false;
+
+
+	/**
+	 * This property allows cpt classes to define multiple routes as cpt routes.
+	 * //in this array we define what the custom post type for this route is.
+	 * array(
+	 * 'route_name' => 'custom_post_type_slug'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_cpt_routes = [];
+
+
+	/**
+	 * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
+	 * in this format:
+	 * array(
+	 * 'post_type_slug' => 'edit_route'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_cpt_edit_routes = [];
+
+
+	/**
+	 * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
+	 * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
+	 * _cpt_model_names property should be in the following format: array(
+	 * 'route_defined_by_action_param' => 'Model_Name')
+	 *
+	 * @var array $_cpt_model_names
+	 */
+	protected $_cpt_model_names = [];
+
+
+	/**
+	 * @var EE_CPT_Base
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
+	 * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
+	 * the _register_autosave_containers() method so that we don't override any other containers already registered.
+	 * Registration of containers should be done before load_page_dependencies() is run.
+	 *
+	 * @var array()
+	 */
+	protected $_autosave_containers = [];
+
+	protected $_autosave_fields     = [];
+
+	/**
+	 * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
+	 * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
+	 *
+	 * @var array
+	 */
+	protected $_pagenow_map;
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
+	 * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
+	 * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
+	 * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
+	 *
+	 * @abstract
+	 * @param string  $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param WP_Post $post    The post object of the cpt that was saved.
+	 * @return void
+	 */
+	abstract protected function _insert_update_cpt_item($post_id, $post);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
+	 *
+	 * @abstract
+	 * @param string $post_id The ID of the cpt that was trashed
+	 * @return void
+	 */
+	abstract public function trash_cpt_item($post_id);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
+	 *
+	 * @param string $post_id theID of the cpt that was untrashed
+	 * @return void
+	 */
+	abstract public function restore_cpt_item($post_id);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
+	 * from the db
+	 *
+	 * @param string $post_id the ID of the cpt that was deleted
+	 * @return void
+	 */
+	abstract public function delete_cpt_item($post_id);
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader(): LoaderInterface
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Just utilizing the method EE_Admin exposes for doing things before page setup.
+	 *
+	 * @return void
+	 */
+	protected function _before_page_setup()
+	{
+		$this->raw_req_action = $this->request->getRequestParam('action');
+		$this->raw_req_page   = $this->request->getRequestParam('page');
+		$this->_cpt_routes    = array_merge(
+			[
+				'create_new' => $this->page_slug,
+				'edit'       => $this->page_slug,
+				'trash'      => $this->page_slug,
+			],
+			$this->_cpt_routes
+		);
+		$cpt_route_action     = $this->_cpt_routes[ $this->raw_req_action ] ?? null;
+		// let's see if the current route has a value for cpt_object_slug. if it does, we use that instead of the page
+		$page              = $this->raw_req_page ?: $this->page_slug;
+		$page              = $cpt_route_action ?: $page;
+		$this->_cpt_object = get_post_type_object($page);
+		// tweak pagenow for page loading.
+		if (! $this->_pagenow_map) {
+			$this->_pagenow_map = [
+				'create_new' => 'post-new.php',
+				'edit'       => 'post.php',
+				'trash'      => 'post.php',
+			];
+		}
+		add_action('current_screen', [$this, 'modify_pagenow']);
+		// TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
+		// get current page from autosave
+		$current_page        = $this->request->getRequestParam('ee_autosave_data[ee-cpt-hidden-inputs][current_page]');
+		$this->_current_page = $this->request->getRequestParam('current_page', $current_page);
+	}
+
+
+	/**
+	 * Simply ensure that we simulate the correct post route for cpt screens
+	 *
+	 * @param WP_Screen|null $current_screen
+	 * @return void
+	 */
+	public function modify_pagenow(?WP_Screen $current_screen)
+	{
+		// possibly reset pagenow.
+		if (
+			$this->page_slug === $this->raw_req_page
+			&& isset($this->_pagenow_map[ $this->raw_req_action ])
+		) {
+			global $pagenow, $hook_suffix;
+			$pagenow     = $this->_pagenow_map[ $this->raw_req_action ];
+			$hook_suffix = $pagenow;
+		}
+	}
+
+
+	/**
+	 * This method is used to register additional autosave containers to the _autosave_containers property.
+	 *
+	 * @param array $ids  an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
+	 *                    you would send along the id of a metabox container.
+	 * @return void
+	 * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
+	 *                    automatically register the id for the post metabox as a container.
+	 */
+	protected function _register_autosave_containers($ids)
+	{
+		$this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
+	}
+
+
+	/**
+	 * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
+	 * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
+	 */
+	protected function _set_autosave_containers()
+	{
+		global $wp_meta_boxes;
+		$containers = [];
+		if (empty($wp_meta_boxes)) {
+			return;
+		}
+		$current_metaboxes = $wp_meta_boxes[ $this->page_slug ] ?? [];
+		foreach ($current_metaboxes as $box_context) {
+			foreach ($box_context as $box_details) {
+				foreach ($box_details as $box) {
+					if (
+						is_array($box) && is_array($box['callback'])
+						&& (
+							$box['callback'][0] instanceof EE_Admin_Page
+							|| $box['callback'][0] instanceof EE_Admin_Hooks
+						)
+					) {
+						$containers[] = $box['id'];
+					}
+				}
+			}
+		}
+		$this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
+		// add hidden inputs container
+		$this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
+	}
+
+
+	protected function _load_autosave_scripts_styles()
+	{
+		/*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
         wp_enqueue_script('cpt-autosave');/**/ // todo re-enable when we start doing autosave again in 4.2
 
-        // filter _autosave_containers
-        $containers = apply_filters(
-            'FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
-            $this->_autosave_containers,
-            $this
-        );
-        $containers = apply_filters(
-            'FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
-            $containers,
-            $this
-        );
-
-        wp_localize_script(
-            'event_editor_js',
-            'EE_AUTOSAVE_IDS',
-            $containers
-        ); // todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
-
-        $unsaved_data_msg = [
-            'eventmsg'     => sprintf(
-                wp_strip_all_tags(
-                    __(
-                        "The changes you made to this %s will be lost if you navigate away from this page.",
-                        'event_espresso'
-                    )
-                ),
-                $this->_cpt_object->labels->singular_name
-            ),
-            'inputChanged' => 0,
-        ];
-        wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
-    }
-
-
-    /**
-     * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _load_page_dependencies()
-    {
-        // we only add stuff if this is a cpt_route!
-        if (! $this->_cpt_route) {
-            parent::_load_page_dependencies();
-            return;
-        }
-        // now let's do some automatic filters into the wp_system
-        // and we'll check to make sure the CHILD class
-        // automatically has the required methods in place.
-        // the following filters are for setting all the redirects
-        // on DEFAULT WP custom post type actions
-        // let's add a hidden input to the post-edit form
-        // so we know when we have to trigger our custom redirects!
-        // Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
-        add_action('edit_form_after_title', [$this, 'cpt_post_form_hidden_input']);
-        // inject our Admin page nav tabs...
-        // let's make sure the nav tabs are set if they aren't already
-        // if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
-        add_action('edit_form_top', [$this, 'inject_nav_tabs']);
-        // modify the post_updated messages array
-        add_action('post_updated_messages', [$this, 'post_update_messages'], 10);
-        // This basically allows us to change the title of the "publish" metabox area
-        // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
-        $screen = $this->_cpt_routes[ $this->_req_action ];
-        if (! empty($this->_labels['publishbox'])) {
-            $this->addMetaBox(
-                'submitdiv',
-                $this->getPublishBoxTitle(),
-                'post_submit_meta_box',
-                $screen,
-                'side',
-                'core'
-            );
-        }
-        // let's add page_templates metabox if this cpt added support for it.
-        if ($this->_supports_page_templates($this->_cpt_object->name)) {
-            $this->addMetaBox(
-                'page_templates',
-                esc_html__('Page Template', 'event_espresso'),
-                [$this, 'page_template_meta_box'],
-                $screen,
-                'side'
-            );
-        }
-        // add preview button
-        add_filter('get_sample_permalink_html', [PreviewButton::class, 'addButton'], 5, 2);
-        // add shortlink button to cpt edit screens.
-        //  We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts!
-        add_filter('get_sample_permalink_html', [EventShortlinkButton::class, 'addButton'], 10, 2);
-        // this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
-        add_filter('get_sample_permalink_html', [TicketSelectorShortcodeButton::class, 'addButton'], 12, 4);
-        // insert our own post_stati dropdown
-        add_action('post_submitbox_misc_actions', [$this, 'custom_post_stati_dropdown'], 10);
-        // This allows adding additional information to the publish post submitbox on the wp post edit form
-        if (method_exists($this, 'extra_misc_actions_publish_box')) {
-            add_action('post_submitbox_misc_actions', [$this, 'extra_misc_actions_publish_box'], 10);
-        }
-        // This allows for adding additional stuff after the title field on the wp post edit form.
-        // This is also before the wp_editor for post description field.
-        if (method_exists($this, 'edit_form_after_title')) {
-            add_action('edit_form_after_title', [$this, 'edit_form_after_title'], 10);
-        }
-        /**
-         * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
-         */
-        add_filter('clean_url', [$this, 'switch_core_wp_urls_with_ours'], 10);
-        parent::_load_page_dependencies();
-        // notice we are ALSO going to load the pagenow hook set for this route
-        // (see _before_page_setup for the reset of the pagenow global ).
-        // This is for any plugins that are doing things properly
-        // and hooking into the load page hook for core wp cpt routes.
-        global $pagenow;
-        add_action('load-' . $pagenow, [$this, 'modify_current_screen'], 20);
-        do_action('load-' . $pagenow);
-        add_action('admin_enqueue_scripts', [$this, 'setup_autosave_hooks'], 30);
-        // we route REALLY early.
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    /**
-     * Since we don't want users going to default core wp routes, this will check any wp urls run through the
-     * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
-     * route instead.
-     *
-     * @param string $good_protocol_url The escaped url.
-     * @return string possibly a new url for our route.
-     */
-    public function switch_core_wp_urls_with_ours(string $good_protocol_url): string
-    {
-        $routes_to_match = [
-            0 => [
-                'edit.php?post_type=espresso_attendees',
-                'admin.php?page=espresso_registrations&action=contact_list',
-            ],
-            1 => [
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
-            ],
-        ];
-        foreach ($routes_to_match as $route_matches) {
-            if (strpos($good_protocol_url, $route_matches[0]) !== false) {
-                return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
-            }
-        }
-        return $good_protocol_url;
-    }
-
-
-    /**
-     * Determine whether the current cpt supports page templates or not.
-     *
-     * @param string $cpt_name The cpt slug we're checking on.
-     * @return bool True supported, false not.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since %VER%
-     */
-    private function _supports_page_templates(string $cpt_name): bool
-    {
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-        $custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $cpt_args          = $custom_post_types->getDefinitions();
-        $cpt_args          = isset($cpt_args[ $cpt_name ]) ? $cpt_args[ $cpt_name ]['args'] : [];
-        $cpt_has_support   = ! empty($cpt_args['page_templates']);
-
-        $post_templates = wp_get_theme()->get_post_templates();
-        // if there are $post_templates for this cpt, then we return false for this method because
-        // that means we aren't going to load our page template manager and leave that up to the native
-        // cpt template manager.
-        return ! isset($post_templates[ $cpt_name ]) ? $cpt_has_support : false;
-    }
-
-
-    /**
-     * Callback for the page_templates metabox selector.
-     *
-     * @return void
-     * @since %VER%
-     */
-    public function page_template_meta_box()
-    {
-        global $post;
-        $template = '';
-
-        $page_template_count = count(get_page_templates());
-        if ($page_template_count) {
-            $page_template = get_post_meta($post->ID, '_wp_page_template', true);
-            $template      = ! empty($page_template) ? $page_template : '';
-        }
-        ?>
+		// filter _autosave_containers
+		$containers = apply_filters(
+			'FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
+			$this->_autosave_containers,
+			$this
+		);
+		$containers = apply_filters(
+			'FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+			$containers,
+			$this
+		);
+
+		wp_localize_script(
+			'event_editor_js',
+			'EE_AUTOSAVE_IDS',
+			$containers
+		); // todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
+
+		$unsaved_data_msg = [
+			'eventmsg'     => sprintf(
+				wp_strip_all_tags(
+					__(
+						"The changes you made to this %s will be lost if you navigate away from this page.",
+						'event_espresso'
+					)
+				),
+				$this->_cpt_object->labels->singular_name
+			),
+			'inputChanged' => 0,
+		];
+		wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
+	}
+
+
+	/**
+	 * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _load_page_dependencies()
+	{
+		// we only add stuff if this is a cpt_route!
+		if (! $this->_cpt_route) {
+			parent::_load_page_dependencies();
+			return;
+		}
+		// now let's do some automatic filters into the wp_system
+		// and we'll check to make sure the CHILD class
+		// automatically has the required methods in place.
+		// the following filters are for setting all the redirects
+		// on DEFAULT WP custom post type actions
+		// let's add a hidden input to the post-edit form
+		// so we know when we have to trigger our custom redirects!
+		// Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
+		add_action('edit_form_after_title', [$this, 'cpt_post_form_hidden_input']);
+		// inject our Admin page nav tabs...
+		// let's make sure the nav tabs are set if they aren't already
+		// if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
+		add_action('edit_form_top', [$this, 'inject_nav_tabs']);
+		// modify the post_updated messages array
+		add_action('post_updated_messages', [$this, 'post_update_messages'], 10);
+		// This basically allows us to change the title of the "publish" metabox area
+		// on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
+		$screen = $this->_cpt_routes[ $this->_req_action ];
+		if (! empty($this->_labels['publishbox'])) {
+			$this->addMetaBox(
+				'submitdiv',
+				$this->getPublishBoxTitle(),
+				'post_submit_meta_box',
+				$screen,
+				'side',
+				'core'
+			);
+		}
+		// let's add page_templates metabox if this cpt added support for it.
+		if ($this->_supports_page_templates($this->_cpt_object->name)) {
+			$this->addMetaBox(
+				'page_templates',
+				esc_html__('Page Template', 'event_espresso'),
+				[$this, 'page_template_meta_box'],
+				$screen,
+				'side'
+			);
+		}
+		// add preview button
+		add_filter('get_sample_permalink_html', [PreviewButton::class, 'addButton'], 5, 2);
+		// add shortlink button to cpt edit screens.
+		//  We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts!
+		add_filter('get_sample_permalink_html', [EventShortlinkButton::class, 'addButton'], 10, 2);
+		// this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
+		add_filter('get_sample_permalink_html', [TicketSelectorShortcodeButton::class, 'addButton'], 12, 4);
+		// insert our own post_stati dropdown
+		add_action('post_submitbox_misc_actions', [$this, 'custom_post_stati_dropdown'], 10);
+		// This allows adding additional information to the publish post submitbox on the wp post edit form
+		if (method_exists($this, 'extra_misc_actions_publish_box')) {
+			add_action('post_submitbox_misc_actions', [$this, 'extra_misc_actions_publish_box'], 10);
+		}
+		// This allows for adding additional stuff after the title field on the wp post edit form.
+		// This is also before the wp_editor for post description field.
+		if (method_exists($this, 'edit_form_after_title')) {
+			add_action('edit_form_after_title', [$this, 'edit_form_after_title'], 10);
+		}
+		/**
+		 * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
+		 */
+		add_filter('clean_url', [$this, 'switch_core_wp_urls_with_ours'], 10);
+		parent::_load_page_dependencies();
+		// notice we are ALSO going to load the pagenow hook set for this route
+		// (see _before_page_setup for the reset of the pagenow global ).
+		// This is for any plugins that are doing things properly
+		// and hooking into the load page hook for core wp cpt routes.
+		global $pagenow;
+		add_action('load-' . $pagenow, [$this, 'modify_current_screen'], 20);
+		do_action('load-' . $pagenow);
+		add_action('admin_enqueue_scripts', [$this, 'setup_autosave_hooks'], 30);
+		// we route REALLY early.
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	/**
+	 * Since we don't want users going to default core wp routes, this will check any wp urls run through the
+	 * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
+	 * route instead.
+	 *
+	 * @param string $good_protocol_url The escaped url.
+	 * @return string possibly a new url for our route.
+	 */
+	public function switch_core_wp_urls_with_ours(string $good_protocol_url): string
+	{
+		$routes_to_match = [
+			0 => [
+				'edit.php?post_type=espresso_attendees',
+				'admin.php?page=espresso_registrations&action=contact_list',
+			],
+			1 => [
+				'edit.php?post_type=' . $this->_cpt_object->name,
+				'admin.php?page=' . $this->_cpt_object->name,
+			],
+		];
+		foreach ($routes_to_match as $route_matches) {
+			if (strpos($good_protocol_url, $route_matches[0]) !== false) {
+				return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
+			}
+		}
+		return $good_protocol_url;
+	}
+
+
+	/**
+	 * Determine whether the current cpt supports page templates or not.
+	 *
+	 * @param string $cpt_name The cpt slug we're checking on.
+	 * @return bool True supported, false not.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since %VER%
+	 */
+	private function _supports_page_templates(string $cpt_name): bool
+	{
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+		$custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$cpt_args          = $custom_post_types->getDefinitions();
+		$cpt_args          = isset($cpt_args[ $cpt_name ]) ? $cpt_args[ $cpt_name ]['args'] : [];
+		$cpt_has_support   = ! empty($cpt_args['page_templates']);
+
+		$post_templates = wp_get_theme()->get_post_templates();
+		// if there are $post_templates for this cpt, then we return false for this method because
+		// that means we aren't going to load our page template manager and leave that up to the native
+		// cpt template manager.
+		return ! isset($post_templates[ $cpt_name ]) ? $cpt_has_support : false;
+	}
+
+
+	/**
+	 * Callback for the page_templates metabox selector.
+	 *
+	 * @return void
+	 * @since %VER%
+	 */
+	public function page_template_meta_box()
+	{
+		global $post;
+		$template = '';
+
+		$page_template_count = count(get_page_templates());
+		if ($page_template_count) {
+			$page_template = get_post_meta($post->ID, '_wp_page_template', true);
+			$template      = ! empty($page_template) ? $page_template : '';
+		}
+		?>
         <p><strong><?php esc_html_e('Template', 'event_espresso') ?></strong></p>
         <label class="screen-reader-text" for="page_template">
             <?php esc_html_e('Page Template', 'event_espresso') ?>
@@ -489,457 +489,457 @@ 
             <?php page_template_dropdown($template); ?>
         </select>
         <?php
-    }
-
-
-    /**
-     * if this post is a draft or scheduled post then we provide a preview button for user to click
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param string $return    the current html
-     * @param int    $id        the post id for the page
-     * @return string            The new html string for the permalink area
-     * @deprecated $VID:$
-     * @see PreviewButton::addButton()
-     */
-    public function preview_button_html(string $return, int $id): string
-    {
-        return PreviewButton::addButton($return, $id);
-    }
-
-
-    /**
-     * add our custom post status dropdown on the wp post page for this cpt
-     *
-     * @return void
-     */
-    public function custom_post_stati_dropdown()
-    {
-        $statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
-        $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
-            ? $statuses[ $this->_cpt_model_obj->status() ]
-            : '';
-        $template_args    = [
-            'cur_status'            => $this->_cpt_model_obj->status(),
-            'statuses'              => $statuses,
-            'cur_status_label'      => $cur_status_label,
-            'localized_status_save' => sprintf(esc_html__('Save %s', 'event_espresso'), $cur_status_label),
-        ];
-        // we'll add a trash post status (WP doesn't add one for some reason)
-        if ($this->_cpt_model_obj->status() === 'trash') {
-            $template_args['cur_status_label'] = esc_html__('Trashed', 'event_espresso');
-            $statuses['trash']                 = esc_html__('Trashed', 'event_espresso');
-            $template_args['statuses']         = $statuses;
-        }
-
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function setup_autosave_hooks()
-    {
-        $this->_set_autosave_containers();
-        $this->_load_autosave_scripts_styles();
-    }
-
-
-    /**
-     * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a post object (available
-     * in request data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
-     * for the nonce in here, but then this method looks for two things:
-     * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
-     * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
-     * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
-     * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
-     * template args.
-     *    1. $template_args['error'] = IF there is an error you can add the message in here.
-     *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
-     *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
-     *    $this->_template_args['data']['items'] = array(
-     *        'event-datetime-ids' => '1,2,3';
-     *    );
-     *    Keep in mind the following things:
-     *    - "where" index is for the input with the id as that string.
-     *    - "what" index is what will be used for the value of that input.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function do_extra_autosave_stuff()
-    {
-        // next let's check for the autosave nonce (we'll use _verify_nonce )
-        $nonce = $this->request->getRequestParam('autosavenonce');
-        $this->_verify_nonce($nonce, 'autosave');
-        // make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
-        if (! defined('DOING_AUTOSAVE')) {
-            define('DOING_AUTOSAVE', true);
-        }
-        // if we made it here then the nonce checked out.  Let's run our methods and actions
-        $autosave = "_ee_autosave_$this->_current_view";
-        if (method_exists($this, $autosave)) {
-            $this->$autosave();
-        } else {
-            $this->_template_args['success'] = true;
-        }
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
-        // now let's return json
-        $this->_return_json();
-    }
-
-
-    /**
-     * This takes care of setting up default routes and pages that utilize the core WP admin pages.
-     * Child classes can override the defaults (in cases for adding metaboxes etc.)
-     * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _extend_page_config_for_cpt()
-    {
-        // before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
-        if ($this->raw_req_page !== $this->page_slug) {
-            return;
-        }
-        // set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
-        if (! empty($this->_cpt_object)) {
-            $this->_page_routes = array_merge(
-                [
-                    'create_new' => [$this, '_create_new_cpt_item'],
-                    'edit'       => [$this, '_edit_cpt_item'],
-                ],
-                $this->_page_routes
-            );
-            $this->_page_config = array_merge(
-                [
-                    'create_new' => [
-                        'nav'           => [
-                            'label' => $this->_cpt_object->labels->add_new_item,
-                            'order' => 5,
-                        ],
-                        'require_nonce' => false,
-                    ],
-                    'edit'       => [
-                        'nav'           => [
-                            'label'      => $this->_cpt_object->labels->edit_item,
-                            'order'      => 5,
-                            'persistent' => false,
-                            'url'        => '',
-                        ],
-                        'require_nonce' => false,
-                    ],
-                ],
-                $this->_page_config
-            );
-        }
-        // load the next section only if this is a matching cpt route as set in the cpt routes array.
-        if (! isset($this->_cpt_routes[ $this->_req_action ])) {
-            return;
-        }
-        $this->_cpt_route = true;
-        // $this->_cpt_route = isset($this->_cpt_routes[ $this->_req_action ]);
-        // add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
-        if (empty($this->_cpt_object)) {
-            $msg = sprintf(
-                esc_html__(
-                    'This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).',
-                    'event_espresso'
-                ),
-                $this->page_slug,
-                $this->_req_action,
-                get_class($this)
-            );
-            throw new EE_Error($msg);
-        }
-        $this->_set_model_object($this->request->getRequestParam('post', 0, DataType::INT));
-    }
-
-
-    /**
-     * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
-     *
-     * @param int    $id       The id to retrieve the model object for. If empty we set a default object.
-     * @param bool   $ignore_route_check
-     * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _set_model_object(int $id = 0, bool $ignore_route_check = false, string $req_type = '')
-    {
-        $model = null;
-        if (
-            empty($this->_cpt_model_names)
-            || (
-                ! $ignore_route_check
-                && ! isset($this->_cpt_routes[ $this->_req_action ])
-            )
-            || (
-                $this->_cpt_model_obj instanceof EE_CPT_Base
-                && $this->_cpt_model_obj->ID() === $id
-            )
-        ) {
-            // get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
-            return;
-        }
-        // if ignore_route_check is true, then get the model name via CustomPostTypeDefinitions
-        if ($ignore_route_check) {
-            $post_type = get_post_type($id);
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->loader->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $model_names       = $custom_post_types->getCustomPostTypeModelNames($post_type);
-            if (isset($model_names[ $post_type ])) {
-                $model = EE_Registry::instance()->load_model($model_names[ $post_type ]);
-            }
-        } else {
-            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[ $this->_req_action ]);
-        }
-        if ($model instanceof EEM_Base) {
-            $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
-        }
-        do_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            $this->_cpt_model_obj,
-            $req_type
-        );
-    }
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @return void
-     */
-    public function admin_init_global()
-    {
-        $post_ID = $this->request->getRequestParam('post', 0, DataType::INT);
-        // its possible this is a new save so let's catch that instead
-        $post_ID        = $this->request->getRequestParam('post_ID', $post_ID, DataType::INT);
-        $post           = get_post($post_ID);
-        $post_type      = $post instanceof WP_Post ? $post->post_type : false;
-        $current_route  = $this->request->getRequestParam('current_route', 'shouldneverwork');
-        $route_to_check = $post_type && isset($this->_cpt_routes[ $current_route ])
-            ? $this->_cpt_routes[ $current_route ]
-            : '';
-        add_filter('get_delete_post_link', [$this, 'modify_delete_post_link'], 10, 2);
-        add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
-        if ($post_type === $route_to_check) {
-            add_filter('redirect_post_location', [$this, 'cpt_post_location_redirect'], 10, 2);
-        }
-        // now let's filter redirect if we're on a revision page and the revision is for an event CPT.
-        $revision = $this->request->getRequestParam('revision');
-        if (! empty($revision)) {
-            $action = $this->request->getRequestParam('action');
-            // doing a restore?
-            if (! empty($action) && $action === 'restore') {
-                // get post for revision
-                $rev_post   = get_post($revision);
-                $rev_parent = get_post($rev_post->post_parent);
-                // only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
-                if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
-                    add_filter('wp_redirect', [$this, 'revision_redirect'], 10);
-                    // restores of revisions
-                    add_action('wp_restore_post_revision', [$this, 'restore_revision'], 10, 2);
-                }
-            }
-        }
-        // NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
-        if ($post_type && $post_type === $route_to_check) {
-            // $post_id, $post
-            add_action('save_post', [$this, 'insert_update'], 10, 3);
-            // $post_id
-            add_action('trashed_post', [$this, 'before_trash_cpt_item'], 10);
-            add_action('trashed_post', [$this, 'dont_permanently_delete_ee_cpts'], 10);
-            add_action('untrashed_post', [$this, 'before_restore_cpt_item'], 10);
-            add_action('after_delete_post', [$this, 'before_delete_cpt_item'], 10);
-        }
-    }
-
-
-    /**
-     * Callback for the WordPress trashed_post hook.
-     * Execute some basic checks before calling the trash_cpt_item declared in the child class.
-     *
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_trash_cpt_item(int $post_id)
-    {
-        $this->_set_model_object($post_id, true, 'trash');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->trash_cpt_item($post_id);
-    }
-
-
-    /**
-     * Callback for the WordPress untrashed_post hook.
-     * Execute some basic checks before calling the restore_cpt_method in the child class.
-     *
-     * @param $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_restore_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'restore');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->restore_cpt_item($post_id);
-    }
-
-
-    /**
-     * Callback for the WordPress after_delete_post hook.
-     * Execute some basic checks before calling the delete_cpt_item method in the child class.
-     *
-     * @param $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_delete_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'delete');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->delete_cpt_item($post_id);
-    }
-
-
-    /**
-     * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
-     * accordingly.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_cpt_object()
-    {
-        $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
-        // verify event object
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
-                        'event_espresso'
-                    ),
-                    $label
-                )
-            );
-        }
-        // if auto-draft then throw an error
-        if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
-            EE_Error::overwrite_errors();
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.',
-                        'event_espresso'
-                    ),
-                    $label
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-    }
-
-
-    /**
-     * add in any global scripts for cpt routes
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        parent::load_global_scripts_styles();
-        if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
-            // setup custom post status object for localize script but only if we've got a cpt object
-            $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
-            if (! empty($statuses)) {
-                // get ALL statuses!
-                $statuses = $this->_cpt_model_obj->get_all_post_statuses();
-                // setup object
-                $ee_cpt_statuses = [];
-                foreach ($statuses as $status => $label) {
-                    $ee_cpt_statuses[ $status ] = [
-                        'label'      => $label,
-                        'save_label' => sprintf(
-                            wp_strip_all_tags(__('Save as %s', 'event_espresso')),
-                            $label
-                        ),
-                    ];
-                }
-                wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
-            }
-        }
-    }
-
-
-    /**
-     * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
-     * insert/updates
-     *
-     * @param int     $post_id ID of post being updated
-     * @param WP_Post $post    Post object from WP
-     * @param bool    $update  Whether this is an update or a new save.
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function insert_update(int $post_id, WP_Post $post, bool $update)
-    {
-        // make sure that if this is a revision OR trash action that we don't do any updates!
-        $action = $this->request->getRequestParam('action');
-        if ($action === 'restore' || $action === 'trash') {
-            return;
-        }
-        $this->_set_model_object($post_id, true, 'insert_update');
-        // if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
-        if (
-            $update
-            && (
-                ! $this->_cpt_model_obj instanceof EE_CPT_Base
-                || $this->_cpt_model_obj->ID() !== $post_id
-            )
-        ) {
-            return;
-        }
-        // check for autosave and update our req_data property accordingly.
-        /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
+	}
+
+
+	/**
+	 * if this post is a draft or scheduled post then we provide a preview button for user to click
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param string $return    the current html
+	 * @param int    $id        the post id for the page
+	 * @return string            The new html string for the permalink area
+	 * @deprecated $VID:$
+	 * @see PreviewButton::addButton()
+	 */
+	public function preview_button_html(string $return, int $id): string
+	{
+		return PreviewButton::addButton($return, $id);
+	}
+
+
+	/**
+	 * add our custom post status dropdown on the wp post page for this cpt
+	 *
+	 * @return void
+	 */
+	public function custom_post_stati_dropdown()
+	{
+		$statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
+		$cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
+			? $statuses[ $this->_cpt_model_obj->status() ]
+			: '';
+		$template_args    = [
+			'cur_status'            => $this->_cpt_model_obj->status(),
+			'statuses'              => $statuses,
+			'cur_status_label'      => $cur_status_label,
+			'localized_status_save' => sprintf(esc_html__('Save %s', 'event_espresso'), $cur_status_label),
+		];
+		// we'll add a trash post status (WP doesn't add one for some reason)
+		if ($this->_cpt_model_obj->status() === 'trash') {
+			$template_args['cur_status_label'] = esc_html__('Trashed', 'event_espresso');
+			$statuses['trash']                 = esc_html__('Trashed', 'event_espresso');
+			$template_args['statuses']         = $statuses;
+		}
+
+		$template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function setup_autosave_hooks()
+	{
+		$this->_set_autosave_containers();
+		$this->_load_autosave_scripts_styles();
+	}
+
+
+	/**
+	 * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a post object (available
+	 * in request data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
+	 * for the nonce in here, but then this method looks for two things:
+	 * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
+	 * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
+	 * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
+	 * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
+	 * template args.
+	 *    1. $template_args['error'] = IF there is an error you can add the message in here.
+	 *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
+	 *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
+	 *    $this->_template_args['data']['items'] = array(
+	 *        'event-datetime-ids' => '1,2,3';
+	 *    );
+	 *    Keep in mind the following things:
+	 *    - "where" index is for the input with the id as that string.
+	 *    - "what" index is what will be used for the value of that input.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function do_extra_autosave_stuff()
+	{
+		// next let's check for the autosave nonce (we'll use _verify_nonce )
+		$nonce = $this->request->getRequestParam('autosavenonce');
+		$this->_verify_nonce($nonce, 'autosave');
+		// make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
+		if (! defined('DOING_AUTOSAVE')) {
+			define('DOING_AUTOSAVE', true);
+		}
+		// if we made it here then the nonce checked out.  Let's run our methods and actions
+		$autosave = "_ee_autosave_$this->_current_view";
+		if (method_exists($this, $autosave)) {
+			$this->$autosave();
+		} else {
+			$this->_template_args['success'] = true;
+		}
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+		// now let's return json
+		$this->_return_json();
+	}
+
+
+	/**
+	 * This takes care of setting up default routes and pages that utilize the core WP admin pages.
+	 * Child classes can override the defaults (in cases for adding metaboxes etc.)
+	 * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _extend_page_config_for_cpt()
+	{
+		// before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
+		if ($this->raw_req_page !== $this->page_slug) {
+			return;
+		}
+		// set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
+		if (! empty($this->_cpt_object)) {
+			$this->_page_routes = array_merge(
+				[
+					'create_new' => [$this, '_create_new_cpt_item'],
+					'edit'       => [$this, '_edit_cpt_item'],
+				],
+				$this->_page_routes
+			);
+			$this->_page_config = array_merge(
+				[
+					'create_new' => [
+						'nav'           => [
+							'label' => $this->_cpt_object->labels->add_new_item,
+							'order' => 5,
+						],
+						'require_nonce' => false,
+					],
+					'edit'       => [
+						'nav'           => [
+							'label'      => $this->_cpt_object->labels->edit_item,
+							'order'      => 5,
+							'persistent' => false,
+							'url'        => '',
+						],
+						'require_nonce' => false,
+					],
+				],
+				$this->_page_config
+			);
+		}
+		// load the next section only if this is a matching cpt route as set in the cpt routes array.
+		if (! isset($this->_cpt_routes[ $this->_req_action ])) {
+			return;
+		}
+		$this->_cpt_route = true;
+		// $this->_cpt_route = isset($this->_cpt_routes[ $this->_req_action ]);
+		// add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
+		if (empty($this->_cpt_object)) {
+			$msg = sprintf(
+				esc_html__(
+					'This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).',
+					'event_espresso'
+				),
+				$this->page_slug,
+				$this->_req_action,
+				get_class($this)
+			);
+			throw new EE_Error($msg);
+		}
+		$this->_set_model_object($this->request->getRequestParam('post', 0, DataType::INT));
+	}
+
+
+	/**
+	 * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
+	 *
+	 * @param int    $id       The id to retrieve the model object for. If empty we set a default object.
+	 * @param bool   $ignore_route_check
+	 * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _set_model_object(int $id = 0, bool $ignore_route_check = false, string $req_type = '')
+	{
+		$model = null;
+		if (
+			empty($this->_cpt_model_names)
+			|| (
+				! $ignore_route_check
+				&& ! isset($this->_cpt_routes[ $this->_req_action ])
+			)
+			|| (
+				$this->_cpt_model_obj instanceof EE_CPT_Base
+				&& $this->_cpt_model_obj->ID() === $id
+			)
+		) {
+			// get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
+			return;
+		}
+		// if ignore_route_check is true, then get the model name via CustomPostTypeDefinitions
+		if ($ignore_route_check) {
+			$post_type = get_post_type($id);
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->loader->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$model_names       = $custom_post_types->getCustomPostTypeModelNames($post_type);
+			if (isset($model_names[ $post_type ])) {
+				$model = EE_Registry::instance()->load_model($model_names[ $post_type ]);
+			}
+		} else {
+			$model = EE_Registry::instance()->load_model($this->_cpt_model_names[ $this->_req_action ]);
+		}
+		if ($model instanceof EEM_Base) {
+			$this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
+		}
+		do_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			$this->_cpt_model_obj,
+			$req_type
+		);
+	}
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+		$post_ID = $this->request->getRequestParam('post', 0, DataType::INT);
+		// its possible this is a new save so let's catch that instead
+		$post_ID        = $this->request->getRequestParam('post_ID', $post_ID, DataType::INT);
+		$post           = get_post($post_ID);
+		$post_type      = $post instanceof WP_Post ? $post->post_type : false;
+		$current_route  = $this->request->getRequestParam('current_route', 'shouldneverwork');
+		$route_to_check = $post_type && isset($this->_cpt_routes[ $current_route ])
+			? $this->_cpt_routes[ $current_route ]
+			: '';
+		add_filter('get_delete_post_link', [$this, 'modify_delete_post_link'], 10, 2);
+		add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
+		if ($post_type === $route_to_check) {
+			add_filter('redirect_post_location', [$this, 'cpt_post_location_redirect'], 10, 2);
+		}
+		// now let's filter redirect if we're on a revision page and the revision is for an event CPT.
+		$revision = $this->request->getRequestParam('revision');
+		if (! empty($revision)) {
+			$action = $this->request->getRequestParam('action');
+			// doing a restore?
+			if (! empty($action) && $action === 'restore') {
+				// get post for revision
+				$rev_post   = get_post($revision);
+				$rev_parent = get_post($rev_post->post_parent);
+				// only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
+				if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
+					add_filter('wp_redirect', [$this, 'revision_redirect'], 10);
+					// restores of revisions
+					add_action('wp_restore_post_revision', [$this, 'restore_revision'], 10, 2);
+				}
+			}
+		}
+		// NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
+		if ($post_type && $post_type === $route_to_check) {
+			// $post_id, $post
+			add_action('save_post', [$this, 'insert_update'], 10, 3);
+			// $post_id
+			add_action('trashed_post', [$this, 'before_trash_cpt_item'], 10);
+			add_action('trashed_post', [$this, 'dont_permanently_delete_ee_cpts'], 10);
+			add_action('untrashed_post', [$this, 'before_restore_cpt_item'], 10);
+			add_action('after_delete_post', [$this, 'before_delete_cpt_item'], 10);
+		}
+	}
+
+
+	/**
+	 * Callback for the WordPress trashed_post hook.
+	 * Execute some basic checks before calling the trash_cpt_item declared in the child class.
+	 *
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_trash_cpt_item(int $post_id)
+	{
+		$this->_set_model_object($post_id, true, 'trash');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->trash_cpt_item($post_id);
+	}
+
+
+	/**
+	 * Callback for the WordPress untrashed_post hook.
+	 * Execute some basic checks before calling the restore_cpt_method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_restore_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'restore');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->restore_cpt_item($post_id);
+	}
+
+
+	/**
+	 * Callback for the WordPress after_delete_post hook.
+	 * Execute some basic checks before calling the delete_cpt_item method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_delete_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'delete');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->delete_cpt_item($post_id);
+	}
+
+
+	/**
+	 * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
+	 * accordingly.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_cpt_object()
+	{
+		$label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
+		// verify event object
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
+						'event_espresso'
+					),
+					$label
+				)
+			);
+		}
+		// if auto-draft then throw an error
+		if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
+			EE_Error::overwrite_errors();
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.',
+						'event_espresso'
+					),
+					$label
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+	}
+
+
+	/**
+	 * add in any global scripts for cpt routes
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		parent::load_global_scripts_styles();
+		if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
+			// setup custom post status object for localize script but only if we've got a cpt object
+			$statuses = $this->_cpt_model_obj->get_custom_post_statuses();
+			if (! empty($statuses)) {
+				// get ALL statuses!
+				$statuses = $this->_cpt_model_obj->get_all_post_statuses();
+				// setup object
+				$ee_cpt_statuses = [];
+				foreach ($statuses as $status => $label) {
+					$ee_cpt_statuses[ $status ] = [
+						'label'      => $label,
+						'save_label' => sprintf(
+							wp_strip_all_tags(__('Save as %s', 'event_espresso')),
+							$label
+						),
+					];
+				}
+				wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
+			}
+		}
+	}
+
+
+	/**
+	 * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
+	 * insert/updates
+	 *
+	 * @param int     $post_id ID of post being updated
+	 * @param WP_Post $post    Post object from WP
+	 * @param bool    $update  Whether this is an update or a new save.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function insert_update(int $post_id, WP_Post $post, bool $update)
+	{
+		// make sure that if this is a revision OR trash action that we don't do any updates!
+		$action = $this->request->getRequestParam('action');
+		if ($action === 'restore' || $action === 'trash') {
+			return;
+		}
+		$this->_set_model_object($post_id, true, 'insert_update');
+		// if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
+		if (
+			$update
+			&& (
+				! $this->_cpt_model_obj instanceof EE_CPT_Base
+				|| $this->_cpt_model_obj->ID() !== $post_id
+			)
+		) {
+			return;
+		}
+		// check for autosave and update our req_data property accordingly.
+		/*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
             foreach( (array) $this->_req_data['ee_autosave_data'] as $id => $values ) {
 
                 foreach ( (array) $values as $key => $value ) {
@@ -949,540 +949,540 @@ 
 
         }/**/ // TODO reactivate after autosave is implemented in 4.2
 
-        // take care of updating any selected page_template IF this cpt supports it.
-
-        $page_template = $this->request->getRequestParam('page_template');
-        if ($this->_supports_page_templates($post->post_type) && ! empty($page_template)) {
-            // wp version aware.
-            if (RecommendedVersions::compareWordPressVersion('4.7')) {
-                $page_templates = wp_get_theme()->get_page_templates();
-            } else {
-                $post->page_template = $page_template;
-                $page_templates      = wp_get_theme()->get_page_templates($post);
-            }
-            if ($page_template !== 'default' && ! isset($page_templates[ $page_template ])) {
-                EE_Error::add_error(
-                    esc_html__('Invalid Page Template.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                update_post_meta($post_id, '_wp_page_template', $page_template);
-            }
-        }
-        if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
-            return;
-        } //TODO we'll remove this after reimplementing autosave in 4.2
-        $this->_insert_update_cpt_item($post_id, $post);
-    }
-
-
-    /**
-     * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
-     * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
-     * so we don't have to check for our CPT.
-     *
-     * @param int $post_id ID of the post
-     * @return void
-     */
-    public function dont_permanently_delete_ee_cpts(int $post_id)
-    {
-        // only do this if we're actually processing one of our CPTs
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            return;
-        }
-        delete_post_meta($post_id, '_wp_trash_meta_status');
-        delete_post_meta($post_id, '_wp_trash_meta_time');
-        // our cpts may have comments so let's take care of that too
-        delete_post_meta($post_id, '_wp_trash_meta_comments_status');
-    }
-
-
-    /**
-     * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
-     * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
-     * in them. We also have our OWN action in here so addons can hook into the restore process easily.
-     *
-     * @param int $post_id     ID of cpt item
-     * @param int $revision_id ID of revision being restored
-     * @return void
-     */
-    public function restore_revision(int $post_id, int $revision_id)
-    {
-        $this->_restore_cpt_item($post_id, $revision_id);
-        // global action
-        do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
-        // class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
-    }
-
-
-    /**
-     * @param int $post_id     ID of cpt item
-     * @param int $revision_id ID of revision for item
-     * @return void
-     * @see restore_revision() for details
-     */
-    abstract protected function _restore_cpt_item(int $post_id, int $revision_id);
-
-
-    /**
-     * Execution of this method is added to the end of the load_page_dependencies method in the parent
-     * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
-     * To fix we have to reset the current_screen using the page_slug
-     * (which is identical - or should be - to our registered_post_type id.)
-     * Also, since the core WP file loads the admin_header.php for WP
-     * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
-     * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function modify_current_screen()
-    {
-        // ONLY do this if the current page_route IS a cpt route
-        if (! $this->_cpt_route) {
-            return;
-        }
-        // routing things REALLY early b/c this is a cpt admin page
-        set_current_screen($this->_cpt_routes[ $this->_req_action ]);
-        $this->_current_screen       = get_current_screen();
-        $this->_current_screen->base = 'event-espresso';
-        $this->_add_help_tabs(); // we make sure we add any help tabs back in!
-        /*try {
+		// take care of updating any selected page_template IF this cpt supports it.
+
+		$page_template = $this->request->getRequestParam('page_template');
+		if ($this->_supports_page_templates($post->post_type) && ! empty($page_template)) {
+			// wp version aware.
+			if (RecommendedVersions::compareWordPressVersion('4.7')) {
+				$page_templates = wp_get_theme()->get_page_templates();
+			} else {
+				$post->page_template = $page_template;
+				$page_templates      = wp_get_theme()->get_page_templates($post);
+			}
+			if ($page_template !== 'default' && ! isset($page_templates[ $page_template ])) {
+				EE_Error::add_error(
+					esc_html__('Invalid Page Template.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				update_post_meta($post_id, '_wp_page_template', $page_template);
+			}
+		}
+		if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
+			return;
+		} //TODO we'll remove this after reimplementing autosave in 4.2
+		$this->_insert_update_cpt_item($post_id, $post);
+	}
+
+
+	/**
+	 * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
+	 * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
+	 * so we don't have to check for our CPT.
+	 *
+	 * @param int $post_id ID of the post
+	 * @return void
+	 */
+	public function dont_permanently_delete_ee_cpts(int $post_id)
+	{
+		// only do this if we're actually processing one of our CPTs
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			return;
+		}
+		delete_post_meta($post_id, '_wp_trash_meta_status');
+		delete_post_meta($post_id, '_wp_trash_meta_time');
+		// our cpts may have comments so let's take care of that too
+		delete_post_meta($post_id, '_wp_trash_meta_comments_status');
+	}
+
+
+	/**
+	 * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
+	 * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
+	 * in them. We also have our OWN action in here so addons can hook into the restore process easily.
+	 *
+	 * @param int $post_id     ID of cpt item
+	 * @param int $revision_id ID of revision being restored
+	 * @return void
+	 */
+	public function restore_revision(int $post_id, int $revision_id)
+	{
+		$this->_restore_cpt_item($post_id, $revision_id);
+		// global action
+		do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
+		// class specific action so you can limit hooking into a specific page.
+		do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+	}
+
+
+	/**
+	 * @param int $post_id     ID of cpt item
+	 * @param int $revision_id ID of revision for item
+	 * @return void
+	 * @see restore_revision() for details
+	 */
+	abstract protected function _restore_cpt_item(int $post_id, int $revision_id);
+
+
+	/**
+	 * Execution of this method is added to the end of the load_page_dependencies method in the parent
+	 * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
+	 * To fix we have to reset the current_screen using the page_slug
+	 * (which is identical - or should be - to our registered_post_type id.)
+	 * Also, since the core WP file loads the admin_header.php for WP
+	 * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
+	 * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function modify_current_screen()
+	{
+		// ONLY do this if the current page_route IS a cpt route
+		if (! $this->_cpt_route) {
+			return;
+		}
+		// routing things REALLY early b/c this is a cpt admin page
+		set_current_screen($this->_cpt_routes[ $this->_req_action ]);
+		$this->_current_screen       = get_current_screen();
+		$this->_current_screen->base = 'event-espresso';
+		$this->_add_help_tabs(); // we make sure we add any help tabs back in!
+		/*try {
             $this->_route_admin_request();
         } catch ( EE_Error $e ) {
             $e->get_error();
         }/**/
-    }
-
-
-    /**
-     * This allows child classes to modify the default editor title that appears when people add a new or edit an
-     * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
-     * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
-     * default to be.
-     *
-     * @param string $title The new title (or existing if there is no editor_title defined)
-     * @return string
-     */
-    public function add_custom_editor_default_title(string $title): string
-    {
-        return $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ] ?? $title;
-    }
-
-
-    /**
-     * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
-     *
-     * @param string $shortlink   The already generated shortlink
-     * @param int    $id          Post ID for this item
-     * @return string
-     * @deprecated $VID:$
-     * @see EventShortlinkButton::addButton()
-     */
-    public function add_shortlink_button_to_editor(string $shortlink, int $id): string
-    {
-        return EventShortlinkButton::addButton($shortlink, $id);
-    }
-
-
-    /**
-     * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
-     * already run in modify_current_screen())
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function route_admin_request()
-    {
-        if ($this->_cpt_route) {
-            return;
-        }
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    /**
-     * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
-     *
-     * @return void
-     */
-    public function cpt_post_form_hidden_input()
-    {
-        // we're also going to add the route value and the current page so we can direct autosave parsing correctly
-        echo '
+	}
+
+
+	/**
+	 * This allows child classes to modify the default editor title that appears when people add a new or edit an
+	 * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
+	 * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
+	 * default to be.
+	 *
+	 * @param string $title The new title (or existing if there is no editor_title defined)
+	 * @return string
+	 */
+	public function add_custom_editor_default_title(string $title): string
+	{
+		return $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ] ?? $title;
+	}
+
+
+	/**
+	 * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
+	 *
+	 * @param string $shortlink   The already generated shortlink
+	 * @param int    $id          Post ID for this item
+	 * @return string
+	 * @deprecated $VID:$
+	 * @see EventShortlinkButton::addButton()
+	 */
+	public function add_shortlink_button_to_editor(string $shortlink, int $id): string
+	{
+		return EventShortlinkButton::addButton($shortlink, $id);
+	}
+
+
+	/**
+	 * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
+	 * already run in modify_current_screen())
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function route_admin_request()
+	{
+		if ($this->_cpt_route) {
+			return;
+		}
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	/**
+	 * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
+	 *
+	 * @return void
+	 */
+	public function cpt_post_form_hidden_input()
+	{
+		// we're also going to add the route value and the current page so we can direct autosave parsing correctly
+		echo '
         <input type="hidden" name="ee_cpt_item_redirect_url" value="' . esc_url_raw($this->_admin_base_url) . '"/>
         <div id="ee-cpt-hidden-inputs">
             <input type="hidden" id="current_route" name="current_route" value="' . esc_attr($this->_current_view) . '"/>
             <input type="hidden" id="current_page" name="current_page" value="' . esc_attr($this->page_slug) . '"/>
         </div>';
-    }
-
-
-    /**
-     * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
-     *
-     * @param string $location Original location url
-     * @return string           new (or original) url to redirect to.
-     * @throws EE_Error
-     */
-    public function revision_redirect(string $location): string
-    {
-        // get revision
-        $revision = $this->request->getRequestParam('revision');
-        // can't do anything without revision so let's get out if not present
-        if (empty($revision)) {
-            return $location;
-        }
-        // get rev_post_data
-        $rev        = get_post($revision);
-        $admin_url  = $this->_admin_base_url;
-        $query_args = [
-            'action'   => 'edit',
-            'post'     => $rev->post_parent,
-            'revision' => $revision,
-            'message'  => 5,
-        ];
-        $this->_process_notices($query_args, true);
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-    /**
-     * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
-     *
-     * @param string $link    the original generated link
-     * @param int    $id      post id
-     * @return string          the link
-     */
-    public function modify_edit_post_link(string $link, int $id): string
-    {
-        $post = get_post($id);
-        $action = $this->request->getRequestParam('action');
-        if (
-            empty($action)
-            || ! isset($this->_cpt_routes[ $action ])
-            || $post->post_type !== $this->_cpt_routes[ $action ]
-        ) {
-            return $link;
-        }
-        $query_args = [
-            'action' => $this->_cpt_edit_routes[ $post->post_type ] ?? 'edit',
-            'post'   => $id,
-        ];
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-    /**
-     * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
-     * our routes.
-     *
-     * @param string $delete_link  original delete link
-     * @param int    $post_id      id of cpt object
-     * @return string new delete link
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function modify_delete_post_link(string $delete_link, int $post_id): string
-    {
-        $post = get_post($post_id);
-        $action = $this->request->getRequestParam('action');
-        if (
-            ! $post instanceof WP_Post
-            || empty($action)
-            || ! isset($this->_cpt_routes[ $action ])
-            || $post->post_type !== $this->_cpt_routes[ $action ]
-        ) {
-            return $delete_link;
-        }
-        $this->_set_model_object($post->ID, true);
-
-        // returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
-
-        return EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'page'   => $this->request->getRequestParam('page'),
-                'action' => $action,
-                $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() => $post->ID,
-            ],
-            admin_url()
-        );
-    }
-
-
-    /**
-     * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
-     * so that we can hijack the default redirect locations for wp custom post types
-     * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
-     *
-     * @param string $location This is the incoming currently set redirect location
-     * @param string $post_id  This is the 'ID' value of the wp_posts table
-     * @return string           the new location to redirect to
-     * @throws EE_Error
-     */
-    public function cpt_post_location_redirect(string $location, string $post_id): string
-    {
-        // we DO have a match so let's setup the url
-        // we have to get the post to determine our route
-        $post       = get_post($post_id);
-        $edit_route = $this->_cpt_edit_routes[ $post->post_type ];
-        // shared query_args
-        $query_args = ['action' => $edit_route, 'post' => $post_id];
-
-        $save = $this->request->getRequestParam('save');
-        $publish = $this->request->getRequestParam('publish');
-        $add_meta = $this->request->getRequestParam('addmeta');
-        $delete_meta = $this->request->getRequestParam('deletemeta');
-        if ($save || $publish) {
-            $status = get_post_status($post_id);
-            if ($publish) {
-                switch ($status) {
-                    case 'pending':
-                        $message = 8;
-                        break;
-                    case 'future':
-                        $message = 9;
-                        break;
-                    default:
-                        $message = 6;
-                }
-            } else {
-                $message = 'draft' === $status ? 10 : 1;
-            }
-        } elseif ($add_meta) {
-            $message = 2;
-        } elseif ($delete_meta) {
-            $message = 3;
-        } elseif ($this->request->getRequestParam('action') === 'post-quickpress-save-cont') {
-            $message = 7;
-        } else {
-            $message = 4;
-        }
-        // change the message if the post type is not viewable on the frontend
-        $this->_cpt_object = get_post_type_object($post->post_type);
-
-        $query_args['message'] = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
-        $this->_process_notices($query_args, true);
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-    /**
-     * This method is called to inject nav tabs on core WP cpt pages
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function inject_nav_tabs()
-    {
-        echo wp_kses($this->_get_main_nav_tabs(), AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * This just sets up the post update messages when an update form is loaded
-     *
-     * @param array $messages the original messages array
-     * @return array           the new messages array
-     */
-    public function post_update_messages(array $messages): array
-    {
-        global $post;
-        $id       = $this->request->getRequestParam('post');
-        $id       = empty($id) && is_object($post) ? $post->ID : null;
-        $revision = $this->request->getRequestParam('revision', 0, 'int');
-
-        $messages[ $post->post_type ] = [
-            0  => '', // Unused. Messages start at index 1.
-            1  => sprintf(
-                esc_html__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            2  => esc_html__('Custom field updated', 'event_espresso'),
-            3  => esc_html__('Custom field deleted.', 'event_espresso'),
-            4  => sprintf(esc_html__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            5  => $revision
-                ? sprintf(
-                    esc_html__('%s restored to revision from %s', 'event_espresso'),
-                    $this->_cpt_object->labels->singular_name,
-                    wp_post_revision_title($revision, false)
-                )
-                : false,
-            6  => sprintf(
-                esc_html__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            7  => sprintf(esc_html__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            8  => sprintf(
-                esc_html__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
-                '</a>'
-            ),
-            9  => sprintf(
-                esc_html__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n('M j, Y @ G:i', strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
-                '</a>'
-            ),
-            10 => sprintf(
-                esc_html__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
-                '</a>'
-            ),
-        ];
-        return $messages;
-    }
-
-
-    /**
-     * default method for the 'create_new' route for cpt admin pages.
-     * For reference what to include in here, see wp-admin/post-new.php
-     *
-     * @return void
-     */
-    protected function _create_new_cpt_item()
-    {
-        // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        global $post, $title, $post_type, $post_type_object;
-        $post_type        = $this->_cpt_routes[ $this->_req_action ];
-        $post_type_object = $this->_cpt_object;
-        $title            = $post_type_object->labels->add_new_item;
-        $post             = $post = get_default_post_to_edit($this->_cpt_routes[ $this->_req_action ], true);
-        add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
-        // modify the default editor title field with default title.
-        add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
-        $this->loadEditorTemplate();
-    }
-
-
-    /**
-     * Enqueues auto-save and loads the editor template
-     *
-     * @param bool $creating
-     */
-    private function loadEditorTemplate(bool $creating = true)
-    {
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        // these vars are used by the template
-        $editing = true;
-        $post_ID = $post->ID;
-        if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
-            // only enqueue autosave when creating event (necessary to get permalink/url generated)
-            // otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
-            $action = $this->request->getRequestParam('action');
-            if ($creating) {
-                wp_enqueue_script('autosave');
-            } elseif (
-                isset($this->_cpt_routes[ $action ])
-                && ! isset($this->_labels['hide_add_button_on_cpt_route'][ $action ])
-            ) {
-                $create_new_action = apply_filters(
-                    'FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
-                    'create_new',
-                    $this
-                );
-                $post_new_file     = EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action' => $create_new_action,
-                        'page'   => $this->page_slug,
-                    ],
-                    'admin.php'
-                );
-            }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
-        }
-    }
-
-
-    public function add_new_admin_page_global()
-    {
-        $admin_page = $this->request->getRequestParam('post', 0, DataType::INT) !== 0
-            ? 'post-php'
-            : 'post-new-php';
-        ?>
+	}
+
+
+	/**
+	 * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
+	 *
+	 * @param string $location Original location url
+	 * @return string           new (or original) url to redirect to.
+	 * @throws EE_Error
+	 */
+	public function revision_redirect(string $location): string
+	{
+		// get revision
+		$revision = $this->request->getRequestParam('revision');
+		// can't do anything without revision so let's get out if not present
+		if (empty($revision)) {
+			return $location;
+		}
+		// get rev_post_data
+		$rev        = get_post($revision);
+		$admin_url  = $this->_admin_base_url;
+		$query_args = [
+			'action'   => 'edit',
+			'post'     => $rev->post_parent,
+			'revision' => $revision,
+			'message'  => 5,
+		];
+		$this->_process_notices($query_args, true);
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+	/**
+	 * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
+	 *
+	 * @param string $link    the original generated link
+	 * @param int    $id      post id
+	 * @return string          the link
+	 */
+	public function modify_edit_post_link(string $link, int $id): string
+	{
+		$post = get_post($id);
+		$action = $this->request->getRequestParam('action');
+		if (
+			empty($action)
+			|| ! isset($this->_cpt_routes[ $action ])
+			|| $post->post_type !== $this->_cpt_routes[ $action ]
+		) {
+			return $link;
+		}
+		$query_args = [
+			'action' => $this->_cpt_edit_routes[ $post->post_type ] ?? 'edit',
+			'post'   => $id,
+		];
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+	/**
+	 * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
+	 * our routes.
+	 *
+	 * @param string $delete_link  original delete link
+	 * @param int    $post_id      id of cpt object
+	 * @return string new delete link
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function modify_delete_post_link(string $delete_link, int $post_id): string
+	{
+		$post = get_post($post_id);
+		$action = $this->request->getRequestParam('action');
+		if (
+			! $post instanceof WP_Post
+			|| empty($action)
+			|| ! isset($this->_cpt_routes[ $action ])
+			|| $post->post_type !== $this->_cpt_routes[ $action ]
+		) {
+			return $delete_link;
+		}
+		$this->_set_model_object($post->ID, true);
+
+		// returns something like `trash_event` or `trash_attendee` or `trash_venue`
+		$action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+
+		return EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'page'   => $this->request->getRequestParam('page'),
+				'action' => $action,
+				$this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() => $post->ID,
+			],
+			admin_url()
+		);
+	}
+
+
+	/**
+	 * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
+	 * so that we can hijack the default redirect locations for wp custom post types
+	 * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
+	 *
+	 * @param string $location This is the incoming currently set redirect location
+	 * @param string $post_id  This is the 'ID' value of the wp_posts table
+	 * @return string           the new location to redirect to
+	 * @throws EE_Error
+	 */
+	public function cpt_post_location_redirect(string $location, string $post_id): string
+	{
+		// we DO have a match so let's setup the url
+		// we have to get the post to determine our route
+		$post       = get_post($post_id);
+		$edit_route = $this->_cpt_edit_routes[ $post->post_type ];
+		// shared query_args
+		$query_args = ['action' => $edit_route, 'post' => $post_id];
+
+		$save = $this->request->getRequestParam('save');
+		$publish = $this->request->getRequestParam('publish');
+		$add_meta = $this->request->getRequestParam('addmeta');
+		$delete_meta = $this->request->getRequestParam('deletemeta');
+		if ($save || $publish) {
+			$status = get_post_status($post_id);
+			if ($publish) {
+				switch ($status) {
+					case 'pending':
+						$message = 8;
+						break;
+					case 'future':
+						$message = 9;
+						break;
+					default:
+						$message = 6;
+				}
+			} else {
+				$message = 'draft' === $status ? 10 : 1;
+			}
+		} elseif ($add_meta) {
+			$message = 2;
+		} elseif ($delete_meta) {
+			$message = 3;
+		} elseif ($this->request->getRequestParam('action') === 'post-quickpress-save-cont') {
+			$message = 7;
+		} else {
+			$message = 4;
+		}
+		// change the message if the post type is not viewable on the frontend
+		$this->_cpt_object = get_post_type_object($post->post_type);
+
+		$query_args['message'] = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
+		$this->_process_notices($query_args, true);
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+	/**
+	 * This method is called to inject nav tabs on core WP cpt pages
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function inject_nav_tabs()
+	{
+		echo wp_kses($this->_get_main_nav_tabs(), AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * This just sets up the post update messages when an update form is loaded
+	 *
+	 * @param array $messages the original messages array
+	 * @return array           the new messages array
+	 */
+	public function post_update_messages(array $messages): array
+	{
+		global $post;
+		$id       = $this->request->getRequestParam('post');
+		$id       = empty($id) && is_object($post) ? $post->ID : null;
+		$revision = $this->request->getRequestParam('revision', 0, 'int');
+
+		$messages[ $post->post_type ] = [
+			0  => '', // Unused. Messages start at index 1.
+			1  => sprintf(
+				esc_html__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			2  => esc_html__('Custom field updated', 'event_espresso'),
+			3  => esc_html__('Custom field deleted.', 'event_espresso'),
+			4  => sprintf(esc_html__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			5  => $revision
+				? sprintf(
+					esc_html__('%s restored to revision from %s', 'event_espresso'),
+					$this->_cpt_object->labels->singular_name,
+					wp_post_revision_title($revision, false)
+				)
+				: false,
+			6  => sprintf(
+				esc_html__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			7  => sprintf(esc_html__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			8  => sprintf(
+				esc_html__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+				'</a>'
+			),
+			9  => sprintf(
+				esc_html__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<strong>' . date_i18n('M j, Y @ G:i', strtotime($post->post_date)) . '</strong>',
+				'<a target="_blank" href="' . esc_url(get_permalink($id)),
+				'</a>'
+			),
+			10 => sprintf(
+				esc_html__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+				'</a>'
+			),
+		];
+		return $messages;
+	}
+
+
+	/**
+	 * default method for the 'create_new' route for cpt admin pages.
+	 * For reference what to include in here, see wp-admin/post-new.php
+	 *
+	 * @return void
+	 */
+	protected function _create_new_cpt_item()
+	{
+		// gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		global $post, $title, $post_type, $post_type_object;
+		$post_type        = $this->_cpt_routes[ $this->_req_action ];
+		$post_type_object = $this->_cpt_object;
+		$title            = $post_type_object->labels->add_new_item;
+		$post             = $post = get_default_post_to_edit($this->_cpt_routes[ $this->_req_action ], true);
+		add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
+		// modify the default editor title field with default title.
+		add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
+		$this->loadEditorTemplate();
+	}
+
+
+	/**
+	 * Enqueues auto-save and loads the editor template
+	 *
+	 * @param bool $creating
+	 */
+	private function loadEditorTemplate(bool $creating = true)
+	{
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		// these vars are used by the template
+		$editing = true;
+		$post_ID = $post->ID;
+		if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
+			// only enqueue autosave when creating event (necessary to get permalink/url generated)
+			// otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
+			$action = $this->request->getRequestParam('action');
+			if ($creating) {
+				wp_enqueue_script('autosave');
+			} elseif (
+				isset($this->_cpt_routes[ $action ])
+				&& ! isset($this->_labels['hide_add_button_on_cpt_route'][ $action ])
+			) {
+				$create_new_action = apply_filters(
+					'FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
+					'create_new',
+					$this
+				);
+				$post_new_file     = EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action' => $create_new_action,
+						'page'   => $this->page_slug,
+					],
+					'admin.php'
+				);
+			}
+			include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+		}
+	}
+
+
+	public function add_new_admin_page_global()
+	{
+		$admin_page = $this->request->getRequestParam('post', 0, DataType::INT) !== 0
+			? 'post-php'
+			: 'post-new-php';
+		?>
         <script type="text/javascript">
             adminpage = '<?php echo esc_js($admin_page); ?>';
         </script>
         <?php
-    }
-
-
-    /**
-     * default method for the 'edit' route for cpt admin pages
-     * For reference on what to put in here, refer to wp-admin/post.php
-     *
-     * @return void
-     */
-    protected function _edit_cpt_item()
-    {
-        global $post, $post_type, $post_type_object, $title;
-        $post_id = $this->request->getRequestParam('post', 0, DataType::INT);
-        $post    = $post_id ? get_post($post_id, OBJECT, 'edit') : null;
-        if (empty($post)) {
-            wp_die(
-                esc_html__(
-                    "You attempted to edit an item that doesn't exist. Perhaps it was deleted?",
-                    'event_espresso'
-                )
-            );
-        }
-
-        $post_lock = $this->request->getRequestParam('get-post-lock');
-        if ($post_lock) {
-            wp_set_post_lock($post_id);
-            EEH_URL::safeRedirectAndExit(get_edit_post_link($post_id, 'url'));
-        }
-
-        // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        $post_type        = $this->_cpt_routes[ $this->_req_action ];
-        $post_type_object = $this->_cpt_object;
-        $title = $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ]
-                 ?? $post_type_object->labels->edit_item;
-
-        if (! wp_check_post_lock($post->ID)) {
-            wp_set_post_lock($post->ID);
-        }
-        add_action('admin_footer', '_admin_notice_post_locked');
-        if (post_type_supports($this->_cpt_routes[ $this->_req_action ], 'comments')) {
-            wp_enqueue_script('admin-comments');
-            enqueue_comment_hotkeys_js();
-        }
-        add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
-        // modify the default editor title field with default title.
-        add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
-        $this->loadEditorTemplate(false);
-    }
-
-
-
-    /**
-     * some getters
-     */
-    /**
-     * This returns the protected _cpt_model_obj property
-     *
-     * @return EE_CPT_Base
-     */
-    public function get_cpt_model_obj()
-    {
-        return $this->_cpt_model_obj;
-    }
+	}
+
+
+	/**
+	 * default method for the 'edit' route for cpt admin pages
+	 * For reference on what to put in here, refer to wp-admin/post.php
+	 *
+	 * @return void
+	 */
+	protected function _edit_cpt_item()
+	{
+		global $post, $post_type, $post_type_object, $title;
+		$post_id = $this->request->getRequestParam('post', 0, DataType::INT);
+		$post    = $post_id ? get_post($post_id, OBJECT, 'edit') : null;
+		if (empty($post)) {
+			wp_die(
+				esc_html__(
+					"You attempted to edit an item that doesn't exist. Perhaps it was deleted?",
+					'event_espresso'
+				)
+			);
+		}
+
+		$post_lock = $this->request->getRequestParam('get-post-lock');
+		if ($post_lock) {
+			wp_set_post_lock($post_id);
+			EEH_URL::safeRedirectAndExit(get_edit_post_link($post_id, 'url'));
+		}
+
+		// template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		$post_type        = $this->_cpt_routes[ $this->_req_action ];
+		$post_type_object = $this->_cpt_object;
+		$title = $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ]
+				 ?? $post_type_object->labels->edit_item;
+
+		if (! wp_check_post_lock($post->ID)) {
+			wp_set_post_lock($post->ID);
+		}
+		add_action('admin_footer', '_admin_notice_post_locked');
+		if (post_type_supports($this->_cpt_routes[ $this->_req_action ], 'comments')) {
+			wp_enqueue_script('admin-comments');
+			enqueue_comment_hotkeys_js();
+		}
+		add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
+		// modify the default editor title field with default title.
+		add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
+		$this->loadEditorTemplate(false);
+	}
+
+
+
+	/**
+	 * some getters
+	 */
+	/**
+	 * This returns the protected _cpt_model_obj property
+	 *
+	 * @return EE_CPT_Base
+	 */
+	public function get_cpt_model_obj()
+	{
+		return $this->_cpt_model_obj;
+	}
 }

core/admin/EE_Admin.core.php

Indentation +998 added lines, -998 removed lines

@@ -20,1002 +20,1002 @@
  */
 final class EE_Admin implements InterminableInterface
 {
-    /**
-     * @var EE_Admin $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
-     */
-    private $persistent_admin_notice_manager;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface  $loader
-     * @param RequestInterface $request
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function instance(LoaderInterface $loader = null, RequestInterface $request = null)
-    {
-        // check if class object is instantiated
-        if (! EE_Admin::$_instance instanceof EE_Admin) {
-            EE_Admin::$_instance = new EE_Admin($loader, $request);
-        }
-        return EE_Admin::$_instance;
-    }
-
-
-    /**
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        EE_Admin::$_instance = null;
-        $loader = LoaderFactory::getLoader();
-        $request = $loader->getShared('EventEspresso\core\services\request\Request');
-        return EE_Admin::instance($loader, $request);
-    }
-
-
-    /**
-     * @param LoaderInterface  $loader
-     * @param RequestInterface $request
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct(LoaderInterface $loader, RequestInterface $request)
-    {
-        $this->loader = $loader;
-        $this->request = $request;
-        // define global EE_Admin constants
-        $this->_define_all_constants();
-        // set autoloaders for our admin page classes based on included path information
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_ADMIN);
-        // reset Environment config (we only do this on admin page loads);
-        EE_Registry::instance()->CFG->environment->recheck_values();
-        // load EE_Request_Handler early
-        add_action('AHEE__EE_System__initialize_last', [$this, 'init']);
-        add_action('admin_init', [$this, 'admin_init'], 100);
-        if (! $this->request->isAjax()) {
-            // admin hooks
-            add_action('admin_notices', [$this, 'display_admin_notices'], 10);
-            add_action('network_admin_notices', [$this, 'display_admin_notices'], 10);
-            add_filter('pre_update_option', [$this, 'check_for_invalid_datetime_formats'], 100, 2);
-            add_filter('plugin_action_links', [$this, 'filter_plugin_actions'], 10, 2);
-            add_filter('admin_footer_text', [$this, 'espresso_admin_footer']);
-            add_action('display_post_states', [$this, 'displayStateForCriticalPages'], 10, 2);
-            add_filter('plugin_row_meta', [$this, 'addLinksToPluginRowMeta'], 10, 2);
-        }
-        do_action('AHEE__EE_Admin__loaded');
-    }
-
-
-    /**
-     * _define_all_constants
-     * define constants that are set globally for all admin pages
-     *
-     * @return void
-     */
-    private function _define_all_constants()
-    {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
-            define('WP_AJAX_URL', admin_url('admin-ajax.php'));
-        }
-    }
-
-
-    /**
-     * filter_plugin_actions - adds links to the Plugins page listing
-     *
-     * @param array  $links
-     * @param string $plugin
-     * @return    array
-     */
-    public function filter_plugin_actions($links, $plugin)
-    {
-        // set $main_file in stone
-        static $main_file;
-        // if $main_file is not set yet
-        if (! $main_file) {
-            $main_file = EE_PLUGIN_BASENAME;
-        }
-        if ($plugin === $main_file) {
-            // compare current plugin to this one
-            if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
-                $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
-                                    . ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
-                                    . esc_html__('Maintenance Mode Active', 'event_espresso')
-                                    . '</a>';
-                array_unshift($links, $maintenance_link);
-            } else {
-                $org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
-                                     . esc_html__('Settings', 'event_espresso')
-                                     . '</a>';
-                $events_link       = '<a href="admin.php?page=espresso_events">'
-                                     . esc_html__('Events', 'event_espresso')
-                                     . '</a>';
-                // add before other links
-                array_unshift($links, $org_settings_link, $events_link);
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * hide_admin_pages_except_maintenance_mode
-     *
-     * @param array $admin_page_folder_names
-     * @return array
-     */
-    public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = [])
-    {
-        return [
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
-            'about'       => EE_ADMIN_PAGES . 'about/',
-            'support'     => EE_ADMIN_PAGES . 'support/',
-        ];
-    }
-
-
-    /**
-     * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
-     * EE_Front_Controller's init phases have run
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws ServiceNotFoundException
-     */
-    public function init()
-    {
-        // only enable most of the EE_Admin IF we're not in full maintenance mode
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->initModelsReady();
-        }
-        // run the admin page factory but ONLY if:
-        // - it is a regular non ajax admin request
-        // - we are doing an ee admin ajax request
-        if ($this->request->isAdmin() || $this->request->isAdminAjax() || $this->request->isActivation()) {
-            try {
-                // this loads the controller for the admin pages which will setup routing etc
-                $admin_page_loader = $this->loader->getShared('EE_Admin_Page_Loader', [$this->loader]);
-                /** @var EE_Admin_Page_Loader $admin_page_loader */
-                $admin_page_loader->init();
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        if ($this->request->isAjax()) {
-            return;
-        }
-        add_filter('content_save_pre', [$this, 'its_eSpresso'], 10, 1);
-        // make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-        add_action('admin_head', [$this, 'enable_hidden_ee_nav_menu_metaboxes'], 10);
-        add_action('admin_head', [$this, 'register_custom_nav_menu_boxes'], 10);
-        // exclude EE critical pages from all nav menus and wp_list_pages
-        add_filter('nav_menu_meta_box_object', [$this, 'remove_pages_from_nav_menu'], 10);
-    }
-
-
-    /**
-     * Gets the loader (and if it wasn't previously set, sets it)
-     *
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader()
-    {
-        return $this->loader;
-    }
-
-
-    /**
-     * Method that's fired on admin requests (including admin ajax) but only when the models are usable
-     * (ie, the site isn't in maintenance mode)
-     *
-     * @return void
-     * @throws EE_Error
-     * @since 4.9.63.p
-     */
-    protected function initModelsReady()
-    {
-        // ok so we want to enable the entire admin
-        $this->persistent_admin_notice_manager = $this->loader->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $this->persistent_admin_notice_manager->setReturnUrl(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'   => $this->request->getRequestParam('page', ''),
-                    'action' => $this->request->getRequestParam('action', ''),
-                ],
-                EE_ADMIN_URL
-            )
-        );
-        $this->maybeSetDatetimeWarningNotice();
-        // at a glance dashboard widget
-        add_filter('dashboard_glance_items', [$this, 'dashboard_glance_items'], 10);
-        // filter for get_edit_post_link used on comments for custom post types
-        add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
-    }
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function maybeSetDatetimeWarningNotice()
-    {
-        // add dismissible notice for datetime changes.  Only valid if site does not have a timezone_string set.
-        // @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
-        // with this.  But after enough time (indeterminate at this point) we can just remove this notice.
-        // this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
-        if (
-            apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
-            && ! get_option('timezone_string')
-            && EEM_Event::instance()->count() > 0
-        ) {
-            new PersistentAdminNotice(
-                'datetime_fix_notice',
-                sprintf(
-                    esc_html__(
-                        '%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>',
-                    '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
-                    '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'page'   => 'espresso_maintenance_settings',
-                            'action' => 'datetime_tools',
-                        ],
-                        admin_url('admin.php')
-                    ) . '">'
-                ),
-                false,
-                'manage_options',
-                'datetime_fix_persistent_notice'
-            );
-        }
-    }
-
-
-    /**
-     * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
-     * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
-     * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
-     * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
-     * normal property on the post_type object.  It's found ONLY in this particular context.
-     *
-     * @param WP_Post $post_type WP post type object
-     * @return WP_Post
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_pages_from_nav_menu($post_type)
-    {
-        // if this isn't the "pages" post type let's get out
-        if ($post_type->name !== 'page') {
-            return $post_type;
-        }
-        $critical_pages            = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-        $post_type->_default_query = [
-            'post__not_in' => $critical_pages,
-        ];
-        return $post_type;
-    }
-
-
-    /**
-     * WP by default only shows three metaboxes in "nav-menus.php" for first times users.
-     * We want to make sure our metaboxes get shown as well
-     *
-     * @return void
-     */
-    public function enable_hidden_ee_nav_menu_metaboxes()
-    {
-        global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
-            return;
-        }
-        $user = wp_get_current_user();
-        // has this been done yet?
-        if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
-            return;
-        }
-
-        $hidden_meta_boxes  = get_user_option('metaboxhidden_nav-menus', $user->ID);
-        $initial_meta_boxes = apply_filters(
-            'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
-            [
-                'nav-menu-theme-locations',
-                'add-page',
-                'add-custom-links',
-                'add-category',
-                'add-espresso_events',
-                'add-espresso_venues',
-                'add-espresso_event_categories',
-                'add-espresso_venue_categories',
-                'add-post-type-post',
-                'add-post-type-page',
-            ]
-        );
-
-        if (is_array($hidden_meta_boxes)) {
-            foreach ($hidden_meta_boxes as $key => $meta_box_id) {
-                if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
-                }
-            }
-        }
-        update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
-        update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
-    }
-
-
-    /**
-     * This method simply registers custom nav menu boxes for "nav_menus.php route"
-     * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
-     *
-     * @return void
-     * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
-     *         addons etc.
-     */
-    public function register_custom_nav_menu_boxes()
-    {
-        add_meta_box(
-            'add-extra-nav-menu-pages',
-            esc_html__('Event Espresso Pages', 'event_espresso'),
-            [$this, 'ee_cpt_archive_pages'],
-            'nav-menus',
-            'side',
-            'core'
-        );
-        add_filter(
-            "postbox_classes_nav-menus_add-extra-nav-menu-pages",
-            function ($classes) {
-                array_push($classes, 'ee-admin-container');
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     * Use this to edit the post link for our cpts so that the edit link points to the correct page.
-     *
-     * @param string $link the original link generated by wp
-     * @param int    $id   post id
-     * @return string  the (maybe) modified link
-     * @since   4.3.0
-     */
-    public function modify_edit_post_link($link, $id)
-    {
-        if (! $post = get_post($id)) {
-            return $link;
-        }
-        if ($post->post_type === 'espresso_attendees') {
-            $query_args = [
-                'action' => 'edit_attendee',
-                'post'   => $id,
-            ];
-            return EEH_URL::add_query_args_and_nonce(
-                $query_args,
-                admin_url('admin.php?page=espresso_registrations')
-            );
-        }
-        return $link;
-    }
-
-
-    public function ee_cpt_archive_pages()
-    {
-        global $nav_menu_selected_id;
-        $removed_args = [
-            'action',
-            'customlink-tab',
-            'edit-menu-item',
-            'menu-item',
-            'page-tab',
-            '_wpnonce',
-        ];
-        $nav_tab_link = $nav_menu_selected_id
-            ? esc_url(
-                add_query_arg(
-                    'extra-nav-menu-pages-tab',
-                    'event-archives',
-                    remove_query_arg($removed_args)
-                )
-            )
-            : '';
-        $select_all_link = esc_url(
-            add_query_arg(
-                [
-                    'extra-nav-menu-pages-tab' => 'event-archives',
-                    'selectall'                => 1,
-                ],
-                remove_query_arg($removed_args)
-            )
-        );
-        $pages = $this->_get_extra_nav_menu_pages_items();
-        $args['walker'] = new Walker_Nav_Menu_Checklist(false);
-        ;
-        $nav_menu_pages_items = walk_nav_menu_tree(
-            array_map(
-                [$this, '_setup_extra_nav_menu_pages_items'],
-                $pages
-            ),
-            0,
-            (object) $args
-        );
-        EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'cpt_archive_page.template.php',
-            [
-                'nav_menu_selected_id' => $nav_menu_selected_id,
-                'nav_menu_pages_items' => $nav_menu_pages_items,
-                'nav_tab_link'         => $nav_tab_link,
-                'select_all_link'      => $select_all_link,
-            ]
-        );
-    }
-
-
-    /**
-     * Returns an array of event archive nav items.
-     *
-     * @return array
-     * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
-     *        method we use for getting the extra nav menu items
-     */
-    private function _get_extra_nav_menu_pages_items()
-    {
-        $menuitems[] = [
-            'title'       => esc_html__('Event List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_events'),
-            'description' => esc_html__('Archive page for all events.', 'event_espresso'),
-        ];
-        return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
-    }
-
-
-    /**
-     * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
-     * the properties and converts it to the menu item object.
-     *
-     * @param $menu_item_values
-     * @return stdClass
-     * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
-     */
-    private function _setup_extra_nav_menu_pages_items($menu_item_values)
-    {
-        $menu_item = new stdClass();
-        $keys      = [
-            'ID'               => 0,
-            'db_id'            => 0,
-            'menu_item_parent' => 0,
-            'object_id'        => -1,
-            'post_parent'      => 0,
-            'type'             => 'custom',
-            'object'           => '',
-            'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
-            'title'            => '',
-            'url'              => '',
-            'target'           => '',
-            'attr_title'       => '',
-            'description'      => '',
-            'classes'          => [],
-            'xfn'              => '',
-        ];
-        foreach ($keys as $key => $value) {
-            $menu_item->{$key} = $menu_item_values[ $key ] ?? $value;
-        }
-        return $menu_item;
-    }
-
-
-    /**
-     * admin_init
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function admin_init()
-    {
-        /**
-         * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
-         * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
-         * - check if doing post processing.
-         * - check if doing post processing of one of EE CPTs
-         * - instantiate the corresponding EE CPT model for the post_type being processed.
-         */
-        $action    = $this->request->getRequestParam('action');
-        $post_type = $this->request->getRequestParam('post_type');
-        if ($post_type && $action === 'editpost') {
-            /** @var CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->loader->getShared(CustomPostTypeDefinitions::class);
-            $custom_post_types->getCustomPostTypeModels($post_type);
-        }
-
-
-        if (! $this->request->isAjax()) {
-            /**
-             * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
-             * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
-             * Pages" tab in the EE General Settings Admin page.
-             * This is for user-proofing.
-             */
-            add_filter('wp_dropdown_pages', [$this, 'modify_dropdown_pages']);
-            if (EE_Maintenance_Mode::instance()->models_can_query()) {
-                $this->adminInitModelsReady();
-            }
-        }
-    }
-
-
-    /**
-     * Runs on admin_init but only if models are usable (ie, we're not in maintenance mode)
-     */
-    protected function adminInitModelsReady()
-    {
-        if (function_exists('wp_add_privacy_policy_content')) {
-            $this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
-        }
-    }
-
-
-    /**
-     * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
-     *
-     * @param string $output Current output.
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function modify_dropdown_pages($output)
-    {
-        // get critical pages
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-
-        // split current output by line break for easier parsing.
-        $split_output = explode("\n", $output);
-
-        // loop through to remove any critical pages from the array.
-        foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
-            foreach ($split_output as $key => $haystack) {
-                if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
-                }
-            }
-        }
-        // replace output with the new contents
-        return implode("\n", $split_output);
-    }
-
-
-    /**
-     * display_admin_notices
-     *
-     * @return void
-     */
-    public function display_admin_notices()
-    {
-        echo EE_Error::get_notices(); // already escaped
-    }
-
-
-    /**
-     * @param array $elements
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function dashboard_glance_items($elements)
-    {
-        $elements                        = is_array($elements) ? $elements : [$elements];
-        $events                          = EEM_Event::instance()->count();
-        $items['events']['url']          = EE_Admin_Page::add_query_args_and_nonce(
-            ['page' => 'espresso_events'],
-            admin_url('admin.php')
-        );
-        $items['events']['text']         = sprintf(
-            esc_html(
-                _n('%s Event', '%s Events', $events, 'event_espresso')
-            ),
-            number_format_i18n($events)
-        );
-        $items['events']['title']        = esc_html__('Click to view all Events', 'event_espresso');
-        $registrations                   = EEM_Registration::instance()->count(
-            [
-                [
-                    'STS_ID' => ['!=', EEM_Registration::status_id_incomplete],
-                ],
-            ]
-        );
-        $items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
-            ['page' => 'espresso_registrations'],
-            admin_url('admin.php')
-        );
-        $items['registrations']['text']  = sprintf(
-            esc_html(
-                _n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
-            ),
-            number_format_i18n($registrations)
-        );
-        $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
-
-        $items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
-
-        foreach ($items as $type => $item_properties) {
-            $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
-                $item_properties['url'],
-                $item_properties['title'],
-                $item_properties['text']
-            );
-        }
-        return $elements;
-    }
-
-
-    /**
-     * check_for_invalid_datetime_formats
-     * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
-     * their selected format can be parsed by PHP
-     *
-     * @param    $value
-     * @param    $option
-     * @return    string
-     */
-    public function check_for_invalid_datetime_formats($value, $option)
-    {
-        // check for date_format or time_format
-        switch ($option) {
-            case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
-                break;
-            case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
-                break;
-            default:
-                $date_time_format = false;
-        }
-        // do we have a date_time format to check ?
-        if ($date_time_format) {
-            $error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
-
-            if (is_array($error_msg)) {
-                $msg = '<p>'
-                       . sprintf(
-                           esc_html__(
-                               'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
-                               'event_espresso'
-                           ),
-                           date($date_time_format),
-                           $date_time_format
-                       )
-                       . '</p><p><ul>';
-
-
-                foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
-                }
-
-                $msg .= '</ul></p><p>'
-                        . sprintf(
-                            esc_html__(
-                                '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
-                                'event_espresso'
-                            ),
-                            '<span style="color:#D54E21;">',
-                            '</span>'
-                        )
-                        . '</p>';
-
-                // trigger WP settings error
-                add_settings_error(
-                    'date_format',
-                    'date_format',
-                    $msg
-                );
-
-                // set format to something valid
-                switch ($option) {
-                    case 'date_format':
-                        $value = 'F j, Y';
-                        break;
-                    case 'time_format':
-                        $value = 'g:i a';
-                        break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
-     *
-     * @param $content
-     * @return    string
-     */
-    public function its_eSpresso($content)
-    {
-        return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
-    }
-
-
-    /**
-     * espresso_admin_footer
-     *
-     * @return    string
-     */
-    public function espresso_admin_footer()
-    {
-        return EEH_Template::powered_by_event_espresso('aln-cntr', '', ['utm_content' => 'admin_footer']);
-    }
-
-
-    /**
-     * Hooks into the "post states" filter in a wp post type list table.
-     *
-     * @param array   $post_states
-     * @param WP_Post $post
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function displayStateForCriticalPages($post_states, $post)
-    {
-        $post_states = (array) $post_states;
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
-            return $post_states;
-        }
-        /** @var EE_Core_Config $config */
-        $config = $this->loader->getShared('EE_Config')->core;
-        if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
-            $post_states[] = sprintf(
-            /* Translators: Using company name - Event Espresso Critical Page */
-                esc_html__('%s Critical Page', 'event_espresso'),
-                'Event Espresso'
-            );
-        }
-        return $post_states;
-    }
-
-
-    /**
-     * Show documentation links on the plugins page
-     *
-     * @param mixed $meta Plugin Row Meta
-     * @param mixed $file Plugin Base file
-     * @return array
-     */
-    public function addLinksToPluginRowMeta($meta, $file)
-    {
-        if (EE_PLUGIN_BASENAME === $file) {
-            $row_meta = [
-                'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso documentation', 'event_espresso')
-                          . '">'
-                          . esc_html__('Docs', 'event_espresso')
-                          . '</a>',
-                'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso API docs', 'event_espresso')
-                          . '">'
-                          . esc_html__('API docs', 'event_espresso')
-                          . '</a>',
-            ];
-            return array_merge($meta, $row_meta);
-        }
-        return (array) $meta;
-    }
-
-     /**************************************************************************************/
-     /************************************* DEPRECATED *************************************/
-     /**************************************************************************************/
-
-
-    /**
-     * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
-     * EE_Admin_Page route is called.
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-    }
-
-
-    /**
-     * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * static method for registering ee admin page.
-     * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
-     *
-     * @param       $page_basename
-     * @param       $page_path
-     * @param array $config
-     * @return void
-     * @throws EE_Error
-     * @see        EE_Register_Admin_Page::register()
-     * @since      4.3.0
-     * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
-     */
-    public static function register_ee_admin_page($page_basename, $page_path, $config = [])
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
-                    'event_espresso'
-                ),
-                $page_basename
-            ),
-            '4.3'
-        );
-        if (class_exists('EE_Register_Admin_Page')) {
-            $config['page_path'] = $page_path;
-        }
-        EE_Register_Admin_Page::register($page_basename, $config);
-    }
-
-
-    /**
-     * @param int      $post_ID
-     * @param \WP_Post $post
-     * @return void
-     * @deprecated 4.8.41
-     */
-    public static function parse_post_content_on_save($post_ID, $post)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @param  $option
-     * @param  $old_value
-     * @param  $value
-     * @return void
-     * @deprecated 4.8.41
-     */
-    public function reset_page_for_posts_on_change($option, $old_value, $value)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.27
-     */
-    public function get_persistent_admin_notices()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @deprecated 4.9.27
-     */
-    public function dismiss_ee_nag_notice_callback()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-        $this->persistent_admin_notice_manager->dismissNotice();
-    }
-
-
-    /**
-     * @return void
-     * @deprecated $VID:$
-     */
-    public function enqueue_admin_scripts()
-    {
-    }
-
-
-
-    /**
-     * @return RequestInterface
-     * @deprecated $VID:$
-     */
-    public function get_request()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                'EventEspresso\core\services\request\Request'
-            ),
-            '$VID:$'
-        );
-        return $this->request;
-    }
-
-
-    /**
-     * @deprecated $VID:$
-     */
-    public function hookIntoWpPluginsPage()
-    {
-    }
+	/**
+	 * @var EE_Admin $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
+	 */
+	private $persistent_admin_notice_manager;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface  $loader
+	 * @param RequestInterface $request
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function instance(LoaderInterface $loader = null, RequestInterface $request = null)
+	{
+		// check if class object is instantiated
+		if (! EE_Admin::$_instance instanceof EE_Admin) {
+			EE_Admin::$_instance = new EE_Admin($loader, $request);
+		}
+		return EE_Admin::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		EE_Admin::$_instance = null;
+		$loader = LoaderFactory::getLoader();
+		$request = $loader->getShared('EventEspresso\core\services\request\Request');
+		return EE_Admin::instance($loader, $request);
+	}
+
+
+	/**
+	 * @param LoaderInterface  $loader
+	 * @param RequestInterface $request
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct(LoaderInterface $loader, RequestInterface $request)
+	{
+		$this->loader = $loader;
+		$this->request = $request;
+		// define global EE_Admin constants
+		$this->_define_all_constants();
+		// set autoloaders for our admin page classes based on included path information
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_ADMIN);
+		// reset Environment config (we only do this on admin page loads);
+		EE_Registry::instance()->CFG->environment->recheck_values();
+		// load EE_Request_Handler early
+		add_action('AHEE__EE_System__initialize_last', [$this, 'init']);
+		add_action('admin_init', [$this, 'admin_init'], 100);
+		if (! $this->request->isAjax()) {
+			// admin hooks
+			add_action('admin_notices', [$this, 'display_admin_notices'], 10);
+			add_action('network_admin_notices', [$this, 'display_admin_notices'], 10);
+			add_filter('pre_update_option', [$this, 'check_for_invalid_datetime_formats'], 100, 2);
+			add_filter('plugin_action_links', [$this, 'filter_plugin_actions'], 10, 2);
+			add_filter('admin_footer_text', [$this, 'espresso_admin_footer']);
+			add_action('display_post_states', [$this, 'displayStateForCriticalPages'], 10, 2);
+			add_filter('plugin_row_meta', [$this, 'addLinksToPluginRowMeta'], 10, 2);
+		}
+		do_action('AHEE__EE_Admin__loaded');
+	}
+
+
+	/**
+	 * _define_all_constants
+	 * define constants that are set globally for all admin pages
+	 *
+	 * @return void
+	 */
+	private function _define_all_constants()
+	{
+		if (! defined('EE_ADMIN_URL')) {
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
+			define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
+		}
+	}
+
+
+	/**
+	 * filter_plugin_actions - adds links to the Plugins page listing
+	 *
+	 * @param array  $links
+	 * @param string $plugin
+	 * @return    array
+	 */
+	public function filter_plugin_actions($links, $plugin)
+	{
+		// set $main_file in stone
+		static $main_file;
+		// if $main_file is not set yet
+		if (! $main_file) {
+			$main_file = EE_PLUGIN_BASENAME;
+		}
+		if ($plugin === $main_file) {
+			// compare current plugin to this one
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
+									. ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
+									. esc_html__('Maintenance Mode Active', 'event_espresso')
+									. '</a>';
+				array_unshift($links, $maintenance_link);
+			} else {
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
+									 . esc_html__('Settings', 'event_espresso')
+									 . '</a>';
+				$events_link       = '<a href="admin.php?page=espresso_events">'
+									 . esc_html__('Events', 'event_espresso')
+									 . '</a>';
+				// add before other links
+				array_unshift($links, $org_settings_link, $events_link);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * hide_admin_pages_except_maintenance_mode
+	 *
+	 * @param array $admin_page_folder_names
+	 * @return array
+	 */
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = [])
+	{
+		return [
+			'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
+			'about'       => EE_ADMIN_PAGES . 'about/',
+			'support'     => EE_ADMIN_PAGES . 'support/',
+		];
+	}
+
+
+	/**
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
+	 * EE_Front_Controller's init phases have run
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws ServiceNotFoundException
+	 */
+	public function init()
+	{
+		// only enable most of the EE_Admin IF we're not in full maintenance mode
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->initModelsReady();
+		}
+		// run the admin page factory but ONLY if:
+		// - it is a regular non ajax admin request
+		// - we are doing an ee admin ajax request
+		if ($this->request->isAdmin() || $this->request->isAdminAjax() || $this->request->isActivation()) {
+			try {
+				// this loads the controller for the admin pages which will setup routing etc
+				$admin_page_loader = $this->loader->getShared('EE_Admin_Page_Loader', [$this->loader]);
+				/** @var EE_Admin_Page_Loader $admin_page_loader */
+				$admin_page_loader->init();
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		if ($this->request->isAjax()) {
+			return;
+		}
+		add_filter('content_save_pre', [$this, 'its_eSpresso'], 10, 1);
+		// make sure our CPTs and custom taxonomy metaboxes get shown for first time users
+		add_action('admin_head', [$this, 'enable_hidden_ee_nav_menu_metaboxes'], 10);
+		add_action('admin_head', [$this, 'register_custom_nav_menu_boxes'], 10);
+		// exclude EE critical pages from all nav menus and wp_list_pages
+		add_filter('nav_menu_meta_box_object', [$this, 'remove_pages_from_nav_menu'], 10);
+	}
+
+
+	/**
+	 * Gets the loader (and if it wasn't previously set, sets it)
+	 *
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader()
+	{
+		return $this->loader;
+	}
+
+
+	/**
+	 * Method that's fired on admin requests (including admin ajax) but only when the models are usable
+	 * (ie, the site isn't in maintenance mode)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.9.63.p
+	 */
+	protected function initModelsReady()
+	{
+		// ok so we want to enable the entire admin
+		$this->persistent_admin_notice_manager = $this->loader->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$this->persistent_admin_notice_manager->setReturnUrl(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'   => $this->request->getRequestParam('page', ''),
+					'action' => $this->request->getRequestParam('action', ''),
+				],
+				EE_ADMIN_URL
+			)
+		);
+		$this->maybeSetDatetimeWarningNotice();
+		// at a glance dashboard widget
+		add_filter('dashboard_glance_items', [$this, 'dashboard_glance_items'], 10);
+		// filter for get_edit_post_link used on comments for custom post types
+		add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
+	}
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function maybeSetDatetimeWarningNotice()
+	{
+		// add dismissible notice for datetime changes.  Only valid if site does not have a timezone_string set.
+		// @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
+		// with this.  But after enough time (indeterminate at this point) we can just remove this notice.
+		// this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
+		if (
+			apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
+			&& ! get_option('timezone_string')
+			&& EEM_Event::instance()->count() > 0
+		) {
+			new PersistentAdminNotice(
+				'datetime_fix_notice',
+				sprintf(
+					esc_html__(
+						'%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>',
+					'<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
+					'</a>',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'page'   => 'espresso_maintenance_settings',
+							'action' => 'datetime_tools',
+						],
+						admin_url('admin.php')
+					) . '">'
+				),
+				false,
+				'manage_options',
+				'datetime_fix_persistent_notice'
+			);
+		}
+	}
+
+
+	/**
+	 * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
+	 * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
+	 * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
+	 * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
+	 * normal property on the post_type object.  It's found ONLY in this particular context.
+	 *
+	 * @param WP_Post $post_type WP post type object
+	 * @return WP_Post
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_pages_from_nav_menu($post_type)
+	{
+		// if this isn't the "pages" post type let's get out
+		if ($post_type->name !== 'page') {
+			return $post_type;
+		}
+		$critical_pages            = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+		$post_type->_default_query = [
+			'post__not_in' => $critical_pages,
+		];
+		return $post_type;
+	}
+
+
+	/**
+	 * WP by default only shows three metaboxes in "nav-menus.php" for first times users.
+	 * We want to make sure our metaboxes get shown as well
+	 *
+	 * @return void
+	 */
+	public function enable_hidden_ee_nav_menu_metaboxes()
+	{
+		global $wp_meta_boxes, $pagenow;
+		if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+			return;
+		}
+		$user = wp_get_current_user();
+		// has this been done yet?
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
+			return;
+		}
+
+		$hidden_meta_boxes  = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters(
+			'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
+			[
+				'nav-menu-theme-locations',
+				'add-page',
+				'add-custom-links',
+				'add-category',
+				'add-espresso_events',
+				'add-espresso_venues',
+				'add-espresso_event_categories',
+				'add-espresso_venue_categories',
+				'add-post-type-post',
+				'add-post-type-page',
+			]
+		);
+
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes, true)) {
+					unset($hidden_meta_boxes[ $key ]);
+				}
+			}
+		}
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
+	}
+
+
+	/**
+	 * This method simply registers custom nav menu boxes for "nav_menus.php route"
+	 * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
+	 *
+	 * @return void
+	 * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
+	 *         addons etc.
+	 */
+	public function register_custom_nav_menu_boxes()
+	{
+		add_meta_box(
+			'add-extra-nav-menu-pages',
+			esc_html__('Event Espresso Pages', 'event_espresso'),
+			[$this, 'ee_cpt_archive_pages'],
+			'nav-menus',
+			'side',
+			'core'
+		);
+		add_filter(
+			"postbox_classes_nav-menus_add-extra-nav-menu-pages",
+			function ($classes) {
+				array_push($classes, 'ee-admin-container');
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 * Use this to edit the post link for our cpts so that the edit link points to the correct page.
+	 *
+	 * @param string $link the original link generated by wp
+	 * @param int    $id   post id
+	 * @return string  the (maybe) modified link
+	 * @since   4.3.0
+	 */
+	public function modify_edit_post_link($link, $id)
+	{
+		if (! $post = get_post($id)) {
+			return $link;
+		}
+		if ($post->post_type === 'espresso_attendees') {
+			$query_args = [
+				'action' => 'edit_attendee',
+				'post'   => $id,
+			];
+			return EEH_URL::add_query_args_and_nonce(
+				$query_args,
+				admin_url('admin.php?page=espresso_registrations')
+			);
+		}
+		return $link;
+	}
+
+
+	public function ee_cpt_archive_pages()
+	{
+		global $nav_menu_selected_id;
+		$removed_args = [
+			'action',
+			'customlink-tab',
+			'edit-menu-item',
+			'menu-item',
+			'page-tab',
+			'_wpnonce',
+		];
+		$nav_tab_link = $nav_menu_selected_id
+			? esc_url(
+				add_query_arg(
+					'extra-nav-menu-pages-tab',
+					'event-archives',
+					remove_query_arg($removed_args)
+				)
+			)
+			: '';
+		$select_all_link = esc_url(
+			add_query_arg(
+				[
+					'extra-nav-menu-pages-tab' => 'event-archives',
+					'selectall'                => 1,
+				],
+				remove_query_arg($removed_args)
+			)
+		);
+		$pages = $this->_get_extra_nav_menu_pages_items();
+		$args['walker'] = new Walker_Nav_Menu_Checklist(false);
+		;
+		$nav_menu_pages_items = walk_nav_menu_tree(
+			array_map(
+				[$this, '_setup_extra_nav_menu_pages_items'],
+				$pages
+			),
+			0,
+			(object) $args
+		);
+		EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'cpt_archive_page.template.php',
+			[
+				'nav_menu_selected_id' => $nav_menu_selected_id,
+				'nav_menu_pages_items' => $nav_menu_pages_items,
+				'nav_tab_link'         => $nav_tab_link,
+				'select_all_link'      => $select_all_link,
+			]
+		);
+	}
+
+
+	/**
+	 * Returns an array of event archive nav items.
+	 *
+	 * @return array
+	 * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
+	 *        method we use for getting the extra nav menu items
+	 */
+	private function _get_extra_nav_menu_pages_items()
+	{
+		$menuitems[] = [
+			'title'       => esc_html__('Event List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_events'),
+			'description' => esc_html__('Archive page for all events.', 'event_espresso'),
+		];
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
+	}
+
+
+	/**
+	 * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
+	 * the properties and converts it to the menu item object.
+	 *
+	 * @param $menu_item_values
+	 * @return stdClass
+	 * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
+	 */
+	private function _setup_extra_nav_menu_pages_items($menu_item_values)
+	{
+		$menu_item = new stdClass();
+		$keys      = [
+			'ID'               => 0,
+			'db_id'            => 0,
+			'menu_item_parent' => 0,
+			'object_id'        => -1,
+			'post_parent'      => 0,
+			'type'             => 'custom',
+			'object'           => '',
+			'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
+			'title'            => '',
+			'url'              => '',
+			'target'           => '',
+			'attr_title'       => '',
+			'description'      => '',
+			'classes'          => [],
+			'xfn'              => '',
+		];
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = $menu_item_values[ $key ] ?? $value;
+		}
+		return $menu_item;
+	}
+
+
+	/**
+	 * admin_init
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function admin_init()
+	{
+		/**
+		 * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
+		 * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
+		 * - check if doing post processing.
+		 * - check if doing post processing of one of EE CPTs
+		 * - instantiate the corresponding EE CPT model for the post_type being processed.
+		 */
+		$action    = $this->request->getRequestParam('action');
+		$post_type = $this->request->getRequestParam('post_type');
+		if ($post_type && $action === 'editpost') {
+			/** @var CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->loader->getShared(CustomPostTypeDefinitions::class);
+			$custom_post_types->getCustomPostTypeModels($post_type);
+		}
+
+
+		if (! $this->request->isAjax()) {
+			/**
+			 * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
+			 * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
+			 * Pages" tab in the EE General Settings Admin page.
+			 * This is for user-proofing.
+			 */
+			add_filter('wp_dropdown_pages', [$this, 'modify_dropdown_pages']);
+			if (EE_Maintenance_Mode::instance()->models_can_query()) {
+				$this->adminInitModelsReady();
+			}
+		}
+	}
+
+
+	/**
+	 * Runs on admin_init but only if models are usable (ie, we're not in maintenance mode)
+	 */
+	protected function adminInitModelsReady()
+	{
+		if (function_exists('wp_add_privacy_policy_content')) {
+			$this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
+		}
+	}
+
+
+	/**
+	 * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
+	 *
+	 * @param string $output Current output.
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function modify_dropdown_pages($output)
+	{
+		// get critical pages
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+
+		// split current output by line break for easier parsing.
+		$split_output = explode("\n", $output);
+
+		// loop through to remove any critical pages from the array.
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="' . $page_id . '"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[ $key ]);
+				}
+			}
+		}
+		// replace output with the new contents
+		return implode("\n", $split_output);
+	}
+
+
+	/**
+	 * display_admin_notices
+	 *
+	 * @return void
+	 */
+	public function display_admin_notices()
+	{
+		echo EE_Error::get_notices(); // already escaped
+	}
+
+
+	/**
+	 * @param array $elements
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function dashboard_glance_items($elements)
+	{
+		$elements                        = is_array($elements) ? $elements : [$elements];
+		$events                          = EEM_Event::instance()->count();
+		$items['events']['url']          = EE_Admin_Page::add_query_args_and_nonce(
+			['page' => 'espresso_events'],
+			admin_url('admin.php')
+		);
+		$items['events']['text']         = sprintf(
+			esc_html(
+				_n('%s Event', '%s Events', $events, 'event_espresso')
+			),
+			number_format_i18n($events)
+		);
+		$items['events']['title']        = esc_html__('Click to view all Events', 'event_espresso');
+		$registrations                   = EEM_Registration::instance()->count(
+			[
+				[
+					'STS_ID' => ['!=', EEM_Registration::status_id_incomplete],
+				],
+			]
+		);
+		$items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
+			['page' => 'espresso_registrations'],
+			admin_url('admin.php')
+		);
+		$items['registrations']['text']  = sprintf(
+			esc_html(
+				_n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
+			),
+			number_format_i18n($registrations)
+		);
+		$items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
+
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
+
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf(
+				'<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+				$item_properties['url'],
+				$item_properties['title'],
+				$item_properties['text']
+			);
+		}
+		return $elements;
+	}
+
+
+	/**
+	 * check_for_invalid_datetime_formats
+	 * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
+	 * their selected format can be parsed by PHP
+	 *
+	 * @param    $value
+	 * @param    $option
+	 * @return    string
+	 */
+	public function check_for_invalid_datetime_formats($value, $option)
+	{
+		// check for date_format or time_format
+		switch ($option) {
+			case 'date_format':
+				$date_time_format = $value . ' ' . get_option('time_format');
+				break;
+			case 'time_format':
+				$date_time_format = get_option('date_format') . ' ' . $value;
+				break;
+			default:
+				$date_time_format = false;
+		}
+		// do we have a date_time format to check ?
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
+
+			if (is_array($error_msg)) {
+				$msg = '<p>'
+					   . sprintf(
+						   esc_html__(
+							   'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
+							   'event_espresso'
+						   ),
+						   date($date_time_format),
+						   $date_time_format
+					   )
+					   . '</p><p><ul>';
+
+
+				foreach ($error_msg as $error) {
+					$msg .= '<li>' . $error . '</li>';
+				}
+
+				$msg .= '</ul></p><p>'
+						. sprintf(
+							esc_html__(
+								'%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
+								'event_espresso'
+							),
+							'<span style="color:#D54E21;">',
+							'</span>'
+						)
+						. '</p>';
+
+				// trigger WP settings error
+				add_settings_error(
+					'date_format',
+					'date_format',
+					$msg
+				);
+
+				// set format to something valid
+				switch ($option) {
+					case 'date_format':
+						$value = 'F j, Y';
+						break;
+					case 'time_format':
+						$value = 'g:i a';
+						break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
+	 *
+	 * @param $content
+	 * @return    string
+	 */
+	public function its_eSpresso($content)
+	{
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
+	}
+
+
+	/**
+	 * espresso_admin_footer
+	 *
+	 * @return    string
+	 */
+	public function espresso_admin_footer()
+	{
+		return EEH_Template::powered_by_event_espresso('aln-cntr', '', ['utm_content' => 'admin_footer']);
+	}
+
+
+	/**
+	 * Hooks into the "post states" filter in a wp post type list table.
+	 *
+	 * @param array   $post_states
+	 * @param WP_Post $post
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function displayStateForCriticalPages($post_states, $post)
+	{
+		$post_states = (array) $post_states;
+		if (! $post instanceof WP_Post || $post->post_type !== 'page') {
+			return $post_states;
+		}
+		/** @var EE_Core_Config $config */
+		$config = $this->loader->getShared('EE_Config')->core;
+		if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
+			$post_states[] = sprintf(
+			/* Translators: Using company name - Event Espresso Critical Page */
+				esc_html__('%s Critical Page', 'event_espresso'),
+				'Event Espresso'
+			);
+		}
+		return $post_states;
+	}
+
+
+	/**
+	 * Show documentation links on the plugins page
+	 *
+	 * @param mixed $meta Plugin Row Meta
+	 * @param mixed $file Plugin Base file
+	 * @return array
+	 */
+	public function addLinksToPluginRowMeta($meta, $file)
+	{
+		if (EE_PLUGIN_BASENAME === $file) {
+			$row_meta = [
+				'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso documentation', 'event_espresso')
+						  . '">'
+						  . esc_html__('Docs', 'event_espresso')
+						  . '</a>',
+				'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso API docs', 'event_espresso')
+						  . '">'
+						  . esc_html__('API docs', 'event_espresso')
+						  . '</a>',
+			];
+			return array_merge($meta, $row_meta);
+		}
+		return (array) $meta;
+	}
+
+	 /**************************************************************************************/
+	 /************************************* DEPRECATED *************************************/
+	 /**************************************************************************************/
+
+
+	/**
+	 * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
+	 * EE_Admin_Page route is called.
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+	}
+
+
+	/**
+	 * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * static method for registering ee admin page.
+	 * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
+	 *
+	 * @param       $page_basename
+	 * @param       $page_path
+	 * @param array $config
+	 * @return void
+	 * @throws EE_Error
+	 * @see        EE_Register_Admin_Page::register()
+	 * @since      4.3.0
+	 * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
+	 */
+	public static function register_ee_admin_page($page_basename, $page_path, $config = [])
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
+					'event_espresso'
+				),
+				$page_basename
+			),
+			'4.3'
+		);
+		if (class_exists('EE_Register_Admin_Page')) {
+			$config['page_path'] = $page_path;
+		}
+		EE_Register_Admin_Page::register($page_basename, $config);
+	}
+
+
+	/**
+	 * @param int      $post_ID
+	 * @param \WP_Post $post
+	 * @return void
+	 * @deprecated 4.8.41
+	 */
+	public static function parse_post_content_on_save($post_ID, $post)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @param  $option
+	 * @param  $old_value
+	 * @param  $value
+	 * @return void
+	 * @deprecated 4.8.41
+	 */
+	public function reset_page_for_posts_on_change($option, $old_value, $value)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.27
+	 */
+	public function get_persistent_admin_notices()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @deprecated 4.9.27
+	 */
+	public function dismiss_ee_nag_notice_callback()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+		$this->persistent_admin_notice_manager->dismissNotice();
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated $VID:$
+	 */
+	public function enqueue_admin_scripts()
+	{
+	}
+
+
+
+	/**
+	 * @return RequestInterface
+	 * @deprecated $VID:$
+	 */
+	public function get_request()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'EventEspresso\core\services\request\Request'
+			),
+			'$VID:$'
+		);
+		return $this->request;
+	}
+
+
+	/**
+	 * @deprecated $VID:$
+	 */
+	public function hookIntoWpPluginsPage()
+	{
+	}
 }

core/domain/entities/routing/handlers/shared/RegularRequests.php

Indentation +136 added lines, -136 removed lines

@@ -28,148 +28,148 @@
  */
 class RegularRequests extends PrimaryRoute
 {
-    /**
-     * called just before matchesCurrentRequest()
-     * and allows Route to perform any setup required such as calling setSpecification()
-     *
-     * @since $VID:$
-     */
-    public function initialize()
-    {
-        $basic_nodes = [
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\Api',
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\Capabilities',
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\Locale',
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteUrls',
-        ];
-        foreach ($basic_nodes as $basic_node) {
-            $this->dependency_map->registerDependencies(
-                $basic_node,
-                ['EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache]
-            );
-        }
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\SitePermissions',
-            [
-                'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator'       => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\GeneralSettings',
-            [
-                'EventEspresso\core\services\json\JsonDataNodeValidator'                => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\converters\date_time_formats\PhpToUnicode' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\EventEspressoData',
-            [
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\Api'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\Config' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\JedLocaleData'                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator'            => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\Config',
-            [
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\CurrentUser'        => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\EspressoCoreDomain' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\GeneralSettings'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\Locale'             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteCurrency'       => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\SitePermissions'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteUrls'           => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator'                        => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\CurrentUser',
-            [
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\Capabilities' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator'                  => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\EspressoCoreDomain',
-            [
-                'EventEspresso\core\domain\Domain'                       => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteCurrency',
-            [
-                'EE_Currency_Config'                                     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->setDataNode(
-            $this->loader->getShared('EventEspresso\core\domain\entities\routing\data_nodes\EventEspressoData')
-        );
-    }
+	/**
+	 * called just before matchesCurrentRequest()
+	 * and allows Route to perform any setup required such as calling setSpecification()
+	 *
+	 * @since $VID:$
+	 */
+	public function initialize()
+	{
+		$basic_nodes = [
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\Api',
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\Capabilities',
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\Locale',
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteUrls',
+		];
+		foreach ($basic_nodes as $basic_node) {
+			$this->dependency_map->registerDependencies(
+				$basic_node,
+				['EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache]
+			);
+		}
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\SitePermissions',
+			[
+				'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator'       => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\GeneralSettings',
+			[
+				'EventEspresso\core\services\json\JsonDataNodeValidator'                => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\converters\date_time_formats\PhpToUnicode' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\EventEspressoData',
+			[
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\Api'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\Config' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\JedLocaleData'                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator'            => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\Config',
+			[
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\CurrentUser'        => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\EspressoCoreDomain' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\GeneralSettings'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\Locale'             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteCurrency'       => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\SitePermissions'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteUrls'           => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator'                        => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\CurrentUser',
+			[
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\Capabilities' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator'                  => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\EspressoCoreDomain',
+			[
+				'EventEspresso\core\domain\Domain'                       => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteCurrency',
+			[
+				'EE_Currency_Config'                                     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->setDataNode(
+			$this->loader->getShared('EventEspresso\core\domain\entities\routing\data_nodes\EventEspressoData')
+		);
+	}
 
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return ! $this->request->isActivation() || $this->request->isUnitTesting();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return ! $this->request->isActivation() || $this->request->isUnitTesting();
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $public = ['EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache] + Route::getDefaultDependencies();
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$public = ['EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache] + Route::getDefaultDependencies();
 
-        $default_with_barista  = [BaristaFactory::class => EE_Dependency_Map::load_from_cache] +
-                                 Route::getDefaultDependencies();
-        $default_with_manifest = [AssetManifestFactory::class => EE_Dependency_Map::load_from_cache] +
-                                 Route::getDefaultDependencies();
+		$default_with_barista  = [BaristaFactory::class => EE_Dependency_Map::load_from_cache] +
+								 Route::getDefaultDependencies();
+		$default_with_manifest = [AssetManifestFactory::class => EE_Dependency_Map::load_from_cache] +
+								 Route::getDefaultDependencies();
 
-        $default_routes = [
-            // default dependencies
-            ShortcodeRequests::class    => Route::getDefaultDependencies(),
-            RestApiRequests::class      => Route::getDefaultDependencies(),
-            SessionRequests::class      => Route::getDefaultDependencies(),
-            WordPressHeartbeat::class   => Route::getDefaultDependencies(),
-            AssetRequests::class        => $default_with_barista,
-            GQLRequests::class          => $default_with_manifest,
-            // admin dependencies
-            AdminRoute::class           => AdminRoute::getDefaultDependencies(),
-            EspressoEventsAdmin::class  => AdminRoute::getDefaultDependencies(),
-            EspressoEventEditor::class  => AdminRoute::getDefaultDependencies(),
-            EspressoLegacyAdmin::class  => AdminRoute::getDefaultDependencies(),
-            GutenbergEditor::class      => AdminRoute::getDefaultDependencies(),
-            NonEspressoAdminAjax::class => AdminRoute::getDefaultDependencies(),
-            WordPressPluginsPage::class => AdminRoute::getDefaultDependencies(),
-            // public dependencies
-            PersonalDataRequests::class => $public,
-            FrontendRequests::class     => $public,
-        ];
-        foreach ($default_routes as $route => $dependencies) {
-            $this->dependency_map->registerDependencies($route, $dependencies);
-        }
-    }
+		$default_routes = [
+			// default dependencies
+			ShortcodeRequests::class    => Route::getDefaultDependencies(),
+			RestApiRequests::class      => Route::getDefaultDependencies(),
+			SessionRequests::class      => Route::getDefaultDependencies(),
+			WordPressHeartbeat::class   => Route::getDefaultDependencies(),
+			AssetRequests::class        => $default_with_barista,
+			GQLRequests::class          => $default_with_manifest,
+			// admin dependencies
+			AdminRoute::class           => AdminRoute::getDefaultDependencies(),
+			EspressoEventsAdmin::class  => AdminRoute::getDefaultDependencies(),
+			EspressoEventEditor::class  => AdminRoute::getDefaultDependencies(),
+			EspressoLegacyAdmin::class  => AdminRoute::getDefaultDependencies(),
+			GutenbergEditor::class      => AdminRoute::getDefaultDependencies(),
+			NonEspressoAdminAjax::class => AdminRoute::getDefaultDependencies(),
+			WordPressPluginsPage::class => AdminRoute::getDefaultDependencies(),
+			// public dependencies
+			PersonalDataRequests::class => $public,
+			FrontendRequests::class     => $public,
+		];
+		foreach ($default_routes as $route => $dependencies) {
+			$this->dependency_map->registerDependencies($route, $dependencies);
+		}
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler(): bool
-    {
-        $this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR);
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler(): bool
+	{
+		$this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR);
+		return true;
+	}
 }

core/domain/entities/routing/handlers/shared/AssetRequests.php

Indentation +134 added lines, -134 removed lines

@@ -22,148 +22,148 @@
  */
 class AssetRequests extends Route
 {
-    /**
-     * @var BaristaFactory $barista_factory
-     */
-    protected $barista_factory;
+	/**
+	 * @var BaristaFactory $barista_factory
+	 */
+	protected $barista_factory;
 
 
-    /**
-     * AssetRequests constructor.
-     *
-     * @param EE_Dependency_Map                $dependency_map
-     * @param LoaderInterface                  $loader
-     * @param RequestInterface                 $request
-     * @param BaristaFactory $barista_factory
-     */
-    public function __construct(
-        EE_Dependency_Map $dependency_map,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        BaristaFactory $barista_factory
-    ) {
-        $this->barista_factory = $barista_factory;
-        parent::__construct($dependency_map, $loader, $request);
-    }
+	/**
+	 * AssetRequests constructor.
+	 *
+	 * @param EE_Dependency_Map                $dependency_map
+	 * @param LoaderInterface                  $loader
+	 * @param RequestInterface                 $request
+	 * @param BaristaFactory $barista_factory
+	 */
+	public function __construct(
+		EE_Dependency_Map $dependency_map,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		BaristaFactory $barista_factory
+	) {
+		$this->barista_factory = $barista_factory;
+		parent::__construct($dependency_map, $loader, $request);
+	}
 
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isAdmin()
-               || $this->request->isFrontend()
-               || $this->request->isIframe()
-               || $this->request->isWordPressApi();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isAdmin()
+			   || $this->request->isFrontend()
+			   || $this->request->isIframe()
+			   || $this->request->isWordPressApi();
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $default_dependencies = [
-            'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-            'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
-            'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-        ];
-        $this->dependency_map->registerDependencies(JqueryAssetManager::class, $default_dependencies);
-        $this->dependency_map->registerDependencies(ReactAssetManager::class, $default_dependencies);
-        $this->dependency_map->registerDependencies(
-            CoreAssetManager::class,
-            [
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
-                'EE_Currency_Config'                                 => EE_Dependency_Map::load_from_cache,
-                'EE_Template_Config'                                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\editor\BlockRegistrationManager',
-            [
-                'EventEspresso\core\services\assets\BlockAssetManagerCollection'     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\editor\BlockCollection'          => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\routing\RouteMatchSpecificationManager' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                        => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager',
-            [
-                'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
-                'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer',
-            [
-                'EventEspresso\core\domain\Domain'                                        => EE_Dependency_Map::load_from_cache,
-                'EEM_Attendee'                                                            => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\graphql\enums\RegistrationStatusEnum' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\editor\blocks\EventAttendees',
-            [
-                'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager'      => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                           => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        if (apply_filters('FHEE__load_Barista', true)) {
-            $this->dependency_map->registerDependencies(
-                'EventEspresso\core\services\assets\Barista',
-                ['EventEspresso\core\services\assets\AssetManifest' => EE_Dependency_Map::load_from_cache]
-            );
-        }
-    }
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$default_dependencies = [
+			'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+			'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
+			'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+		];
+		$this->dependency_map->registerDependencies(JqueryAssetManager::class, $default_dependencies);
+		$this->dependency_map->registerDependencies(ReactAssetManager::class, $default_dependencies);
+		$this->dependency_map->registerDependencies(
+			CoreAssetManager::class,
+			[
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
+				'EE_Currency_Config'                                 => EE_Dependency_Map::load_from_cache,
+				'EE_Template_Config'                                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\editor\BlockRegistrationManager',
+			[
+				'EventEspresso\core\services\assets\BlockAssetManagerCollection'     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\editor\BlockCollection'          => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\routing\RouteMatchSpecificationManager' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                        => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager',
+			[
+				'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
+				'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer',
+			[
+				'EventEspresso\core\domain\Domain'                                        => EE_Dependency_Map::load_from_cache,
+				'EEM_Attendee'                                                            => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\graphql\enums\RegistrationStatusEnum' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\editor\blocks\EventAttendees',
+			[
+				'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager'      => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                           => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		if (apply_filters('FHEE__load_Barista', true)) {
+			$this->dependency_map->registerDependencies(
+				'EventEspresso\core\services\assets\Barista',
+				['EventEspresso\core\services\assets\AssetManifest' => EE_Dependency_Map::load_from_cache]
+			);
+		}
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler(): bool
-    {
-        if (apply_filters('FHEE__load_Barista', true)) {
-            $barista = $this->barista_factory->create();
-            if ($barista instanceof BaristaInterface) {
-                $barista->initialize();
-                $this->loader->getShared('EventEspresso\core\services\assets\Registry');
-            }
-        }
-        $this->loader->getShared(JqueryAssetManager::class);
-        $this->loader->getShared(CoreAssetManager::class);
-        if ($this->canLoadBlocks()) {
-            $this->loader->getShared(
-                'EventEspresso\core\services\editor\BlockRegistrationManager'
-            );
-        }
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler(): bool
+	{
+		if (apply_filters('FHEE__load_Barista', true)) {
+			$barista = $this->barista_factory->create();
+			if ($barista instanceof BaristaInterface) {
+				$barista->initialize();
+				$this->loader->getShared('EventEspresso\core\services\assets\Registry');
+			}
+		}
+		$this->loader->getShared(JqueryAssetManager::class);
+		$this->loader->getShared(CoreAssetManager::class);
+		if ($this->canLoadBlocks()) {
+			$this->loader->getShared(
+				'EventEspresso\core\services\editor\BlockRegistrationManager'
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * Return whether blocks can be registered/loaded or not.
-     *
-     * @return bool
-     * @since $VID:$
-     */
-    private function canLoadBlocks()
-    {
-        return apply_filters('FHEE__EE_System__canLoadBlocks', true)
-               && function_exists('register_block_type')
-               // don't load blocks if in the Divi page builder editor context
-               // @see https://github.com/eventespresso/event-espresso-core/issues/814
-               && ! $this->request->getRequestParam('et_fb', false);
-    }
+	/**
+	 * Return whether blocks can be registered/loaded or not.
+	 *
+	 * @return bool
+	 * @since $VID:$
+	 */
+	private function canLoadBlocks()
+	{
+		return apply_filters('FHEE__EE_System__canLoadBlocks', true)
+			   && function_exists('register_block_type')
+			   // don't load blocks if in the Divi page builder editor context
+			   // @see https://github.com/eventespresso/event-espresso-core/issues/814
+			   && ! $this->request->getRequestParam('et_fb', false);
+	}
 }

core/domain/entities/routing/handlers/shared/GQLRequests.php

Indentation +216 added lines, -216 removed lines

@@ -19,228 +19,228 @@
  */
 class GQLRequests extends Route
 {
-    /**
-     * @var AssetManifestFactory
-     */
-    private $manifest_factory;
+	/**
+	 * @var AssetManifestFactory
+	 */
+	private $manifest_factory;
 
 
-    /**
-     * AssetRequests constructor.
-     *
-     * @param EE_Dependency_Map    $dependency_map
-     * @param LoaderInterface      $loader
-     * @param RequestInterface     $request
-     * @param AssetManifestFactory $manifest_factory
-     */
-    public function __construct(
-        EE_Dependency_Map $dependency_map,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        AssetManifestFactory $manifest_factory
-    ) {
-        $this->manifest_factory = $manifest_factory;
-        parent::__construct($dependency_map, $loader, $request);
-    }
+	/**
+	 * AssetRequests constructor.
+	 *
+	 * @param EE_Dependency_Map    $dependency_map
+	 * @param LoaderInterface      $loader
+	 * @param RequestInterface     $request
+	 * @param AssetManifestFactory $manifest_factory
+	 */
+	public function __construct(
+		EE_Dependency_Map $dependency_map,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		AssetManifestFactory $manifest_factory
+	) {
+		$this->manifest_factory = $manifest_factory;
+		parent::__construct($dependency_map, $loader, $request);
+	}
 
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        global $pagenow;
-        return (
-                   $this->request->isGQL()
-                   || $this->request->isUnitTesting()
-                   || (
-                       $this->request->isAdmin()
-                       && $this->request->getRequestParam('page') === 'espresso_events'
-                       && (
-                           $this->request->getRequestParam('action') === 'create_new'
-                           || $this->request->getRequestParam('action') === 'edit'
-                       )
-                   )
-                   || (
-                       $pagenow
-                       && (
-                           $pagenow === 'post-new.php'
-                           || (
-                               $pagenow === 'post.php'
-                               && $this->request->getRequestParam('action') === 'edit'
-                           )
-                       )
-                   )
-               );
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		global $pagenow;
+		return (
+				   $this->request->isGQL()
+				   || $this->request->isUnitTesting()
+				   || (
+					   $this->request->isAdmin()
+					   && $this->request->getRequestParam('page') === 'espresso_events'
+					   && (
+						   $this->request->getRequestParam('action') === 'create_new'
+						   || $this->request->getRequestParam('action') === 'edit'
+					   )
+				   )
+				   || (
+					   $pagenow
+					   && (
+						   $pagenow === 'post-new.php'
+						   || (
+							   $pagenow === 'post.php'
+							   && $this->request->getRequestParam('action') === 'edit'
+						   )
+					   )
+				   )
+			   );
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\graphql\GraphQLManager',
-            [
-                'EventEspresso\core\services\graphql\ConnectionsManager' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\graphql\DataLoaderManager'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\graphql\EnumsManager'       => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\graphql\InputsManager'      => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\graphql\TypesManager'       => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\graphql\TypesManager',
-            [
-                'EventEspresso\core\services\graphql\types\TypeCollection' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\graphql\InputsManager',
-            [
-                'EventEspresso\core\services\graphql\inputs\InputCollection' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\graphql\EnumsManager',
-            [
-                'EventEspresso\core\services\graphql\enums\EnumCollection' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\graphql\ConnectionsManager',
-            [
-                'EventEspresso\core\services\graphql\connections\ConnectionCollection' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\graphql\DataLoaderManager',
-            [
-                'EventEspresso\core\services\graphql\loaders\DataLoaderCollection' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\Datetime',
-            ['EEM_Datetime' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\Attendee',
-            ['EEM_Attendee' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\Event',
-            ['EEM_Event' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\FormElement',
-            ['EEM_Form_Element' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\FormSection',
-            ['EEM_Form_Section' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\Ticket',
-            ['EEM_Ticket' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\Price',
-            ['EEM_Price' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\PriceType',
-            ['EEM_Price_Type' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\Venue',
-            ['EEM_Venue' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\State',
-            ['EEM_State' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\types\Country',
-            ['EEM_Country' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\EventDatetimesConnection',
-            ['EEM_Datetime' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryDatetimesConnection',
-            ['EEM_Datetime' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryAttendeesConnection',
-            ['EEM_Attendee' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryCountriesConnection',
-            ['EEM_Country' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryFormElementsConnection',
-            ['EEM_Form_Element' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryFormSectionsConnection',
-            ['EEM_Form_Section' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryStatesConnection',
-            ['EEM_State' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\DatetimeTicketsConnection',
-            ['EEM_Ticket' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryTicketsConnection',
-            ['EEM_Ticket' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\TicketPricesConnection',
-            ['EEM_Price' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryPricesConnection',
-            ['EEM_Price' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\RootQueryPriceTypesConnection',
-            ['EEM_Price_Type' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\TicketDatetimesConnection',
-            ['EEM_Datetime' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\graphql\connections\EventVenuesConnection',
-            ['EEM_Venue' => EE_Dependency_Map::load_from_cache]
-        );
-    }
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\graphql\GraphQLManager',
+			[
+				'EventEspresso\core\services\graphql\ConnectionsManager' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\graphql\DataLoaderManager'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\graphql\EnumsManager'       => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\graphql\InputsManager'      => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\graphql\TypesManager'       => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\graphql\TypesManager',
+			[
+				'EventEspresso\core\services\graphql\types\TypeCollection' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\graphql\InputsManager',
+			[
+				'EventEspresso\core\services\graphql\inputs\InputCollection' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\graphql\EnumsManager',
+			[
+				'EventEspresso\core\services\graphql\enums\EnumCollection' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\graphql\ConnectionsManager',
+			[
+				'EventEspresso\core\services\graphql\connections\ConnectionCollection' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\graphql\DataLoaderManager',
+			[
+				'EventEspresso\core\services\graphql\loaders\DataLoaderCollection' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\Datetime',
+			['EEM_Datetime' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\Attendee',
+			['EEM_Attendee' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\Event',
+			['EEM_Event' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\FormElement',
+			['EEM_Form_Element' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\FormSection',
+			['EEM_Form_Section' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\Ticket',
+			['EEM_Ticket' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\Price',
+			['EEM_Price' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\PriceType',
+			['EEM_Price_Type' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\Venue',
+			['EEM_Venue' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\State',
+			['EEM_State' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\types\Country',
+			['EEM_Country' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\EventDatetimesConnection',
+			['EEM_Datetime' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryDatetimesConnection',
+			['EEM_Datetime' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryAttendeesConnection',
+			['EEM_Attendee' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryCountriesConnection',
+			['EEM_Country' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryFormElementsConnection',
+			['EEM_Form_Element' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryFormSectionsConnection',
+			['EEM_Form_Section' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryStatesConnection',
+			['EEM_State' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\DatetimeTicketsConnection',
+			['EEM_Ticket' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryTicketsConnection',
+			['EEM_Ticket' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\TicketPricesConnection',
+			['EEM_Price' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryPricesConnection',
+			['EEM_Price' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\RootQueryPriceTypesConnection',
+			['EEM_Price_Type' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\TicketDatetimesConnection',
+			['EEM_Datetime' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\graphql\connections\EventVenuesConnection',
+			['EEM_Venue' => EE_Dependency_Map::load_from_cache]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler(): bool
-    {
-        // load handler for EE GraphQL requests
-        $graphQL_manager = $this->loader->getShared(
-            'EventEspresso\core\services\graphql\GraphQLManager'
-        );
-        $graphQL_manager->init();
-        $manifest = $this->manifest_factory->createFromDomainObject(DomainFactory::getEventEspressoCoreDomain());
-        $manifest->initialize();
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler(): bool
+	{
+		// load handler for EE GraphQL requests
+		$graphQL_manager = $this->loader->getShared(
+			'EventEspresso\core\services\graphql\GraphQLManager'
+		);
+		$graphQL_manager->init();
+		$manifest = $this->manifest_factory->createFromDomainObject(DomainFactory::getEventEspressoCoreDomain());
+		$manifest->initialize();
+		return true;
+	}
 }

core/domain/entities/routing/handlers/admin/ActivationRequests.php

Indentation +35 added lines, -35 removed lines

@@ -14,43 +14,43 @@
  */
 class ActivationRequests extends PrimaryRoute
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isActivation();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isActivation();
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute',
-            AdminRoute::getDefaultDependencies()
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage',
-            AdminRoute::getDefaultDependencies()
-        );
-    }
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute',
+			AdminRoute::getDefaultDependencies()
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage',
+			AdminRoute::getDefaultDependencies()
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler(): bool
-    {
-        $this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION);
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler(): bool
+	{
+		$this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION);
+		return true;
+	}
 }