eventespresso / event-espresso-core

core/domain/services/cron/jobs/ExpiredTransactionCheck.php

Indentation +248 added lines, -248 removed lines

@@ -17,252 +17,252 @@
 
 class ExpiredTransactionCheck extends CronJob
 {
-    private ?PaymentProcessor $payment_processor = null;
-
-    private ?EE_Transaction_Processor $transaction_processor = null;
-
-    /**
-     * array of TXN IDs
-     *
-     * @var array
-     */
-    protected array $expired_transactions = [];
-
-
-    private function loadTransactionProcessor()
-    {
-        $this->transaction_processor = $this->loader->getShared(EE_Transaction_Processor::class);
-    }
-
-
-    private function loadPaymentProcessor()
-    {
-        $this->payment_processor = $this->loader->getShared(PaymentProcessor::class);
-    }
-
-
-    public function setHooks(): void
-    {
-        add_action(
-            'AHEE__EE_Cron_Tasks__expired_transaction_check',
-            [$this, 'expiredTransactionCheck']
-        );
-    }
-
-
-    /**
-     * schedule_expired_transaction_check
-     * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function scheduleExpiredTransactionCheck(
-        int $timestamp,
-        int $TXN_ID
-    ): void {
-        // validate $TXN_ID and $timestamp
-        $TXN_ID    = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__expired_transaction_check',
-                [$TXN_ID]
-            );
-        }
-    }
-
-
-    /**
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
-     * which is utilized by wp_schedule_single_event()
-     * in \EED_Single_Page_Checkout::_initialize_transaction().
-     * The passed TXN_ID gets added to an array, and then the
-     * process_expired_transactions() function is hooked into
-     * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
-     * processing of any failed transactions, because doing so now would be
-     * too early and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     */
-    public function expiredTransactionCheck(int $TXN_ID = 0): void
-    {
-        if (absint($TXN_ID)) {
-            $this->expired_transactions[ $TXN_ID ] = $TXN_ID;
-            add_action(
-                'shutdown',
-                [$this, 'processExpiredTransactions'],
-                5
-            );
-        }
-    }
-
-
-    /**
-     * loops through the $this->expired_transactions array and processes any failed TXNs
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws DomainException
-     * @throws RuntimeException
-     */
-    public function processExpiredTransactions(): void
-    {
-        if (
-            // are there any TXNs that need cleaning up ?
-            empty($this->expired_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || CronUtilities::rescheduleCronForTransactions(
-                [ExpiredTransactionCheck::class, 'scheduleExpiredTransactionCheck'],
-                $this->expired_transactions
-            )
-        ) {
-            return;
-        }
-        $this->loadTransactionProcessor();
-        // set revisit flag for txn processor
-        $this->transaction_processor->set_revisit();
-        foreach ($this->expired_transactions as $TXN_ID) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            // verify transaction and whether it is failed or not
-            if ($transaction instanceof EE_Transaction) {
-                switch ($transaction->status_ID()) {
-
-                    case EEM_Transaction::complete_status_code:
-                        $this->processCompletedTransaction($transaction);
-                        break;
-
-                    case EEM_Transaction::overpaid_status_code:
-                        $this->processOverpaidTransaction($transaction);
-                        break;
-
-                    case EEM_Transaction::incomplete_status_code:
-                        $this->processIncompletedTransaction($transaction);
-                        break;
-
-                    case EEM_Transaction::abandoned_status_code:
-                        $this->processAbandonedTransaction($transaction);
-                        break;
-
-                    case EEM_Transaction::failed_status_code:
-                        $this->processFailedTransaction($transaction);
-                        break;
-                }
-            }
-            unset($this->expired_transactions[ $TXN_ID ]);
-        }
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processCompletedTransaction(EE_Transaction $transaction)
-    {
-        // Don't update the transaction/registrations if the Primary Registration is Not Approved.
-        $primary_registration = $transaction->primary_registration();
-        if (
-            $primary_registration instanceof EE_Registration
-            && $primary_registration->status_ID() !== RegStatus::AWAITING_REVIEW
-        ) {
-            $this->transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                $transaction,
-                $transaction->last_payment()
-            );
-            do_action(
-                'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
-                $transaction
-            );
-        }
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return void
-     */
-    private function processOverpaidTransaction(EE_Transaction $transaction)
-    {
-        do_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
-            $transaction
-        );
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return void
-     */
-    private function processIncompletedTransaction(EE_Transaction $transaction)
-    {
-        do_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-            $transaction
-        );
-        // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processAbandonedTransaction(EE_Transaction $transaction)
-    {
-        // run hook before updating transaction, primarily so
-        // EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
-        do_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-            $transaction
-        );
-        // don't finalize the TXN if it has already been completed
-        if ($transaction->all_reg_steps_completed() !== true) {
-            $this->loadPaymentProcessor();
-            // let's simulate an IPN here which will trigger any notifications that need to go out
-            $this->payment_processor->updateTransactionBasedOnPayment(
-                $transaction,
-                $transaction->last_payment(),
-                true,
-                true
-            );
-        }
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return void
-     */
-    private function processFailedTransaction(EE_Transaction $transaction)
-    {
-        do_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-            $transaction
-        );
-        // todo :
-        // perform garbage collection here and remove clean_out_junk_transactions()
-        // $registrations = $transaction->registrations();
-        // if (! empty($registrations)) {
-        //     foreach ($registrations as $registration) {
-        //         if ($registration instanceof EE_Registration) {
-        //             $delete_registration = true;
-        //             if ($registration->attendee() instanceof EE_Attendee) {
-        //                 $delete_registration = false;
-        //             }
-        //             if ($delete_registration) {
-        //                 $registration->delete_permanently();
-        //                 $registration->delete_related_permanently();
-        //             }
-        //         }
-        //     }
-        // }
-    }
+	private ?PaymentProcessor $payment_processor = null;
+
+	private ?EE_Transaction_Processor $transaction_processor = null;
+
+	/**
+	 * array of TXN IDs
+	 *
+	 * @var array
+	 */
+	protected array $expired_transactions = [];
+
+
+	private function loadTransactionProcessor()
+	{
+		$this->transaction_processor = $this->loader->getShared(EE_Transaction_Processor::class);
+	}
+
+
+	private function loadPaymentProcessor()
+	{
+		$this->payment_processor = $this->loader->getShared(PaymentProcessor::class);
+	}
+
+
+	public function setHooks(): void
+	{
+		add_action(
+			'AHEE__EE_Cron_Tasks__expired_transaction_check',
+			[$this, 'expiredTransactionCheck']
+		);
+	}
+
+
+	/**
+	 * schedule_expired_transaction_check
+	 * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function scheduleExpiredTransactionCheck(
+		int $timestamp,
+		int $TXN_ID
+	): void {
+		// validate $TXN_ID and $timestamp
+		$TXN_ID    = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__expired_transaction_check',
+				[$TXN_ID]
+			);
+		}
+	}
+
+
+	/**
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
+	 * which is utilized by wp_schedule_single_event()
+	 * in \EED_Single_Page_Checkout::_initialize_transaction().
+	 * The passed TXN_ID gets added to an array, and then the
+	 * process_expired_transactions() function is hooked into
+	 * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
+	 * processing of any failed transactions, because doing so now would be
+	 * too early and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 */
+	public function expiredTransactionCheck(int $TXN_ID = 0): void
+	{
+		if (absint($TXN_ID)) {
+			$this->expired_transactions[ $TXN_ID ] = $TXN_ID;
+			add_action(
+				'shutdown',
+				[$this, 'processExpiredTransactions'],
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * loops through the $this->expired_transactions array and processes any failed TXNs
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws DomainException
+	 * @throws RuntimeException
+	 */
+	public function processExpiredTransactions(): void
+	{
+		if (
+			// are there any TXNs that need cleaning up ?
+			empty($this->expired_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| CronUtilities::rescheduleCronForTransactions(
+				[ExpiredTransactionCheck::class, 'scheduleExpiredTransactionCheck'],
+				$this->expired_transactions
+			)
+		) {
+			return;
+		}
+		$this->loadTransactionProcessor();
+		// set revisit flag for txn processor
+		$this->transaction_processor->set_revisit();
+		foreach ($this->expired_transactions as $TXN_ID) {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			// verify transaction and whether it is failed or not
+			if ($transaction instanceof EE_Transaction) {
+				switch ($transaction->status_ID()) {
+
+					case EEM_Transaction::complete_status_code:
+						$this->processCompletedTransaction($transaction);
+						break;
+
+					case EEM_Transaction::overpaid_status_code:
+						$this->processOverpaidTransaction($transaction);
+						break;
+
+					case EEM_Transaction::incomplete_status_code:
+						$this->processIncompletedTransaction($transaction);
+						break;
+
+					case EEM_Transaction::abandoned_status_code:
+						$this->processAbandonedTransaction($transaction);
+						break;
+
+					case EEM_Transaction::failed_status_code:
+						$this->processFailedTransaction($transaction);
+						break;
+				}
+			}
+			unset($this->expired_transactions[ $TXN_ID ]);
+		}
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processCompletedTransaction(EE_Transaction $transaction)
+	{
+		// Don't update the transaction/registrations if the Primary Registration is Not Approved.
+		$primary_registration = $transaction->primary_registration();
+		if (
+			$primary_registration instanceof EE_Registration
+			&& $primary_registration->status_ID() !== RegStatus::AWAITING_REVIEW
+		) {
+			$this->transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+				$transaction,
+				$transaction->last_payment()
+			);
+			do_action(
+				'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
+				$transaction
+			);
+		}
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 */
+	private function processOverpaidTransaction(EE_Transaction $transaction)
+	{
+		do_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
+			$transaction
+		);
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 */
+	private function processIncompletedTransaction(EE_Transaction $transaction)
+	{
+		do_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+			$transaction
+		);
+		// todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processAbandonedTransaction(EE_Transaction $transaction)
+	{
+		// run hook before updating transaction, primarily so
+		// EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
+		do_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+			$transaction
+		);
+		// don't finalize the TXN if it has already been completed
+		if ($transaction->all_reg_steps_completed() !== true) {
+			$this->loadPaymentProcessor();
+			// let's simulate an IPN here which will trigger any notifications that need to go out
+			$this->payment_processor->updateTransactionBasedOnPayment(
+				$transaction,
+				$transaction->last_payment(),
+				true,
+				true
+			);
+		}
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 */
+	private function processFailedTransaction(EE_Transaction $transaction)
+	{
+		do_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+			$transaction
+		);
+		// todo :
+		// perform garbage collection here and remove clean_out_junk_transactions()
+		// $registrations = $transaction->registrations();
+		// if (! empty($registrations)) {
+		//     foreach ($registrations as $registration) {
+		//         if ($registration instanceof EE_Registration) {
+		//             $delete_registration = true;
+		//             if ($registration->attendee() instanceof EE_Attendee) {
+		//                 $delete_registration = false;
+		//             }
+		//             if ($delete_registration) {
+		//                 $registration->delete_permanently();
+		//                 $registration->delete_related_permanently();
+		//             }
+		//         }
+		//     }
+		// }
+	}
 }

core/domain/DomainBase.php

Indentation +227 added lines, -227 removed lines

@@ -16,231 +16,231 @@
  */
 abstract class DomainBase implements DomainInterface
 {
-    const ASSETS_FOLDER = 'assets/';
-
-    /**
-     * Equivalent to `__FILE__` for main plugin file.
-     *
-     * @var FilePath
-     */
-    private FilePath $plugin_file;
-
-    /**
-     * String indicating version for plugin
-     *
-     * @var Version
-     */
-    private Version $version;
-
-    /**
-     * @var string $plugin_basename
-     */
-    private string $plugin_basename = '';
-
-    /**
-     * @var string $plugin_path
-     */
-    private string $plugin_path = '';
-
-    /**
-     * @var string $plugin_url
-     */
-    private string $plugin_url = '';
-
-    /**
-     * @var string $asset_namespace
-     */
-    private string $asset_namespace = '';
-
-    /**
-     * @var string $assets_path
-     */
-    private string $assets_path = '';
-
-    /**
-     * @var bool
-     */
-    protected bool $initialized = false;
-
-
-    /**
-     * Initializes internal properties.
-     *
-     * @param FilePath $plugin_file
-     * @param Version  $version
-     * @param string   $asset_namespace
-     */
-    public function __construct(
-        FilePath $plugin_file,
-        Version $version,
-        string $asset_namespace = Domain::ASSET_NAMESPACE
-    ) {
-        $this->plugin_file = $plugin_file;
-        $this->version     = $version;
-        $this->initialize($asset_namespace);
-    }
-
-
-    /**
-     * @param string $asset_namespace
-     * @return void
-     * @since 5.0.0.p
-     */
-    public function initialize(string $asset_namespace = Domain::ASSET_NAMESPACE)
-    {
-        if (! $this->initialized) {
-            $this->plugin_basename = plugin_basename($this->pluginFile());
-            $this->plugin_path     = plugin_dir_path($this->pluginFile());
-            $this->plugin_url      = plugin_dir_url($this->pluginFile());
-            $this->setAssetNamespace($asset_namespace);
-            $this->setDistributionAssetsPath();
-            $this->initialized = true;
-        }
-    }
-
-
-    /**
-     * @param string $asset_namespace
-     * @return void
-     */
-    public function setAssetNamespace(string $asset_namespace = Domain::ASSET_NAMESPACE)
-    {
-        if (! $this->asset_namespace) {
-            $this->asset_namespace = sanitize_key(
-            // convert directory separators to dashes and remove file extension
-                str_replace(['/', '.php'], ['-', ''], $asset_namespace)
-            );
-        }
-    }
-
-
-    /**
-     * @throws DomainException
-     * @since 5.0.0.p
-     */
-    private function setDistributionAssetsPath()
-    {
-        $assets_folder_paths = [
-            $this->plugin_path . DomainBase::ASSETS_FOLDER,
-            $this->plugin_path . 'src/' . DomainBase::ASSETS_FOLDER,
-        ];
-        foreach ($assets_folder_paths as $assets_folder_path) {
-            if (is_readable($assets_folder_path)) {
-                $this->assets_path = trailingslashit($assets_folder_path);
-                // once we find a valid path, just break out of loop
-                break;
-            }
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function pluginFile(): string
-    {
-        return (string) $this->plugin_file;
-    }
-
-
-    /**
-     * @return FilePath
-     */
-    public function pluginFileObject(): FilePath
-    {
-        return $this->plugin_file;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function pluginBasename(): string
-    {
-        return $this->plugin_basename;
-    }
-
-
-    /**
-     * @param string $additional_path
-     * @return string
-     */
-    public function pluginPath(string $additional_path = ''): string
-    {
-        return is_string($additional_path) && $additional_path !== ''
-            ? $this->plugin_path . $additional_path
-            : $this->plugin_path;
-    }
-
-
-    /**
-     * @param string $additional_path
-     * @return string
-     */
-    public function pluginUrl(string $additional_path = ''): string
-    {
-        return is_string($additional_path) && $additional_path !== ''
-            ? $this->plugin_url . $additional_path
-            : $this->plugin_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function version(): string
-    {
-        return (string) $this->version;
-    }
-
-
-    /**
-     * @return Version
-     */
-    public function versionValueObject(): Version
-    {
-        return $this->version;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsFolder(): string
-    {
-        return DomainBase::ASSETS_FOLDER;
-    }
-
-
-    /**
-     * @param string $additional_path
-     * @return string
-     */
-    public function distributionAssetsPath(string $additional_path = ''): string
-    {
-        return is_string($additional_path) && $additional_path !== ''
-            ? $this->assets_path . $additional_path
-            : $this->assets_path;
-    }
-
-
-    /**
-     * @param string $additional_path
-     * @return string
-     */
-    public function distributionAssetsUrl(string $additional_path = ''): string
-    {
-        return is_string($additional_path) && $additional_path !== ''
-            ? $this->plugin_url . DomainBase::ASSETS_FOLDER . $additional_path
-            : $this->plugin_url . DomainBase::ASSETS_FOLDER;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function assetNamespace(): string
-    {
-        return $this->asset_namespace;
-    }
+	const ASSETS_FOLDER = 'assets/';
+
+	/**
+	 * Equivalent to `__FILE__` for main plugin file.
+	 *
+	 * @var FilePath
+	 */
+	private FilePath $plugin_file;
+
+	/**
+	 * String indicating version for plugin
+	 *
+	 * @var Version
+	 */
+	private Version $version;
+
+	/**
+	 * @var string $plugin_basename
+	 */
+	private string $plugin_basename = '';
+
+	/**
+	 * @var string $plugin_path
+	 */
+	private string $plugin_path = '';
+
+	/**
+	 * @var string $plugin_url
+	 */
+	private string $plugin_url = '';
+
+	/**
+	 * @var string $asset_namespace
+	 */
+	private string $asset_namespace = '';
+
+	/**
+	 * @var string $assets_path
+	 */
+	private string $assets_path = '';
+
+	/**
+	 * @var bool
+	 */
+	protected bool $initialized = false;
+
+
+	/**
+	 * Initializes internal properties.
+	 *
+	 * @param FilePath $plugin_file
+	 * @param Version  $version
+	 * @param string   $asset_namespace
+	 */
+	public function __construct(
+		FilePath $plugin_file,
+		Version $version,
+		string $asset_namespace = Domain::ASSET_NAMESPACE
+	) {
+		$this->plugin_file = $plugin_file;
+		$this->version     = $version;
+		$this->initialize($asset_namespace);
+	}
+
+
+	/**
+	 * @param string $asset_namespace
+	 * @return void
+	 * @since 5.0.0.p
+	 */
+	public function initialize(string $asset_namespace = Domain::ASSET_NAMESPACE)
+	{
+		if (! $this->initialized) {
+			$this->plugin_basename = plugin_basename($this->pluginFile());
+			$this->plugin_path     = plugin_dir_path($this->pluginFile());
+			$this->plugin_url      = plugin_dir_url($this->pluginFile());
+			$this->setAssetNamespace($asset_namespace);
+			$this->setDistributionAssetsPath();
+			$this->initialized = true;
+		}
+	}
+
+
+	/**
+	 * @param string $asset_namespace
+	 * @return void
+	 */
+	public function setAssetNamespace(string $asset_namespace = Domain::ASSET_NAMESPACE)
+	{
+		if (! $this->asset_namespace) {
+			$this->asset_namespace = sanitize_key(
+			// convert directory separators to dashes and remove file extension
+				str_replace(['/', '.php'], ['-', ''], $asset_namespace)
+			);
+		}
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @since 5.0.0.p
+	 */
+	private function setDistributionAssetsPath()
+	{
+		$assets_folder_paths = [
+			$this->plugin_path . DomainBase::ASSETS_FOLDER,
+			$this->plugin_path . 'src/' . DomainBase::ASSETS_FOLDER,
+		];
+		foreach ($assets_folder_paths as $assets_folder_path) {
+			if (is_readable($assets_folder_path)) {
+				$this->assets_path = trailingslashit($assets_folder_path);
+				// once we find a valid path, just break out of loop
+				break;
+			}
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginFile(): string
+	{
+		return (string) $this->plugin_file;
+	}
+
+
+	/**
+	 * @return FilePath
+	 */
+	public function pluginFileObject(): FilePath
+	{
+		return $this->plugin_file;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginBasename(): string
+	{
+		return $this->plugin_basename;
+	}
+
+
+	/**
+	 * @param string $additional_path
+	 * @return string
+	 */
+	public function pluginPath(string $additional_path = ''): string
+	{
+		return is_string($additional_path) && $additional_path !== ''
+			? $this->plugin_path . $additional_path
+			: $this->plugin_path;
+	}
+
+
+	/**
+	 * @param string $additional_path
+	 * @return string
+	 */
+	public function pluginUrl(string $additional_path = ''): string
+	{
+		return is_string($additional_path) && $additional_path !== ''
+			? $this->plugin_url . $additional_path
+			: $this->plugin_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function version(): string
+	{
+		return (string) $this->version;
+	}
+
+
+	/**
+	 * @return Version
+	 */
+	public function versionValueObject(): Version
+	{
+		return $this->version;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsFolder(): string
+	{
+		return DomainBase::ASSETS_FOLDER;
+	}
+
+
+	/**
+	 * @param string $additional_path
+	 * @return string
+	 */
+	public function distributionAssetsPath(string $additional_path = ''): string
+	{
+		return is_string($additional_path) && $additional_path !== ''
+			? $this->assets_path . $additional_path
+			: $this->assets_path;
+	}
+
+
+	/**
+	 * @param string $additional_path
+	 * @return string
+	 */
+	public function distributionAssetsUrl(string $additional_path = ''): string
+	{
+		return is_string($additional_path) && $additional_path !== ''
+			? $this->plugin_url . DomainBase::ASSETS_FOLDER . $additional_path
+			: $this->plugin_url . DomainBase::ASSETS_FOLDER;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function assetNamespace(): string
+	{
+		return $this->asset_namespace;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -88,7 +88,7 @@ 
      */
     public function initialize(string $asset_namespace = Domain::ASSET_NAMESPACE)
     {
-        if (! $this->initialized) {
+        if ( ! $this->initialized) {
             $this->plugin_basename = plugin_basename($this->pluginFile());
             $this->plugin_path     = plugin_dir_path($this->pluginFile());
             $this->plugin_url      = plugin_dir_url($this->pluginFile());
@@ -105,7 +105,7 @@ 
      */
     public function setAssetNamespace(string $asset_namespace = Domain::ASSET_NAMESPACE)
     {
-        if (! $this->asset_namespace) {
+        if ( ! $this->asset_namespace) {
             $this->asset_namespace = sanitize_key(
             // convert directory separators to dashes and remove file extension
                 str_replace(['/', '.php'], ['-', ''], $asset_namespace)
@@ -121,8 +121,8 @@ 
     private function setDistributionAssetsPath()
     {
         $assets_folder_paths = [
-            $this->plugin_path . DomainBase::ASSETS_FOLDER,
-            $this->plugin_path . 'src/' . DomainBase::ASSETS_FOLDER,
+            $this->plugin_path.DomainBase::ASSETS_FOLDER,
+            $this->plugin_path.'src/'.DomainBase::ASSETS_FOLDER,
         ];
         foreach ($assets_folder_paths as $assets_folder_path) {
             if (is_readable($assets_folder_path)) {
@@ -168,7 +168,7 @@ 
     public function pluginPath(string $additional_path = ''): string
     {
         return is_string($additional_path) && $additional_path !== ''
-            ? $this->plugin_path . $additional_path
+            ? $this->plugin_path.$additional_path
             : $this->plugin_path;
     }
 
@@ -180,7 +180,7 @@ 
     public function pluginUrl(string $additional_path = ''): string
     {
         return is_string($additional_path) && $additional_path !== ''
-            ? $this->plugin_url . $additional_path
+            ? $this->plugin_url.$additional_path
             : $this->plugin_url;
     }
 
@@ -219,7 +219,7 @@ 
     public function distributionAssetsPath(string $additional_path = ''): string
     {
         return is_string($additional_path) && $additional_path !== ''
-            ? $this->assets_path . $additional_path
+            ? $this->assets_path.$additional_path
             : $this->assets_path;
     }
 
@@ -231,8 +231,8 @@ 
     public function distributionAssetsUrl(string $additional_path = ''): string
     {
         return is_string($additional_path) && $additional_path !== ''
-            ? $this->plugin_url . DomainBase::ASSETS_FOLDER . $additional_path
-            : $this->plugin_url . DomainBase::ASSETS_FOLDER;
+            ? $this->plugin_url.DomainBase::ASSETS_FOLDER.$additional_path
+            : $this->plugin_url.DomainBase::ASSETS_FOLDER;
     }
 
 

core/domain/DomainInterface.php

Indentation +54 added lines, -54 removed lines

@@ -14,80 +14,80 @@
  */
 interface DomainInterface extends InterminableInterface
 {
-    /**
-     * @param string $asset_namespace
-     * @return void
-     * @since 5.0.0.p
-     */
-    public function initialize(string $asset_namespace = 'eventespresso');
+	/**
+	 * @param string $asset_namespace
+	 * @return void
+	 * @since 5.0.0.p
+	 */
+	public function initialize(string $asset_namespace = 'eventespresso');
 
 
-    /**
-     * @param string $asset_namespace
-     * @return void
-     */
-    public function setAssetNamespace(string $asset_namespace = 'eventespresso');
+	/**
+	 * @param string $asset_namespace
+	 * @return void
+	 */
+	public function setAssetNamespace(string $asset_namespace = 'eventespresso');
 
 
-    /**
-     * @return string
-     */
-    public function pluginFile(): string;
+	/**
+	 * @return string
+	 */
+	public function pluginFile(): string;
 
 
-    /**
-     * @return string
-     */
-    public function pluginBasename(): string;
+	/**
+	 * @return string
+	 */
+	public function pluginBasename(): string;
 
 
-    /**
-     * @param string $additional_path
-     * @return string
-     */
-    public function pluginPath(string $additional_path = ''): string;
+	/**
+	 * @param string $additional_path
+	 * @return string
+	 */
+	public function pluginPath(string $additional_path = ''): string;
 
 
-    /**
-     * @return string
-     */
-    public function pluginUrl(): string;
+	/**
+	 * @return string
+	 */
+	public function pluginUrl(): string;
 
 
-    /**
-     * @return string
-     */
-    public function version(): string;
+	/**
+	 * @return string
+	 */
+	public function version(): string;
 
 
-    /**
-     * @return Version
-     */
-    public function versionValueObject(): Version;
+	/**
+	 * @return Version
+	 */
+	public function versionValueObject(): Version;
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsFolder(): string;
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsFolder(): string;
 
 
-    /**
-     * @param string $additional_path
-     * @return string
-     */
-    public function distributionAssetsPath(string $additional_path = ''): string;
+	/**
+	 * @param string $additional_path
+	 * @return string
+	 */
+	public function distributionAssetsPath(string $additional_path = ''): string;
 
 
-    /**
-     * @param string $additional_path
-     * @return string
-     */
-    public function distributionAssetsUrl(string $additional_path = ''): string;
+	/**
+	 * @param string $additional_path
+	 * @return string
+	 */
+	public function distributionAssetsUrl(string $additional_path = ''): string;
 
 
-    /**
-     * @return string
-     */
-    public function assetNamespace(): string;
+	/**
+	 * @return string
+	 */
+	public function assetNamespace(): string;
 }

core/domain/Domain.php

Indentation +110 added lines, -110 removed lines

@@ -15,114 +15,114 @@
  */
 class Domain extends DomainBase implements CaffeinatedInterface
 {
-    /**
-     * URL path component used to denote an API request
-     */
-    public const API_NAMESPACE   = 'ee/v';
-
-    public const ASSET_NAMESPACE = 'eventespresso';
-
-    public const LICENSE_PLUGIN_NAME = 'Event Espresso Core';
-
-    public const LICENSE_PLUGIN_SLUG = 'event_espresso_core';
-
-    public const TEXT_DOMAIN     = 'event_espresso';
-
-    /**
-     * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
-     * Page ui.
-     */
-    public const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN        = 'manual_registration_status_change_from_registration_admin';
-
-    public const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY = 'manual_registration_status_change_from_registration_admin_and_notify';
-
-
-    /**
-     * Whether EE core is the full premium version.
-     *
-     * @since 4.9.59.p
-     * @var bool
-     */
-    private bool $caffeinated = false;
-
-    /**
-     * @since 5.0.0.p
-     * @var bool
-     */
-    private bool $multisite;
-
-
-    public function __construct(FilePath $plugin_file, Version $version)
-    {
-        parent::__construct($plugin_file, $version);
-        $this->setCaffeinated();
-        $this->multisite = is_multisite();
-    }
-
-
-    /**
-     * Whether EE core is the full premium version.
-     *
-     * @return bool
-     * @since 4.9.59.p
-     */
-    public function isCaffeinated(): bool
-    {
-        return $this->caffeinated;
-    }
-
-
-    /**
-     * @return bool
-     * @since 5.0.22.p
-     */
-    public function isDecaf(): bool
-    {
-        return ! $this->isCaffeinated();
-    }
-
-
-    /**
-     * Setter for $is_caffeinated property.
-     *
-     * @since 4.9.59.p
-     */
-    private function setCaffeinated()
-    {
-        $this->caffeinated = ! (defined('EE_DECAF') && EE_DECAF)
-                             && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php');
-    }
-
-
-    /**
-     * This should be used everywhere the Event Espresso brand name is referenced in public facing interfaces
-     * to allow for filtering the brand.
-     *
-     * @return string
-     */
-    public static function brandName(): string
-    {
-        return (string) apply_filters('FHEE__EventEspresso_core_domain_Domain__brandName', 'Event Espresso');
-    }
-
-
-    /**
-     * @return bool
-     * @since 5.0.0.p
-     */
-    public function isMultiSite(): bool
-    {
-        return $this->multisite;
-    }
-
-
-    public static function pluginName(): string
-    {
-        return self::LICENSE_PLUGIN_NAME;
-    }
-
-    public static function pluginSlug(): string
-    {
-        return self::LICENSE_PLUGIN_SLUG;
-    }
+	/**
+	 * URL path component used to denote an API request
+	 */
+	public const API_NAMESPACE   = 'ee/v';
+
+	public const ASSET_NAMESPACE = 'eventespresso';
+
+	public const LICENSE_PLUGIN_NAME = 'Event Espresso Core';
+
+	public const LICENSE_PLUGIN_SLUG = 'event_espresso_core';
+
+	public const TEXT_DOMAIN     = 'event_espresso';
+
+	/**
+	 * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
+	 * Page ui.
+	 */
+	public const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN        = 'manual_registration_status_change_from_registration_admin';
+
+	public const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY = 'manual_registration_status_change_from_registration_admin_and_notify';
+
+
+	/**
+	 * Whether EE core is the full premium version.
+	 *
+	 * @since 4.9.59.p
+	 * @var bool
+	 */
+	private bool $caffeinated = false;
+
+	/**
+	 * @since 5.0.0.p
+	 * @var bool
+	 */
+	private bool $multisite;
+
+
+	public function __construct(FilePath $plugin_file, Version $version)
+	{
+		parent::__construct($plugin_file, $version);
+		$this->setCaffeinated();
+		$this->multisite = is_multisite();
+	}
+
+
+	/**
+	 * Whether EE core is the full premium version.
+	 *
+	 * @return bool
+	 * @since 4.9.59.p
+	 */
+	public function isCaffeinated(): bool
+	{
+		return $this->caffeinated;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since 5.0.22.p
+	 */
+	public function isDecaf(): bool
+	{
+		return ! $this->isCaffeinated();
+	}
+
+
+	/**
+	 * Setter for $is_caffeinated property.
+	 *
+	 * @since 4.9.59.p
+	 */
+	private function setCaffeinated()
+	{
+		$this->caffeinated = ! (defined('EE_DECAF') && EE_DECAF)
+							 && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php');
+	}
+
+
+	/**
+	 * This should be used everywhere the Event Espresso brand name is referenced in public facing interfaces
+	 * to allow for filtering the brand.
+	 *
+	 * @return string
+	 */
+	public static function brandName(): string
+	{
+		return (string) apply_filters('FHEE__EventEspresso_core_domain_Domain__brandName', 'Event Espresso');
+	}
+
+
+	/**
+	 * @return bool
+	 * @since 5.0.0.p
+	 */
+	public function isMultiSite(): bool
+	{
+		return $this->multisite;
+	}
+
+
+	public static function pluginName(): string
+	{
+		return self::LICENSE_PLUGIN_NAME;
+	}
+
+	public static function pluginSlug(): string
+	{
+		return self::LICENSE_PLUGIN_SLUG;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
 
     public const LICENSE_PLUGIN_SLUG = 'event_espresso_core';
 
-    public const TEXT_DOMAIN     = 'event_espresso';
+    public const TEXT_DOMAIN = 'event_espresso';
 
     /**
      * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
@@ -90,7 +90,7 @@ 
     private function setCaffeinated()
     {
         $this->caffeinated = ! (defined('EE_DECAF') && EE_DECAF)
-                             && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php');
+                             && is_readable($this->pluginPath().'caffeinated/brewing_regular.php');
     }
 
 

core/domain/entities/config/legacy/EE_Admin_Config.php

Indentation +137 added lines, -137 removed lines

@@ -7,141 +7,141 @@
  */
 class EE_Admin_Config extends EE_Config_Base
 {
-    protected ?bool $useAdvancedEditor = true;
-
-    public $use_remote_logging = false;
-
-    public $show_reg_footer = false;
-
-    protected ?bool $is_caffeinated = false;
-
-    public $use_dashboard_widget = false;
-
-    public $use_personnel_manager = false;
-
-    public $use_event_timezones = false;
-
-    /**
-     * adds extra layer of encoding to session data to prevent serialization errors
-     * but is incompatible with some server configuration errors
-     * if you get "500 internal server errors" during registration, try turning this on
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
-     *
-     * @var boolean $encode_session_data
-     */
-    protected bool $encode_session_data = false;
-
-    public ?string $log_file_name = '';
-
-    public ?string $debug_file_name = '';
-
-    public ?string $remote_logging_url = '';
-
-    public ?string $affiliate_id = 'default';
-
-    /**
-     * @var int|null $events_in_dashboard
-     * @deprecated
-     */
-    public ?int $events_in_dashboard = 30;
-
-
-    public function __construct()
-    {
-        $this->setIsCaffeinated();
-        // set default general admin settings
-        $this->show_reg_footer = (bool) apply_filters(
-            'FHEE__EE_Admin_Config__show_reg_footer__default',
-            false
-        );
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function log_file_name(bool $reset = false): string
-    {
-        if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return (string) $this->log_file_name;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function debug_file_name(bool $reset = false): string
-    {
-        if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return (string) $this->debug_file_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function affiliate_id(): string
-    {
-        return ! empty($this->affiliate_id) ? (string) $this->affiliate_id : 'default';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function encode_session_data(): bool
-    {
-        return $this->encode_session_data;
-    }
-
-
-    /**
-     * @param bool|int|string $encode_session_data
-     */
-    public function set_encode_session_data($encode_session_data)
-    {
-        $this->encode_session_data = (bool) filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
-
-    /**
-     * @return boolean
-     */
-    public function useAdvancedEditor(): bool
-    {
-        return $this->useAdvancedEditor;
-    }
-
-    /**
-     * @param bool|int|string $use_advanced_editor
-     */
-    public function setUseAdvancedEditor($use_advanced_editor = true)
-    {
-        $this->useAdvancedEditor = (bool) filter_var(
-            apply_filters(
-                'FHEE__EE_Admin_Config__setUseAdvancedEditor__use_advanced_editor',
-                $use_advanced_editor
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    protected function setIsCaffeinated(): void
-    {
-        /** @var EventEspresso\core\domain\Domain $domain */
-        $domain               = LoaderFactory::getLoader()->getShared('EventEspresso\core\domain\Domain');
-        $this->is_caffeinated = (bool) filter_var($domain->isCaffeinated(), FILTER_VALIDATE_BOOLEAN);
-    }
+	protected ?bool $useAdvancedEditor = true;
+
+	public $use_remote_logging = false;
+
+	public $show_reg_footer = false;
+
+	protected ?bool $is_caffeinated = false;
+
+	public $use_dashboard_widget = false;
+
+	public $use_personnel_manager = false;
+
+	public $use_event_timezones = false;
+
+	/**
+	 * adds extra layer of encoding to session data to prevent serialization errors
+	 * but is incompatible with some server configuration errors
+	 * if you get "500 internal server errors" during registration, try turning this on
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
+	 *
+	 * @var boolean $encode_session_data
+	 */
+	protected bool $encode_session_data = false;
+
+	public ?string $log_file_name = '';
+
+	public ?string $debug_file_name = '';
+
+	public ?string $remote_logging_url = '';
+
+	public ?string $affiliate_id = 'default';
+
+	/**
+	 * @var int|null $events_in_dashboard
+	 * @deprecated
+	 */
+	public ?int $events_in_dashboard = 30;
+
+
+	public function __construct()
+	{
+		$this->setIsCaffeinated();
+		// set default general admin settings
+		$this->show_reg_footer = (bool) apply_filters(
+			'FHEE__EE_Admin_Config__show_reg_footer__default',
+			false
+		);
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function log_file_name(bool $reset = false): string
+	{
+		if (empty($this->log_file_name) || $reset) {
+			$this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return (string) $this->log_file_name;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function debug_file_name(bool $reset = false): string
+	{
+		if (empty($this->debug_file_name) || $reset) {
+			$this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return (string) $this->debug_file_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function affiliate_id(): string
+	{
+		return ! empty($this->affiliate_id) ? (string) $this->affiliate_id : 'default';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function encode_session_data(): bool
+	{
+		return $this->encode_session_data;
+	}
+
+
+	/**
+	 * @param bool|int|string $encode_session_data
+	 */
+	public function set_encode_session_data($encode_session_data)
+	{
+		$this->encode_session_data = (bool) filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function useAdvancedEditor(): bool
+	{
+		return $this->useAdvancedEditor;
+	}
+
+	/**
+	 * @param bool|int|string $use_advanced_editor
+	 */
+	public function setUseAdvancedEditor($use_advanced_editor = true)
+	{
+		$this->useAdvancedEditor = (bool) filter_var(
+			apply_filters(
+				'FHEE__EE_Admin_Config__setUseAdvancedEditor__use_advanced_editor',
+				$use_advanced_editor
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	protected function setIsCaffeinated(): void
+	{
+		/** @var EventEspresso\core\domain\Domain $domain */
+		$domain               = LoaderFactory::getLoader()->getShared('EventEspresso\core\domain\Domain');
+		$this->is_caffeinated = (bool) filter_var($domain->isCaffeinated(), FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/domain/entities/shortcodes/EspressoTxnPage.php

Indentation +82 added lines, -82 removed lines

@@ -24,92 +24,92 @@
  */
 class EspressoTxnPage extends EspressoShortcode
 {
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TXN_PAGE';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TXN_PAGE';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     * @throws Exception
-     * @throws EE_Error
-     */
-    public function initializeShortcode()
-    {
-        $transaction  = null;
-        $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $reg_url_link = $request->getRequestParam('e_reg_url_link');
-        if ($reg_url_link) {
-            /** @var EEM_Transaction $EEM_Transaction */
-            $EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
-            $transaction = $EEM_Transaction->get_transaction_from_reg_url_link($reg_url_link);
-        }
-        if ($transaction instanceof EE_Transaction) {
-            $payment_method = null;
-            $payment_method_slug = $request->getRequestParam('ee_payment_method');
-            if ($payment_method_slug) {
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($payment_method_slug);
-            }
-            if ($payment_method instanceof EE_Payment_Method && $payment_method->is_off_site()) {
-                $gateway = $payment_method->type_obj()->get_gateway();
-                if (
-                    $gateway instanceof EE_Offsite_Gateway
-                    && $gateway->handle_IPN_in_this_request(
-                        $request->requestParams(),
-                        true
-                    )
-                ) {
-                    /** @var RequestInterface $request */
-                    $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-                    /** @var IpnHandler $payment_processor */
-                    $payment_processor = LoaderFactory::getShared(IpnHandler::class);
-                    $payment_processor->processIPN($request->requestParams(), $transaction, $payment_method);
-                }
-            }
-            // allow gateways to add a filter to stop rendering the page
-            if (apply_filters('FHEE__EES_Espresso_Txn_Page__run__exit', false)) {
-                exit;
-            }
-        }
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 * @throws Exception
+	 * @throws EE_Error
+	 */
+	public function initializeShortcode()
+	{
+		$transaction  = null;
+		$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$reg_url_link = $request->getRequestParam('e_reg_url_link');
+		if ($reg_url_link) {
+			/** @var EEM_Transaction $EEM_Transaction */
+			$EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
+			$transaction = $EEM_Transaction->get_transaction_from_reg_url_link($reg_url_link);
+		}
+		if ($transaction instanceof EE_Transaction) {
+			$payment_method = null;
+			$payment_method_slug = $request->getRequestParam('ee_payment_method');
+			if ($payment_method_slug) {
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($payment_method_slug);
+			}
+			if ($payment_method instanceof EE_Payment_Method && $payment_method->is_off_site()) {
+				$gateway = $payment_method->type_obj()->get_gateway();
+				if (
+					$gateway instanceof EE_Offsite_Gateway
+					&& $gateway->handle_IPN_in_this_request(
+						$request->requestParams(),
+						true
+					)
+				) {
+					/** @var RequestInterface $request */
+					$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+					/** @var IpnHandler $payment_processor */
+					$payment_processor = LoaderFactory::getShared(IpnHandler::class);
+					$payment_processor->processIPN($request->requestParams(), $transaction, $payment_method);
+				}
+			}
+			// allow gateways to add a filter to stop rendering the page
+			if (apply_filters('FHEE__EES_Espresso_Txn_Page__run__exit', false)) {
+				exit;
+			}
+		}
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array|string $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        return esc_html__(
-            'This is the Event Espresso Transactions page. This page receives instant payment notification (IPN) requests and should have a status of published, but should not be easily accessible by site visitors. Do not add it to your website\'s navigation menu or link to it from another page. Also, do not delete it or change its status to private.',
-            'event_espresso'
-        );
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array|string $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		return esc_html__(
+			'This is the Event Espresso Transactions page. This page receives instant payment notification (IPN) requests and should have a status of published, but should not be easily accessible by site visitors. Do not add it to your website\'s navigation menu or link to it from another page. Also, do not delete it or change its status to private.',
+			'event_espresso'
+		);
+	}
 }

core/domain/entities/routing/data_nodes/core/EspressoCoreDomain.php

Indentation +36 added lines, -36 removed lines

@@ -16,40 +16,40 @@
  */
 class EspressoCoreDomain extends JsonDataNode
 {
-    const NODE_NAME = 'coreDomain';
-
-    private Domain $domain;
-
-
-    /**
-     * JsonDataNode constructor.
-     *
-     * @param Domain                $domain
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(Domain $domain, JsonDataNodeValidator $validator)
-    {
-        $this->domain = $domain;
-        parent::__construct($validator);
-        $this->setNodeName(EspressoCoreDomain::NODE_NAME);
-    }
-
-
-    /**
-     * @inheritDoc
-     */
-    public function initialize()
-    {
-        $this->addData('assetNamespace', $this->domain->assetNamespace());
-        $this->addData('brandName', Domain::brandName());
-        $this->addData('coreVersion', $this->domain->version());
-        $this->addData('distributionAssetsPath', $this->domain->distributionAssetsPath());
-        $this->addData('distributionAssetsUrl', $this->domain->distributionAssetsUrl());
-        $this->addData('isCaffeinated', $this->domain->isCaffeinated());
-        $this->addData('isDecaf', $this->domain->isDecaf());
-        $this->addData('isMultiSite', $this->domain->isMultiSite());
-        $this->addData('pluginPath', $this->domain->pluginPath());
-        $this->addData('pluginUrl', $this->domain->pluginUrl());
-        $this->setInitialized(true);
-    }
+	const NODE_NAME = 'coreDomain';
+
+	private Domain $domain;
+
+
+	/**
+	 * JsonDataNode constructor.
+	 *
+	 * @param Domain                $domain
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(Domain $domain, JsonDataNodeValidator $validator)
+	{
+		$this->domain = $domain;
+		parent::__construct($validator);
+		$this->setNodeName(EspressoCoreDomain::NODE_NAME);
+	}
+
+
+	/**
+	 * @inheritDoc
+	 */
+	public function initialize()
+	{
+		$this->addData('assetNamespace', $this->domain->assetNamespace());
+		$this->addData('brandName', Domain::brandName());
+		$this->addData('coreVersion', $this->domain->version());
+		$this->addData('distributionAssetsPath', $this->domain->distributionAssetsPath());
+		$this->addData('distributionAssetsUrl', $this->domain->distributionAssetsUrl());
+		$this->addData('isCaffeinated', $this->domain->isCaffeinated());
+		$this->addData('isDecaf', $this->domain->isDecaf());
+		$this->addData('isMultiSite', $this->domain->isMultiSite());
+		$this->addData('pluginPath', $this->domain->pluginPath());
+		$this->addData('pluginUrl', $this->domain->pluginUrl());
+		$this->setInitialized(true);
+	}
 }

core/admin/EE_Admin.core.php

Indentation +987 added lines, -987 removed lines

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

Spacing +30 added lines, -30 removed lines

@@ -43,7 +43,7 @@ 
     public static function instance(?LoaderInterface $loader = null, ?RequestInterface $request = null): ?EE_Admin
     {
         // check if class object is instantiated
-        if (! EE_Admin::$_instance instanceof EE_Admin) {
+        if ( ! EE_Admin::$_instance instanceof EE_Admin) {
             EE_Admin::$_instance = new EE_Admin($loader, $request);
         }
         return EE_Admin::$_instance;
@@ -84,7 +84,7 @@ 
         // load EE_Request_Handler early
         add_action('AHEE__EE_System__initialize_last', [$this, 'init']);
         add_action('admin_init', [$this, 'admin_init'], 100);
-        if (! $this->request->isActivation() && ! $this->request->isAjax()) {
+        if ( ! $this->request->isActivation() && ! $this->request->isAjax()) {
             // admin hooks
             add_action('admin_notices', [$this, 'display_admin_notices']);
             add_action('network_admin_notices', [$this, 'display_admin_notices']);
@@ -106,11 +106,11 @@ 
      */
     private function _define_all_constants()
     {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+        if ( ! defined('EE_ADMIN_URL')) {
+            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL.'core/admin/');
+            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL.'admin_pages/');
+            define('EE_ADMIN_TEMPLATE', EE_ADMIN.'templates/');
+            define('WP_ADMIN_PATH', ABSPATH.'wp-admin/');
             define('WP_AJAX_URL', admin_url('admin-ajax.php'));
         }
     }
@@ -128,7 +128,7 @@ 
         // set $main_file in stone
         static $main_file;
         // if $main_file is not set yet
-        if (! $main_file) {
+        if ( ! $main_file) {
             $main_file = EE_PLUGIN_BASENAME;
         }
         if ($plugin === $main_file) {
@@ -163,9 +163,9 @@ 
     public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = [])
     {
         return [
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
-            'about'       => EE_ADMIN_PAGES . 'about/',
-            'support'     => EE_ADMIN_PAGES . 'support/',
+            'maintenance' => EE_ADMIN_PAGES.'maintenance/',
+            'about'       => EE_ADMIN_PAGES.'about/',
+            'support'     => EE_ADMIN_PAGES.'support/',
         ];
     }
 
@@ -291,13 +291,13 @@ 
                     '</strong>',
                     '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
                     '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+                    '<a href="'.EE_Admin_Page::add_query_args_and_nonce(
                         [
                             'page'   => 'espresso_maintenance_settings',
                             'action' => 'datetime_tools',
                         ],
                         admin_url('admin.php')
-                    ) . '">'
+                    ).'">'
                 ),
                 false,
                 'manage_options',
@@ -343,7 +343,7 @@ 
     public function enable_hidden_ee_nav_menu_metaboxes()
     {
         global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+        if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
             return;
         }
         $user = wp_get_current_user();
@@ -372,7 +372,7 @@ 
         if (is_array($hidden_meta_boxes)) {
             foreach ($hidden_meta_boxes as $key => $meta_box_id) {
                 if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
+                    unset($hidden_meta_boxes[$key]);
                 }
             }
         }
@@ -401,7 +401,7 @@ 
         );
         add_filter(
             "postbox_classes_nav-menus_add-extra-nav-menu-pages",
-            function ($classes) {
+            function($classes) {
                 $classes[] = 'ee-admin-container';
                 return $classes;
             }
@@ -419,7 +419,7 @@ 
      */
     public function modify_edit_post_link($link, $id)
     {
-        if (! $post = get_post($id)) {
+        if ( ! $post = get_post($id)) {
             return $link;
         }
         if ($post->post_type === EspressoPostType::ATTENDEES) {
@@ -476,7 +476,7 @@ 
             (object) $args
         );
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'cpt_archive_page.template.php',
+            EE_ADMIN_TEMPLATE.'cpt_archive_page.template.php',
             [
                 'nav_menu_selected_id' => $nav_menu_selected_id,
                 'nav_menu_pages_items' => $nav_menu_pages_items,
@@ -534,7 +534,7 @@ 
             'xfn'              => '',
         ];
         foreach ($keys as $key => $value) {
-            $menu_item->{$key} = $menu_item_values[ $key ] ?? $value;
+            $menu_item->{$key} = $menu_item_values[$key] ?? $value;
         }
         return $menu_item;
     }
@@ -566,7 +566,7 @@ 
         }
 
 
-        if (! $this->request->isAjax()) {
+        if ( ! $this->request->isAjax()) {
             /**
              * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
              * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
@@ -611,10 +611,10 @@ 
 
         // loop through to remove any critical pages from the array.
         foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
+            $needle = 'value="'.$page_id.'"';
             foreach ($split_output as $key => $haystack) {
                 if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
+                    unset($split_output[$key]);
                 }
             }
         }
@@ -651,7 +651,7 @@ 
             ['page' => 'espresso_events'],
             admin_url('admin.php')
         );
-        $items['events']['text']         = sprintf(
+        $items['events']['text'] = sprintf(
             esc_html(
                 _n('%s Event', '%s Events', $events, 'event_espresso')
             ),
@@ -665,11 +665,11 @@ 
                 ],
             ]
         );
-        $items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
+        $items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
             ['page' => 'espresso_registrations'],
             admin_url('admin.php')
         );
-        $items['registrations']['text']  = sprintf(
+        $items['registrations']['text'] = sprintf(
             esc_html(
                 _n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
             ),
@@ -681,7 +681,7 @@ 
 
         foreach ($items as $type => $item_properties) {
             $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+                '<a class="ee-dashboard-link-'.$type.'" href="%s" title="%s">%s</a>',
                 $item_properties['url'],
                 $item_properties['title'],
                 $item_properties['text']
@@ -705,10 +705,10 @@ 
         // check for date_format or time_format
         switch ($option) {
             case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
+                $date_time_format = $value.' '.get_option('time_format');
                 break;
             case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
+                $date_time_format = get_option('date_format').' '.$value;
                 break;
             default:
                 $date_time_format = false;
@@ -731,7 +731,7 @@ 
 
 
                 foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
+                    $msg .= '<li>'.$error.'</li>';
                 }
 
                 $msg .= '</ul></p><p>'
@@ -803,7 +803,7 @@ 
     public function displayStateForCriticalPages($post_states, $post)
     {
         $post_states = (array) $post_states;
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
+        if ( ! $post instanceof WP_Post || $post->post_type !== 'page') {
             return $post_states;
         }
         /** @var EE_Core_Config $config */

core/admin/EE_Admin_Page_Loader.core.php

Indentation +433 added lines, -433 removed lines

@@ -18,119 +18,119 @@ 
  */
 class EE_Admin_Page_Loader
 {
-    /**
-     * @var AdminMenuManager $menu_manager
-     */
-    protected $menu_manager;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = [];
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = [];
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = [];
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-    /**
-     * @var bool
-     * @since 5.0.0.p
-     */
-    private bool $full_site_maintenance = false;
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(?LoaderInterface $loader)
-    {
-        $this->loader = $loader instanceof LoaderInterface ? $loader : LoaderFactory::getLoader();
-        $this->menu_manager = $this->loader->getShared(AdminMenuManager::class);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    public function init()
-    {
-        $this->menu_manager->initialize();
-        $this->full_site_maintenance = MaintenanceStatus::isFullSite();
-        // let's do a scan and see what installed pages we have
-        $this->findAndLoadAdminPages();
-    }
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function defineCaffeinatedConstants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-    /**
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function findAndLoadAdminPages()
-    {
-        $admin_pages = $this->findAdminPages();
+	/**
+	 * @var AdminMenuManager $menu_manager
+	 */
+	protected $menu_manager;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = [];
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = [];
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = [];
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+	/**
+	 * @var bool
+	 * @since 5.0.0.p
+	 */
+	private bool $full_site_maintenance = false;
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(?LoaderInterface $loader)
+	{
+		$this->loader = $loader instanceof LoaderInterface ? $loader : LoaderFactory::getLoader();
+		$this->menu_manager = $this->loader->getShared(AdminMenuManager::class);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	public function init()
+	{
+		$this->menu_manager->initialize();
+		$this->full_site_maintenance = MaintenanceStatus::isFullSite();
+		// let's do a scan and see what installed pages we have
+		$this->findAndLoadAdminPages();
+	}
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function defineCaffeinatedConstants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+	/**
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function findAndLoadAdminPages()
+	{
+		$admin_pages = $this->findAdminPages();
 		$isCaffeinated = ! (defined('EE_DECAF') && EE_DECAF) && is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin');
 		// first let's check if there IS a caffeinated folder.
 		if ($isCaffeinated) {
@@ -140,325 +140,325 @@ 
 			$this->findAdminPageExtensions();
 			$this->findAdminPageHooks();
 		}
-        // allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        // loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = [];
-        $menu_pages = [];
-        foreach ($admin_pages as $page => $path) {
-            // don't load the page init class IF IT's ALREADY LOADED !!!
-            if (
-                isset($this->_installed_pages[ $page ])
-                && $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
-            ) {
-                continue;
-            }
-            // build list of installed pages
-            $admin_page_init = $this->loadAdminPageInit($page);
-            $this->_installed_pages[ $page ] = $admin_page_init;
-            $admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
-            $admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
-            // skip if in full maintenance mode and maintenance_mode_parent is NOT set
-            if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
-                unset($admin_pages[ $page ]);
-                continue;
-            }
-            $menu_slug = $admin_menu->menuSlug();
-            $this->_menu_slugs[ $menu_slug ] = $page;
-            $menu_pages[ $menu_slug ] = $admin_page_init;
-
-            // now that we've got the admin_init objects...
-            // let's see if there are any caffeinated pages extending the originals.
-            // If there are then let's hook into the init admin filter and load our extentions instead.
-            // Set flag for register hooks on extended pages b/c extended pages use the default INIT.
-            $extended_hooks = $admin_page_init->register_hooks(
-                $this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
-            );
-            $hooks_ref = array_merge($hooks_ref, $extended_hooks);
-        }
+		// allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		// loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = [];
+		$menu_pages = [];
+		foreach ($admin_pages as $page => $path) {
+			// don't load the page init class IF IT's ALREADY LOADED !!!
+			if (
+				isset($this->_installed_pages[ $page ])
+				&& $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
+			) {
+				continue;
+			}
+			// build list of installed pages
+			$admin_page_init = $this->loadAdminPageInit($page);
+			$this->_installed_pages[ $page ] = $admin_page_init;
+			$admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
+			$admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
+			// skip if in full maintenance mode and maintenance_mode_parent is NOT set
+			if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
+				unset($admin_pages[ $page ]);
+				continue;
+			}
+			$menu_slug = $admin_menu->menuSlug();
+			$this->_menu_slugs[ $menu_slug ] = $page;
+			$menu_pages[ $menu_slug ] = $admin_page_init;
+
+			// now that we've got the admin_init objects...
+			// let's see if there are any caffeinated pages extending the originals.
+			// If there are then let's hook into the init admin filter and load our extentions instead.
+			// Set flag for register hooks on extended pages b/c extended pages use the default INIT.
+			$extended_hooks = $admin_page_init->register_hooks(
+				$this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
+			);
+			$hooks_ref = array_merge($hooks_ref, $extended_hooks);
+		}
 		// the hooks_ref is all the pages where we have $extended _Hooks files
-        // that will extend a class in a different folder.
-        // So we want to make sure we load the file for the parent.
-        // first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        // now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            // if we're not caffeinated, then we don't need to do any of the following.
-            if (! $isCaffeinated && strpos($path, 'caffeinated') !== false) {
-            	continue;
-            }
-            require_once($path);
-        }
-        // make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        // we need to loop again to run any early code
-        foreach ($this->_installed_pages as $page) {
-            $page->do_initial_loads();
-        }
-        $this->menu_manager->setInstalledPages($menu_pages);
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPages(): array
-    {
-        // grab everything in the  admin core directory
-        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
-        $admin_page_folders = apply_filters(
-            'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
-            $admin_page_folders
-        );
-        if (! empty($admin_page_folders)) {
-            return $admin_page_folders;
-        }
-        $error_msg = esc_html__(
-            'There are no EE_Admin pages detected, it looks like EE did not install properly',
-            'event_espresso'
-        );
-        $error_msg .= '||';
-        $error_msg .= sprintf(
-            esc_html__(
-                'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                'event_espresso'
-            ),
-            EE_ADMIN_PAGES
-        );
-        throw new RuntimeException($error_msg);
-    }
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
-    {
-        return isset($this->_installed_pages[ $page_slug ])
-               && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
-            ? $this->_installed_pages[ $page_slug ]->loaded_page_object()
-            : null;
-    }
-
-
-    /**
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param string $dir_name
-     * @return string
-     */
-    private function getClassnameForAdminPageInit(string $dir_name = ''): string
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param string $page page_reference
-     * @return EE_Admin_Page_Init
-     * @throws EE_Error
-     */
-    private function loadAdminPageInit(string $page = ''): EE_Admin_Page_Init
-    {
-        $class_name = $this->getClassnameForAdminPageInit($page);
-        if (class_exists($class_name)) {
-            $admin_page_init = $this->loader->getShared($class_name);
-            // verify returned object
-            if ($admin_page_init instanceof EE_Admin_Page_Init) {
-                return $admin_page_init;
-            }
-        }
-        $error_msg = sprintf(
-            esc_html__('Something went wrong with loading the %s admin page.', 'event_espresso'),
-            $page
-        );
-        $error_msg .= '||'; // separates public from developer messages
-        $error_msg .= "\r\n";
-        $error_msg .= sprintf(
-            esc_html__('There is no Init class in place for the %s admin page.', 'event_espresso'),
-            $page
-        );
-        $error_msg .= '<br />';
-        $error_msg .= sprintf(
-            esc_html__(
-                'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                'event_espresso'
-            ),
-            '<strong>' . $class_name . '</strong>'
-        );
-        throw new EE_Error($error_msg);
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $admin_pages
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $admin_pages the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     * @throws EE_Error
-     */
-    private function findCaffeinatedAdminPages(array $admin_pages): array
-    {
-        $this->defineCaffeinatedConstants();
-
-        $exclude = ['tickets'];
-        $feature = $this->loader->getShared(FeatureFlags::class);
-        if (! $feature->allowed('use_edd_plugin_licensing')) {
-            $exclude[] = 'license_keys';
-        }
-        // okay let's setup an "New" pages first (we'll return installed refs later)
-        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', $exclude);
-
-        return apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $admin_pages
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPageExtensions()
-    {
-        // let's see if there are any EXTENDS to set up in the $_caffeinated_extends array
-        // (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
-        if ($extensions) {
-            foreach ($extensions as $folder => $extension) {
-                // convert lowercase_snake_case to Uppercase_Snake_Case
-                $filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
-                $filename = "Extend_{$filename}_Admin_Page";
-                $filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
-                // save filename and filepath for later
-                $this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
-                $this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
-            }
-        }
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-    }
-
-
-    private function loadCaffeinatedExtensions(
-        EE_Admin_Page_Init $admin_page_init,
-        string $page,
-        string $menu_slug
-    ): bool {
-        if (! isset($this->_caffeinated_extends[ $page ])) {
-            return false;
-        }
-        $admin_page_name = $admin_page_init->get_admin_page_name();
-        $caf_path        = $this->_caffeinated_extends[ $page ]['path'];
-        $caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
-        add_filter(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
-            static function ($path_to_file) use ($caf_path) {
-                return $caf_path;
-            }
-        );
-        add_filter(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
-            static function ($admin_page) use ($caf_admin_page) {
-                return $caf_admin_page;
-            }
-        );
-        return true;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPageHooks()
-    {
-        // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks   = [];
-        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
-        if ($admin_page_hooks) {
-            foreach ($admin_page_hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
-                    if (class_exists($classname)) {
-                        $ee_admin_hooks[] = $this->loader->getShared($classname);
-                    }
-                }
-            }
-        }
-        apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-    }
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link(): bool
-    {
-        return false;
-    }
-
-
-    /**
-     * @param string $path
-     * @param int    $flags
-     * @param array  $exclude
-     * @param bool   $register_autoloaders
-     * @return array
-     * @throws EE_Error
-     * @since 5.0.0.p
-     */
-    private function findAdminPageFolders(
-        string $path,
-        array $exclude = [],
-        int $flags = GLOB_ONLYDIR,
-        bool $register_autoloaders = true
-    ): array {
-        $folders = [];
-        $subfolders = glob($path, $flags);
-        if ($subfolders) {
-            foreach ($subfolders as $admin_screen) {
-                $admin_screen_name = basename($admin_screen);
-                // files and anything in the exclude array need not apply
-                if (! in_array($admin_screen_name, $exclude, true)) {
-                    // these folders represent the different EE admin pages
-                    $folders[ $admin_screen_name ] = $admin_screen;
-                    if ($register_autoloaders) {
-                        // set autoloaders for our admin page classes based on included path information
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);
-                    }
-                }
-            }
-        }
-        return $folders;
-    }
+		// that will extend a class in a different folder.
+		// So we want to make sure we load the file for the parent.
+		// first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		// now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			// if we're not caffeinated, then we don't need to do any of the following.
+			if (! $isCaffeinated && strpos($path, 'caffeinated') !== false) {
+				continue;
+			}
+			require_once($path);
+		}
+		// make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		// we need to loop again to run any early code
+		foreach ($this->_installed_pages as $page) {
+			$page->do_initial_loads();
+		}
+		$this->menu_manager->setInstalledPages($menu_pages);
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPages(): array
+	{
+		// grab everything in the  admin core directory
+		$admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
+		$admin_page_folders = apply_filters(
+			'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
+			$admin_page_folders
+		);
+		if (! empty($admin_page_folders)) {
+			return $admin_page_folders;
+		}
+		$error_msg = esc_html__(
+			'There are no EE_Admin pages detected, it looks like EE did not install properly',
+			'event_espresso'
+		);
+		$error_msg .= '||';
+		$error_msg .= sprintf(
+			esc_html__(
+				'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+				'event_espresso'
+			),
+			EE_ADMIN_PAGES
+		);
+		throw new RuntimeException($error_msg);
+	}
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
+	{
+		return isset($this->_installed_pages[ $page_slug ])
+			   && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
+			? $this->_installed_pages[ $page_slug ]->loaded_page_object()
+			: null;
+	}
+
+
+	/**
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param string $dir_name
+	 * @return string
+	 */
+	private function getClassnameForAdminPageInit(string $dir_name = ''): string
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param string $page page_reference
+	 * @return EE_Admin_Page_Init
+	 * @throws EE_Error
+	 */
+	private function loadAdminPageInit(string $page = ''): EE_Admin_Page_Init
+	{
+		$class_name = $this->getClassnameForAdminPageInit($page);
+		if (class_exists($class_name)) {
+			$admin_page_init = $this->loader->getShared($class_name);
+			// verify returned object
+			if ($admin_page_init instanceof EE_Admin_Page_Init) {
+				return $admin_page_init;
+			}
+		}
+		$error_msg = sprintf(
+			esc_html__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+			$page
+		);
+		$error_msg .= '||'; // separates public from developer messages
+		$error_msg .= "\r\n";
+		$error_msg .= sprintf(
+			esc_html__('There is no Init class in place for the %s admin page.', 'event_espresso'),
+			$page
+		);
+		$error_msg .= '<br />';
+		$error_msg .= sprintf(
+			esc_html__(
+				'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+				'event_espresso'
+			),
+			'<strong>' . $class_name . '</strong>'
+		);
+		throw new EE_Error($error_msg);
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $admin_pages
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $admin_pages the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 * @throws EE_Error
+	 */
+	private function findCaffeinatedAdminPages(array $admin_pages): array
+	{
+		$this->defineCaffeinatedConstants();
+
+		$exclude = ['tickets'];
+		$feature = $this->loader->getShared(FeatureFlags::class);
+		if (! $feature->allowed('use_edd_plugin_licensing')) {
+			$exclude[] = 'license_keys';
+		}
+		// okay let's setup an "New" pages first (we'll return installed refs later)
+		$admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', $exclude);
+
+		return apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$admin_pages
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPageExtensions()
+	{
+		// let's see if there are any EXTENDS to set up in the $_caffeinated_extends array
+		// (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
+		if ($extensions) {
+			foreach ($extensions as $folder => $extension) {
+				// convert lowercase_snake_case to Uppercase_Snake_Case
+				$filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
+				$filename = "Extend_{$filename}_Admin_Page";
+				$filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
+				// save filename and filepath for later
+				$this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
+				$this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
+			}
+		}
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+	}
+
+
+	private function loadCaffeinatedExtensions(
+		EE_Admin_Page_Init $admin_page_init,
+		string $page,
+		string $menu_slug
+	): bool {
+		if (! isset($this->_caffeinated_extends[ $page ])) {
+			return false;
+		}
+		$admin_page_name = $admin_page_init->get_admin_page_name();
+		$caf_path        = $this->_caffeinated_extends[ $page ]['path'];
+		$caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
+		add_filter(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
+			static function ($path_to_file) use ($caf_path) {
+				return $caf_path;
+			}
+		);
+		add_filter(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
+			static function ($admin_page) use ($caf_admin_page) {
+				return $caf_admin_page;
+			}
+		);
+		return true;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPageHooks()
+	{
+		// let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks   = [];
+		$admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
+		if ($admin_page_hooks) {
+			foreach ($admin_page_hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
+					if (class_exists($classname)) {
+						$ee_admin_hooks[] = $this->loader->getShared($classname);
+					}
+				}
+			}
+		}
+		apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+	}
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link(): bool
+	{
+		return false;
+	}
+
+
+	/**
+	 * @param string $path
+	 * @param int    $flags
+	 * @param array  $exclude
+	 * @param bool   $register_autoloaders
+	 * @return array
+	 * @throws EE_Error
+	 * @since 5.0.0.p
+	 */
+	private function findAdminPageFolders(
+		string $path,
+		array $exclude = [],
+		int $flags = GLOB_ONLYDIR,
+		bool $register_autoloaders = true
+	): array {
+		$folders = [];
+		$subfolders = glob($path, $flags);
+		if ($subfolders) {
+			foreach ($subfolders as $admin_screen) {
+				$admin_screen_name = basename($admin_screen);
+				// files and anything in the exclude array need not apply
+				if (! in_array($admin_screen_name, $exclude, true)) {
+					// these folders represent the different EE admin pages
+					$folders[ $admin_screen_name ] = $admin_screen;
+					if ($register_autoloaders) {
+						// set autoloaders for our admin page classes based on included path information
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);
+					}
+				}
+			}
+		}
+		return $folders;
+	}
 }

Spacing +37 added lines, -37 removed lines

@@ -106,13 +106,13 @@ 
      */
     private function defineCaffeinatedConstants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -131,7 +131,7 @@ 
     private function findAndLoadAdminPages()
     {
         $admin_pages = $this->findAdminPages();
-		$isCaffeinated = ! (defined('EE_DECAF') && EE_DECAF) && is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin');
+		$isCaffeinated = ! (defined('EE_DECAF') && EE_DECAF) && is_dir(EE_PLUGIN_DIR_PATH.'caffeinated/admin');
 		// first let's check if there IS a caffeinated folder.
 		if ($isCaffeinated) {
 			// this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
@@ -147,24 +147,24 @@ 
         foreach ($admin_pages as $page => $path) {
             // don't load the page init class IF IT's ALREADY LOADED !!!
             if (
-                isset($this->_installed_pages[ $page ])
-                && $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
+                isset($this->_installed_pages[$page])
+                && $this->_installed_pages[$page] instanceof EE_Admin_Page_Init
             ) {
                 continue;
             }
             // build list of installed pages
             $admin_page_init = $this->loadAdminPageInit($page);
-            $this->_installed_pages[ $page ] = $admin_page_init;
+            $this->_installed_pages[$page] = $admin_page_init;
             $admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
             $admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
             // skip if in full maintenance mode and maintenance_mode_parent is NOT set
             if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
-                unset($admin_pages[ $page ]);
+                unset($admin_pages[$page]);
                 continue;
             }
             $menu_slug = $admin_menu->menuSlug();
-            $this->_menu_slugs[ $menu_slug ] = $page;
-            $menu_pages[ $menu_slug ] = $admin_page_init;
+            $this->_menu_slugs[$menu_slug] = $page;
+            $menu_pages[$menu_slug] = $admin_page_init;
 
             // now that we've got the admin_init objects...
             // let's see if there are any caffeinated pages extending the originals.
@@ -183,7 +183,7 @@ 
         // now let's loop and require!
         foreach ($hooks_ref as $path) {
             // if we're not caffeinated, then we don't need to do any of the following.
-            if (! $isCaffeinated && strpos($path, 'caffeinated') !== false) {
+            if ( ! $isCaffeinated && strpos($path, 'caffeinated') !== false) {
             	continue;
             }
             require_once($path);
@@ -208,12 +208,12 @@ 
     private function findAdminPages(): array
     {
         // grab everything in the  admin core directory
-        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
+        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES.'*');
         $admin_page_folders = apply_filters(
             'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
             $admin_page_folders
         );
-        if (! empty($admin_page_folders)) {
+        if ( ! empty($admin_page_folders)) {
             return $admin_page_folders;
         }
         $error_msg = esc_html__(
@@ -240,9 +240,9 @@ 
      */
     public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
     {
-        return isset($this->_installed_pages[ $page_slug ])
-               && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
-            ? $this->_installed_pages[ $page_slug ]->loaded_page_object()
+        return isset($this->_installed_pages[$page_slug])
+               && $this->_installed_pages[$page_slug] instanceof EE_Admin_Page_Init
+            ? $this->_installed_pages[$page_slug]->loaded_page_object()
             : null;
     }
 
@@ -256,7 +256,7 @@ 
     private function getClassnameForAdminPageInit(string $dir_name = ''): string
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -294,7 +294,7 @@ 
                 'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                 'event_espresso'
             ),
-            '<strong>' . $class_name . '</strong>'
+            '<strong>'.$class_name.'</strong>'
         );
         throw new EE_Error($error_msg);
     }
@@ -325,11 +325,11 @@ 
 
         $exclude = ['tickets'];
         $feature = $this->loader->getShared(FeatureFlags::class);
-        if (! $feature->allowed('use_edd_plugin_licensing')) {
+        if ( ! $feature->allowed('use_edd_plugin_licensing')) {
             $exclude[] = 'license_keys';
         }
         // okay let's setup an "New" pages first (we'll return installed refs later)
-        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', $exclude);
+        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'new/*', $exclude);
 
         return apply_filters(
             'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
@@ -346,16 +346,16 @@ 
     {
         // let's see if there are any EXTENDS to set up in the $_caffeinated_extends array
         // (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
+        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'extend/*');
         if ($extensions) {
             foreach ($extensions as $folder => $extension) {
                 // convert lowercase_snake_case to Uppercase_Snake_Case
                 $filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
                 $filename = "Extend_{$filename}_Admin_Page";
-                $filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
+                $filepath = EE_CORE_CAF_ADMIN."extend/$folder/$filename.core.php";
                 // save filename and filepath for later
-                $this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
-                $this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
+                $this->_caffeinated_extends[$folder]['path']       = str_replace(['\\', '/'], '/', $filepath);
+                $this->_caffeinated_extends[$folder]['admin_page'] = $filename;
             }
         }
         $this->_caffeinated_extends = apply_filters(
@@ -370,21 +370,21 @@ 
         string $page,
         string $menu_slug
     ): bool {
-        if (! isset($this->_caffeinated_extends[ $page ])) {
+        if ( ! isset($this->_caffeinated_extends[$page])) {
             return false;
         }
         $admin_page_name = $admin_page_init->get_admin_page_name();
-        $caf_path        = $this->_caffeinated_extends[ $page ]['path'];
-        $caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
+        $caf_path        = $this->_caffeinated_extends[$page]['path'];
+        $caf_admin_page  = $this->_caffeinated_extends[$page]['admin_page'];
         add_filter(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
-            static function ($path_to_file) use ($caf_path) {
+            static function($path_to_file) use ($caf_path) {
                 return $caf_path;
             }
         );
         add_filter(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
-            static function ($admin_page) use ($caf_admin_page) {
+            static function($admin_page) use ($caf_admin_page) {
                 return $caf_admin_page;
             }
         );
@@ -400,12 +400,12 @@ 
     {
         // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks   = [];
-        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
+        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'hooks/*.class.php', [], 0, false);
         if ($admin_page_hooks) {
             foreach ($admin_page_hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
+                    $classname = str_replace([EE_CORE_CAF_ADMIN.'hooks/', '.class.php'], '', $hook);
                     if (class_exists($classname)) {
                         $ee_admin_hooks[] = $this->loader->getShared($classname);
                     }
@@ -449,9 +449,9 @@ 
             foreach ($subfolders as $admin_screen) {
                 $admin_screen_name = basename($admin_screen);
                 // files and anything in the exclude array need not apply
-                if (! in_array($admin_screen_name, $exclude, true)) {
+                if ( ! in_array($admin_screen_name, $exclude, true)) {
                     // these folders represent the different EE admin pages
-                    $folders[ $admin_screen_name ] = $admin_screen;
+                    $folders[$admin_screen_name] = $admin_screen;
                     if ($register_autoloaders) {
                         // set autoloaders for our admin page classes based on included path information
                         EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);