eventespresso / event-espresso-core

core/EE_Maintenance_Mode.core.php

Indentation +512 added lines, -512 removed lines

@@ -19,524 +19,524 @@
  */
 class EE_Maintenance_Mode implements ResettableInterface
 {
-    /**
-     * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
-     * STATUS_OFF means the site is NOT in maintenance mode (so everything's normal)
-     */
-    public const STATUS_OFF = 0;
-
-
-    /**
-     * STATUS_PUBLIC_ONLY 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
-     */
-    public const STATUS_PUBLIC_ONLY = 1;
-
-    /**
-     * STATUS_FULL_SITE 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
-     */
-    public const STATUS_FULL_SITE = 2;
-
-    /**
-     * the name of the option which stores the current level of maintenance mode
-     */
-    private const OPTION_NAME = 'ee_maintenance_mode';
-
-
-    protected LoaderInterface $loader;
-
-    private RequestInterface $request;
-
-    private static ?EE_Maintenance_Mode $_instance = null;
-
-    /**
-     * @var int
-     * @since 5.0.12.p
-     */
-    private int $status;
-
-    /**
-     * @var int
-     * @since 5.0.12.p
-     */
-    private int $admin_status;
-
-    /**
-     * true if current_user_can('administrator')
-     *
-     * @var bool
-     * @since 5.0.12.p
-     */
-    private bool $current_user_is_admin;
-
-    /**
-     * used to control updates to the WP options setting in the database
-     *
-     * @var bool
-     * @since 5.0.12.p
-     */
-    private bool $update_db;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface|null  $loader
-     * @param RequestInterface|null $request
-     * @return EE_Maintenance_Mode|null
-     */
-    public static function instance(
-        ?LoaderInterface $loader = null,
-        ?RequestInterface $request = null
-    ): ?EE_Maintenance_Mode {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
-            self::$_instance = new EE_Maintenance_Mode($loader, $request);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets maintenance mode (mostly just re-checks whether we should be in maintenance mode)
-     *
-     * @return EE_Maintenance_Mode|null
-     * @throws EE_Error
-     */
-    public static function reset(): ?EE_Maintenance_Mode
-    {
-        self::instance()->set_maintenance_mode_if_db_old();
-        self::instance()->initialize();
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     */
-    private function __construct(LoaderInterface $loader, RequestInterface $request)
-    {
-        $this->loader                = $loader;
-        $this->request               = $request;
-        $this->initialize();
-
-        // 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']);
-    }
-
-
-    private function initialize(): void
-    {
-        $this->current_user_is_admin = current_user_can('administrator');
-        // now make sure the status is set correctly everywhere
-        // (but don't update the db else we'll get into an infinite loop of updates)
-        $this->update_db = false;
-        $this->set_maintenance_level($this->loadStatusFromDatabase());
-        $this->update_db = true;
-    }
-
-
-    private function loadStatusFromDatabase(): int
-    {
-        return (int) get_option(EE_Maintenance_Mode::OPTION_NAME, EE_Maintenance_Mode::STATUS_OFF);
-    }
-
-
-    /**
-     * changes the maintenance mode level to reflect whether the current user is an admin or not.
-     * 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 the site isn't in maintenance mode.
-     *      EE_Maintenance_Mode::STATUS_OFF => not in maintenance mode (in normal mode)
-     *      EE_Maintenance_Mode::STATUS_PUBLIC_ONLY=> frontend-only maintenance mode
-     *      EE_Maintenance_Mode::STATUS_FULL_SITE => frontend and backend maintenance mode
-     *
-     * @param int $status
-     * @return void
-     * @since 5.0.12.p
-     */
-    private function setAdminStatus(int $status)
-    {
-        if (
-            $status === EE_Maintenance_Mode::STATUS_PUBLIC_ONLY
-            && $this->current_user_is_admin
-            && ($this->request->isAjax() || ! $this->request->isAdmin())
-        ) {
-            $status = EE_Maintenance_Mode::STATUS_OFF;
-        }
-        $this->admin_status = $status;
-    }
-
-
-    public function real_level(): int
-    {
-        return $this->status;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function level(): int
-    {
-        return $this->admin_status;
-    }
-
-
-    /**
-     * 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(): bool
-    {
-        /** @var EE_Data_Migration_Manager $data_migration_manager */
-        $data_migration_manager = $this->loader->getShared(EE_Data_Migration_Manager::class);
-        $scripts_that_should_run = $data_migration_manager->check_for_applicable_data_migration_scripts();
-        if (! empty($scripts_that_should_run)) { //  && $this->status !== EE_Maintenance_Mode::STATUS_FULL_SITE
-            $this->activateFullSiteMaintenanceMode();
-            return true;
-        }
-        if ($this->status === EE_Maintenance_Mode::STATUS_FULL_SITE) {
-            // 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?)
-            $this->deactivateMaintenanceMode();
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the maintenance level on the site
-     *
-     * @param int $level
-     * @return void
-     */
-    public function set_maintenance_level(int $level): void
-    {
-        switch ($level) {
-            case EE_Maintenance_Mode::STATUS_OFF:
-                $this->deactivateMaintenanceMode();
-                return;
-            case EE_Maintenance_Mode::STATUS_PUBLIC_ONLY:
-                $this->activatePublicOnlyMaintenanceMode();
-                return;
-            case EE_Maintenance_Mode::STATUS_FULL_SITE:
-                $this->activateFullSiteMaintenanceMode();
-                return;
-        }
-        throw new DomainException(
-            sprintf(
-                esc_html__(
-                    '"%1$s" is not valid a EE maintenance mode level. Please choose from one of the following: %2$s',
-                    'event_espresso'
-                ),
-                $level,
-                'EE_Maintenance_Mode::STATUS_OFF, EE_Maintenance_Mode::STATUS_PUBLIC_ONLY, EE_Maintenance_Mode::STATUS_FULL_SITE',
-            )
-        );
-    }
-
-
-    /**
-     * sets database status to online
-     * sets maintenance mode status to public only, unless current user is an admin, then maintenance mode is disabled
-     *
-     * @return void
-     * @since 5.0.12.p
-     */
-    public function activatePublicOnlyMaintenanceMode()
-    {
-        DbStatus::setOnline();
-        // disable maintenance mode for admins, otherwise enable public only maintenance mode
-        if ($this->current_user_is_admin) {
-            MaintenanceStatus::disableMaintenanceMode();
-        } else {
-            MaintenanceStatus::setPublicOnlyMaintenanceMode();
-        }
-        $this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_PUBLIC_ONLY);
-    }
-
-
-    /**
-     * sets database status to offline
-     * sets maintenance mode status to full site
-     *
-     * @return void
-     * @since 5.0.12.p
-     */
-    public function activateFullSiteMaintenanceMode()
-    {
-        DbStatus::setOffline();
-        MaintenanceStatus::setFullSiteMaintenanceMode();
-        $this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_FULL_SITE);
-    }
-
-
-    /**
-     * sets database status to online
-     * turns maintenance mode off
-     *
-     * @return void
-     * @since 5.0.12.p
-     */
-    public function deactivateMaintenanceMode()
-    {
-        DbStatus::setOnline();
-        MaintenanceStatus::disableMaintenanceMode();
-        $this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_OFF);
-    }
-
-
-    private function updateMaintenaceModeStatus(int $status)
-    {
-        $this->status = $status;
-        $this->setAdminStatus($status);
-        if (! $this->update_db) {
-            return;
-        }
-        do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $status);
-        update_option(EE_Maintenance_Mode::OPTION_NAME, $status);
-    }
-
-
-    /**
-     * 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(): bool
-    {
-        return ! is_admin() && MaintenanceStatus::isNotDisabled();
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_assets_required_for_m_mode(): void
-    {
-        if (
-            $this->status === EE_Maintenance_Mode::STATUS_FULL_SITE
-            && ! 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(): string
-    {
-        // 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(?string $the_content): ?string
-    {
-        // check if M-mode is engaged and for EE shortcode
-        if ($this->admin_status && strpos((string)$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()
-    {
-        if (
-            ! $this->current_user_is_admin
-            || $this->status === EE_Maintenance_Mode::STATUS_OFF
-            || $this->request->isAdmin()
-            || $this->request->isAjax()
-            || ! did_action('AHEE__EE_System__load_core_configuration__complete')
-        ) {
-            return;
-        }
-        /** @var CurrentPage $current_page */
-        $current_page = $this->loader->getShared(CurrentPage::class);
-        if ($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;
-        $page = $this->request->getRequestParam('page', '', DataType::STRING);
-        if (
-            $pagenow == 'admin.php'
-            && $page !== 'espresso_maintenance_settings'
-            && strpos($page, 'espresso_') !== false
-            && $this->status == EE_Maintenance_Mode::STATUS_FULL_SITE
-        ) {
-            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)
-    {
-    }
+	/**
+	 * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
+	 * STATUS_OFF means the site is NOT in maintenance mode (so everything's normal)
+	 */
+	public const STATUS_OFF = 0;
+
+
+	/**
+	 * STATUS_PUBLIC_ONLY 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
+	 */
+	public const STATUS_PUBLIC_ONLY = 1;
+
+	/**
+	 * STATUS_FULL_SITE 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
+	 */
+	public const STATUS_FULL_SITE = 2;
+
+	/**
+	 * the name of the option which stores the current level of maintenance mode
+	 */
+	private const OPTION_NAME = 'ee_maintenance_mode';
+
+
+	protected LoaderInterface $loader;
+
+	private RequestInterface $request;
+
+	private static ?EE_Maintenance_Mode $_instance = null;
+
+	/**
+	 * @var int
+	 * @since 5.0.12.p
+	 */
+	private int $status;
+
+	/**
+	 * @var int
+	 * @since 5.0.12.p
+	 */
+	private int $admin_status;
+
+	/**
+	 * true if current_user_can('administrator')
+	 *
+	 * @var bool
+	 * @since 5.0.12.p
+	 */
+	private bool $current_user_is_admin;
+
+	/**
+	 * used to control updates to the WP options setting in the database
+	 *
+	 * @var bool
+	 * @since 5.0.12.p
+	 */
+	private bool $update_db;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface|null  $loader
+	 * @param RequestInterface|null $request
+	 * @return EE_Maintenance_Mode|null
+	 */
+	public static function instance(
+		?LoaderInterface $loader = null,
+		?RequestInterface $request = null
+	): ?EE_Maintenance_Mode {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Maintenance_Mode) {
+			self::$_instance = new EE_Maintenance_Mode($loader, $request);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets maintenance mode (mostly just re-checks whether we should be in maintenance mode)
+	 *
+	 * @return EE_Maintenance_Mode|null
+	 * @throws EE_Error
+	 */
+	public static function reset(): ?EE_Maintenance_Mode
+	{
+		self::instance()->set_maintenance_mode_if_db_old();
+		self::instance()->initialize();
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 */
+	private function __construct(LoaderInterface $loader, RequestInterface $request)
+	{
+		$this->loader                = $loader;
+		$this->request               = $request;
+		$this->initialize();
+
+		// 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']);
+	}
+
+
+	private function initialize(): void
+	{
+		$this->current_user_is_admin = current_user_can('administrator');
+		// now make sure the status is set correctly everywhere
+		// (but don't update the db else we'll get into an infinite loop of updates)
+		$this->update_db = false;
+		$this->set_maintenance_level($this->loadStatusFromDatabase());
+		$this->update_db = true;
+	}
+
+
+	private function loadStatusFromDatabase(): int
+	{
+		return (int) get_option(EE_Maintenance_Mode::OPTION_NAME, EE_Maintenance_Mode::STATUS_OFF);
+	}
+
+
+	/**
+	 * changes the maintenance mode level to reflect whether the current user is an admin or not.
+	 * 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 the site isn't in maintenance mode.
+	 *      EE_Maintenance_Mode::STATUS_OFF => not in maintenance mode (in normal mode)
+	 *      EE_Maintenance_Mode::STATUS_PUBLIC_ONLY=> frontend-only maintenance mode
+	 *      EE_Maintenance_Mode::STATUS_FULL_SITE => frontend and backend maintenance mode
+	 *
+	 * @param int $status
+	 * @return void
+	 * @since 5.0.12.p
+	 */
+	private function setAdminStatus(int $status)
+	{
+		if (
+			$status === EE_Maintenance_Mode::STATUS_PUBLIC_ONLY
+			&& $this->current_user_is_admin
+			&& ($this->request->isAjax() || ! $this->request->isAdmin())
+		) {
+			$status = EE_Maintenance_Mode::STATUS_OFF;
+		}
+		$this->admin_status = $status;
+	}
+
+
+	public function real_level(): int
+	{
+		return $this->status;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function level(): int
+	{
+		return $this->admin_status;
+	}
+
+
+	/**
+	 * 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(): bool
+	{
+		/** @var EE_Data_Migration_Manager $data_migration_manager */
+		$data_migration_manager = $this->loader->getShared(EE_Data_Migration_Manager::class);
+		$scripts_that_should_run = $data_migration_manager->check_for_applicable_data_migration_scripts();
+		if (! empty($scripts_that_should_run)) { //  && $this->status !== EE_Maintenance_Mode::STATUS_FULL_SITE
+			$this->activateFullSiteMaintenanceMode();
+			return true;
+		}
+		if ($this->status === EE_Maintenance_Mode::STATUS_FULL_SITE) {
+			// 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?)
+			$this->deactivateMaintenanceMode();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the maintenance level on the site
+	 *
+	 * @param int $level
+	 * @return void
+	 */
+	public function set_maintenance_level(int $level): void
+	{
+		switch ($level) {
+			case EE_Maintenance_Mode::STATUS_OFF:
+				$this->deactivateMaintenanceMode();
+				return;
+			case EE_Maintenance_Mode::STATUS_PUBLIC_ONLY:
+				$this->activatePublicOnlyMaintenanceMode();
+				return;
+			case EE_Maintenance_Mode::STATUS_FULL_SITE:
+				$this->activateFullSiteMaintenanceMode();
+				return;
+		}
+		throw new DomainException(
+			sprintf(
+				esc_html__(
+					'"%1$s" is not valid a EE maintenance mode level. Please choose from one of the following: %2$s',
+					'event_espresso'
+				),
+				$level,
+				'EE_Maintenance_Mode::STATUS_OFF, EE_Maintenance_Mode::STATUS_PUBLIC_ONLY, EE_Maintenance_Mode::STATUS_FULL_SITE',
+			)
+		);
+	}
+
+
+	/**
+	 * sets database status to online
+	 * sets maintenance mode status to public only, unless current user is an admin, then maintenance mode is disabled
+	 *
+	 * @return void
+	 * @since 5.0.12.p
+	 */
+	public function activatePublicOnlyMaintenanceMode()
+	{
+		DbStatus::setOnline();
+		// disable maintenance mode for admins, otherwise enable public only maintenance mode
+		if ($this->current_user_is_admin) {
+			MaintenanceStatus::disableMaintenanceMode();
+		} else {
+			MaintenanceStatus::setPublicOnlyMaintenanceMode();
+		}
+		$this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_PUBLIC_ONLY);
+	}
+
+
+	/**
+	 * sets database status to offline
+	 * sets maintenance mode status to full site
+	 *
+	 * @return void
+	 * @since 5.0.12.p
+	 */
+	public function activateFullSiteMaintenanceMode()
+	{
+		DbStatus::setOffline();
+		MaintenanceStatus::setFullSiteMaintenanceMode();
+		$this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_FULL_SITE);
+	}
+
+
+	/**
+	 * sets database status to online
+	 * turns maintenance mode off
+	 *
+	 * @return void
+	 * @since 5.0.12.p
+	 */
+	public function deactivateMaintenanceMode()
+	{
+		DbStatus::setOnline();
+		MaintenanceStatus::disableMaintenanceMode();
+		$this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_OFF);
+	}
+
+
+	private function updateMaintenaceModeStatus(int $status)
+	{
+		$this->status = $status;
+		$this->setAdminStatus($status);
+		if (! $this->update_db) {
+			return;
+		}
+		do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $status);
+		update_option(EE_Maintenance_Mode::OPTION_NAME, $status);
+	}
+
+
+	/**
+	 * 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(): bool
+	{
+		return ! is_admin() && MaintenanceStatus::isNotDisabled();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_assets_required_for_m_mode(): void
+	{
+		if (
+			$this->status === EE_Maintenance_Mode::STATUS_FULL_SITE
+			&& ! 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(): string
+	{
+		// 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(?string $the_content): ?string
+	{
+		// check if M-mode is engaged and for EE shortcode
+		if ($this->admin_status && strpos((string)$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()
+	{
+		if (
+			! $this->current_user_is_admin
+			|| $this->status === EE_Maintenance_Mode::STATUS_OFF
+			|| $this->request->isAdmin()
+			|| $this->request->isAjax()
+			|| ! did_action('AHEE__EE_System__load_core_configuration__complete')
+		) {
+			return;
+		}
+		/** @var CurrentPage $current_page */
+		$current_page = $this->loader->getShared(CurrentPage::class);
+		if ($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;
+		$page = $this->request->getRequestParam('page', '', DataType::STRING);
+		if (
+			$pagenow == 'admin.php'
+			&& $page !== 'espresso_maintenance_settings'
+			&& strpos($page, 'espresso_') !== false
+			&& $this->status == EE_Maintenance_Mode::STATUS_FULL_SITE
+		) {
+			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)
+	{
+	}
 
 
-    /************************ @DEPRECATED ********************** */
+	/************************ @DEPRECATED ********************** */
 
-    /**
-     * @depecated 5.0.12.p
-     */
-    const level_0_not_in_maintenance = 0;
+	/**
+	 * @depecated 5.0.12.p
+	 */
+	const level_0_not_in_maintenance = 0;
 
-    /**
-     * @depecated 5.0.12.p
-     */
-    const level_1_frontend_only_maintenance = 1;
+	/**
+	 * @depecated 5.0.12.p
+	 */
+	const level_1_frontend_only_maintenance = 1;
 
-    /**
-     * @depecated 5.0.12.p
-     */
-    const level_2_complete_maintenance = 2;
+	/**
+	 * @depecated 5.0.12.p
+	 */
+	const level_2_complete_maintenance = 2;
 
-    /**
-     * @depecated 5.0.12.p
-     */
-    const option_name_maintenance_mode = 'ee_maintenance_mode';
+	/**
+	 * @depecated 5.0.12.p
+	 */
+	const option_name_maintenance_mode = 'ee_maintenance_mode';
 
 
-    /**
-     * 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
-     * @depecated 5.0.12.p
-     */
-    public function models_can_query(): bool
-    {
-        return DbStatus::isOnline();
-    }
+	/**
+	 * 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
+	 * @depecated 5.0.12.p
+	 */
+	public function models_can_query(): bool
+	{
+		return DbStatus::isOnline();
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -91,7 +91,7 @@ 
         ?RequestInterface $request = null
     ): ?EE_Maintenance_Mode {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
+        if ( ! self::$_instance instanceof EE_Maintenance_Mode) {
             self::$_instance = new EE_Maintenance_Mode($loader, $request);
         }
         return self::$_instance;
@@ -201,7 +201,7 @@ 
         /** @var EE_Data_Migration_Manager $data_migration_manager */
         $data_migration_manager = $this->loader->getShared(EE_Data_Migration_Manager::class);
         $scripts_that_should_run = $data_migration_manager->check_for_applicable_data_migration_scripts();
-        if (! empty($scripts_that_should_run)) { //  && $this->status !== EE_Maintenance_Mode::STATUS_FULL_SITE
+        if ( ! empty($scripts_that_should_run)) { //  && $this->status !== EE_Maintenance_Mode::STATUS_FULL_SITE
             $this->activateFullSiteMaintenanceMode();
             return true;
         }
@@ -300,7 +300,7 @@ 
     {
         $this->status = $status;
         $this->setAdminStatus($status);
-        if (! $this->update_db) {
+        if ( ! $this->update_db) {
             return;
         }
         do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $status);
@@ -330,14 +330,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
@@ -357,7 +357,7 @@ 
     public static function template_include(): string
     {
         // 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';
     }
 
 
@@ -371,7 +371,7 @@ 
     public function the_content(?string $the_content): ?string
     {
         // check if M-mode is engaged and for EE shortcode
-        if ($this->admin_status && strpos((string)$the_content, '[ESPRESSO_') !== false) {
+        if ($this->admin_status && strpos((string) $the_content, '[ESPRESSO_') !== false) {
             // this can eventually be moved to a template, or edited via admin. But for now...
             $the_content = sprintf(
                 esc_html__(
@@ -411,10 +411,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>'
             );
         }

core/domain/services/admin/registrations/list_table/QueryBuilder.php

Indentation +413 added lines, -413 removed lines

@@ -23,417 +23,417 @@
  */
 class QueryBuilder
 {
-    protected RequestInterface $request;
-
-    protected EEM_Registration $registration_model;
-
-    protected array $filters;
-
-    protected string $view;
-
-    protected array $where_params;
-
-
-    /**
-     * QueryBuilder constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Registration $registration_model
-     * @param array            $extra_request_params
-     */
-    public function __construct(
-        RequestInterface $request,
-        EEM_Registration $registration_model,
-        array $extra_request_params = []
-    ) {
-        $this->request = $request;
-        $this->filters = $this->request->getRequestParam('filters', [], DataType::STRING, true);
-        $this->registration_model = $registration_model;
-        foreach ($extra_request_params as $key => $value) {
-            if (! $this->request->requestParamIsSet($key)) {
-                $this->request->setRequestParam($key, $value);
-            }
-        }
-        $this->view = $this->request->getRequestParam('status', '');
-        $this->where_params = [];
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @param int  $per_page
-     * @param bool $count_query
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getQueryParams(int $per_page = 10, bool $count_query = false): array
-    {
-        $query_params = [
-            0                          => $this->getWhereClause(),
-            'caps'                     => EEM_Base::caps_read_admin,
-            'default_where_conditions' => 'this_model_only',
-        ];
-        if (! $count_query) {
-            $query_params = array_merge(
-                $query_params,
-                $this->getOrderbyClause(),
-                $this->getLimitClause($per_page)
-            );
-        }
-
-        return $query_params;
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getWhereClause(): array
-    {
-        $this->addAttendeeIdToWhereConditions();
-        $this->addEventIdToWhereConditions();
-        $this->addCategoryIdToWhereConditions();
-        $this->addDatetimeIdToWhereConditions();
-        $this->addTicketIdToWhereConditions();
-        $this->addRegistrationStatusToWhereConditions();
-        $this->addDateToWhereConditions();
-        $this->addSearchToWhereConditions();
-        return apply_filters(
-            'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
-            $this->where_params,
-            $this->request->requestParams()
-        );
-    }
-
-
-    /**
-     * This will add ATT_ID to the provided $this->where_clause array for EE model query parameters.
-     */
-    protected function addAttendeeIdToWhereConditions()
-    {
-        $ATT_ID = $this->request->getRequestParam('attendee_id');
-        $ATT_ID = $this->request->getRequestParam('ATT_ID', $ATT_ID, 'int');
-        if ($ATT_ID) {
-            $this->where_params['ATT_ID'] = $ATT_ID;
-        }
-    }
-
-
-    /**
-     * This will add EVT_ID to the provided $this->where_clause array for EE model query parameters.
-     */
-    protected function addEventIdToWhereConditions()
-    {
-        $EVT_ID = $this->request->getRequestParam('event_id');
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', $EVT_ID, 'int');
-        if ($EVT_ID) {
-            $this->where_params['EVT_ID'] = $EVT_ID;
-        }
-    }
-
-
-    /**
-     * Adds category ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addCategoryIdToWhereConditions()
-    {
-        $EVT_CAT = $this->request->getRequestParam('EVT_CAT', 0, DataType::INTEGER);
-        $EVT_CAT = $this->filters['EVT_CAT'] ?? $EVT_CAT;
-        $EVT_CAT = (int) $EVT_CAT;
-        if ($EVT_CAT > 0) {
-            $this->where_params['Event.Term_Taxonomy.term_id'] = $EVT_CAT;
-        }
-    }
-
-
-    /**
-     * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addDatetimeIdToWhereConditions()
-    {
-        // first look for 'datetime_id' then 'DTT_ID' using first result as fallback default value
-        $DTT_ID = $this->request->getRequestParam('datetime_id');
-        $DTT_ID = $this->request->getRequestParam('DTT_ID', $DTT_ID, DataType::INTEGER);
-        $DTT_ID = $this->filters['datetime_id'] ?? $DTT_ID;
-        $DTT_ID = (int) $DTT_ID;
-
-        if ($DTT_ID) {
-            $this->where_params['Ticket.Datetime.DTT_ID'] = $DTT_ID;
-        }
-    }
-
-
-    /**
-     * Adds the ticket ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addTicketIdToWhereConditions()
-    {
-        // first look for 'ticket_id' then 'TKT_ID' using first result as fallback default value
-        $TKT_ID = $this->request->getRequestParam('ticket_id');
-        $TKT_ID = $this->request->getRequestParam('TKT_ID', $TKT_ID, DataType::INTEGER);
-        $TKT_ID = $this->filters['ticket_id'] ?? $TKT_ID;
-        $TKT_ID = (int) $TKT_ID;
-
-        if ($TKT_ID) {
-            $this->where_params['TKT_ID'] = $TKT_ID;
-        }
-    }
-
-
-    /**
-     * Adds the correct registration status to the where conditions for the registrations query.
-     * If filtering by registration status, then we show registrations matching that status.
-     * If not filtering by specified status, then we show all registrations excluding incomplete registrations
-     * UNLESS viewing trashed registrations.
-     */
-    protected function addRegistrationStatusToWhereConditions()
-    {
-        $registration_status = $this->request->getRequestParam('_reg_status');
-        $registration_status = $this->filters['_reg_status'] ?? $registration_status;
-        if ($registration_status) {
-            $this->where_params['STS_ID'] = sanitize_text_field($registration_status);
-            return;
-        }
-        // make sure we exclude incomplete registrations, but only if not trashed.
-        if ($this->view === 'trash') {
-            $this->where_params['REG_deleted'] = true;
-            return;
-        }
-        $this->where_params['STS_ID'] = $this->view === 'incomplete'
-            ? RegStatus::INCOMPLETE
-            : ['!=', RegStatus::INCOMPLETE];
-    }
-
-
-    /**
-     * Adds any provided date restraints to the where conditions for the registrations query.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function addDateToWhereConditions()
-    {
-        $current_time = current_time('timestamp');
-        $timezone_string = EEH_DTT_Helper::get_timezone();
-        if ($this->view === 'today') {
-            $now = date('Y-m-d', $current_time);
-            $this->where_params['REG_date'] = [
-                'BETWEEN',
-                [
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 00:00:00',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 23:59:59',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                ],
-            ];
-            return;
-        }
-        if ($this->view === 'yesterday') {
-            $yesterday = date('Y-m-d', $current_time - DAY_IN_SECONDS);
-            $this->where_params['REG_date'] = [
-                'BETWEEN',
-                [
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $yesterday . ' 00:00:00',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $yesterday . ' 23:59:59',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                ],
-            ];
-            return;
-        }
-        if ($this->view === 'month') {
-            $current_year_and_month = date('Y-m', $current_time);
-            $days_this_month = date('t', $current_time);
-            $this->where_params['REG_date'] = [
-                'BETWEEN',
-                [
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                ],
-            ];
-            return;
-        }
-        $month_range = $this->request->getRequestParam('month_range');
-        $month_range = $this->filters['month_range'] ?? $month_range;
-        if ($month_range) {
-            $month_range = sanitize_text_field($month_range);
-            $pieces = explode(' ', $month_range, 3);
-            $month_requested = ! empty($pieces[0])
-                ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
-                : '';
-            $year_requested = ! empty($pieces[1])
-                ? $pieces[1]
-                : '';
-            // if there is not a month or year then we can't go further
-            if ($month_requested && $year_requested) {
-                $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
-                $this->where_params['REG_date'] = [
-                    'BETWEEN',
-                    [
-                        $this->registration_model->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
-                            'Y-m-d H:i:s',
-                            $timezone_string
-                        ),
-                        $this->registration_model->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
-                            'Y-m-d H:i:s',
-                            $timezone_string
-                        ),
-                    ],
-                ];
-            }
-        }
-    }
-
-
-    /**
-     * Adds any provided search restraints to the where conditions for the registrations query
-     */
-    protected function addSearchToWhereConditions()
-    {
-        $search = $this->request->getRequestParam('s');
-        if ($search) {
-            $search_string = '%' . sanitize_text_field($search) . '%';
-            $this->where_params['OR*search_conditions'] = [
-                'Event.EVT_name'                          => ['LIKE', $search_string],
-                'Event.EVT_desc'                          => ['LIKE', $search_string],
-                'Event.EVT_short_desc'                    => ['LIKE', $search_string],
-                'Attendee.ATT_full_name'                  => ['LIKE', $search_string],
-                'Attendee.ATT_fname'                      => ['LIKE', $search_string],
-                'Attendee.ATT_lname'                      => ['LIKE', $search_string],
-                'Attendee.ATT_short_bio'                  => ['LIKE', $search_string],
-                'Attendee.ATT_email'                      => ['LIKE', $search_string],
-                'Attendee.ATT_address'                    => ['LIKE', $search_string],
-                'Attendee.ATT_address2'                   => ['LIKE', $search_string],
-                'Attendee.ATT_city'                       => ['LIKE', $search_string],
-                'REG_ID'                                  => ['LIKE', $search_string],
-                'REG_final_price'                         => ['LIKE', $search_string],
-                'REG_code'                                => ['LIKE', $search_string],
-                'REG_count'                               => ['LIKE', $search_string],
-                'REG_group_size'                          => ['LIKE', $search_string],
-                'Ticket.TKT_name'                         => ['LIKE', $search_string],
-                'Ticket.TKT_description'                  => ['LIKE', $search_string],
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => ['LIKE', $search_string],
-            ];
-        }
-    }
-
-
-    /**
-     * Sets up the orderby for the registrations query.
-     *
-     * @return array
-     */
-    protected function getOrderbyClause(): array
-    {
-        $orderby_field = $this->request->getRequestParam('orderby');
-        $orderby_field = $orderby_field ? sanitize_text_field($orderby_field) : '_REG_date';
-        switch ($orderby_field) {
-            case '_REG_ID':
-                $orderby = ['REG_ID'];
-                break;
-            case '_Reg_status':
-                $orderby = ['STS_ID'];
-                break;
-            case 'ATT_fname':
-                $orderby = ['Attendee.ATT_fname', 'Attendee.ATT_lname'];
-                break;
-            case 'ATT_lname':
-                $orderby = ['Attendee.ATT_lname', 'Attendee.ATT_fname'];
-                break;
-            case 'event_name':
-                $orderby = ['Event.EVT_name'];
-                break;
-            case 'DTT_EVT_start':
-                $orderby = ['Event.Datetime.DTT_EVT_start'];
-                break;
-            case '_REG_date':
-                $orderby = ['REG_date'];
-                break;
-            default:
-                $orderby = [$orderby_field];
-                break;
-        }
-        $order = $this->request->getRequestParam('order');
-        $order = $order ? sanitize_text_field($order) : 'DESC';
-
-        $orderby = array_combine(
-            $orderby,
-            array_fill(0, count($orderby), $order)
-        );
-        // always add REG_count to the orderby array
-        $orderby['REG_count'] = 'ASC';
-        // because there are many registrations with the same date, define
-        // a secondary way to order them, otherwise MySQL seems to be a bit random
-        if (empty($orderby['REG_ID'])) {
-            $orderby['REG_ID'] = $order;
-        }
-
-        $orderby = apply_filters(
-            'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query',
-            $orderby,
-            $this->request->requestParams()
-        );
-        return ['order_by' => $orderby];
-    }
-
-
-    /**
-     * Sets up the limit for the registrations query.
-     *
-     * @param int $per_page
-     * @return array
-     */
-    protected function getLimitClause(int $per_page): array
-    {
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
-        // -1 means return all results so get out if that's set.
-        if ($per_page === -1) {
-            return [];
-        }
-        $offset = ($current_page - 1) * $per_page;
-        return ['limit' => [$offset, $per_page]];
-    }
+	protected RequestInterface $request;
+
+	protected EEM_Registration $registration_model;
+
+	protected array $filters;
+
+	protected string $view;
+
+	protected array $where_params;
+
+
+	/**
+	 * QueryBuilder constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Registration $registration_model
+	 * @param array            $extra_request_params
+	 */
+	public function __construct(
+		RequestInterface $request,
+		EEM_Registration $registration_model,
+		array $extra_request_params = []
+	) {
+		$this->request = $request;
+		$this->filters = $this->request->getRequestParam('filters', [], DataType::STRING, true);
+		$this->registration_model = $registration_model;
+		foreach ($extra_request_params as $key => $value) {
+			if (! $this->request->requestParamIsSet($key)) {
+				$this->request->setRequestParam($key, $value);
+			}
+		}
+		$this->view = $this->request->getRequestParam('status', '');
+		$this->where_params = [];
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @param int  $per_page
+	 * @param bool $count_query
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getQueryParams(int $per_page = 10, bool $count_query = false): array
+	{
+		$query_params = [
+			0                          => $this->getWhereClause(),
+			'caps'                     => EEM_Base::caps_read_admin,
+			'default_where_conditions' => 'this_model_only',
+		];
+		if (! $count_query) {
+			$query_params = array_merge(
+				$query_params,
+				$this->getOrderbyClause(),
+				$this->getLimitClause($per_page)
+			);
+		}
+
+		return $query_params;
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getWhereClause(): array
+	{
+		$this->addAttendeeIdToWhereConditions();
+		$this->addEventIdToWhereConditions();
+		$this->addCategoryIdToWhereConditions();
+		$this->addDatetimeIdToWhereConditions();
+		$this->addTicketIdToWhereConditions();
+		$this->addRegistrationStatusToWhereConditions();
+		$this->addDateToWhereConditions();
+		$this->addSearchToWhereConditions();
+		return apply_filters(
+			'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
+			$this->where_params,
+			$this->request->requestParams()
+		);
+	}
+
+
+	/**
+	 * This will add ATT_ID to the provided $this->where_clause array for EE model query parameters.
+	 */
+	protected function addAttendeeIdToWhereConditions()
+	{
+		$ATT_ID = $this->request->getRequestParam('attendee_id');
+		$ATT_ID = $this->request->getRequestParam('ATT_ID', $ATT_ID, 'int');
+		if ($ATT_ID) {
+			$this->where_params['ATT_ID'] = $ATT_ID;
+		}
+	}
+
+
+	/**
+	 * This will add EVT_ID to the provided $this->where_clause array for EE model query parameters.
+	 */
+	protected function addEventIdToWhereConditions()
+	{
+		$EVT_ID = $this->request->getRequestParam('event_id');
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', $EVT_ID, 'int');
+		if ($EVT_ID) {
+			$this->where_params['EVT_ID'] = $EVT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds category ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addCategoryIdToWhereConditions()
+	{
+		$EVT_CAT = $this->request->getRequestParam('EVT_CAT', 0, DataType::INTEGER);
+		$EVT_CAT = $this->filters['EVT_CAT'] ?? $EVT_CAT;
+		$EVT_CAT = (int) $EVT_CAT;
+		if ($EVT_CAT > 0) {
+			$this->where_params['Event.Term_Taxonomy.term_id'] = $EVT_CAT;
+		}
+	}
+
+
+	/**
+	 * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addDatetimeIdToWhereConditions()
+	{
+		// first look for 'datetime_id' then 'DTT_ID' using first result as fallback default value
+		$DTT_ID = $this->request->getRequestParam('datetime_id');
+		$DTT_ID = $this->request->getRequestParam('DTT_ID', $DTT_ID, DataType::INTEGER);
+		$DTT_ID = $this->filters['datetime_id'] ?? $DTT_ID;
+		$DTT_ID = (int) $DTT_ID;
+
+		if ($DTT_ID) {
+			$this->where_params['Ticket.Datetime.DTT_ID'] = $DTT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds the ticket ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addTicketIdToWhereConditions()
+	{
+		// first look for 'ticket_id' then 'TKT_ID' using first result as fallback default value
+		$TKT_ID = $this->request->getRequestParam('ticket_id');
+		$TKT_ID = $this->request->getRequestParam('TKT_ID', $TKT_ID, DataType::INTEGER);
+		$TKT_ID = $this->filters['ticket_id'] ?? $TKT_ID;
+		$TKT_ID = (int) $TKT_ID;
+
+		if ($TKT_ID) {
+			$this->where_params['TKT_ID'] = $TKT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds the correct registration status to the where conditions for the registrations query.
+	 * If filtering by registration status, then we show registrations matching that status.
+	 * If not filtering by specified status, then we show all registrations excluding incomplete registrations
+	 * UNLESS viewing trashed registrations.
+	 */
+	protected function addRegistrationStatusToWhereConditions()
+	{
+		$registration_status = $this->request->getRequestParam('_reg_status');
+		$registration_status = $this->filters['_reg_status'] ?? $registration_status;
+		if ($registration_status) {
+			$this->where_params['STS_ID'] = sanitize_text_field($registration_status);
+			return;
+		}
+		// make sure we exclude incomplete registrations, but only if not trashed.
+		if ($this->view === 'trash') {
+			$this->where_params['REG_deleted'] = true;
+			return;
+		}
+		$this->where_params['STS_ID'] = $this->view === 'incomplete'
+			? RegStatus::INCOMPLETE
+			: ['!=', RegStatus::INCOMPLETE];
+	}
+
+
+	/**
+	 * Adds any provided date restraints to the where conditions for the registrations query.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function addDateToWhereConditions()
+	{
+		$current_time = current_time('timestamp');
+		$timezone_string = EEH_DTT_Helper::get_timezone();
+		if ($this->view === 'today') {
+			$now = date('Y-m-d', $current_time);
+			$this->where_params['REG_date'] = [
+				'BETWEEN',
+				[
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 00:00:00',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 23:59:59',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+				],
+			];
+			return;
+		}
+		if ($this->view === 'yesterday') {
+			$yesterday = date('Y-m-d', $current_time - DAY_IN_SECONDS);
+			$this->where_params['REG_date'] = [
+				'BETWEEN',
+				[
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$yesterday . ' 00:00:00',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$yesterday . ' 23:59:59',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+				],
+			];
+			return;
+		}
+		if ($this->view === 'month') {
+			$current_year_and_month = date('Y-m', $current_time);
+			$days_this_month = date('t', $current_time);
+			$this->where_params['REG_date'] = [
+				'BETWEEN',
+				[
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-01 00:00:00',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+				],
+			];
+			return;
+		}
+		$month_range = $this->request->getRequestParam('month_range');
+		$month_range = $this->filters['month_range'] ?? $month_range;
+		if ($month_range) {
+			$month_range = sanitize_text_field($month_range);
+			$pieces = explode(' ', $month_range, 3);
+			$month_requested = ! empty($pieces[0])
+				? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
+				: '';
+			$year_requested = ! empty($pieces[1])
+				? $pieces[1]
+				: '';
+			// if there is not a month or year then we can't go further
+			if ($month_requested && $year_requested) {
+				$days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+				$this->where_params['REG_date'] = [
+					'BETWEEN',
+					[
+						$this->registration_model->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-01 00:00:00',
+							'Y-m-d H:i:s',
+							$timezone_string
+						),
+						$this->registration_model->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+							'Y-m-d H:i:s',
+							$timezone_string
+						),
+					],
+				];
+			}
+		}
+	}
+
+
+	/**
+	 * Adds any provided search restraints to the where conditions for the registrations query
+	 */
+	protected function addSearchToWhereConditions()
+	{
+		$search = $this->request->getRequestParam('s');
+		if ($search) {
+			$search_string = '%' . sanitize_text_field($search) . '%';
+			$this->where_params['OR*search_conditions'] = [
+				'Event.EVT_name'                          => ['LIKE', $search_string],
+				'Event.EVT_desc'                          => ['LIKE', $search_string],
+				'Event.EVT_short_desc'                    => ['LIKE', $search_string],
+				'Attendee.ATT_full_name'                  => ['LIKE', $search_string],
+				'Attendee.ATT_fname'                      => ['LIKE', $search_string],
+				'Attendee.ATT_lname'                      => ['LIKE', $search_string],
+				'Attendee.ATT_short_bio'                  => ['LIKE', $search_string],
+				'Attendee.ATT_email'                      => ['LIKE', $search_string],
+				'Attendee.ATT_address'                    => ['LIKE', $search_string],
+				'Attendee.ATT_address2'                   => ['LIKE', $search_string],
+				'Attendee.ATT_city'                       => ['LIKE', $search_string],
+				'REG_ID'                                  => ['LIKE', $search_string],
+				'REG_final_price'                         => ['LIKE', $search_string],
+				'REG_code'                                => ['LIKE', $search_string],
+				'REG_count'                               => ['LIKE', $search_string],
+				'REG_group_size'                          => ['LIKE', $search_string],
+				'Ticket.TKT_name'                         => ['LIKE', $search_string],
+				'Ticket.TKT_description'                  => ['LIKE', $search_string],
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => ['LIKE', $search_string],
+			];
+		}
+	}
+
+
+	/**
+	 * Sets up the orderby for the registrations query.
+	 *
+	 * @return array
+	 */
+	protected function getOrderbyClause(): array
+	{
+		$orderby_field = $this->request->getRequestParam('orderby');
+		$orderby_field = $orderby_field ? sanitize_text_field($orderby_field) : '_REG_date';
+		switch ($orderby_field) {
+			case '_REG_ID':
+				$orderby = ['REG_ID'];
+				break;
+			case '_Reg_status':
+				$orderby = ['STS_ID'];
+				break;
+			case 'ATT_fname':
+				$orderby = ['Attendee.ATT_fname', 'Attendee.ATT_lname'];
+				break;
+			case 'ATT_lname':
+				$orderby = ['Attendee.ATT_lname', 'Attendee.ATT_fname'];
+				break;
+			case 'event_name':
+				$orderby = ['Event.EVT_name'];
+				break;
+			case 'DTT_EVT_start':
+				$orderby = ['Event.Datetime.DTT_EVT_start'];
+				break;
+			case '_REG_date':
+				$orderby = ['REG_date'];
+				break;
+			default:
+				$orderby = [$orderby_field];
+				break;
+		}
+		$order = $this->request->getRequestParam('order');
+		$order = $order ? sanitize_text_field($order) : 'DESC';
+
+		$orderby = array_combine(
+			$orderby,
+			array_fill(0, count($orderby), $order)
+		);
+		// always add REG_count to the orderby array
+		$orderby['REG_count'] = 'ASC';
+		// because there are many registrations with the same date, define
+		// a secondary way to order them, otherwise MySQL seems to be a bit random
+		if (empty($orderby['REG_ID'])) {
+			$orderby['REG_ID'] = $order;
+		}
+
+		$orderby = apply_filters(
+			'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query',
+			$orderby,
+			$this->request->requestParams()
+		);
+		return ['order_by' => $orderby];
+	}
+
+
+	/**
+	 * Sets up the limit for the registrations query.
+	 *
+	 * @param int $per_page
+	 * @return array
+	 */
+	protected function getLimitClause(int $per_page): array
+	{
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
+		// -1 means return all results so get out if that's set.
+		if ($per_page === -1) {
+			return [];
+		}
+		$offset = ($current_page - 1) * $per_page;
+		return ['limit' => [$offset, $per_page]];
+	}
 }

core/libraries/shortcodes/EE_Attendee_Shortcodes.lib.php

Indentation +229 added lines, -229 removed lines

@@ -15,233 +15,233 @@
  */
 class EE_Attendee_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * hold all extra data.
-     *
-     * @var array|stdClass|null
-     */
-    protected $_extra;
-
-
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Attendee Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to attendee related data', 'event_espresso');
-        $this->_shortcodes = [
-            '[FNAME]'                          => esc_html__('First Name of an attendee.', 'event_espresso'),
-            '[LNAME]'                          => esc_html__('Last Name of an attendee.', 'event_espresso'),
-            '[ATTENDEE_EMAIL]'                 => esc_html__('Email address for the attendee.', 'event_espresso'),
-            '[EDIT_ATTENDEE_LINK]'             => esc_html__(
-                'Edit Registration Link (typically you\'d only use this for messages going to event administrators)',
-                'event_espresso'
-            ),
-            '[REGISTRATION_ID]'                => esc_html__(
-                'Unique Registration ID for the registration',
-                'event_espresso'
-            ),
-            '[REGISTRATION_CODE]'              => esc_html__(
-                'Unique Registration Code for the registration',
-                'event_espresso'
-            ),
-            '[REGISTRATION_STATUS_ID]'         => esc_html__(
-                'Parses to the registration status for the attendee',
-                'event_espresso'
-            ),
-            '[REGISTRATION_STATUS_LABEL]'      => esc_html__(
-                'Parses to the status label for the registrant',
-                'event_espresso'
-            ),
-            '[REGISTRATION_TOTAL_AMOUNT_PAID]' => esc_html__(
-                'Parses to the total amount paid for this registration.',
-                'event_espresso'
-            ),
-            '[FRONTEND_EDIT_REG_LINK]'         => esc_html__(
-                'Generates a link for the given registration to edit this registration details on the frontend.',
-                'event_espresso'
-            ),
-            '[PHONE_NUMBER]'                   => esc_html__(
-                'The Phone Number for the Registration.',
-                'event_espresso'
-            ),
-            '[ADDRESS]'                        => esc_html__('The Address for the Registration', 'event_espresso'),
-            '[ADDRESS2]'                       => esc_html__(
-                'Whatever was in the address 2 field for the registration.',
-                'event_espresso'
-            ),
-            '[CITY]'                           => esc_html__('The city for the registration.', 'event_espresso'),
-            '[ZIP_PC]'                         => esc_html__(
-                'The ZIP (or Postal) Code for the Registration.',
-                'event_espresso'
-            ),
-            '[ADDRESS_STATE]'                  => esc_html__(
-                'The state/province for the registration.',
-                'event_espresso'
-            ),
-            '[COUNTRY]'                        => esc_html__('The country for the registration.', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * handles shortcode parsing
-     *
-     * @param string $shortcode the shortcode to be parsed.
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        $this->_extra = isset($this->_extra_data['data'])
-            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']
-                : null;
-
-        $registration = $this->getRegistration();
-        $attendee     = $this->getAttendee($registration);
-
-        switch ($shortcode) {
-            case '[FNAME]':
-                return $attendee->fname();
-
-            case '[LNAME]':
-                return $attendee->lname();
-
-            case '[ATTENDEE_EMAIL]':
-                return $attendee->email();
-
-            case '[EDIT_ATTENDEE_LINK]':
-                return $registration->get_admin_edit_url();
-
-            case '[REGISTRATION_CODE]':
-                return $registration->reg_code();
-
-            case '[REGISTRATION_ID]':
-                return $registration->ID();
-
-            case '[FRONTEND_EDIT_REG_LINK]':
-                return $registration->edit_attendee_information_url();
-
-            case '[PHONE_NUMBER]':
-                return $attendee->phone();
-
-            case '[ADDRESS]':
-                return $attendee->address();
-
-            case '[ADDRESS2]':
-                return $attendee->address2();
-
-            case '[CITY]':
-                return $attendee->city();
-
-            case '[ZIP_PC]':
-                return $attendee->zip();
-
-            case '[ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-
-            case '[COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-
-            case '[REGISTRATION_STATUS_ID]':
-                return $registration->status_ID();
-
-            case '[REGISTRATION_STATUS_LABEL]':
-                return $registration->pretty_status();
-
-            case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
-                return $registration->pretty_paid();
-        }
-
-        return apply_filters(
-            'FHEE__EE_Attendee_Shortcodes__parsed',
-            '',
-            $shortcode,
-            $registration,
-            $attendee,
-            $this->_data,
-            $this->_extra_data,
-            $this
-        );
-    }
-
-
-    /**
-     * @return EE_Registration
-     * @throws EE_Error
-     * @since 5.0.20.p
-     */
-    private function getRegistration(): EE_Registration
-    {
-        // incoming object should only be a registration object.
-        if ($this->_data instanceof EE_Registration) {
-            return $this->_data;
-        }
-        // look for registration in _data
-        if ($this->_data instanceof EE_Messages_Addressee) {
-            if ($this->_data->reg_obj instanceof EE_Registration) {
-                return $this->_data->reg_obj;
-            }
-            if ($this->_data->primary_reg_obj instanceof EE_Registration) {
-                return $this->_data->primary_reg_obj;
-            }
-        }
-        // look for registration in _extra
-        if ($this->_extra instanceof EE_Messages_Addressee) {
-            if ($this->_extra->reg_obj instanceof EE_Registration) {
-                return $this->_extra->reg_obj;
-            }
-            if ($this->_extra->primary_reg_obj instanceof EE_Registration) {
-                return $this->_extra->primary_reg_obj;
-            }
-        }
-        // let's attempt to get the txn_id for the error message.
-        $txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
-            ? $this->_extra->txn->ID()
-            : esc_html__('Unknown', 'event_espresso');
-        $msg     = esc_html__(
-            'There is no EE_Registration object in the data sent to the EE_Attendee Shortcode Parser for the messages system.',
-            'event_espresso'
-        );
-        $dev_msg = sprintf(
-            esc_html__('The transaction ID for this request is: %s', 'event_espresso'),
-            $txn_id
-        );
-        throw new EE_Error("$msg||$msg $dev_msg");
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.20.p
-     */
-    private function getAttendee(EE_Registration $registration): EE_Attendee
-    {
-        $attendee = $registration->attendee();
-        if ($attendee instanceof EE_Attendee) {
-            return $attendee;
-        }
-        // attendee obj for this registration
-        if (
-            isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
-            && $this->_extra->registrations[ $registration->ID() ]['att_obj'] instanceof EE_Attendee
-        ) {
-            return $this->_extra->registrations[ $registration->ID() ]['att_obj'];
-        }
-
-        $msg     = esc_html__(
-            'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
-            'event_espresso'
-        );
-        $dev_msg = sprintf(
-            esc_html__('The registration ID for this request is: %s', 'event_espresso'),
-            $registration->ID()
-        );
-        throw new EE_Error("$msg||$msg $dev_msg");
-    }
+	/**
+	 * hold all extra data.
+	 *
+	 * @var array|stdClass|null
+	 */
+	protected $_extra;
+
+
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Attendee Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to attendee related data', 'event_espresso');
+		$this->_shortcodes = [
+			'[FNAME]'                          => esc_html__('First Name of an attendee.', 'event_espresso'),
+			'[LNAME]'                          => esc_html__('Last Name of an attendee.', 'event_espresso'),
+			'[ATTENDEE_EMAIL]'                 => esc_html__('Email address for the attendee.', 'event_espresso'),
+			'[EDIT_ATTENDEE_LINK]'             => esc_html__(
+				'Edit Registration Link (typically you\'d only use this for messages going to event administrators)',
+				'event_espresso'
+			),
+			'[REGISTRATION_ID]'                => esc_html__(
+				'Unique Registration ID for the registration',
+				'event_espresso'
+			),
+			'[REGISTRATION_CODE]'              => esc_html__(
+				'Unique Registration Code for the registration',
+				'event_espresso'
+			),
+			'[REGISTRATION_STATUS_ID]'         => esc_html__(
+				'Parses to the registration status for the attendee',
+				'event_espresso'
+			),
+			'[REGISTRATION_STATUS_LABEL]'      => esc_html__(
+				'Parses to the status label for the registrant',
+				'event_espresso'
+			),
+			'[REGISTRATION_TOTAL_AMOUNT_PAID]' => esc_html__(
+				'Parses to the total amount paid for this registration.',
+				'event_espresso'
+			),
+			'[FRONTEND_EDIT_REG_LINK]'         => esc_html__(
+				'Generates a link for the given registration to edit this registration details on the frontend.',
+				'event_espresso'
+			),
+			'[PHONE_NUMBER]'                   => esc_html__(
+				'The Phone Number for the Registration.',
+				'event_espresso'
+			),
+			'[ADDRESS]'                        => esc_html__('The Address for the Registration', 'event_espresso'),
+			'[ADDRESS2]'                       => esc_html__(
+				'Whatever was in the address 2 field for the registration.',
+				'event_espresso'
+			),
+			'[CITY]'                           => esc_html__('The city for the registration.', 'event_espresso'),
+			'[ZIP_PC]'                         => esc_html__(
+				'The ZIP (or Postal) Code for the Registration.',
+				'event_espresso'
+			),
+			'[ADDRESS_STATE]'                  => esc_html__(
+				'The state/province for the registration.',
+				'event_espresso'
+			),
+			'[COUNTRY]'                        => esc_html__('The country for the registration.', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * handles shortcode parsing
+	 *
+	 * @param string $shortcode the shortcode to be parsed.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		$this->_extra = isset($this->_extra_data['data'])
+			&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']
+				: null;
+
+		$registration = $this->getRegistration();
+		$attendee     = $this->getAttendee($registration);
+
+		switch ($shortcode) {
+			case '[FNAME]':
+				return $attendee->fname();
+
+			case '[LNAME]':
+				return $attendee->lname();
+
+			case '[ATTENDEE_EMAIL]':
+				return $attendee->email();
+
+			case '[EDIT_ATTENDEE_LINK]':
+				return $registration->get_admin_edit_url();
+
+			case '[REGISTRATION_CODE]':
+				return $registration->reg_code();
+
+			case '[REGISTRATION_ID]':
+				return $registration->ID();
+
+			case '[FRONTEND_EDIT_REG_LINK]':
+				return $registration->edit_attendee_information_url();
+
+			case '[PHONE_NUMBER]':
+				return $attendee->phone();
+
+			case '[ADDRESS]':
+				return $attendee->address();
+
+			case '[ADDRESS2]':
+				return $attendee->address2();
+
+			case '[CITY]':
+				return $attendee->city();
+
+			case '[ZIP_PC]':
+				return $attendee->zip();
+
+			case '[ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+
+			case '[COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+
+			case '[REGISTRATION_STATUS_ID]':
+				return $registration->status_ID();
+
+			case '[REGISTRATION_STATUS_LABEL]':
+				return $registration->pretty_status();
+
+			case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
+				return $registration->pretty_paid();
+		}
+
+		return apply_filters(
+			'FHEE__EE_Attendee_Shortcodes__parsed',
+			'',
+			$shortcode,
+			$registration,
+			$attendee,
+			$this->_data,
+			$this->_extra_data,
+			$this
+		);
+	}
+
+
+	/**
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 * @since 5.0.20.p
+	 */
+	private function getRegistration(): EE_Registration
+	{
+		// incoming object should only be a registration object.
+		if ($this->_data instanceof EE_Registration) {
+			return $this->_data;
+		}
+		// look for registration in _data
+		if ($this->_data instanceof EE_Messages_Addressee) {
+			if ($this->_data->reg_obj instanceof EE_Registration) {
+				return $this->_data->reg_obj;
+			}
+			if ($this->_data->primary_reg_obj instanceof EE_Registration) {
+				return $this->_data->primary_reg_obj;
+			}
+		}
+		// look for registration in _extra
+		if ($this->_extra instanceof EE_Messages_Addressee) {
+			if ($this->_extra->reg_obj instanceof EE_Registration) {
+				return $this->_extra->reg_obj;
+			}
+			if ($this->_extra->primary_reg_obj instanceof EE_Registration) {
+				return $this->_extra->primary_reg_obj;
+			}
+		}
+		// let's attempt to get the txn_id for the error message.
+		$txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
+			? $this->_extra->txn->ID()
+			: esc_html__('Unknown', 'event_espresso');
+		$msg     = esc_html__(
+			'There is no EE_Registration object in the data sent to the EE_Attendee Shortcode Parser for the messages system.',
+			'event_espresso'
+		);
+		$dev_msg = sprintf(
+			esc_html__('The transaction ID for this request is: %s', 'event_espresso'),
+			$txn_id
+		);
+		throw new EE_Error("$msg||$msg $dev_msg");
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.20.p
+	 */
+	private function getAttendee(EE_Registration $registration): EE_Attendee
+	{
+		$attendee = $registration->attendee();
+		if ($attendee instanceof EE_Attendee) {
+			return $attendee;
+		}
+		// attendee obj for this registration
+		if (
+			isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
+			&& $this->_extra->registrations[ $registration->ID() ]['att_obj'] instanceof EE_Attendee
+		) {
+			return $this->_extra->registrations[ $registration->ID() ]['att_obj'];
+		}
+
+		$msg     = esc_html__(
+			'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
+			'event_espresso'
+		);
+		$dev_msg = sprintf(
+			esc_html__('The registration ID for this request is: %s', 'event_espresso'),
+			$registration->ID()
+		);
+		throw new EE_Error("$msg||$msg $dev_msg");
+	}
 }

core/libraries/form_sections/strategies/display/EE_Select_Display_Strategy.strategy.php

Indentation +77 added lines, -77 removed lines

@@ -10,88 +10,88 @@
  */
 class EE_Select_Display_Strategy extends EE_Display_Strategy_Base
 {
-    /**
-     * @return string of html to display the field
-     * @throws EE_Error
-     */
-    public function display(): string
-    {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
-            throw new EE_Error(
-                esc_html__(
-                    'Cannot use Select Display Strategy with an input that doesn\'t have options',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * @return string of html to display the field
+	 * @throws EE_Error
+	 */
+	public function display(): string
+	{
+		if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(
+				esc_html__(
+					'Cannot use Select Display Strategy with an input that doesn\'t have options',
+					'event_espresso'
+				)
+			);
+		}
 
-        $html = EEH_HTML::nl(0, 'select');
-        $html .= '<select';
-        $html .= $this->_attributes_string(
-            $this->_standard_attributes_array()
-        );
-        $html .= $this->dataAttributesString($this->_input->dataAttributes());
-        $html .= '>';
+		$html = EEH_HTML::nl(0, 'select');
+		$html .= '<select';
+		$html .= $this->_attributes_string(
+			$this->_standard_attributes_array()
+		);
+		$html .= $this->dataAttributesString($this->_input->dataAttributes());
+		$html .= '>';
 
-        if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
-            EEH_HTML::indent(1, 'optgroup');
-            foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
-                }
-                EEH_HTML::indent(1, 'option');
-                $html .= $this->_display_options($opt_group);
-                EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
-                }
-            }
-            EEH_HTML::indent(-1, 'optgroup');
-        } else {
-            $html .= $this->_display_options($this->_input->options());
-        }
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			EEH_HTML::indent(1, 'optgroup');
+			foreach ($this->_input->options() as $opt_group_label => $opt_group) {
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+				}
+				EEH_HTML::indent(1, 'option');
+				$html .= $this->_display_options($opt_group);
+				EEH_HTML::indent(-1, 'option');
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+				}
+			}
+			EEH_HTML::indent(-1, 'optgroup');
+		} else {
+			$html .= $this->_display_options($this->_input->options());
+		}
 
-        $html .= EEH_HTML::nl(0, 'select') . '</select>';
-        return $html;
-    }
+		$html .= EEH_HTML::nl(0, 'select') . '</select>';
+		return $html;
+	}
 
 
-    /**
-     * Displays a flat list of options as option tags
-     *
-     * @param array $options
-     * @return string
-     */
-    protected function _display_options(array $options): string
-    {
-        $html = '';
-        EEH_HTML::indent(1, 'option');
-        foreach ($options as $value => $display_text) {
-            if (! $value && ! $display_text) {
-                $html = "<option></option>";
-                continue;
-            }
-            // even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
-            // PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
-            $value    = $this->_input->get_normalization_strategy()->unnormalize_one($value);
-            $selected = $this->_check_if_option_selected($value) ? ' selected' : '';
-            $value    = esc_attr($value);
-            $html     .= EEH_HTML::nl(0, 'option');
-            $html     .= "<option value=\"$value\"$selected>$display_text</option>";
-        }
-        EEH_HTML::indent(-1, 'option');
-        return $html;
-    }
+	/**
+	 * Displays a flat list of options as option tags
+	 *
+	 * @param array $options
+	 * @return string
+	 */
+	protected function _display_options(array $options): string
+	{
+		$html = '';
+		EEH_HTML::indent(1, 'option');
+		foreach ($options as $value => $display_text) {
+			if (! $value && ! $display_text) {
+				$html = "<option></option>";
+				continue;
+			}
+			// even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
+			// PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
+			$value    = $this->_input->get_normalization_strategy()->unnormalize_one($value);
+			$selected = $this->_check_if_option_selected($value) ? ' selected' : '';
+			$value    = esc_attr($value);
+			$html     .= EEH_HTML::nl(0, 'option');
+			$html     .= "<option value=\"$value\"$selected>$display_text</option>";
+		}
+		EEH_HTML::indent(-1, 'option');
+		return $html;
+	}
 
 
-    /**
-     * Checks if that value is the one selected
-     *
-     * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
-     * @return bool
-     */
-    protected function _check_if_option_selected($option_value): bool
-    {
-        return $option_value === $this->_input->raw_value();
-    }
+	/**
+	 * Checks if that value is the one selected
+	 *
+	 * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
+	 * @return bool
+	 */
+	protected function _check_if_option_selected($option_value): bool
+	{
+		return $option_value === $this->_input->raw_value();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -16,7 +16,7 @@ 
      */
     public function display(): string
     {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+        if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
             throw new EE_Error(
                 esc_html__(
                     'Cannot use Select Display Strategy with an input that doesn\'t have options',
@@ -36,14 +36,14 @@ 
         if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
             EEH_HTML::indent(1, 'optgroup');
             foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+                if ( ! empty($opt_group_label)) {
+                    $html .= EEH_HTML::nl(0, 'optgroup').'<optgroup label="'.esc_attr($opt_group_label).'">';
                 }
                 EEH_HTML::indent(1, 'option');
                 $html .= $this->_display_options($opt_group);
                 EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+                if ( ! empty($opt_group_label)) {
+                    $html .= EEH_HTML::nl(0, 'optgroup').'</optgroup>';
                 }
             }
             EEH_HTML::indent(-1, 'optgroup');
@@ -51,7 +51,7 @@ 
             $html .= $this->_display_options($this->_input->options());
         }
 
-        $html .= EEH_HTML::nl(0, 'select') . '</select>';
+        $html .= EEH_HTML::nl(0, 'select').'</select>';
         return $html;
     }
 
@@ -67,7 +67,7 @@ 
         $html = '';
         EEH_HTML::indent(1, 'option');
         foreach ($options as $value => $display_text) {
-            if (! $value && ! $display_text) {
+            if ( ! $value && ! $display_text) {
                 $html = "<option></option>";
                 continue;
             }

core/helpers/EEH_URL.helper.php

Indentation +270 added lines, -270 removed lines

@@ -13,302 +13,302 @@
  */
 class EEH_URL
 {
-    const CONTEXT_NONE   = 0;
+	const CONTEXT_NONE   = 0;
 
-    const CONTEXT_OUTPUT = 1;
+	const CONTEXT_OUTPUT = 1;
 
-    const CONTEXT_RAW    = 2;
+	const CONTEXT_RAW    = 2;
 
 
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *
-     * @param array  $args
-     * @param string $url
-     * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
-     * @param int    $context
-     * @return string
-     */
-    public static function add_query_args_and_nonce(
-        array $args = [],
-        string $url = '',
-        bool $exclude_nonce = false,
-        int $context = EEH_URL::CONTEXT_NONE
-    ): string {
-        // check that an action exists and add nonce
-        if (! $exclude_nonce) {
-            if (! empty($args['action'])) {
-                $args = array_merge(
-                    $args,
-                    [
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
-                    ]
-                );
-            } else {
-                $args = array_merge(
-                    $args,
-                    [
-                        'action'        => 'default',
-                        'default_nonce' => wp_create_nonce('default_nonce'),
-                    ]
-                );
-            }
-        }
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
+	 * @param int    $context
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce(
+		array $args = [],
+		string $url = '',
+		bool $exclude_nonce = false,
+		int $context = EEH_URL::CONTEXT_NONE
+	): string {
+		// check that an action exists and add nonce
+		if (! $exclude_nonce) {
+			if (! empty($args['action'])) {
+				$args = array_merge(
+					$args,
+					[
+						$args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
+					]
+				);
+			} else {
+				$args = array_merge(
+					$args,
+					[
+						'action'        => 'default',
+						'default_nonce' => wp_create_nonce('default_nonce'),
+					]
+				);
+			}
+		}
 
-        $action = EEH_URL::getRequest()->getRequestParam('action', '');
-        // finally, let's always add a return address (if present) :)
-        if ($action !== '') {
-            $args['return'] = $action;
-        }
+		$action = EEH_URL::getRequest()->getRequestParam('action', '');
+		// finally, let's always add a return address (if present) :)
+		if ($action !== '') {
+			$args['return'] = $action;
+		}
 
-        $url = add_query_arg($args, $url);
-        if ($context === EEH_URL::CONTEXT_OUTPUT) {
-            return esc_url($url);
-        }
-        if ($context === EEH_URL::CONTEXT_RAW) {
-            return esc_url_raw($url);
-        }
-        return $url;
-    }
+		$url = add_query_arg($args, $url);
+		if ($context === EEH_URL::CONTEXT_OUTPUT) {
+			return esc_url($url);
+		}
+		if ($context === EEH_URL::CONTEXT_RAW) {
+			return esc_url_raw($url);
+		}
+		return $url;
+	}
 
 
-    /**
-     * Returns whether not the remote file exists.
-     * Checking via GET because HEAD requests are blocked on some server configurations.
-     *
-     * @param string $url
-     * @param array  $args the arguments that should be passed through to the wp_remote_request call.
-     * @return boolean
-     */
-    public static function remote_file_exists(string $url, array $args = []): bool
-    {
-        $results = wp_remote_request(
-            $url,
-            array_merge(
-                [
-                    'method'      => 'GET',
-                    'redirection' => 1,
-                ],
-                $args
-            )
-        );
-        return ! $results instanceof WP_Error
-            && isset($results['response']['code'])
-            && $results['response']['code'] == '200';
-    }
+	/**
+	 * Returns whether not the remote file exists.
+	 * Checking via GET because HEAD requests are blocked on some server configurations.
+	 *
+	 * @param string $url
+	 * @param array  $args the arguments that should be passed through to the wp_remote_request call.
+	 * @return boolean
+	 */
+	public static function remote_file_exists(string $url, array $args = []): bool
+	{
+		$results = wp_remote_request(
+			$url,
+			array_merge(
+				[
+					'method'      => 'GET',
+					'redirection' => 1,
+				],
+				$args
+			)
+		);
+		return ! $results instanceof WP_Error
+			&& isset($results['response']['code'])
+			&& $results['response']['code'] == '200';
+	}
 
 
-    /**
-     * refactor_url
-     * primarily used for removing the query string from a URL
-     *
-     * @param string $url
-     * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
-     * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
-     * @return string
-     */
-    public static function refactor_url(
-        string $url = '',
-        bool $remove_query = true,
-        bool $base_url_only = false
-    ): string {
-        // break apart incoming URL
-        $url_bits = parse_url($url);
-        // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'https://';
-        // domain
-        $host = $url_bits['host'] ?? '';
-        // if only the base URL is requested, then return that now
-        if ($base_url_only) {
-            return $scheme . $host;
-        }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
-        $user = $url_bits['user'] ?? '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
-        $path = $url_bits['path'] ?? '';
-        // if the query string is not required, then return what we have so far
-        if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
-        }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
-    }
+	/**
+	 * refactor_url
+	 * primarily used for removing the query string from a URL
+	 *
+	 * @param string $url
+	 * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
+	 * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
+	 * @return string
+	 */
+	public static function refactor_url(
+		string $url = '',
+		bool $remove_query = true,
+		bool $base_url_only = false
+	): string {
+		// break apart incoming URL
+		$url_bits = parse_url($url);
+		// HTTP or HTTPS ?
+		$scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'https://';
+		// domain
+		$host = $url_bits['host'] ?? '';
+		// if only the base URL is requested, then return that now
+		if ($base_url_only) {
+			return $scheme . $host;
+		}
+		$port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+		$user = $url_bits['user'] ?? '';
+		$pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
+		$pass = ($user || $pass) ? $pass . '@' : '';
+		$path = $url_bits['path'] ?? '';
+		// if the query string is not required, then return what we have so far
+		if ($remove_query) {
+			return $scheme . $user . $pass . $host . $port . $path;
+		}
+		$query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
+		$fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
+		return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+	}
 
 
-    /**
-     * get_query_string
-     * returns just the query string from a URL, formatted by default into an array of key value pairs
-     *
-     * @param string $url
-     * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
-     *                         simply return the query string
-     * @return string|array
-     */
-    public static function get_query_string(string $url = '', bool $as_array = true)
-    {
-        // decode, then break apart incoming URL
-        $url_bits = parse_url(html_entity_decode($url));
-        // grab query string from URL
-        $query = $url_bits['query'] ?? '';
-        // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
-            return $query;
-        }
-        // if no query string exists then just return an empty array now
-        if (empty($query)) {
-            return [];
-        }
-        // empty array to hold results
-        $query_params = [];
-        // now break apart the query string into separate params
-        $query = explode('&', $query);
-        // loop thru our query params
-        foreach ($query as $query_args) {
-            // break apart the key value pairs
-            $query_args = explode('=', $query_args);
-            if ($query_args) {
-                // and add to our results array
-                $query_params[ $query_args[0] ] = $query_args[1];
-            }
-        }
-        return $query_params;
-    }
+	/**
+	 * get_query_string
+	 * returns just the query string from a URL, formatted by default into an array of key value pairs
+	 *
+	 * @param string $url
+	 * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
+	 *                         simply return the query string
+	 * @return string|array
+	 */
+	public static function get_query_string(string $url = '', bool $as_array = true)
+	{
+		// decode, then break apart incoming URL
+		$url_bits = parse_url(html_entity_decode($url));
+		// grab query string from URL
+		$query = $url_bits['query'] ?? '';
+		// if we don't want the query string formatted into an array of key => value pairs, then just return it as is
+		if (! $as_array) {
+			return $query;
+		}
+		// if no query string exists then just return an empty array now
+		if (empty($query)) {
+			return [];
+		}
+		// empty array to hold results
+		$query_params = [];
+		// now break apart the query string into separate params
+		$query = explode('&', $query);
+		// loop thru our query params
+		foreach ($query as $query_args) {
+			// break apart the key value pairs
+			$query_args = explode('=', $query_args);
+			if ($query_args) {
+				// and add to our results array
+				$query_params[ $query_args[0] ] = $query_args[1];
+			}
+		}
+		return $query_params;
+	}
 
 
-    /**
-     * prevent_prefetching
-     *
-     * @return void
-     */
-    public static function prevent_prefetching()
-    {
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
-        // with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
+	/**
+	 * prevent_prefetching
+	 *
+	 * @return void
+	 */
+	public static function prevent_prefetching()
+	{
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
+		// with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
 
 
-    /**
-     * This generates a unique site-specific string.
-     * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
-     * urls.
-     *
-     * @param string $prefix Use this to prefix the string with something.
-     * @return string
-     */
-    public static function generate_unique_token(string $prefix = ''): string
-    {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
-    }
+	/**
+	 * This generates a unique site-specific string.
+	 * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
+	 * urls.
+	 *
+	 * @param string $prefix Use this to prefix the string with something.
+	 * @return string
+	 */
+	public static function generate_unique_token(string $prefix = ''): string
+	{
+		$token = md5(uniqid() . mt_rand());
+		return $prefix ? $prefix . '_' . $token : $token;
+	}
 
 
-    /**
-     * filter_input_server_url
-     * uses filter_input() to sanitize one of the INPUT_SERVER URL values
-     * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
-     *
-     * @param string $server_variable
-     * @return string
-     */
-    public static function filter_input_server_url(string $server_variable = 'REQUEST_URI'): string
-    {
-        $URL              = '';
-        $server_variables = [
-            'REQUEST_URI' => 1,
-            'HTTP_HOST'   => 1,
-            'PHP_SELF'    => 1,
-        ];
-        $server_variable  = strtoupper($server_variable);
-        // whitelist INPUT_SERVER var
-        if (isset($server_variables[ $server_variable ])) {
-            $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
-            if (empty($URL) || $URL !== $_SERVER[ $server_variable ]) {
-                // fallback sanitization if the above fails or URL has changed after filtering
-                $URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
-            }
-        }
-        return $URL;
-    }
+	/**
+	 * filter_input_server_url
+	 * uses filter_input() to sanitize one of the INPUT_SERVER URL values
+	 * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
+	 *
+	 * @param string $server_variable
+	 * @return string
+	 */
+	public static function filter_input_server_url(string $server_variable = 'REQUEST_URI'): string
+	{
+		$URL              = '';
+		$server_variables = [
+			'REQUEST_URI' => 1,
+			'HTTP_HOST'   => 1,
+			'PHP_SELF'    => 1,
+		];
+		$server_variable  = strtoupper($server_variable);
+		// whitelist INPUT_SERVER var
+		if (isset($server_variables[ $server_variable ])) {
+			$URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
+			if (empty($URL) || $URL !== $_SERVER[ $server_variable ]) {
+				// fallback sanitization if the above fails or URL has changed after filtering
+				$URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
+			}
+		}
+		return $URL;
+	}
 
 
-    /**
-     * Gets the current page's full URL.
-     *
-     * @return string
-     */
-    public static function current_url(): string
-    {
-        $url = '';
-        if (
-            EEH_URL::getRequest()->serverParamIsSet('HTTP_HOST')
-            && EEH_URL::getRequest()->serverParamIsSet('REQUEST_URI')
-        ) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= EEH_URL::filter_input_server_url();
-        }
-        return $url;
-    }
+	/**
+	 * Gets the current page's full URL.
+	 *
+	 * @return string
+	 */
+	public static function current_url(): string
+	{
+		$url = '';
+		if (
+			EEH_URL::getRequest()->serverParamIsSet('HTTP_HOST')
+			&& EEH_URL::getRequest()->serverParamIsSet('REQUEST_URI')
+		) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= EEH_URL::filter_input_server_url();
+		}
+		return $url;
+	}
 
 
-    /**
-     * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
-     *
-     * @param array $query_parameters An array of query_parameters to remove from the current url.
-     * @return string
-     * @since 4.9.46.rc.029
-     */
-    public static function current_url_without_query_paramaters(array $query_parameters): string
-    {
-        return remove_query_arg($query_parameters, EEH_URL::current_url());
-    }
+	/**
+	 * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
+	 *
+	 * @param array $query_parameters An array of query_parameters to remove from the current url.
+	 * @return string
+	 * @since 4.9.46.rc.029
+	 */
+	public static function current_url_without_query_paramaters(array $query_parameters): string
+	{
+		return remove_query_arg($query_parameters, EEH_URL::current_url());
+	}
 
 
-    /**
-     * @param string $location
-     * @param int    $status
-     * @param string $exit_notice
-     */
-    public static function safeRedirectAndExit(string $location, int $status = 302, string $exit_notice = '')
-    {
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect($location, $status);
-        exit($exit_notice);
-    }
+	/**
+	 * @param string $location
+	 * @param int    $status
+	 * @param string $exit_notice
+	 */
+	public static function safeRedirectAndExit(string $location, int $status = 302, string $exit_notice = '')
+	{
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect($location, $status);
+		exit($exit_notice);
+	}
 
 
-    /**
-     * Slugifies text for usage in a URL.
-     * Currently, this isn't just calling `sanitize_title()` on it, because that percent-encodes unicode characters,
-     * and WordPress chokes on them when used as CPT and custom taxonomy slugs.
-     *
-     * @param string $text
-     * @param string $fallback
-     * @return string which can be used in a URL
-     * @since 4.9.66.p
-     */
-    public static function slugify(string $text, string $fallback): string
-    {
-        // url decode after sanitizing title to restore unicode characters,
-        // see https://github.com/eventespresso/event-espresso-core/issues/575
-        return urldecode(sanitize_title($text, $fallback));
-    }
+	/**
+	 * Slugifies text for usage in a URL.
+	 * Currently, this isn't just calling `sanitize_title()` on it, because that percent-encodes unicode characters,
+	 * and WordPress chokes on them when used as CPT and custom taxonomy slugs.
+	 *
+	 * @param string $text
+	 * @param string $fallback
+	 * @return string which can be used in a URL
+	 * @since 4.9.66.p
+	 */
+	public static function slugify(string $text, string $fallback): string
+	{
+		// url decode after sanitizing title to restore unicode characters,
+		// see https://github.com/eventespresso/event-espresso-core/issues/575
+		return urldecode(sanitize_title($text, $fallback));
+	}
 
 
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    protected static function getRequest(): RequestInterface
-    {
-        static $request;
-        if (! $request instanceof RequestInterface) {
-            $request = LoaderFactory::getShared(RequestInterface::class);
-        }
-        return $request;
-    }
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	protected static function getRequest(): RequestInterface
+	{
+		static $request;
+		if (! $request instanceof RequestInterface) {
+			$request = LoaderFactory::getShared(RequestInterface::class);
+		}
+		return $request;
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -37,12 +37,12 @@ 
         int $context = EEH_URL::CONTEXT_NONE
     ): string {
         // check that an action exists and add nonce
-        if (! $exclude_nonce) {
-            if (! empty($args['action'])) {
+        if ( ! $exclude_nonce) {
+            if ( ! empty($args['action'])) {
                 $args = array_merge(
                     $args,
                     [
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
+                        $args['action'].'_nonce' => wp_create_nonce($args['action'].'_nonce'),
                     ]
                 );
             } else {
@@ -116,25 +116,25 @@ 
         // break apart incoming URL
         $url_bits = parse_url($url);
         // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'https://';
+        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'].'://' : 'https://';
         // domain
         $host = $url_bits['host'] ?? '';
         // if only the base URL is requested, then return that now
         if ($base_url_only) {
-            return $scheme . $host;
+            return $scheme.$host;
         }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+        $port = isset($url_bits['port']) ? ':'.$url_bits['port'] : '';
         $user = $url_bits['user'] ?? '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
+        $pass = isset($url_bits['pass']) ? ':'.$url_bits['pass'] : '';
+        $pass = ($user || $pass) ? $pass.'@' : '';
         $path = $url_bits['path'] ?? '';
         // if the query string is not required, then return what we have so far
         if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
+            return $scheme.$user.$pass.$host.$port.$path;
         }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+        $query    = isset($url_bits['query']) ? '?'.$url_bits['query'] : '';
+        $fragment = isset($url_bits['fragment']) ? '#'.$url_bits['fragment'] : '';
+        return $scheme.$user.$pass.$host.$port.$path.$query.$fragment;
     }
 
 
@@ -154,7 +154,7 @@ 
         // grab query string from URL
         $query = $url_bits['query'] ?? '';
         // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
+        if ( ! $as_array) {
             return $query;
         }
         // if no query string exists then just return an empty array now
@@ -171,7 +171,7 @@ 
             $query_args = explode('=', $query_args);
             if ($query_args) {
                 // and add to our results array
-                $query_params[ $query_args[0] ] = $query_args[1];
+                $query_params[$query_args[0]] = $query_args[1];
             }
         }
         return $query_params;
@@ -201,8 +201,8 @@ 
      */
     public static function generate_unique_token(string $prefix = ''): string
     {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
+        $token = md5(uniqid().mt_rand());
+        return $prefix ? $prefix.'_'.$token : $token;
     }
 
 
@@ -222,13 +222,13 @@ 
             'HTTP_HOST'   => 1,
             'PHP_SELF'    => 1,
         ];
-        $server_variable  = strtoupper($server_variable);
+        $server_variable = strtoupper($server_variable);
         // whitelist INPUT_SERVER var
-        if (isset($server_variables[ $server_variable ])) {
+        if (isset($server_variables[$server_variable])) {
             $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
-            if (empty($URL) || $URL !== $_SERVER[ $server_variable ]) {
+            if (empty($URL) || $URL !== $_SERVER[$server_variable]) {
                 // fallback sanitization if the above fails or URL has changed after filtering
-                $URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
+                $URL = wp_sanitize_redirect($_SERVER[$server_variable]);
             }
         }
         return $URL;
@@ -306,7 +306,7 @@ 
     protected static function getRequest(): RequestInterface
     {
         static $request;
-        if (! $request instanceof RequestInterface) {
+        if ( ! $request instanceof RequestInterface) {
             $request = LoaderFactory::getShared(RequestInterface::class);
         }
         return $request;