eventespresso / event-espresso-core

PaymentMethods/Manager.php

Indentation +190 added lines, -190 removed lines

@@ -20,194 +20,194 @@
  */
 class Manager
 {
-    /**
-     * List of PMs that can be replaced with PP Commerce.
-     * ['payment method name' => 'settings option']
-     *
-     * @var $pms_can_hide
-     */
-    protected static $pms_can_hide = [
-        'paypal_express' => 'api_username',
-        'paypal_pro'     => 'api_username',
-        'aim'            => 'login_id',
-    ];
-
-
-    /**
-     * Manager constructor.
-     */
-    public function __construct()
-    {
-        $this->loadPaymentMethods();
-        if (is_admin()) {
-            // Use only PayPal Commerce if it's a new setup.
-            add_filter(
-                'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-                [__CLASS__, 'hidePaymentMethods']
-            );
-            // Payment methods related admin notices.
-            add_action('admin_init', [__CLASS__, 'adminNotice']);
-        }
-    }
-
-
-    /**
-     * Load all payment methods that are in PaymentMethods folder.
-     *
-     * @return void
-     */
-    protected function loadPaymentMethods()
-    {
-        // Scan the PaymentMethods folder.
-        $pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
-        // Filter the discovered PM list.
-        $pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
-        // Clean from duplicates.
-        $pms_list = array_unique($pms_list);
-        foreach ($pms_list as $pm_path) {
-            $this->registerPaymentMethod($pm_path);
-        }
-    }
-
-
-    /**
-     * Looks for the main payment method file and loads it.
-     *
-     * @param string $pm_path path to the payment method folder
-     * @param string $file_ext
-     * @param string $pm_namespace
-     * @return boolean
-     */
-    public function registerPaymentMethod(
-        string $pm_path,
-        string $file_ext = '.php',
-        string $pm_namespace = 'EventEspresso\PaymentMethods'
-    ): bool {
-        do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
-        // Separators should match.
-        $pm_path = str_replace('/\\', '/', $pm_path) . DS;
-        // Sanitize PM name.
-        $module_dir = basename($pm_path);
-        // Get class name.
-        $pm_class_name = str_replace(' ', '_', $module_dir);
-        // Check if file exists.
-        if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
-            return false;
-        }
-        // Load the initial PM class.
-        require_once($pm_path . DS . $pm_class_name . $file_ext);
-        $pm_object = "$pm_namespace\\$pm_class_name";
-        if (! class_exists($pm_object)) {
-            return false;
-        }
-        new $pm_object();
-        return true;
-    }
-
-
-    /**
-     * Deactivate a few other PMs if it's a new setup. Use PP Commerce.
-     *
-     * @param array $pms_to_list
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function hidePaymentMethods(array $pms_to_list): array
-    {
-        foreach (self::$pms_can_hide as $pm_name => $pm_option) {
-            // Can we deregister this PM ?
-            if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
-                unset($pms_to_list[ $pm_name ]);
-            }
-        }
-        return $pms_to_list;
-    }
-
-
-    /**
-     * Deregisters the provided payment method if not used.
-     *
-     * @param string $pm_name
-     * @param string $pm_option
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function pmCanBeHidden(string $pm_name, string $pm_option): bool
-    {
-        $pm_to_hide = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
-        $pm_active  = $pm_active_before = false;
-        if ($pm_to_hide instanceof EE_Payment_Method) {
-            $pm_active = $pm_to_hide->active();
-            // Payment method used before ?
-            $option = $pm_to_hide->get_extra_meta($pm_option, true, false);
-            $pm_active_before = ! empty($option);
-        }
-        // If PM not used before and not active, deregister it.
-        if (
-            apply_filters(
-                "FHEE__PaymentMethods__Manager__register_payment_methods__hide_$pm_name",
-                ! $pm_active && ! $pm_active_before,
-                $pm_name
-            )
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Payment methods related admin notices.
-     *
-     * @return void
-     */
-    public static function adminNotice()
-    {
-        // Is this an EE admin page ?
-        $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page_name = $request->getRequestParam('page');
-        // Only show the notice on core EE pages
-        if (! str_contains($page_name, 'espresso')) {
-            return;
-        }
-        // Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.
-        try {
-            $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-            // Don't show notice if PayPal Commerce is active.
-            if ($pp_commerce instanceof EE_Payment_Method && $pp_commerce->active()) {
-                return;
-            }
-            foreach (self::$pms_can_hide as $pm_name => $pm_option) {
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
-                if ($payment_method instanceof EE_Payment_Method && $payment_method->active()) {
-                    add_action('admin_notices', [__CLASS__, 'usePayPalCommerceNotice']);
-                    return;
-                }
-            }
-        } catch (EE_Error | ReflectionException $e) {
-            // No handling needed right now.
-        }
-    }
-
-
-    /**
-     * Recommend PayPal Commerce notice contents.
-     *
-     * @return void
-     */
-    public static function usePayPalCommerceNotice()
-    {
-        echo '<div class="error"><p>'
-         . sprintf(
-             esc_html__(
-                 'We recommend using our latest PayPal integration - %1$sPayPal Commerce%2$s payment method in place of PayPal Standard, PayPal Express and PayPal Pro.',
-                 'event_espresso'
-             ),
-             '<strong>',
-             '</strong>'
-         )
-         . '</p></div>';
-    }
+	/**
+	 * List of PMs that can be replaced with PP Commerce.
+	 * ['payment method name' => 'settings option']
+	 *
+	 * @var $pms_can_hide
+	 */
+	protected static $pms_can_hide = [
+		'paypal_express' => 'api_username',
+		'paypal_pro'     => 'api_username',
+		'aim'            => 'login_id',
+	];
+
+
+	/**
+	 * Manager constructor.
+	 */
+	public function __construct()
+	{
+		$this->loadPaymentMethods();
+		if (is_admin()) {
+			// Use only PayPal Commerce if it's a new setup.
+			add_filter(
+				'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+				[__CLASS__, 'hidePaymentMethods']
+			);
+			// Payment methods related admin notices.
+			add_action('admin_init', [__CLASS__, 'adminNotice']);
+		}
+	}
+
+
+	/**
+	 * Load all payment methods that are in PaymentMethods folder.
+	 *
+	 * @return void
+	 */
+	protected function loadPaymentMethods()
+	{
+		// Scan the PaymentMethods folder.
+		$pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
+		// Filter the discovered PM list.
+		$pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
+		// Clean from duplicates.
+		$pms_list = array_unique($pms_list);
+		foreach ($pms_list as $pm_path) {
+			$this->registerPaymentMethod($pm_path);
+		}
+	}
+
+
+	/**
+	 * Looks for the main payment method file and loads it.
+	 *
+	 * @param string $pm_path path to the payment method folder
+	 * @param string $file_ext
+	 * @param string $pm_namespace
+	 * @return boolean
+	 */
+	public function registerPaymentMethod(
+		string $pm_path,
+		string $file_ext = '.php',
+		string $pm_namespace = 'EventEspresso\PaymentMethods'
+	): bool {
+		do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
+		// Separators should match.
+		$pm_path = str_replace('/\\', '/', $pm_path) . DS;
+		// Sanitize PM name.
+		$module_dir = basename($pm_path);
+		// Get class name.
+		$pm_class_name = str_replace(' ', '_', $module_dir);
+		// Check if file exists.
+		if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
+			return false;
+		}
+		// Load the initial PM class.
+		require_once($pm_path . DS . $pm_class_name . $file_ext);
+		$pm_object = "$pm_namespace\\$pm_class_name";
+		if (! class_exists($pm_object)) {
+			return false;
+		}
+		new $pm_object();
+		return true;
+	}
+
+
+	/**
+	 * Deactivate a few other PMs if it's a new setup. Use PP Commerce.
+	 *
+	 * @param array $pms_to_list
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function hidePaymentMethods(array $pms_to_list): array
+	{
+		foreach (self::$pms_can_hide as $pm_name => $pm_option) {
+			// Can we deregister this PM ?
+			if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
+				unset($pms_to_list[ $pm_name ]);
+			}
+		}
+		return $pms_to_list;
+	}
+
+
+	/**
+	 * Deregisters the provided payment method if not used.
+	 *
+	 * @param string $pm_name
+	 * @param string $pm_option
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function pmCanBeHidden(string $pm_name, string $pm_option): bool
+	{
+		$pm_to_hide = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
+		$pm_active  = $pm_active_before = false;
+		if ($pm_to_hide instanceof EE_Payment_Method) {
+			$pm_active = $pm_to_hide->active();
+			// Payment method used before ?
+			$option = $pm_to_hide->get_extra_meta($pm_option, true, false);
+			$pm_active_before = ! empty($option);
+		}
+		// If PM not used before and not active, deregister it.
+		if (
+			apply_filters(
+				"FHEE__PaymentMethods__Manager__register_payment_methods__hide_$pm_name",
+				! $pm_active && ! $pm_active_before,
+				$pm_name
+			)
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Payment methods related admin notices.
+	 *
+	 * @return void
+	 */
+	public static function adminNotice()
+	{
+		// Is this an EE admin page ?
+		$request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$page_name = $request->getRequestParam('page');
+		// Only show the notice on core EE pages
+		if (! str_contains($page_name, 'espresso')) {
+			return;
+		}
+		// Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.
+		try {
+			$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+			// Don't show notice if PayPal Commerce is active.
+			if ($pp_commerce instanceof EE_Payment_Method && $pp_commerce->active()) {
+				return;
+			}
+			foreach (self::$pms_can_hide as $pm_name => $pm_option) {
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
+				if ($payment_method instanceof EE_Payment_Method && $payment_method->active()) {
+					add_action('admin_notices', [__CLASS__, 'usePayPalCommerceNotice']);
+					return;
+				}
+			}
+		} catch (EE_Error | ReflectionException $e) {
+			// No handling needed right now.
+		}
+	}
+
+
+	/**
+	 * Recommend PayPal Commerce notice contents.
+	 *
+	 * @return void
+	 */
+	public static function usePayPalCommerceNotice()
+	{
+		echo '<div class="error"><p>'
+		 . sprintf(
+			 esc_html__(
+				 'We recommend using our latest PayPal integration - %1$sPayPal Commerce%2$s payment method in place of PayPal Standard, PayPal Express and PayPal Pro.',
+				 'event_espresso'
+			 ),
+			 '<strong>',
+			 '</strong>'
+		 )
+		 . '</p></div>';
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -59,7 +59,7 @@ 
     protected function loadPaymentMethods()
     {
         // Scan the PaymentMethods folder.
-        $pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
+        $pms_list = glob(EE_PLUGIN_DIR_PATH.'PaymentMethods/*', GLOB_ONLYDIR);
         // Filter the discovered PM list.
         $pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
         // Clean from duplicates.
@@ -85,19 +85,19 @@ 
     ): bool {
         do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
         // Separators should match.
-        $pm_path = str_replace('/\\', '/', $pm_path) . DS;
+        $pm_path = str_replace('/\\', '/', $pm_path).DS;
         // Sanitize PM name.
         $module_dir = basename($pm_path);
         // Get class name.
         $pm_class_name = str_replace(' ', '_', $module_dir);
         // Check if file exists.
-        if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
+        if ( ! is_readable($pm_path.$pm_class_name.$file_ext)) {
             return false;
         }
         // Load the initial PM class.
-        require_once($pm_path . DS . $pm_class_name . $file_ext);
+        require_once($pm_path.DS.$pm_class_name.$file_ext);
         $pm_object = "$pm_namespace\\$pm_class_name";
-        if (! class_exists($pm_object)) {
+        if ( ! class_exists($pm_object)) {
             return false;
         }
         new $pm_object();
@@ -117,8 +117,8 @@ 
     {
         foreach (self::$pms_can_hide as $pm_name => $pm_option) {
             // Can we deregister this PM ?
-            if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
-                unset($pms_to_list[ $pm_name ]);
+            if (isset($pms_to_list[$pm_name]) && self::pmCanBeHidden($pm_name, $pm_option)) {
+                unset($pms_to_list[$pm_name]);
             }
         }
         return $pms_to_list;
@@ -169,7 +169,7 @@ 
         $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
         $page_name = $request->getRequestParam('page');
         // Only show the notice on core EE pages
-        if (! str_contains($page_name, 'espresso')) {
+        if ( ! str_contains($page_name, 'espresso')) {
             return;
         }
         // Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.

modules/batch/EED_Batch.module.php

Indentation +434 added lines, -434 removed lines

@@ -29,438 +29,438 @@
  */
 class EED_Batch extends EED_Module
 {
-    public const PAGE_SLUG = 'espresso_batch';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * processes data only
-     */
-    const batch_job = 'job';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * produces a file for download
-     */
-    const batch_file_job = 'file';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
-     * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
-     * at all
-     */
-    const batch_not_job = 'none';
-
-    /**
-     *
-     * @var string 'file', or 'job', or false to indicate its not a batch request at all
-     */
-    protected $_batch_request_type = '';
-
-    /**
-     * Because we want to use the response in both the localized JS and in the body
-     * we need to make this response available between method calls
-     *
-     * @var JobStepResponse|null
-     */
-    protected $_job_step_response = null;
-
-    /**
-     * @var LoaderInterface|null
-     */
-    protected $loader = null;
-
-
-    /**
-     * Gets the batch instance
-     *
-     * @return  EED_Module|EED_Batch
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Batch
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Sets hooks to enable batch jobs on the frontend. Disabled by default
-     * because it's an attack vector and there are currently no implementations
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_hooks()
-    {
-        // because this is a possible attack vector, let's have this disabled until
-        // we at least have a real use for it on the frontend
-        if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
-            add_action('wp_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
-            add_filter('template_include', [self::instance(), 'override_template'], 99);
-        }
-    }
-
-
-    /**
-     * Initializes some hooks for the admin in order to run batch jobs
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('admin_menu', [self::instance(), 'register_admin_pages']);
-        add_action('admin_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
-
-        // ajax
-        add_action('wp_ajax_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
-        add_action('wp_ajax_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
-        add_action('wp_ajax_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
-    }
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    protected function getLoader(): LoaderInterface
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Enqueues batch scripts on the frontend or admin, and creates a job
-     */
-    public function enqueue_scripts()
-    {
-        $request = EED_Batch::getRequest();
-        if (
-            $request->getRequestParam(EED_Batch::PAGE_SLUG)
-            || $request->getRequestParam('page') === EED_Batch::PAGE_SLUG
-        ) {
-            if (
-                ! $request->requestParamIsSet('default_nonce')
-                || ! wp_verify_nonce($request->getRequestParam('default_nonce'), 'default_nonce')
-            ) {
-                wp_die(
-                    esc_html__(
-                        'The link you clicked to start the batch job has expired. Please go back and refresh the previous page.',
-                        'event_espresso'
-                    )
-                );
-            }
-            switch ($this->batch_request_type()) {
-                case self::batch_job:
-                    $this->enqueue_scripts_styles_batch_create();
-                    break;
-                case self::batch_file_job:
-                    $this->enqueue_scripts_styles_batch_file_create();
-                    break;
-            }
-        }
-    }
-
-
-    /**
-     * Create a batch job, enqueues a script to run it, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_create()
-    {
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
-            ['batch_runner'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script('batch_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        $return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
-        if ($return_url) {
-            wp_localize_script(
-                'batch_runner_init',
-                'ee_job_i18n',
-                [
-                    'return_url'                => $return_url,
-                    'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam(
-                        'auto_redirect_on_complete'
-                    ),
-                    'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
-                        ?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_file_create()
-    {
-        // creates a job based on the request variable
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
-            ['batch_runner'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script('batch_file_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        $return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
-        if ($return_url) {
-            wp_localize_script(
-                'batch_file_runner_init',
-                'ee_job_i18n',
-                ['return_url' => $return_url]
-            );
-        }
-    }
-
-
-    /**
-     * Enqueues scripts and styles common to any batch job, and creates
-     * a job from the request data, and stores the response in the
-     * $this->_job_step_response property
-     *
-     * @return JobStepResponse
-     */
-    protected function _enqueue_batch_job_scripts_and_styles_and_start_job(): JobStepResponse
-    {
-        // just copy the bits of EE admin's eei18n that we need in the JS
-        EE_Registry::$i18n_js_strings['batchJobError'] = __(
-            'An error occurred and the job has been stopped. Please refresh the page to try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
-        wp_enqueue_style(
-            EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
-            EE_ADMIN_URL . 'assets/ee-admin-page.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style(
-            'batch_runner',
-            BATCH_URL . 'assets/batch_runner.css',
-            [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
-            date('Y-m-d-H:i', time())
-        );
-        wp_register_script(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
-            ['jquery'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_enqueue_style(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
-            [],
-            date('Y-m-d-H:i', time())
-        );
-        wp_enqueue_script(
-            'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
-            ['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        /** @var BatchRequestProcessor $batch_runner */
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        // eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
-        // remember the response for later. We need it to display the page body
-        $this->_job_step_response = $batch_runner->createJob();
-        return $this->_job_step_response;
-    }
-
-
-    /**
-     * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
-     *
-     * @param string $template
-     * @return string
-     */
-    public function override_template(string $template): string
-    {
-        $request = EED_Batch::getRequest();
-        if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
-        }
-        return $template;
-    }
-
-
-    /**
-     * Adds an admin page which doesn't appear in the admin menu
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function register_admin_pages()
-    {
-        add_submenu_page(
-            '',
-            // parent slug. we don't want this to actually appear in the menu
-            esc_html__('Batch Job', 'event_espresso'),
-            // page title
-            'n/a',
-            // menu title
-            'read',
-            // we want this page to actually be accessible to anyone,
-            EED_Batch::PAGE_SLUG,
-            // menu slug
-            [self::instance(), 'show_admin_page']
-        );
-    }
-
-
-    /**
-     * Renders the admin page, after most of the work was already done during enqueuing scripts
-     * of creating the job and localizing some data
-     */
-    public function show_admin_page()
-    {
-        echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.php',
-            [
-                'batch_request_type'        => $this->batch_request_type(),
-                'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
-                'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
-                    ?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
-            ]
-        );
-    }
-
-
-    private function runBatchRunnerJob(string $job)
-    {
-        $job_id = EED_Batch::getRequest()->getRequestParam('job_id');
-        /** @var BatchRequestProcessor $batch_runner */
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        $job_response = $batch_runner->{$job}($job_id);
-        $this->_return_json($job_response->to_array());
-    }
-
-
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function continueBatchJob()
-    {
-        $this->runBatchRunnerJob('continueJob');
-    }
-
-
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function advanceBatchJob()
-    {
-        $this->runBatchRunnerJob('advanceJob');
-    }
-
-
-    /**
-     * Receives the ajax call to cleanup a job
-     *
-     * @return void
-     */
-    public function cleanupBatchJob()
-    {
-        $this->runBatchRunnerJob('cleanupJob');
-    }
-
-
-    /**
-     * Returns a json response
-     *
-     * @param array $data The data we want to send echo via in the JSON response's "data" element
-     *
-     * The returned json object is created from an array in the following format:
-     * array(
-     *    'notices' => '', // - contains any EE_Error formatted notices
-     *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *    We're also going to include the template args with every package (so js can pick out any specific template
-     *    args that might be included in here)
-     *    'isEEajax' => true,//indicates this is a response from EE
-     * )
-     */
-    protected function _return_json(array $data)
-    {
-        $json = [
-            'data'     => $data,
-            'isEEajax' => true,
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        ];
-
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (error_get_last() === null || ! headers_sent()) {
-            $notices = EE_Error::get_notices(false);
-            header('Content-Type: application/json; charset=UTF-8');
-            echo wp_json_encode($json + $notices);
-            exit();
-        }
-    }
-
-
-    /**
-     * Gets the job step response which was done during the enqueuing of scripts
-     *
-     * @return JobStepResponse
-     */
-    public function job_step_response(): JobStepResponse
-    {
-        return $this->_job_step_response;
-    }
-
-
-    /**
-     * Gets the batch request type indicated in the current request
-     *
-     * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
-     */
-    public function batch_request_type(): string
-    {
-        if (! $this->_batch_request_type) {
-            $request = EED_Batch::getRequest();
-            $batch   = $request->getRequestParam('batch');
-            switch ($batch) {
-                case self::batch_job:
-                    $this->_batch_request_type = self::batch_job;
-                    break;
-                case self::batch_file_job:
-                    $this->_batch_request_type = self::batch_file_job;
-                    break;
-                default:
-                    // if we didn't find that it was a batch request, indicate it wasn't
-                    $this->_batch_request_type = self::batch_not_job;
-            }
-        }
-        return $this->_batch_request_type;
-    }
-
-
-    /**
-     * Unnecessary
-     *
-     * @param WP $WP
-     */
-    public function run($WP)
-    {
-    }
+	public const PAGE_SLUG = 'espresso_batch';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * processes data only
+	 */
+	const batch_job = 'job';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * produces a file for download
+	 */
+	const batch_file_job = 'file';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
+	 * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
+	 * at all
+	 */
+	const batch_not_job = 'none';
+
+	/**
+	 *
+	 * @var string 'file', or 'job', or false to indicate its not a batch request at all
+	 */
+	protected $_batch_request_type = '';
+
+	/**
+	 * Because we want to use the response in both the localized JS and in the body
+	 * we need to make this response available between method calls
+	 *
+	 * @var JobStepResponse|null
+	 */
+	protected $_job_step_response = null;
+
+	/**
+	 * @var LoaderInterface|null
+	 */
+	protected $loader = null;
+
+
+	/**
+	 * Gets the batch instance
+	 *
+	 * @return  EED_Module|EED_Batch
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Batch
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Sets hooks to enable batch jobs on the frontend. Disabled by default
+	 * because it's an attack vector and there are currently no implementations
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_hooks()
+	{
+		// because this is a possible attack vector, let's have this disabled until
+		// we at least have a real use for it on the frontend
+		if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
+			add_action('wp_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
+			add_filter('template_include', [self::instance(), 'override_template'], 99);
+		}
+	}
+
+
+	/**
+	 * Initializes some hooks for the admin in order to run batch jobs
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('admin_menu', [self::instance(), 'register_admin_pages']);
+		add_action('admin_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
+
+		// ajax
+		add_action('wp_ajax_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
+		add_action('wp_ajax_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
+		add_action('wp_ajax_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	protected function getLoader(): LoaderInterface
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Enqueues batch scripts on the frontend or admin, and creates a job
+	 */
+	public function enqueue_scripts()
+	{
+		$request = EED_Batch::getRequest();
+		if (
+			$request->getRequestParam(EED_Batch::PAGE_SLUG)
+			|| $request->getRequestParam('page') === EED_Batch::PAGE_SLUG
+		) {
+			if (
+				! $request->requestParamIsSet('default_nonce')
+				|| ! wp_verify_nonce($request->getRequestParam('default_nonce'), 'default_nonce')
+			) {
+				wp_die(
+					esc_html__(
+						'The link you clicked to start the batch job has expired. Please go back and refresh the previous page.',
+						'event_espresso'
+					)
+				);
+			}
+			switch ($this->batch_request_type()) {
+				case self::batch_job:
+					$this->enqueue_scripts_styles_batch_create();
+					break;
+				case self::batch_file_job:
+					$this->enqueue_scripts_styles_batch_file_create();
+					break;
+			}
+		}
+	}
+
+
+	/**
+	 * Create a batch job, enqueues a script to run it, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_create()
+	{
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_runner_init',
+			BATCH_URL . 'assets/batch_runner_init.js',
+			['batch_runner'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script('batch_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		$return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
+		if ($return_url) {
+			wp_localize_script(
+				'batch_runner_init',
+				'ee_job_i18n',
+				[
+					'return_url'                => $return_url,
+					'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam(
+						'auto_redirect_on_complete'
+					),
+					'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
+						?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_file_create()
+	{
+		// creates a job based on the request variable
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_file_runner_init',
+			BATCH_URL . 'assets/batch_file_runner_init.js',
+			['batch_runner'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script('batch_file_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		$return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
+		if ($return_url) {
+			wp_localize_script(
+				'batch_file_runner_init',
+				'ee_job_i18n',
+				['return_url' => $return_url]
+			);
+		}
+	}
+
+
+	/**
+	 * Enqueues scripts and styles common to any batch job, and creates
+	 * a job from the request data, and stores the response in the
+	 * $this->_job_step_response property
+	 *
+	 * @return JobStepResponse
+	 */
+	protected function _enqueue_batch_job_scripts_and_styles_and_start_job(): JobStepResponse
+	{
+		// just copy the bits of EE admin's eei18n that we need in the JS
+		EE_Registry::$i18n_js_strings['batchJobError'] = __(
+			'An error occurred and the job has been stopped. Please refresh the page to try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
+		wp_enqueue_style(
+			EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
+			EE_ADMIN_URL . 'assets/ee-admin-page.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style(
+			'batch_runner',
+			BATCH_URL . 'assets/batch_runner.css',
+			[EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
+			date('Y-m-d-H:i', time())
+		);
+		wp_register_script(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+			['jquery'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_enqueue_style(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+			[],
+			date('Y-m-d-H:i', time())
+		);
+		wp_enqueue_script(
+			'batch_runner',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+			['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		/** @var BatchRequestProcessor $batch_runner */
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		// eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
+		// remember the response for later. We need it to display the page body
+		$this->_job_step_response = $batch_runner->createJob();
+		return $this->_job_step_response;
+	}
+
+
+	/**
+	 * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
+	 *
+	 * @param string $template
+	 * @return string
+	 */
+	public function override_template(string $template): string
+	{
+		$request = EED_Batch::getRequest();
+		if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
+			return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
+		}
+		return $template;
+	}
+
+
+	/**
+	 * Adds an admin page which doesn't appear in the admin menu
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function register_admin_pages()
+	{
+		add_submenu_page(
+			'',
+			// parent slug. we don't want this to actually appear in the menu
+			esc_html__('Batch Job', 'event_espresso'),
+			// page title
+			'n/a',
+			// menu title
+			'read',
+			// we want this page to actually be accessible to anyone,
+			EED_Batch::PAGE_SLUG,
+			// menu slug
+			[self::instance(), 'show_admin_page']
+		);
+	}
+
+
+	/**
+	 * Renders the admin page, after most of the work was already done during enqueuing scripts
+	 * of creating the job and localizing some data
+	 */
+	public function show_admin_page()
+	{
+		echo EEH_Template::locate_template(
+			EE_MODULES . 'batch/templates/batch_wrapper.template.php',
+			[
+				'batch_request_type'        => $this->batch_request_type(),
+				'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
+				'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
+					?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
+			]
+		);
+	}
+
+
+	private function runBatchRunnerJob(string $job)
+	{
+		$job_id = EED_Batch::getRequest()->getRequestParam('job_id');
+		/** @var BatchRequestProcessor $batch_runner */
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		$job_response = $batch_runner->{$job}($job_id);
+		$this->_return_json($job_response->to_array());
+	}
+
+
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function continueBatchJob()
+	{
+		$this->runBatchRunnerJob('continueJob');
+	}
+
+
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function advanceBatchJob()
+	{
+		$this->runBatchRunnerJob('advanceJob');
+	}
+
+
+	/**
+	 * Receives the ajax call to cleanup a job
+	 *
+	 * @return void
+	 */
+	public function cleanupBatchJob()
+	{
+		$this->runBatchRunnerJob('cleanupJob');
+	}
+
+
+	/**
+	 * Returns a json response
+	 *
+	 * @param array $data The data we want to send echo via in the JSON response's "data" element
+	 *
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *    'notices' => '', // - contains any EE_Error formatted notices
+	 *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *    We're also going to include the template args with every package (so js can pick out any specific template
+	 *    args that might be included in here)
+	 *    'isEEajax' => true,//indicates this is a response from EE
+	 * )
+	 */
+	protected function _return_json(array $data)
+	{
+		$json = [
+			'data'     => $data,
+			'isEEajax' => true,
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		];
+
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (error_get_last() === null || ! headers_sent()) {
+			$notices = EE_Error::get_notices(false);
+			header('Content-Type: application/json; charset=UTF-8');
+			echo wp_json_encode($json + $notices);
+			exit();
+		}
+	}
+
+
+	/**
+	 * Gets the job step response which was done during the enqueuing of scripts
+	 *
+	 * @return JobStepResponse
+	 */
+	public function job_step_response(): JobStepResponse
+	{
+		return $this->_job_step_response;
+	}
+
+
+	/**
+	 * Gets the batch request type indicated in the current request
+	 *
+	 * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
+	 */
+	public function batch_request_type(): string
+	{
+		if (! $this->_batch_request_type) {
+			$request = EED_Batch::getRequest();
+			$batch   = $request->getRequestParam('batch');
+			switch ($batch) {
+				case self::batch_job:
+					$this->_batch_request_type = self::batch_job;
+					break;
+				case self::batch_file_job:
+					$this->_batch_request_type = self::batch_file_job;
+					break;
+				default:
+					// if we didn't find that it was a batch request, indicate it wasn't
+					$this->_batch_request_type = self::batch_not_job;
+			}
+		}
+		return $this->_batch_request_type;
+	}
+
+
+	/**
+	 * Unnecessary
+	 *
+	 * @param WP $WP
+	 */
+	public function run($WP)
+	{
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -131,7 +131,7 @@ 
      */
     protected function getLoader(): LoaderInterface
     {
-        if (! $this->loader instanceof LoaderInterface) {
+        if ( ! $this->loader instanceof LoaderInterface) {
             $this->loader = LoaderFactory::getLoader();
         }
         return $this->loader;
@@ -179,7 +179,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
+            BATCH_URL.'assets/batch_runner_init.js',
             ['batch_runner'],
             date('Y-m-d-H:i', time()),
             true
@@ -214,7 +214,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
+            BATCH_URL.'assets/batch_file_runner_init.js',
             ['batch_runner'],
             date('Y-m-d-H:i', time()),
             true
@@ -247,35 +247,35 @@ 
             'An error occurred and the job has been stopped. Please refresh the page to try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
+        EE_Registry::$i18n_js_strings['is_admin'] = is_admin();
         wp_enqueue_style(
             EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
-            EE_ADMIN_URL . 'assets/ee-admin-page.css',
+            EE_ADMIN_URL.'assets/ee-admin-page.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style(
             'batch_runner',
-            BATCH_URL . 'assets/batch_runner.css',
+            BATCH_URL.'assets/batch_runner.css',
             [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
             date('Y-m-d-H:i', time())
         );
         wp_register_script(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.js',
             ['jquery'],
             date('Y-m-d-H:i', time()),
             true
         );
         wp_enqueue_style(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.css',
             [],
             date('Y-m-d-H:i', time())
         );
         wp_enqueue_script(
             'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/batch_runner.js',
             ['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
             date('Y-m-d-H:i', time()),
             true
@@ -299,7 +299,7 @@ 
     {
         $request = EED_Batch::getRequest();
         if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
+            return EE_MODULES.'batch/templates/batch_frontend_wrapper.template.php';
         }
         return $template;
     }
@@ -336,7 +336,7 @@ 
     public function show_admin_page()
     {
         echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.php',
+            EE_MODULES.'batch/templates/batch_wrapper.template.php',
             [
                 'batch_request_type'        => $this->batch_request_type(),
                 'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
@@ -436,7 +436,7 @@ 
      */
     public function batch_request_type(): string
     {
-        if (! $this->_batch_request_type) {
+        if ( ! $this->_batch_request_type) {
             $request = EED_Batch::getRequest();
             $batch   = $request->getRequestParam('batch');
             switch ($batch) {

caffeinated/admin/new/pricing/Pricing_Admin_Page.core.php

Indentation +1283 added lines, -1283 removed lines

@@ -12,1294 +12,1294 @@
  */
 class Pricing_Admin_Page extends EE_Admin_Page
 {
-    protected function _init_page_props()
-    {
-        $this->page_slug        = PRICING_PG_SLUG;
-        $this->page_label       = PRICING_LABEL;
-        $this->_admin_base_url  = PRICING_ADMIN_URL;
-        $this->_admin_base_path = PRICING_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_update_prices_order', [$this, 'update_price_order']);
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = PRICING_LABEL;
-        $this->_labels           = [
-            'buttons' => [
-                'add'         => esc_html__('Add New Default Price', 'event_espresso'),
-                'edit'        => esc_html__('Edit Default Price', 'event_espresso'),
-                'delete'      => esc_html__('Delete Default Price', 'event_espresso'),
-                'add_type'    => esc_html__('Add New Default Price Type', 'event_espresso'),
-                'edit_type'   => esc_html__('Edit Price Type', 'event_espresso'),
-                'delete_type' => esc_html__('Delete Price Type', 'event_espresso'),
-            ],
-            'publishbox' => [
-                'add_new_price'      => esc_html__('Add New Default Price', 'event_espresso'),
-                'edit_price'         => esc_html__('Edit Default Price', 'event_espresso'),
-                'add_new_price_type' => esc_html__('Add New Default Price Type', 'event_espresso'),
-                'edit_price_type'    => esc_html__('Edit Price Type', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     * an array for storing request actions and their corresponding methods
-     *
-     * @return void
-     */
-    protected function _set_page_routes()
-    {
-        $PRC_ID             = $this->request->getRequestParam('PRC_ID', 0, DataType::INTEGER);
-        $PRT_ID             = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
-        $this->_page_routes = [
-            'default'                     => [
-                'func'       => [$this, '_price_overview_list_table'],
-                'capability' => 'ee_read_default_prices',
-            ],
-            'add_new_price'               => [
-                'func'       => [$this, '_edit_price_details'],
-                'capability' => 'ee_edit_default_prices',
-            ],
-            'edit_price'                  => [
-                'func'       => [$this, '_edit_price_details'],
-                'capability' => 'ee_edit_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'insert_price'                => [
-                'func'       => [$this, '_insert_or_update_price'],
-                'args'       => ['insert' => true],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_prices',
-            ],
-            'update_price'                => [
-                'func'       => [$this, '_insert_or_update_price'],
-                'args'       => ['insert' => false],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'trash_price'                 => [
-                'func'       => [$this, '_trash_or_restore_price'],
-                'args'       => ['trash' => true],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'restore_price'               => [
-                'func'       => [$this, '_trash_or_restore_price'],
-                'args'       => ['trash' => false],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'delete_price'                => [
-                'func'       => [$this, '_delete_price'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'espresso_update_price_order' => [
-                'func'       => [$this, 'update_price_order'],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_prices',
-            ],
-            // price types
-            'price_types'                 => [
-                'func'       => [$this, '_price_types_overview_list_table'],
-                'capability' => 'ee_read_default_price_types',
-            ],
-            'add_new_price_type'          => [
-                'func'       => [$this, '_edit_price_type_details'],
-                'capability' => 'ee_edit_default_price_types',
-            ],
-            'edit_price_type'             => [
-                'func'       => [$this, '_edit_price_type_details'],
-                'capability' => 'ee_edit_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'insert_price_type'           => [
-                'func'       => [$this, '_insert_or_update_price_type'],
-                'args'       => ['new_price_type' => true],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_price_types',
-            ],
-            'update_price_type'           => [
-                'func'       => [$this, '_insert_or_update_price_type'],
-                'args'       => ['new_price_type' => false],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'trash_price_type'            => [
-                'func'       => [$this, '_trash_or_restore_price_type'],
-                'args'       => ['trash' => true],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'restore_price_type'          => [
-                'func'       => [$this, '_trash_or_restore_price_type'],
-                'args'       => ['trash' => false],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'delete_price_type'           => [
-                'func'       => [$this, '_delete_price_type'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'tax_settings'                => [
-                'func'       => [$this, '_tax_settings'],
-                'capability' => 'manage_options',
-            ],
-            'update_tax_settings'         => [
-                'func'       => [$this, '_update_tax_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $PRC_ID             = $this->request->getRequestParam('id', 0, DataType::INTEGER);
-        $this->_page_config = [
-            'default'            => [
-                'nav'           => [
-                    'label' => esc_html__('Default Pricing', 'event_espresso'),
-                    'icon' => 'dashicons-money-alt',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Prices_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'pricing_default_pricing_help_tab'                           => [
-                        'title'    => esc_html__('Default Pricing', 'event_espresso'),
-                        'filename' => 'pricing_default_pricing',
-                    ],
-                    'pricing_default_pricing_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Default Pricing Table Column Headings', 'event_espresso'),
-                        'filename' => 'pricing_default_pricing_table_column_headings',
-                    ],
-                    'pricing_default_pricing_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Default Pricing Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'pricing_default_pricing_views_bulk_actions_search',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'add_new_price'      => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Default Price', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 20,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_new_default_price_help_tab' => [
-                        'title'    => esc_html__('Add New Default Price', 'event_espresso'),
-                        'filename' => 'pricing_add_new_default_price',
-                    ],
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'require_nonce' => false,
-            ],
-            'edit_price'         => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Default Price', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 20,
-                    'url'        => $PRC_ID
-                        ? add_query_arg(['id' => $PRC_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'help_tabs'     => [
-                    'edit_default_price_help_tab' => [
-                        'title'    => esc_html__('Edit Default Price', 'event_espresso'),
-                        'filename' => 'pricing_edit_default_price',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'price_types'        => [
-                'nav'           => [
-                    'label' => esc_html__('Price Types', 'event_espresso'),
-                    'icon' => 'dashicons-networking',
-                    'order' => 30,
-                ],
-                'list_table'    => 'Price_Types_List_Table',
-                'help_tabs'     => [
-                    'pricing_price_types_help_tab'                           => [
-                        'title'    => esc_html__('Price Types', 'event_espresso'),
-                        'filename' => 'pricing_price_types',
-                    ],
-                    'pricing_price_types_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Price Types Table Column Headings', 'event_espresso'),
-                        'filename' => 'pricing_price_types_table_column_headings',
-                    ],
-                    'pricing_price_types_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Price Types Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'pricing_price_types_views_bulk_actions_search',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-            'add_new_price_type' => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Price Type', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 40,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_new_price_type_help_tab' => [
-                        'title'    => esc_html__('Add New Price Type', 'event_espresso'),
-                        'filename' => 'pricing_add_new_price_type',
-                    ],
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'require_nonce' => false,
-            ],
-            'edit_price_type'    => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Price Type', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 40,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'edit_price_type_help_tab' => [
-                        'title'    => esc_html__('Edit Price Type', 'event_espresso'),
-                        'filename' => 'pricing_edit_price_type',
-                    ],
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'require_nonce' => false,
-            ],
-            'tax_settings'       => [
-                'nav' => [
-                    'label' => esc_html__('Tax Settings', 'event_espresso'),
-                    'icon' => 'dashicons-sticky',
-                    'order' => 50,
-                ],
-                'labels'        => [
-                    'publishbox' => esc_html__('Update Tax Settings', 'event_espresso'),
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'require_nonce' => true,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_price_types()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Price Types', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_pricing_css',
-            PRICING_ASSETS_URL . 'espresso_pricing_admin.css',
-            [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_pricing_css');
-
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('jquery-ui-position');
-        wp_enqueue_script('jquery-ui-widget');
-        wp_register_script(
-            'espresso_pricing_js',
-            PRICING_ASSETS_URL . 'espresso_pricing_admin.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_pricing_js');
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_script('espresso_ajax_table_sorting');
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Default Pricing', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_price' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
-            $this->_views['trashed'] = [
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_price' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_price'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    protected function _set_list_table_views_price_types()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_price_type' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_default_price_types',
-                'pricing_trash_price_type'
-            )
-        ) {
-            $this->_views['trashed'] = [
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_price_type' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_price_type'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    /**
-     * generates HTML for main Prices Admin page
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _price_overview_list_table()
-    {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_new_price',
-            'add',
-            [],
-            'add-new-h2'
-        );
-        $this->_admin_page_title .= $this->_learn_more_about_pricing_link();
-        $this->_search_btn_label = esc_html__('Default Prices', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * retrieve data for Prices List table
-     *
-     * @param int  $per_page how many prices displayed per page
-     * @param bool $count    return the count or objects
-     * @param bool $trashed  whether the current view is of the trash can - eww yuck!
-     * @return EE_Soft_Delete_Base_Class[]|int int = count || array of price objects
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_prices_overview_data(int $per_page = 10, bool $count = false, bool $trashed = false)
-    {
-        // start with an empty array
-        $event_pricing = [];
-
-        require_once(PRICING_ADMIN . 'Prices_List_Table.class.php');
-
-        $orderby = $this->request->getRequestParam('orderby', '');
-        $order   = $this->request->getRequestParam('order', 'ASC');
-
-        switch ($orderby) {
-            case 'name':
-                $orderby = ['PRC_name' => $order];
-                break;
-            case 'type':
-                $orderby = ['Price_Type.PRT_name' => $order];
-                break;
-            case 'amount':
-                $orderby = ['PRC_amount' => $order];
-                break;
-            default:
-                $orderby = ['PRC_order' => $order, 'Price_Type.PRT_order' => $order, 'PRC_ID' => $order];
-        }
-
-        $current_page = $this->request->getRequestParam('paged', 1, DataType::INTEGER);
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, DataType::INTEGER);
-
-        $where = [
-            'PRC_is_default' => 1,
-            'PRC_deleted'    => $trashed,
-        ];
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = "%{$search_term}%";
-            $where['OR'] = [
-                'PRC_name'            => ['LIKE', $search_term],
-                'PRC_desc'            => ['LIKE', $search_term],
-                'PRC_amount'          => ['LIKE', $search_term],
-                'Price_Type.PRT_name' => ['LIKE', $search_term],
-            ];
-        }
-
-        $query_params = [
-            $where,
-            'order_by' => $orderby,
-            'limit'    => $limit,
-            'group_by' => 'PRC_ID',
-        ];
-
-        if ($count) {
-            return $trashed
-                ? EEM_Price::instance()->count([$where])
-                : EEM_Price::instance()->count_deleted_and_undeleted([$where]);
-        }
-        return EEM_Price::instance()->get_all_deleted_and_undeleted($query_params);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _edit_price_details()
-    {
-        // grab price ID
-        $PRC_ID = $this->request->getRequestParam('id', 0, DataType::INTEGER);
-        // change page title based on request action
-        switch ($this->_req_action) {
-            case 'add_new_price':
-                $this->_admin_page_title = esc_html__('Add New Price', 'event_espresso');
-                break;
-            case 'edit_price':
-                $this->_admin_page_title = esc_html__('Edit Price', '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 = $PRC_ID ? $this->_admin_page_title . ' # ' . $PRC_ID : $this->_admin_page_title;
-
-        if ($PRC_ID) {
-            $price                    = EEM_Price::instance()->get_one_by_ID($PRC_ID);
-            $additional_hidden_fields = [
-                'PRC_ID' => ['type' => 'hidden', 'value' => $PRC_ID],
-            ];
-            $this->_set_add_edit_form_tags('update_price', $additional_hidden_fields);
-        } else {
-            $price = EEM_Price::instance()->get_new_price();
-            $this->_set_add_edit_form_tags('insert_price');
-        }
-
-        if (! $price instanceof EE_Price) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'A valid Price could not be retrieved from the database with ID: %1$s',
-                        'event_espresso'
-                    ),
-                    $PRC_ID
-                )
-            );
-        }
-
-        $this->_template_args['PRC_ID'] = $PRC_ID;
-        $this->_template_args['price']  = $price;
-
-        $default_base_price = $price->type_obj() && $price->type_obj()->base_type() === 1;
-
-        $this->_template_args['default_base_price'] = $default_base_price;
-
-        // get price types
-        $price_types = EEM_Price_Type::instance()->get_all([['PBT_ID' => ['!=', 1]]]);
-        if (empty($price_types)) {
-            $msg = esc_html__(
-                'You have no price types defined. Please add a price type before adding a price.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->display_admin_page_with_sidebar();
-        }
-        $attributes       = [];
-        $price_type_names = [];
-        $attributes[]     = 'id="PRT_ID"';
-        if ($default_base_price) {
-            $attributes[]       = 'disabled="disabled"';
-            $price_type_names[] = ['id' => 1, 'text' => esc_html__('Base Price', 'event_espresso')];
-        }
-        foreach ($price_types as $type) {
-            $price_type_names[] = ['id' => $type->ID(), 'text' => $type->name()];
-        }
-        $this->_template_args['attributes']  = implode(' ', $attributes);
-        $this->_template_args['price_types'] = $price_type_names;
-
-        $this->_template_args['learn_more_about_pricing_link'] = $this->_learn_more_about_pricing_link();
-        $this->_template_args['admin_page_content']            = $this->_edit_price_details_meta_box();
-
-        $this->_set_publish_post_box_vars('id', $PRC_ID, '', '', true);
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *
-     * @return string
-     */
-    public function _edit_price_details_meta_box(): string
-    {
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'pricing_details_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function set_price_column_values(): array
-    {
-        $PRC_order = 0;
-        $PRT_ID    = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
-        if ($PRT_ID) {
-            /** @var EE_Price_Type $price_type */
-            $price_type = EEM_Price_Type::instance()->get_one_by_ID($PRT_ID);
-            if ($price_type instanceof EE_Price_Type) {
-                $PRC_order = $price_type->order();
-            }
-        }
-        return [
-            'PRT_ID'         => $PRT_ID,
-            'PRC_amount'     => $this->request->getRequestParam('PRC_amount', 0, DataType::FLOAT),
-            'PRC_name'       => $this->request->getRequestParam('PRC_name'),
-            'PRC_desc'       => $this->request->getRequestParam('PRC_desc'),
-            'PRC_is_default' => 1,
-            'PRC_overrides'  => null,
-            'PRC_order'      => $PRC_order,
-            'PRC_deleted'    => 0,
-            'PRC_parent'     => 0,
-        ];
-    }
-
-
-    /**
-     * @param bool $insert - whether to insert or update
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_price(bool $insert = false)
-    {
-        // why be so pessimistic ???  : (
-        $updated = 0;
-
-        $set_column_values = $this->set_price_column_values();
-        // is this a new Price ?
-        if ($insert) {
-            // run the insert
-            $PRC_ID = EEM_Price::instance()->insert($set_column_values);
-            if ($PRC_ID) {
-                // make sure this new price modifier is attached to the ticket but ONLY if it is not a tax type
-                $price = EEM_price::instance()->get_one_by_ID($PRC_ID);
-                if (
-                    $price instanceof EE_Price
-                    && $price->type_obj() instanceof EE_Price_type
-                    && $price->type_obj()->base_type() !== EEM_Price_Type::base_type_tax
-                ) {
-                    $ticket = EEM_Ticket::instance()->get_one_by_ID(1);
-                    $ticket->_add_relation_to($price, 'Price');
-                    $ticket->save();
-                }
-                $updated = 1;
-            }
-            $action_desc = 'created';
-        } else {
-            $PRC_ID = $this->request->getRequestParam('PRC_ID', 0, DataType::INTEGER);
-            // run the update
-            $where_cols_n_values = ['PRC_ID' => $PRC_ID];
-            $updated             = EEM_Price::instance()->update($set_column_values, [$where_cols_n_values]);
-
-            $price = EEM_Price::instance()->get_one_by_ID($PRC_ID);
-            if ($price instanceof EE_Price && $price->type_obj()->base_type() !== EEM_Price_Type::base_type_tax) {
-                // if this is $PRC_ID == 1,
-                // then we need to update the default ticket attached to this price so the TKT_price value is updated.
-                if ($PRC_ID === 1) {
-                    $ticket = $price->get_first_related('Ticket');
-                    if ($ticket) {
-                        $ticket->set('TKT_price', $price->get('PRC_amount'));
-                        $ticket->set('TKT_name', $price->get('PRC_name'));
-                        $ticket->set('TKT_description', $price->get('PRC_desc'));
-                        $ticket->save();
-                    }
-                } else {
-                    // we make sure this price is attached to base ticket. but ONLY if it's not a tax ticket type.
-                    $ticket = EEM_Ticket::instance()->get_one_by_ID(1);
-                    if ($ticket instanceof EE_Ticket) {
-                        $ticket->_add_relation_to($PRC_ID, 'Price');
-                        $ticket->save();
-                    }
-                }
-            }
-
-            $action_desc = 'updated';
-        }
-
-        $query_args = ['action' => 'edit_price', 'id' => $PRC_ID];
-
-        $this->_redirect_after_action($updated, 'Prices', $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param bool $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _trash_or_restore_price($trash = true)
-    {
-        $entity_model = EEM_Price::instance();
-        $action       = $trash ? EE_Admin_List_Table::ACTION_TRASH : EE_Admin_List_Table::ACTION_RESTORE;
-        $result       = $this->trashRestoreDeleteEntities(
-            $entity_model,
-            'id',
-            $action,
-            'PRC_deleted',
-            [$this, 'adjustTicketRelations']
-        );
-
-        if ($result) {
-            $msg = $trash
-                ? esc_html(
-                    _n(
-                        'The Price has been trashed',
-                        'The Prices have been trashed',
-                        $result,
-                        'event_espresso'
-                    )
-                )
-                : esc_html(
-                    _n(
-                        'The Price has been restored',
-                        'The Prices have been restored',
-                        $result,
-                        'event_espresso'
-                    )
-                );
-            EE_Error::add_success($msg);
-        }
-
-        $this->_redirect_after_action(
-            $result,
-            _n('Price', 'Prices', $result, 'event_espresso'),
-            $trash ? 'trashed' : 'restored',
-            ['action' => 'default'],
-            true
-        );
-    }
-
-
-    /**
-     * @param EEM_Base   $entity_model
-     * @param int|string $entity_ID
-     * @param string     $action
-     * @param int        $result
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.30.p
-     */
-    public function adjustTicketRelations(
-        EEM_Base $entity_model,
-        $entity_ID,
-        string $action,
-        int $result
-    ) {
-        if (! $entity_ID || (float) $result < 1) {
-            return;
-        }
-
-        $entity = $entity_model->get_one_by_ID($entity_ID);
-        if (! $entity instanceof EE_Price || $entity->type_obj()->base_type() === EEM_Price_Type::base_type_tax) {
-            return;
-        }
-
-        // get default tickets for updating
-        $default_tickets = EEM_Ticket::instance()->get_all_default_tickets();
-        foreach ($default_tickets as $default_ticket) {
-            if (! $default_ticket instanceof EE_Ticket) {
-                continue;
-            }
-            switch ($action) {
-                case EE_Admin_List_Table::ACTION_DELETE:
-                case EE_Admin_List_Table::ACTION_TRASH:
-                    // if trashing then remove relations to base default ticket.
-                    $default_ticket->_remove_relation_to($entity_ID, 'Price');
-                    break;
-                case EE_Admin_List_Table::ACTION_RESTORE:
-                    // if restoring then add back to base default ticket
-                    $default_ticket->_add_relation_to($entity_ID, 'Price');
-                    break;
-            }
-            $default_ticket->save();
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_price()
-    {
-        $entity_model = EEM_Price::instance();
-        $deleted      = $this->trashRestoreDeleteEntities($entity_model, 'id');
-        $entity       = $entity_model->item_name($deleted);
-        $this->_redirect_after_action(
-            $deleted,
-            $entity,
-            'deleted',
-            ['action' => 'default']
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_price_order()
-    {
-        // grab our row IDs
-        $row_ids = $this->request->getRequestParam('row_ids', '');
-        $row_ids = explode(',', rtrim($row_ids, ','));
-
-        $all_updated = true;
-        foreach ($row_ids as $i => $row_id) {
-            // Update the prices when re-ordering
-            $fields_n_values = ['PRC_order' => $i + 1];
-            $query_params    = [['PRC_ID' => absint($row_id)]];
-            // any failure will toggle $all_updated to false
-            $all_updated = $row_id && EEM_Price::instance()->update($fields_n_values, $query_params) !== false
-                ? $all_updated
-                : false;
-        }
-        $success = $all_updated
-            ? esc_html__('Price order was updated successfully.', 'event_espresso')
-            : false;
-        $errors  = ! $all_updated
-            ? esc_html__('An error occurred. The price order was not updated.', 'event_espresso')
-            : false;
-
-        echo wp_json_encode(['return_data' => false, 'success' => $success, 'errors' => $errors]);
-        die();
-    }
-
-
-    /******************************************************************************************************************
+	protected function _init_page_props()
+	{
+		$this->page_slug        = PRICING_PG_SLUG;
+		$this->page_label       = PRICING_LABEL;
+		$this->_admin_base_url  = PRICING_ADMIN_URL;
+		$this->_admin_base_path = PRICING_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_update_prices_order', [$this, 'update_price_order']);
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = PRICING_LABEL;
+		$this->_labels           = [
+			'buttons' => [
+				'add'         => esc_html__('Add New Default Price', 'event_espresso'),
+				'edit'        => esc_html__('Edit Default Price', 'event_espresso'),
+				'delete'      => esc_html__('Delete Default Price', 'event_espresso'),
+				'add_type'    => esc_html__('Add New Default Price Type', 'event_espresso'),
+				'edit_type'   => esc_html__('Edit Price Type', 'event_espresso'),
+				'delete_type' => esc_html__('Delete Price Type', 'event_espresso'),
+			],
+			'publishbox' => [
+				'add_new_price'      => esc_html__('Add New Default Price', 'event_espresso'),
+				'edit_price'         => esc_html__('Edit Default Price', 'event_espresso'),
+				'add_new_price_type' => esc_html__('Add New Default Price Type', 'event_espresso'),
+				'edit_price_type'    => esc_html__('Edit Price Type', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 * an array for storing request actions and their corresponding methods
+	 *
+	 * @return void
+	 */
+	protected function _set_page_routes()
+	{
+		$PRC_ID             = $this->request->getRequestParam('PRC_ID', 0, DataType::INTEGER);
+		$PRT_ID             = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
+		$this->_page_routes = [
+			'default'                     => [
+				'func'       => [$this, '_price_overview_list_table'],
+				'capability' => 'ee_read_default_prices',
+			],
+			'add_new_price'               => [
+				'func'       => [$this, '_edit_price_details'],
+				'capability' => 'ee_edit_default_prices',
+			],
+			'edit_price'                  => [
+				'func'       => [$this, '_edit_price_details'],
+				'capability' => 'ee_edit_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'insert_price'                => [
+				'func'       => [$this, '_insert_or_update_price'],
+				'args'       => ['insert' => true],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_prices',
+			],
+			'update_price'                => [
+				'func'       => [$this, '_insert_or_update_price'],
+				'args'       => ['insert' => false],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'trash_price'                 => [
+				'func'       => [$this, '_trash_or_restore_price'],
+				'args'       => ['trash' => true],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'restore_price'               => [
+				'func'       => [$this, '_trash_or_restore_price'],
+				'args'       => ['trash' => false],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'delete_price'                => [
+				'func'       => [$this, '_delete_price'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'espresso_update_price_order' => [
+				'func'       => [$this, 'update_price_order'],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_prices',
+			],
+			// price types
+			'price_types'                 => [
+				'func'       => [$this, '_price_types_overview_list_table'],
+				'capability' => 'ee_read_default_price_types',
+			],
+			'add_new_price_type'          => [
+				'func'       => [$this, '_edit_price_type_details'],
+				'capability' => 'ee_edit_default_price_types',
+			],
+			'edit_price_type'             => [
+				'func'       => [$this, '_edit_price_type_details'],
+				'capability' => 'ee_edit_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'insert_price_type'           => [
+				'func'       => [$this, '_insert_or_update_price_type'],
+				'args'       => ['new_price_type' => true],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_price_types',
+			],
+			'update_price_type'           => [
+				'func'       => [$this, '_insert_or_update_price_type'],
+				'args'       => ['new_price_type' => false],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'trash_price_type'            => [
+				'func'       => [$this, '_trash_or_restore_price_type'],
+				'args'       => ['trash' => true],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'restore_price_type'          => [
+				'func'       => [$this, '_trash_or_restore_price_type'],
+				'args'       => ['trash' => false],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'delete_price_type'           => [
+				'func'       => [$this, '_delete_price_type'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'tax_settings'                => [
+				'func'       => [$this, '_tax_settings'],
+				'capability' => 'manage_options',
+			],
+			'update_tax_settings'         => [
+				'func'       => [$this, '_update_tax_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$PRC_ID             = $this->request->getRequestParam('id', 0, DataType::INTEGER);
+		$this->_page_config = [
+			'default'            => [
+				'nav'           => [
+					'label' => esc_html__('Default Pricing', 'event_espresso'),
+					'icon' => 'dashicons-money-alt',
+					'order' => 10,
+				],
+				'list_table'    => 'Prices_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'pricing_default_pricing_help_tab'                           => [
+						'title'    => esc_html__('Default Pricing', 'event_espresso'),
+						'filename' => 'pricing_default_pricing',
+					],
+					'pricing_default_pricing_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Default Pricing Table Column Headings', 'event_espresso'),
+						'filename' => 'pricing_default_pricing_table_column_headings',
+					],
+					'pricing_default_pricing_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Default Pricing Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'pricing_default_pricing_views_bulk_actions_search',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'add_new_price'      => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Default Price', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 20,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_new_default_price_help_tab' => [
+						'title'    => esc_html__('Add New Default Price', 'event_espresso'),
+						'filename' => 'pricing_add_new_default_price',
+					],
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'require_nonce' => false,
+			],
+			'edit_price'         => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Default Price', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 20,
+					'url'        => $PRC_ID
+						? add_query_arg(['id' => $PRC_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'help_tabs'     => [
+					'edit_default_price_help_tab' => [
+						'title'    => esc_html__('Edit Default Price', 'event_espresso'),
+						'filename' => 'pricing_edit_default_price',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'price_types'        => [
+				'nav'           => [
+					'label' => esc_html__('Price Types', 'event_espresso'),
+					'icon' => 'dashicons-networking',
+					'order' => 30,
+				],
+				'list_table'    => 'Price_Types_List_Table',
+				'help_tabs'     => [
+					'pricing_price_types_help_tab'                           => [
+						'title'    => esc_html__('Price Types', 'event_espresso'),
+						'filename' => 'pricing_price_types',
+					],
+					'pricing_price_types_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Price Types Table Column Headings', 'event_espresso'),
+						'filename' => 'pricing_price_types_table_column_headings',
+					],
+					'pricing_price_types_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Price Types Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'pricing_price_types_views_bulk_actions_search',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+			'add_new_price_type' => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Price Type', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 40,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_new_price_type_help_tab' => [
+						'title'    => esc_html__('Add New Price Type', 'event_espresso'),
+						'filename' => 'pricing_add_new_price_type',
+					],
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'require_nonce' => false,
+			],
+			'edit_price_type'    => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Price Type', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 40,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'edit_price_type_help_tab' => [
+						'title'    => esc_html__('Edit Price Type', 'event_espresso'),
+						'filename' => 'pricing_edit_price_type',
+					],
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'require_nonce' => false,
+			],
+			'tax_settings'       => [
+				'nav' => [
+					'label' => esc_html__('Tax Settings', 'event_espresso'),
+					'icon' => 'dashicons-sticky',
+					'order' => 50,
+				],
+				'labels'        => [
+					'publishbox' => esc_html__('Update Tax Settings', 'event_espresso'),
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'require_nonce' => true,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_price_types()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Price Types', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_pricing_css',
+			PRICING_ASSETS_URL . 'espresso_pricing_admin.css',
+			[EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_pricing_css');
+
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('jquery-ui-position');
+		wp_enqueue_script('jquery-ui-widget');
+		wp_register_script(
+			'espresso_pricing_js',
+			PRICING_ASSETS_URL . 'espresso_pricing_admin.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_pricing_js');
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_script('espresso_ajax_table_sorting');
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Default Pricing', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_price' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
+			$this->_views['trashed'] = [
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_price' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_price'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	protected function _set_list_table_views_price_types()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_price_type' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_default_price_types',
+				'pricing_trash_price_type'
+			)
+		) {
+			$this->_views['trashed'] = [
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_price_type' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_price_type'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	/**
+	 * generates HTML for main Prices Admin page
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _price_overview_list_table()
+	{
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_new_price',
+			'add',
+			[],
+			'add-new-h2'
+		);
+		$this->_admin_page_title .= $this->_learn_more_about_pricing_link();
+		$this->_search_btn_label = esc_html__('Default Prices', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * retrieve data for Prices List table
+	 *
+	 * @param int  $per_page how many prices displayed per page
+	 * @param bool $count    return the count or objects
+	 * @param bool $trashed  whether the current view is of the trash can - eww yuck!
+	 * @return EE_Soft_Delete_Base_Class[]|int int = count || array of price objects
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_prices_overview_data(int $per_page = 10, bool $count = false, bool $trashed = false)
+	{
+		// start with an empty array
+		$event_pricing = [];
+
+		require_once(PRICING_ADMIN . 'Prices_List_Table.class.php');
+
+		$orderby = $this->request->getRequestParam('orderby', '');
+		$order   = $this->request->getRequestParam('order', 'ASC');
+
+		switch ($orderby) {
+			case 'name':
+				$orderby = ['PRC_name' => $order];
+				break;
+			case 'type':
+				$orderby = ['Price_Type.PRT_name' => $order];
+				break;
+			case 'amount':
+				$orderby = ['PRC_amount' => $order];
+				break;
+			default:
+				$orderby = ['PRC_order' => $order, 'Price_Type.PRT_order' => $order, 'PRC_ID' => $order];
+		}
+
+		$current_page = $this->request->getRequestParam('paged', 1, DataType::INTEGER);
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, DataType::INTEGER);
+
+		$where = [
+			'PRC_is_default' => 1,
+			'PRC_deleted'    => $trashed,
+		];
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = "%{$search_term}%";
+			$where['OR'] = [
+				'PRC_name'            => ['LIKE', $search_term],
+				'PRC_desc'            => ['LIKE', $search_term],
+				'PRC_amount'          => ['LIKE', $search_term],
+				'Price_Type.PRT_name' => ['LIKE', $search_term],
+			];
+		}
+
+		$query_params = [
+			$where,
+			'order_by' => $orderby,
+			'limit'    => $limit,
+			'group_by' => 'PRC_ID',
+		];
+
+		if ($count) {
+			return $trashed
+				? EEM_Price::instance()->count([$where])
+				: EEM_Price::instance()->count_deleted_and_undeleted([$where]);
+		}
+		return EEM_Price::instance()->get_all_deleted_and_undeleted($query_params);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _edit_price_details()
+	{
+		// grab price ID
+		$PRC_ID = $this->request->getRequestParam('id', 0, DataType::INTEGER);
+		// change page title based on request action
+		switch ($this->_req_action) {
+			case 'add_new_price':
+				$this->_admin_page_title = esc_html__('Add New Price', 'event_espresso');
+				break;
+			case 'edit_price':
+				$this->_admin_page_title = esc_html__('Edit Price', '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 = $PRC_ID ? $this->_admin_page_title . ' # ' . $PRC_ID : $this->_admin_page_title;
+
+		if ($PRC_ID) {
+			$price                    = EEM_Price::instance()->get_one_by_ID($PRC_ID);
+			$additional_hidden_fields = [
+				'PRC_ID' => ['type' => 'hidden', 'value' => $PRC_ID],
+			];
+			$this->_set_add_edit_form_tags('update_price', $additional_hidden_fields);
+		} else {
+			$price = EEM_Price::instance()->get_new_price();
+			$this->_set_add_edit_form_tags('insert_price');
+		}
+
+		if (! $price instanceof EE_Price) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'A valid Price could not be retrieved from the database with ID: %1$s',
+						'event_espresso'
+					),
+					$PRC_ID
+				)
+			);
+		}
+
+		$this->_template_args['PRC_ID'] = $PRC_ID;
+		$this->_template_args['price']  = $price;
+
+		$default_base_price = $price->type_obj() && $price->type_obj()->base_type() === 1;
+
+		$this->_template_args['default_base_price'] = $default_base_price;
+
+		// get price types
+		$price_types = EEM_Price_Type::instance()->get_all([['PBT_ID' => ['!=', 1]]]);
+		if (empty($price_types)) {
+			$msg = esc_html__(
+				'You have no price types defined. Please add a price type before adding a price.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->display_admin_page_with_sidebar();
+		}
+		$attributes       = [];
+		$price_type_names = [];
+		$attributes[]     = 'id="PRT_ID"';
+		if ($default_base_price) {
+			$attributes[]       = 'disabled="disabled"';
+			$price_type_names[] = ['id' => 1, 'text' => esc_html__('Base Price', 'event_espresso')];
+		}
+		foreach ($price_types as $type) {
+			$price_type_names[] = ['id' => $type->ID(), 'text' => $type->name()];
+		}
+		$this->_template_args['attributes']  = implode(' ', $attributes);
+		$this->_template_args['price_types'] = $price_type_names;
+
+		$this->_template_args['learn_more_about_pricing_link'] = $this->_learn_more_about_pricing_link();
+		$this->_template_args['admin_page_content']            = $this->_edit_price_details_meta_box();
+
+		$this->_set_publish_post_box_vars('id', $PRC_ID, '', '', true);
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *
+	 * @return string
+	 */
+	public function _edit_price_details_meta_box(): string
+	{
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'pricing_details_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function set_price_column_values(): array
+	{
+		$PRC_order = 0;
+		$PRT_ID    = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
+		if ($PRT_ID) {
+			/** @var EE_Price_Type $price_type */
+			$price_type = EEM_Price_Type::instance()->get_one_by_ID($PRT_ID);
+			if ($price_type instanceof EE_Price_Type) {
+				$PRC_order = $price_type->order();
+			}
+		}
+		return [
+			'PRT_ID'         => $PRT_ID,
+			'PRC_amount'     => $this->request->getRequestParam('PRC_amount', 0, DataType::FLOAT),
+			'PRC_name'       => $this->request->getRequestParam('PRC_name'),
+			'PRC_desc'       => $this->request->getRequestParam('PRC_desc'),
+			'PRC_is_default' => 1,
+			'PRC_overrides'  => null,
+			'PRC_order'      => $PRC_order,
+			'PRC_deleted'    => 0,
+			'PRC_parent'     => 0,
+		];
+	}
+
+
+	/**
+	 * @param bool $insert - whether to insert or update
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_price(bool $insert = false)
+	{
+		// why be so pessimistic ???  : (
+		$updated = 0;
+
+		$set_column_values = $this->set_price_column_values();
+		// is this a new Price ?
+		if ($insert) {
+			// run the insert
+			$PRC_ID = EEM_Price::instance()->insert($set_column_values);
+			if ($PRC_ID) {
+				// make sure this new price modifier is attached to the ticket but ONLY if it is not a tax type
+				$price = EEM_price::instance()->get_one_by_ID($PRC_ID);
+				if (
+					$price instanceof EE_Price
+					&& $price->type_obj() instanceof EE_Price_type
+					&& $price->type_obj()->base_type() !== EEM_Price_Type::base_type_tax
+				) {
+					$ticket = EEM_Ticket::instance()->get_one_by_ID(1);
+					$ticket->_add_relation_to($price, 'Price');
+					$ticket->save();
+				}
+				$updated = 1;
+			}
+			$action_desc = 'created';
+		} else {
+			$PRC_ID = $this->request->getRequestParam('PRC_ID', 0, DataType::INTEGER);
+			// run the update
+			$where_cols_n_values = ['PRC_ID' => $PRC_ID];
+			$updated             = EEM_Price::instance()->update($set_column_values, [$where_cols_n_values]);
+
+			$price = EEM_Price::instance()->get_one_by_ID($PRC_ID);
+			if ($price instanceof EE_Price && $price->type_obj()->base_type() !== EEM_Price_Type::base_type_tax) {
+				// if this is $PRC_ID == 1,
+				// then we need to update the default ticket attached to this price so the TKT_price value is updated.
+				if ($PRC_ID === 1) {
+					$ticket = $price->get_first_related('Ticket');
+					if ($ticket) {
+						$ticket->set('TKT_price', $price->get('PRC_amount'));
+						$ticket->set('TKT_name', $price->get('PRC_name'));
+						$ticket->set('TKT_description', $price->get('PRC_desc'));
+						$ticket->save();
+					}
+				} else {
+					// we make sure this price is attached to base ticket. but ONLY if it's not a tax ticket type.
+					$ticket = EEM_Ticket::instance()->get_one_by_ID(1);
+					if ($ticket instanceof EE_Ticket) {
+						$ticket->_add_relation_to($PRC_ID, 'Price');
+						$ticket->save();
+					}
+				}
+			}
+
+			$action_desc = 'updated';
+		}
+
+		$query_args = ['action' => 'edit_price', 'id' => $PRC_ID];
+
+		$this->_redirect_after_action($updated, 'Prices', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param bool $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _trash_or_restore_price($trash = true)
+	{
+		$entity_model = EEM_Price::instance();
+		$action       = $trash ? EE_Admin_List_Table::ACTION_TRASH : EE_Admin_List_Table::ACTION_RESTORE;
+		$result       = $this->trashRestoreDeleteEntities(
+			$entity_model,
+			'id',
+			$action,
+			'PRC_deleted',
+			[$this, 'adjustTicketRelations']
+		);
+
+		if ($result) {
+			$msg = $trash
+				? esc_html(
+					_n(
+						'The Price has been trashed',
+						'The Prices have been trashed',
+						$result,
+						'event_espresso'
+					)
+				)
+				: esc_html(
+					_n(
+						'The Price has been restored',
+						'The Prices have been restored',
+						$result,
+						'event_espresso'
+					)
+				);
+			EE_Error::add_success($msg);
+		}
+
+		$this->_redirect_after_action(
+			$result,
+			_n('Price', 'Prices', $result, 'event_espresso'),
+			$trash ? 'trashed' : 'restored',
+			['action' => 'default'],
+			true
+		);
+	}
+
+
+	/**
+	 * @param EEM_Base   $entity_model
+	 * @param int|string $entity_ID
+	 * @param string     $action
+	 * @param int        $result
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.30.p
+	 */
+	public function adjustTicketRelations(
+		EEM_Base $entity_model,
+		$entity_ID,
+		string $action,
+		int $result
+	) {
+		if (! $entity_ID || (float) $result < 1) {
+			return;
+		}
+
+		$entity = $entity_model->get_one_by_ID($entity_ID);
+		if (! $entity instanceof EE_Price || $entity->type_obj()->base_type() === EEM_Price_Type::base_type_tax) {
+			return;
+		}
+
+		// get default tickets for updating
+		$default_tickets = EEM_Ticket::instance()->get_all_default_tickets();
+		foreach ($default_tickets as $default_ticket) {
+			if (! $default_ticket instanceof EE_Ticket) {
+				continue;
+			}
+			switch ($action) {
+				case EE_Admin_List_Table::ACTION_DELETE:
+				case EE_Admin_List_Table::ACTION_TRASH:
+					// if trashing then remove relations to base default ticket.
+					$default_ticket->_remove_relation_to($entity_ID, 'Price');
+					break;
+				case EE_Admin_List_Table::ACTION_RESTORE:
+					// if restoring then add back to base default ticket
+					$default_ticket->_add_relation_to($entity_ID, 'Price');
+					break;
+			}
+			$default_ticket->save();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_price()
+	{
+		$entity_model = EEM_Price::instance();
+		$deleted      = $this->trashRestoreDeleteEntities($entity_model, 'id');
+		$entity       = $entity_model->item_name($deleted);
+		$this->_redirect_after_action(
+			$deleted,
+			$entity,
+			'deleted',
+			['action' => 'default']
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_price_order()
+	{
+		// grab our row IDs
+		$row_ids = $this->request->getRequestParam('row_ids', '');
+		$row_ids = explode(',', rtrim($row_ids, ','));
+
+		$all_updated = true;
+		foreach ($row_ids as $i => $row_id) {
+			// Update the prices when re-ordering
+			$fields_n_values = ['PRC_order' => $i + 1];
+			$query_params    = [['PRC_ID' => absint($row_id)]];
+			// any failure will toggle $all_updated to false
+			$all_updated = $row_id && EEM_Price::instance()->update($fields_n_values, $query_params) !== false
+				? $all_updated
+				: false;
+		}
+		$success = $all_updated
+			? esc_html__('Price order was updated successfully.', 'event_espresso')
+			: false;
+		$errors  = ! $all_updated
+			? esc_html__('An error occurred. The price order was not updated.', 'event_espresso')
+			: false;
+
+		echo wp_json_encode(['return_data' => false, 'success' => $success, 'errors' => $errors]);
+		die();
+	}
+
+
+	/******************************************************************************************************************
      ***********************************************  TICKET PRICE TYPES  *********************************************
      ******************************************************************************************************************/
 
 
-    /**
-     * generates HTML for main Prices Admin page
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _price_types_overview_list_table()
-    {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_new_price_type',
-            'add_type',
-            [],
-            'add-new-h2'
-        );
-        $this->_admin_page_title .= $this->_learn_more_about_pricing_link();
-        $this->_search_btn_label = esc_html__('Price Types', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * retrieve data for Price Types List table
-     *
-     * @param int  $per_page how many prices displayed per page
-     * @param bool $count    return the count or objects
-     * @param bool $trashed  whether the current view is of the trash can - eww yuck!
-     * @return EE_Soft_Delete_Base_Class[]|int int = count || array of price objects
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_price_types_overview_data(int $per_page = 10, bool $count = false, bool $trashed = false)
-    {
-        // start with an empty array
-        require_once(PRICING_ADMIN . 'Price_Types_List_Table.class.php');
-
-        $orderby = $this->request->getRequestParam('orderby', '');
-        $order   = $this->request->getRequestParam('order', 'ASC');
-
-        switch ($orderby) {
-            case 'name':
-                $orderby = ['PRT_name' => $order];
-                break;
-            default:
-                $orderby = ['PRT_order' => $order];
-        }
-
-        $current_page = $this->request->getRequestParam('paged', 1, DataType::INTEGER);
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, DataType::INTEGER);
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $where = ['PRT_deleted' => $trashed, 'PBT_ID' => ['!=', 1]];
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $where['OR'] = [
-                'PRT_name' => ['LIKE', "%{$search_term}%"],
-            ];
-        }
-        $query_params = [
-            $where,
-            'order_by' => $orderby,
-            'limit'    => $limit,
-        ];
-        return $count
-            ? EEM_Price_Type::instance()->count_deleted_and_undeleted($query_params)
-            : EEM_Price_Type::instance()->get_all_deleted_and_undeleted($query_params);
-    }
-
-
-    /**
-     * _edit_price_type_details
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _edit_price_type_details()
-    {
-        // grab price type ID
-        $PRT_ID = $this->request->getRequestParam('id', 0, DataType::INTEGER);
-        // change page title based on request action
-        switch ($this->_req_action) {
-            case 'add_new_price_type':
-                $this->_admin_page_title = esc_html__('Add New Price Type', 'event_espresso');
-                break;
-            case 'edit_price_type':
-                $this->_admin_page_title = esc_html__('Edit Price Type', 'event_espresso');
-                break;
-            default:
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-        // add PRT_ID to title if editing
-        $this->_admin_page_title = $PRT_ID ? $this->_admin_page_title . ' # ' . $PRT_ID : $this->_admin_page_title;
-
-        if ($PRT_ID) {
-            $price_type               = EEM_Price_Type::instance()->get_one_by_ID($PRT_ID);
-            $additional_hidden_fields = ['PRT_ID' => ['type' => 'hidden', 'value' => $PRT_ID]];
-            $this->_set_add_edit_form_tags('update_price_type', $additional_hidden_fields);
-        } else {
-            $price_type = EEM_Price_Type::instance()->get_new_price_type();
-            $this->_set_add_edit_form_tags('insert_price_type');
-        }
-
-        if (! $price_type instanceof EE_Price_Type) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'A valid Price Type could not be retrieved from the database with ID: %1$s',
-                        'event_espresso'
-                    ),
-                    $PRT_ID
-                )
-            );
-        }
-
-        $this->_template_args['PRT_ID']     = $PRT_ID;
-        $this->_template_args['price_type'] = $price_type;
-
-        $base_types    = EEM_Price_Type::instance()->get_base_types();
-        $select_values = [];
-        foreach ($base_types as $ref => $text) {
-            if ($ref == EEM_Price_Type::base_type_base_price) {
-                // do not allow creation of base_type_base_prices because that's a system only base type.
-                continue;
-            }
-            $select_values[] = ['id' => $ref, 'text' => $text];
-        }
-
-        $this->_template_args['base_type_select'] = EEH_Form_Fields::select_input(
-            'base_type',
-            $select_values,
-            $price_type->base_type(),
-            'id="price-type-base-type-slct"'
-        );
-
-        $this->_template_args['learn_more_about_pricing_link'] = $this->_learn_more_about_pricing_link();
-        $this->_template_args['admin_page_content']            = $this->_edit_price_type_details_meta_box();
-
-        $redirect_URL = add_query_arg(['action' => 'price_types'], $this->_admin_base_url);
-        $this->_set_publish_post_box_vars('id', $PRT_ID, false, $redirect_URL, true);
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _edit_price_type_details_meta_box
-     *
-     * @return string
-     */
-    public function _edit_price_type_details_meta_box(): string
-    {
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'pricing_type_details_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function set_price_type_column_values(): array
-    {
-        $base_type  = $this->request->getRequestParam(
-            'base_type',
-            EEM_Price_Type::base_type_base_price,
-            DataType::INTEGER
-        );
-        $is_percent = $this->request->getRequestParam('PRT_is_percent', 0, DataType::INTEGER);
-        $order      = $this->request->getRequestParam('PRT_order', 0, DataType::INTEGER);
-        switch ($base_type) {
-            case EEM_Price_Type::base_type_base_price:
-                $is_percent = 0;
-                $order      = 0;
-                break;
-
-            case EEM_Price_Type::base_type_discount:
-            case EEM_Price_Type::base_type_surcharge:
-                break;
-
-            case EEM_Price_Type::base_type_tax:
-                $is_percent = 1;
-                break;
-        }
-
-        return [
-            'PBT_ID'         => $base_type,
-            'PRT_name'       => $this->request->getRequestParam('PRT_name', ''),
-            'PRT_is_percent' => $is_percent,
-            'PRT_order'      => $order,
-            'PRT_deleted'    => 0,
-        ];
-    }
-
-
-    /**
-     * @param bool $new_price_type - whether to insert or update
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_price_type(bool $new_price_type = false)
-    {
-        // why be so pessimistic ???  : (
-        $success = 0;
-
-        $set_column_values = $this->set_price_type_column_values();
-        // is this a new Price ?
-        if ($new_price_type) {
-            // run the insert
-            if ($PRT_ID = EEM_Price_Type::instance()->insert($set_column_values)) {
-                $success = 1;
-            }
-            $action_desc = 'created';
-        } else {
-            $PRT_ID = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
-            // run the update
-            $where_cols_n_values = ['PRT_ID' => $PRT_ID];
-            if (EEM_Price_Type::instance()->update($set_column_values, [$where_cols_n_values])) {
-                $success = 1;
-            }
-            $action_desc = 'updated';
-        }
-
-        $query_args = ['action' => 'edit_price_type', 'id' => $PRT_ID];
-        $this->_redirect_after_action($success, 'Price Type', $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param bool $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_price_type(bool $trash = true)
-    {
-        $entity_model = EEM_Price_Type::instance();
-        $action       = $trash ? EE_Admin_List_Table::ACTION_TRASH : EE_Admin_List_Table::ACTION_RESTORE;
-        $success      = $this->trashRestoreDeleteEntities($entity_model, 'id', $action, 'PRT_deleted');
-        if ($success) {
-            $msg = $trash
-                ? esc_html(
-                    _n(
-                        'The Price Type has been trashed',
-                        'The Price Types have been trashed',
-                        $success,
-                        'event_espresso'
-                    )
-                )
-                : esc_html(
-                    _n(
-                        'The Price Type has been restored',
-                        'The Price Types have been restored',
-                        $success,
-                        'event_espresso'
-                    )
-                );
-            EE_Error::add_success($msg);
-        }
-        $this->_redirect_after_action('', '', '', ['action' => 'price_types'], true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_price_type()
-    {
-        $entity_model = EEM_Price_Type::instance();
-        $deleted      = $this->trashRestoreDeleteEntities($entity_model, 'id');
-        $this->_redirect_after_action(
-            $deleted,
-            $entity_model->item_name($deleted),
-            'deleted',
-            ['action' => 'price_types']
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _learn_more_about_pricing_link(): string
-    {
-        return '
+	/**
+	 * generates HTML for main Prices Admin page
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _price_types_overview_list_table()
+	{
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_new_price_type',
+			'add_type',
+			[],
+			'add-new-h2'
+		);
+		$this->_admin_page_title .= $this->_learn_more_about_pricing_link();
+		$this->_search_btn_label = esc_html__('Price Types', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * retrieve data for Price Types List table
+	 *
+	 * @param int  $per_page how many prices displayed per page
+	 * @param bool $count    return the count or objects
+	 * @param bool $trashed  whether the current view is of the trash can - eww yuck!
+	 * @return EE_Soft_Delete_Base_Class[]|int int = count || array of price objects
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_price_types_overview_data(int $per_page = 10, bool $count = false, bool $trashed = false)
+	{
+		// start with an empty array
+		require_once(PRICING_ADMIN . 'Price_Types_List_Table.class.php');
+
+		$orderby = $this->request->getRequestParam('orderby', '');
+		$order   = $this->request->getRequestParam('order', 'ASC');
+
+		switch ($orderby) {
+			case 'name':
+				$orderby = ['PRT_name' => $order];
+				break;
+			default:
+				$orderby = ['PRT_order' => $order];
+		}
+
+		$current_page = $this->request->getRequestParam('paged', 1, DataType::INTEGER);
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, DataType::INTEGER);
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$where = ['PRT_deleted' => $trashed, 'PBT_ID' => ['!=', 1]];
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$where['OR'] = [
+				'PRT_name' => ['LIKE', "%{$search_term}%"],
+			];
+		}
+		$query_params = [
+			$where,
+			'order_by' => $orderby,
+			'limit'    => $limit,
+		];
+		return $count
+			? EEM_Price_Type::instance()->count_deleted_and_undeleted($query_params)
+			: EEM_Price_Type::instance()->get_all_deleted_and_undeleted($query_params);
+	}
+
+
+	/**
+	 * _edit_price_type_details
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _edit_price_type_details()
+	{
+		// grab price type ID
+		$PRT_ID = $this->request->getRequestParam('id', 0, DataType::INTEGER);
+		// change page title based on request action
+		switch ($this->_req_action) {
+			case 'add_new_price_type':
+				$this->_admin_page_title = esc_html__('Add New Price Type', 'event_espresso');
+				break;
+			case 'edit_price_type':
+				$this->_admin_page_title = esc_html__('Edit Price Type', 'event_espresso');
+				break;
+			default:
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+		// add PRT_ID to title if editing
+		$this->_admin_page_title = $PRT_ID ? $this->_admin_page_title . ' # ' . $PRT_ID : $this->_admin_page_title;
+
+		if ($PRT_ID) {
+			$price_type               = EEM_Price_Type::instance()->get_one_by_ID($PRT_ID);
+			$additional_hidden_fields = ['PRT_ID' => ['type' => 'hidden', 'value' => $PRT_ID]];
+			$this->_set_add_edit_form_tags('update_price_type', $additional_hidden_fields);
+		} else {
+			$price_type = EEM_Price_Type::instance()->get_new_price_type();
+			$this->_set_add_edit_form_tags('insert_price_type');
+		}
+
+		if (! $price_type instanceof EE_Price_Type) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'A valid Price Type could not be retrieved from the database with ID: %1$s',
+						'event_espresso'
+					),
+					$PRT_ID
+				)
+			);
+		}
+
+		$this->_template_args['PRT_ID']     = $PRT_ID;
+		$this->_template_args['price_type'] = $price_type;
+
+		$base_types    = EEM_Price_Type::instance()->get_base_types();
+		$select_values = [];
+		foreach ($base_types as $ref => $text) {
+			if ($ref == EEM_Price_Type::base_type_base_price) {
+				// do not allow creation of base_type_base_prices because that's a system only base type.
+				continue;
+			}
+			$select_values[] = ['id' => $ref, 'text' => $text];
+		}
+
+		$this->_template_args['base_type_select'] = EEH_Form_Fields::select_input(
+			'base_type',
+			$select_values,
+			$price_type->base_type(),
+			'id="price-type-base-type-slct"'
+		);
+
+		$this->_template_args['learn_more_about_pricing_link'] = $this->_learn_more_about_pricing_link();
+		$this->_template_args['admin_page_content']            = $this->_edit_price_type_details_meta_box();
+
+		$redirect_URL = add_query_arg(['action' => 'price_types'], $this->_admin_base_url);
+		$this->_set_publish_post_box_vars('id', $PRT_ID, false, $redirect_URL, true);
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _edit_price_type_details_meta_box
+	 *
+	 * @return string
+	 */
+	public function _edit_price_type_details_meta_box(): string
+	{
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'pricing_type_details_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function set_price_type_column_values(): array
+	{
+		$base_type  = $this->request->getRequestParam(
+			'base_type',
+			EEM_Price_Type::base_type_base_price,
+			DataType::INTEGER
+		);
+		$is_percent = $this->request->getRequestParam('PRT_is_percent', 0, DataType::INTEGER);
+		$order      = $this->request->getRequestParam('PRT_order', 0, DataType::INTEGER);
+		switch ($base_type) {
+			case EEM_Price_Type::base_type_base_price:
+				$is_percent = 0;
+				$order      = 0;
+				break;
+
+			case EEM_Price_Type::base_type_discount:
+			case EEM_Price_Type::base_type_surcharge:
+				break;
+
+			case EEM_Price_Type::base_type_tax:
+				$is_percent = 1;
+				break;
+		}
+
+		return [
+			'PBT_ID'         => $base_type,
+			'PRT_name'       => $this->request->getRequestParam('PRT_name', ''),
+			'PRT_is_percent' => $is_percent,
+			'PRT_order'      => $order,
+			'PRT_deleted'    => 0,
+		];
+	}
+
+
+	/**
+	 * @param bool $new_price_type - whether to insert or update
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_price_type(bool $new_price_type = false)
+	{
+		// why be so pessimistic ???  : (
+		$success = 0;
+
+		$set_column_values = $this->set_price_type_column_values();
+		// is this a new Price ?
+		if ($new_price_type) {
+			// run the insert
+			if ($PRT_ID = EEM_Price_Type::instance()->insert($set_column_values)) {
+				$success = 1;
+			}
+			$action_desc = 'created';
+		} else {
+			$PRT_ID = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
+			// run the update
+			$where_cols_n_values = ['PRT_ID' => $PRT_ID];
+			if (EEM_Price_Type::instance()->update($set_column_values, [$where_cols_n_values])) {
+				$success = 1;
+			}
+			$action_desc = 'updated';
+		}
+
+		$query_args = ['action' => 'edit_price_type', 'id' => $PRT_ID];
+		$this->_redirect_after_action($success, 'Price Type', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param bool $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_price_type(bool $trash = true)
+	{
+		$entity_model = EEM_Price_Type::instance();
+		$action       = $trash ? EE_Admin_List_Table::ACTION_TRASH : EE_Admin_List_Table::ACTION_RESTORE;
+		$success      = $this->trashRestoreDeleteEntities($entity_model, 'id', $action, 'PRT_deleted');
+		if ($success) {
+			$msg = $trash
+				? esc_html(
+					_n(
+						'The Price Type has been trashed',
+						'The Price Types have been trashed',
+						$success,
+						'event_espresso'
+					)
+				)
+				: esc_html(
+					_n(
+						'The Price Type has been restored',
+						'The Price Types have been restored',
+						$success,
+						'event_espresso'
+					)
+				);
+			EE_Error::add_success($msg);
+		}
+		$this->_redirect_after_action('', '', '', ['action' => 'price_types'], true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_price_type()
+	{
+		$entity_model = EEM_Price_Type::instance();
+		$deleted      = $this->trashRestoreDeleteEntities($entity_model, 'id');
+		$this->_redirect_after_action(
+			$deleted,
+			$entity_model->item_name($deleted),
+			'deleted',
+			['action' => 'price_types']
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _learn_more_about_pricing_link(): string
+	{
+		return '
             <a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >
                 ' . esc_html__('learn more about how pricing works', 'event_espresso') . '
             </a>';
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _tax_settings()
-    {
-        $this->_set_add_edit_form_tags('update_tax_settings');
-        $this->_set_publish_post_box_vars();
-        $this->_template_args['admin_page_content'] = $this->tax_settings_form()->get_html();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function tax_settings_form(): EE_Form_Section_Proper
-    {
-        $tax_settings = EE_Config::instance()->tax_settings;
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'tax_settings_form',
-                'html_id'         => 'tax_settings_form',
-                'html_class'      => 'padding',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Pricing_Admin_Page__tax_settings_form__form_subsections',
-                    [
-                        'tax_settings' => new EE_Form_Section_Proper(
-                            [
-                                'name'            => 'tax_settings_tbl',
-                                'html_id'         => 'tax_settings_tbl',
-                                'html_class'      => 'form-table',
-                                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                                'subsections'     => [
-                                    'prices_displayed_including_taxes' => new EE_Yes_No_Input(
-                                        [
-                                            'html_label_text'         => esc_html__(
-                                                'Show Prices With Taxes Included?',
-                                                'event_espresso'
-                                            ),
-                                            'html_help_text'          => esc_html__(
-                                                'Indicates whether or not to display prices with the taxes included',
-                                                'event_espresso'
-                                            ),
-                                            'default'                 => $tax_settings->prices_displayed_including_taxes
-                                                                         ?? true,
-                                            'display_html_label_text' => false,
-                                        ]
-                                    ),
-                                ],
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _update_tax_settings
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.9.13
-     */
-    public function _update_tax_settings()
-    {
-        $tax_settings = EE_Config::instance()->tax_settings;
-        if (! $tax_settings instanceof EE_Tax_Config) {
-            $tax_settings = new EE_Tax_Config();
-        }
-        try {
-            $tax_form = $this->tax_settings_form();
-            // check for form submission
-            if ($tax_form->was_submitted()) {
-                // capture form data
-                $tax_form->receive_form_submission();
-                // validate form data
-                if ($tax_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $tax_form->valid_data();
-                    // set data on config
-                    $tax_settings->prices_displayed_including_taxes =
-                        $valid_data['tax_settings']['prices_displayed_including_taxes'];
-                } else {
-                    if ($tax_form->submission_error_message() !== '') {
-                        EE_Error::add_error(
-                            $tax_form->submission_error_message(),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->get_error(), __FILE__, __FUNCTION__, __LINE__);
-        }
-
-        $what    = 'Tax Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            $tax_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action($success, $what, 'updated', ['action' => 'tax_settings']);
-    }
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _tax_settings()
+	{
+		$this->_set_add_edit_form_tags('update_tax_settings');
+		$this->_set_publish_post_box_vars();
+		$this->_template_args['admin_page_content'] = $this->tax_settings_form()->get_html();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function tax_settings_form(): EE_Form_Section_Proper
+	{
+		$tax_settings = EE_Config::instance()->tax_settings;
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'tax_settings_form',
+				'html_id'         => 'tax_settings_form',
+				'html_class'      => 'padding',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Pricing_Admin_Page__tax_settings_form__form_subsections',
+					[
+						'tax_settings' => new EE_Form_Section_Proper(
+							[
+								'name'            => 'tax_settings_tbl',
+								'html_id'         => 'tax_settings_tbl',
+								'html_class'      => 'form-table',
+								'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+								'subsections'     => [
+									'prices_displayed_including_taxes' => new EE_Yes_No_Input(
+										[
+											'html_label_text'         => esc_html__(
+												'Show Prices With Taxes Included?',
+												'event_espresso'
+											),
+											'html_help_text'          => esc_html__(
+												'Indicates whether or not to display prices with the taxes included',
+												'event_espresso'
+											),
+											'default'                 => $tax_settings->prices_displayed_including_taxes
+																		 ?? true,
+											'display_html_label_text' => false,
+										]
+									),
+								],
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _update_tax_settings
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.9.13
+	 */
+	public function _update_tax_settings()
+	{
+		$tax_settings = EE_Config::instance()->tax_settings;
+		if (! $tax_settings instanceof EE_Tax_Config) {
+			$tax_settings = new EE_Tax_Config();
+		}
+		try {
+			$tax_form = $this->tax_settings_form();
+			// check for form submission
+			if ($tax_form->was_submitted()) {
+				// capture form data
+				$tax_form->receive_form_submission();
+				// validate form data
+				if ($tax_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $tax_form->valid_data();
+					// set data on config
+					$tax_settings->prices_displayed_including_taxes =
+						$valid_data['tax_settings']['prices_displayed_including_taxes'];
+				} else {
+					if ($tax_form->submission_error_message() !== '') {
+						EE_Error::add_error(
+							$tax_form->submission_error_message(),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->get_error(), __FILE__, __FUNCTION__, __LINE__);
+		}
+
+		$what    = 'Tax Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			$tax_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action($success, $what, 'updated', ['action' => 'tax_settings']);
+	}
 }

caffeinated/modules/event_single_caff/EED_Event_Single_Caff.module.php

Indentation +226 added lines, -226 removed lines

@@ -24,230 +24,230 @@
  */
 class EED_Event_Single_Caff extends EED_Event_Single
 {
-    /**
-     * @return EED_Event_Single_Caff
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::setDefinitions();
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings',
-            array('EED_Event_Single_Caff', 'load_scripts_styles'),
-            10
-        );
-        add_action(
-            'AHEE__template_settings__template__before_settings_form',
-            array('EED_Event_Single_Caff', 'template_settings_form'),
-            10
-        );
-        add_filter(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            array('EED_Event_Single_Caff', 'update_template_settings'),
-            10,
-            2
-        );
-        // AJAX
-        add_action(
-            'wp_ajax_espresso_update_event_single_order',
-            array('EED_Event_Single_Caff', 'update_event_single_order')
-        );
-    }
-
-
-    public static function load_scripts_styles()
-    {
-        add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10);
-    }
-
-
-    public static function enqueue_scripts_styles()
-    {
-        wp_register_style(
-            'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('eed-event-single-sortable');
-        wp_register_script(
-            'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
-            array('espresso_core', 'jquery-ui-sortable'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('eed-event-single-sortable');
-    }
-
-
-    /**
-     * Set constants only if they haven't been set yet.
-     */
-    public static function setDefinitions()
-    {
-        if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
-            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        }
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    void
-     */
-    public static function template_settings_form()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings;
-        $config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config
-            ? $config->EED_Event_Single : new EE_Event_Single_Config();
-        $config->use_sortable_display_order = isset($config->use_sortable_display_order)
-            ? $config->use_sortable_display_order : false;
-        $config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
-
-        $event_single_order_array = array();
-        $event_single_order_array[ $config->display_order_tickets ] = 'tickets';
-        $event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
-        $event_single_order_array[ $config->display_order_event ] = 'event';
-        $event_single_order_array[ $config->display_order_venue ] = 'venue';
-        // get template parts
-        $template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
-        // convert to array so that we can add more properties
-        $config = get_object_vars($config);
-        $config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
-            'event-single-sortable-js',
-            '',
-            'single-sortable-li single-sortable-js'
-        );
-        EEH_Template::display_template(
-            EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
-            $config
-        );
-    }
-
-
-    /**
-     * update_template_settings
-     *
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ
-     * @return EE_Template_Config
-     */
-    public static function update_template_settings(EE_Template_Config $CFG, $REQ)
-    {
-        if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
-            $CFG->EED_Event_Single = new EE_Event_Single_Config();
-        }
-        $display_order_event = $CFG->EED_Event_Single->display_order_event !== null
-            ? $CFG->EED_Event_Single->display_order_event
-            : EED_Event_Single::EVENT_DETAILS_PRIORITY;
-        $display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null
-            ? $CFG->EED_Event_Single->display_order_datetimes
-            : EED_Event_Single::EVENT_DATETIMES_PRIORITY;
-        $display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null
-            ? $CFG->EED_Event_Single->display_order_tickets
-            : EED_Event_Single::EVENT_TICKETS_PRIORITY;
-        $display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null
-            ? $CFG->EED_Event_Single->display_order_venue
-            : EED_Event_Single::EVENT_VENUES_PRIORITY;
-        $CFG->EED_Event_Single = new EE_Event_Single_Config();
-        $CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single'])
-                                                               && $REQ['display_status_banner_single'];
-        $CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue'];
-        $CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order'])
-            ? absint($REQ['EED_Events_Single_use_sortable_display_order'])
-            : 0;
-        $CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_event
-            : EED_Event_Single::EVENT_DETAILS_PRIORITY;
-        $CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_datetimes
-            : EED_Event_Single::EVENT_DATETIMES_PRIORITY;
-        $CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_tickets
-            : EED_Event_Single::EVENT_TICKETS_PRIORITY;
-        $CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_venue
-            : EED_Event_Single::EVENT_VENUES_PRIORITY;
-        do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ);
-        return $CFG;
-    }
-
-
-    /**
-     * update_event_single_order
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function update_event_single_order()
-    {
-        if (
-            ! isset(EE_Registry::instance()->CFG->template_settings->EED_Event_Single)
-            || ! EE_Registry::instance()->CFG->template_settings->EED_Event_Single instanceof EE_Event_Single_Config
-        ) {
-            EE_Registry::instance()->CFG->template_settings->EED_Event_Single = new EE_Event_Single_Config();
-        }
-        $config_saved = false;
-        $template_parts = EED_Event_Single_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
-            $template_parts = explode(',', trim($template_parts, ','));
-            foreach ($template_parts as $key => $template_part) {
-                $template_part = "display_order_$template_part";
-                $priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY;
-                EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority;
-                do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority);
-            }
-            $config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false);
-        }
-        if ($config_saved) {
-            EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                esc_html__('Display Order was not updated.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        echo wp_json_encode(EE_Error::get_notices(false));
-        exit();
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * @return EED_Event_Single_Caff
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::setDefinitions();
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings',
+			array('EED_Event_Single_Caff', 'load_scripts_styles'),
+			10
+		);
+		add_action(
+			'AHEE__template_settings__template__before_settings_form',
+			array('EED_Event_Single_Caff', 'template_settings_form'),
+			10
+		);
+		add_filter(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			array('EED_Event_Single_Caff', 'update_template_settings'),
+			10,
+			2
+		);
+		// AJAX
+		add_action(
+			'wp_ajax_espresso_update_event_single_order',
+			array('EED_Event_Single_Caff', 'update_event_single_order')
+		);
+	}
+
+
+	public static function load_scripts_styles()
+	{
+		add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10);
+	}
+
+
+	public static function enqueue_scripts_styles()
+	{
+		wp_register_style(
+			'eed-event-single-sortable',
+			EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('eed-event-single-sortable');
+		wp_register_script(
+			'eed-event-single-sortable',
+			EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
+			array('espresso_core', 'jquery-ui-sortable'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('eed-event-single-sortable');
+	}
+
+
+	/**
+	 * Set constants only if they haven't been set yet.
+	 */
+	public static function setDefinitions()
+	{
+		if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
+			define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+			define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		}
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    void
+	 */
+	public static function template_settings_form()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings;
+		$config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config
+			? $config->EED_Event_Single : new EE_Event_Single_Config();
+		$config->use_sortable_display_order = isset($config->use_sortable_display_order)
+			? $config->use_sortable_display_order : false;
+		$config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
+
+		$event_single_order_array = array();
+		$event_single_order_array[ $config->display_order_tickets ] = 'tickets';
+		$event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
+		$event_single_order_array[ $config->display_order_event ] = 'event';
+		$event_single_order_array[ $config->display_order_venue ] = 'venue';
+		// get template parts
+		$template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
+		// convert to array so that we can add more properties
+		$config = get_object_vars($config);
+		$config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
+			'event-single-sortable-js',
+			'',
+			'single-sortable-li single-sortable-js'
+		);
+		EEH_Template::display_template(
+			EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
+			$config
+		);
+	}
+
+
+	/**
+	 * update_template_settings
+	 *
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ
+	 * @return EE_Template_Config
+	 */
+	public static function update_template_settings(EE_Template_Config $CFG, $REQ)
+	{
+		if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
+			$CFG->EED_Event_Single = new EE_Event_Single_Config();
+		}
+		$display_order_event = $CFG->EED_Event_Single->display_order_event !== null
+			? $CFG->EED_Event_Single->display_order_event
+			: EED_Event_Single::EVENT_DETAILS_PRIORITY;
+		$display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null
+			? $CFG->EED_Event_Single->display_order_datetimes
+			: EED_Event_Single::EVENT_DATETIMES_PRIORITY;
+		$display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null
+			? $CFG->EED_Event_Single->display_order_tickets
+			: EED_Event_Single::EVENT_TICKETS_PRIORITY;
+		$display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null
+			? $CFG->EED_Event_Single->display_order_venue
+			: EED_Event_Single::EVENT_VENUES_PRIORITY;
+		$CFG->EED_Event_Single = new EE_Event_Single_Config();
+		$CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single'])
+															   && $REQ['display_status_banner_single'];
+		$CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue'];
+		$CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order'])
+			? absint($REQ['EED_Events_Single_use_sortable_display_order'])
+			: 0;
+		$CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_event
+			: EED_Event_Single::EVENT_DETAILS_PRIORITY;
+		$CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_datetimes
+			: EED_Event_Single::EVENT_DATETIMES_PRIORITY;
+		$CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_tickets
+			: EED_Event_Single::EVENT_TICKETS_PRIORITY;
+		$CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_venue
+			: EED_Event_Single::EVENT_VENUES_PRIORITY;
+		do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ);
+		return $CFG;
+	}
+
+
+	/**
+	 * update_event_single_order
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function update_event_single_order()
+	{
+		if (
+			! isset(EE_Registry::instance()->CFG->template_settings->EED_Event_Single)
+			|| ! EE_Registry::instance()->CFG->template_settings->EED_Event_Single instanceof EE_Event_Single_Config
+		) {
+			EE_Registry::instance()->CFG->template_settings->EED_Event_Single = new EE_Event_Single_Config();
+		}
+		$config_saved = false;
+		$template_parts = EED_Event_Single_Caff::getRequest()->getRequestParam('elements');
+		if (! empty($template_parts)) {
+			$template_parts = explode(',', trim($template_parts, ','));
+			foreach ($template_parts as $key => $template_part) {
+				$template_part = "display_order_$template_part";
+				$priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY;
+				EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority;
+				do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority);
+			}
+			$config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false);
+		}
+		if ($config_saved) {
+			EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				esc_html__('Display Order was not updated.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		echo wp_json_encode(EE_Error::get_notices(false));
+		exit();
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }

espresso.php

Indentation +97 added lines, -97 removed lines

@@ -37,124 +37,124 @@
  * @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="http://php.net/downloads.php">http://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="http://php.net/downloads.php">http://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/wp-graphql/wp-graphql/wp-graphql.php';
+		require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.4.rc.000');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.4.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
-            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
+			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
-            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
+			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($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($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/EE_Maintenance_Mode.core.php

Indentation +355 added lines, -355 removed lines

@@ -16,361 +16,361 @@
  */
 class EE_Maintenance_Mode implements ResettableInterface
 {
-    /**
-     * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
-     * level_0_not_in_maintenance means the site is NOT in maintenance mode (so everything's normal)
-     */
-    const level_0_not_in_maintenance = 0;
-
-    /**
-     * level_1_frontend_only_maintenance means that the site's frontend EE code should be completely disabled
-     * but the admin backend should be running as normal. Maybe an admin can view the frontend though
-     */
-    const level_1_frontend_only_maintenance = 1;
-
-    /**
-     * level_2_complete_maintenance means the frontend AND EE backend code are disabled. The only system running
-     * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
-     * migration scripts before taking the site out of maintenance mode
-     */
-    const level_2_complete_maintenance = 2;
-
-    /**
-     * the name of the option which stores the current level of maintenance mode
-     */
-    const option_name_maintenance_mode = 'ee_maintenance_mode';
-
-
-    /**
-     * @var EE_Maintenance_Mode $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $EE
-     */
-    protected $EE;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Maintenance_Mode
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets maintenance mode (mostly just re-checks whether we should be in maintenance mode)
-     *
-     * @return EE_Maintenance_Mode
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::instance()->set_maintenance_mode_if_db_old();
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     */
-    private function __construct()
-    {
-        // if M-Mode level 2 is engaged, we still need basic assets loaded
-        add_action('wp_enqueue_scripts', [$this, 'load_assets_required_for_m_mode']);
-        // shut 'er down for maintenance ?
-        add_filter('the_content', [$this, 'the_content'], 2);
-        // redirect ee menus to maintenance page
-        add_action('admin_page_access_denied', [$this, 'redirect_to_maintenance']);
-        // add powered by EE msg
-        add_action('shutdown', [$this, 'display_maintenance_mode_notice'], 10);
-    }
-
-
-    /**
-     * retrieves the maintenance mode option value from the db
-     *
-     * @return int
-     */
-    public function real_level()
-    {
-        return (int) get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
-    }
-
-
-    /**
-     * Returns whether the models reportedly are able to run queries or not
-     * (ie, if the system thinks their tables are present and up-to-date).
-     *
-     * @return boolean
-     */
-    public function models_can_query()
-    {
-        return $this->real_level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
-    }
-
-
-    /**
-     * Determines whether we're in maintenance mode and what level. However, while the site
-     * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
-     * to them as if teh site isn't in maintenance mode.
-     * EE_Maintenance_Mode::level_0_not_in_maintenance => not in maintenance mode (in normal mode)
-     * EE_Maintenance_Mode::level_1_frontend_only_maintenance=> frontend-only maintenance mode
-     * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
-     *
-     * @return int
-     */
-    public function level()
-    {
-        $maintenance_mode_level = $this->real_level();
-        // if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
-        if (
-            $maintenance_mode_level === EE_Maintenance_Mode::level_1_frontend_only_maintenance// we're in level 1
-            && ((defined('DOING_AJAX') && DOING_AJAX) || ! is_admin()) // on non-ajax frontend requests
-            && current_user_can('administrator') // when the user is an admin
-        ) {
-            $maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
-        }
-        return $maintenance_mode_level;
-    }
-
-
-    /**
-     * Determines if we need to put EE in maintenance mode because the database needs updating
-     *
-     * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
-     * @throws EE_Error
-     */
-    public function set_maintenance_mode_if_db_old()
-    {
-        LoaderFactory::getLoader()->getShared('Data_Migration_Manager');
-        if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
-            update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
-            return true;
-        }
-        if ($this->level() === self::level_2_complete_maintenance) {
-            // we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
-            // then we shouldn't be in mm2. (Maybe an addon got deactivated?)
-            update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
-            return false;
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the maintenance level on the site
-     *
-     * @param int $level
-     * @return void
-     */
-    public function set_maintenance_level($level)
-    {
-        do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
-        update_option(self::option_name_maintenance_mode, (int) $level);
-    }
-
-
-    /**
-     * returns TRUE if M-Mode is engaged and the current request is not for the admin
-     *
-     * @return bool
-     */
-    public static function disable_frontend_for_maintenance()
-    {
-        return (! is_admin() && EE_Maintenance_Mode::instance()->level());
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_assets_required_for_m_mode()
-    {
-        if (
-            $this->real_level() === EE_Maintenance_Mode::level_2_complete_maintenance
-            && ! wp_script_is('espresso_core')
-        ) {
-            wp_register_style(
-                'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                ['dashicons'],
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('espresso_default');
-            wp_register_script(
-                'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-                ['jquery'],
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('espresso_core');
-        }
-    }
-
-
-    /**
-     * replacement EE CPT template that displays message notifying site visitors
-     * that EE has been temporarily placed into maintenance mode
-     * does NOT get called on non-EE-CPT requests
-     *
-     * @return    string
-     */
-    public static function template_include()
-    {
-        // shut 'er down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
-    }
-
-
-    /**
-     * displays message notifying site visitors that EE has been temporarily
-     * placed into maintenance mode when post_type != EE CPT
-     *
-     * @param string $the_content
-     * @return string
-     */
-    public function the_content($the_content)
-    {
-        // check if M-mode is engaged and for EE shortcode
-        if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
-            // this can eventually be moved to a template, or edited via admin. But for now...
-            $the_content = sprintf(
-                esc_html__(
-                    '%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
-                    'event_espresso'
-                ),
-                '<h3>',
-                '</h3><p>',
-                '</p>'
-            );
-        }
-        return $the_content;
-    }
-
-
-    /**
-     * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
-     */
-    public function display_maintenance_mode_notice()
-    {
-        /** @var CurrentPage $current_page */
-        $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        // check if M-mode is engaged and for EE shortcode
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && $this->real_level()
-            && ! is_admin()
-            && current_user_can('administrator')
-            && $current_page->isEspressoPage()
-        ) {
-            printf(
-                esc_html__(
-                    '%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
-                    'event_espresso'
-                ),
-                '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
-                '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
-                    ['page' => 'espresso_maintenance_settings'],
-                    admin_url('admin.php')
-                ) . '">',
-                '</a></p></div>'
-            );
-        }
-    }
-    // espresso-notices important-notice ee-attention
-
-    /**
-     * Redirects EE admin menu requests to the maintenance page
-     */
-    public function redirect_to_maintenance()
-    {
-        global $pagenow;
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page   = $request->getRequestParam('page');
-
-        if (
-            $pagenow == 'admin.php'
-            && $page !== 'espresso_maintenance_settings'
-            && strpos($page, 'espresso_') !== false
-            && $this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            EEH_URL::safeRedirectAndExit('admin.php?page=espresso_maintenance_settings');
-        }
-    }
-
-
-    /**
-     * override magic methods
-     */
-    final public function __destruct()
-    {
-    }
-
-
-    final public function __call($a, $b)
-    {
-    }
-
-
-    final public function __get($a)
-    {
-    }
-
-
-    final public function __set($a, $b)
-    {
-    }
-
-
-    final public function __isset($a)
-    {
-    }
-
-
-    final public function __unset($a)
-    {
-    }
-
-
-    final public function __sleep()
-    {
-        return [];
-    }
-
-
-    final public function __wakeup()
-    {
-    }
-
-
-    final public function __invoke()
-    {
-    }
-
-
-    final public static function __set_state($a = null)
-    {
-        return EE_Maintenance_Mode::instance();
-    }
-
-
-    final public function __clone()
-    {
-    }
+	/**
+	 * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
+	 * level_0_not_in_maintenance means the site is NOT in maintenance mode (so everything's normal)
+	 */
+	const level_0_not_in_maintenance = 0;
+
+	/**
+	 * level_1_frontend_only_maintenance means that the site's frontend EE code should be completely disabled
+	 * but the admin backend should be running as normal. Maybe an admin can view the frontend though
+	 */
+	const level_1_frontend_only_maintenance = 1;
+
+	/**
+	 * level_2_complete_maintenance means the frontend AND EE backend code are disabled. The only system running
+	 * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
+	 * migration scripts before taking the site out of maintenance mode
+	 */
+	const level_2_complete_maintenance = 2;
+
+	/**
+	 * the name of the option which stores the current level of maintenance mode
+	 */
+	const option_name_maintenance_mode = 'ee_maintenance_mode';
+
+
+	/**
+	 * @var EE_Maintenance_Mode $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $EE
+	 */
+	protected $EE;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Maintenance_Mode
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Maintenance_Mode) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets maintenance mode (mostly just re-checks whether we should be in maintenance mode)
+	 *
+	 * @return EE_Maintenance_Mode
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::instance()->set_maintenance_mode_if_db_old();
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 */
+	private function __construct()
+	{
+		// if M-Mode level 2 is engaged, we still need basic assets loaded
+		add_action('wp_enqueue_scripts', [$this, 'load_assets_required_for_m_mode']);
+		// shut 'er down for maintenance ?
+		add_filter('the_content', [$this, 'the_content'], 2);
+		// redirect ee menus to maintenance page
+		add_action('admin_page_access_denied', [$this, 'redirect_to_maintenance']);
+		// add powered by EE msg
+		add_action('shutdown', [$this, 'display_maintenance_mode_notice'], 10);
+	}
+
+
+	/**
+	 * retrieves the maintenance mode option value from the db
+	 *
+	 * @return int
+	 */
+	public function real_level()
+	{
+		return (int) get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
+	}
+
+
+	/**
+	 * Returns whether the models reportedly are able to run queries or not
+	 * (ie, if the system thinks their tables are present and up-to-date).
+	 *
+	 * @return boolean
+	 */
+	public function models_can_query()
+	{
+		return $this->real_level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
+	}
+
+
+	/**
+	 * Determines whether we're in maintenance mode and what level. However, while the site
+	 * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
+	 * to them as if teh site isn't in maintenance mode.
+	 * EE_Maintenance_Mode::level_0_not_in_maintenance => not in maintenance mode (in normal mode)
+	 * EE_Maintenance_Mode::level_1_frontend_only_maintenance=> frontend-only maintenance mode
+	 * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
+	 *
+	 * @return int
+	 */
+	public function level()
+	{
+		$maintenance_mode_level = $this->real_level();
+		// if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
+		if (
+			$maintenance_mode_level === EE_Maintenance_Mode::level_1_frontend_only_maintenance// we're in level 1
+			&& ((defined('DOING_AJAX') && DOING_AJAX) || ! is_admin()) // on non-ajax frontend requests
+			&& current_user_can('administrator') // when the user is an admin
+		) {
+			$maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
+		}
+		return $maintenance_mode_level;
+	}
+
+
+	/**
+	 * Determines if we need to put EE in maintenance mode because the database needs updating
+	 *
+	 * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
+	 * @throws EE_Error
+	 */
+	public function set_maintenance_mode_if_db_old()
+	{
+		LoaderFactory::getLoader()->getShared('Data_Migration_Manager');
+		if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
+			update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
+			return true;
+		}
+		if ($this->level() === self::level_2_complete_maintenance) {
+			// we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
+			// then we shouldn't be in mm2. (Maybe an addon got deactivated?)
+			update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
+			return false;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the maintenance level on the site
+	 *
+	 * @param int $level
+	 * @return void
+	 */
+	public function set_maintenance_level($level)
+	{
+		do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
+		update_option(self::option_name_maintenance_mode, (int) $level);
+	}
+
+
+	/**
+	 * returns TRUE if M-Mode is engaged and the current request is not for the admin
+	 *
+	 * @return bool
+	 */
+	public static function disable_frontend_for_maintenance()
+	{
+		return (! is_admin() && EE_Maintenance_Mode::instance()->level());
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_assets_required_for_m_mode()
+	{
+		if (
+			$this->real_level() === EE_Maintenance_Mode::level_2_complete_maintenance
+			&& ! wp_script_is('espresso_core')
+		) {
+			wp_register_style(
+				'espresso_default',
+				EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				['dashicons'],
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('espresso_default');
+			wp_register_script(
+				'espresso_core',
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+				['jquery'],
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('espresso_core');
+		}
+	}
+
+
+	/**
+	 * replacement EE CPT template that displays message notifying site visitors
+	 * that EE has been temporarily placed into maintenance mode
+	 * does NOT get called on non-EE-CPT requests
+	 *
+	 * @return    string
+	 */
+	public static function template_include()
+	{
+		// shut 'er down for maintenance ? then don't use any of our templates for our endpoints
+		return get_template_directory() . '/index.php';
+	}
+
+
+	/**
+	 * displays message notifying site visitors that EE has been temporarily
+	 * placed into maintenance mode when post_type != EE CPT
+	 *
+	 * @param string $the_content
+	 * @return string
+	 */
+	public function the_content($the_content)
+	{
+		// check if M-mode is engaged and for EE shortcode
+		if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
+			// this can eventually be moved to a template, or edited via admin. But for now...
+			$the_content = sprintf(
+				esc_html__(
+					'%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
+					'event_espresso'
+				),
+				'<h3>',
+				'</h3><p>',
+				'</p>'
+			);
+		}
+		return $the_content;
+	}
+
+
+	/**
+	 * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
+	 */
+	public function display_maintenance_mode_notice()
+	{
+		/** @var CurrentPage $current_page */
+		$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		// check if M-mode is engaged and for EE shortcode
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& $this->real_level()
+			&& ! is_admin()
+			&& current_user_can('administrator')
+			&& $current_page->isEspressoPage()
+		) {
+			printf(
+				esc_html__(
+					'%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
+					'event_espresso'
+				),
+				'<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
+				'"><span class="dashicons dashicons-no"></span></a><p>',
+				' &raquo; <a href="' . add_query_arg(
+					['page' => 'espresso_maintenance_settings'],
+					admin_url('admin.php')
+				) . '">',
+				'</a></p></div>'
+			);
+		}
+	}
+	// espresso-notices important-notice ee-attention
+
+	/**
+	 * Redirects EE admin menu requests to the maintenance page
+	 */
+	public function redirect_to_maintenance()
+	{
+		global $pagenow;
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$page   = $request->getRequestParam('page');
+
+		if (
+			$pagenow == 'admin.php'
+			&& $page !== 'espresso_maintenance_settings'
+			&& strpos($page, 'espresso_') !== false
+			&& $this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			EEH_URL::safeRedirectAndExit('admin.php?page=espresso_maintenance_settings');
+		}
+	}
+
+
+	/**
+	 * override magic methods
+	 */
+	final public function __destruct()
+	{
+	}
+
+
+	final public function __call($a, $b)
+	{
+	}
+
+
+	final public function __get($a)
+	{
+	}
+
+
+	final public function __set($a, $b)
+	{
+	}
+
+
+	final public function __isset($a)
+	{
+	}
+
+
+	final public function __unset($a)
+	{
+	}
+
+
+	final public function __sleep()
+	{
+		return [];
+	}
+
+
+	final public function __wakeup()
+	{
+	}
+
+
+	final public function __invoke()
+	{
+	}
+
+
+	final public static function __set_state($a = null)
+	{
+		return EE_Maintenance_Mode::instance();
+	}
+
+
+	final public function __clone()
+	{
+	}
 
 
-    final public static function __callStatic($a, $b)
-    {
-    }
+	final public static function __callStatic($a, $b)
+	{
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -59,7 +59,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
+        if ( ! self::$_instance instanceof EE_Maintenance_Mode) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -186,7 +186,7 @@ 
      */
     public static function disable_frontend_for_maintenance()
     {
-        return (! is_admin() && EE_Maintenance_Mode::instance()->level());
+        return ( ! is_admin() && EE_Maintenance_Mode::instance()->level());
     }
 
 
@@ -201,14 +201,14 @@ 
         ) {
             wp_register_style(
                 'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+                EE_GLOBAL_ASSETS_URL.'css/espresso_default.css',
                 ['dashicons'],
                 EVENT_ESPRESSO_VERSION
             );
             wp_enqueue_style('espresso_default');
             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,
                 true
@@ -228,7 +228,7 @@ 
     public static function template_include()
     {
         // shut 'er down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
+        return get_template_directory().'/index.php';
     }
 
 
@@ -280,10 +280,10 @@ 
                 ),
                 '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
                 '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
+                ' &raquo; <a href="'.add_query_arg(
                     ['page' => 'espresso_maintenance_settings'],
                     admin_url('admin.php')
-                ) . '">',
+                ).'">',
                 '</a></p></div>'
             );
         }
@@ -297,7 +297,7 @@ 
     {
         global $pagenow;
         $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page   = $request->getRequestParam('page');
+        $page = $request->getRequestParam('page');
 
         if (
             $pagenow == 'admin.php'

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

Indentation +133 added lines, -133 removed lines

@@ -17,143 +17,143 @@
  */
 class EspressoLegacyAdmin extends AdminRoute
 {
-    /**
-     * @var LegacyAccountingAssetManager $asset_manager
-     */
-    protected $asset_manager;
+	/**
+	 * @var LegacyAccountingAssetManager $asset_manager
+	 */
+	protected $asset_manager;
 
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        global $pagenow;
-        $page = $this->request->getRequestParam('page');
-        return (
-                   $pagenow === 'admin.php'
-                   || $pagenow === 'admin-ajax.php'
-               ) && (
-                   $page === 'pricing'
-                   || $page === 'mailchimp'
-                   || $page === 'eea_barcode_scanner'
-                   || str_contains($page, 'espresso')
-               ) && parent::matchesCurrentRequest();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		global $pagenow;
+		$page = $this->request->getRequestParam('page');
+		return (
+				   $pagenow === 'admin.php'
+				   || $pagenow === 'admin-ajax.php'
+			   ) && (
+				   $page === 'pricing'
+				   || $page === 'mailchimp'
+				   || $page === 'eea_barcode_scanner'
+				   || str_contains($page, 'espresso')
+			   ) && parent::matchesCurrentRequest();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $asset_manger_dependencies = [
-            'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-            'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
-            'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-        ];
-        $this->dependency_map->registerDependencies(JqueryAssetManager::class, $asset_manger_dependencies);
-        $this->dependency_map->registerDependencies(EspressoLegacyAdminAssetManager::class, $asset_manger_dependencies);
-        $this->dependency_map->registerDependencies(
-            LegacyAccountingAssetManager::class,
-            ['EE_Currency_Config' => EE_Dependency_Map::load_from_cache] + $asset_manger_dependencies
-        );
-        $this->dependency_map->registerDependencies(
-            'EE_Admin_Transactions_List_Table',
-            [
-                null,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings',
-            ['EE_Registration_Config' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\admin_pages\general_settings\OrganizationSettings',
-            [
-                'EE_Registry'                                             => EE_Dependency_Map::load_from_cache,
-                'EE_Organization_Config'                                  => EE_Dependency_Map::load_from_cache,
-                'EE_Core_Config'                                          => EE_Dependency_Map::load_from_cache,
-                'EE_Network_Core_Config'                                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\address\CountrySubRegionDao' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\address\CountrySubRegionDao',
-            [
-                'EEM_State'                                            => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\validators\JsonValidator' => EE_Dependency_Map::load_from_cache
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'                            => EE_Dependency_Map::load_from_cache,
-                null,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Attendee'                                => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Datetime'                                => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Event'                                   => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'                                  => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\admin\AdminListTableFilters',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$asset_manger_dependencies = [
+			'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+			'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
+			'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+		];
+		$this->dependency_map->registerDependencies(JqueryAssetManager::class, $asset_manger_dependencies);
+		$this->dependency_map->registerDependencies(EspressoLegacyAdminAssetManager::class, $asset_manger_dependencies);
+		$this->dependency_map->registerDependencies(
+			LegacyAccountingAssetManager::class,
+			['EE_Currency_Config' => EE_Dependency_Map::load_from_cache] + $asset_manger_dependencies
+		);
+		$this->dependency_map->registerDependencies(
+			'EE_Admin_Transactions_List_Table',
+			[
+				null,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings',
+			['EE_Registration_Config' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\admin_pages\general_settings\OrganizationSettings',
+			[
+				'EE_Registry'                                             => EE_Dependency_Map::load_from_cache,
+				'EE_Organization_Config'                                  => EE_Dependency_Map::load_from_cache,
+				'EE_Core_Config'                                          => EE_Dependency_Map::load_from_cache,
+				'EE_Network_Core_Config'                                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\address\CountrySubRegionDao' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\address\CountrySubRegionDao',
+			[
+				'EEM_State'                                            => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\validators\JsonValidator' => EE_Dependency_Map::load_from_cache
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'                            => EE_Dependency_Map::load_from_cache,
+				null,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Attendee'                                => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Datetime'                                => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Event'                                   => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'                                  => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\admin\AdminListTableFilters',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        add_filter(
-            'admin_body_class',
-            function ($classes) {
-                if (strpos($classes, 'espresso-admin') === false) {
-                    $classes .= ' espresso-admin';
-                }
-                return $classes;
-            }
-        );
-        $this->loader->getShared(JqueryAssetManager::class);
-        $this->loader->getShared(EspressoLegacyAdminAssetManager::class);
-        $this->loader->getShared(LegacyAccountingAssetManager::class);
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		add_filter(
+			'admin_body_class',
+			function ($classes) {
+				if (strpos($classes, 'espresso-admin') === false) {
+					$classes .= ' espresso-admin';
+				}
+				return $classes;
+			}
+		);
+		$this->loader->getShared(JqueryAssetManager::class);
+		$this->loader->getShared(EspressoLegacyAdminAssetManager::class);
+		$this->loader->getShared(LegacyAccountingAssetManager::class);
+		return true;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
     {
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }

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

Indentation +24 added lines, -24 removed lines

@@ -14,30 +14,30 @@
  */
 class EspressoEventsAdmin extends AdminRoute
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        global $pagenow;
-        return parent::matchesCurrentRequest()
-               && $pagenow
-               && $pagenow === 'admin.php'
-               && $this->request->getRequestParam('page') === 'espresso_events';
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		global $pagenow;
+		return parent::matchesCurrentRequest()
+			   && $pagenow
+			   && $pagenow === 'admin.php'
+			   && $this->request->getRequestParam('page') === 'espresso_events';
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\events\default_settings\AdvancedEditorAdminFormSection',
-            AdminRoute::getDefaultDependencies()
-        );
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\events\default_settings\AdvancedEditorAdminFormSection',
+			AdminRoute::getDefaultDependencies()
+		);
+	}
 }

core/libraries/payment_methods/EE_PMT_Base.lib.php

Indentation +834 added lines, -834 removed lines

@@ -16,838 +16,838 @@
  */
 abstract class EE_PMT_Base
 {
-    const onsite  = 'on-site';
-
-    const offsite = 'off-site';
-
-    const offline = 'off-line';
-
-    /**
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_requires_https = false;
-
-    /**
-     * @var boolean
-     */
-    protected $_has_billing_form;
-
-    /**
-     * @var EE_Gateway
-     */
-    protected $_gateway = null;
-
-    /**
-     * @var EE_Payment_Method_Form
-     */
-    protected $_settings_form = null;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $_billing_form = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_cache_billing_form = true;
-
-    /**
-     * String of the absolute path to the folder containing this file, with a trailing slash.
-     * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
-     *
-     * @var string|null
-     */
-    protected $_file_folder = null;
-
-    /**
-     * String to the absolute URL to this file (useful for getting its web-accessible resources
-     * like images, js, or css)
-     *
-     * @var string|null
-     */
-    protected $_file_url = null;
-
-    /**
-     * Pretty name for the payment method
-     *
-     * @var string|null
-     */
-    protected $_pretty_name = null;
-
-    /**
-     * @var string|null
-     */
-    protected $_default_button_url = null;
-
-    /**
-     * @var string|null
-     */
-    protected $_default_description = null;
-
-    /**
-     *  @var string|null
-     */
-    protected $_template_path = null;
-
-    /**
-     * @param EE_Payment_Method|null $pm_instance
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function __construct($pm_instance = null)
-    {
-        if ($pm_instance instanceof EE_Payment_Method) {
-            $this->set_instance($pm_instance);
-        }
-        if ($this->_gateway) {
-            $this->_gateway->set_payment_model(EEM_Payment::instance());
-            $this->_gateway->set_payment_log(EEM_Change_Log::instance());
-            $this->_gateway->set_template_helper(new EEH_Template());
-            $this->_gateway->set_line_item_helper(new EEH_Line_Item());
-            $this->_gateway->set_money_helper(new EEH_Money());
-            $this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
-            $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
-            do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
-        }
-        if (! isset($this->_has_billing_form)) {
-            // by default, On Site gateways have a billing form
-            if ($this->payment_occurs() == EE_PMT_Base::onsite) {
-                $this->set_has_billing_form(true);
-            } else {
-                $this->set_has_billing_form(false);
-            }
-        }
-
-        if (! $this->_pretty_name) {
-            throw new EE_Error(
-                esc_html__(
-                    'You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized',
-                    'event_espresso'
-                )
-            );
-        }
-        // if the child didn't specify a default button, use the credit card one
-        if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
-        }
-    }
-
-
-    /**
-     * @param boolean $has_billing_form
-     */
-    public function set_has_billing_form(bool $has_billing_form)
-    {
-        $this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * sets the file_folder property
-     */
-    protected function _set_file_folder()
-    {
-        $reflector          = new ReflectionClass(get_class($this));
-        $fn                 = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . '/';
-    }
-
-
-    /**
-     * sets the file URL with a trailing slash for this PMT
-     */
-    protected function _set_file_url()
-    {
-        $plugins_dir_fixed = str_replace('\\', '/', WP_PLUGIN_DIR);
-        $file_folder_fixed = str_replace('\\', '/', $this->file_folder());
-        $file_path         = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
-        $this->_file_url   = set_url_scheme($file_path);
-    }
-
-
-    /**
-     * Gets the default description on all payment methods of this type
-     *
-     * @return string
-     */
-    public function default_description(): ?string
-    {
-        return $this->_default_description;
-    }
-
-
-    /**
-     * Returns the folder containing the PMT child class, with a trailing slash
-     *
-     * @return string
-     */
-    public function file_folder(): ?string
-    {
-        if (! $this->_file_folder) {
-            $this->_set_file_folder();
-        }
-        return $this->_file_folder;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file_url(): ?string
-    {
-        if (! $this->_file_url) {
-            $this->_set_file_url();
-        }
-        return $this->_file_url;
-    }
-
-
-    /**
-     * Sets the payment method instance this payment method type is for.
-     * Its important teh payment method instance is set before
-     *
-     * @param EE_Payment_Method $payment_method_instance
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_instance(EE_Payment_Method $payment_method_instance)
-    {
-        $this->_pm_instance = $payment_method_instance;
-        // if they have already requested the settings form, make sure its
-        // data matches this model object
-        if ($this->_settings_form) {
-            $this->settings_form()->populate_model_obj($payment_method_instance);
-        }
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->set_settings($payment_method_instance->settings_array());
-        }
-    }
-
-
-    /**
-     * Gets teh form for displaying to admins where they set up the payment method
-     *
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function settings_form(): EE_Payment_Method_Form
-    {
-        if (! $this->_settings_form) {
-            $this->_settings_form = $this->generate_new_settings_form();
-            $this->_settings_form->set_payment_method_type($this);
-            // if we have already assigned a model object to this pmt, make
-            // sure it's reflected in the form we just generated
-            if ($this->_pm_instance) {
-                $this->_settings_form->populate_model_obj($this->_pm_instance);
-            }
-        }
-        return $this->_settings_form;
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @return EE_Payment_Method_Form
-     */
-    abstract public function generate_new_settings_form();
-
-
-    /**
-     * Sets the form for settings. This may be useful if we have already received
-     * a form submission and have form data it in, and want to use it anytime we're showing
-     * this payment method type's settings form later in the request
-     *
-     * @param EE_Payment_Method_Form $form
-     */
-    public function set_settings_form(EE_Payment_Method_Form $form)
-    {
-        $this->_settings_form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function has_billing_form(): bool
-    {
-        return $this->_has_billing_form;
-    }
-
-
-    /**
-     * Gets the form for displaying to attendees where they can enter their billing info
-     * which will be sent to teh gateway (can be null)
-     *
-     * @param EE_Transaction|null $transaction
-     * @param array               $extra_args
-     * @return EE_Billing_Attendee_Info_Form|EE_Billing_Info_Form|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function billing_form(EE_Transaction $transaction = null, array $extra_args = [])
-    {
-        // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
-            $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
-        }
-        // if we know who the attendee is, and this is a billing form
-        // that uses attendee info, populate it
-        if (
-            apply_filters(
-                'FHEE__populate_billing_form_fields_from_attendee',
-                (
-                    $this->_billing_form instanceof EE_Billing_Attendee_Info_Form
-                    && $transaction instanceof EE_Transaction
-                    && $transaction->primary_registration() instanceof EE_Registration
-                    && $transaction->primary_registration()->attendee() instanceof EE_Attendee
-                ),
-                $this->_billing_form,
-                $transaction
-            )
-        ) {
-            $this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
-        }
-        return $this->_billing_form;
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     *
-     * @param EE_Transaction|null $transaction
-     * @return EE_Billing_Info_Form|null
-     */
-    abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
-
-
-    /**
-     * applies debug data to the form
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @return EE_Billing_Info_Form|null
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        return $billing_form;
-    }
-
-
-    /**
-     * Sets the billing form for this payment method type. You may want to use this
-     * if you have form
-     *
-     * @param EE_Payment_Method $form
-     */
-    public function set_billing_form(EE_Payment_Method $form)
-    {
-        $this->_billing_form = $form;
-    }
-
-
-    /**
-     * Returns whether this payment method requires HTTPS to be used
-     *
-     * @return boolean
-     */
-    public function requires_https(): bool
-    {
-        return $this->_requires_https;
-    }
-
-
-    /**
-     * @param EE_Transaction            $transaction
-     * @param float|null                $amount
-     * @param EE_Billing_Info_Form|null $billing_info
-     * @param string|null               $return_url
-     * @param string                    $fail_url
-     * @param string                    $method
-     * @param bool                      $by_admin
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function process_payment(
-        EE_Transaction $transaction,
-        $amount = NULL,
-        $billing_info = NULL,
-        $return_url = NULL,
-        $fail_url = '',
-        $method = 'CART',
-        $by_admin = false
-    ) {
-        // @todo: add surcharge for the payment method, if any
-        if ($this->_gateway) {
-            // there is a gateway, so we're going to make a payment object
-            // but wait! do they already have a payment in progress that we thought was failed?
-            $duplicate_properties = [
-                'STS_ID'               => EEM_Payment::status_id_failed,
-                'TXN_ID'               => $transaction->ID(),
-                'PMD_ID'               => $this->_pm_instance->ID(),
-                'PAY_source'           => $method,
-                'PAY_amount'           => $amount !== null
-                    ? $amount
-                    : $transaction->remaining(),
-                'PAY_gateway_response' => null,
-            ];
-            $payment              = EEM_Payment::instance()->get_one([$duplicate_properties]);
-            // if we didn't already have a payment in progress for the same thing,
-            // then we actually want to make a new payment
-            if (! $payment instanceof EE_Payment) {
-                $payment = EE_Payment::new_instance(
-                    array_merge(
-                        $duplicate_properties,
-                        [
-                            'PAY_timestamp'       => time(),
-                            'PAY_txn_id_chq_nmbr' => null,
-                            'PAY_po_number'       => null,
-                            'PAY_extra_accntng'   => null,
-                            'PAY_details'         => null,
-                        ]
-                    )
-                );
-            }
-            // make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
-            $payment->save();
-            $billing_values = $this->_get_billing_values_from_form($billing_info);
-
-            //  Offsite Gateway
-            if ($this->_gateway instanceof EE_Offsite_Gateway) {
-                $payment = $this->_gateway->set_redirection_info(
-                    $payment,
-                    $billing_values,
-                    $return_url,
-                    EE_Config::instance()->core->txn_page_url(
-                        [
-                            'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
-                            'ee_payment_method' => $this->_pm_instance->slug(),
-                        ]
-                    ),
-                    $fail_url
-                );
-                $payment->save();
-                //  Onsite Gateway
-            } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-                $payment = $this->_gateway->do_direct_payment($payment, $billing_values);
-                $payment->save();
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        gettype($this->_gateway)
-                    )
-                );
-            }
-        } else {
-            // no gateway provided
-            // there is no payment. Must be an offline gateway
-            // create a payment object anyways, but dont save it
-            $payment = EE_Payment::new_instance(
-                [
-                    'STS_ID'        => EEM_Payment::status_id_pending,
-                    'TXN_ID'        => $transaction->ID(),
-                    'PMD_ID'        => $transaction->payment_method_ID(),
-                    'PAY_amount'    => 0.00,
-                    'PAY_timestamp' => time(),
-                ]
-            );
-        }
-
-        // if there is billing info, clean it and save it now
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        return $payment;
-    }
-
-
-    /**
-     * Gets the values we want to pass onto the gateway. Normally these
-     * are just the 'pretty' values, but there may be times the data may need
-     * a  little massaging. Proper subsections will become arrays of inputs
-     *
-     * @param EE_Billing_Info_Form|null $billing_form
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        return $billing_form instanceof EE_Form_Section_Proper
-            ? $billing_form->input_pretty_values(true)
-            : [];
-    }
-
-
-    /**
-     * Handles an instant payment notification when the transaction is known (by default).
-     *
-     * @param array          $req_data
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function handle_ipn(array $req_data, EE_Transaction $transaction): EE_Payment
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
-                    print_r($this->_gateway, true)
-                )
-            );
-        }
-        return $this->_gateway->handle_payment_update($req_data, $transaction);
-    }
-
-
-    /**
-     * Saves the billing info onto the attendee of the primary registrant on this transaction, and
-     * cleans it first.
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Transaction|null           $transaction
-     * @return boolean success
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _save_billing_info_to_attendee(
-        EE_Billing_Attendee_Info_Form $billing_form,
-        ?EE_Transaction $transaction
-    ): bool {
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    "Cannot save billing info because the transaction has no primary registration",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                esc_html__(
-                    "Cannot save billing info because the transaction's primary registration has no attendee!",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
-    }
-
-
-    /**
-     * Gets the payment this IPN is for. Children may often want to
-     * override this to inspect the request
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $req_data
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function find_payment_for_ipn(EE_Transaction $transaction, array $req_data = []): EE_Payment
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * In case generic code cannot provide the payment processor with a specific payment method
-     * and transaction, it will try calling this method on each activate payment method.
-     * If the payment method is able to identify the request as being for it, it should fetch
-     * the payment it's for and return it. If not, it should throw an EE_Error to indicate it cannot
-     * handle the IPN
-     *
-     * @param array $req_data
-     * @return EE_Payment only if this payment method can find the info its needs from $req_data
-     * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
-     * @throws EE_Error
-     */
-    public function handle_unclaimed_ipn(array $req_data = []): EE_Payment
-    {
-        throw new EE_Error(
-            sprintf(
-                esc_html__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * Logic to be accomplished when the payment attempt is complete.
-     * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
-     * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
-     * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
-     * of the payment). Fed a transaction because it's always assumed to be the last payment that
-     * we're dealing with. Returns that last payment (if there is one)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function finalize_payment_for(EE_Transaction $transaction): ?EE_Payment
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * Whether this payment method's gateway supports sending refund requests
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds(): bool
-    {
-        return $this->_gateway instanceof EE_Gateway && $this->_gateway->supports_sending_refunds();
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function process_refund(EE_Payment $payment, array $refund_info = []): EE_Payment
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->do_direct_refund($payment, $refund_info);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Returns one the class's constants onsite,offsite, or offline, depending on this
-     * payment method's gateway.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_occurs(): string
-    {
-        if (! $this->_gateway) {
-            return EE_PMT_Base::offline;
-        }
-        if ($this->_gateway instanceof EE_Onsite_Gateway) {
-            return EE_PMT_Base::onsite;
-        }
-        if ($this->_gateway instanceof EE_Offsite_Gateway) {
-            return EE_PMT_Base::offsite;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
-                    "event_espresso"
-                ),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     *
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
-            ['payment_method' => $this->_pm_instance, 'payment' => $payment],
-            true
-        );
-    }
-
-
-    /**
-     * @return array where keys are the help tab name,
-     * values are: array {
-     * @type string $title         i18n name for the help tab
-     * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
-     * @type array  $template_args any arguments you want passed to the template file while rendering.
-     *                             Keys will be variable names and values with be their values.
-     */
-    public function help_tabs_config()
-    {
-        return [];
-    }
-
-
-    /**
-     * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
-     * the payment method's table's PMT_type column)
-     *
-     * @return string
-     */
-    public function system_name()
-    {
-        $classname = get_class($this);
-        return str_replace("EE_PMT_", '', $classname);
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
-     * this method.
-     *
-     * @return string|null
-     */
-    public function defaultFrontendName()
-    {
-        return $this->pretty_name();
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name
-     *
-     * @return string|null
-     */
-    public function pretty_name(): ?string
-    {
-        return $this->_pretty_name;
-    }
-
-
-    /**
-     * Gets the default absolute URL to the payment method type's button
-     *
-     * @return string|null
-     */
-    public function default_button_url(): ?string
-    {
-        return $this->_default_button_url;
-    }
-
-
-    /**
-     * Gets the gateway used by this payment method (if any)
-     *
-     * @return EE_Gateway
-     */
-    public function get_gateway(): ?EE_Gateway
-    {
-        return $this->_gateway;
-    }
-
-
-    /**
-     * @return string html for the link to a help tab
-     */
-    public function get_help_tab_link(): string
-    {
-        return EEH_Template::get_help_tab_link(
-            $this->get_help_tab_name(),
-            'espresso_payment_settings',
-            'default'
-        );
-    }
-
-
-    /**
-     * Returns the name of the help tab for this PMT
-     *
-     * @return string
-     */
-    public function get_help_tab_name(): string
-    {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
-    }
-
-
-    /**
-     * The name of the wp capability that should be associated with the usage of
-     * this PMT by an admin
-     *
-     * @return string
-     */
-    public function cap_name(): string
-    {
-        return 'ee_payment_method_' . strtolower($this->system_name());
-    }
-
-
-    /**
-     * Called by client code to tell the gateway that if it wants to change
-     * the transaction or line items or registrations related to teh payment it already
-     * processed (we think, but possibly not) that now's the time to do it.
-     * It is expected that gateways will store any info they need for this on the PAY_details,
-     * or maybe an extra meta value
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->update_txn_based_on_payment($payment);
-        }
-    }
-
-
-    /**
-     * Returns a string of HTML describing this payment method type for an admin,
-     * primarily intended for them to read before activating it.
-     * The easiest way to set this is to create a folder 'templates' alongside
-     * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
-     * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
-     * then you'd create a file named "templates" in the same folder as it, and name the file
-     * "foo_bar_intro.template.php", and its content will be returned by this method
-     *
-     * @return string
-     */
-    public function introductory_html(): string
-    {
-        return EEH_Template::locate_template(
-            $this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
-            ['pmt_obj' => $this, 'pm_instance' => $this->_pm_instance]
-        );
-    }
+	const onsite  = 'on-site';
+
+	const offsite = 'off-site';
+
+	const offline = 'off-line';
+
+	/**
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_requires_https = false;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_has_billing_form;
+
+	/**
+	 * @var EE_Gateway
+	 */
+	protected $_gateway = null;
+
+	/**
+	 * @var EE_Payment_Method_Form
+	 */
+	protected $_settings_form = null;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_billing_form = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_cache_billing_form = true;
+
+	/**
+	 * String of the absolute path to the folder containing this file, with a trailing slash.
+	 * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
+	 *
+	 * @var string|null
+	 */
+	protected $_file_folder = null;
+
+	/**
+	 * String to the absolute URL to this file (useful for getting its web-accessible resources
+	 * like images, js, or css)
+	 *
+	 * @var string|null
+	 */
+	protected $_file_url = null;
+
+	/**
+	 * Pretty name for the payment method
+	 *
+	 * @var string|null
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 * @var string|null
+	 */
+	protected $_default_button_url = null;
+
+	/**
+	 * @var string|null
+	 */
+	protected $_default_description = null;
+
+	/**
+	 *  @var string|null
+	 */
+	protected $_template_path = null;
+
+	/**
+	 * @param EE_Payment_Method|null $pm_instance
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function __construct($pm_instance = null)
+	{
+		if ($pm_instance instanceof EE_Payment_Method) {
+			$this->set_instance($pm_instance);
+		}
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
+			$this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
+			$this->_gateway->set_unsupported_character_remover(new AsciiOnly());
+			do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
+		}
+		if (! isset($this->_has_billing_form)) {
+			// by default, On Site gateways have a billing form
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
+			} else {
+				$this->set_has_billing_form(false);
+			}
+		}
+
+		if (! $this->_pretty_name) {
+			throw new EE_Error(
+				esc_html__(
+					'You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized',
+					'event_espresso'
+				)
+			);
+		}
+		// if the child didn't specify a default button, use the credit card one
+		if ($this->_default_button_url === null) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
+		}
+	}
+
+
+	/**
+	 * @param boolean $has_billing_form
+	 */
+	public function set_has_billing_form(bool $has_billing_form)
+	{
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * sets the file_folder property
+	 */
+	protected function _set_file_folder()
+	{
+		$reflector          = new ReflectionClass(get_class($this));
+		$fn                 = $reflector->getFileName();
+		$this->_file_folder = dirname($fn) . '/';
+	}
+
+
+	/**
+	 * sets the file URL with a trailing slash for this PMT
+	 */
+	protected function _set_file_url()
+	{
+		$plugins_dir_fixed = str_replace('\\', '/', WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', '/', $this->file_folder());
+		$file_path         = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
+		$this->_file_url   = set_url_scheme($file_path);
+	}
+
+
+	/**
+	 * Gets the default description on all payment methods of this type
+	 *
+	 * @return string
+	 */
+	public function default_description(): ?string
+	{
+		return $this->_default_description;
+	}
+
+
+	/**
+	 * Returns the folder containing the PMT child class, with a trailing slash
+	 *
+	 * @return string
+	 */
+	public function file_folder(): ?string
+	{
+		if (! $this->_file_folder) {
+			$this->_set_file_folder();
+		}
+		return $this->_file_folder;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file_url(): ?string
+	{
+		if (! $this->_file_url) {
+			$this->_set_file_url();
+		}
+		return $this->_file_url;
+	}
+
+
+	/**
+	 * Sets the payment method instance this payment method type is for.
+	 * Its important teh payment method instance is set before
+	 *
+	 * @param EE_Payment_Method $payment_method_instance
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_instance(EE_Payment_Method $payment_method_instance)
+	{
+		$this->_pm_instance = $payment_method_instance;
+		// if they have already requested the settings form, make sure its
+		// data matches this model object
+		if ($this->_settings_form) {
+			$this->settings_form()->populate_model_obj($payment_method_instance);
+		}
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->set_settings($payment_method_instance->settings_array());
+		}
+	}
+
+
+	/**
+	 * Gets teh form for displaying to admins where they set up the payment method
+	 *
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function settings_form(): EE_Payment_Method_Form
+	{
+		if (! $this->_settings_form) {
+			$this->_settings_form = $this->generate_new_settings_form();
+			$this->_settings_form->set_payment_method_type($this);
+			// if we have already assigned a model object to this pmt, make
+			// sure it's reflected in the form we just generated
+			if ($this->_pm_instance) {
+				$this->_settings_form->populate_model_obj($this->_pm_instance);
+			}
+		}
+		return $this->_settings_form;
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	abstract public function generate_new_settings_form();
+
+
+	/**
+	 * Sets the form for settings. This may be useful if we have already received
+	 * a form submission and have form data it in, and want to use it anytime we're showing
+	 * this payment method type's settings form later in the request
+	 *
+	 * @param EE_Payment_Method_Form $form
+	 */
+	public function set_settings_form(EE_Payment_Method_Form $form)
+	{
+		$this->_settings_form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function has_billing_form(): bool
+	{
+		return $this->_has_billing_form;
+	}
+
+
+	/**
+	 * Gets the form for displaying to attendees where they can enter their billing info
+	 * which will be sent to teh gateway (can be null)
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @param array               $extra_args
+	 * @return EE_Billing_Attendee_Info_Form|EE_Billing_Info_Form|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function billing_form(EE_Transaction $transaction = null, array $extra_args = [])
+	{
+		// has billing form already been regenerated ? or overwrite cache?
+		if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
+		}
+		// if we know who the attendee is, and this is a billing form
+		// that uses attendee info, populate it
+		if (
+			apply_filters(
+				'FHEE__populate_billing_form_fields_from_attendee',
+				(
+					$this->_billing_form instanceof EE_Billing_Attendee_Info_Form
+					&& $transaction instanceof EE_Transaction
+					&& $transaction->primary_registration() instanceof EE_Registration
+					&& $transaction->primary_registration()->attendee() instanceof EE_Attendee
+				),
+				$this->_billing_form,
+				$transaction
+			)
+		) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
+		}
+		return $this->_billing_form;
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Billing_Info_Form|null
+	 */
+	abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
+
+
+	/**
+	 * applies debug data to the form
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return EE_Billing_Info_Form|null
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		return $billing_form;
+	}
+
+
+	/**
+	 * Sets the billing form for this payment method type. You may want to use this
+	 * if you have form
+	 *
+	 * @param EE_Payment_Method $form
+	 */
+	public function set_billing_form(EE_Payment_Method $form)
+	{
+		$this->_billing_form = $form;
+	}
+
+
+	/**
+	 * Returns whether this payment method requires HTTPS to be used
+	 *
+	 * @return boolean
+	 */
+	public function requires_https(): bool
+	{
+		return $this->_requires_https;
+	}
+
+
+	/**
+	 * @param EE_Transaction            $transaction
+	 * @param float|null                $amount
+	 * @param EE_Billing_Info_Form|null $billing_info
+	 * @param string|null               $return_url
+	 * @param string                    $fail_url
+	 * @param string                    $method
+	 * @param bool                      $by_admin
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function process_payment(
+		EE_Transaction $transaction,
+		$amount = NULL,
+		$billing_info = NULL,
+		$return_url = NULL,
+		$fail_url = '',
+		$method = 'CART',
+		$by_admin = false
+	) {
+		// @todo: add surcharge for the payment method, if any
+		if ($this->_gateway) {
+			// there is a gateway, so we're going to make a payment object
+			// but wait! do they already have a payment in progress that we thought was failed?
+			$duplicate_properties = [
+				'STS_ID'               => EEM_Payment::status_id_failed,
+				'TXN_ID'               => $transaction->ID(),
+				'PMD_ID'               => $this->_pm_instance->ID(),
+				'PAY_source'           => $method,
+				'PAY_amount'           => $amount !== null
+					? $amount
+					: $transaction->remaining(),
+				'PAY_gateway_response' => null,
+			];
+			$payment              = EEM_Payment::instance()->get_one([$duplicate_properties]);
+			// if we didn't already have a payment in progress for the same thing,
+			// then we actually want to make a new payment
+			if (! $payment instanceof EE_Payment) {
+				$payment = EE_Payment::new_instance(
+					array_merge(
+						$duplicate_properties,
+						[
+							'PAY_timestamp'       => time(),
+							'PAY_txn_id_chq_nmbr' => null,
+							'PAY_po_number'       => null,
+							'PAY_extra_accntng'   => null,
+							'PAY_details'         => null,
+						]
+					)
+				);
+			}
+			// make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
+			$payment->save();
+			$billing_values = $this->_get_billing_values_from_form($billing_info);
+
+			//  Offsite Gateway
+			if ($this->_gateway instanceof EE_Offsite_Gateway) {
+				$payment = $this->_gateway->set_redirection_info(
+					$payment,
+					$billing_values,
+					$return_url,
+					EE_Config::instance()->core->txn_page_url(
+						[
+							'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
+							'ee_payment_method' => $this->_pm_instance->slug(),
+						]
+					),
+					$fail_url
+				);
+				$payment->save();
+				//  Onsite Gateway
+			} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+				$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
+				$payment->save();
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
+							'event_espresso'
+						),
+						get_class($this),
+						gettype($this->_gateway)
+					)
+				);
+			}
+		} else {
+			// no gateway provided
+			// there is no payment. Must be an offline gateway
+			// create a payment object anyways, but dont save it
+			$payment = EE_Payment::new_instance(
+				[
+					'STS_ID'        => EEM_Payment::status_id_pending,
+					'TXN_ID'        => $transaction->ID(),
+					'PMD_ID'        => $transaction->payment_method_ID(),
+					'PAY_amount'    => 0.00,
+					'PAY_timestamp' => time(),
+				]
+			);
+		}
+
+		// if there is billing info, clean it and save it now
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		return $payment;
+	}
+
+
+	/**
+	 * Gets the values we want to pass onto the gateway. Normally these
+	 * are just the 'pretty' values, but there may be times the data may need
+	 * a  little massaging. Proper subsections will become arrays of inputs
+	 *
+	 * @param EE_Billing_Info_Form|null $billing_form
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		return $billing_form instanceof EE_Form_Section_Proper
+			? $billing_form->input_pretty_values(true)
+			: [];
+	}
+
+
+	/**
+	 * Handles an instant payment notification when the transaction is known (by default).
+	 *
+	 * @param array          $req_data
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function handle_ipn(array $req_data, EE_Transaction $transaction): EE_Payment
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
+					print_r($this->_gateway, true)
+				)
+			);
+		}
+		return $this->_gateway->handle_payment_update($req_data, $transaction);
+	}
+
+
+	/**
+	 * Saves the billing info onto the attendee of the primary registrant on this transaction, and
+	 * cleans it first.
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Transaction|null           $transaction
+	 * @return boolean success
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _save_billing_info_to_attendee(
+		EE_Billing_Attendee_Info_Form $billing_form,
+		?EE_Transaction $transaction
+	): bool {
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					"Cannot save billing info because the transaction has no primary registration",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				esc_html__(
+					"Cannot save billing info because the transaction's primary registration has no attendee!",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
+	}
+
+
+	/**
+	 * Gets the payment this IPN is for. Children may often want to
+	 * override this to inspect the request
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $req_data
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function find_payment_for_ipn(EE_Transaction $transaction, array $req_data = []): EE_Payment
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * In case generic code cannot provide the payment processor with a specific payment method
+	 * and transaction, it will try calling this method on each activate payment method.
+	 * If the payment method is able to identify the request as being for it, it should fetch
+	 * the payment it's for and return it. If not, it should throw an EE_Error to indicate it cannot
+	 * handle the IPN
+	 *
+	 * @param array $req_data
+	 * @return EE_Payment only if this payment method can find the info its needs from $req_data
+	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
+	 * @throws EE_Error
+	 */
+	public function handle_unclaimed_ipn(array $req_data = []): EE_Payment
+	{
+		throw new EE_Error(
+			sprintf(
+				esc_html__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * Logic to be accomplished when the payment attempt is complete.
+	 * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
+	 * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
+	 * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
+	 * of the payment). Fed a transaction because it's always assumed to be the last payment that
+	 * we're dealing with. Returns that last payment (if there is one)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function finalize_payment_for(EE_Transaction $transaction): ?EE_Payment
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * Whether this payment method's gateway supports sending refund requests
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds(): bool
+	{
+		return $this->_gateway instanceof EE_Gateway && $this->_gateway->supports_sending_refunds();
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function process_refund(EE_Payment $payment, array $refund_info = []): EE_Payment
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns one the class's constants onsite,offsite, or offline, depending on this
+	 * payment method's gateway.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_occurs(): string
+	{
+		if (! $this->_gateway) {
+			return EE_PMT_Base::offline;
+		}
+		if ($this->_gateway instanceof EE_Onsite_Gateway) {
+			return EE_PMT_Base::onsite;
+		}
+		if ($this->_gateway instanceof EE_Offsite_Gateway) {
+			return EE_PMT_Base::offsite;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
+					"event_espresso"
+				),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		return EEH_Template::display_template(
+			EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
+			['payment_method' => $this->_pm_instance, 'payment' => $payment],
+			true
+		);
+	}
+
+
+	/**
+	 * @return array where keys are the help tab name,
+	 * values are: array {
+	 * @type string $title         i18n name for the help tab
+	 * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
+	 * @type array  $template_args any arguments you want passed to the template file while rendering.
+	 *                             Keys will be variable names and values with be their values.
+	 */
+	public function help_tabs_config()
+	{
+		return [];
+	}
+
+
+	/**
+	 * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
+	 * the payment method's table's PMT_type column)
+	 *
+	 * @return string
+	 */
+	public function system_name()
+	{
+		$classname = get_class($this);
+		return str_replace("EE_PMT_", '', $classname);
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
+	 * this method.
+	 *
+	 * @return string|null
+	 */
+	public function defaultFrontendName()
+	{
+		return $this->pretty_name();
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name
+	 *
+	 * @return string|null
+	 */
+	public function pretty_name(): ?string
+	{
+		return $this->_pretty_name;
+	}
+
+
+	/**
+	 * Gets the default absolute URL to the payment method type's button
+	 *
+	 * @return string|null
+	 */
+	public function default_button_url(): ?string
+	{
+		return $this->_default_button_url;
+	}
+
+
+	/**
+	 * Gets the gateway used by this payment method (if any)
+	 *
+	 * @return EE_Gateway
+	 */
+	public function get_gateway(): ?EE_Gateway
+	{
+		return $this->_gateway;
+	}
+
+
+	/**
+	 * @return string html for the link to a help tab
+	 */
+	public function get_help_tab_link(): string
+	{
+		return EEH_Template::get_help_tab_link(
+			$this->get_help_tab_name(),
+			'espresso_payment_settings',
+			'default'
+		);
+	}
+
+
+	/**
+	 * Returns the name of the help tab for this PMT
+	 *
+	 * @return string
+	 */
+	public function get_help_tab_name(): string
+	{
+		return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+	}
+
+
+	/**
+	 * The name of the wp capability that should be associated with the usage of
+	 * this PMT by an admin
+	 *
+	 * @return string
+	 */
+	public function cap_name(): string
+	{
+		return 'ee_payment_method_' . strtolower($this->system_name());
+	}
+
+
+	/**
+	 * Called by client code to tell the gateway that if it wants to change
+	 * the transaction or line items or registrations related to teh payment it already
+	 * processed (we think, but possibly not) that now's the time to do it.
+	 * It is expected that gateways will store any info they need for this on the PAY_details,
+	 * or maybe an extra meta value
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
+		}
+	}
+
+
+	/**
+	 * Returns a string of HTML describing this payment method type for an admin,
+	 * primarily intended for them to read before activating it.
+	 * The easiest way to set this is to create a folder 'templates' alongside
+	 * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
+	 * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
+	 * then you'd create a file named "templates" in the same folder as it, and name the file
+	 * "foo_bar_intro.template.php", and its content will be returned by this method
+	 *
+	 * @return string
+	 */
+	public function introductory_html(): string
+	{
+		return EEH_Template::locate_template(
+			$this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
+			['pmt_obj' => $this, 'pm_instance' => $this->_pm_instance]
+		);
+	}
 }