eventespresso / event-espresso-core

espresso.php

Indentation +107 added lines, -107 removed lines

@@ -37,138 +37,138 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time.
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time.
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
 <div class="error">
     <p>
         <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
     </p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
 <div class="error">
     <p>
         <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
-                    );
-        ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
+					);
+		?>
     </p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
 
-        require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/autoload.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version(): string
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.35.rc.000');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version(): string
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.35.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-            update_option('event-espresso-core_allow_tracking', 'no');
-            update_option('event-espresso-core_tracking_notice', 'hide');
-            // Run WP GraphQL activation callback
-            espressoLoadWpGraphQL();
-            graphql_activation_callback();
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+			update_option('event-espresso-core_allow_tracking', 'no');
+			update_option('event-espresso-core_tracking_notice', 'hide');
+			// Run WP GraphQL activation callback
+			espressoLoadWpGraphQL();
+			graphql_activation_callback();
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        /**
-         * espresso_plugin_deactivation
-         */
-        function espresso_plugin_deactivation()
-        {
-            // Run WP GraphQL deactivation callback
-            espressoLoadWpGraphQL();
-            graphql_deactivation_callback();
-            delete_option('event-espresso-core_allow_tracking');
-            delete_option('event-espresso-core_tracking_notice');
-        }
-        register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
+		/**
+		 * espresso_plugin_deactivation
+		 */
+		function espresso_plugin_deactivation()
+		{
+			// Run WP GraphQL deactivation callback
+			espressoLoadWpGraphQL();
+			graphql_deactivation_callback();
+			delete_option('event-espresso-core_allow_tracking');
+			delete_option('event-espresso-core_tracking_notice');
+		}
+		register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin(string $plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin(string $plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
 
 
 if (! function_exists('espressoLoadWpGraphQL')) {
-    function espressoLoadWpGraphQL()
-    {
-        if (
-            ! class_exists('WPGraphQL')
-            && is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
-        ) {
-            require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
-        }
-    }
+	function espressoLoadWpGraphQL()
+	{
+		if (
+			! class_exists('WPGraphQL')
+			&& is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
+		) {
+			require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
+		}
+	}
 }

PaymentMethods/PayPalCommerce/modules/EED_PayPalOnboard.module.php

Indentation +729 added lines, -729 removed lines

@@ -20,736 +20,736 @@
  */
 class EED_PayPalOnboard extends EED_Module
 {
-    /**
-     * @return EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Module
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Run - initial module setup.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * For hooking into EE Admin Core and other modules.
-     *
-     * @return void
-     */
-    public static function set_hooks_admin(): void
-    {
-        // check for the most basic EE capability
-        /** @var EE_Capabilities $capabilities */
-        $capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
-        if (
-            DbStatus::isOffline()
-            || ! $capabilities->current_user_can('ee_manage_gateways', 'manage-paypal-onboarding')
-        ) {
-            return;
-        }
-        // Get onboarding URL.
-        add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
-        // Catch the return/redirect from PayPal onboarding page.
-        add_action('init', [__CLASS__, 'updateOnboardingStatus']);
-        // Return the connection/onboard status.
-        add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
-        // Revoke access.
-        add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
-        // Clear all metadata.
-        add_action('wp_ajax_eeaPpClearMetaData', [__CLASS__, 'clearMetaData']);
-        // Admin notice.
-        add_action('admin_init', [__CLASS__, 'adminNotice']);
-    }
-
-
-    /**
-     * Get the onboarding URL.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function getOnboardingUrl(): void
-    {
-        $signup_link = '';
-        try {
-            $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
-                PayPalLogger::errorLogAndExit(
-                    esc_html__('No payment method.', 'event_espresso'),
-                    EED_Module::getRequest()->postParams(),
-                    $paypal_pm
-                );
-            }
-            PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
-            // Just get a new onboarding URL every time.
-            $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
-            if (! $signup_link) {
-                $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
-                PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
-            }
-        } catch (Exception $e) {
-            PayPalLogger::errorLogAndExit($e->getMessage(), ['trace' => $e->getTrace()]);
-        }
-        // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
-        wp_send_json(
-            [
-                'signup_link' => $signup_link,
-            ]
-        );
-    }
-
-
-    /**
-     * Request the sign-up link from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param bool              $one_time_request
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
-    {
-        $signup_link = '';
-        // Get the access token.
-        $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
-            $err_msg = esc_html__('Error! No access token.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
-            return '';
-        }
-        // Request the access token.
-        $body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
-        $bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        $post_params = [
-            'method'  => 'POST',
-            'headers' => [
-                'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-                'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
-                'PayPal-Partner-Attribution-Id' => $bn_code,
-            ],
-            'body'    => $body_params,
-        ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
-        $response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
-        // Check the data we received.
-        if (isset($response['error']) || empty($response['links'])) {
-            // Did the original access token get replaced by any chance ?
-            if (
-                ! $one_time_request
-                && ! empty($response['message'])
-                && $response['message'] === 'Access Token not found in cache'
-            ) {
-                // Clear all PM metadata and try getting the access token One more time.
-                PayPalExtraMetaManager::deleteData($paypal_pm);
-                PayPalLogger::errorLog(
-                    esc_html__('Removing old metadata before new onboarding.', 'event_espresso'),
-                    $response,
-                    $paypal_pm
-                );
-                return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
-            }
-            $err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
-            return '';
-        }
-        // Now retrieve that sign-up link.
-        foreach ($response['links'] as $link) {
-            if ($link['rel'] === 'action_url') {
-                $signup_link = $link['href'] ?? '';
-            }
-        }
-        return $signup_link;
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws Exception
-     */
-    public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
-    {
-        $identifier_string = new OneTimeString($paypal_pm->debug_mode());
-        $tracking_id       = $identifier_string->value();
-        $request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $selected_payment  = $request->getRequestParam('selected_payment', 'EXPRESS_CHECKOUT');
-        // Save the identifier for future use.
-        PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
-        // Assemble the return URL.
-        $return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm, $selected_payment);
-        return json_encode(
-            [
-                'tracking_id'             => $tracking_id,
-                'operations'              => [
-                    [
-                        'operation'                  => 'API_INTEGRATION',
-                        'api_integration_preference' => [
-                            'rest_api_integration' => [
-                                'integration_method'  => 'PAYPAL',
-                                'integration_type'    => 'THIRD_PARTY',
-                                'third_party_details' => [
-                                    'features' => ['PAYMENT', 'REFUND', 'PARTNER_FEE'],
-                                ],
-                            ],
-                        ],
-                    ],
-                ],
-                'products'                => [$selected_payment],
-                'legal_consents'          => [
-                    [
-                        'type'    => 'SHARE_DATA_CONSENT',
-                        'granted' => true,
-                    ],
-                ],
-                'partner_config_override' => [
-                    'return_url' => $return_url,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $selected_payment
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getReturnUrl(EE_Payment_Method $paypal_pm, string $selected_payment = ''): string
-    {
-        $wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
-        $nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
-        return add_query_arg(
-            [
-                'page'                        => 'espresso_payment_settings',
-                'webhook_action'              => 'eepPpcMerchantOnboard',
-                'payment_method'              => $paypal_pm->slug(),
-                '_wpnonce'                    => $wp_nonce,
-                'nonce'                       => $nonce,
-                'selected_payment'            => $selected_payment,
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Redirect to the payment method (PP) settings home page.
-     *
-     * @return void
-     */
-    public static function redirectToPmSettingsHome(): void
-    {
-        $get_params = EED_Module::getRequest()->getParams();
-        if (empty($get_params['payment_method'])) {
-            // Simply do not redirect.
-            return;
-        }
-        $args_to_add = [
-            'page'           => 'espresso_payment_settings',
-            'payment_method' => $get_params['payment_method'],
-        ];
-        if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
-        }
-        $home_url = add_query_arg($args_to_add, admin_url('admin.php'));
-        wp_redirect($home_url);
-        exit;
-    }
-
-
-    /**
-     * Check user’s onboarding status.
-     * This will handle the user return from the auth page and also check the status via the API.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function updateOnboardingStatus(): void
-    {
-        // Check if this is the webhook from PayPal.
-        if (
-            ! isset($_GET['webhook_action'], $_GET['nonce'])
-            || $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
-        ) {
-            return;  // Ignore.
-        }
-        $get_params = EED_Module::getRequest()->getParams();
-        // Get the payment method.
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        // Check the response (GET) parameters.
-        if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
-            // Missing parameters. Can't proceed.
-            PayPalLogger::errorLog(
-                esc_html__('Missing required onboarding parameters.', 'event_espresso'),
-                $get_params,
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Check on the onboarding status (recommended by PP).
-        $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
-            $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
-        );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
-            PayPalLogger::errorLog(
-                $onboarding_status['message'],
-                array_merge($get_params, $onboarding_status),
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Start saving the setup and info.
-        PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status, $get_params);
-        // Save the credentials.
-        PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
-        // Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
-        EED_PayPalOnboard::redirectToPmSettingsHome();
-    }
-
-
-    /**
-     * Check if all required parameters for the onboarding status check are present.
-     *
-     * @param array $data
-     * @param mixed $paypal_pm
-     * @return bool
-     */
-    public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
-    {
-        // Check that we have all the required parameters and the nonce is ok.
-        if (
-            $paypal_pm instanceof EE_Payment_Method
-            && wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
-            && ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
-            && ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        // Do we have it saved ?
-        $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
-        // If we don't have it, request/update it.
-        if (! $access_token) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        if (EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm)) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        // Access token is saved as encrypted, but return decrypted.
-        return $access_token;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
-    {
-        $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_TOKEN_EXPIRES_IN);
-        if (! $expires_at) {
-            return true;
-        }
-        // Validate the token expiration date.
-        $minutes_left = round(($expires_at - time()) / 60);
-        // Count as expired if less than 60 minutes till expiration left.
-        if ($minutes_left <= 60) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Request the partner access token from PayPal and save/update it.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        $nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
-        // Request the access token.
-        $post_args = [
-            'method' => 'POST',
-            'body'   => [
-                'nonce'                       => $nonce,
-                'api_version'                 => 'v1',
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-        ];
-        if (defined('LOCAL_MIDDLEMAN_SERVER')) {
-            $post_args['sslverify'] = Manager::verifySSL();
-        }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
-        $response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
-        if (isset($response['error'])) {
-            return '';
-        }
-        // Check the data we received.
-        if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
-            return '';
-        }
-        // If we are here all seems to be ok. Save the token and it's data.
-        $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
-            return '';
-        }
-        return $response['access_token'];
-    }
-
-
-    /**
-     * Request seller onboarding status from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
-    {
-        $track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
-        if (! $track_onboarding instanceof TrackSellerOnboarding) {
-            return [
-                'error'   => 'TRACK_ONBOARDING_FAILED',
-                'message' => esc_html__('Failed to track seller onboarding.', 'event_espresso')
-            ];
-        }
-        return $track_onboarding->isValid();
-    }
-
-
-    /**
-     * Returns the Track Seller Onboarding API.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return TrackSellerOnboarding|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getTrackOnboardingApi(
-        EE_Payment_Method $paypal_pm,
-        string $merchant_id
-    ): ?TrackSellerOnboarding {
-        $partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
-            return null;
-        }
-        return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
-    }
-
-
-    /**
-     * Check the onboard status and return the result.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getOnboardStatus(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
-            wp_send_json(['on_board' => false]);
-        }
-        try {
-            $seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
-        } catch (Exception $e) {
-            $seller_id = '--';
-            PayPalLogger::errorLog($e->getMessage(), ['trace' => $e->getTrace()]);
-        }
-        wp_send_json(
-            [
-                'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
-                'seller_id' => $seller_id,
-            ]
-        );
-    }
-
-
-    /**
-     * De-authorize the seller. Remove all API credentials.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function offboard(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        EED_PayPalOnboard::validatePmAjax($paypal_pm);
-        PayPalExtraMetaManager::deleteData($paypal_pm);
-        PayPalLogger::errorLog(
-            esc_html__('Offboarding. Removing metadata.', 'event_espresso'),
-            EED_Module::getRequest()->postParams(),
-            $paypal_pm
-        );
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Clear all credentials metadata.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function clearMetaData(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        EED_PayPalOnboard::validatePmAjax($paypal_pm);
-        PayPalExtraMetaManager::deleteAllData($paypal_pm);
-        PayPalLogger::errorLog(
-            esc_html__('Doing a Reset. Removing all PM settings metadata.', 'event_espresso'),
-            EED_Module::getRequest()->postParams(),
-            $paypal_pm
-        );
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Validate the PM instance, returning an ajax response on invalid.
-     *
-     * @param $paypal_pm
-     * @return void
-     */
-    public static function validatePmAjax($paypal_pm): void
-    {
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            wp_send_json(
-                [
-                    'error'   => 'INVALID_PM',
-                    'message' => esc_html__(
-                        'Invalid payment method. Please refresh the page and try again.',
-                        'event_espresso'
-                    ),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Checks if already onboard.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function isOnboard(EE_Payment_Method $payment_method): bool
-    {
-        $pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
-        return
-            (
-                // onboarded with a third party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
-            ) || (
-                // or with the first party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
-            );
-    }
-
-
-    /**
-     * Send a request and return a decoded response body.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $request_url
-     * @param array             $request_args
-     * @return array
-     */
-    public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
-    {
-        $error_return = ['error' => true];
-        $response     = wp_remote_request($request_url, $request_args);
-        if (is_wp_error($response)) {
-            $message = $response->get_error_message();
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        $response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
-        if (empty($response_body) || isset($response_body['error'])) {
-            $message = $response_body['error_description']
-                ?? sprintf(
-                    esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
-                    $request_url
-                );
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        return $response_body;
-    }
-
-
-    /**
-     * Check the response for a partner token request.
-     *
-     * @param array             $response
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerTokenResponseValid(array $response, EE_Payment_Method $paypal_pm): bool
-    {
-        // Check the data we received.
-        if (
-            empty($response['nonce'])
-            || ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
-            || empty($response['access_token'])
-            || empty($response['app_id'])
-            || empty($response['expires_in'])
-            || empty($response['partner_client_id'])
-            || empty($response['partner_merchant_id'])
-        ) {
-            // This is an error.
-            PayPalLogger::errorLog(
-                esc_html__('Incoming parameter validation failed.', 'event_espresso'),
-                $response,
-                $paypal_pm
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Returns the base URL to the middleman server.
-     * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
-    {
-        $target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
-        // If this PM is used under different provider accounts, you might need an account indicator.
-        $account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
-        $postfix = $payment_method->debug_mode() ? '_sandbox' : '';
-        return "https://connect.eventespresso.$target/paypal_commerce$account$postfix/";
-    }
-
-
-    /**
-     * This Payment Method admin notices.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function adminNotice()
-    {
-        // Show the notice if PayPal Commerce PM is active but merchant is not onboard.
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
-        if (
-            $pp_commerce instanceof EE_Payment_Method
-            && $pp_commerce->active()
-            && ! EED_PayPalOnboard::isOnboard($pp_commerce)
-        ) {
-            add_action('admin_notices', [EED_PayPalOnboard::class, 'notOnboardNotice']);
-        }
-    }
-
-
-    /**
-     * Contents of the not onboard admin notice.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function notOnboardNotice()
-    {
-        $open_anchor = $close_anchor = '';
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
-        if ($pp_commerce instanceof EE_Payment_Method) {
-            $pm_page      = add_query_arg(
-                [
-                    'page'           => 'espresso_payment_settings',
-                    'webhook_action' => 'eepPpcMerchantOnboard',
-                    'payment_method' => $pp_commerce->slug(),
-                ],
-                admin_url('admin.php')
-            );
-            $open_anchor  = "<a href='$pm_page'>";
-            $close_anchor = "</a>";
-        }
-        $notice = sprintf(
-            esc_html__(
-                '%1$sPayPal Commerce%2$s payment method was activated but is not connected to PayPal. Please %3$sfinish setting up%4$s this payment method.',
-                'event_espresso'
-            ),
-            '<strong>',
-            '</strong>',
-            $open_anchor,
-            $close_anchor
-        );
-        echo "
+	/**
+	 * @return EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Module
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Run - initial module setup.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * For hooking into EE Admin Core and other modules.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin(): void
+	{
+		// check for the most basic EE capability
+		/** @var EE_Capabilities $capabilities */
+		$capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
+		if (
+			DbStatus::isOffline()
+			|| ! $capabilities->current_user_can('ee_manage_gateways', 'manage-paypal-onboarding')
+		) {
+			return;
+		}
+		// Get onboarding URL.
+		add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
+		// Catch the return/redirect from PayPal onboarding page.
+		add_action('init', [__CLASS__, 'updateOnboardingStatus']);
+		// Return the connection/onboard status.
+		add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
+		// Revoke access.
+		add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
+		// Clear all metadata.
+		add_action('wp_ajax_eeaPpClearMetaData', [__CLASS__, 'clearMetaData']);
+		// Admin notice.
+		add_action('admin_init', [__CLASS__, 'adminNotice']);
+	}
+
+
+	/**
+	 * Get the onboarding URL.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function getOnboardingUrl(): void
+	{
+		$signup_link = '';
+		try {
+			$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+			if (! $paypal_pm instanceof EE_Payment_Method) {
+				PayPalLogger::errorLogAndExit(
+					esc_html__('No payment method.', 'event_espresso'),
+					EED_Module::getRequest()->postParams(),
+					$paypal_pm
+				);
+			}
+			PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
+			// Just get a new onboarding URL every time.
+			$signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
+			if (! $signup_link) {
+				$err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
+				PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
+			}
+		} catch (Exception $e) {
+			PayPalLogger::errorLogAndExit($e->getMessage(), ['trace' => $e->getTrace()]);
+		}
+		// Is it empty (can happen if we didn't get the URL through the API).
+		$signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+		wp_send_json(
+			[
+				'signup_link' => $signup_link,
+			]
+		);
+	}
+
+
+	/**
+	 * Request the sign-up link from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param bool              $one_time_request
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
+	{
+		$signup_link = '';
+		// Get the access token.
+		$access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
+		if (! $access_token) {
+			$err_msg = esc_html__('Error! No access token.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
+			return '';
+		}
+		// Request the access token.
+		$body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
+		$bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		$post_params = [
+			'method'  => 'POST',
+			'headers' => [
+				'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+				'Content-Type'                  => 'application/json',
+				'Authorization'                 => 'Bearer ' . $access_token,
+				'PayPal-Partner-Attribution-Id' => $bn_code,
+			],
+			'body'    => $body_params,
+		];
+		$request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+		$response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
+		// Check the data we received.
+		if (isset($response['error']) || empty($response['links'])) {
+			// Did the original access token get replaced by any chance ?
+			if (
+				! $one_time_request
+				&& ! empty($response['message'])
+				&& $response['message'] === 'Access Token not found in cache'
+			) {
+				// Clear all PM metadata and try getting the access token One more time.
+				PayPalExtraMetaManager::deleteData($paypal_pm);
+				PayPalLogger::errorLog(
+					esc_html__('Removing old metadata before new onboarding.', 'event_espresso'),
+					$response,
+					$paypal_pm
+				);
+				return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
+			}
+			$err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
+			return '';
+		}
+		// Now retrieve that sign-up link.
+		foreach ($response['links'] as $link) {
+			if ($link['rel'] === 'action_url') {
+				$signup_link = $link['href'] ?? '';
+			}
+		}
+		return $signup_link;
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws Exception
+	 */
+	public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
+	{
+		$identifier_string = new OneTimeString($paypal_pm->debug_mode());
+		$tracking_id       = $identifier_string->value();
+		$request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$selected_payment  = $request->getRequestParam('selected_payment', 'EXPRESS_CHECKOUT');
+		// Save the identifier for future use.
+		PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
+		// Assemble the return URL.
+		$return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm, $selected_payment);
+		return json_encode(
+			[
+				'tracking_id'             => $tracking_id,
+				'operations'              => [
+					[
+						'operation'                  => 'API_INTEGRATION',
+						'api_integration_preference' => [
+							'rest_api_integration' => [
+								'integration_method'  => 'PAYPAL',
+								'integration_type'    => 'THIRD_PARTY',
+								'third_party_details' => [
+									'features' => ['PAYMENT', 'REFUND', 'PARTNER_FEE'],
+								],
+							],
+						],
+					],
+				],
+				'products'                => [$selected_payment],
+				'legal_consents'          => [
+					[
+						'type'    => 'SHARE_DATA_CONSENT',
+						'granted' => true,
+					],
+				],
+				'partner_config_override' => [
+					'return_url' => $return_url,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $selected_payment
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getReturnUrl(EE_Payment_Method $paypal_pm, string $selected_payment = ''): string
+	{
+		$wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
+		$nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
+		return add_query_arg(
+			[
+				'page'                        => 'espresso_payment_settings',
+				'webhook_action'              => 'eepPpcMerchantOnboard',
+				'payment_method'              => $paypal_pm->slug(),
+				'_wpnonce'                    => $wp_nonce,
+				'nonce'                       => $nonce,
+				'selected_payment'            => $selected_payment,
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Redirect to the payment method (PP) settings home page.
+	 *
+	 * @return void
+	 */
+	public static function redirectToPmSettingsHome(): void
+	{
+		$get_params = EED_Module::getRequest()->getParams();
+		if (empty($get_params['payment_method'])) {
+			// Simply do not redirect.
+			return;
+		}
+		$args_to_add = [
+			'page'           => 'espresso_payment_settings',
+			'payment_method' => $get_params['payment_method'],
+		];
+		if (isset($get_params['sandbox_mode'])) {
+			$args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
+		}
+		$home_url = add_query_arg($args_to_add, admin_url('admin.php'));
+		wp_redirect($home_url);
+		exit;
+	}
+
+
+	/**
+	 * Check user’s onboarding status.
+	 * This will handle the user return from the auth page and also check the status via the API.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function updateOnboardingStatus(): void
+	{
+		// Check if this is the webhook from PayPal.
+		if (
+			! isset($_GET['webhook_action'], $_GET['nonce'])
+			|| $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
+		) {
+			return;  // Ignore.
+		}
+		$get_params = EED_Module::getRequest()->getParams();
+		// Get the payment method.
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		// Check the response (GET) parameters.
+		if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
+			// Missing parameters. Can't proceed.
+			PayPalLogger::errorLog(
+				esc_html__('Missing required onboarding parameters.', 'event_espresso'),
+				$get_params,
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Check on the onboarding status (recommended by PP).
+		$onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
+			$paypal_pm,
+			$get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+		);
+		if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+			PayPalLogger::errorLog(
+				$onboarding_status['message'],
+				array_merge($get_params, $onboarding_status),
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Start saving the setup and info.
+		PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status, $get_params);
+		// Save the credentials.
+		PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
+		// Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
+		EED_PayPalOnboard::redirectToPmSettingsHome();
+	}
+
+
+	/**
+	 * Check if all required parameters for the onboarding status check are present.
+	 *
+	 * @param array $data
+	 * @param mixed $paypal_pm
+	 * @return bool
+	 */
+	public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
+	{
+		// Check that we have all the required parameters and the nonce is ok.
+		if (
+			$paypal_pm instanceof EE_Payment_Method
+			&& wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
+			&& ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
+			&& ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+			&& isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		// Do we have it saved ?
+		$access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
+		// If we don't have it, request/update it.
+		if (! $access_token) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		if (EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm)) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		// Access token is saved as encrypted, but return decrypted.
+		return $access_token;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
+	{
+		$expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_TOKEN_EXPIRES_IN);
+		if (! $expires_at) {
+			return true;
+		}
+		// Validate the token expiration date.
+		$minutes_left = round(($expires_at - time()) / 60);
+		// Count as expired if less than 60 minutes till expiration left.
+		if ($minutes_left <= 60) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Request the partner access token from PayPal and save/update it.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		$nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
+		// Request the access token.
+		$post_args = [
+			'method' => 'POST',
+			'body'   => [
+				'nonce'                       => $nonce,
+				'api_version'                 => 'v1',
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+		];
+		if (defined('LOCAL_MIDDLEMAN_SERVER')) {
+			$post_args['sslverify'] = Manager::verifySSL();
+		}
+		$post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+		$response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
+		if (isset($response['error'])) {
+			return '';
+		}
+		// Check the data we received.
+		if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
+			return '';
+		}
+		// If we are here all seems to be ok. Save the token and it's data.
+		$saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
+		if (! $saved) {
+			return '';
+		}
+		return $response['access_token'];
+	}
+
+
+	/**
+	 * Request seller onboarding status from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
+	{
+		$track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
+		if (! $track_onboarding instanceof TrackSellerOnboarding) {
+			return [
+				'error'   => 'TRACK_ONBOARDING_FAILED',
+				'message' => esc_html__('Failed to track seller onboarding.', 'event_espresso')
+			];
+		}
+		return $track_onboarding->isValid();
+	}
+
+
+	/**
+	 * Returns the Track Seller Onboarding API.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return TrackSellerOnboarding|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getTrackOnboardingApi(
+		EE_Payment_Method $paypal_pm,
+		string $merchant_id
+	): ?TrackSellerOnboarding {
+		$partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
+			return null;
+		}
+		return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
+	}
+
+
+	/**
+	 * Check the onboard status and return the result.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getOnboardStatus(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			$err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
+			wp_send_json(['on_board' => false]);
+		}
+		try {
+			$seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
+		} catch (Exception $e) {
+			$seller_id = '--';
+			PayPalLogger::errorLog($e->getMessage(), ['trace' => $e->getTrace()]);
+		}
+		wp_send_json(
+			[
+				'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
+				'seller_id' => $seller_id,
+			]
+		);
+	}
+
+
+	/**
+	 * De-authorize the seller. Remove all API credentials.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function offboard(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		EED_PayPalOnboard::validatePmAjax($paypal_pm);
+		PayPalExtraMetaManager::deleteData($paypal_pm);
+		PayPalLogger::errorLog(
+			esc_html__('Offboarding. Removing metadata.', 'event_espresso'),
+			EED_Module::getRequest()->postParams(),
+			$paypal_pm
+		);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Clear all credentials metadata.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function clearMetaData(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		EED_PayPalOnboard::validatePmAjax($paypal_pm);
+		PayPalExtraMetaManager::deleteAllData($paypal_pm);
+		PayPalLogger::errorLog(
+			esc_html__('Doing a Reset. Removing all PM settings metadata.', 'event_espresso'),
+			EED_Module::getRequest()->postParams(),
+			$paypal_pm
+		);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Validate the PM instance, returning an ajax response on invalid.
+	 *
+	 * @param $paypal_pm
+	 * @return void
+	 */
+	public static function validatePmAjax($paypal_pm): void
+	{
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			wp_send_json(
+				[
+					'error'   => 'INVALID_PM',
+					'message' => esc_html__(
+						'Invalid payment method. Please refresh the page and try again.',
+						'event_espresso'
+					),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Checks if already onboard.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function isOnboard(EE_Payment_Method $payment_method): bool
+	{
+		$pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
+		return
+			(
+				// onboarded with a third party integration ?
+				! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
+			) || (
+				// or with the first party integration ?
+				! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
+			);
+	}
+
+
+	/**
+	 * Send a request and return a decoded response body.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $request_url
+	 * @param array             $request_args
+	 * @return array
+	 */
+	public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
+	{
+		$error_return = ['error' => true];
+		$response     = wp_remote_request($request_url, $request_args);
+		if (is_wp_error($response)) {
+			$message = $response->get_error_message();
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		$response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
+		if (empty($response_body) || isset($response_body['error'])) {
+			$message = $response_body['error_description']
+				?? sprintf(
+					esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
+					$request_url
+				);
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		return $response_body;
+	}
+
+
+	/**
+	 * Check the response for a partner token request.
+	 *
+	 * @param array             $response
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerTokenResponseValid(array $response, EE_Payment_Method $paypal_pm): bool
+	{
+		// Check the data we received.
+		if (
+			empty($response['nonce'])
+			|| ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
+			|| empty($response['access_token'])
+			|| empty($response['app_id'])
+			|| empty($response['expires_in'])
+			|| empty($response['partner_client_id'])
+			|| empty($response['partner_merchant_id'])
+		) {
+			// This is an error.
+			PayPalLogger::errorLog(
+				esc_html__('Incoming parameter validation failed.', 'event_espresso'),
+				$response,
+				$paypal_pm
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Returns the base URL to the middleman server.
+	 * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
+	{
+		$target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
+		// If this PM is used under different provider accounts, you might need an account indicator.
+		$account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
+		$postfix = $payment_method->debug_mode() ? '_sandbox' : '';
+		return "https://connect.eventespresso.$target/paypal_commerce$account$postfix/";
+	}
+
+
+	/**
+	 * This Payment Method admin notices.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function adminNotice()
+	{
+		// Show the notice if PayPal Commerce PM is active but merchant is not onboard.
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
+		if (
+			$pp_commerce instanceof EE_Payment_Method
+			&& $pp_commerce->active()
+			&& ! EED_PayPalOnboard::isOnboard($pp_commerce)
+		) {
+			add_action('admin_notices', [EED_PayPalOnboard::class, 'notOnboardNotice']);
+		}
+	}
+
+
+	/**
+	 * Contents of the not onboard admin notice.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function notOnboardNotice()
+	{
+		$open_anchor = $close_anchor = '';
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
+		if ($pp_commerce instanceof EE_Payment_Method) {
+			$pm_page      = add_query_arg(
+				[
+					'page'           => 'espresso_payment_settings',
+					'webhook_action' => 'eepPpcMerchantOnboard',
+					'payment_method' => $pp_commerce->slug(),
+				],
+				admin_url('admin.php')
+			);
+			$open_anchor  = "<a href='$pm_page'>";
+			$close_anchor = "</a>";
+		}
+		$notice = sprintf(
+			esc_html__(
+				'%1$sPayPal Commerce%2$s payment method was activated but is not connected to PayPal. Please %3$sfinish setting up%4$s this payment method.',
+				'event_espresso'
+			),
+			'<strong>',
+			'</strong>',
+			$open_anchor,
+			$close_anchor
+		);
+		echo "
         <div class='error'>
             <p>$notice</p>
         </div>";
-    }
+	}
 }

Spacing +29 added lines, -29 removed lines

@@ -84,7 +84,7 @@ 
         $signup_link = '';
         try {
             $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
+            if ( ! $paypal_pm instanceof EE_Payment_Method) {
                 PayPalLogger::errorLogAndExit(
                     esc_html__('No payment method.', 'event_espresso'),
                     EED_Module::getRequest()->postParams(),
@@ -94,7 +94,7 @@ 
             PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
             // Just get a new onboarding URL every time.
             $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
-            if (! $signup_link) {
+            if ( ! $signup_link) {
                 $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
                 PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
             }
@@ -102,7 +102,7 @@ 
             PayPalLogger::errorLogAndExit($e->getMessage(), ['trace' => $e->getTrace()]);
         }
         // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+        $signup_link = $signup_link ? $signup_link.'?&displayMode=minibrowser' : '#';
         wp_send_json(
             [
                 'signup_link' => $signup_link,
@@ -125,7 +125,7 @@ 
         $signup_link = '';
         // Get the access token.
         $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
+        if ( ! $access_token) {
             $err_msg = esc_html__('Error! No access token.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
             return '';
@@ -138,12 +138,12 @@ 
             'headers' => [
                 'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
                 'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
+                'Authorization'                 => 'Bearer '.$access_token,
                 'PayPal-Partner-Attribution-Id' => $bn_code,
             ],
             'body'    => $body_params,
         ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+        $request_url = Domain::getPayPalApiUrl($paypal_pm).'/v2/customer/partner-referrals';
         $response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
         // Check the data we received.
         if (isset($response['error']) || empty($response['links'])) {
@@ -270,7 +270,7 @@ 
             'payment_method' => $get_params['payment_method'],
         ];
         if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
+            $args_to_add[Domain::META_KEY_SANDBOX_MODE] = $get_params['sandbox_mode'];
         }
         $home_url = add_query_arg($args_to_add, admin_url('admin.php'));
         wp_redirect($home_url);
@@ -293,13 +293,13 @@ 
             ! isset($_GET['webhook_action'], $_GET['nonce'])
             || $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
         ) {
-            return;  // Ignore.
+            return; // Ignore.
         }
         $get_params = EED_Module::getRequest()->getParams();
         // Get the payment method.
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
         // Check the response (GET) parameters.
-        if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
+        if ( ! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
             // Missing parameters. Can't proceed.
             PayPalLogger::errorLog(
                 esc_html__('Missing required onboarding parameters.', 'event_espresso'),
@@ -312,9 +312,9 @@ 
         // Check on the onboarding status (recommended by PP).
         $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
             $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+            $get_params[Domain::META_KEY_SELLER_MERCHANT_ID]
         );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+        if ( ! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
             PayPalLogger::errorLog(
                 $onboarding_status['message'],
                 array_merge($get_params, $onboarding_status),
@@ -345,9 +345,9 @@ 
         if (
             $paypal_pm instanceof EE_Payment_Method
             && wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
-            && ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
-            && ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
+            && ! empty($data[Domain::API_PARAM_PARTNER_ID])
+            && ! empty($data[Domain::META_KEY_SELLER_MERCHANT_ID])
+            && isset($data[Domain::API_PARAM_EMAIL_CONFIRMED])
         ) {
             return true;
         }
@@ -368,7 +368,7 @@ 
         // Do we have it saved ?
         $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
         // If we don't have it, request/update it.
-        if (! $access_token) {
+        if ( ! $access_token) {
             return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
         }
         if (EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm)) {
@@ -390,7 +390,7 @@ 
     public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
     {
         $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_TOKEN_EXPIRES_IN);
-        if (! $expires_at) {
+        if ( ! $expires_at) {
             return true;
         }
         // Validate the token expiration date.
@@ -426,18 +426,18 @@ 
         if (defined('LOCAL_MIDDLEMAN_SERVER')) {
             $post_args['sslverify'] = Manager::verifySSL();
         }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm).'get_token';
         $response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
         if (isset($response['error'])) {
             return '';
         }
         // Check the data we received.
-        if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
+        if ( ! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
             return '';
         }
         // If we are here all seems to be ok. Save the token and it's data.
         $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
+        if ( ! $saved) {
             return '';
         }
         return $response['access_token'];
@@ -456,7 +456,7 @@ 
     public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
     {
         $track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
-        if (! $track_onboarding instanceof TrackSellerOnboarding) {
+        if ( ! $track_onboarding instanceof TrackSellerOnboarding) {
             return [
                 'error'   => 'TRACK_ONBOARDING_FAILED',
                 'message' => esc_html__('Failed to track seller onboarding.', 'event_espresso')
@@ -481,7 +481,7 @@ 
     ): ?TrackSellerOnboarding {
         $partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
+        if ( ! $paypal_api instanceof PayPalApi || ! $partner_id) {
             return null;
         }
         return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
@@ -499,7 +499,7 @@ 
     public static function getOnboardStatus(): void
     {
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
             wp_send_json(['on_board' => false]);
@@ -571,7 +571,7 @@ 
      */
     public static function validatePmAjax($paypal_pm): void
     {
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             wp_send_json(
                 [
                     'error'   => 'INVALID_PM',
@@ -599,13 +599,13 @@ 
         return
             (
                 // onboarded with a third party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
+                ! empty($pp_meta_data[Domain::META_KEY_SELLER_MERCHANT_ID])
+                && ! empty($pp_meta_data[Domain::META_KEY_ACCESS_TOKEN])
             ) || (
                 // or with the first party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
+                ! empty($pp_meta_data[Domain::META_KEY_CLIENT_ID])
+                && ! empty($pp_meta_data[Domain::META_KEY_CLIENT_SECRET])
+                && ! empty($pp_meta_data[Domain::META_KEY_PAYER_ID])
             );
     }
 
@@ -726,7 +726,7 @@ 
         $open_anchor = $close_anchor = '';
         $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug(Domain::PM_SLUG);
         if ($pp_commerce instanceof EE_Payment_Method) {
-            $pm_page      = add_query_arg(
+            $pm_page = add_query_arg(
                 [
                     'page'           => 'espresso_payment_settings',
                     'webhook_action' => 'eepPpcMerchantOnboard',

PaymentMethods/PayPalCommerce/PayPalCheckout/forms/OnboardingForm.php

Indentation +164 added lines, -164 removed lines

@@ -22,179 +22,179 @@
  */
 class OnboardingForm extends EE_Form_Section_Proper
 {
-    /**
-     *  Payment method.
-     *
-     * @var EE_PMT_Base|null
-     */
-    protected $payment_method = null;
+	/**
+	 *  Payment method.
+	 *
+	 * @var EE_PMT_Base|null
+	 */
+	protected $payment_method = null;
 
-    /**
-     *  Payment method instance.
-     *
-     * @var EE_PMT_Base|null
-     */
-    protected $pm_instance = null;
+	/**
+	 *  Payment method instance.
+	 *
+	 * @var EE_PMT_Base|null
+	 */
+	protected $pm_instance = null;
 
-    /**
-     *  Payment method slug.
-     *
-     * @var EE_PMT_Base|null
-     */
-    protected $pm_slug = null;
+	/**
+	 *  Payment method slug.
+	 *
+	 * @var EE_PMT_Base|null
+	 */
+	protected $pm_slug = null;
 
-    /**
-     *  Options field header.
-     *
-     * @var string
-     */
-    protected $option_heading = '';
+	/**
+	 *  Options field header.
+	 *
+	 * @var string
+	 */
+	protected $option_heading = '';
 
-    /**
-     *  Onboarding URL.
-     *
-     * @var string
-     */
-    protected $onboarding_url = '';
+	/**
+	 *  Onboarding URL.
+	 *
+	 * @var string
+	 */
+	protected $onboarding_url = '';
 
-    /**
-     *  Onboarding form html entities object.
-     *
-     * @var OnboardingFormHtml|null
-     */
-    protected $form_html = null;
+	/**
+	 *  Onboarding form html entities object.
+	 *
+	 * @var OnboardingFormHtml|null
+	 */
+	protected $form_html = null;
 
 
-    /**
-     * Class constructor.
-     *
-     * @param EE_PMT_Base       $pmt
-     * @param EE_Payment_Method $payment_method
-     * @throws EE_Error
-     */
-    public function __construct(EE_PMT_Base $pmt, EE_Payment_Method $payment_method)
-    {
-        $this->payment_method      = $pmt;
-        $this->pm_instance         = $payment_method;
-        $this->pm_slug             = $this->pm_instance->slug();
-        $this->form_html           = new OnboardingFormHtml($pmt, $payment_method);
-        // Help tab link as icon.
-        $this->option_heading = $this->form_html->getHeader();
-        $options = [
-            'html_id'               => $this->pm_slug . '_pp_commerce_form',
-            'layout_strategy'       => new EE_Admin_Two_Column_Layout(),
-            'validation_strategies' => [new EE_Simple_HTML_Validation_Strategy()],
-            'subsections'           => $this->onboardSectionContents(),
-        ];
-        parent::__construct($options);
-    }
+	/**
+	 * Class constructor.
+	 *
+	 * @param EE_PMT_Base       $pmt
+	 * @param EE_Payment_Method $payment_method
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_PMT_Base $pmt, EE_Payment_Method $payment_method)
+	{
+		$this->payment_method      = $pmt;
+		$this->pm_instance         = $payment_method;
+		$this->pm_slug             = $this->pm_instance->slug();
+		$this->form_html           = new OnboardingFormHtml($pmt, $payment_method);
+		// Help tab link as icon.
+		$this->option_heading = $this->form_html->getHeader();
+		$options = [
+			'html_id'               => $this->pm_slug . '_pp_commerce_form',
+			'layout_strategy'       => new EE_Admin_Two_Column_Layout(),
+			'validation_strategies' => [new EE_Simple_HTML_Validation_Strategy()],
+			'subsections'           => $this->onboardSectionContents(),
+		];
+		parent::__construct($options);
+	}
 
 
-    /**
-     * Add the onboarding options section.
-     *
-     * @return array
-     */
-    public function onboardSectionContents(): array
-    {
-        $subsections = [];
-        // Get the Onboarding status.
-        $is_onboard  = EED_PayPalOnboard::isOnboard($this->pm_instance);
-        $subsections = $this->form_html->addOnboardButton($subsections, $is_onboard);
-        $subsections = $this->form_html->addOffboardButton($subsections, $is_onboard);
-        return $this->form_html->addPmSlugHolder($subsections);
-    }
+	/**
+	 * Add the onboarding options section.
+	 *
+	 * @return array
+	 */
+	public function onboardSectionContents(): array
+	{
+		$subsections = [];
+		// Get the Onboarding status.
+		$is_onboard  = EED_PayPalOnboard::isOnboard($this->pm_instance);
+		$subsections = $this->form_html->addOnboardButton($subsections, $is_onboard);
+		$subsections = $this->form_html->addOffboardButton($subsections, $is_onboard);
+		return $this->form_html->addPmSlugHolder($subsections);
+	}
 
 
-    /**
-     * Add JS needed for this form.
-     * This is called automatically when displaying the form.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function enqueue_js()
-    {
-        // Also tell the script about each instance of this PM.
-        $pm_versions = $pm_dialogs = [];
-        $active_payment_methods = EEM_Payment_Method::instance()->get_all_active(
-            EEM_Payment_Method::scope_cart,
-            [['PMD_slug' => ['LIKE', '%' . Domain::PM_SLUG . '%']]]
-        );
-        foreach ($active_payment_methods as $payment_method) {
-            if (! $payment_method instanceof EE_Payment_Method) {
-                continue;
-            }
-            $pm_slug = $payment_method->slug();
-            $pm_versions[ $pm_slug ] = [
-                'pm_slug' => $pm_slug,
-            ];
-            $form_html = new OnboardingFormHtml($this->payment_method, $payment_method);
-            $pm_dialogs[ $pm_slug ]['connect_dialog'] = $form_html->connectDialog()->get_html();
-            $pm_dialogs[ $pm_slug ]['disconnect_dialog'] = $form_html->disconnectDialog()->get_html();
-            $pm_dialogs[ $pm_slug ]['processing_mask'] = $form_html->processingMask()->get_html();
-        }
-        $countries_iso = ["US", "AU", "AT", "BE", "BG", "HR", "CY", "CZ", "DK", "EE", "FI", "FR", "DE", "GR", "HU",
-                          "IE", "IT", "LV", "LT", "LU", "MT", "NL", "PL", "PT", "RO", "SK", "SI", "ES", "SE"];
-        $parameters = [
-            'onboard_btn_text'     => $this->form_html->onboard_btn_text,
-            'sandbox_btn_text'     => $this->form_html->sandbox_btn_text,
-            'sandbox_text'         => $this->form_html->authed_sandbox_text,
-            'pm_versions'          => $pm_versions,
-            'onboarding_url'       => $this->onboarding_url,
-            'supported_countries'  => $countries_iso,
-            'pm_dialogs'           => $pm_dialogs,
-            'ee_default_styles'    => EE_ADMIN_URL . 'assets/ee-admin-page.css',
-            'wp_stylesheet'        => includes_url('css/dashicons.min.css'),
-            'can_disable_input'    => method_exists('EE_Form_Input_Base', 'isDisabled'),
-            'connection_notice'    => esc_html__('Error while requesting the redirect URL.', 'event_espresso'),
-            'error_response'       => esc_html__('Error response received', 'event_espresso'),
-            'request_error'        => esc_html__(
-                'Onboarding request Error. Please check the logs on the Payment Methods page.',
-                'event_espresso'
-            ),
-            'unknown_container'    => esc_html__('Could not specify the parent form.', 'event_espresso'),
-            'pm_nice_name'         => esc_html__('PayPal Commerce', 'event_espresso'),
-            'blocked_popup_notice' => esc_html__(
-                'The authentication process could not be executed. Please allow window pop-ups in your browser for this website in order to process a successful authentication.',
-                'event_espresso'
-            ),
-            'debug_is_on_notice'   => esc_html__(
-                'The authentication with PayPal is in sandbox mode! If you wish to process real payments with this payment method, please Offboard and use live credentials to authenticate with PayPal.',
-                'event_espresso'
-            ),
-            'debug_is_off_notice'  => esc_html__(
-                'The authentication with PayPal is in Live mode! If you wish to test this payment method, please Offboard and use sandbox credentials to authenticate with PayPal.',
-                'event_espresso'
-            ),
-            'refresh_alert'        => esc_html__(
-                'There was an unexpected error. Please refresh the page and check the logs on the Payment Methods page.',
-                'event_espresso'
-            ),
-        ];
-        // Styles.
-        wp_enqueue_style(
-            'eea_paypal_onboard_form_styles',
-            EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'css' . DS . 'eea-paypal-onboard.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        // Scripts.
-        wp_enqueue_script(
-            'eea_paypal_onboard_form_scripts',
-            EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'js' . DS . 'eea-paypal-onboarding.js',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script(
-            'eea_paypal_partner_script',
-            'https://www.paypal.com/webapps/merchantboarding/js/lib/lightbox/partner.js',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        // Localize the script with some extra data.
-        wp_localize_script('eea_paypal_onboard_form_scripts', 'eeaPPOnboardParameters', $parameters);
-        parent::enqueue_js();
-    }
+	/**
+	 * Add JS needed for this form.
+	 * This is called automatically when displaying the form.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function enqueue_js()
+	{
+		// Also tell the script about each instance of this PM.
+		$pm_versions = $pm_dialogs = [];
+		$active_payment_methods = EEM_Payment_Method::instance()->get_all_active(
+			EEM_Payment_Method::scope_cart,
+			[['PMD_slug' => ['LIKE', '%' . Domain::PM_SLUG . '%']]]
+		);
+		foreach ($active_payment_methods as $payment_method) {
+			if (! $payment_method instanceof EE_Payment_Method) {
+				continue;
+			}
+			$pm_slug = $payment_method->slug();
+			$pm_versions[ $pm_slug ] = [
+				'pm_slug' => $pm_slug,
+			];
+			$form_html = new OnboardingFormHtml($this->payment_method, $payment_method);
+			$pm_dialogs[ $pm_slug ]['connect_dialog'] = $form_html->connectDialog()->get_html();
+			$pm_dialogs[ $pm_slug ]['disconnect_dialog'] = $form_html->disconnectDialog()->get_html();
+			$pm_dialogs[ $pm_slug ]['processing_mask'] = $form_html->processingMask()->get_html();
+		}
+		$countries_iso = ["US", "AU", "AT", "BE", "BG", "HR", "CY", "CZ", "DK", "EE", "FI", "FR", "DE", "GR", "HU",
+						  "IE", "IT", "LV", "LT", "LU", "MT", "NL", "PL", "PT", "RO", "SK", "SI", "ES", "SE"];
+		$parameters = [
+			'onboard_btn_text'     => $this->form_html->onboard_btn_text,
+			'sandbox_btn_text'     => $this->form_html->sandbox_btn_text,
+			'sandbox_text'         => $this->form_html->authed_sandbox_text,
+			'pm_versions'          => $pm_versions,
+			'onboarding_url'       => $this->onboarding_url,
+			'supported_countries'  => $countries_iso,
+			'pm_dialogs'           => $pm_dialogs,
+			'ee_default_styles'    => EE_ADMIN_URL . 'assets/ee-admin-page.css',
+			'wp_stylesheet'        => includes_url('css/dashicons.min.css'),
+			'can_disable_input'    => method_exists('EE_Form_Input_Base', 'isDisabled'),
+			'connection_notice'    => esc_html__('Error while requesting the redirect URL.', 'event_espresso'),
+			'error_response'       => esc_html__('Error response received', 'event_espresso'),
+			'request_error'        => esc_html__(
+				'Onboarding request Error. Please check the logs on the Payment Methods page.',
+				'event_espresso'
+			),
+			'unknown_container'    => esc_html__('Could not specify the parent form.', 'event_espresso'),
+			'pm_nice_name'         => esc_html__('PayPal Commerce', 'event_espresso'),
+			'blocked_popup_notice' => esc_html__(
+				'The authentication process could not be executed. Please allow window pop-ups in your browser for this website in order to process a successful authentication.',
+				'event_espresso'
+			),
+			'debug_is_on_notice'   => esc_html__(
+				'The authentication with PayPal is in sandbox mode! If you wish to process real payments with this payment method, please Offboard and use live credentials to authenticate with PayPal.',
+				'event_espresso'
+			),
+			'debug_is_off_notice'  => esc_html__(
+				'The authentication with PayPal is in Live mode! If you wish to test this payment method, please Offboard and use sandbox credentials to authenticate with PayPal.',
+				'event_espresso'
+			),
+			'refresh_alert'        => esc_html__(
+				'There was an unexpected error. Please refresh the page and check the logs on the Payment Methods page.',
+				'event_espresso'
+			),
+		];
+		// Styles.
+		wp_enqueue_style(
+			'eea_paypal_onboard_form_styles',
+			EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'css' . DS . 'eea-paypal-onboard.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		// Scripts.
+		wp_enqueue_script(
+			'eea_paypal_onboard_form_scripts',
+			EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'js' . DS . 'eea-paypal-onboarding.js',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script(
+			'eea_paypal_partner_script',
+			'https://www.paypal.com/webapps/merchantboarding/js/lib/lightbox/partner.js',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		// Localize the script with some extra data.
+		wp_localize_script('eea_paypal_onboard_form_scripts', 'eeaPPOnboardParameters', $parameters);
+		parent::enqueue_js();
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -81,7 +81,7 @@ 
         // Help tab link as icon.
         $this->option_heading = $this->form_html->getHeader();
         $options = [
-            'html_id'               => $this->pm_slug . '_pp_commerce_form',
+            'html_id'               => $this->pm_slug.'_pp_commerce_form',
             'layout_strategy'       => new EE_Admin_Two_Column_Layout(),
             'validation_strategies' => [new EE_Simple_HTML_Validation_Strategy()],
             'subsections'           => $this->onboardSectionContents(),
@@ -120,20 +120,20 @@ 
         $pm_versions = $pm_dialogs = [];
         $active_payment_methods = EEM_Payment_Method::instance()->get_all_active(
             EEM_Payment_Method::scope_cart,
-            [['PMD_slug' => ['LIKE', '%' . Domain::PM_SLUG . '%']]]
+            [['PMD_slug' => ['LIKE', '%'.Domain::PM_SLUG.'%']]]
         );
         foreach ($active_payment_methods as $payment_method) {
-            if (! $payment_method instanceof EE_Payment_Method) {
+            if ( ! $payment_method instanceof EE_Payment_Method) {
                 continue;
             }
             $pm_slug = $payment_method->slug();
-            $pm_versions[ $pm_slug ] = [
+            $pm_versions[$pm_slug] = [
                 'pm_slug' => $pm_slug,
             ];
             $form_html = new OnboardingFormHtml($this->payment_method, $payment_method);
-            $pm_dialogs[ $pm_slug ]['connect_dialog'] = $form_html->connectDialog()->get_html();
-            $pm_dialogs[ $pm_slug ]['disconnect_dialog'] = $form_html->disconnectDialog()->get_html();
-            $pm_dialogs[ $pm_slug ]['processing_mask'] = $form_html->processingMask()->get_html();
+            $pm_dialogs[$pm_slug]['connect_dialog'] = $form_html->connectDialog()->get_html();
+            $pm_dialogs[$pm_slug]['disconnect_dialog'] = $form_html->disconnectDialog()->get_html();
+            $pm_dialogs[$pm_slug]['processing_mask'] = $form_html->processingMask()->get_html();
         }
         $countries_iso = ["US", "AU", "AT", "BE", "BG", "HR", "CY", "CZ", "DK", "EE", "FI", "FR", "DE", "GR", "HU",
                           "IE", "IT", "LV", "LT", "LU", "MT", "NL", "PL", "PT", "RO", "SK", "SI", "ES", "SE"];
@@ -145,7 +145,7 @@ 
             'onboarding_url'       => $this->onboarding_url,
             'supported_countries'  => $countries_iso,
             'pm_dialogs'           => $pm_dialogs,
-            'ee_default_styles'    => EE_ADMIN_URL . 'assets/ee-admin-page.css',
+            'ee_default_styles'    => EE_ADMIN_URL.'assets/ee-admin-page.css',
             'wp_stylesheet'        => includes_url('css/dashicons.min.css'),
             'can_disable_input'    => method_exists('EE_Form_Input_Base', 'isDisabled'),
             'connection_notice'    => esc_html__('Error while requesting the redirect URL.', 'event_espresso'),
@@ -176,14 +176,14 @@ 
         // Styles.
         wp_enqueue_style(
             'eea_paypal_onboard_form_styles',
-            EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'css' . DS . 'eea-paypal-onboard.css',
+            EEP_PAYPAL_COMMERCE_URL.'assets'.DS.'css'.DS.'eea-paypal-onboard.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
         // Scripts.
         wp_enqueue_script(
             'eea_paypal_onboard_form_scripts',
-            EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'js' . DS . 'eea-paypal-onboarding.js',
+            EEP_PAYPAL_COMMERCE_URL.'assets'.DS.'js'.DS.'eea-paypal-onboarding.js',
             [],
             EVENT_ESPRESSO_VERSION
         );

PaymentMethods/PayPalCommerce/tools/extra_meta/PayPalExtraMetaManager.php

Indentation +383 added lines, -383 removed lines

@@ -22,387 +22,387 @@
  */
 class PayPalExtraMetaManager
 {
-    private static ?OpenSSLEncryption $encryptor = null;
-
-    private static ?PayPalExtraMeta $pay_pal_extra_meta = null;
-
-
-    /**
-     * Get PayPal extra meta helper.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return PayPalExtraMeta
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
-    {
-        if (
-            ! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta
-            || PayPalExtraMetaManager::$pay_pal_extra_meta->pm->slug() !== $paypal_pm->slug()
-        ) {
-            PayPalExtraMetaManager::$pay_pal_extra_meta = new PayPalExtraMeta($paypal_pm);
-        }
-        return PayPalExtraMetaManager::$pay_pal_extra_meta;
-    }
-
-
-    /**
-     * Get OpenSSLEncryption instance.
-     *
-     * @return OpenSSLEncryption
-     */
-    public static function encryptor(): OpenSSLEncryption
-    {
-        if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
-            PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
-                OpenSSLEncryption::class,
-                [new Base64Encoder()]
-            );
-        }
-        return PayPalExtraMetaManager::$encryptor;
-    }
-
-
-    /**
-     * Get payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
-    {
-        $option_value = PayPalExtraMetaManager::extraMeta($paypal_pm)->getOption($option_name);
-        // Decrypt the encrypted options.
-        if (
-            $option_name === Domain::META_KEY_ACCESS_TOKEN
-            || $option_name === Domain::META_KEY_PARTNER_MERCHANT_ID
-            || $option_name === Domain::META_KEY_CLIENT_SECRET
-        ) {
-            $option_value = PayPalExtraMetaManager::decryptString($option_value, $paypal_pm);
-        }
-        return $option_value;
-    }
-
-
-    /**
-     * Save payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @param                   $option_value
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveOption($option_name, $option_value);
-    }
-
-
-    /**
-     * Save a list of payment method options/extra meta.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $options_list
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveBatch($options_list);
-    }
-
-
-    /**
-     * Delete payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteOption($option_name);
-    }
-
-
-    /**
-     * Get all options for payment method.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getAllData(EE_Payment_Method $paypal_pm): array
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->getMetaData();
-    }
-
-
-    /**
-     * Delete payment method metadata.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deleteData(EE_Payment_Method $paypal_pm): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteMetaData();
-    }
-
-
-    /**
-     * Delete all payment method metadata.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteAllMetaData();
-    }
-
-    /**
-     * Save the debug mode option if it changed.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $request_data
-     * @return bool             Updated or not.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function updateDebugMode(EE_Payment_Method $paypal_pm, array $request_data): bool
-    {
-        if (
-            isset($request_data['sandbox_mode'])
-            && in_array($request_data['sandbox_mode'], ['0', '1'], true)
-            && $paypal_pm->debug_mode() !== (bool) $request_data['sandbox_mode']
-        ) {
-            try {
-                $paypal_pm->save(['PMD_debug_mode' => (bool) $request_data['sandbox_mode']]);
-            } catch (EE_Error $e) {
-                PayPalLogger::errorLog(
-                    sprintf(
-                        esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
-                        $e->getMessage()
-                    ),
-                    ['request_data' => $request_data, 'trace' => $e->getTrace()],
-                    $paypal_pm
-                );
-                return false;
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Save partner access token and parameters.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $paypal_data         = [];
-        $expected_parameters = [
-            Domain::META_KEY_ACCESS_TOKEN,
-            Domain::META_KEY_TOKEN_EXPIRES_IN,
-            Domain::META_KEY_APP_ID,
-            Domain::META_KEY_PARTNER_CLIENT_ID,
-            Domain::META_KEY_PARTNER_MERCHANT_ID,
-            Domain::META_KEY_BN_CODE,
-        ];
-        foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
-                // Don't want to try saving data that doesn't exist.
-                continue;
-            }
-            try {
-                switch ($api_key) {
-                    case Domain::META_KEY_ACCESS_TOKEN:
-                    case Domain::META_KEY_PARTNER_MERCHANT_ID:
-                        $paypal_data[ $api_key ] = PayPalExtraMetaManager::encryptString(
-                            $response[ $api_key ],
-                            $paypal_pm
-                        );
-                        break;
-                    case Domain::META_KEY_TOKEN_EXPIRES_IN:
-                        $paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
-                        break;
-                    default:
-                        $paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
-                }
-            } catch (Exception $e) {
-                PayPalLogger::errorLog(
-                    $e->getMessage(),
-                    ['response' => $response, 'trace' => $e->getTrace()],
-                    $paypal_pm
-                );
-                return false;
-            }
-        }
-        return PayPalExtraMetaManager::savePmOptions($paypal_pm, $paypal_data);
-    }
-
-
-    /**
-     * Save merchant/seller API credentials.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function saveSellerApiCredentials(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $api_credentials     = [];
-        $expected_parameters = [Domain::META_KEY_SELLER_MERCHANT_ID];
-        foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
-                // Don't want to try saving data that doesn't exist.
-                continue;
-            }
-            $api_credentials[ $api_key ] = $response[ $api_key ];
-        }
-        return PayPalExtraMetaManager::savePmOptions($paypal_pm, $api_credentials);
-    }
-
-
-    /**
-     * Save other payment method related settings from a data array.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $data
-     * @param array             $get_params
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function parseAndSaveOptions(EE_Payment_Method $paypal_pm, array $data, array $get_params): bool
-    {
-        $allowed_checkout_type = 'express_checkout';
-        // Did the merchant onboard with PPCP enabled or no.
-        if (! empty($get_params['selected_payment']) && $get_params['selected_payment'] === 'PPCP') {
-            // Make sure that merchant's account really supports advanced card fields (included in the PPCP scope).
-            // Has to include "PPCP_CUSTOM" product for ACDC support. "EXPRESS_CHECKOUT" otherwise.
-            if (! empty($data['response']['products'][0]['name'])) {
-                foreach ($data['response']['products'] as $product) {
-                    if ($product['name'] === 'PPCP_CUSTOM') {
-                        // This merchant has PPCP in the products list, so we can enable both (all supported) checkout types.
-                        $allowed_checkout_type = 'all';
-                        break;
-                    }
-                }
-            }
-        }
-        // Set the PM option Checkout type, just in case merchant doesn't save PM options manually.
-        $checkout_type_setting = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
-        if (! $checkout_type_setting || $checkout_type_setting !== $allowed_checkout_type) {
-            $paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
-        }
-        // Save the scopes that were authorized.
-        if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
-            $scopes = [];
-            foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
-                // Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
-                $split       = explode('/', $scope);
-                $split_count = count($split);
-                // Get the scope itself.
-                $scopes[] = $split[ $split_count - 1 ];
-            }
-            if (empty($scopes)) {
-                // In case the there's a change in how scopes come in just save the list.
-                $scopes = $data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'];
-            }
-            PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_AUTHORIZED_SCOPES, $scopes);
-        }
-        return PayPalExtraMetaManager::savePmOption(
-            $paypal_pm,
-            Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
-            $allowed_checkout_type
-        );
-    }
-
-
-    /**
-     * Encrypt a text field.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string|null
-     * @throws Exception
-     */
-    public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
-    {
-        // We sure we are getting something ?
-        if (! $text) {
-            return $text;
-        }
-
-        try {
-            // Do encrypt.
-            $sanitized_text = sanitize_text_field($text);
-            $key_identifier = $paypal_pm->debug_mode()
-                ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-                : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-            $encrypted      = PayPalExtraMetaManager::encryptor()->encrypt($sanitized_text, $key_identifier);
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                $e->getMessage(),
-                ['trace' => $e->getTrace()],
-                $paypal_pm
-            );
-        }
-        return $encrypted ?? null;
-    }
-
-
-    /**
-     * Decrypt a string.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     */
-    public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
-    {
-        // Are we even getting something ?
-        if (! $text) {
-            return $text;
-        }
-        // Try decrypting.
-        try {
-            $key_identifier = $paypal_pm->debug_mode()
-                ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-                : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-            $decrypted      = PayPalExtraMetaManager::encryptor()->decrypt($text, $key_identifier);
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                $e->getMessage(),
-                ['trace' => $e->getTrace()],
-                $paypal_pm
-            );
-            return $text;
-        }
-        return $decrypted ?? $text;
-    }
+	private static ?OpenSSLEncryption $encryptor = null;
+
+	private static ?PayPalExtraMeta $pay_pal_extra_meta = null;
+
+
+	/**
+	 * Get PayPal extra meta helper.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return PayPalExtraMeta
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
+	{
+		if (
+			! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta
+			|| PayPalExtraMetaManager::$pay_pal_extra_meta->pm->slug() !== $paypal_pm->slug()
+		) {
+			PayPalExtraMetaManager::$pay_pal_extra_meta = new PayPalExtraMeta($paypal_pm);
+		}
+		return PayPalExtraMetaManager::$pay_pal_extra_meta;
+	}
+
+
+	/**
+	 * Get OpenSSLEncryption instance.
+	 *
+	 * @return OpenSSLEncryption
+	 */
+	public static function encryptor(): OpenSSLEncryption
+	{
+		if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
+			PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
+				OpenSSLEncryption::class,
+				[new Base64Encoder()]
+			);
+		}
+		return PayPalExtraMetaManager::$encryptor;
+	}
+
+
+	/**
+	 * Get payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
+	{
+		$option_value = PayPalExtraMetaManager::extraMeta($paypal_pm)->getOption($option_name);
+		// Decrypt the encrypted options.
+		if (
+			$option_name === Domain::META_KEY_ACCESS_TOKEN
+			|| $option_name === Domain::META_KEY_PARTNER_MERCHANT_ID
+			|| $option_name === Domain::META_KEY_CLIENT_SECRET
+		) {
+			$option_value = PayPalExtraMetaManager::decryptString($option_value, $paypal_pm);
+		}
+		return $option_value;
+	}
+
+
+	/**
+	 * Save payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @param                   $option_value
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveOption($option_name, $option_value);
+	}
+
+
+	/**
+	 * Save a list of payment method options/extra meta.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $options_list
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveBatch($options_list);
+	}
+
+
+	/**
+	 * Delete payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteOption($option_name);
+	}
+
+
+	/**
+	 * Get all options for payment method.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getAllData(EE_Payment_Method $paypal_pm): array
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->getMetaData();
+	}
+
+
+	/**
+	 * Delete payment method metadata.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deleteData(EE_Payment_Method $paypal_pm): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteMetaData();
+	}
+
+
+	/**
+	 * Delete all payment method metadata.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteAllMetaData();
+	}
+
+	/**
+	 * Save the debug mode option if it changed.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $request_data
+	 * @return bool             Updated or not.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function updateDebugMode(EE_Payment_Method $paypal_pm, array $request_data): bool
+	{
+		if (
+			isset($request_data['sandbox_mode'])
+			&& in_array($request_data['sandbox_mode'], ['0', '1'], true)
+			&& $paypal_pm->debug_mode() !== (bool) $request_data['sandbox_mode']
+		) {
+			try {
+				$paypal_pm->save(['PMD_debug_mode' => (bool) $request_data['sandbox_mode']]);
+			} catch (EE_Error $e) {
+				PayPalLogger::errorLog(
+					sprintf(
+						esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
+						$e->getMessage()
+					),
+					['request_data' => $request_data, 'trace' => $e->getTrace()],
+					$paypal_pm
+				);
+				return false;
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Save partner access token and parameters.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$paypal_data         = [];
+		$expected_parameters = [
+			Domain::META_KEY_ACCESS_TOKEN,
+			Domain::META_KEY_TOKEN_EXPIRES_IN,
+			Domain::META_KEY_APP_ID,
+			Domain::META_KEY_PARTNER_CLIENT_ID,
+			Domain::META_KEY_PARTNER_MERCHANT_ID,
+			Domain::META_KEY_BN_CODE,
+		];
+		foreach ($expected_parameters as $api_key) {
+			if (! isset($response[ $api_key ])) {
+				// Don't want to try saving data that doesn't exist.
+				continue;
+			}
+			try {
+				switch ($api_key) {
+					case Domain::META_KEY_ACCESS_TOKEN:
+					case Domain::META_KEY_PARTNER_MERCHANT_ID:
+						$paypal_data[ $api_key ] = PayPalExtraMetaManager::encryptString(
+							$response[ $api_key ],
+							$paypal_pm
+						);
+						break;
+					case Domain::META_KEY_TOKEN_EXPIRES_IN:
+						$paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
+						break;
+					default:
+						$paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
+				}
+			} catch (Exception $e) {
+				PayPalLogger::errorLog(
+					$e->getMessage(),
+					['response' => $response, 'trace' => $e->getTrace()],
+					$paypal_pm
+				);
+				return false;
+			}
+		}
+		return PayPalExtraMetaManager::savePmOptions($paypal_pm, $paypal_data);
+	}
+
+
+	/**
+	 * Save merchant/seller API credentials.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function saveSellerApiCredentials(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$api_credentials     = [];
+		$expected_parameters = [Domain::META_KEY_SELLER_MERCHANT_ID];
+		foreach ($expected_parameters as $api_key) {
+			if (! isset($response[ $api_key ])) {
+				// Don't want to try saving data that doesn't exist.
+				continue;
+			}
+			$api_credentials[ $api_key ] = $response[ $api_key ];
+		}
+		return PayPalExtraMetaManager::savePmOptions($paypal_pm, $api_credentials);
+	}
+
+
+	/**
+	 * Save other payment method related settings from a data array.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $data
+	 * @param array             $get_params
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function parseAndSaveOptions(EE_Payment_Method $paypal_pm, array $data, array $get_params): bool
+	{
+		$allowed_checkout_type = 'express_checkout';
+		// Did the merchant onboard with PPCP enabled or no.
+		if (! empty($get_params['selected_payment']) && $get_params['selected_payment'] === 'PPCP') {
+			// Make sure that merchant's account really supports advanced card fields (included in the PPCP scope).
+			// Has to include "PPCP_CUSTOM" product for ACDC support. "EXPRESS_CHECKOUT" otherwise.
+			if (! empty($data['response']['products'][0]['name'])) {
+				foreach ($data['response']['products'] as $product) {
+					if ($product['name'] === 'PPCP_CUSTOM') {
+						// This merchant has PPCP in the products list, so we can enable both (all supported) checkout types.
+						$allowed_checkout_type = 'all';
+						break;
+					}
+				}
+			}
+		}
+		// Set the PM option Checkout type, just in case merchant doesn't save PM options manually.
+		$checkout_type_setting = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
+		if (! $checkout_type_setting || $checkout_type_setting !== $allowed_checkout_type) {
+			$paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
+		}
+		// Save the scopes that were authorized.
+		if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
+			$scopes = [];
+			foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
+				// Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
+				$split       = explode('/', $scope);
+				$split_count = count($split);
+				// Get the scope itself.
+				$scopes[] = $split[ $split_count - 1 ];
+			}
+			if (empty($scopes)) {
+				// In case the there's a change in how scopes come in just save the list.
+				$scopes = $data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'];
+			}
+			PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_AUTHORIZED_SCOPES, $scopes);
+		}
+		return PayPalExtraMetaManager::savePmOption(
+			$paypal_pm,
+			Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
+			$allowed_checkout_type
+		);
+	}
+
+
+	/**
+	 * Encrypt a text field.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string|null
+	 * @throws Exception
+	 */
+	public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
+	{
+		// We sure we are getting something ?
+		if (! $text) {
+			return $text;
+		}
+
+		try {
+			// Do encrypt.
+			$sanitized_text = sanitize_text_field($text);
+			$key_identifier = $paypal_pm->debug_mode()
+				? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+				: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+			$encrypted      = PayPalExtraMetaManager::encryptor()->encrypt($sanitized_text, $key_identifier);
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				$e->getMessage(),
+				['trace' => $e->getTrace()],
+				$paypal_pm
+			);
+		}
+		return $encrypted ?? null;
+	}
+
+
+	/**
+	 * Decrypt a string.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 */
+	public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
+	{
+		// Are we even getting something ?
+		if (! $text) {
+			return $text;
+		}
+		// Try decrypting.
+		try {
+			$key_identifier = $paypal_pm->debug_mode()
+				? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+				: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+			$decrypted      = PayPalExtraMetaManager::encryptor()->decrypt($text, $key_identifier);
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				$e->getMessage(),
+				['trace' => $e->getTrace()],
+				$paypal_pm
+			);
+			return $text;
+		}
+		return $decrypted ?? $text;
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -54,7 +54,7 @@ 
      */
     public static function encryptor(): OpenSSLEncryption
     {
-        if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
+        if ( ! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
             PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
                 OpenSSLEncryption::class,
                 [new Base64Encoder()]
@@ -231,7 +231,7 @@ 
             Domain::META_KEY_BN_CODE,
         ];
         foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
+            if ( ! isset($response[$api_key])) {
                 // Don't want to try saving data that doesn't exist.
                 continue;
             }
@@ -239,16 +239,16 @@ 
                 switch ($api_key) {
                     case Domain::META_KEY_ACCESS_TOKEN:
                     case Domain::META_KEY_PARTNER_MERCHANT_ID:
-                        $paypal_data[ $api_key ] = PayPalExtraMetaManager::encryptString(
-                            $response[ $api_key ],
+                        $paypal_data[$api_key] = PayPalExtraMetaManager::encryptString(
+                            $response[$api_key],
                             $paypal_pm
                         );
                         break;
                     case Domain::META_KEY_TOKEN_EXPIRES_IN:
-                        $paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
+                        $paypal_data[$api_key] = time() + (int) sanitize_key($response[$api_key]);
                         break;
                     default:
-                        $paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
+                        $paypal_data[$api_key] = sanitize_text_field($response[$api_key]);
                 }
             } catch (Exception $e) {
                 PayPalLogger::errorLog(
@@ -277,11 +277,11 @@ 
         $api_credentials     = [];
         $expected_parameters = [Domain::META_KEY_SELLER_MERCHANT_ID];
         foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
+            if ( ! isset($response[$api_key])) {
                 // Don't want to try saving data that doesn't exist.
                 continue;
             }
-            $api_credentials[ $api_key ] = $response[ $api_key ];
+            $api_credentials[$api_key] = $response[$api_key];
         }
         return PayPalExtraMetaManager::savePmOptions($paypal_pm, $api_credentials);
     }
@@ -301,10 +301,10 @@ 
     {
         $allowed_checkout_type = 'express_checkout';
         // Did the merchant onboard with PPCP enabled or no.
-        if (! empty($get_params['selected_payment']) && $get_params['selected_payment'] === 'PPCP') {
+        if ( ! empty($get_params['selected_payment']) && $get_params['selected_payment'] === 'PPCP') {
             // Make sure that merchant's account really supports advanced card fields (included in the PPCP scope).
             // Has to include "PPCP_CUSTOM" product for ACDC support. "EXPRESS_CHECKOUT" otherwise.
-            if (! empty($data['response']['products'][0]['name'])) {
+            if ( ! empty($data['response']['products'][0]['name'])) {
                 foreach ($data['response']['products'] as $product) {
                     if ($product['name'] === 'PPCP_CUSTOM') {
                         // This merchant has PPCP in the products list, so we can enable both (all supported) checkout types.
@@ -316,18 +316,18 @@ 
         }
         // Set the PM option Checkout type, just in case merchant doesn't save PM options manually.
         $checkout_type_setting = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
-        if (! $checkout_type_setting || $checkout_type_setting !== $allowed_checkout_type) {
+        if ( ! $checkout_type_setting || $checkout_type_setting !== $allowed_checkout_type) {
             $paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
         }
         // Save the scopes that were authorized.
-        if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
+        if ( ! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
             $scopes = [];
             foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
                 // Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
                 $split       = explode('/', $scope);
                 $split_count = count($split);
                 // Get the scope itself.
-                $scopes[] = $split[ $split_count - 1 ];
+                $scopes[] = $split[$split_count - 1];
             }
             if (empty($scopes)) {
                 // In case the there's a change in how scopes come in just save the list.
@@ -354,7 +354,7 @@ 
     public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
     {
         // We sure we are getting something ?
-        if (! $text) {
+        if ( ! $text) {
             return $text;
         }
 
@@ -386,7 +386,7 @@ 
     public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
     {
         // Are we even getting something ?
-        if (! $text) {
+        if ( ! $text) {
             return $text;
         }
         // Try decrypting.

admin_pages/registration_form/Registration_Form_Admin_Page.core.php

Indentation +744 added lines, -744 removed lines

@@ -17,695 +17,695 @@ 
  */
 class Registration_Form_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * holds the specific question object for the question details screen
-     */
-    protected ?EE_Question $_question = null;
-
-    /**
-     * holds the specific question group object for the question group details screen
-     */
-    protected ?EE_Question_Group $_question_group = null;
-
-    protected EEM_Question $_question_model;
-
-    protected EEM_Question_Group $_question_group_model;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
-        $this->_question_model       = EEM_Question::instance();
-        $this->_question_group_model = EEM_Question_Group::instance();
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REGISTRATION_FORM_PG_SLUG;
-        $this->page_label       = esc_html__('Registration Form', 'event_espresso');
-        $this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
-        $this->_admin_base_path = REGISTRATION_FORM_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
-        $this->_labels           = [
-            'buttons'    => [
-                'edit_question' => esc_html__('Edit Question', 'event_espresso'),
-            ],
-            'publishbox' => [
-                'edit_question' => esc_html__('Edit Question', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     *_set_page_routes
-     */
-    protected function _set_page_routes()
-    {
-        $qst_id             =
-            ! empty($this->_req_data['QST_ID'])
-                ? $this->_req_data['QST_ID']
-                : 0;
-        $this->_page_routes = [
-            'default' => [
-                'func'       => [$this, '_questions_overview_list_table'],
-                'capability' => 'ee_read_questions',
-            ],
-
-            'edit_question' => [
-                'func'       => [$this, '_edit_question'],
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'args'       => ['edit'],
-            ],
-
-            'question_groups' => [
-                'func'       => [$this, '_questions_groups_preview'],
-                'capability' => 'ee_read_question_groups',
-            ],
-
-            'update_question' => [
-                'func'       => [$this, '_insert_or_update_question'],
-                'args'       => ['new_question' => false],
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default' => [
-                'nav'           => [
-                    'label' => esc_html__('Questions', 'event_espresso'),
-                    'icon'  => 'dashicons-editor-help',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'registration_form_questions_overview_help_tab'                           => [
-                        'title'    => esc_html__('Questions Overview', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview',
-                    ],
-                    'registration_form_questions_overview_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_table_column_headings',
-                    ],
-                    'registration_form_questions_overview_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-
-            'question_groups' => [
-                'nav'           => [
-                    'label' => esc_html__('Question Groups', 'event_espresso'),
-                    'icon'  => 'dashicons-forms',
-                    'order' => 20,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'registration_form_question_groups_help_tab' => [
-                        'title'    => esc_html__('Question Groups', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-
-            'edit_question' => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Question', 'event_espresso'),
-                    'icon'       => 'dashicons-edit-large',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['question_id'])
-                        ? add_query_arg(
-                            ['question_id' => $this->_req_data['question_id']],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'registration_form_edit_question_group_help_tab' => [
-                        'title'    => esc_html__('Edit Question', 'event_espresso'),
-                        'filename' => 'registration_form_edit_question',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Questions', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_screen_options_question_groups()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Categories
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
-            [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_registration');
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-    }
-
-
-    public function load_scripts_styles_add_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-
-    public function load_scripts_styles_edit_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-
-    /**
-     * Loads the JS required for adding or editing a question
-     */
-    protected function load_scripts_styles_question_details()
-    {
-        $this->load_scripts_styles_forms();
-        wp_register_script(
-            'espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
-            ['jquery-ui-sortable'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_registration_form_single');
-        wp_localize_script(
-            'espresso_registration_form_single',
-            'ee_question_data',
-            [
-                'question_types_with_max'    => $this->_question_model->questionTypesWithMaxLength(),
-                'question_type_with_options' => $this->_question_model->question_types_with_options(),
-            ]
-        );
-    }
-
-
-    public function recaptcha_info_help_tab()
-    {
-        EEH_Template::display_template(REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php');
-    }
-
-
-    public function load_scripts_styles_forms()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'  => 'all',
-                'label' => esc_html__('View All Questions', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-
-        if (
-            $this->capabilities->current_user_can(
-                'ee_delete_questions',
-                'espresso_registration_form_trash_questions'
-            )
-        ) {
-            $this->_views['trash'] = [
-                'slug'  => 'trash',
-                'label' => esc_html__('Trash', 'event_espresso'),
-                'count' => 0,
-            ];
-        }
-    }
-
-
-    /**
-     * This just previews the question groups tab that comes in caffeinated.
-     *
-     * @return void html
-     * @throws EE_Error
-     */
-    protected function _questions_groups_preview()
-    {
-        $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  =
-            '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
-            . esc_attr__(
-                'Preview Question Groups Overview List Table screenshot',
-                'event_espresso'
-            ) . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-            . esc_html__(
-                'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
-                'event_espresso'
-            ) . '</strong>';
-        $this->display_admin_caf_preview_page('question_groups_tab');
-    }
-
-
-    /**
-     * Extracts the question field's values from the POST request to update or insert them
-     *
-     * @param EEM_Base $model
-     * @return array where each key is the name of a model's field/db column, and each value is its value.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_column_values_for(EEM_Base $model): array
-    {
-        $column_values = [];
-        // some initial checks for proper values.
-        $QST_ID = $this->request->getRequestParam('QST_ID', 0, DataType::INT);
-        // if QST_admin_only, then no matter what QST_required is we disable.
-        $QST_admin_only = $this->request->getRequestParam('QST_admin_only', false, DataType::BOOL);
-        if ($QST_admin_only) {
-            $this->request->setRequestParam('QST_required', false);
-        }
-        // if the question shouldn't have a max length, don't let them set one
-        if (
-            ! (
-                $this->request->requestParamIsSet('QST_type')
-                && $this->request->requestParamIsSet('QST_max')
-            ) || ! in_array(
-                $this->request->getRequestParam('QST_type', '', DataType::STRING),
-                $this->_question_model->questionTypesWithMaxLength(),
-                true
-            )
-        ) {
-            // they're not allowed to set the max
-            $this->request->unSetRequestParam('QST_max', true);
-        }
-        foreach ($model->field_settings() as $fieldName => $settings) {
-            switch($fieldName) {
-                case 'QSG_identifier':
-                    // basically if QSG_identifier is empty or not set
-                    if (! $this->request->getRequestParam('QSG_identifier', '', DataType::STRING)) {
-                        $QSG_name                    = $this->request->getRequestParam('QSG_name', '', DataType::STRING);
-                        $column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
-                    }
-                    break;
-
-                case 'QST_admin_label':
-                    if (! $this->request->getRequestParam('QST_admin_label', '', DataType::STRING)) {
-                        // the admin label is blank, use a slug version of the question text
-                        $QST_text                    = $this->request->getRequestParam('QST_display_text', '', DataType::STRING);
-                        $column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
-                    } else {
-                        // admin label set, use it
-                        $column_values[ $fieldName ] = $this->request->getRequestParam('QST_admin_label', '', DataType::STRING);
-                    }
-                    break;
-
-                case 'QST_admin_only':
-                    if (! $QST_admin_only) {
-                        $column_values[ $fieldName ] = false;
-                    }
-                    break;
-
-                case 'QST_max':
-                    $qst_system = $this->_question_model->get_var(
-                        [ [ 'QST_ID' => $QST_ID ] ],
-                        'QST_system'
-                    );
-
-                    $max_max = $this->_question_model->absolute_max_for_system_question((string) $qst_system);
-                    $QST_max = $this->request->getRequestParam('QST_max', 0, DataType::INT);
-                    if ($QST_max === 0 || $QST_max > $max_max) {
-                        $column_values[ $fieldName ] = $max_max;
-                    }
-                    break;
-
-                default:
-                    // only add a property to the array if it's not null (otherwise the model should just use the default value)
-                    if ($this->request->requestParamIsSet($fieldName)) {
-                        // convert the schema type to the appropriate data type
-                        $schema_type = DataType::convertModelFieldSchemaType($settings->getSchemaType());
-                        $column_values[ $fieldName ] = $this->request->getRequestParam($fieldName, null, $schema_type);
-                    }
-            }
-        }
-        // validation for this data to be performed by the model before insertion.
-        return $column_values;
-    }
-
-
-    /**
-     *_questions_overview_list_table
-     *
-     * @throws EE_Error
-     */
-    protected function _questions_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Questions', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * _edit_question
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _edit_question()
-    {
-        $ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID'])
-            ? absint($this->_req_data['QST_ID'])
-            : false;
-
-        switch ($this->_req_action) {
-            case 'add_question':
-                $this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
-                break;
-            case 'edit_question':
-                $this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
-                break;
-            default:
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-
-        // add PRC_ID to title if editing
-        $this->_admin_page_title =
-            $ID
-                ? $this->_admin_page_title . ' # ' . $ID
-                : $this->_admin_page_title;
-        if ($ID) {
-            $question                 = $this->_question_model->get_one_by_ID($ID);
-            $additional_hidden_fields = ['QST_ID' => ['type' => 'hidden', 'value' => $ID]];
-            $this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
-        } else {
-            $question = EE_Question::new_instance();
-            $question->set_order_to_latest();
-            $this->_set_add_edit_form_tags('insert_question');
-        }
-        if ($question->system_ID() === EEM_Attendee::system_question_phone) {
-            $question_types = array_intersect_key(
-                $this->_question_model->allowed_question_types(),
-                array_flip(
-                    [
-                        EEM_Question::QST_type_text,
-                        EEM_Question::QST_type_us_phone,
-                    ]
-                )
-            );
-        } else {
-            $question_types = $question->has_answers()
-                ? $this->_question_model->question_types_in_same_category($question->type())
-                : $this->_question_model->allowed_question_types();
-        }
-        $this->_template_args['QST_ID']                     = $ID;
-        $this->_template_args['question']                   = $question;
-        $this->_template_args['question_types']             = $question_types;
-        $this->_template_args['max_max']                    =
-            $this->_question_model->absolute_max_for_system_question(
-                $question->system_ID()
-            );
-        $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
-        $this->_set_publish_post_box_vars('id', $ID);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_type_descriptions(): string
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        $descriptions               = '';
-        $question_type_descriptions = $this->_question_model->question_descriptions();
-        foreach ($question_type_descriptions as $type => $question_type_description) {
-            if ($type == 'HTML_TEXTAREA') {
-                $html                      = new EE_Simple_HTML_Validation_Strategy();
-                $question_type_description .= sprintf(
-                    esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
-                    '<br/>',
-                    $html->get_list_of_allowed_tags()
-                );
-            }
-            $descriptions .= EEH_HTML::p(
-                $question_type_description,
-                'question_type_description-' . $type,
-                'question_type_description description',
-                'display:none;'
-            );
-        }
-        return $descriptions;
-    }
-
-
-    /**
-     * @param bool $new_question
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_question(bool $new_question = true)
-    {
-        $set_column_values = $this->_set_column_values_for($this->_question_model);
-        if ($new_question) {
-            $question    = EE_Question::new_instance($set_column_values);
-            $action_desc = 'added';
-        } else {
-            $question = $this->_question_model->get_one_by_ID(
-                $this->request->getRequestParam('QST_ID', 0, DataType::INT)
-            );
-            foreach ($set_column_values as $field => $new_value) {
-                $question->set($field, $new_value);
-            }
-            $action_desc = 'updated';
-        }
-        $success = $question->save();
-        $ID      = $question->ID();
-        if ($ID && $question->should_have_question_options()) {
-            // save the related options
-            // trash removed options, save old ones
-            // get list of all options
-            $options          = $question->options();
-            $question_options = $this->request->getRequestParam('question_options', [], DataType::ARRAY);
-            $QSO_default      = $this->request->getRequestParam('QSO_default', null, DataType::INT);
-            if (! empty($options)) {
-                foreach ($options as $option_ID => $option) {
-                    $option_req_index = $this->_get_option_req_data_index($option_ID);
-                    if ($option_req_index !== false) {
-                        $question_options[ $option_req_index ]['QSO_default'] = $option_req_index === $QSO_default;
-                        $option->save($question_options[ $option_req_index ]);
-                    } else {
-                        // not found, remove it
-                        $option->delete();
-                    }
-                }
-            }
-            // save new related options
-            foreach ($question_options as $index => $option_req_data) {
-                // skip $index that is from our sample
-                if ($index === 'xxcountxx') {
-                    continue;
-                }
-                // note we allow saving blank options.
-                if (empty($option_req_data['QSO_ID'])) {
-                    // no ID! save it!
-                    $new_option = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value'   => $option_req_data['QSO_value'],
-                            'QSO_desc'    => $option_req_data['QSO_desc'],
-                            'QSO_default' => $index === $QSO_default,
-                            'QSO_order'   => $option_req_data['QSO_order'],
-                            'QST_ID'      => $question->ID(),
-                        ]
-                    );
-                    $new_option->save();
-                }
-            }
-        }
-
-        $success = apply_filters(
-            'FHEE__Registration_Form_Admin_Page___insert_or_update_question__success',
-            (int) $success,
-            $question,
-            $this
-        );
-
-        $query_args = ['action' => 'edit_question', 'QST_ID' => $ID];
-        if ($success !== 0) {
-            $msg = $new_question
-                ? sprintf(
-                    esc_html__('The %s has been created', 'event_espresso'),
-                    $this->_question_model->item_name()
-                )
-                : sprintf(
-                    esc_html__('The %s has been updated', 'event_espresso'),
-                    $this->_question_model->item_name()
-                );
-            EE_Error::add_success($msg);
-        }
-
-        $this->_redirect_after_action(false, '', $action_desc, $query_args, true);
-    }
-
-
-    /**
-     * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
-     * by ID
-     * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
-     * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
-     *
-     * @param int $ID of the question option to find
-     * @return int index in question_options array if successful, FALSE if unsuccessful
-     */
-    protected function _get_option_req_data_index(int $ID)
-    {
-        $req_data_for_question_options = $this->_req_data['question_options'];
-        foreach ($req_data_for_question_options as $num => $option_data) {
-            if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
-                return $num;
-            }
-        }
-        return false;
-    }
-
-
-
-
-    /* QUERIES */
-    /**
-     * For internal use in getting all the query parameters
-     * (because it's pretty well the same between question, question groups,
-     * and for both when searching for trashed and untrashed ones)
-     *
-     * @param EEM_Base $model either EEM_Question or EEM_Question_Group
-     * @param int      $per_page
-     * @param int      $current_page
-     * @return array model query params,
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function get_query_params(EEM_Base $model, int $per_page = 10, int $current_page = 10): array
-    {
-        $query_params             = [];
-        $offset                   = ($current_page - 1) * $per_page;
-        $query_params['limit']    = [$offset, $per_page];
-
-        $order  = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-            ? $this->_req_data['order']
-            : 'ASC';
-
-        $orderby_field = $model instanceof EEM_Question ? 'QST_ID' : 'QSG_order';
-
-        $field_to_order_by = empty($this->_req_data['orderby']) ? $orderby_field : $this->_req_data['orderby'];
-
-        $query_params['order_by'] = [$field_to_order_by => $order];
-
-        $search_string = array_key_exists('s', $this->_req_data) ? $this->_req_data['s'] : null;
-        if (! empty($search_string)) {
-            if ($model instanceof EEM_Question_Group) {
-                $query_params[0] = [
-                    'OR' => [
-                        'QSG_name' => ['LIKE', "%$search_string%"],
-                        'QSG_desc' => ['LIKE', "%$search_string%"],
-                    ],
-                ];
-            } else {
-                $query_params[0] = [
-                    'QST_display_text' => ['LIKE', "%$search_string%"],
-                ];
-            }
-        }
-
-        // capability checks (just leaving this commented out for reference because
-        // it illustrates some complicated query params that could be useful when fully implemented)
-        /*if ( $model instanceof EEM_Question_Group ) {
+	/**
+	 * holds the specific question object for the question details screen
+	 */
+	protected ?EE_Question $_question = null;
+
+	/**
+	 * holds the specific question group object for the question group details screen
+	 */
+	protected ?EE_Question_Group $_question_group = null;
+
+	protected EEM_Question $_question_model;
+
+	protected EEM_Question_Group $_question_group_model;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		require_once(EE_MODELS . 'EEM_Question.model.php');
+		require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+		$this->_question_model       = EEM_Question::instance();
+		$this->_question_group_model = EEM_Question_Group::instance();
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REGISTRATION_FORM_PG_SLUG;
+		$this->page_label       = esc_html__('Registration Form', 'event_espresso');
+		$this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
+		$this->_admin_base_path = REGISTRATION_FORM_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
+		$this->_labels           = [
+			'buttons'    => [
+				'edit_question' => esc_html__('Edit Question', 'event_espresso'),
+			],
+			'publishbox' => [
+				'edit_question' => esc_html__('Edit Question', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 *_set_page_routes
+	 */
+	protected function _set_page_routes()
+	{
+		$qst_id             =
+			! empty($this->_req_data['QST_ID'])
+				? $this->_req_data['QST_ID']
+				: 0;
+		$this->_page_routes = [
+			'default' => [
+				'func'       => [$this, '_questions_overview_list_table'],
+				'capability' => 'ee_read_questions',
+			],
+
+			'edit_question' => [
+				'func'       => [$this, '_edit_question'],
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'args'       => ['edit'],
+			],
+
+			'question_groups' => [
+				'func'       => [$this, '_questions_groups_preview'],
+				'capability' => 'ee_read_question_groups',
+			],
+
+			'update_question' => [
+				'func'       => [$this, '_insert_or_update_question'],
+				'args'       => ['new_question' => false],
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default' => [
+				'nav'           => [
+					'label' => esc_html__('Questions', 'event_espresso'),
+					'icon'  => 'dashicons-editor-help',
+					'order' => 10,
+				],
+				'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'registration_form_questions_overview_help_tab'                           => [
+						'title'    => esc_html__('Questions Overview', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview',
+					],
+					'registration_form_questions_overview_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_table_column_headings',
+					],
+					'registration_form_questions_overview_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
+					],
+				],
+				'require_nonce' => false,
+			],
+
+			'question_groups' => [
+				'nav'           => [
+					'label' => esc_html__('Question Groups', 'event_espresso'),
+					'icon'  => 'dashicons-forms',
+					'order' => 20,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'registration_form_question_groups_help_tab' => [
+						'title'    => esc_html__('Question Groups', 'event_espresso'),
+						'filename' => 'registration_form_question_groups',
+					],
+				],
+				'require_nonce' => false,
+			],
+
+			'edit_question' => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Question', 'event_espresso'),
+					'icon'       => 'dashicons-edit-large',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['question_id'])
+						? add_query_arg(
+							['question_id' => $this->_req_data['question_id']],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'registration_form_edit_question_group_help_tab' => [
+						'title'    => esc_html__('Edit Question', 'event_espresso'),
+						'filename' => 'registration_form_edit_question',
+					],
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Questions', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_screen_options_question_groups()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Categories
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_registration',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
+			[EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_registration');
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+	}
+
+
+	public function load_scripts_styles_add_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+
+	public function load_scripts_styles_edit_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+
+	/**
+	 * Loads the JS required for adding or editing a question
+	 */
+	protected function load_scripts_styles_question_details()
+	{
+		$this->load_scripts_styles_forms();
+		wp_register_script(
+			'espresso_registration_form_single',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
+			['jquery-ui-sortable'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_registration_form_single');
+		wp_localize_script(
+			'espresso_registration_form_single',
+			'ee_question_data',
+			[
+				'question_types_with_max'    => $this->_question_model->questionTypesWithMaxLength(),
+				'question_type_with_options' => $this->_question_model->question_types_with_options(),
+			]
+		);
+	}
+
+
+	public function recaptcha_info_help_tab()
+	{
+		EEH_Template::display_template(REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php');
+	}
+
+
+	public function load_scripts_styles_forms()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'  => 'all',
+				'label' => esc_html__('View All Questions', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+
+		if (
+			$this->capabilities->current_user_can(
+				'ee_delete_questions',
+				'espresso_registration_form_trash_questions'
+			)
+		) {
+			$this->_views['trash'] = [
+				'slug'  => 'trash',
+				'label' => esc_html__('Trash', 'event_espresso'),
+				'count' => 0,
+			];
+		}
+	}
+
+
+	/**
+	 * This just previews the question groups tab that comes in caffeinated.
+	 *
+	 * @return void html
+	 * @throws EE_Error
+	 */
+	protected function _questions_groups_preview()
+	{
+		$this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  =
+			'<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
+			. esc_attr__(
+				'Preview Question Groups Overview List Table screenshot',
+				'event_espresso'
+			) . '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+			. esc_html__(
+				'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
+				'event_espresso'
+			) . '</strong>';
+		$this->display_admin_caf_preview_page('question_groups_tab');
+	}
+
+
+	/**
+	 * Extracts the question field's values from the POST request to update or insert them
+	 *
+	 * @param EEM_Base $model
+	 * @return array where each key is the name of a model's field/db column, and each value is its value.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_column_values_for(EEM_Base $model): array
+	{
+		$column_values = [];
+		// some initial checks for proper values.
+		$QST_ID = $this->request->getRequestParam('QST_ID', 0, DataType::INT);
+		// if QST_admin_only, then no matter what QST_required is we disable.
+		$QST_admin_only = $this->request->getRequestParam('QST_admin_only', false, DataType::BOOL);
+		if ($QST_admin_only) {
+			$this->request->setRequestParam('QST_required', false);
+		}
+		// if the question shouldn't have a max length, don't let them set one
+		if (
+			! (
+				$this->request->requestParamIsSet('QST_type')
+				&& $this->request->requestParamIsSet('QST_max')
+			) || ! in_array(
+				$this->request->getRequestParam('QST_type', '', DataType::STRING),
+				$this->_question_model->questionTypesWithMaxLength(),
+				true
+			)
+		) {
+			// they're not allowed to set the max
+			$this->request->unSetRequestParam('QST_max', true);
+		}
+		foreach ($model->field_settings() as $fieldName => $settings) {
+			switch($fieldName) {
+				case 'QSG_identifier':
+					// basically if QSG_identifier is empty or not set
+					if (! $this->request->getRequestParam('QSG_identifier', '', DataType::STRING)) {
+						$QSG_name                    = $this->request->getRequestParam('QSG_name', '', DataType::STRING);
+						$column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+					}
+					break;
+
+				case 'QST_admin_label':
+					if (! $this->request->getRequestParam('QST_admin_label', '', DataType::STRING)) {
+						// the admin label is blank, use a slug version of the question text
+						$QST_text                    = $this->request->getRequestParam('QST_display_text', '', DataType::STRING);
+						$column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
+					} else {
+						// admin label set, use it
+						$column_values[ $fieldName ] = $this->request->getRequestParam('QST_admin_label', '', DataType::STRING);
+					}
+					break;
+
+				case 'QST_admin_only':
+					if (! $QST_admin_only) {
+						$column_values[ $fieldName ] = false;
+					}
+					break;
+
+				case 'QST_max':
+					$qst_system = $this->_question_model->get_var(
+						[ [ 'QST_ID' => $QST_ID ] ],
+						'QST_system'
+					);
+
+					$max_max = $this->_question_model->absolute_max_for_system_question((string) $qst_system);
+					$QST_max = $this->request->getRequestParam('QST_max', 0, DataType::INT);
+					if ($QST_max === 0 || $QST_max > $max_max) {
+						$column_values[ $fieldName ] = $max_max;
+					}
+					break;
+
+				default:
+					// only add a property to the array if it's not null (otherwise the model should just use the default value)
+					if ($this->request->requestParamIsSet($fieldName)) {
+						// convert the schema type to the appropriate data type
+						$schema_type = DataType::convertModelFieldSchemaType($settings->getSchemaType());
+						$column_values[ $fieldName ] = $this->request->getRequestParam($fieldName, null, $schema_type);
+					}
+			}
+		}
+		// validation for this data to be performed by the model before insertion.
+		return $column_values;
+	}
+
+
+	/**
+	 *_questions_overview_list_table
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _questions_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Questions', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * _edit_question
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _edit_question()
+	{
+		$ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID'])
+			? absint($this->_req_data['QST_ID'])
+			: false;
+
+		switch ($this->_req_action) {
+			case 'add_question':
+				$this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
+				break;
+			case 'edit_question':
+				$this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
+				break;
+			default:
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+
+		// add PRC_ID to title if editing
+		$this->_admin_page_title =
+			$ID
+				? $this->_admin_page_title . ' # ' . $ID
+				: $this->_admin_page_title;
+		if ($ID) {
+			$question                 = $this->_question_model->get_one_by_ID($ID);
+			$additional_hidden_fields = ['QST_ID' => ['type' => 'hidden', 'value' => $ID]];
+			$this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
+		} else {
+			$question = EE_Question::new_instance();
+			$question->set_order_to_latest();
+			$this->_set_add_edit_form_tags('insert_question');
+		}
+		if ($question->system_ID() === EEM_Attendee::system_question_phone) {
+			$question_types = array_intersect_key(
+				$this->_question_model->allowed_question_types(),
+				array_flip(
+					[
+						EEM_Question::QST_type_text,
+						EEM_Question::QST_type_us_phone,
+					]
+				)
+			);
+		} else {
+			$question_types = $question->has_answers()
+				? $this->_question_model->question_types_in_same_category($question->type())
+				: $this->_question_model->allowed_question_types();
+		}
+		$this->_template_args['QST_ID']                     = $ID;
+		$this->_template_args['question']                   = $question;
+		$this->_template_args['question_types']             = $question_types;
+		$this->_template_args['max_max']                    =
+			$this->_question_model->absolute_max_for_system_question(
+				$question->system_ID()
+			);
+		$this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
+		$this->_set_publish_post_box_vars('id', $ID);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_type_descriptions(): string
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		$descriptions               = '';
+		$question_type_descriptions = $this->_question_model->question_descriptions();
+		foreach ($question_type_descriptions as $type => $question_type_description) {
+			if ($type == 'HTML_TEXTAREA') {
+				$html                      = new EE_Simple_HTML_Validation_Strategy();
+				$question_type_description .= sprintf(
+					esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
+					'<br/>',
+					$html->get_list_of_allowed_tags()
+				);
+			}
+			$descriptions .= EEH_HTML::p(
+				$question_type_description,
+				'question_type_description-' . $type,
+				'question_type_description description',
+				'display:none;'
+			);
+		}
+		return $descriptions;
+	}
+
+
+	/**
+	 * @param bool $new_question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_question(bool $new_question = true)
+	{
+		$set_column_values = $this->_set_column_values_for($this->_question_model);
+		if ($new_question) {
+			$question    = EE_Question::new_instance($set_column_values);
+			$action_desc = 'added';
+		} else {
+			$question = $this->_question_model->get_one_by_ID(
+				$this->request->getRequestParam('QST_ID', 0, DataType::INT)
+			);
+			foreach ($set_column_values as $field => $new_value) {
+				$question->set($field, $new_value);
+			}
+			$action_desc = 'updated';
+		}
+		$success = $question->save();
+		$ID      = $question->ID();
+		if ($ID && $question->should_have_question_options()) {
+			// save the related options
+			// trash removed options, save old ones
+			// get list of all options
+			$options          = $question->options();
+			$question_options = $this->request->getRequestParam('question_options', [], DataType::ARRAY);
+			$QSO_default      = $this->request->getRequestParam('QSO_default', null, DataType::INT);
+			if (! empty($options)) {
+				foreach ($options as $option_ID => $option) {
+					$option_req_index = $this->_get_option_req_data_index($option_ID);
+					if ($option_req_index !== false) {
+						$question_options[ $option_req_index ]['QSO_default'] = $option_req_index === $QSO_default;
+						$option->save($question_options[ $option_req_index ]);
+					} else {
+						// not found, remove it
+						$option->delete();
+					}
+				}
+			}
+			// save new related options
+			foreach ($question_options as $index => $option_req_data) {
+				// skip $index that is from our sample
+				if ($index === 'xxcountxx') {
+					continue;
+				}
+				// note we allow saving blank options.
+				if (empty($option_req_data['QSO_ID'])) {
+					// no ID! save it!
+					$new_option = EE_Question_Option::new_instance(
+						[
+							'QSO_value'   => $option_req_data['QSO_value'],
+							'QSO_desc'    => $option_req_data['QSO_desc'],
+							'QSO_default' => $index === $QSO_default,
+							'QSO_order'   => $option_req_data['QSO_order'],
+							'QST_ID'      => $question->ID(),
+						]
+					);
+					$new_option->save();
+				}
+			}
+		}
+
+		$success = apply_filters(
+			'FHEE__Registration_Form_Admin_Page___insert_or_update_question__success',
+			(int) $success,
+			$question,
+			$this
+		);
+
+		$query_args = ['action' => 'edit_question', 'QST_ID' => $ID];
+		if ($success !== 0) {
+			$msg = $new_question
+				? sprintf(
+					esc_html__('The %s has been created', 'event_espresso'),
+					$this->_question_model->item_name()
+				)
+				: sprintf(
+					esc_html__('The %s has been updated', 'event_espresso'),
+					$this->_question_model->item_name()
+				);
+			EE_Error::add_success($msg);
+		}
+
+		$this->_redirect_after_action(false, '', $action_desc, $query_args, true);
+	}
+
+
+	/**
+	 * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
+	 * by ID
+	 * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
+	 * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
+	 *
+	 * @param int $ID of the question option to find
+	 * @return int index in question_options array if successful, FALSE if unsuccessful
+	 */
+	protected function _get_option_req_data_index(int $ID)
+	{
+		$req_data_for_question_options = $this->_req_data['question_options'];
+		foreach ($req_data_for_question_options as $num => $option_data) {
+			if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
+				return $num;
+			}
+		}
+		return false;
+	}
+
+
+
+
+	/* QUERIES */
+	/**
+	 * For internal use in getting all the query parameters
+	 * (because it's pretty well the same between question, question groups,
+	 * and for both when searching for trashed and untrashed ones)
+	 *
+	 * @param EEM_Base $model either EEM_Question or EEM_Question_Group
+	 * @param int      $per_page
+	 * @param int      $current_page
+	 * @return array model query params,
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function get_query_params(EEM_Base $model, int $per_page = 10, int $current_page = 10): array
+	{
+		$query_params             = [];
+		$offset                   = ($current_page - 1) * $per_page;
+		$query_params['limit']    = [$offset, $per_page];
+
+		$order  = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+			? $this->_req_data['order']
+			: 'ASC';
+
+		$orderby_field = $model instanceof EEM_Question ? 'QST_ID' : 'QSG_order';
+
+		$field_to_order_by = empty($this->_req_data['orderby']) ? $orderby_field : $this->_req_data['orderby'];
+
+		$query_params['order_by'] = [$field_to_order_by => $order];
+
+		$search_string = array_key_exists('s', $this->_req_data) ? $this->_req_data['s'] : null;
+		if (! empty($search_string)) {
+			if ($model instanceof EEM_Question_Group) {
+				$query_params[0] = [
+					'OR' => [
+						'QSG_name' => ['LIKE', "%$search_string%"],
+						'QSG_desc' => ['LIKE', "%$search_string%"],
+					],
+				];
+			} else {
+				$query_params[0] = [
+					'QST_display_text' => ['LIKE', "%$search_string%"],
+				];
+			}
+		}
+
+		// capability checks (just leaving this commented out for reference because
+		// it illustrates some complicated query params that could be useful when fully implemented)
+		/*if ( $model instanceof EEM_Question_Group ) {
             if (
                 ! $this->capabilities->current_user_can(
                     'edit_others_question_groups',
@@ -745,59 +745,59 @@ 
             }
         }/**/
 
-        return $query_params;
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Question[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_questions(int $per_page = 10, int $current_page = 1, bool $count = false)
-    {
-        $query_params = $this->get_query_params($this->_question_model, $per_page, $current_page);
-        if ($count) {
-            $where = isset($query_params[0]) ? [$query_params[0]] : [];
-            return $this->_question_model->count($where);
-        }
-        return $this->_question_model->get_all($query_params);
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     */
-    public function get_trashed_questions(int $per_page, int $current_page = 1, bool $count = false)
-    {
-        $query_params = $this->get_query_params($this->_question_model, $per_page, $current_page);
-        $where        = isset($query_params[0]) ? [$query_params[0]] : [];
-        return $count
-            ? $this->_question_model->count_deleted($where)
-            : $this->_question_model->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Question_Group[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_question_groups(int $per_page, int $current_page = 1, bool $count = false)
-    {
-        // note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-        return $this->_question_group_model->get_all(
-            $this->get_query_params($this->_question_group_model, $per_page, $current_page)
-        );
-    }
+		return $query_params;
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Question[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_questions(int $per_page = 10, int $current_page = 1, bool $count = false)
+	{
+		$query_params = $this->get_query_params($this->_question_model, $per_page, $current_page);
+		if ($count) {
+			$where = isset($query_params[0]) ? [$query_params[0]] : [];
+			return $this->_question_model->count($where);
+		}
+		return $this->_question_model->get_all($query_params);
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 */
+	public function get_trashed_questions(int $per_page, int $current_page = 1, bool $count = false)
+	{
+		$query_params = $this->get_query_params($this->_question_model, $per_page, $current_page);
+		$where        = isset($query_params[0]) ? [$query_params[0]] : [];
+		return $count
+			? $this->_question_model->count_deleted($where)
+			: $this->_question_model->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Question_Group[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_question_groups(int $per_page, int $current_page = 1, bool $count = false)
+	{
+		// note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+		return $this->_question_group_model->get_all(
+			$this->get_query_params($this->_question_group_model, $per_page, $current_page)
+		);
+	}
 }

Spacing +29 added lines, -29 removed lines

@@ -40,8 +40,8 @@ 
      */
     public function __construct($routing = true)
     {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+        require_once(EE_MODELS.'EEM_Question.model.php');
+        require_once(EE_MODELS.'EEM_Question_Group.model.php');
         $this->_question_model       = EEM_Question::instance();
         $this->_question_group_model = EEM_Question_Group::instance();
         parent::__construct($routing);
@@ -81,7 +81,7 @@ 
      */
     protected function _set_page_routes()
     {
-        $qst_id             =
+        $qst_id =
             ! empty($this->_req_data['QST_ID'])
                 ? $this->_req_data['QST_ID']
                 : 0;
@@ -218,7 +218,7 @@ 
     {
         wp_register_style(
             'espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
+            REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.css',
             [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
             EVENT_ESPRESSO_VERSION
         );
@@ -266,7 +266,7 @@ 
         $this->load_scripts_styles_forms();
         wp_register_script(
             'espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
+            REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.js',
             ['jquery-ui-sortable'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -285,7 +285,7 @@ 
 
     public function recaptcha_info_help_tab()
     {
-        EEH_Template::display_template(REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php');
+        EEH_Template::display_template(REGISTRATION_FORM_TEMPLATE_PATH.'recaptcha_info_help_tab.template.php');
     }
 
 
@@ -333,16 +333,16 @@ 
     {
         $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
         $this->_template_args['preview_img']  =
-            '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
+            '<img src="'.REGISTRATION_FORM_ASSETS_URL.'caf_reg_form_preview.jpg" alt="'
             . esc_attr__(
                 'Preview Question Groups Overview List Table screenshot',
                 'event_espresso'
-            ) . '" />';
+            ).'" />';
         $this->_template_args['preview_text'] = '<strong>'
             . esc_html__(
                 'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
                 'event_espresso'
-            ) . '</strong>';
+            ).'</strong>';
         $this->display_admin_caf_preview_page('question_groups_tab');
     }
 
@@ -380,42 +380,42 @@ 
             $this->request->unSetRequestParam('QST_max', true);
         }
         foreach ($model->field_settings() as $fieldName => $settings) {
-            switch($fieldName) {
+            switch ($fieldName) {
                 case 'QSG_identifier':
                     // basically if QSG_identifier is empty or not set
-                    if (! $this->request->getRequestParam('QSG_identifier', '', DataType::STRING)) {
+                    if ( ! $this->request->getRequestParam('QSG_identifier', '', DataType::STRING)) {
                         $QSG_name                    = $this->request->getRequestParam('QSG_name', '', DataType::STRING);
-                        $column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+                        $column_values[$fieldName] = sanitize_title($QSG_name).'-'.uniqid('', true);
                     }
                     break;
 
                 case 'QST_admin_label':
-                    if (! $this->request->getRequestParam('QST_admin_label', '', DataType::STRING)) {
+                    if ( ! $this->request->getRequestParam('QST_admin_label', '', DataType::STRING)) {
                         // the admin label is blank, use a slug version of the question text
                         $QST_text                    = $this->request->getRequestParam('QST_display_text', '', DataType::STRING);
-                        $column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
+                        $column_values[$fieldName] = sanitize_title(wp_trim_words($QST_text, 10));
                     } else {
                         // admin label set, use it
-                        $column_values[ $fieldName ] = $this->request->getRequestParam('QST_admin_label', '', DataType::STRING);
+                        $column_values[$fieldName] = $this->request->getRequestParam('QST_admin_label', '', DataType::STRING);
                     }
                     break;
 
                 case 'QST_admin_only':
-                    if (! $QST_admin_only) {
-                        $column_values[ $fieldName ] = false;
+                    if ( ! $QST_admin_only) {
+                        $column_values[$fieldName] = false;
                     }
                     break;
 
                 case 'QST_max':
                     $qst_system = $this->_question_model->get_var(
-                        [ [ 'QST_ID' => $QST_ID ] ],
+                        [['QST_ID' => $QST_ID]],
                         'QST_system'
                     );
 
                     $max_max = $this->_question_model->absolute_max_for_system_question((string) $qst_system);
                     $QST_max = $this->request->getRequestParam('QST_max', 0, DataType::INT);
                     if ($QST_max === 0 || $QST_max > $max_max) {
-                        $column_values[ $fieldName ] = $max_max;
+                        $column_values[$fieldName] = $max_max;
                     }
                     break;
 
@@ -424,7 +424,7 @@ 
                     if ($this->request->requestParamIsSet($fieldName)) {
                         // convert the schema type to the appropriate data type
                         $schema_type = DataType::convertModelFieldSchemaType($settings->getSchemaType());
-                        $column_values[ $fieldName ] = $this->request->getRequestParam($fieldName, null, $schema_type);
+                        $column_values[$fieldName] = $this->request->getRequestParam($fieldName, null, $schema_type);
                     }
             }
         }
@@ -471,7 +471,7 @@ 
         // add PRC_ID to title if editing
         $this->_admin_page_title =
             $ID
-                ? $this->_admin_page_title . ' # ' . $ID
+                ? $this->_admin_page_title.' # '.$ID
                 : $this->_admin_page_title;
         if ($ID) {
             $question                 = $this->_question_model->get_one_by_ID($ID);
@@ -507,7 +507,7 @@ 
         $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
         $this->_set_publish_post_box_vars('id', $ID);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+            REGISTRATION_FORM_TEMPLATE_PATH.'questions_main_meta_box.template.php',
             $this->_template_args,
             true
         );
@@ -529,7 +529,7 @@ 
         $question_type_descriptions = $this->_question_model->question_descriptions();
         foreach ($question_type_descriptions as $type => $question_type_description) {
             if ($type == 'HTML_TEXTAREA') {
-                $html                      = new EE_Simple_HTML_Validation_Strategy();
+                $html = new EE_Simple_HTML_Validation_Strategy();
                 $question_type_description .= sprintf(
                     esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
                     '<br/>',
@@ -538,7 +538,7 @@ 
             }
             $descriptions .= EEH_HTML::p(
                 $question_type_description,
-                'question_type_description-' . $type,
+                'question_type_description-'.$type,
                 'question_type_description description',
                 'display:none;'
             );
@@ -576,12 +576,12 @@ 
             $options          = $question->options();
             $question_options = $this->request->getRequestParam('question_options', [], DataType::ARRAY);
             $QSO_default      = $this->request->getRequestParam('QSO_default', null, DataType::INT);
-            if (! empty($options)) {
+            if ( ! empty($options)) {
                 foreach ($options as $option_ID => $option) {
                     $option_req_index = $this->_get_option_req_data_index($option_ID);
                     if ($option_req_index !== false) {
-                        $question_options[ $option_req_index ]['QSO_default'] = $option_req_index === $QSO_default;
-                        $option->save($question_options[ $option_req_index ]);
+                        $question_options[$option_req_index]['QSO_default'] = $option_req_index === $QSO_default;
+                        $option->save($question_options[$option_req_index]);
                     } else {
                         // not found, remove it
                         $option->delete();
@@ -677,7 +677,7 @@ 
         $offset                   = ($current_page - 1) * $per_page;
         $query_params['limit']    = [$offset, $per_page];
 
-        $order  = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+        $order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
             ? $this->_req_data['order']
             : 'ASC';
 
@@ -688,7 +688,7 @@ 
         $query_params['order_by'] = [$field_to_order_by => $order];
 
         $search_string = array_key_exists('s', $this->_req_data) ? $this->_req_data['s'] : null;
-        if (! empty($search_string)) {
+        if ( ! empty($search_string)) {
             if ($model instanceof EEM_Question_Group) {
                 $query_params[0] = [
                     'OR' => [

core/EE_Error.core.php

Indentation +1138 added lines, -1138 removed lines

@@ -18,245 +18,245 @@ 
  */
 class EE_Error extends Exception
 {
-    const OPTIONS_KEY_NOTICES = 'ee_notices';
-
-    /**
-     *    stores details for all exception
-     *
-     * @var array
-     */
-    private static $_all_exceptions = [];
-
-    /**
-     *    tracks number of errors
-     *
-     * @var int
-     */
-    private static $_error_count = 0;
-
-    /**
-     * @var array $_espresso_notices
-     */
-    private static $_espresso_notices = ['success' => false, 'errors' => false, 'attention' => false];
-
-
-    /**
-     * @override default exception handling
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($message, $code = 0, Exception $previous = null)
-    {
-        if (version_compare(PHP_VERSION, '5.3.0', '<')) {
-            parent::__construct($message, $code);
-        } else {
-            parent::__construct($message, $code, $previous);
-        }
-    }
-
-
-    /**
-     *    error_handler
-     *
-     * @param int  $code
-     * @param string $message
-     * @param string $file
-     * @param int|string $line
-     * @return void
-     */
-    public static function error_handler(int $code, string $message, string $file, $line)
-    {
-        $type    = EE_Error::error_type($code);
-        $site    = site_url();
-        $to      = strpos($site, 'eventespresso.com')
-            ? 'developers@eventespresso.com'
-            : get_option('admin_email');
-        $subject = "$type $message in " . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
-        $msg     = EE_Error::_format_error($type, $message, $file, $line);
-        if (function_exists('wp_mail')) {
-            add_filter('wp_mail_content_type', ['EE_Error', 'set_content_type']);
-            wp_mail($to, $subject, $msg);
-        }
-        echo '<div id="message" class="espresso-notices error"><p>';
-        echo wp_kses($type . ': ' . $message . '<br />' . $file . ' line ' . $line, AllowedTags::getWithFormTags());
-        echo '<br /></p></div>';
-    }
-
-
-    /**
-     * error_type
-     * http://www.php.net/manual/en/errorfunc.constants.php#109430
-     *
-     * @param int $code
-     * @return string
-     */
-    public static function error_type(int $code): string
-    {
-        switch ($code) {
-            case E_ERROR: // 1 //
-                return 'E_ERROR';
-            case E_WARNING: // 2 //
-                return 'E_WARNING';
-            case E_PARSE: // 4 //
-                return 'E_PARSE';
-            case E_NOTICE: // 8 //
-                return 'E_NOTICE';
-            case E_CORE_ERROR: // 16 //
-                return 'E_CORE_ERROR';
-            case E_CORE_WARNING: // 32 //
-                return 'E_CORE_WARNING';
-            case E_COMPILE_ERROR: // 64 //
-                return 'E_COMPILE_ERROR';
-            case E_COMPILE_WARNING: // 128 //
-                return 'E_COMPILE_WARNING';
-            case E_USER_ERROR: // 256 //
-                return 'E_USER_ERROR';
-            case E_USER_WARNING: // 512 //
-                return 'E_USER_WARNING';
-            case E_USER_NOTICE: // 1024 //
-                return 'E_USER_NOTICE';
-            case E_STRICT: // 2048 //
-                return 'E_STRICT';
-            case E_RECOVERABLE_ERROR: // 4096 //
-                return 'E_RECOVERABLE_ERROR';
-            case E_DEPRECATED: // 8192 //
-                return 'E_DEPRECATED';
-            case E_USER_DEPRECATED: // 16384 //
-                return 'E_USER_DEPRECATED';
-            case E_ALL: // 16384 //
-                return 'E_ALL';
-        }
-        return '';
-    }
-
-
-    /**
-     *    fatal_error_handler
-     *
-     * @return void
-     */
-    public static function fatal_error_handler()
-    {
-        $last_error = error_get_last();
-        if ($last_error['type'] === E_ERROR) {
-            EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
-        }
-    }
-
-
-    /**
-     * _format_error
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return string
-     */
-    private static function _format_error($code, $message, $file, $line): string
-    {
-        $html =
-            "<table><thead><th>Item</th><th>Details</th></thead><tbody>";
-        $html .= "<tr><td><b>Code</b></td><td>$code</td></tr>";
-        $html .= "<tr><td><b>Error</b></td><td>$message</td></tr>";
-        $html .= "<tr><td><b>File</b></td><td>$file</td></tr>";
-        $html .= "<tr><td><b>Line</b></td><td>$line</td></tr>";
-        $html .= '</tbody></table>';
-        return $html;
-    }
-
-
-    /**
-     * set_content_type
-     *
-     * @param $content_type
-     * @return string
-     */
-    public static function set_content_type($content_type): string
-    {
-        return 'text/html';
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_error()
-    {
-        if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
-            throw $this;
-        }
-        // get separate user and developer messages if they exist
-        $msg      = explode('||', $this->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg  = $msg[1] ?? $msg[0];
-        $msg      = WP_DEBUG ? $dev_msg : $user_msg;
-        // add details to _all_exceptions array
-        $x_time                                     = time();
-        self::$_all_exceptions[ $x_time ]['name']   = get_class($this);
-        self::$_all_exceptions[ $x_time ]['file']   = $this->getFile();
-        self::$_all_exceptions[ $x_time ]['line']   = $this->getLine();
-        self::$_all_exceptions[ $x_time ]['msg']    = $msg;
-        self::$_all_exceptions[ $x_time ]['code']   = $this->getCode();
-        self::$_all_exceptions[ $x_time ]['trace']  = $this->getTrace();
-        self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
-        self::$_error_count++;
-        // add_action( 'shutdown', array( $this, 'display_errors' ));
-        $this->display_errors();
-    }
-
-
-    /**
-     * @param bool   $check_stored
-     * @param string $type_to_check
-     * @return bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    public static function has_error(bool $check_stored = false, string $type_to_check = 'errors'): bool
-    {
-        $has_error = isset(self::$_espresso_notices[ $type_to_check ])
-                     && ! empty(self::$_espresso_notices[ $type_to_check ]);
-        if ($check_stored && ! $has_error) {
-            $notices = EE_Error::getStoredNotices();
-            foreach ($notices as $type => $notice) {
-                if ($type === $type_to_check && $notice) {
-                    return true;
-                }
-            }
-        }
-        return $has_error;
-    }
-
-
-    /**
-     * @echo string
-     * @throws ReflectionException
-     */
-    public function display_errors()
-    {
-        $trace_details = '';
-        $output = '
+	const OPTIONS_KEY_NOTICES = 'ee_notices';
+
+	/**
+	 *    stores details for all exception
+	 *
+	 * @var array
+	 */
+	private static $_all_exceptions = [];
+
+	/**
+	 *    tracks number of errors
+	 *
+	 * @var int
+	 */
+	private static $_error_count = 0;
+
+	/**
+	 * @var array $_espresso_notices
+	 */
+	private static $_espresso_notices = ['success' => false, 'errors' => false, 'attention' => false];
+
+
+	/**
+	 * @override default exception handling
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($message, $code = 0, Exception $previous = null)
+	{
+		if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+			parent::__construct($message, $code);
+		} else {
+			parent::__construct($message, $code, $previous);
+		}
+	}
+
+
+	/**
+	 *    error_handler
+	 *
+	 * @param int  $code
+	 * @param string $message
+	 * @param string $file
+	 * @param int|string $line
+	 * @return void
+	 */
+	public static function error_handler(int $code, string $message, string $file, $line)
+	{
+		$type    = EE_Error::error_type($code);
+		$site    = site_url();
+		$to      = strpos($site, 'eventespresso.com')
+			? 'developers@eventespresso.com'
+			: get_option('admin_email');
+		$subject = "$type $message in " . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+		$msg     = EE_Error::_format_error($type, $message, $file, $line);
+		if (function_exists('wp_mail')) {
+			add_filter('wp_mail_content_type', ['EE_Error', 'set_content_type']);
+			wp_mail($to, $subject, $msg);
+		}
+		echo '<div id="message" class="espresso-notices error"><p>';
+		echo wp_kses($type . ': ' . $message . '<br />' . $file . ' line ' . $line, AllowedTags::getWithFormTags());
+		echo '<br /></p></div>';
+	}
+
+
+	/**
+	 * error_type
+	 * http://www.php.net/manual/en/errorfunc.constants.php#109430
+	 *
+	 * @param int $code
+	 * @return string
+	 */
+	public static function error_type(int $code): string
+	{
+		switch ($code) {
+			case E_ERROR: // 1 //
+				return 'E_ERROR';
+			case E_WARNING: // 2 //
+				return 'E_WARNING';
+			case E_PARSE: // 4 //
+				return 'E_PARSE';
+			case E_NOTICE: // 8 //
+				return 'E_NOTICE';
+			case E_CORE_ERROR: // 16 //
+				return 'E_CORE_ERROR';
+			case E_CORE_WARNING: // 32 //
+				return 'E_CORE_WARNING';
+			case E_COMPILE_ERROR: // 64 //
+				return 'E_COMPILE_ERROR';
+			case E_COMPILE_WARNING: // 128 //
+				return 'E_COMPILE_WARNING';
+			case E_USER_ERROR: // 256 //
+				return 'E_USER_ERROR';
+			case E_USER_WARNING: // 512 //
+				return 'E_USER_WARNING';
+			case E_USER_NOTICE: // 1024 //
+				return 'E_USER_NOTICE';
+			case E_STRICT: // 2048 //
+				return 'E_STRICT';
+			case E_RECOVERABLE_ERROR: // 4096 //
+				return 'E_RECOVERABLE_ERROR';
+			case E_DEPRECATED: // 8192 //
+				return 'E_DEPRECATED';
+			case E_USER_DEPRECATED: // 16384 //
+				return 'E_USER_DEPRECATED';
+			case E_ALL: // 16384 //
+				return 'E_ALL';
+		}
+		return '';
+	}
+
+
+	/**
+	 *    fatal_error_handler
+	 *
+	 * @return void
+	 */
+	public static function fatal_error_handler()
+	{
+		$last_error = error_get_last();
+		if ($last_error['type'] === E_ERROR) {
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
+		}
+	}
+
+
+	/**
+	 * _format_error
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return string
+	 */
+	private static function _format_error($code, $message, $file, $line): string
+	{
+		$html =
+			"<table><thead><th>Item</th><th>Details</th></thead><tbody>";
+		$html .= "<tr><td><b>Code</b></td><td>$code</td></tr>";
+		$html .= "<tr><td><b>Error</b></td><td>$message</td></tr>";
+		$html .= "<tr><td><b>File</b></td><td>$file</td></tr>";
+		$html .= "<tr><td><b>Line</b></td><td>$line</td></tr>";
+		$html .= '</tbody></table>';
+		return $html;
+	}
+
+
+	/**
+	 * set_content_type
+	 *
+	 * @param $content_type
+	 * @return string
+	 */
+	public static function set_content_type($content_type): string
+	{
+		return 'text/html';
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_error()
+	{
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
+			throw $this;
+		}
+		// get separate user and developer messages if they exist
+		$msg      = explode('||', $this->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg  = $msg[1] ?? $msg[0];
+		$msg      = WP_DEBUG ? $dev_msg : $user_msg;
+		// add details to _all_exceptions array
+		$x_time                                     = time();
+		self::$_all_exceptions[ $x_time ]['name']   = get_class($this);
+		self::$_all_exceptions[ $x_time ]['file']   = $this->getFile();
+		self::$_all_exceptions[ $x_time ]['line']   = $this->getLine();
+		self::$_all_exceptions[ $x_time ]['msg']    = $msg;
+		self::$_all_exceptions[ $x_time ]['code']   = $this->getCode();
+		self::$_all_exceptions[ $x_time ]['trace']  = $this->getTrace();
+		self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
+		self::$_error_count++;
+		// add_action( 'shutdown', array( $this, 'display_errors' ));
+		$this->display_errors();
+	}
+
+
+	/**
+	 * @param bool   $check_stored
+	 * @param string $type_to_check
+	 * @return bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function has_error(bool $check_stored = false, string $type_to_check = 'errors'): bool
+	{
+		$has_error = isset(self::$_espresso_notices[ $type_to_check ])
+					 && ! empty(self::$_espresso_notices[ $type_to_check ]);
+		if ($check_stored && ! $has_error) {
+			$notices = EE_Error::getStoredNotices();
+			foreach ($notices as $type => $notice) {
+				if ($type === $type_to_check && $notice) {
+					return true;
+				}
+			}
+		}
+		return $has_error;
+	}
+
+
+	/**
+	 * @echo string
+	 * @throws ReflectionException
+	 */
+	public function display_errors()
+	{
+		$trace_details = '';
+		$output = '
         <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	        <p>';
-        }
-        // cycle thru errors
-        foreach (self::$_all_exceptions as $time => $ex) {
-            $error_code = '';
-            // process trace info
-            if (empty($ex['trace'])) {
-                $trace_details .= esc_html__(
-                    'Sorry, but no trace information was available for this exception.',
-                    'event_espresso'
-                );
-            } else {
-                $trace_details .= '
+		}
+		// cycle thru errors
+		foreach (self::$_all_exceptions as $time => $ex) {
+			$error_code = '';
+			// process trace info
+			if (empty($ex['trace'])) {
+				$trace_details .= esc_html__(
+					'Sorry, but no trace information was available for this exception.',
+					'event_espresso'
+				);
+			} else {
+				$trace_details .= '
 			<div id="ee-trace-details">
 			<table>
 				<tr>
@@ -266,43 +266,43 @@ 
 					<th scope="col">Class</th>
 					<th scope="col">Method( arguments )</th>
 				</tr>';
-                $last_on_stack = count($ex['trace']) - 1;
-                // reverse array so that stack is in proper chronological order
-                $sorted_trace = array_reverse($ex['trace']);
-                foreach ($sorted_trace as $number => $trace) {
-                    $file     = $trace['file'] ?? '';
-                    $class    = $trace['class'] ?? '';
-                    $type     = $trace['type'] ?? '';
-                    $function = $trace['function'] ?? '';
-                    $args     = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                    $line     = $trace['line'] ?? '';
-                    $zebra    = ($number % 2) ? ' odd' : '';
-                    if (empty($file) && ! empty($class)) {
-                        $a    = new ReflectionClass($class);
-                        $file = $a->getFileName();
-                        if (empty($line) && ! empty($function)) {
-                            try {
-                                // if $function is a closure, this throws an exception
-                                $b    = new ReflectionMethod($class, $function);
-                                $line = $b->getStartLine();
-                            } catch (Exception $closure_exception) {
-                                $line = 'unknown';
-                            }
-                        }
-                    }
-                    if ($number === $last_on_stack) {
-                        $file       = $ex['file'] !== '' ? $ex['file'] : $file;
-                        $line       = $ex['line'] !== '' ? $ex['line'] : $line;
-                        $error_code = self::generate_error_code($file, $trace['function'], $line);
-                    }
-                    $number_display   = ! empty($number) ? $number : '&nbsp;';
-                    $line_display     = ! empty($line) ? $line : '&nbsp;';
-                    $file_display     = ! empty($file) ? $file : '&nbsp;';
-                    $class_display    = ! empty($class) ? $class : '&nbsp;';
-                    $type_display     = ! empty($type) ? $type : '&nbsp;';
-                    $function_display = ! empty($function) ? $function : '&nbsp;';
-                    $args_display     = ! empty($args) ? '( ' . $args . ' )' : '';
-                    $trace_details    .= '
+				$last_on_stack = count($ex['trace']) - 1;
+				// reverse array so that stack is in proper chronological order
+				$sorted_trace = array_reverse($ex['trace']);
+				foreach ($sorted_trace as $number => $trace) {
+					$file     = $trace['file'] ?? '';
+					$class    = $trace['class'] ?? '';
+					$type     = $trace['type'] ?? '';
+					$function = $trace['function'] ?? '';
+					$args     = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+					$line     = $trace['line'] ?? '';
+					$zebra    = ($number % 2) ? ' odd' : '';
+					if (empty($file) && ! empty($class)) {
+						$a    = new ReflectionClass($class);
+						$file = $a->getFileName();
+						if (empty($line) && ! empty($function)) {
+							try {
+								// if $function is a closure, this throws an exception
+								$b    = new ReflectionMethod($class, $function);
+								$line = $b->getStartLine();
+							} catch (Exception $closure_exception) {
+								$line = 'unknown';
+							}
+						}
+					}
+					if ($number === $last_on_stack) {
+						$file       = $ex['file'] !== '' ? $ex['file'] : $file;
+						$line       = $ex['line'] !== '' ? $ex['line'] : $line;
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
+					}
+					$number_display   = ! empty($number) ? $number : '&nbsp;';
+					$line_display     = ! empty($line) ? $line : '&nbsp;';
+					$file_display     = ! empty($file) ? $file : '&nbsp;';
+					$class_display    = ! empty($class) ? $class : '&nbsp;';
+					$type_display     = ! empty($type) ? $type : '&nbsp;';
+					$function_display = ! empty($function) ? $function : '&nbsp;';
+					$args_display     = ! empty($args) ? '( ' . $args . ' )' : '';
+					$trace_details    .= '
 					<tr>
 						<td class="' . $zebra . '">' . $number_display . '</td>
 						<td class="' . $zebra . '">' . $line_display . '</td>
@@ -310,649 +310,649 @@ 
 						<td class="' . $zebra . '">' . $class_display . '</td>
 						<td class="' . $zebra . '">' . $type_display . $function_display . $args_display . '</td>
 					</tr>';
-                }
-                $trace_details .= '
+				}
+				$trace_details .= '
 			 </table>
 			</div>';
-            }
-            $ex['code'] = $ex['code'] ?: $error_code;
-            // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
-                $output .= '<span class="ee-error-user-msg-spn">'
-                           . trim($ex['msg'])
-                           . '</span> &nbsp; <sup>'
-                           . $ex['code']
-                           . '</sup><br />';
-            } else {
-                // or helpful developer messages if debugging is on
-                $output .= '
+			}
+			$ex['code'] = $ex['code'] ?: $error_code;
+			// add generic non-identifying messages for non-privileged users
+			if (! WP_DEBUG) {
+				$output .= '<span class="ee-error-user-msg-spn">'
+						   . trim($ex['msg'])
+						   . '</span> &nbsp; <sup>'
+						   . $ex['code']
+						   . '</sup><br />';
+			} else {
+				// or helpful developer messages if debugging is on
+				$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				<strong class="ee-error-dev-msg-str">An '
-                           . $ex['name']
-                           . ' exception was thrown!</strong>  &nbsp; <span>code: '
-                           . $ex['code']
-                           . '</span><br />
+						   . $ex['name']
+						   . ' exception was thrown!</strong>  &nbsp; <span>code: '
+						   . $ex['code']
+						   . '</span><br />
 				<span class="big-text">"'
-                           . trim($ex['msg'])
-                           . '"</span><br/>
+						   . trim($ex['msg'])
+						   . '"</span><br/>
 				<a id="display-ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '">
+						   . self::$_error_count
+						   . $time
+						   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
+						   . self::$_error_count
+						   . $time
+						   . '">
 					'
-                           . esc_html__('click to view backtrace and class/method details', 'event_espresso')
-                           . '
+						   . esc_html__('click to view backtrace and class/method details', 'event_espresso')
+						   . '
 				</a><br />
 				<span class="small-text lt-grey-text">'
-                           . $ex['file']
-                           . ' &nbsp; ( line no: '
-                           . $ex['line']
-                           . ' )</span>
+						   . $ex['file']
+						   . ' &nbsp; ( line no: '
+						   . $ex['line']
+						   . ' )</span>
 			</p>
 			<div id="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '-dv" class="ee-error-trace-dv" style="display: none;">
+						   . self::$_error_count
+						   . $time
+						   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                           . $trace_details;
-                if (! empty($class)) {
-                    $output .= '
+						   . $trace_details;
+				if (! empty($class)) {
+					$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-                    $a      = new ReflectionClass($class);
-                    $output .= '
+					$a      = new ReflectionClass($class);
+					$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-                }
-                $output .= '
+				}
+				$output .= '
 			</div>
 		</div>
 		<br />';
-            }
-            $this->write_to_error_log($time, $ex);
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+			}
+			$this->write_to_error_log($time, $ex);
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	        </p>';
-        }
-        $output .= '
+		}
+		$output .= '
         </div>';
-        $output .= self::_print_scripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(['error' => $output]);
-            exit();
-        }
-        echo wp_kses($output, AllowedTags::getWithFormTags());
-        die();
-    }
-
-
-    /**
-     *    generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string(array $arguments = [], bool $array = false): string
-    {
-        $arg_string = '';
-        if (! empty($arguments)) {
-            $args = [];
-            foreach ($arguments as $arg) {
-                if (! empty($arg)) {
-                    if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
-                    } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
-                    } elseif (is_bool($arg)) {
-                        $args[] = $arg ? ' TRUE' : ' FALSE';
-                    } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
-                    } elseif (is_resource($arg)) {
-                        $args[] = get_resource_type($arg);
-                    } else {
-                        $args[] = $arg;
-                    }
-                } else {
-                    $args[] = ' NULL';
-                }
-            }
-            $arg_string = implode(', ', $args);
-        }
-        if ($array) {
-            $arg_string .= ' )';
-        }
-        return $arg_string;
-    }
-
-
-    /**
-     *    add error message
-     *
-     * @param string $msg         the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param string $file        the file that the error occurred in - just use __FILE__
-     * @param string $func        the function/method that the error occurred in - just use __FUNCTION__
-     * @param int|string $line        the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_error(string $msg, string $file, string $func, $line)
-    {
-        self::_add_notice('errors', $msg, $file, $func, $line);
-        self::$_error_count++;
-    }
-
-
-    /**
-     * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
-     * adds an error
-     *
-     * @param string $msg
-     * @param string $file
-     * @param string $func
-     * @param int|string $line
-     * @throws EE_Error
-     */
-    public static function throw_exception_if_debugging(
-        string $msg = '',
-        string $file = '',
-        string $func = '',
-        $line = ''
-    ) {
-        if (WP_DEBUG) {
-            throw new EE_Error($msg);
-        }
-        EE_Error::add_error($msg, $file, $func, $line);
-    }
-
-
-    /**
-     *    add success message
-     *
-     * @param string $msg         the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param string $file        the file that the error occurred in - just use __FILE__
-     * @param string $func        the function/method that the error occurred in - just use __FUNCTION__
-     * @param int|string $line        the line number where the error occurred - just use __LINE__
-     * @return void
-     */
-    public static function add_success(string $msg = '', string $file = '', string $func = '', $line = '')
-    {
-        self::_add_notice('success', $msg, $file, $func, $line);
-    }
-
-
-    /**
-     *    add attention message
-     *
-     * @param string $msg         the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param string $file        the file that the error occurred in - just use __FILE__
-     * @param string $func        the function/method that the error occurred in - just use __FUNCTION__
-     * @param int|string $line        the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_attention(string $msg = '', string $file = '', string $func = '', $line = '')
-    {
-        self::_add_notice('attention', $msg, $file, $func, $line);
-    }
-
-
-    /**
-     * @param string $type whether the message is for a success or error notification
-     * @param string $msg  the message to display to users or developers
-     *                     - adding a double pipe || (OR) creates separate messages for user || dev
-     * @param string $file the file that the error occurred in - just use __FILE__
-     * @param string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param int|string $line the line number where the error occurred - just use __LINE__
-     * @return void
-     */
-    private static function _add_notice(
-        string $type = 'success',
-        string $msg = '',
-        string $file = '',
-        string $func = '',
-        $line = ''
-    ) {
-        if (empty($msg)) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
-                sprintf(
-                    esc_html__(
-                        'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
-                        'event_espresso'
-                    ),
-                    $type,
-                    $file,
-                    $line
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_error()',
-                esc_html__(
-                    'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
-                    'event_espresso'
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        // get separate user and developer messages if they exist
-        $msg      = explode('||', $msg);
-        $user_msg = $msg[0];
-        $dev_msg  = $msg[1] ?? $msg[0];
-        /**
-         * Do an action so other code can be triggered when a notice is created
-         *
-         * @param string $type     can be 'errors', 'attention', or 'success'
-         * @param string $user_msg message displayed to user when WP_DEBUG is off
-         * @param string $user_msg message displayed to user when WP_DEBUG is on
-         * @param string $file     file where error was generated
-         * @param string $func     function where error was generated
-         * @param int|string $line     line where error was generated
-         */
-        do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add notice if message exists
-        if (! empty($msg)) {
-            // get error code
-            $notice_code = EE_Error::generate_error_code($file, $func, $line);
-            if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
-            }
-
-            if (! is_array(self::$_espresso_notices[ $type ]) || ! array_key_exists($type, self::$_espresso_notices)) {
-                self::$_espresso_notices[ $type ] = [];
-            }
-
-            // add notice. Index by code if it's not blank
-            if ($notice_code) {
-                self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
-            } else {
-                self::$_espresso_notices[ $type ][] = $msg;
-            }
-            add_action('wp_footer', ['EE_Error', 'enqueue_error_scripts'], 1);
-        }
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing success messages
-     *
-     * @return        void
-     */
-    public static function overwrite_success()
-    {
-        self::$_espresso_notices['success'] = [];
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing attention messages
-     *
-     * @return void
-     */
-    public static function overwrite_attention()
-    {
-        self::$_espresso_notices['attention'] = [];
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing error messages
-     *
-     * @return void
-     */
-    public static function overwrite_errors()
-    {
-        self::$_espresso_notices['errors'] = [];
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function reset_notices()
-    {
-        self::$_espresso_notices['success']   = [];
-        self::$_espresso_notices['attention'] = [];
-        self::$_espresso_notices['errors']    = [];
-    }
-
-
-    /**
-     * @return int
-     */
-    public static function has_notices(): int
-    {
-        $has_notices = 0;
-        // check for success messages
-        $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
-            ? 3
-            : $has_notices;
-        // check for attention messages
-        $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
-            ? 2
-            : $has_notices;
-        // check for error messages
-        return self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
-            ? 1
-            : $has_notices;
-    }
-
-
-    /**
-     * This simply returns non formatted error notices as they were sent into the EE_Error object.
-     *
-     * @return array
-     * @since 4.9.0
-     */
-    public static function get_vanilla_notices(): array
-    {
-        return [
-            'success'   => self::$_espresso_notices['success'] ?? [],
-            'attention' => self::$_espresso_notices['attention'] ?? [],
-            'errors'    => self::$_espresso_notices['errors'] ?? [],
-        ];
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getStoredNotices(): array
-    {
-        if ($user_id = get_current_user_id()) {
-            // get notices for logged in user
-            $notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
-            return is_array($notices) ? $notices : [];
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // get notices for user currently engaged in a session
-            $session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
-            return is_array($session_data) ? $session_data : [];
-        }
-        // get global notices and hope they apply to the current site visitor
-        $notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, []);
-        return is_array($notices) ? $notices : [];
-    }
-
-
-    /**
-     * @param array $notices
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function storeNotices(array $notices): bool
-    {
-        if ($user_id = get_current_user_id()) {
-            // store notices for logged in user
-            return (bool) update_user_option(
-                $user_id,
-                EE_Error::OPTIONS_KEY_NOTICES,
-                $notices
-            );
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // store notices for user currently engaged in a session
-            return EE_Session::instance()->set_session_data(
-                [EE_Error::OPTIONS_KEY_NOTICES => $notices]
-            );
-        }
-        // store global notices and hope they apply to the same site visitor on the next request
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function clearNotices(): bool
-    {
-        if ($user_id = get_current_user_id()) {
-            // clear notices for logged in user
-            return (bool) update_user_option(
-                $user_id,
-                EE_Error::OPTIONS_KEY_NOTICES,
-                []
-            );
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // clear notices for user currently engaged in a session
-            return EE_Session::instance()->reset_data([EE_Error::OPTIONS_KEY_NOTICES]);
-        }
-        // clear global notices and hope none belonged to some for some other site visitor
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, []);
-    }
-
-
-    /**
-     * saves notices to the db for retrieval on next request
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function stashNoticesBeforeRedirect()
-    {
-        EE_Error::get_notices(false, true);
-    }
-
-
-    /**
-     * compile all error or success messages into one string
-     *
-     * @param boolean $format_output        whether to format the messages for display in the WP admin
-     * @param boolean $save_to_transient    whether to save notices to the db for retrieval on next request
-     *                                          - ONLY do this just before redirecting
-     * @param bool $remove_empty             whether to unset empty messages
-     * @param bool $add_preface              whether to add notice before messages like "An error has occurred:"
-     * @return array|string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
-     */
-    public static function get_notices(
-        bool $format_output = true,
-        bool $save_to_transient = false,
-        bool $remove_empty = true,
-        bool $add_preface = true
-    ) {
-        $success_messages   = '';
-        $attention_messages = '';
-        $error_messages     = '';
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        // either save notices to the db
-        if ($save_to_transient || $request->requestParamIsSet('activate-selected')) {
-            self::$_espresso_notices = array_merge(
-                EE_Error::getStoredNotices(),
-                self::$_espresso_notices
-            );
-            EE_Error::storeNotices(self::$_espresso_notices);
-            return [];
-        }
-        $print_scripts = EE_Error::combineExistingAndNewNotices();
-        // check for success messages
-        if (! empty(self::$_espresso_notices['success'])) {
-            // combine messages
-            $success_messages .= implode('<br />', self::$_espresso_notices['success']);
-            $print_scripts    = true;
-        }
-        // check for attention messages
-        if (! empty(self::$_espresso_notices['attention'])) {
-            // combine messages
-            $attention_messages .= implode('<br />', self::$_espresso_notices['attention']);
-            $print_scripts      = true;
-        }
-        // check for error messages
-        if (! empty(self::$_espresso_notices['errors'])) {
-            if ($add_preface) {
-                $error_messages .= count(self::$_espresso_notices['errors']) > 1
-                    ? esc_html__('The following errors have occurred:', 'event_espresso')
-                    : esc_html__('An error has occurred:', 'event_espresso');
-            }
-            // combine messages
-            $error_messages .= '<br />' . implode('<br />', self::$_espresso_notices['errors']);
-            $print_scripts  = true;
-        }
-        if ($format_output) {
-            $notices = EE_Error::formatNoticesOutput(
-                $success_messages,
-                $attention_messages,
-                $error_messages
-            );
-        } else {
-            $notices = [
-                'success'   => $success_messages,
-                'attention' => $attention_messages,
-                'errors'    => $error_messages,
-            ];
-            if ($remove_empty) {
-                // remove empty notices
-                foreach ($notices as $type => $notice) {
-                    if (empty($notice)) {
-                        unset($notices[ $type ]);
-                    }
-                }
-            }
-        }
-        if ($print_scripts) {
-            self::_print_scripts();
-        }
-        return $notices;
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function combineExistingAndNewNotices(): bool
-    {
-        $print_scripts = false;
-        // grab any notices that have been previously saved
-        $notices = EE_Error::getStoredNotices();
-        if (! empty($notices)) {
-            foreach ($notices as $type => $notice) {
-                if (is_array($notice) && ! empty($notice)) {
-                    // make sure that existing notice type is an array
-                    self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
-                                                        && ! empty(self::$_espresso_notices[ $type ])
-                        ? self::$_espresso_notices[ $type ]
-                        : [];
-                    // add newly created notices to existing ones
-                    self::$_espresso_notices[ $type ] += $notice;
-                    $print_scripts                    = true;
-                }
-            }
-            // now clear any stored notices
-            EE_Error::clearNotices();
-        }
-        return $print_scripts;
-    }
-
-
-    /**
-     * @param string $success_messages
-     * @param string $attention_messages
-     * @param string $error_messages
-     * @return string
-     */
-    private static function formatNoticesOutput(
-        string $success_messages,
-        string $attention_messages,
-        string $error_messages
-    ): string {
-        $notices = '<div id="espresso-notices">';
-        $close   = is_admin()
-            ? ''
-            : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
-        if ($success_messages !== '') {
-            $css_id    = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
-            $css_class = is_admin() ? 'updated fade ee-status-outline ee-status-bg--success' : 'success fade-away';
-            // showMessage( $success_messages );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $success_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        if ($attention_messages !== '') {
-            $css_id    = is_admin()  ? 'ee-attention-message' : 'espresso-notices-attention';
-            $css_class = is_admin()
-                ? 'notice notice-info ee-notices-attention ee-status-outline ee-status-bg--attention'
-                : 'attention fade-away';
-            // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $attention_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        if ($error_messages !== '') {
-            $css_id    = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
-            $css_class = is_admin()
-                ? 'error ee-status-outline ee-status-bg--error'
-                : 'error fade-away';
-            // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $error_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        $notices .= '</div>';
-        return $notices;
-    }
-
-
-    /**
-     * _print_scripts
-     *
-     * @param bool $force_print
-     * @return    string
-     */
-    private static function _print_scripts(bool $force_print = false): string
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-            }
-            if (wp_script_is('ee_error_js')) {
-                wp_localize_script('ee_error_js', 'ee_settings', ['wp_debug' => WP_DEBUG]);
-                return '';
-            }
-        } else {
-            return '
+		$output .= self::_print_scripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(['error' => $output]);
+			exit();
+		}
+		echo wp_kses($output, AllowedTags::getWithFormTags());
+		die();
+	}
+
+
+	/**
+	 *    generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string(array $arguments = [], bool $array = false): string
+	{
+		$arg_string = '';
+		if (! empty($arguments)) {
+			$args = [];
+			foreach ($arguments as $arg) {
+				if (! empty($arg)) {
+					if (is_string($arg)) {
+						$args[] = " '" . $arg . "'";
+					} elseif (is_array($arg)) {
+						$args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+					} elseif (is_bool($arg)) {
+						$args[] = $arg ? ' TRUE' : ' FALSE';
+					} elseif (is_object($arg)) {
+						$args[] = ' OBJECT ' . get_class($arg);
+					} elseif (is_resource($arg)) {
+						$args[] = get_resource_type($arg);
+					} else {
+						$args[] = $arg;
+					}
+				} else {
+					$args[] = ' NULL';
+				}
+			}
+			$arg_string = implode(', ', $args);
+		}
+		if ($array) {
+			$arg_string .= ' )';
+		}
+		return $arg_string;
+	}
+
+
+	/**
+	 *    add error message
+	 *
+	 * @param string $msg         the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param string $file        the file that the error occurred in - just use __FILE__
+	 * @param string $func        the function/method that the error occurred in - just use __FUNCTION__
+	 * @param int|string $line        the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_error(string $msg, string $file, string $func, $line)
+	{
+		self::_add_notice('errors', $msg, $file, $func, $line);
+		self::$_error_count++;
+	}
+
+
+	/**
+	 * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
+	 * adds an error
+	 *
+	 * @param string $msg
+	 * @param string $file
+	 * @param string $func
+	 * @param int|string $line
+	 * @throws EE_Error
+	 */
+	public static function throw_exception_if_debugging(
+		string $msg = '',
+		string $file = '',
+		string $func = '',
+		$line = ''
+	) {
+		if (WP_DEBUG) {
+			throw new EE_Error($msg);
+		}
+		EE_Error::add_error($msg, $file, $func, $line);
+	}
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param string $msg         the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param string $file        the file that the error occurred in - just use __FILE__
+	 * @param string $func        the function/method that the error occurred in - just use __FUNCTION__
+	 * @param int|string $line        the line number where the error occurred - just use __LINE__
+	 * @return void
+	 */
+	public static function add_success(string $msg = '', string $file = '', string $func = '', $line = '')
+	{
+		self::_add_notice('success', $msg, $file, $func, $line);
+	}
+
+
+	/**
+	 *    add attention message
+	 *
+	 * @param string $msg         the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param string $file        the file that the error occurred in - just use __FILE__
+	 * @param string $func        the function/method that the error occurred in - just use __FUNCTION__
+	 * @param int|string $line        the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_attention(string $msg = '', string $file = '', string $func = '', $line = '')
+	{
+		self::_add_notice('attention', $msg, $file, $func, $line);
+	}
+
+
+	/**
+	 * @param string $type whether the message is for a success or error notification
+	 * @param string $msg  the message to display to users or developers
+	 *                     - adding a double pipe || (OR) creates separate messages for user || dev
+	 * @param string $file the file that the error occurred in - just use __FILE__
+	 * @param string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param int|string $line the line number where the error occurred - just use __LINE__
+	 * @return void
+	 */
+	private static function _add_notice(
+		string $type = 'success',
+		string $msg = '',
+		string $file = '',
+		string $func = '',
+		$line = ''
+	) {
+		if (empty($msg)) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_' . $type . '()',
+				sprintf(
+					esc_html__(
+						'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
+						'event_espresso'
+					),
+					$type,
+					$file,
+					$line
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_error()',
+				esc_html__(
+					'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
+					'event_espresso'
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		// get separate user and developer messages if they exist
+		$msg      = explode('||', $msg);
+		$user_msg = $msg[0];
+		$dev_msg  = $msg[1] ?? $msg[0];
+		/**
+		 * Do an action so other code can be triggered when a notice is created
+		 *
+		 * @param string $type     can be 'errors', 'attention', or 'success'
+		 * @param string $user_msg message displayed to user when WP_DEBUG is off
+		 * @param string $user_msg message displayed to user when WP_DEBUG is on
+		 * @param string $file     file where error was generated
+		 * @param string $func     function where error was generated
+		 * @param int|string $line     line where error was generated
+		 */
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add notice if message exists
+		if (! empty($msg)) {
+			// get error code
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
+			if (WP_DEBUG && $type === 'errors') {
+				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+			}
+
+			if (! is_array(self::$_espresso_notices[ $type ]) || ! array_key_exists($type, self::$_espresso_notices)) {
+				self::$_espresso_notices[ $type ] = [];
+			}
+
+			// add notice. Index by code if it's not blank
+			if ($notice_code) {
+				self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
+			} else {
+				self::$_espresso_notices[ $type ][] = $msg;
+			}
+			add_action('wp_footer', ['EE_Error', 'enqueue_error_scripts'], 1);
+		}
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing success messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_success()
+	{
+		self::$_espresso_notices['success'] = [];
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing attention messages
+	 *
+	 * @return void
+	 */
+	public static function overwrite_attention()
+	{
+		self::$_espresso_notices['attention'] = [];
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing error messages
+	 *
+	 * @return void
+	 */
+	public static function overwrite_errors()
+	{
+		self::$_espresso_notices['errors'] = [];
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_notices()
+	{
+		self::$_espresso_notices['success']   = [];
+		self::$_espresso_notices['attention'] = [];
+		self::$_espresso_notices['errors']    = [];
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public static function has_notices(): int
+	{
+		$has_notices = 0;
+		// check for success messages
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
+			? 3
+			: $has_notices;
+		// check for attention messages
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
+			? 2
+			: $has_notices;
+		// check for error messages
+		return self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
+			? 1
+			: $has_notices;
+	}
+
+
+	/**
+	 * This simply returns non formatted error notices as they were sent into the EE_Error object.
+	 *
+	 * @return array
+	 * @since 4.9.0
+	 */
+	public static function get_vanilla_notices(): array
+	{
+		return [
+			'success'   => self::$_espresso_notices['success'] ?? [],
+			'attention' => self::$_espresso_notices['attention'] ?? [],
+			'errors'    => self::$_espresso_notices['errors'] ?? [],
+		];
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getStoredNotices(): array
+	{
+		if ($user_id = get_current_user_id()) {
+			// get notices for logged in user
+			$notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
+			return is_array($notices) ? $notices : [];
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// get notices for user currently engaged in a session
+			$session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
+			return is_array($session_data) ? $session_data : [];
+		}
+		// get global notices and hope they apply to the current site visitor
+		$notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, []);
+		return is_array($notices) ? $notices : [];
+	}
+
+
+	/**
+	 * @param array $notices
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function storeNotices(array $notices): bool
+	{
+		if ($user_id = get_current_user_id()) {
+			// store notices for logged in user
+			return (bool) update_user_option(
+				$user_id,
+				EE_Error::OPTIONS_KEY_NOTICES,
+				$notices
+			);
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// store notices for user currently engaged in a session
+			return EE_Session::instance()->set_session_data(
+				[EE_Error::OPTIONS_KEY_NOTICES => $notices]
+			);
+		}
+		// store global notices and hope they apply to the same site visitor on the next request
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function clearNotices(): bool
+	{
+		if ($user_id = get_current_user_id()) {
+			// clear notices for logged in user
+			return (bool) update_user_option(
+				$user_id,
+				EE_Error::OPTIONS_KEY_NOTICES,
+				[]
+			);
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// clear notices for user currently engaged in a session
+			return EE_Session::instance()->reset_data([EE_Error::OPTIONS_KEY_NOTICES]);
+		}
+		// clear global notices and hope none belonged to some for some other site visitor
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, []);
+	}
+
+
+	/**
+	 * saves notices to the db for retrieval on next request
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function stashNoticesBeforeRedirect()
+	{
+		EE_Error::get_notices(false, true);
+	}
+
+
+	/**
+	 * compile all error or success messages into one string
+	 *
+	 * @param boolean $format_output        whether to format the messages for display in the WP admin
+	 * @param boolean $save_to_transient    whether to save notices to the db for retrieval on next request
+	 *                                          - ONLY do this just before redirecting
+	 * @param bool $remove_empty             whether to unset empty messages
+	 * @param bool $add_preface              whether to add notice before messages like "An error has occurred:"
+	 * @return array|string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
+	 */
+	public static function get_notices(
+		bool $format_output = true,
+		bool $save_to_transient = false,
+		bool $remove_empty = true,
+		bool $add_preface = true
+	) {
+		$success_messages   = '';
+		$attention_messages = '';
+		$error_messages     = '';
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		// either save notices to the db
+		if ($save_to_transient || $request->requestParamIsSet('activate-selected')) {
+			self::$_espresso_notices = array_merge(
+				EE_Error::getStoredNotices(),
+				self::$_espresso_notices
+			);
+			EE_Error::storeNotices(self::$_espresso_notices);
+			return [];
+		}
+		$print_scripts = EE_Error::combineExistingAndNewNotices();
+		// check for success messages
+		if (! empty(self::$_espresso_notices['success'])) {
+			// combine messages
+			$success_messages .= implode('<br />', self::$_espresso_notices['success']);
+			$print_scripts    = true;
+		}
+		// check for attention messages
+		if (! empty(self::$_espresso_notices['attention'])) {
+			// combine messages
+			$attention_messages .= implode('<br />', self::$_espresso_notices['attention']);
+			$print_scripts      = true;
+		}
+		// check for error messages
+		if (! empty(self::$_espresso_notices['errors'])) {
+			if ($add_preface) {
+				$error_messages .= count(self::$_espresso_notices['errors']) > 1
+					? esc_html__('The following errors have occurred:', 'event_espresso')
+					: esc_html__('An error has occurred:', 'event_espresso');
+			}
+			// combine messages
+			$error_messages .= '<br />' . implode('<br />', self::$_espresso_notices['errors']);
+			$print_scripts  = true;
+		}
+		if ($format_output) {
+			$notices = EE_Error::formatNoticesOutput(
+				$success_messages,
+				$attention_messages,
+				$error_messages
+			);
+		} else {
+			$notices = [
+				'success'   => $success_messages,
+				'attention' => $attention_messages,
+				'errors'    => $error_messages,
+			];
+			if ($remove_empty) {
+				// remove empty notices
+				foreach ($notices as $type => $notice) {
+					if (empty($notice)) {
+						unset($notices[ $type ]);
+					}
+				}
+			}
+		}
+		if ($print_scripts) {
+			self::_print_scripts();
+		}
+		return $notices;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function combineExistingAndNewNotices(): bool
+	{
+		$print_scripts = false;
+		// grab any notices that have been previously saved
+		$notices = EE_Error::getStoredNotices();
+		if (! empty($notices)) {
+			foreach ($notices as $type => $notice) {
+				if (is_array($notice) && ! empty($notice)) {
+					// make sure that existing notice type is an array
+					self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
+														&& ! empty(self::$_espresso_notices[ $type ])
+						? self::$_espresso_notices[ $type ]
+						: [];
+					// add newly created notices to existing ones
+					self::$_espresso_notices[ $type ] += $notice;
+					$print_scripts                    = true;
+				}
+			}
+			// now clear any stored notices
+			EE_Error::clearNotices();
+		}
+		return $print_scripts;
+	}
+
+
+	/**
+	 * @param string $success_messages
+	 * @param string $attention_messages
+	 * @param string $error_messages
+	 * @return string
+	 */
+	private static function formatNoticesOutput(
+		string $success_messages,
+		string $attention_messages,
+		string $error_messages
+	): string {
+		$notices = '<div id="espresso-notices">';
+		$close   = is_admin()
+			? ''
+			: '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
+		if ($success_messages !== '') {
+			$css_id    = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
+			$css_class = is_admin() ? 'updated fade ee-status-outline ee-status-bg--success' : 'success fade-away';
+			// showMessage( $success_messages );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $success_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		if ($attention_messages !== '') {
+			$css_id    = is_admin()  ? 'ee-attention-message' : 'espresso-notices-attention';
+			$css_class = is_admin()
+				? 'notice notice-info ee-notices-attention ee-status-outline ee-status-bg--attention'
+				: 'attention fade-away';
+			// showMessage( $error_messages, TRUE );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $attention_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		if ($error_messages !== '') {
+			$css_id    = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
+			$css_class = is_admin()
+				? 'error ee-status-outline ee-status-bg--error'
+				: 'error fade-away';
+			// showMessage( $error_messages, TRUE );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $error_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		$notices .= '</div>';
+		return $notices;
+	}
+
+
+	/**
+	 * _print_scripts
+	 *
+	 * @param bool $force_print
+	 * @return    string
+	 */
+	private static function _print_scripts(bool $force_print = false): string
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+			}
+			if (wp_script_is('ee_error_js')) {
+				wp_localize_script('ee_error_js', 'ee_settings', ['wp_debug' => WP_DEBUG]);
+				return '';
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 const ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -962,233 +962,233 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function enqueue_error_scripts()
-    {
-        self::_print_scripts();
-    }
-
-
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @param string $file
-     * @param string $func
-     * @param int|string $line
-     * @return string
-     */
-    public static function generate_error_code(string $file = '', string $func = '', $line = ''): string
-    {
-        $file       = explode('.', basename($file));
-        $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
-
-
-    /**
-     * write exception details to log file
-     * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
-     *
-     * @param int   $time
-     * @param array $ex
-     * @param bool  $clear
-     * @return void
-     */
-    public function write_to_error_log(int $time = 0, array $ex = [], bool $clear = false)
-    {
-        if (empty($ex)) {
-            return;
-        }
-        if (! $time) {
-            $time = time();
-        }
-        $exception_log = '----------------------------------------------------------------------------------------'
-                         . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
-        $exception_log .= '----------------------------------------------------------------------------------------'
-                          . PHP_EOL;
-        try {
-            error_log($exception_log);
-        } catch (Exception $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Event Espresso error logging could not be setup because: %s',
-                        'event_espresso'
-                    ),
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
-     * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
-     * but the code execution is done in a manner that could lead to unexpected results
-     * (i.e. running to early, or too late in WP or EE loading process).
-     * A good test for knowing whether to use this method is:
-     * 1. Is there going to be a PHP error if something isn't setup/used correctly?
-     * Yes -> use EE_Error::add_error() or throw new EE_Error()
-     * 2. If this is loaded before something else, it won't break anything,
-     * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
-     *
-     * @param string   $function     The function that was called
-     * @param string   $message      A message explaining what has been done incorrectly
-     * @param string   $version      The version of Event Espresso where the error was added
-     * @param string   $applies_when a version string for when you want the doing_it_wrong notice to begin appearing
-     *                               for a deprecated function. This allows deprecation to occur during one version,
-     *                               but not have any notices appear until a later version. This allows developers
-     *                               extra time to update their code before notices appear.
-     * @param int|null $error_type
-     * @uses   constant WP_DEBUG test if wp_debug is on or not
-     */
-    public static function doing_it_wrong(
-        string $function,
-        string $message,
-        string $version,
-        string $applies_when = '',
-        int $error_type = null
-    ) {
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
-        }
-    }
-
-
-    /**
-     * Like get_notices, but returns an array of all the notices of the given type.
-     *
-     * @return array {
-     * @type array $success   all the success messages
-     * @type array $errors    all the error messages
-     * @type array $attention all the attention messages
-     * }
-     */
-    public static function get_raw_notices(): array
-    {
-        return self::$_espresso_notices;
-    }
-
-
-    /**
-     * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
-     * @param string $pan_message  the message to be stored persistently until dismissed
-     * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
-     * @return void
-     * @throws InvalidDataTypeException
-     * @deprecated 4.9.27
-     */
-    public static function add_persistent_admin_notice(
-        string $pan_name = '',
-        string $pan_message = '',
-        bool $force_update = false
-    ) {
-        new PersistentAdminNotice(
-            $pan_name,
-            $pan_message,
-            $force_update
-        );
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge
-     * @param bool   $return
-     * @throws DomainException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ServiceNotFoundException
-     * @throws InvalidArgumentException
-     * @deprecated 4.9.27
-     */
-    public static function dismiss_persistent_admin_notice(
-        string $pan_name = '',
-        bool $purge = false,
-        bool $return = false
-    ) {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
-        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'
-        );
-    }
-
-
-    /**
-     * @param string $pan_name    the name, or key of the Persistent Admin Notice to be stored
-     * @param string $pan_message the message to be stored persistently until dismissed
-     * @param string $return_url  URL to go back to after nag notice is dismissed
-     * @deprecated 4.9.27
-     */
-    public static function display_persistent_admin_notices(
-        string $pan_name = '',
-        string $pan_message = '',
-        string $return_url = ''
-    ) {
-        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'
-        );
-    }
-
-
-    /**
-     * @param string $return_url
-     * @deprecated 4.9.27
-     */
-    public static function get_persistent_admin_notices(string $return_url = '')
-    {
-        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'
-        );
-    }
+		}
+		return '';
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function enqueue_error_scripts()
+	{
+		self::_print_scripts();
+	}
+
+
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @param string $file
+	 * @param string $func
+	 * @param int|string $line
+	 * @return string
+	 */
+	public static function generate_error_code(string $file = '', string $func = '', $line = ''): string
+	{
+		$file       = explode('.', basename($file));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
+
+
+	/**
+	 * write exception details to log file
+	 * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
+	 *
+	 * @param int   $time
+	 * @param array $ex
+	 * @param bool  $clear
+	 * @return void
+	 */
+	public function write_to_error_log(int $time = 0, array $ex = [], bool $clear = false)
+	{
+		if (empty($ex)) {
+			return;
+		}
+		if (! $time) {
+			$time = time();
+		}
+		$exception_log = '----------------------------------------------------------------------------------------'
+						 . PHP_EOL;
+		$exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
+		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
+		$exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
+		$exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
+		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
+		$exception_log .= 'Stack trace: ' . PHP_EOL;
+		$exception_log .= $ex['string'] . PHP_EOL;
+		$exception_log .= '----------------------------------------------------------------------------------------'
+						  . PHP_EOL;
+		try {
+			error_log($exception_log);
+		} catch (Exception $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Event Espresso error logging could not be setup because: %s',
+						'event_espresso'
+					),
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
+	 * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
+	 * but the code execution is done in a manner that could lead to unexpected results
+	 * (i.e. running to early, or too late in WP or EE loading process).
+	 * A good test for knowing whether to use this method is:
+	 * 1. Is there going to be a PHP error if something isn't setup/used correctly?
+	 * Yes -> use EE_Error::add_error() or throw new EE_Error()
+	 * 2. If this is loaded before something else, it won't break anything,
+	 * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
+	 *
+	 * @param string   $function     The function that was called
+	 * @param string   $message      A message explaining what has been done incorrectly
+	 * @param string   $version      The version of Event Espresso where the error was added
+	 * @param string   $applies_when a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                               for a deprecated function. This allows deprecation to occur during one version,
+	 *                               but not have any notices appear until a later version. This allows developers
+	 *                               extra time to update their code before notices appear.
+	 * @param int|null $error_type
+	 * @uses   constant WP_DEBUG test if wp_debug is on or not
+	 */
+	public static function doing_it_wrong(
+		string $function,
+		string $message,
+		string $version,
+		string $applies_when = '',
+		int $error_type = null
+	) {
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
+		}
+	}
+
+
+	/**
+	 * Like get_notices, but returns an array of all the notices of the given type.
+	 *
+	 * @return array {
+	 * @type array $success   all the success messages
+	 * @type array $errors    all the error messages
+	 * @type array $attention all the attention messages
+	 * }
+	 */
+	public static function get_raw_notices(): array
+	{
+		return self::$_espresso_notices;
+	}
+
+
+	/**
+	 * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
+	 * @param string $pan_message  the message to be stored persistently until dismissed
+	 * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @deprecated 4.9.27
+	 */
+	public static function add_persistent_admin_notice(
+		string $pan_name = '',
+		string $pan_message = '',
+		bool $force_update = false
+	) {
+		new PersistentAdminNotice(
+			$pan_name,
+			$pan_message,
+			$force_update
+		);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge
+	 * @param bool   $return
+	 * @throws DomainException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ServiceNotFoundException
+	 * @throws InvalidArgumentException
+	 * @deprecated 4.9.27
+	 */
+	public static function dismiss_persistent_admin_notice(
+		string $pan_name = '',
+		bool $purge = false,
+		bool $return = false
+	) {
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
+		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'
+		);
+	}
+
+
+	/**
+	 * @param string $pan_name    the name, or key of the Persistent Admin Notice to be stored
+	 * @param string $pan_message the message to be stored persistently until dismissed
+	 * @param string $return_url  URL to go back to after nag notice is dismissed
+	 * @deprecated 4.9.27
+	 */
+	public static function display_persistent_admin_notices(
+		string $pan_name = '',
+		string $pan_message = '',
+		string $return_url = ''
+	) {
+		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'
+		);
+	}
+
+
+	/**
+	 * @param string $return_url
+	 * @deprecated 4.9.27
+	 */
+	public static function get_persistent_admin_notices(string $return_url = '')
+	{
+		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'
+		);
+	}
 }
 
 // end of Class EE_Exceptions
@@ -1201,29 +1201,29 @@ 
  */
 function espresso_error_enqueue_scripts()
 {
-    // js for error handling
-    if (! wp_script_is('espresso_core', 'registered')) {
-        wp_register_script(
-            'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION
-        );
-    }
-    wp_register_script(
-        'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-        ['espresso_core'],
-        EVENT_ESPRESSO_VERSION
-    );
-    wp_localize_script('ee_error_js', 'ee_settings', ['wp_debug' => WP_DEBUG]);
+	// js for error handling
+	if (! wp_script_is('espresso_core', 'registered')) {
+		wp_register_script(
+			'espresso_core',
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION
+		);
+	}
+	wp_register_script(
+		'ee_error_js',
+		EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+		['espresso_core'],
+		EVENT_ESPRESSO_VERSION
+	);
+	wp_localize_script('ee_error_js', 'ee_settings', ['wp_debug' => WP_DEBUG]);
 }
 
 
 if (is_admin()) {
-    add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
 } else {
-    add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
 }
 
 

Spacing +78 added lines, -78 removed lines

@@ -72,14 +72,14 @@ 
         $to      = strpos($site, 'eventespresso.com')
             ? 'developers@eventespresso.com'
             : get_option('admin_email');
-        $subject = "$type $message in " . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+        $subject = "$type $message in ".EVENT_ESPRESSO_VERSION.' on '.site_url();
         $msg     = EE_Error::_format_error($type, $message, $file, $line);
         if (function_exists('wp_mail')) {
             add_filter('wp_mail_content_type', ['EE_Error', 'set_content_type']);
             wp_mail($to, $subject, $msg);
         }
         echo '<div id="message" class="espresso-notices error"><p>';
-        echo wp_kses($type . ': ' . $message . '<br />' . $file . ' line ' . $line, AllowedTags::getWithFormTags());
+        echo wp_kses($type.': '.$message.'<br />'.$file.' line '.$line, AllowedTags::getWithFormTags());
         echo '<br /></p></div>';
     }
 
@@ -196,13 +196,13 @@ 
         $msg      = WP_DEBUG ? $dev_msg : $user_msg;
         // add details to _all_exceptions array
         $x_time                                     = time();
-        self::$_all_exceptions[ $x_time ]['name']   = get_class($this);
-        self::$_all_exceptions[ $x_time ]['file']   = $this->getFile();
-        self::$_all_exceptions[ $x_time ]['line']   = $this->getLine();
-        self::$_all_exceptions[ $x_time ]['msg']    = $msg;
-        self::$_all_exceptions[ $x_time ]['code']   = $this->getCode();
-        self::$_all_exceptions[ $x_time ]['trace']  = $this->getTrace();
-        self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
+        self::$_all_exceptions[$x_time]['name']   = get_class($this);
+        self::$_all_exceptions[$x_time]['file']   = $this->getFile();
+        self::$_all_exceptions[$x_time]['line']   = $this->getLine();
+        self::$_all_exceptions[$x_time]['msg']    = $msg;
+        self::$_all_exceptions[$x_time]['code']   = $this->getCode();
+        self::$_all_exceptions[$x_time]['trace']  = $this->getTrace();
+        self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
         self::$_error_count++;
         // add_action( 'shutdown', array( $this, 'display_errors' ));
         $this->display_errors();
@@ -219,8 +219,8 @@ 
      */
     public static function has_error(bool $check_stored = false, string $type_to_check = 'errors'): bool
     {
-        $has_error = isset(self::$_espresso_notices[ $type_to_check ])
-                     && ! empty(self::$_espresso_notices[ $type_to_check ]);
+        $has_error = isset(self::$_espresso_notices[$type_to_check])
+                     && ! empty(self::$_espresso_notices[$type_to_check]);
         if ($check_stored && ! $has_error) {
             $notices = EE_Error::getStoredNotices();
             foreach ($notices as $type => $notice) {
@@ -242,7 +242,7 @@ 
         $trace_details = '';
         $output = '
         <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	        <p>';
         }
@@ -301,14 +301,14 @@ 
                     $class_display    = ! empty($class) ? $class : '&nbsp;';
                     $type_display     = ! empty($type) ? $type : '&nbsp;';
                     $function_display = ! empty($function) ? $function : '&nbsp;';
-                    $args_display     = ! empty($args) ? '( ' . $args . ' )' : '';
-                    $trace_details    .= '
+                    $args_display     = ! empty($args) ? '( '.$args.' )' : '';
+                    $trace_details .= '
 					<tr>
-						<td class="' . $zebra . '">' . $number_display . '</td>
-						<td class="' . $zebra . '">' . $line_display . '</td>
-						<td class="' . $zebra . '">' . $file_display . '</td>
-						<td class="' . $zebra . '">' . $class_display . '</td>
-						<td class="' . $zebra . '">' . $type_display . $function_display . $args_display . '</td>
+						<td class="' . $zebra.'">'.$number_display.'</td>
+						<td class="' . $zebra.'">'.$line_display.'</td>
+						<td class="' . $zebra.'">'.$file_display.'</td>
+						<td class="' . $zebra.'">'.$class_display.'</td>
+						<td class="' . $zebra.'">'.$type_display.$function_display.$args_display.'</td>
 					</tr>';
                 }
                 $trace_details .= '
@@ -317,7 +317,7 @@ 
             }
             $ex['code'] = $ex['code'] ?: $error_code;
             // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
+            if ( ! WP_DEBUG) {
                 $output .= '<span class="ee-error-user-msg-spn">'
                            . trim($ex['msg'])
                            . '</span> &nbsp; <sup>'
@@ -359,14 +359,14 @@ 
                            . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
                            . $trace_details;
-                if (! empty($class)) {
+                if ( ! empty($class)) {
                     $output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-                    $a      = new ReflectionClass($class);
+                    $a = new ReflectionClass($class);
                     $output .= '
-						<pre>' . $a . '</pre>
+						<pre>' . $a.'</pre>
 					</div>
 				</div>';
                 }
@@ -379,7 +379,7 @@ 
         }
         // remove last linebreak
         $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	        </p>';
         }
@@ -405,18 +405,18 @@ 
     private function _convert_args_to_string(array $arguments = [], bool $array = false): string
     {
         $arg_string = '';
-        if (! empty($arguments)) {
+        if ( ! empty($arguments)) {
             $args = [];
             foreach ($arguments as $arg) {
-                if (! empty($arg)) {
+                if ( ! empty($arg)) {
                     if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
+                        $args[] = " '".$arg."'";
                     } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+                        $args[] = 'ARRAY('.$this->_convert_args_to_string($arg, true);
                     } elseif (is_bool($arg)) {
                         $args[] = $arg ? ' TRUE' : ' FALSE';
                     } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
+                        $args[] = ' OBJECT '.get_class($arg);
                     } elseif (is_resource($arg)) {
                         $args[] = get_resource_type($arg);
                     } else {
@@ -525,7 +525,7 @@ 
     ) {
         if (empty($msg)) {
             EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
+                'EE_Error::add_'.$type.'()',
                 sprintf(
                     esc_html__(
                         'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
@@ -565,22 +565,22 @@ 
         do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
         $msg = WP_DEBUG ? $dev_msg : $user_msg;
         // add notice if message exists
-        if (! empty($msg)) {
+        if ( ! empty($msg)) {
             // get error code
             $notice_code = EE_Error::generate_error_code($file, $func, $line);
             if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+                $msg .= '<br/><span class="tiny-text">'.$notice_code.'</span>';
             }
 
-            if (! is_array(self::$_espresso_notices[ $type ]) || ! array_key_exists($type, self::$_espresso_notices)) {
-                self::$_espresso_notices[ $type ] = [];
+            if ( ! is_array(self::$_espresso_notices[$type]) || ! array_key_exists($type, self::$_espresso_notices)) {
+                self::$_espresso_notices[$type] = [];
             }
 
             // add notice. Index by code if it's not blank
             if ($notice_code) {
-                self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
+                self::$_espresso_notices[$type][$notice_code] = $msg;
             } else {
-                self::$_espresso_notices[ $type ][] = $msg;
+                self::$_espresso_notices[$type][] = $msg;
             }
             add_action('wp_footer', ['EE_Error', 'enqueue_error_scripts'], 1);
         }
@@ -795,27 +795,27 @@ 
         }
         $print_scripts = EE_Error::combineExistingAndNewNotices();
         // check for success messages
-        if (! empty(self::$_espresso_notices['success'])) {
+        if ( ! empty(self::$_espresso_notices['success'])) {
             // combine messages
             $success_messages .= implode('<br />', self::$_espresso_notices['success']);
-            $print_scripts    = true;
+            $print_scripts = true;
         }
         // check for attention messages
-        if (! empty(self::$_espresso_notices['attention'])) {
+        if ( ! empty(self::$_espresso_notices['attention'])) {
             // combine messages
             $attention_messages .= implode('<br />', self::$_espresso_notices['attention']);
-            $print_scripts      = true;
+            $print_scripts = true;
         }
         // check for error messages
-        if (! empty(self::$_espresso_notices['errors'])) {
+        if ( ! empty(self::$_espresso_notices['errors'])) {
             if ($add_preface) {
                 $error_messages .= count(self::$_espresso_notices['errors']) > 1
                     ? esc_html__('The following errors have occurred:', 'event_espresso')
                     : esc_html__('An error has occurred:', 'event_espresso');
             }
             // combine messages
-            $error_messages .= '<br />' . implode('<br />', self::$_espresso_notices['errors']);
-            $print_scripts  = true;
+            $error_messages .= '<br />'.implode('<br />', self::$_espresso_notices['errors']);
+            $print_scripts = true;
         }
         if ($format_output) {
             $notices = EE_Error::formatNoticesOutput(
@@ -833,7 +833,7 @@ 
                 // remove empty notices
                 foreach ($notices as $type => $notice) {
                     if (empty($notice)) {
-                        unset($notices[ $type ]);
+                        unset($notices[$type]);
                     }
                 }
             }
@@ -856,17 +856,17 @@ 
         $print_scripts = false;
         // grab any notices that have been previously saved
         $notices = EE_Error::getStoredNotices();
-        if (! empty($notices)) {
+        if ( ! empty($notices)) {
             foreach ($notices as $type => $notice) {
                 if (is_array($notice) && ! empty($notice)) {
                     // make sure that existing notice type is an array
-                    self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
-                                                        && ! empty(self::$_espresso_notices[ $type ])
-                        ? self::$_espresso_notices[ $type ]
+                    self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
+                                                        && ! empty(self::$_espresso_notices[$type])
+                        ? self::$_espresso_notices[$type]
                         : [];
                     // add newly created notices to existing ones
-                    self::$_espresso_notices[ $type ] += $notice;
-                    $print_scripts                    = true;
+                    self::$_espresso_notices[$type] += $notice;
+                    $print_scripts = true;
                 }
             }
             // now clear any stored notices
@@ -895,23 +895,23 @@ 
             $css_id    = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
             $css_class = is_admin() ? 'updated fade ee-status-outline ee-status-bg--success' : 'success fade-away';
             // showMessage( $success_messages );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $success_messages . '</p>'
+                        . '<p>'.$success_messages.'</p>'
                         . $close
                         . '</div>';
         }
         if ($attention_messages !== '') {
-            $css_id    = is_admin()  ? 'ee-attention-message' : 'espresso-notices-attention';
+            $css_id    = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention';
             $css_class = is_admin()
                 ? 'notice notice-info ee-notices-attention ee-status-outline ee-status-bg--attention'
                 : 'attention fade-away';
             // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $attention_messages . '</p>'
+                        . '<p>'.$attention_messages.'</p>'
                         . $close
                         . '</div>';
         }
@@ -921,10 +921,10 @@ 
                 ? 'error ee-status-outline ee-status-bg--error'
                 : 'error fade-away';
             // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $error_messages . '</p>'
+                        . '<p>'.$error_messages.'</p>'
                         . $close
                         . '</div>';
         }
@@ -941,7 +941,7 @@ 
      */
     private static function _print_scripts(bool $force_print = false): string
     {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+        if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
             if (wp_script_is('ee_error_js', 'registered')) {
                 wp_enqueue_style('espresso_default');
                 wp_enqueue_style('espresso_custom_css');
@@ -955,12 +955,12 @@ 
             return '
 <script>
 /* <![CDATA[ */
-const ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
+const ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
 /* ]]> */
 </script>
-<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
+<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
 ';
         }
         return '';
@@ -989,8 +989,8 @@ 
     {
         $file       = explode('.', basename($file));
         $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
+        $error_code .= ! empty($func) ? ' - '.$func : '';
+        $error_code .= ! empty($line) ? ' - '.$line : '';
         return $error_code;
     }
 
@@ -1009,18 +1009,18 @@ 
         if (empty($ex)) {
             return;
         }
-        if (! $time) {
+        if ( ! $time) {
             $time = time();
         }
         $exception_log = '----------------------------------------------------------------------------------------'
                          . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
+        $exception_log .= '['.date('Y-m-d H:i:s', $time).']  Exception Details'.PHP_EOL;
+        $exception_log .= 'Message: '.$ex['msg'].PHP_EOL;
+        $exception_log .= 'Code: '.$ex['code'].PHP_EOL;
+        $exception_log .= 'File: '.$ex['file'].PHP_EOL;
+        $exception_log .= 'Line No: '.$ex['line'].PHP_EOL;
+        $exception_log .= 'Stack trace: '.PHP_EOL;
+        $exception_log .= $ex['string'].PHP_EOL;
         $exception_log .= '----------------------------------------------------------------------------------------'
                           . PHP_EOL;
         try {
@@ -1202,17 +1202,17 @@ 
 function espresso_error_enqueue_scripts()
 {
     // js for error handling
-    if (! wp_script_is('espresso_core', 'registered')) {
+    if ( ! wp_script_is('espresso_core', 'registered')) {
         wp_register_script(
             'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION
         );
     }
     wp_register_script(
         'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+        EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js',
         ['espresso_core'],
         EVENT_ESPRESSO_VERSION
     );

core/domain/services/registration/form/v1/RegForm.php

Indentation +272 added lines, -272 removed lines

@@ -38,276 +38,276 @@
  */
 class RegForm extends EE_Form_Section_Proper
 {
-    private EE_Line_Item_Display $line_item_display;
-
-    private string $primary_registrant = '';
-
-    private array $required_questions = [];
-
-    private array $subsections = [];
-
-
-    private bool $print_copy_info = false;
-
-    protected int $reg_form_count = 0;
-
-    public EE_Registration_Config $reg_config;
-
-    public EE_SPCO_Reg_Step_Attendee_Information $reg_step;
-
-
-    /**
-     * RegForm constructor.
-     *
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration_Config                $reg_config
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function __construct(
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration_Config $reg_config
-    ) {
-        $this->reg_step   = $reg_step;
-        $this->reg_config = $reg_config;
-        // setup some classes so that they are ready for loading during construction of other classes
-        LoaderFactory::getShared(CountryOptions::class, [$this->reg_step->checkout->action]);
-        LoaderFactory::getShared(StateOptions::class, [$this->reg_step->checkout->action]);
-        LoaderFactory::getShared(RegFormQuestionFactory::class, [[$this, 'addRequiredQuestion']]);
-        parent::__construct(
-            [
-                'name'            => $this->reg_step->reg_form_name(),
-                'html_id'         => $this->reg_step->reg_form_name(),
-                'layout_strategy' => new EE_No_Layout(),
-                'subsections'     => $this->generateSubsections(),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public function enablePrintCopyInfo(): void
-    {
-        $this->print_copy_info = true;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function printCopyInfo(): bool
-    {
-        return $this->print_copy_info;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function regFormCount(): int
-    {
-        return $this->reg_form_count;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function requiredQuestions(): array
-    {
-        return $this->required_questions;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @param string $required_question
-     */
-    public function addRequiredQuestion(string $identifier, string $required_question): void
-    {
-        $this->required_questions[ $identifier ] = $required_question;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper[]
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function generateSubsections(): array
-    {
-        $this->configureLineItemDisplay();
-        $this->addAttendeeInformationNotice();
-
-        $this->subsections["ticket-details"] = new TicketDetailsTable(
-            $this->reg_step->checkout->cart->get_grand_total(),
-            $this->line_item_display,
-            $this->reg_step->checkout->revisit
-        );
-
-        // grab the saved registrations from the transaction
-        $registrations = $this->reg_step->checkout->transaction->registrations(
-            $this->reg_step->checkout->reg_cache_where_params
-        );
-        if ($registrations) {
-            foreach ($registrations as $registration) {
-                if (! $registration instanceof EE_Registration) {
-                    continue;
-                }
-                $this->subsections["ticket-details"]->addTicket($registration->ticket());
-                $this->addAttendeeRegForm($registration);
-            }
-            $this->addCopyAttendeeInfoForm($registrations);
-        }
-        $this->addPrivacyConsentCheckbox();
-        $this->displayEventQuestionsLink();
-        $this->subsections['default_hidden_inputs']  =  $this->reg_step->reg_step_hidden_inputs();
-
-        return (array) apply_filters(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegForm__generateSubsections__subsections',
-            $this->subsections,
-            $this
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function configureLineItemDisplay()
-    {
-        // autoload Line_Item_Display classes
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $this->line_item_display = new EE_Line_Item_Display();
-        // calculate taxes
-        $this->line_item_display->display_line_item(
-            $this->reg_step->checkout->cart->get_grand_total(),
-            ['set_tax_rate' => true]
-        );
-    }
-
-
-    private function addAttendeeInformationNotice(): void
-    {
-        if (is_admin()) {
-            return;
-        }
-        $this->subsections['attendee_information_notice'] = new AttendeeInformationNotice();
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function addAttendeeRegForm(EE_Registration $registration): void
-    {
-        // can this registration be processed during this visit ?
-        if (! $this->reg_step->checkout->visit_allows_processing_of_this_registration($registration)) {
-            return;
-        }
-        $reg_url_link = $registration->reg_url_link();
-        if ($registration->is_primary_registrant()) {
-            $this->primary_registrant = $reg_url_link;
-        }
-
-        /** @var AttendeeRegForm $registrant_form */
-        $registrant_form = LoaderFactory::getNew(
-            AttendeeRegForm::class,
-            [
-                $registration,
-                $this->reg_config->copyAttendeeInfo(),
-                [$this, 'enablePrintCopyInfo'],
-                $this->reg_step,
-            ]
-        );
-
-        // skip section if there are no questions
-        if (! $registrant_form->hasQuestions()) {
-            return;
-        }
-
-        // but increment the reg form count if form is valid.
-        $this->reg_form_count++;
-        $this->subsections["panel-div-open-$reg_url_link"]  = new EE_Form_Section_HTML(
-            EEH_HTML::div(
-                '',
-                "spco-attendee-panel-dv-$reg_url_link",
-                "spco-attendee-panel-dv spco-attendee-ticket-$reg_url_link"
-            )
-        );
-        $this->subsections["event-header-$reg_url_link"]    = new EventHeader($registration->event());
-        $this->subsections[ $reg_url_link ]                 = $registrant_form;
-        $this->subsections["panel-div-close-$reg_url_link"] = new EE_Form_Section_HTML(
-            EEH_HTML::divx("spco-attendee-panel-dv-$reg_url_link")
-        );
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    private function addCopyAttendeeInfoForm(array $registrations)
-    {
-        if (
-            $this->primary_registrant
-            && count($registrations) > 1
-            && isset($this->subsections[ $this->primary_registrant ])
-            && $this->subsections[ $this->primary_registrant ] instanceof EE_Form_Section_Proper
-        ) {
-            $this->subsections[ $this->primary_registrant ]->add_subsections(
-                [
-                    'spco_copy_attendee_chk' => $this->print_copy_info
-                        ? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
-                        : new AutoCopyAttendeeInfoForm($this->reg_step->slug()),
-                ],
-                'primary_registrant',
-                false
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    private function addPrivacyConsentCheckbox(): void
-    {
-        // if this isn't a revisit, and they have the privacy consent box enabled, add it
-        if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
-            $this->subsections['consent_box'] = new PrivacyConsentCheckboxForm(
-                $this->reg_step->slug(),
-                $this->reg_config->getConsentCheckboxLabelText()
-            );
-        }
-    }
-
-
-    private function displayEventQuestionsLink()
-    {
-        $this->subsections['event_questions_link'] = new EE_Form_Section_HTML(
-            EEH_HTML::div(
-                EEH_HTML::link(
-                    '',
-                    esc_html__('show event questions', 'event_espresso'),
-                    esc_html__('show event questions', 'event_espresso'),
-                    'spco-display-event-questions-lnk',
-                    'act-like-link smaller-text hidden hide-if-no-js float-right'
-                ),
-                '',
-                'clearfix'
-            )
-        );
-    }
+	private EE_Line_Item_Display $line_item_display;
+
+	private string $primary_registrant = '';
+
+	private array $required_questions = [];
+
+	private array $subsections = [];
+
+
+	private bool $print_copy_info = false;
+
+	protected int $reg_form_count = 0;
+
+	public EE_Registration_Config $reg_config;
+
+	public EE_SPCO_Reg_Step_Attendee_Information $reg_step;
+
+
+	/**
+	 * RegForm constructor.
+	 *
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration_Config                $reg_config
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration_Config $reg_config
+	) {
+		$this->reg_step   = $reg_step;
+		$this->reg_config = $reg_config;
+		// setup some classes so that they are ready for loading during construction of other classes
+		LoaderFactory::getShared(CountryOptions::class, [$this->reg_step->checkout->action]);
+		LoaderFactory::getShared(StateOptions::class, [$this->reg_step->checkout->action]);
+		LoaderFactory::getShared(RegFormQuestionFactory::class, [[$this, 'addRequiredQuestion']]);
+		parent::__construct(
+			[
+				'name'            => $this->reg_step->reg_form_name(),
+				'html_id'         => $this->reg_step->reg_form_name(),
+				'layout_strategy' => new EE_No_Layout(),
+				'subsections'     => $this->generateSubsections(),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function enablePrintCopyInfo(): void
+	{
+		$this->print_copy_info = true;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function printCopyInfo(): bool
+	{
+		return $this->print_copy_info;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function regFormCount(): int
+	{
+		return $this->reg_form_count;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function requiredQuestions(): array
+	{
+		return $this->required_questions;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @param string $required_question
+	 */
+	public function addRequiredQuestion(string $identifier, string $required_question): void
+	{
+		$this->required_questions[ $identifier ] = $required_question;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper[]
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function generateSubsections(): array
+	{
+		$this->configureLineItemDisplay();
+		$this->addAttendeeInformationNotice();
+
+		$this->subsections["ticket-details"] = new TicketDetailsTable(
+			$this->reg_step->checkout->cart->get_grand_total(),
+			$this->line_item_display,
+			$this->reg_step->checkout->revisit
+		);
+
+		// grab the saved registrations from the transaction
+		$registrations = $this->reg_step->checkout->transaction->registrations(
+			$this->reg_step->checkout->reg_cache_where_params
+		);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
+				if (! $registration instanceof EE_Registration) {
+					continue;
+				}
+				$this->subsections["ticket-details"]->addTicket($registration->ticket());
+				$this->addAttendeeRegForm($registration);
+			}
+			$this->addCopyAttendeeInfoForm($registrations);
+		}
+		$this->addPrivacyConsentCheckbox();
+		$this->displayEventQuestionsLink();
+		$this->subsections['default_hidden_inputs']  =  $this->reg_step->reg_step_hidden_inputs();
+
+		return (array) apply_filters(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegForm__generateSubsections__subsections',
+			$this->subsections,
+			$this
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function configureLineItemDisplay()
+	{
+		// autoload Line_Item_Display classes
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$this->line_item_display = new EE_Line_Item_Display();
+		// calculate taxes
+		$this->line_item_display->display_line_item(
+			$this->reg_step->checkout->cart->get_grand_total(),
+			['set_tax_rate' => true]
+		);
+	}
+
+
+	private function addAttendeeInformationNotice(): void
+	{
+		if (is_admin()) {
+			return;
+		}
+		$this->subsections['attendee_information_notice'] = new AttendeeInformationNotice();
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function addAttendeeRegForm(EE_Registration $registration): void
+	{
+		// can this registration be processed during this visit ?
+		if (! $this->reg_step->checkout->visit_allows_processing_of_this_registration($registration)) {
+			return;
+		}
+		$reg_url_link = $registration->reg_url_link();
+		if ($registration->is_primary_registrant()) {
+			$this->primary_registrant = $reg_url_link;
+		}
+
+		/** @var AttendeeRegForm $registrant_form */
+		$registrant_form = LoaderFactory::getNew(
+			AttendeeRegForm::class,
+			[
+				$registration,
+				$this->reg_config->copyAttendeeInfo(),
+				[$this, 'enablePrintCopyInfo'],
+				$this->reg_step,
+			]
+		);
+
+		// skip section if there are no questions
+		if (! $registrant_form->hasQuestions()) {
+			return;
+		}
+
+		// but increment the reg form count if form is valid.
+		$this->reg_form_count++;
+		$this->subsections["panel-div-open-$reg_url_link"]  = new EE_Form_Section_HTML(
+			EEH_HTML::div(
+				'',
+				"spco-attendee-panel-dv-$reg_url_link",
+				"spco-attendee-panel-dv spco-attendee-ticket-$reg_url_link"
+			)
+		);
+		$this->subsections["event-header-$reg_url_link"]    = new EventHeader($registration->event());
+		$this->subsections[ $reg_url_link ]                 = $registrant_form;
+		$this->subsections["panel-div-close-$reg_url_link"] = new EE_Form_Section_HTML(
+			EEH_HTML::divx("spco-attendee-panel-dv-$reg_url_link")
+		);
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	private function addCopyAttendeeInfoForm(array $registrations)
+	{
+		if (
+			$this->primary_registrant
+			&& count($registrations) > 1
+			&& isset($this->subsections[ $this->primary_registrant ])
+			&& $this->subsections[ $this->primary_registrant ] instanceof EE_Form_Section_Proper
+		) {
+			$this->subsections[ $this->primary_registrant ]->add_subsections(
+				[
+					'spco_copy_attendee_chk' => $this->print_copy_info
+						? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
+						: new AutoCopyAttendeeInfoForm($this->reg_step->slug()),
+				],
+				'primary_registrant',
+				false
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function addPrivacyConsentCheckbox(): void
+	{
+		// if this isn't a revisit, and they have the privacy consent box enabled, add it
+		if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
+			$this->subsections['consent_box'] = new PrivacyConsentCheckboxForm(
+				$this->reg_step->slug(),
+				$this->reg_config->getConsentCheckboxLabelText()
+			);
+		}
+	}
+
+
+	private function displayEventQuestionsLink()
+	{
+		$this->subsections['event_questions_link'] = new EE_Form_Section_HTML(
+			EEH_HTML::div(
+				EEH_HTML::link(
+					'',
+					esc_html__('show event questions', 'event_espresso'),
+					esc_html__('show event questions', 'event_espresso'),
+					'spco-display-event-questions-lnk',
+					'act-like-link smaller-text hidden hide-if-no-js float-right'
+				),
+				'',
+				'clearfix'
+			)
+		);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -127,7 +127,7 @@ 
      */
     public function addRequiredQuestion(string $identifier, string $required_question): void
     {
-        $this->required_questions[ $identifier ] = $required_question;
+        $this->required_questions[$identifier] = $required_question;
     }
 
 
@@ -158,7 +158,7 @@ 
         );
         if ($registrations) {
             foreach ($registrations as $registration) {
-                if (! $registration instanceof EE_Registration) {
+                if ( ! $registration instanceof EE_Registration) {
                     continue;
                 }
                 $this->subsections["ticket-details"]->addTicket($registration->ticket());
@@ -168,7 +168,7 @@ 
         }
         $this->addPrivacyConsentCheckbox();
         $this->displayEventQuestionsLink();
-        $this->subsections['default_hidden_inputs']  =  $this->reg_step->reg_step_hidden_inputs();
+        $this->subsections['default_hidden_inputs'] = $this->reg_step->reg_step_hidden_inputs();
 
         return (array) apply_filters(
             'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegForm__generateSubsections__subsections',
@@ -212,7 +212,7 @@ 
     private function addAttendeeRegForm(EE_Registration $registration): void
     {
         // can this registration be processed during this visit ?
-        if (! $this->reg_step->checkout->visit_allows_processing_of_this_registration($registration)) {
+        if ( ! $this->reg_step->checkout->visit_allows_processing_of_this_registration($registration)) {
             return;
         }
         $reg_url_link = $registration->reg_url_link();
@@ -232,13 +232,13 @@ 
         );
 
         // skip section if there are no questions
-        if (! $registrant_form->hasQuestions()) {
+        if ( ! $registrant_form->hasQuestions()) {
             return;
         }
 
         // but increment the reg form count if form is valid.
         $this->reg_form_count++;
-        $this->subsections["panel-div-open-$reg_url_link"]  = new EE_Form_Section_HTML(
+        $this->subsections["panel-div-open-$reg_url_link"] = new EE_Form_Section_HTML(
             EEH_HTML::div(
                 '',
                 "spco-attendee-panel-dv-$reg_url_link",
@@ -246,7 +246,7 @@ 
             )
         );
         $this->subsections["event-header-$reg_url_link"]    = new EventHeader($registration->event());
-        $this->subsections[ $reg_url_link ]                 = $registrant_form;
+        $this->subsections[$reg_url_link]                 = $registrant_form;
         $this->subsections["panel-div-close-$reg_url_link"] = new EE_Form_Section_HTML(
             EEH_HTML::divx("spco-attendee-panel-dv-$reg_url_link")
         );
@@ -262,10 +262,10 @@ 
         if (
             $this->primary_registrant
             && count($registrations) > 1
-            && isset($this->subsections[ $this->primary_registrant ])
-            && $this->subsections[ $this->primary_registrant ] instanceof EE_Form_Section_Proper
+            && isset($this->subsections[$this->primary_registrant])
+            && $this->subsections[$this->primary_registrant] instanceof EE_Form_Section_Proper
         ) {
-            $this->subsections[ $this->primary_registrant ]->add_subsections(
+            $this->subsections[$this->primary_registrant]->add_subsections(
                 [
                     'spco_copy_attendee_chk' => $this->print_copy_info
                         ? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
@@ -285,7 +285,7 @@ 
     private function addPrivacyConsentCheckbox(): void
     {
         // if this isn't a revisit, and they have the privacy consent box enabled, add it
-        if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
+        if ( ! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
             $this->subsections['consent_box'] = new PrivacyConsentCheckboxForm(
                 $this->reg_step->slug(),
                 $this->reg_config->getConsentCheckboxLabelText()

core/domain/services/registration/form/v1/subsections/TicketDetailsTable.php

Indentation +111 added lines, -111 removed lines

@@ -13,115 +13,115 @@
 
 class TicketDetailsTable extends EE_Form_Section_HTML
 {
-    private EE_Line_Item $cart_grand_total;
-    private EE_Line_Item_Display $line_item_display;
-
-    private bool $revisit;
-
-    private array $tickets = [];
-
-    private static array $ticket_line_item_options = [
-        'extra_css' => [
-            'row' => 'ee-ticket-details-row',
-            'name' => 'ee-ticket-details-name',
-            'qty' => 'ee-ticket-details-qty',
-            'price' => 'ee-ticket-details-price',
-            'total' => 'ee-ticket-details-total',
-        ]
-    ];
-
-
-    /**
-     * @param EE_Line_Item $cart_grand_total
-     * @param EE_Line_Item_Display $line_item_display
-     * @param bool      $revisit
-     */
-    public function __construct(EE_Line_Item $cart_grand_total, EE_Line_Item_Display $line_item_display, bool $revisit)
-    {
-        $this->cart_grand_total = $cart_grand_total;
-        $this->line_item_display = $line_item_display;
-        $this->revisit = $revisit;
-        parent::__construct();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function addTicket(EE_Ticket $ticket): void
-    {
-        if (! isset($this->tickets[ $ticket->ID() ])) {
-            $this->tickets[ $ticket->ID() ] = $ticket;
-        }
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function get_html(): string
-    {
-        if ($this->revisit) {
-            return '';
-        }
-        $table_rows = '';
-        foreach ($this->tickets as $ticket) {
-            $table_rows .= $this->generateTicketDetailsTableRow($ticket);
-        }
-        return $this->generateTicketDetailsTable($table_rows);
-    }
-
-
-    /**
-     * @param string $table_rows
-     * @return string
-     */
-    private function generateTicketDetailsTable(string $table_rows): string
-    {
-
-        return EEH_HTML::div(
-            EEH_HTML::table(
-                EEH_HTML::thead(
-                    EEH_HTML::tr(
-                        EEH_HTML::th('', '', 'ee-ticket-details-name jst-left')
-                        . EEH_HTML::th(esc_html__('Qty', 'event_espresso'), '', 'ee-ticket-details-qty jst-rght')
-                        . EEH_HTML::th(esc_html__('Price', 'event_espresso'), '', 'ee-ticket-details-price jst-rght')
-                        . EEH_HTML::th(esc_html__('Total', 'event_espresso'), '', 'ee-ticket-details-total jst-rght'),
-                    )
-                )
-                . EEH_HTML::tbody($table_rows),
-                '',
-                'spco-ticket-details'
-            ),
-            '',
-            'spco-ticket-info-dv'
-        );
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function generateTicketDetailsTableRow(EE_Ticket $ticket): string
-    {
-        $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $this->cart_grand_total,
-            'Ticket',
-            [$ticket->ID()]
-        );
-        $ticket_line_item = ! empty($ticket_line_item) ? reset($ticket_line_item) : $ticket_line_item;
-
-        $ticket_line_item_options = self::$ticket_line_item_options;
-        $ticket_line_item_options['extra_css']['row'] = "ticket-details-{$ticket->ID()}";
-
-
-        return $ticket_line_item instanceof EE_Line_Item
-            ? $this->line_item_display->display_line_item($ticket_line_item, $ticket_line_item_options)
-            : '';
-    }
+	private EE_Line_Item $cart_grand_total;
+	private EE_Line_Item_Display $line_item_display;
+
+	private bool $revisit;
+
+	private array $tickets = [];
+
+	private static array $ticket_line_item_options = [
+		'extra_css' => [
+			'row' => 'ee-ticket-details-row',
+			'name' => 'ee-ticket-details-name',
+			'qty' => 'ee-ticket-details-qty',
+			'price' => 'ee-ticket-details-price',
+			'total' => 'ee-ticket-details-total',
+		]
+	];
+
+
+	/**
+	 * @param EE_Line_Item $cart_grand_total
+	 * @param EE_Line_Item_Display $line_item_display
+	 * @param bool      $revisit
+	 */
+	public function __construct(EE_Line_Item $cart_grand_total, EE_Line_Item_Display $line_item_display, bool $revisit)
+	{
+		$this->cart_grand_total = $cart_grand_total;
+		$this->line_item_display = $line_item_display;
+		$this->revisit = $revisit;
+		parent::__construct();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function addTicket(EE_Ticket $ticket): void
+	{
+		if (! isset($this->tickets[ $ticket->ID() ])) {
+			$this->tickets[ $ticket->ID() ] = $ticket;
+		}
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function get_html(): string
+	{
+		if ($this->revisit) {
+			return '';
+		}
+		$table_rows = '';
+		foreach ($this->tickets as $ticket) {
+			$table_rows .= $this->generateTicketDetailsTableRow($ticket);
+		}
+		return $this->generateTicketDetailsTable($table_rows);
+	}
+
+
+	/**
+	 * @param string $table_rows
+	 * @return string
+	 */
+	private function generateTicketDetailsTable(string $table_rows): string
+	{
+
+		return EEH_HTML::div(
+			EEH_HTML::table(
+				EEH_HTML::thead(
+					EEH_HTML::tr(
+						EEH_HTML::th('', '', 'ee-ticket-details-name jst-left')
+						. EEH_HTML::th(esc_html__('Qty', 'event_espresso'), '', 'ee-ticket-details-qty jst-rght')
+						. EEH_HTML::th(esc_html__('Price', 'event_espresso'), '', 'ee-ticket-details-price jst-rght')
+						. EEH_HTML::th(esc_html__('Total', 'event_espresso'), '', 'ee-ticket-details-total jst-rght'),
+					)
+				)
+				. EEH_HTML::tbody($table_rows),
+				'',
+				'spco-ticket-details'
+			),
+			'',
+			'spco-ticket-info-dv'
+		);
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function generateTicketDetailsTableRow(EE_Ticket $ticket): string
+	{
+		$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$this->cart_grand_total,
+			'Ticket',
+			[$ticket->ID()]
+		);
+		$ticket_line_item = ! empty($ticket_line_item) ? reset($ticket_line_item) : $ticket_line_item;
+
+		$ticket_line_item_options = self::$ticket_line_item_options;
+		$ticket_line_item_options['extra_css']['row'] = "ticket-details-{$ticket->ID()}";
+
+
+		return $ticket_line_item instanceof EE_Line_Item
+			? $this->line_item_display->display_line_item($ticket_line_item, $ticket_line_item_options)
+			: '';
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -51,8 +51,8 @@
      */
     public function addTicket(EE_Ticket $ticket): void
     {
-        if (! isset($this->tickets[ $ticket->ID() ])) {
-            $this->tickets[ $ticket->ID() ] = $ticket;
+        if ( ! isset($this->tickets[$ticket->ID()])) {
+            $this->tickets[$ticket->ID()] = $ticket;
         }
     }
 

core/helpers/EEH_HTML.helper.php

Indentation +940 added lines, -940 removed lines

@@ -15,944 +15,944 @@
  */
 class EEH_HTML
 {
-    private static ?EEH_HTML $_instance = null;
-
-    /**
-     * some initial formatting for table indentation
-     *
-     * @var int[]
-     */
-    private static array $_indent = [
-        'table' => 0,
-        'thead' => 1,
-        'tbody' => 1,
-        'tr'    => 2,
-        'th'    => 3,
-        'td'    => 3,
-        'div'   => 0,
-        'h1'    => 0,
-        'h2'    => 0,
-        'h3'    => 0,
-        'h4'    => 0,
-        'h5'    => 0,
-        'h6'    => 0,
-        'p'     => 0,
-        'ul'    => 0,
-        'li'    => 1,
-    ];
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EEH_HTML
-     */
-    public static function instance(): EEH_HTML
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_HTML) {
-            self::$_instance = new EEH_HTML();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Generates an opening HTML <XX> tag and adds any passed attributes
-     * if passed content, it will also add that, as well as the closing </XX> tag
-     *
-     * @param string $tag
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @param bool   $force_close
-     * @return string
-     */
-    protected static function _open_tag(
-        string $tag = 'div',
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = '',
-        bool $force_close = false
-    ): string {
-        $attributes = ! empty($id) ? ' id="' . trim(EEH_HTML::sanitize_id($id)) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . trim($class) . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . trim($style) . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . trim($other_attributes) : '';
-        $html       = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
-        $html       .= trim($content) !== '' ? EEH_HTML::nl(1, $tag) . $content : '';
-        $indent     = ! empty($content) || $force_close;
-        $html       .= ! empty($content) || $force_close
-            ? EEH_HTML::_close_tag($tag, $id, $class, $indent, $content)
-            : '';
-        return $html;
-    }
-
-
-    /**
-     * Generates HTML closing </XX> tag - if passed the id or class attribute
-     * used for the opening tag, will append a comment
-     *
-     * @access protected
-     * @param string $tag
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @param bool   $indent
-     * @param string $content
-     * @return string
-     */
-    protected static function _close_tag(
-        string $tag = 'div',
-        string $id = '',
-        string $class = '',
-        bool $indent = true,
-        string $content = ''
-    ): string {
-        $alotta_content = strlen($content) > 500;
-        $comment         = '';
-        if ($id && $alotta_content) {
-            $comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
-        } elseif ($class && $alotta_content) {
-            $comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
-        }
-        $html = $indent ? EEH_HTML::nl(-1, $tag) : '';
-        $html .= '</' . $tag . '>' . $comment;
-        return $html;
-    }
-
-
-    /**
-     *  div - generates HTML opening <div> tag and adds any passed attributes
-     *  to add an id use:       echo EEH_HTML::div( 'this is some content', 'footer' );
-     *  to add a class use:     echo EEH_HTML::div( 'this is some content', '', 'float_left' );
-     *  to add a both an id and a class use:    echo EEH_HTML::div( 'this is some content', 'footer', 'float_left' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function div(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('div', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML closing </div> tag - if passed the id or class attribute used for the opening div tag, will
-     * append a comment usage: echo EEH_HTML::divx();
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function divx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('div', $id, $class);
-    }
-
-
-    /**
-     * Generates HTML <h1></h1> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h1( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h1(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h1', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h2></h2> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h2( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h2(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h2', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h3></h3> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h3( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h3(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h3', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h4></h4> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h4( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h4(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h4', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h5></h5> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h5( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h5(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h5', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h6></h6> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h6( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h6(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h6', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <p></p> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::p( 'this is a paragraph' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function p(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('p', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     *  ul - generates HTML opening <ul> tag and adds any passed attributes
-     *  usage:      echo EEH_HTML::ul( 'my-list-id', 'my-list-class' );
-     *
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function ul(
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('ul', '', $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML closing </ul> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment usage: echo EEH_HTML::ulx();
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function ulx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('ul', $id, $class);
-    }
-
-
-    /**
-     * Generates HTML <li> tag, inserts content, and adds any passed attributes
-     * if passed content, it will also add that, as well as the closing </li> tag
-     * usage: echo EEH_HTML::li( 'this is a line item' );
-     *
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function li(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('li', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML closing </li> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment usage: echo EEH_HTML::lix();
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function lix(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('li', $id, $class);
-    }
-
-
-    /**
-     *    table - generates an HTML <table> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::table();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function table(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('table', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * tablex - generates an HTML </table> tag - if passed the id or class attribute used for the opening ul tag, will
-     * append a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tablex(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('table', $id, $class);
-    }
-
-
-    /**
-     *    thead - generates an HTML <thead> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::thead();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function thead(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('thead', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * theadx - generates an HTML </thead> tag - if passed the id or class attribute used for the opening ul tag, will
-     * append a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function theadx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('thead', $id, $class);
-    }
-
-
-    /**
-     *    tbody - generates an HTML <tbody> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::tbody();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function tbody(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('tbody', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * tbodyx - generates an HTML </tbody> tag - if passed the id or class attribute used for the opening ul tag, will
-     * append a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tbodyx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('tbody', $id, $class);
-    }
-
-
-    /**
-     *    tr - generates an HTML <tr> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::tr();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function tr(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('tr', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * trx - generates an HTML </tr> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function trx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('tr', $id, $class);
-    }
-
-
-    /**
-     *    th - generates an HTML <th> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::th();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function th(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = 'scope="col"'
-    ): string {
-        return EEH_HTML::_open_tag('th', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * thx - generates an HTML </th> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function thx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('th', $id, $class);
-    }
-
-
-    /**
-     *    td - generates an HTML <td> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::td();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function td(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('td', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * tdx - generates an HTML </td> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tdx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('td', $id, $class);
-    }
-
-
-    /**
-     * no_row - for generating a "hidden" table row, good for embedding tables within tables
-     * generates a new table row with one td cell that spans however many columns you set
-     * removes all styles from the tr and td
-     *
-     * @param string $content
-     * @param int    $colspan
-     * @return string
-     */
-    public static function no_row(string $content = '', int $colspan = 2): string
-    {
-        return EEH_HTML::tr(
-            EEH_HTML::td($content, '', '', '', 'colspan="' . $colspan . '"'),
-            '',
-            'ee-no-row'
-        );
-    }
-
-
-    /**
-     * Generates HTML <a href="url">text</a> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::link( 'domain.com', 'this is a link' );
-     *
-     * @param string $href             URL to link to
-     * @param string $link_text        - the text that will become "hyperlinked"
-     * @param string $title            - html title attribute
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function link(
-        string $href = '',
-        string $link_text = '',
-        string $title = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        $link_text  = ! empty($link_text) ? $link_text : $href;
-        $attributes = ! empty($href) ? ' href="' . $href . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return "<a$attributes>$link_text</a>";
-    }
-
-
-    /**
-     * Generates HTML <button>text</button> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::button( 'this is a button' );
-     *
-     * @param string $btn_text         - the text that will become "hyperlinked"
-     * @param string $class            - html class attribute
-     * @param string $aria_label       - aria-label attribute
-     * @param string $id               - html id attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function button(
-        string $btn_text = '',
-        string $class = '',
-        string $aria_label = '',
-        string $id = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        $attributes = ! empty($aria_label) ? ' aria-label="' . $aria_label . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return "<button type='button' $attributes>$btn_text</button>";
-    }
-
-
-    /**
-     *    img - generates an HTML <img> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::img();
-     *
-     * @param string $src              - html src attribute ie: the path or URL to the image
-     * @param string $alt              - html alt attribute
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function img(
-        string $src = '',
-        string $alt = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        $attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
-        $attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<img' . $attributes . '/>';
-    }
-
-
-    /**
-     * Generates HTML <tag></tag> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $tag
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    protected static function _inline_tag(
-        string $tag = 'span',
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<' . $tag . ' ' . $attributes . '>' . $content . '</' . $tag . '>';
-    }
-
-
-    /**
-     * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function label(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_inline_tag('label', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function span(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_inline_tag('span', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function strong(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_inline_tag('strong', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates an html <--  comment --> tag
-     *  usage: echo comment( 'this is a comment' );
-     *
-     * @param string $comment
-     * @return string
-     */
-    public static function comment(string $comment = ''): string
-    {
-        return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
-    }
-
-
-    /**
-     * br - generates a line break
-     *
-     * @param int $number - the number of line breaks to return
-     * @return string
-     */
-    public static function br(int $number = 1): string
-    {
-        return str_repeat('<br />', $number);
-    }
-
-
-    /**
-     * nbsp - generates non-breaking space entities based on number supplied
-     *
-     * @param int $number - the number of non-breaking spaces to return
-     * @return string
-     */
-    public static function nbsp(int $number = 1): string
-    {
-        return str_repeat('&nbsp;', $number);
-    }
-
-
-    /**
-     * sanitize_id
-     * functionally does the same as the wp_core function sanitize_key except it does NOT use
-     * strtolower and allows capitals.
-     *
-     * @param string $id
-     * @return string
-     */
-    public static function sanitize_id(string $id = ''): string
-    {
-        $key = str_replace(' ', '-', trim($id));
-        return preg_replace('/[^a-zA-Z0-9_\-]/', '', $key);
-    }
-
-
-    /**
-     * return a newline and tabs ("nl" stands for "new line")
-     *
-     * @param int    $indent the number of tabs to ADD to the current indent (can be negative or zero)
-     * @param string $tag
-     * @return string - newline character plus # of indents passed (can be + or -)
-     */
-    public static function nl(int $indent = 0, string $tag = 'none'): string
-    {
-        $html = "\n";
-        EEH_HTML::indent($indent, $tag);
-        $html .= str_repeat("\t", EEH_HTML::$_indent[ $tag ]);
-        return $html;
-    }
-
-
-    /**
-     * Changes the indents used in EEH_HTML::nl. Often it's convenient to change
-     * the indentation level without actually creating a new line
-     *
-     * @param int    $indent can be negative to decrease the indentation level
-     * @param string $tag
-     */
-    public static function indent(int $indent, string $tag = 'none')
-    {
-        static $default_indentation = false;
-        if (! $default_indentation) {
-            EEH_HTML::_set_default_indentation();
-            $default_indentation = true;
-        }
-        if (! isset(EEH_HTML::$_indent[ $tag ])) {
-            EEH_HTML::$_indent[ $tag ] = 0;
-        }
-        EEH_HTML::$_indent[ $tag ] += $indent;
-        EEH_HTML::$_indent[ $tag ] = max(EEH_HTML::$_indent[ $tag ], 0);
-    }
-
-
-    /**
-     *  class _set_default_indentation
-     */
-    private static function _set_default_indentation()
-    {
-        // set some initial formatting for table indentation
-        EEH_HTML::$_indent = [
-            'none'     => 0,
-            'form'     => 0,
-            'radio'    => 0,
-            'checkbox' => 0,
-            'select'   => 0,
-            'option'   => 0,
-            'optgroup' => 0,
-            'table'    => 1,
-            'thead'    => 2,
-            'tbody'    => 2,
-            'tr'       => 3,
-            'th'       => 4,
-            'td'       => 4,
-            'div'      => 0,
-            'h1'       => 0,
-            'h2'       => 0,
-            'h3'       => 0,
-            'h4'       => 0,
-            'h5'       => 0,
-            'h6'       => 0,
-            'p'        => 0,
-            'ul'       => 0,
-            'li'       => 1,
-        ];
-    }
-
-
-    /**
-     * Retrieves the list of tags considered "simple", that are probably safe for
-     * use in inputs
-     *
-     * @return array
-     * @global array $allowedtags
-     */
-    public static function get_simple_tags(): array
-    {
-        global $allowedtags;
-        $tags_we_allow = array_merge_recursive(
-            $allowedtags,
-            [
-                'ol' => [],
-                'ul' => [],
-                'li' => [],
-                'br' => [],
-                'p'  => [],
-                'a'  => ['target'],
-            ]
-        );
-        return apply_filters('FHEE__EEH_HTML__get_simple_tags', $tags_we_allow);
-    }
+	private static ?EEH_HTML $_instance = null;
+
+	/**
+	 * some initial formatting for table indentation
+	 *
+	 * @var int[]
+	 */
+	private static array $_indent = [
+		'table' => 0,
+		'thead' => 1,
+		'tbody' => 1,
+		'tr'    => 2,
+		'th'    => 3,
+		'td'    => 3,
+		'div'   => 0,
+		'h1'    => 0,
+		'h2'    => 0,
+		'h3'    => 0,
+		'h4'    => 0,
+		'h5'    => 0,
+		'h6'    => 0,
+		'p'     => 0,
+		'ul'    => 0,
+		'li'    => 1,
+	];
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EEH_HTML
+	 */
+	public static function instance(): EEH_HTML
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_HTML) {
+			self::$_instance = new EEH_HTML();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Generates an opening HTML <XX> tag and adds any passed attributes
+	 * if passed content, it will also add that, as well as the closing </XX> tag
+	 *
+	 * @param string $tag
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @param bool   $force_close
+	 * @return string
+	 */
+	protected static function _open_tag(
+		string $tag = 'div',
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = '',
+		bool $force_close = false
+	): string {
+		$attributes = ! empty($id) ? ' id="' . trim(EEH_HTML::sanitize_id($id)) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . trim($class) . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . trim($style) . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . trim($other_attributes) : '';
+		$html       = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
+		$html       .= trim($content) !== '' ? EEH_HTML::nl(1, $tag) . $content : '';
+		$indent     = ! empty($content) || $force_close;
+		$html       .= ! empty($content) || $force_close
+			? EEH_HTML::_close_tag($tag, $id, $class, $indent, $content)
+			: '';
+		return $html;
+	}
+
+
+	/**
+	 * Generates HTML closing </XX> tag - if passed the id or class attribute
+	 * used for the opening tag, will append a comment
+	 *
+	 * @access protected
+	 * @param string $tag
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @param bool   $indent
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function _close_tag(
+		string $tag = 'div',
+		string $id = '',
+		string $class = '',
+		bool $indent = true,
+		string $content = ''
+	): string {
+		$alotta_content = strlen($content) > 500;
+		$comment         = '';
+		if ($id && $alotta_content) {
+			$comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
+		} elseif ($class && $alotta_content) {
+			$comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
+		}
+		$html = $indent ? EEH_HTML::nl(-1, $tag) : '';
+		$html .= '</' . $tag . '>' . $comment;
+		return $html;
+	}
+
+
+	/**
+	 *  div - generates HTML opening <div> tag and adds any passed attributes
+	 *  to add an id use:       echo EEH_HTML::div( 'this is some content', 'footer' );
+	 *  to add a class use:     echo EEH_HTML::div( 'this is some content', '', 'float_left' );
+	 *  to add a both an id and a class use:    echo EEH_HTML::div( 'this is some content', 'footer', 'float_left' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function div(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('div', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML closing </div> tag - if passed the id or class attribute used for the opening div tag, will
+	 * append a comment usage: echo EEH_HTML::divx();
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function divx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('div', $id, $class);
+	}
+
+
+	/**
+	 * Generates HTML <h1></h1> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h1( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h1(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h1', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h2></h2> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h2( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h2(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h2', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h3></h3> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h3( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h3(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h3', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h4></h4> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h4( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h4(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h4', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h5></h5> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h5( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h5(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h5', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h6></h6> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h6( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h6(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h6', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <p></p> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::p( 'this is a paragraph' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function p(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('p', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 *  ul - generates HTML opening <ul> tag and adds any passed attributes
+	 *  usage:      echo EEH_HTML::ul( 'my-list-id', 'my-list-class' );
+	 *
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function ul(
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('ul', '', $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML closing </ul> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment usage: echo EEH_HTML::ulx();
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function ulx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('ul', $id, $class);
+	}
+
+
+	/**
+	 * Generates HTML <li> tag, inserts content, and adds any passed attributes
+	 * if passed content, it will also add that, as well as the closing </li> tag
+	 * usage: echo EEH_HTML::li( 'this is a line item' );
+	 *
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function li(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('li', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML closing </li> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment usage: echo EEH_HTML::lix();
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function lix(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('li', $id, $class);
+	}
+
+
+	/**
+	 *    table - generates an HTML <table> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::table();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function table(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('table', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * tablex - generates an HTML </table> tag - if passed the id or class attribute used for the opening ul tag, will
+	 * append a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tablex(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('table', $id, $class);
+	}
+
+
+	/**
+	 *    thead - generates an HTML <thead> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::thead();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function thead(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('thead', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * theadx - generates an HTML </thead> tag - if passed the id or class attribute used for the opening ul tag, will
+	 * append a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function theadx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('thead', $id, $class);
+	}
+
+
+	/**
+	 *    tbody - generates an HTML <tbody> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::tbody();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function tbody(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('tbody', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * tbodyx - generates an HTML </tbody> tag - if passed the id or class attribute used for the opening ul tag, will
+	 * append a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tbodyx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('tbody', $id, $class);
+	}
+
+
+	/**
+	 *    tr - generates an HTML <tr> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::tr();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function tr(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('tr', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * trx - generates an HTML </tr> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function trx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('tr', $id, $class);
+	}
+
+
+	/**
+	 *    th - generates an HTML <th> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::th();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function th(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = 'scope="col"'
+	): string {
+		return EEH_HTML::_open_tag('th', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * thx - generates an HTML </th> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function thx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('th', $id, $class);
+	}
+
+
+	/**
+	 *    td - generates an HTML <td> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::td();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function td(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('td', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * tdx - generates an HTML </td> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tdx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('td', $id, $class);
+	}
+
+
+	/**
+	 * no_row - for generating a "hidden" table row, good for embedding tables within tables
+	 * generates a new table row with one td cell that spans however many columns you set
+	 * removes all styles from the tr and td
+	 *
+	 * @param string $content
+	 * @param int    $colspan
+	 * @return string
+	 */
+	public static function no_row(string $content = '', int $colspan = 2): string
+	{
+		return EEH_HTML::tr(
+			EEH_HTML::td($content, '', '', '', 'colspan="' . $colspan . '"'),
+			'',
+			'ee-no-row'
+		);
+	}
+
+
+	/**
+	 * Generates HTML <a href="url">text</a> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::link( 'domain.com', 'this is a link' );
+	 *
+	 * @param string $href             URL to link to
+	 * @param string $link_text        - the text that will become "hyperlinked"
+	 * @param string $title            - html title attribute
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function link(
+		string $href = '',
+		string $link_text = '',
+		string $title = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		$link_text  = ! empty($link_text) ? $link_text : $href;
+		$attributes = ! empty($href) ? ' href="' . $href . '"' : '';
+		$attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return "<a$attributes>$link_text</a>";
+	}
+
+
+	/**
+	 * Generates HTML <button>text</button> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::button( 'this is a button' );
+	 *
+	 * @param string $btn_text         - the text that will become "hyperlinked"
+	 * @param string $class            - html class attribute
+	 * @param string $aria_label       - aria-label attribute
+	 * @param string $id               - html id attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function button(
+		string $btn_text = '',
+		string $class = '',
+		string $aria_label = '',
+		string $id = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		$attributes = ! empty($aria_label) ? ' aria-label="' . $aria_label . '"' : '';
+		$attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return "<button type='button' $attributes>$btn_text</button>";
+	}
+
+
+	/**
+	 *    img - generates an HTML <img> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::img();
+	 *
+	 * @param string $src              - html src attribute ie: the path or URL to the image
+	 * @param string $alt              - html alt attribute
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function img(
+		string $src = '',
+		string $alt = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		$attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
+		$attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
+		$attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return '<img' . $attributes . '/>';
+	}
+
+
+	/**
+	 * Generates HTML <tag></tag> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $tag
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	protected static function _inline_tag(
+		string $tag = 'span',
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		$attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return '<' . $tag . ' ' . $attributes . '>' . $content . '</' . $tag . '>';
+	}
+
+
+	/**
+	 * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function label(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_inline_tag('label', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function span(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_inline_tag('span', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function strong(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_inline_tag('strong', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates an html <--  comment --> tag
+	 *  usage: echo comment( 'this is a comment' );
+	 *
+	 * @param string $comment
+	 * @return string
+	 */
+	public static function comment(string $comment = ''): string
+	{
+		return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
+	}
+
+
+	/**
+	 * br - generates a line break
+	 *
+	 * @param int $number - the number of line breaks to return
+	 * @return string
+	 */
+	public static function br(int $number = 1): string
+	{
+		return str_repeat('<br />', $number);
+	}
+
+
+	/**
+	 * nbsp - generates non-breaking space entities based on number supplied
+	 *
+	 * @param int $number - the number of non-breaking spaces to return
+	 * @return string
+	 */
+	public static function nbsp(int $number = 1): string
+	{
+		return str_repeat('&nbsp;', $number);
+	}
+
+
+	/**
+	 * sanitize_id
+	 * functionally does the same as the wp_core function sanitize_key except it does NOT use
+	 * strtolower and allows capitals.
+	 *
+	 * @param string $id
+	 * @return string
+	 */
+	public static function sanitize_id(string $id = ''): string
+	{
+		$key = str_replace(' ', '-', trim($id));
+		return preg_replace('/[^a-zA-Z0-9_\-]/', '', $key);
+	}
+
+
+	/**
+	 * return a newline and tabs ("nl" stands for "new line")
+	 *
+	 * @param int    $indent the number of tabs to ADD to the current indent (can be negative or zero)
+	 * @param string $tag
+	 * @return string - newline character plus # of indents passed (can be + or -)
+	 */
+	public static function nl(int $indent = 0, string $tag = 'none'): string
+	{
+		$html = "\n";
+		EEH_HTML::indent($indent, $tag);
+		$html .= str_repeat("\t", EEH_HTML::$_indent[ $tag ]);
+		return $html;
+	}
+
+
+	/**
+	 * Changes the indents used in EEH_HTML::nl. Often it's convenient to change
+	 * the indentation level without actually creating a new line
+	 *
+	 * @param int    $indent can be negative to decrease the indentation level
+	 * @param string $tag
+	 */
+	public static function indent(int $indent, string $tag = 'none')
+	{
+		static $default_indentation = false;
+		if (! $default_indentation) {
+			EEH_HTML::_set_default_indentation();
+			$default_indentation = true;
+		}
+		if (! isset(EEH_HTML::$_indent[ $tag ])) {
+			EEH_HTML::$_indent[ $tag ] = 0;
+		}
+		EEH_HTML::$_indent[ $tag ] += $indent;
+		EEH_HTML::$_indent[ $tag ] = max(EEH_HTML::$_indent[ $tag ], 0);
+	}
+
+
+	/**
+	 *  class _set_default_indentation
+	 */
+	private static function _set_default_indentation()
+	{
+		// set some initial formatting for table indentation
+		EEH_HTML::$_indent = [
+			'none'     => 0,
+			'form'     => 0,
+			'radio'    => 0,
+			'checkbox' => 0,
+			'select'   => 0,
+			'option'   => 0,
+			'optgroup' => 0,
+			'table'    => 1,
+			'thead'    => 2,
+			'tbody'    => 2,
+			'tr'       => 3,
+			'th'       => 4,
+			'td'       => 4,
+			'div'      => 0,
+			'h1'       => 0,
+			'h2'       => 0,
+			'h3'       => 0,
+			'h4'       => 0,
+			'h5'       => 0,
+			'h6'       => 0,
+			'p'        => 0,
+			'ul'       => 0,
+			'li'       => 1,
+		];
+	}
+
+
+	/**
+	 * Retrieves the list of tags considered "simple", that are probably safe for
+	 * use in inputs
+	 *
+	 * @return array
+	 * @global array $allowedtags
+	 */
+	public static function get_simple_tags(): array
+	{
+		global $allowedtags;
+		$tags_we_allow = array_merge_recursive(
+			$allowedtags,
+			[
+				'ol' => [],
+				'ul' => [],
+				'li' => [],
+				'br' => [],
+				'p'  => [],
+				'a'  => ['target'],
+			]
+		);
+		return apply_filters('FHEE__EEH_HTML__get_simple_tags', $tags_we_allow);
+	}
 }

Spacing +42 added lines, -42 removed lines

@@ -49,7 +49,7 @@ 
     public static function instance(): EEH_HTML
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_HTML) {
+        if ( ! self::$_instance instanceof EEH_HTML) {
             self::$_instance = new EEH_HTML();
         }
         return self::$_instance;
@@ -78,12 +78,12 @@ 
         string $other_attributes = '',
         bool $force_close = false
     ): string {
-        $attributes = ! empty($id) ? ' id="' . trim(EEH_HTML::sanitize_id($id)) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . trim($class) . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . trim($style) . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . trim($other_attributes) : '';
-        $html       = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
-        $html       .= trim($content) !== '' ? EEH_HTML::nl(1, $tag) . $content : '';
+        $attributes = ! empty($id) ? ' id="'.trim(EEH_HTML::sanitize_id($id)).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.trim($class).'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.trim($style).'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.trim($other_attributes) : '';
+        $html       = EEH_HTML::nl(0, $tag).'<'.$tag.$attributes.'>';
+        $html       .= trim($content) !== '' ? EEH_HTML::nl(1, $tag).$content : '';
         $indent     = ! empty($content) || $force_close;
         $html       .= ! empty($content) || $force_close
             ? EEH_HTML::_close_tag($tag, $id, $class, $indent, $content)
@@ -112,14 +112,14 @@ 
         string $content = ''
     ): string {
         $alotta_content = strlen($content) > 500;
-        $comment         = '';
+        $comment = '';
         if ($id && $alotta_content) {
-            $comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
+            $comment = EEH_HTML::comment('close '.$id).EEH_HTML::nl(0, $tag);
         } elseif ($class && $alotta_content) {
-            $comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
+            $comment = EEH_HTML::comment('close '.$class).EEH_HTML::nl(0, $tag);
         }
         $html = $indent ? EEH_HTML::nl(-1, $tag) : '';
-        $html .= '</' . $tag . '>' . $comment;
+        $html .= '</'.$tag.'>'.$comment;
         return $html;
     }
 
@@ -615,7 +615,7 @@ 
     public static function no_row(string $content = '', int $colspan = 2): string
     {
         return EEH_HTML::tr(
-            EEH_HTML::td($content, '', '', '', 'colspan="' . $colspan . '"'),
+            EEH_HTML::td($content, '', '', '', 'colspan="'.$colspan.'"'),
             '',
             'ee-no-row'
         );
@@ -645,12 +645,12 @@ 
         string $other_attributes = ''
     ): string {
         $link_text  = ! empty($link_text) ? $link_text : $href;
-        $attributes = ! empty($href) ? ' href="' . $href . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+        $attributes = ! empty($href) ? ' href="'.$href.'"' : '';
+        $attributes .= ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($title) ? ' title="'.esc_attr($title).'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
         return "<a$attributes>$link_text</a>";
     }
 
@@ -675,11 +675,11 @@ 
         string $style = '',
         string $other_attributes = ''
     ): string {
-        $attributes = ! empty($aria_label) ? ' aria-label="' . $aria_label . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+        $attributes = ! empty($aria_label) ? ' aria-label="'.$aria_label.'"' : '';
+        $attributes .= ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
         return "<button type='button' $attributes>$btn_text</button>";
     }
 
@@ -704,13 +704,13 @@ 
         string $style = '',
         string $other_attributes = ''
     ): string {
-        $attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
-        $attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<img' . $attributes . '/>';
+        $attributes = ! empty($src) ? ' src="'.esc_url_raw($src).'"' : '';
+        $attributes .= ! empty($alt) ? ' alt="'.esc_attr($alt).'"' : '';
+        $attributes .= ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
+        return '<img'.$attributes.'/>';
     }
 
 
@@ -734,11 +734,11 @@ 
         string $style = '',
         string $other_attributes = ''
     ): string {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<' . $tag . ' ' . $attributes . '>' . $content . '</' . $tag . '>';
+        $attributes = ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
+        return '<'.$tag.' '.$attributes.'>'.$content.'</'.$tag.'>';
     }
 
 
@@ -817,7 +817,7 @@ 
      */
     public static function comment(string $comment = ''): string
     {
-        return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
+        return ! empty($comment) ? EEH_HTML::nl().'<!-- '.$comment.' -->' : '';
     }
 
 
@@ -871,7 +871,7 @@ 
     {
         $html = "\n";
         EEH_HTML::indent($indent, $tag);
-        $html .= str_repeat("\t", EEH_HTML::$_indent[ $tag ]);
+        $html .= str_repeat("\t", EEH_HTML::$_indent[$tag]);
         return $html;
     }
 
@@ -886,15 +886,15 @@ 
     public static function indent(int $indent, string $tag = 'none')
     {
         static $default_indentation = false;
-        if (! $default_indentation) {
+        if ( ! $default_indentation) {
             EEH_HTML::_set_default_indentation();
             $default_indentation = true;
         }
-        if (! isset(EEH_HTML::$_indent[ $tag ])) {
-            EEH_HTML::$_indent[ $tag ] = 0;
+        if ( ! isset(EEH_HTML::$_indent[$tag])) {
+            EEH_HTML::$_indent[$tag] = 0;
         }
-        EEH_HTML::$_indent[ $tag ] += $indent;
-        EEH_HTML::$_indent[ $tag ] = max(EEH_HTML::$_indent[ $tag ], 0);
+        EEH_HTML::$_indent[$tag] += $indent;
+        EEH_HTML::$_indent[$tag] = max(EEH_HTML::$_indent[$tag], 0);
     }